Answer Generation API

This API allows you to fetch answers to a query from SearchAI corresponding to the input query and the meta filters sent in the request body. Additionally, this API also returns debug information about the qualified chunks used to generate answers.

Method	POST
Endpoint	https://{{host}}/api/public/stream/{{AppID}}/advancedSearch
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Answer Generation

Query Parameters

PARAMETER	REQUIRED	DESCRIPTION
host	Required	The environment URL. For example, https://platform.kore.ai
App ID	Required	Unique Identifier of your application. Bot ID corresponds to the appID for your application. To view your App ID, go to the Dev Tools under App Settings. You can view the AppID under the API scopes.

Sample Request

curl --location 'https://platform.kore.ai/api/public/stream/st-3beea617-cfd5-5224-b70b-656c4eef768e/advancedSearch' \
--header 'auth: eyJhbGciOiJnR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiYXBwSWQiOiJjcy05Yzg5MGMwOS1kMzQ5LTUzZjctYmIwZC1jYWEwZGIwOGNmMTkifQ.K2DWFPthcsTlltPTcR1irzjlxr4LYUzknxeTRfANolo' \
--header 'Content-Type: application/json' \
--data '{
 "query": "Conversational AI",
 "metaFilters":  [{
  "condition": "AND",
  "rules": [
    {
      "fieldName": "sourceType",
      "fieldValue": [
        "file"
      ],
      "operator": "contains"
    }
  ]
}]
}'

Body Parameters

PARAMETER	REQUIRED	DESCRIPTION
query	Yes	Query string for search
metaFilter	No	This parameter can be used to define rules to filter out the results from the Answer Index before using them for generating the answer. This parameter takes an array of rules with conditions. For instance, to use only web pages to answer a query, set the filters as shown below. "metaFilters": [ { "condition": "AND", "rules": [ { "fieldName": "sourceType", "fieldValue": [ "web" ], "operator": "contains" }] }]
answerSearch	No	This can be set to true or false. When set to ‘true’, the response will include answers. Conversely, when set to ‘false’, the response will omit the answer to the query. However, you can still use the includeChunksInResponse field to see the qualified chunks in the response. By default, it is set to true.
includeChunksInResponse	No	This can be set to true or false. When set to true, the response will also include a list of qualified chunks along with other parameters. The chunk information is stored in the response's chunk_result field.
IncludeMetaDataAnswers	No	This field can fetch specific chunk metadata fields in the response along with the default fields.The requested fields are returned as part of the **graph_answer **field in the response. If a metadata field listed in this object does not exist, the field is returned in the response with a null value. For instance, to fetch the author name(a metadata field) and subtitle(a custom field) additionally from the chunks, include the following in the request payload. "IncludeMetaDataAnswers": ["chunkMeta.author", “subtitle”]. Note that for metadata fields, use the field name along with the root name, such as chunkMeta.<x>, as shown in the above example.
raclEntityIds	No	Array of RACL values This field specifies the **RACL (Role-Based Access Control List)** values to be used to determine accessible content. It can include both **user identities** (e.g., email addresses) and **permission entity IDs( **e.g., user groups). When raclEntityIds is passed in the API request, Search AI exclusively uses the provided values in raclEntityIds to identify accessible content. No additional mapping between user identities and permission entities is performed to resolve content accessibility. For each value in raclEntityIds, only the content where the sys_racl field contains a matching value will be accessible in the response. For instance, if raclEntityIds: [ “123234”, // Permission Entity ID “[user@example.com](mailto:user@example.com)” // User Identity ] * Content with a sys_racl field that includes either "123234" or "user@example.com" will be accessible. * The API will not perform additional lookups to identify content accessible to other related permission entities for "user@example.com". This parameter enables granular control over content accessibility by explicitly specifying allowed entities. It ensures strict adherence to the provided values without relying on broader permission mappings. “raclEntityIds” takes precendence over any key set to use via RACL resolver API. So even if that is configured whenever “raclEntityIds” is present we will only honor that.