Knowledge Retrieval - Retrieve

Service:: Search Service

API Version:: 2026-05-01-preview

KnowledgeBase retrieves relevant data from backing stores.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-05-01-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	The endpoint URL of the search service.
knowledgeBaseName	path	True	string	The name of the knowledge base.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Type	Description
Accept	Accept	The Accept header.
x-ms-query-source-authorization	string	Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents.
x-ms-client-request-id	string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Request Body

Name	Type	Description
includeActivity	boolean	Indicates retrieval results should include activity information.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	A list of intended queries to execute without model query planning.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	A list of runtime parameters for the knowledge sources.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents in the output.
maxOutputSize	integer (int32)	Limits the maximum size of the content in the output.
maxOutputSizeInTokens	integer (int32)	Limits the maximum size of the content in the output.
maxRuntimeInSeconds	integer (int32)	The maximum runtime in seconds.
messages	KnowledgeBaseMessage[]	A list of chat message style input.
outputMode	KnowledgeRetrievalOutputMode	The output configuration for this retrieval.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	The retrieval reasoning effort configuration.

Responses

Name	Type	Description
200 OK	KnowledgeBaseRetrievalResponse	Successful retrieval response.
Other Status Codes	KnowledgeBaseRetrievalResponse	Partial retrieval response.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://search.azure.com/.default

Examples

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Sample request

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Sample response

Status code:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ],
  "responseSensitivityLabelInfo": {
    "displayName": "Confidential",
    "sensitivityLabelId": "00000000-0000-0000-0000-000000000001",
    "toolTip": "This content is confidential.",
    "priority": 2,
    "color": "#FF0000",
    "isEncrypted": false
  }
}

Status code:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Sample request

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview



{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Sample response

Status code:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Status code:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Definitions

Name	Description
Accept	The Accept header.
AzureBlobKnowledgeSourceParams	Specifies runtime parameters for a azure blob knowledge source
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FabricDataAgentKnowledgeSourceParams	Specifies runtime parameters for a Fabric Data Agent knowledge source
FabricOntologyKnowledgeSourceParams	Specifies runtime parameters for a Fabric Ontology knowledge source
FileKnowledgeSourceParams	Specifies runtime parameters for a File knowledge source
ImageServingStatistics	Statistics about image serving during a retrieval activity.
IndexedOneLakeKnowledgeSourceParams	Specifies runtime parameters for a indexed OneLake knowledge source
IndexedSharePointKnowledgeSourceParams	Specifies runtime parameters for a indexed SharePoint knowledge source
IndexedSqlKnowledgeSourceParams	Specifies runtime parameters for an indexed SQL knowledge source
KnowledgeBaseActivityRecordType	The type of activity record.
KnowledgeBaseAgenticReasoningActivityRecord	Represents an agentic reasoning activity record.
KnowledgeBaseAzureBlobActivityArguments	Represents the arguments the azure blob retrieval activity was run with.
KnowledgeBaseAzureBlobActivityRecord	Represents a azure blob retrieval activity record.
KnowledgeBaseAzureBlobReference	Represents an Azure Blob Storage document reference.
KnowledgeBaseErrorAdditionalInfo	The resource management error additional info.
KnowledgeBaseErrorDetail	The error details.
KnowledgeBaseFabricDataAgentActivityArguments	Represents the arguments the Fabric Data Agent retrieval activity was run with.
KnowledgeBaseFabricDataAgentActivityRecord	Represents a Fabric Data Agent retrieval activity record.
KnowledgeBaseFabricDataAgentReference	Represents a Fabric Data Agent document reference.
KnowledgeBaseFabricOntologyActivityArguments	Represents the arguments the Fabric Ontology retrieval activity was run with.
KnowledgeBaseFabricOntologyActivityRecord	Represents a Fabric Ontology retrieval activity record.
KnowledgeBaseFabricOntologyReference	Represents a Fabric Ontology document reference.
KnowledgeBaseFileActivityArguments	Represents the arguments the File retrieval activity was run with.
KnowledgeBaseFileActivityRecord	Represents a File retrieval activity record.
KnowledgeBaseFileReference	Represents a file document reference.
KnowledgeBaseImageContent	Image content.
KnowledgeBaseIndexedOneLakeActivityArguments	Represents the arguments the indexed OneLake retrieval activity was run with.
KnowledgeBaseIndexedOneLakeActivityRecord	Represents a indexed OneLake retrieval activity record.
KnowledgeBaseIndexedOneLakeReference	Represents an indexed OneLake document reference.
KnowledgeBaseIndexedSharePointActivityArguments	Represents the arguments the indexed SharePoint retrieval activity was run with.
KnowledgeBaseIndexedSharePointActivityRecord	Represents a indexed SharePoint retrieval activity record.
KnowledgeBaseIndexedSharePointReference	Represents an indexed SharePoint document reference.
KnowledgeBaseIndexedSqlActivityArguments	Represents the arguments the indexed SQL retrieval activity was run with.
KnowledgeBaseIndexedSqlActivityRecord	Represents an indexed SQL retrieval activity record.
KnowledgeBaseIndexedSqlReference	Represents an Azure SQL document reference.
KnowledgeBaseMcpServerActivityArguments	Represents the arguments the MCP server retrieval activity was run with.
KnowledgeBaseMcpServerActivityRecord	Represents an MCP server retrieval activity record.
KnowledgeBaseMcpServerReference	Represents an MCP server document reference.
KnowledgeBaseMessage	The natural language message style object.
KnowledgeBaseMessageContentType	The type of message content.
KnowledgeBaseMessageImageContent	Image message type.
KnowledgeBaseMessageTextContent	Text message type.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Represents an LLM answer synthesis activity record.
KnowledgeBaseModelQueryPlanningActivityRecord	Represents an LLM query planning activity record.
KnowledgeBaseModelWebSummarizationActivityRecord	Represents an LLM web summarization activity record.
KnowledgeBaseReferenceType	The type of reference.
KnowledgeBaseRemoteSharePointActivityArguments	Represents the arguments the remote SharePoint retrieval activity was run with.
KnowledgeBaseRemoteSharePointActivityRecord	Represents a remote SharePoint retrieval activity record.
KnowledgeBaseRemoteSharePointReference	Represents a remote SharePoint document reference.
KnowledgeBaseRetrievalRequest	The input contract for the retrieval request.
KnowledgeBaseRetrievalResponse	The output contract for the retrieval response.
KnowledgeBaseSearchIndexActivityArguments	Represents the arguments the search index retrieval activity was run with.
KnowledgeBaseSearchIndexActivityRecord	Represents a search index retrieval activity record.
KnowledgeBaseSearchIndexReference	Represents an Azure Search document reference.
KnowledgeBaseWebActivityArguments	Represents the arguments the web retrieval activity was run with.
KnowledgeBaseWebActivityRecord	Represents a web retrieval activity record.
KnowledgeBaseWebReference	Represents a web document reference.
KnowledgeBaseWorkIQActivityArguments	Represents the arguments the WorkIQ retrieval activity was run with.
KnowledgeBaseWorkIQActivityRecord	Represents a WorkIQ retrieval activity record.
KnowledgeBaseWorkIQReference	Represents a WorkIQ document reference.
KnowledgeRetrievalIntentType	The kind of knowledge base configuration to use.
KnowledgeRetrievalLowReasoningEffort	Run knowledge retrieval with low reasoning effort.
KnowledgeRetrievalMediumReasoningEffort	Run knowledge retrieval with medium reasoning effort.
KnowledgeRetrievalMinimalReasoningEffort	Run knowledge retrieval with minimal reasoning effort.
KnowledgeRetrievalOutputMode	The output configuration for this retrieval.
KnowledgeRetrievalReasoningEffortKind	The amount of effort to use during retrieval.
KnowledgeRetrievalSemanticIntent	A semantic query intent.
KnowledgeSourceKind	The kind of the knowledge source.
McpServerKnowledgeSourceParams	Specifies runtime parameters for an MCP server knowledge source
PurviewSensitivityLabelInfo	Information about the sensitivity label applied to a document
RemoteSharePointKnowledgeSourceParams	Specifies runtime parameters for a remote SharePoint knowledge source
SearchIndexFieldReference	Field reference for a search index.
SearchIndexKnowledgeSourceParams	Specifies runtime parameters for a search index knowledge source
WebKnowledgeSourceParams	Specifies runtime parameters for a web knowledge source
WorkIQAttribution	Attribution information for a WorkIQ reference.
WorkIQKnowledgeSourceParams	Specifies runtime parameters for a WorkIQ knowledge source

Accept

Enumeration

The Accept header.

Value	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

Specifies runtime parameters for a azure blob knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: azureBlob	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	searchservice.knowledgeretrieval.retrieve	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name	Type	Description
error	ErrorDetail	The error object.

FabricDataAgentKnowledgeSourceParams

Object

Specifies runtime parameters for a Fabric Data Agent knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: fabricDataAgent	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

FabricOntologyKnowledgeSourceParams

Object

Specifies runtime parameters for a Fabric Ontology knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: fabricOntology	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

FileKnowledgeSourceParams

Object

Specifies runtime parameters for a File knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: file	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

ImageServingStatistics

Object

Statistics about image serving during a retrieval activity.

Name	Type	Description
imagesRetrieved	integer (int32)	The number of images retrieved from the asset store.
imagesSentToModel	integer (int32)	The number of images sent to the downstream model.
totalImageSizeBytes	integer (int64)	The total size in bytes of images sent to the model.
verbalizationUsed	boolean	Indicates whether image verbalization was used instead of direct image serving.

IndexedOneLakeKnowledgeSourceParams

Object

Specifies runtime parameters for a indexed OneLake knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: indexedOneLake	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

IndexedSharePointKnowledgeSourceParams

Object

Specifies runtime parameters for a indexed SharePoint knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: indexedSharePoint	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

IndexedSqlKnowledgeSourceParams

Object

Specifies runtime parameters for an indexed SQL knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: indexedSql	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

KnowledgeBaseActivityRecordType

Enumeration

The type of activity record.

Value	Description
searchIndex	Search index retrieval activity.
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	Indexed SharePoint retrieval activity.
indexedOneLake	Indexed OneLake retrieval activity.
web	Web retrieval activity.
remoteSharePoint	Remote SharePoint retrieval activity.
workIQ	WorkIQ retrieval activity.
fabricDataAgent	Fabric Data Agent retrieval activity.
fabricOntology	Fabric Ontology retrieval activity.
mcpServer	MCP server retrieval activity.
file	File retrieval activity.
indexedSql	Indexed SQL retrieval activity.
modelQueryPlanning	LLM query planning activity.
modelAnswerSynthesis	LLM answer synthesis activity.
modelWebSummarization	LLM web summarization activity.
agenticReasoning	Agentic reasoning activity.

KnowledgeBaseAgenticReasoningActivityRecord

Object

Represents an agentic reasoning activity record.

Name	Type	Description
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
reasoningTokens	integer (int32)	The number of input tokens for agentic reasoning.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	The retrieval reasoning effort configuration.
type	string: agenticReasoning	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseAzureBlobActivityArguments

Object

Represents the arguments the azure blob retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query blob contents.

KnowledgeBaseAzureBlobActivityRecord

Object

Represents a azure blob retrieval activity record.

Name	Type	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	The azure blob arguments for the retrieval activity.
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: azureBlob	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseAzureBlobReference

Object

Represents an Azure Blob Storage document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
blobUrl	string	The blob URL for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: azureBlob	The type of the reference.

KnowledgeBaseErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	searchservice.knowledgeretrieval.retrieve	The additional info.
type	string	The additional info type.

KnowledgeBaseErrorDetail

Object

The error details.

Name	Type	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	KnowledgeBaseErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

KnowledgeBaseFabricDataAgentActivityArguments

Object

Represents the arguments the Fabric Data Agent retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query the Fabric Data Agent knowledge source.

KnowledgeBaseFabricDataAgentActivityRecord

Object

Represents a Fabric Data Agent retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	The Fabric Data Agent arguments for the retrieval activity.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: fabricDataAgent	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseFabricDataAgentReference

Object

Represents a Fabric Data Agent document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
dataAgentId	string	The Fabric Data Agent ID.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: fabricDataAgent	The type of the reference.
workspaceId	string	The Fabric workspace ID.

KnowledgeBaseFabricOntologyActivityArguments

Object

Represents the arguments the Fabric Ontology retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query the Fabric Ontology knowledge source.

KnowledgeBaseFabricOntologyActivityRecord

Object

Represents a Fabric Ontology retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	The Fabric Ontology arguments for the retrieval activity.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: fabricOntology	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseFabricOntologyReference

Object

Represents a Fabric Ontology document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
id	string	The ID of the reference.
ontologyId	string	The ontology ID within the workspace.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: fabricOntology	The type of the reference.
workspaceId	string	The Fabric workspace ID.

KnowledgeBaseFileActivityArguments

Object

Represents the arguments the File retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query file contents.

KnowledgeBaseFileActivityRecord

Object

Represents a File retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
fileArguments	KnowledgeBaseFileActivityArguments	The File arguments for the retrieval activity.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: file	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseFileReference

Object

Represents a file document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
docName	string	The document name for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: file	The type of the reference.

KnowledgeBaseImageContent

Object

Image content.

Name	Type	Description
url	string (uri)	The url of the image.

KnowledgeBaseIndexedOneLakeActivityArguments

Object

Represents the arguments the indexed OneLake retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query indexed OneLake contents.

KnowledgeBaseIndexedOneLakeActivityRecord

Object

Represents a indexed OneLake retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	The indexed OneLake arguments for the retrieval activity.
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: indexedOneLake	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseIndexedOneLakeReference

Object

Represents an indexed OneLake document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
docUrl	string	The document URL for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: indexedOneLake	The type of the reference.

KnowledgeBaseIndexedSharePointActivityArguments

Object

Represents the arguments the indexed SharePoint retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query indexed SharePoint contents.

KnowledgeBaseIndexedSharePointActivityRecord

Object

Represents a indexed SharePoint retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	The indexed SharePoint arguments for the retrieval activity.
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: indexedSharePoint	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseIndexedSharePointReference

Object

Represents an indexed SharePoint document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
docUrl	string	The document URL for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: indexedSharePoint	The type of the reference.

KnowledgeBaseIndexedSqlActivityArguments

Object

Represents the arguments the indexed SQL retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query indexed SQL contents.

KnowledgeBaseIndexedSqlActivityRecord

Object

Represents an indexed SQL retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	The indexed SQL arguments for the retrieval activity.
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: indexedSql	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseIndexedSqlReference

Object

Represents an Azure SQL document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
docUrl	string	The document URL for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: indexedSql	The type of the reference.

KnowledgeBaseMcpServerActivityArguments

Object

Represents the arguments the MCP server retrieval activity was run with.

Name	Type	Description
toolArguments	searchservice.knowledgeretrieval.retrieve	The arguments passed to the MCP server tool.
toolName	string	The name of the MCP server tool used for the retrieval activity.

KnowledgeBaseMcpServerActivityRecord

Object

Represents an MCP server retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	The MCP server arguments for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: mcpServer	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseMcpServerReference

Object

Represents an MCP server document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
title	string	The title of the MCP server tool result.
toolName	string	The name of the MCP server tool that produced the reference.
type	string: mcpServer	The type of the reference.

KnowledgeBaseMessage

Object

The natural language message style object.

Name	Type	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	The content of the message.
role	string	The role of the tool response.

KnowledgeBaseMessageContentType

Enumeration

The type of message content.

Value	Description
text	Text message content kind.
image	Image message content kind.

KnowledgeBaseMessageImageContent

Object

Image message type.

Name	Type	Description
image	KnowledgeBaseImageContent	The image content.
type	string: image	The type of the message

KnowledgeBaseMessageTextContent

Object

Text message type.

Name	Type	Description
text	string	The text content.
type	string: text	The type of the message

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

Represents an LLM answer synthesis activity record.

Name	Type	Description
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
inputTokens	integer (int32)	The number of input tokens for the LLM answer synthesis activity.
modelName	string	The name of the model used for the LLM answer synthesis activity.
outputTokens	integer (int32)	The number of output tokens for the LLM answer synthesis activity.
type	string: modelAnswerSynthesis	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseModelQueryPlanningActivityRecord

Object

Represents an LLM query planning activity record.

Name	Type	Description
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
inputTokens	integer (int32)	The number of input tokens for the LLM query planning activity.
modelName	string	The name of the model used for the LLM query planning activity.
outputTokens	integer (int32)	The number of output tokens for the LLM query planning activity.
type	string: modelQueryPlanning	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseModelWebSummarizationActivityRecord

Object

Represents an LLM web summarization activity record.

Name	Type	Description
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
inputTokens	integer (int32)	The number of input tokens for the LLM web summarization activity.
modelName	string	The name of the model used for the LLM web summarization activity.
outputTokens	integer (int32)	The number of output tokens for the LLM web summarization activity.
type	string: modelWebSummarization	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseReferenceType

Enumeration

The type of reference.

Value	Description
searchIndex	Search index document reference.
azureBlob	Azure Blob document reference.
indexedSharePoint	Indexed SharePoint document reference.
indexedOneLake	Indexed OneLake document reference.
web	Web document reference.
remoteSharePoint	Remote SharePoint document reference.
workIQ	Work IQ document reference.
fabricDataAgent	Fabric Data Agent document reference.
fabricOntology	Fabric Ontology document reference.
mcpServer	MCP server document reference.
file	File document reference.
indexedSql	Indexed SQL document reference.

KnowledgeBaseRemoteSharePointActivityArguments

Object

Represents the arguments the remote SharePoint retrieval activity was run with.

Name	Type	Description
filterExpressionAddOn	string	The filter expression add-on for the retrieval activity.
search	string	The search string used to query the remote SharePoint knowledge source.

KnowledgeBaseRemoteSharePointActivityRecord

Object

Represents a remote SharePoint retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	The remote SharePoint arguments for the retrieval activity.
type	string: remoteSharePoint	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseRemoteSharePointReference

Object

Represents a remote SharePoint document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: remoteSharePoint	The type of the reference.
webUrl	string (uri)	The url the reference data originated from.

KnowledgeBaseRetrievalRequest

Object

The input contract for the retrieval request.

Name	Type	Description
includeActivity	boolean	Indicates retrieval results should include activity information.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	A list of intended queries to execute without model query planning.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	A list of runtime parameters for the knowledge sources.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents in the output.
maxOutputSize	integer (int32)	Limits the maximum size of the content in the output.
maxOutputSizeInTokens	integer (int32)	Limits the maximum size of the content in the output.
maxRuntimeInSeconds	integer (int32)	The maximum runtime in seconds.
messages	KnowledgeBaseMessage[]	A list of chat message style input.
outputMode	KnowledgeRetrievalOutputMode	The output configuration for this retrieval.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	The retrieval reasoning effort configuration.

KnowledgeBaseRetrievalResponse

Object

The output contract for the retrieval response.

Name	Type	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	The activity records for tracking progress and billing implications.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	The references for the retrieval data used in the response.
response	KnowledgeBaseMessage[]	The response messages.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the overall response.

KnowledgeBaseSearchIndexActivityArguments

Object

Represents the arguments the search index retrieval activity was run with.

Name	Type	Description
filter	string	The filter string.
search	string	The search string used to query the search index.
searchFields	SearchIndexFieldReference[]	What fields were searched against.
semanticConfigurationName	string	What semantic configuration was used from the search index.
sourceDataFields	SearchIndexFieldReference[]	What fields were selected for search.

KnowledgeBaseSearchIndexActivityRecord

Object

Represents a search index retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	The search index arguments for the retrieval activity.
type	string: searchIndex	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.

KnowledgeBaseSearchIndexReference

Object

Represents an Azure Search document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
docKey	string	The document key for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	The sensitivity label information for the reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: searchIndex	The type of the reference.

KnowledgeBaseWebActivityArguments

Object

Represents the arguments the web retrieval activity was run with.

Name	Type	Description
count	integer (int32)	The number of web results returned.
freshness	string	The freshness for the retrieval activity.
language	string	The language for the retrieval activity.
market	string	The market for the retrieval activity.
search	string	The search string used to query the web.

KnowledgeBaseWebActivityRecord

Object

Represents a web retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: web	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.
webArguments	KnowledgeBaseWebActivityArguments	The web arguments for the retrieval activity.

KnowledgeBaseWebReference

Object

Represents a web document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
title	string	The title of the web document.
type	string: web	The type of the reference.
url	string (uri)	The url the reference data originated from.

KnowledgeBaseWorkIQActivityArguments

Object

Represents the arguments the WorkIQ retrieval activity was run with.

Name	Type	Description
search	string	The search string used to query the WorkIQ knowledge source.

KnowledgeBaseWorkIQActivityRecord

Object

Represents a WorkIQ retrieval activity record.

Name	Type	Description
count	integer (int32)	The count of documents retrieved that were sufficiently relevant to pass the reranker threshold.
elapsedMs	integer (int32)	The elapsed time in milliseconds for the retrieval activity.
error	KnowledgeBaseErrorDetail	The error detail explaining why the operation failed. This property is only included when the activity does not succeed.
id	integer (int32)	The ID of the activity record.
imageServing	ImageServingStatistics	Statistics about image serving for this retrieval activity
knowledgeSourceName	string	The knowledge source for the retrieval activity.
queryTime	string (date-time)	The query time for this retrieval activity.
type	string: workIQ	The type of the activity record.
warning	string	A warning message surfacing potential configuration issues observed during the activity, such as documents dropped due to score thresholding, token limit truncation, or timeout conditions.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	The WorkIQ arguments for the retrieval activity.

KnowledgeBaseWorkIQReference

Object

Represents a WorkIQ document reference.

Name	Type	Description
activitySource	integer (int32)	The source activity ID for the reference.
attributions	WorkIQAttribution[]	The attributions for the reference.
id	string	The ID of the reference.
rerankerScore	number (float)	The reranker score for the document reference.
sourceData	searchservice.knowledgeretrieval.retrieve	The source data for the reference.
type	string: workIQ	The type of the reference.

KnowledgeRetrievalIntentType

Enumeration

The kind of knowledge base configuration to use.

Value	Description
semantic	A natural language semantic query intent.

KnowledgeRetrievalLowReasoningEffort

Object

Run knowledge retrieval with low reasoning effort.

Name	Type	Description
kind	string: low	The kind of reasoning effort.

KnowledgeRetrievalMediumReasoningEffort

Object

Run knowledge retrieval with medium reasoning effort.

Name	Type	Description
kind	string: medium	The kind of reasoning effort.

KnowledgeRetrievalMinimalReasoningEffort

Object

Run knowledge retrieval with minimal reasoning effort.

Name	Type	Description
kind	string: minimal	The kind of reasoning effort.

KnowledgeRetrievalOutputMode

Enumeration

The output configuration for this retrieval.

Value	Description
extractiveData	Return data from the knowledge sources directly without generative alteration.
answerSynthesis	Synthesize an answer for the response payload.

KnowledgeRetrievalReasoningEffortKind

Enumeration

The amount of effort to use during retrieval.

Value	Description
minimal	Does not perform any source selections, query planning, or iterative search.
low	Use low reasoning during retrieval.
medium	Use a moderate amount of reasoning during retrieval.

KnowledgeRetrievalSemanticIntent

Object

A semantic query intent.

Name	Type	Description
search	string	The semantic query to execute
type	string: semantic	The type of the intent.

KnowledgeSourceKind

Enumeration

The kind of the knowledge source.

Value	Description
searchIndex	A knowledge source that reads data from a Search Index.
azureBlob	A knowledge source that read and ingest data from Azure Blob Storage to a Search Index.
indexedSharePoint	A knowledge source that reads data from indexed SharePoint.
indexedOneLake	A knowledge source that reads data from indexed OneLake.
indexedSql	A knowledge source that retrieves and ingests data from Azure SQL Database or SQL Managed Instance to a Search Index.
web	A knowledge source that reads data from the web.
remoteSharePoint	A knowledge source that reads data from remote SharePoint.
workIQ	A knowledge source that reads data from work IQ
file	A knowledge source that supports direct file upload and indexing.
mcpServer	A knowledge source backed by an MCP (Model Context Protocol) server.
fabricDataAgent	A knowledge source that retrieves data from a Fabric Data Agent.
fabricOntology	A knowledge source that retrieves data from Microsoft Fabric Ontology ontologies.

McpServerKnowledgeSourceParams

Object

Specifies runtime parameters for an MCP server knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: mcpServer	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

PurviewSensitivityLabelInfo

Object

Information about the sensitivity label applied to a document

Name	Type	Description
color	string	The color that the UI should display for the label, if configured.
displayName	string	The display name for the sensitivity label.
isEncrypted	boolean	Indicates whether the sensitivity label enforces encryption.
priority	integer (int32)	The priority in which the sensitivity label is applied.
sensitivityLabelId	string	The ID of the sensitivity label.
toolTip	string	The tooltip that should be displayed for the label in a UI.

RemoteSharePointKnowledgeSourceParams

Object

Specifies runtime parameters for a remote SharePoint knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
filterExpressionAddOn	string	A filter condition applied to the SharePoint data source. It must be specified in the Keyword Query Language syntax. It will be combined as a conjunction with the filter expression specified in the knowledge source definition.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: remoteSharePoint	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

SearchIndexFieldReference

Object

Field reference for a search index.

Name	Type	Description
name	string	The name of the field.

SearchIndexKnowledgeSourceParams

Object

Specifies runtime parameters for a search index knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
filterAddOn	string	A filter condition applied to the index (e.g., 'State eq VA').
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: searchIndex	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

WebKnowledgeSourceParams

Object

Specifies runtime parameters for a web knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
count	integer (int32)	The number of web results to return.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
freshness	string	The freshness of web results.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: web	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
language	string	The language of the web results.
market	string	The market of the web results.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.

WorkIQAttribution

Object

Attribution information for a WorkIQ reference.

Name	Type	Description
seeMoreWebUrl	string (uri)	The URL for the attribution.

WorkIQKnowledgeSourceParams

Object

Specifies runtime parameters for a WorkIQ knowledge source

Name	Type	Description
alwaysQuerySource	boolean	Indicates that this knowledge source should bypass source selection and always be queried at retrieval time.
enableImageServing	boolean	Indicates whether image serving should be enabled for this knowledge source at retrieval time. When true, images extracted during ingestion are delivered to downstream models.
failOnError	boolean	Indicates that the entire retrieval request should fail if retrieval from this knowledge source encounters an error. Defaults to false.
includeReferenceSourceData	boolean	Indicates whether references should include the structured data obtained during retrieval in their payload.
includeReferences	boolean	Indicates whether references should be included for data retrieved from this source.
kind	string: workIQ	The type of the knowledge source.
knowledgeSourceName	string	The name of the index the params apply to.
maxOutputDocuments	integer (int32)	Limits the maximum number of documents returned from this knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.