generative_search_for_answer_or_summary

{
  "type": "object",
  "properties": {
    "term": {
      "type": "string",
      "description": "The search query to send to Seismic's AI-powered answer engine. You may improve phrasing for clarity, but you MUST preserve the full intent and scope of the user's question \u2014 never narrow, strip, or omit any part of what was asked. In multi-turn conversations, resolve pronouns and implicit references so the query is self-contained (e.g. if the user said 'what about EMEA?' after asking about pricing, pass 'pricing in EMEA' not 'what about EMEA?'). Do NOT summarize to keywords; the engine needs a complete natural-language question to generate an accurate answer. Only construct a custom term when this tool is invoked as part of a multi-step workflow where the relevant sub-query genuinely differs from the original user message (e.g., a follow-up lookup using a specific entity name surfaced in a prior step)."
    },
    "isShareable": {
      "type": "boolean",
      "description": "When true, restricts results to externally shareable content only. Set to true automatically when the user's intent is clearly customer-facing or sharing-oriented (e.g., \"find a deck I can send\", \"customer-safe pricing material\", \"shareable one-pager\", \"something I can share after the meeting\"). Do NOT set this by default for general or internal discovery queries. If intent is ambiguous but likely customer-facing, ask \"Do you want only externally shareable content?\" before setting it."
    },
    "filter": {
      "type": "object",
      "description": "Use ONLY when the user explicitly requests filtering (e.g. 'filter by region', 'only EMEA documents', 'show PDFs'). Do NOT add filters to improve relevance \u2014 omit entirely for general queries. Shape MUST be {operator, conditions, filters} \u2014 NEVER a flat map like {\"region\":\"EMEA\"} (invalid, causes tool error). For tenant-defined custom properties, prefix attribute with 'custom.' (e.g. 'custom.region'). Values are always string arrays even for numbers (e.g. [\"95\"] not 95).",
      "required": [
        "operator",
        "conditions",
        "filters"
      ],
      "properties": {
        "operator": {
          "type": "string",
          "description": "Logical operator joining all conditions. Must be 'and' or 'or'."
        },
        "conditions": {
          "type": "array",
          "description": "List of filter conditions combined with the parent operator.",
          "items": {
            "type": "object",
            "required": [
              "attribute",
              "operator",
              "value"
            ],
            "properties": {
              "attribute": {
                "type": "string",
                "description": "Property to filter by. Tenant-defined custom properties MUST use 'custom.' prefix (e.g. 'custom.region', 'custom.priorityScore', 'custom.industry'). Built-in properties (no prefix): format, folderPath, contentVersionId, contentId, id, engagementMeetingId, contentProfiles, profileVersionId. Date properties: createdDate, expireDate, modifiedDate, publishDate, versionActivatedTime, versionCreatedDate."
              },
              "operator": {
                "type": "string",
                "description": "Comparison operator. Use 'in' or 'notin' for string/enum properties. For date or numeric custom properties use 'greaterthan', 'greaterthanorequal', 'lessthan', or 'lessthanorequal'."
              },
              "value": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "description": "Array of string values to match. Always strings, even for numbers (e.g. [\"95\"] not 95)."
              }
            },
            "examples": [
              {
                "attribute": "custom.region",
                "operator": "in",
                "value": [
                  "EMEA"
                ]
              },
              {
                "attribute": "format",
                "operator": "in",
                "value": [
                  "pdf"
                ]
              },
              {
                "attribute": "custom.priorityScore",
                "operator": "in",
                "value": [
                  "95"
                ]
              }
            ]
          }
        },
        "filters": {
          "type": "array",
          "description": "Nested filter groups for complex boolean logic. Use the same shape as the parent filter.",
          "items": {
            "type": "object"
          }
        }
      },
      "examples": [
        {
          "operator": "and",
          "conditions": [
            {
              "attribute": "custom.region",
              "operator": "in",
              "value": [
                "EMEA"
              ]
            },
            {
              "attribute": "custom.priorityScore",
              "operator": "in",
              "value": [
                "95"
              ]
            }
          ],
          "filters": []
        }
      ]
    }
  },
  "required": [
    "term"
  ]
}

{
  "type": "object",
  "properties": {
    "answer": {
      "type": "string",
      "description": "Answer generated from the LLM model"
    },
    "totalCount": {
      "type": "integer",
      "description": "Total number of the content returned"
    },
    "documents": {
      "type": "array",
      "description": "Source files related to the search",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier of the content"
          },
          "versionId": {
            "type": [
              "string",
              "null"
            ],
            "description": "Content version id. Knowledge content will not have this field"
          },
          "repository": {
            "type": "string",
            "description": "Repository of the content like DocCenter, NewsCenter or Knowledge"
          },
          "name": {
            "type": "string",
            "description": "Content name"
          },
          "teamsiteId": {
            "type": [
              "string",
              "null"
            ],
            "description": "Teamsite id of the standard content. Knowledge content will not have this field"
          },
          "type": {
            "type": "string",
            "description": "Type of the content. FAQ for knowledge, \"3\" for Seismic"
          },
          "format": {
            "type": [
              "string",
              "null"
            ],
            "description": "Content format like mp4, pdf, ppt, etc. Knowledge content will not have this field"
          },
          "properties": {
            "type": [
              "array",
              "null"
            ],
            "description": "Custom properties of the content",
            "items": {
              "type": "object"
            }
          },
          "thumbnailUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "Thumbnail url of the content"
          },
          "pageNumber": {
            "type": "integer",
            "description": "Page number of the published text"
          },
          "downloadUrl": {
            "type": [
              "string",
              "null"
            ],
            "description": "Download url of the content"
          },
          "createdDate": {
            "type": [
              "string",
              "null"
            ],
            "description": "Date created of the content"
          },
          "publishDate": {
            "type": [
              "string",
              "null"
            ],
            "description": "Date published of the content"
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of the content"
          },
          "majorVersion": {
            "type": "integer",
            "description": "Major version of the content"
          },
          "minorVersion": {
            "type": "integer",
            "description": "Minor version of the content"
          },
          "sourceText": {
            "type": "string",
            "description": "Paginate text of the matched search term"
          },
          "status": {
            "type": "string",
            "description": "Status of the content, can be published, approved, and etc"
          },
          "score": {
            "type": "number",
            "description": "Score of the matched text, the higher score the more relevant"
          },
          "applicationUrls": {
            "type": "array",
            "description": "The application urls of the content like universal link or knowledge link",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the application url"
                },
                "url": {
                  "type": "string",
                  "description": "Url of the content"
                }
              },
              "examples": [
                {
                  "name": "DocCenter Universal Link",
                  "url": "https://quake.seismic.com/Link/Content/DCNPLvGpV9KE2Iv9-ZmBnhXQ"
                }
              ]
            }
          }
        }
      }
    }
  }
}