Knowledge Retrieval - Retrieve Stream

Service:: Search Service

API Version:: 2026-08-01-preview

Retrieves relevant data from backing stores and streams progress and results as server-sent events.

Process the response incrementally using server-sent event framing. Each event contains an event name and a JSON-encoded data payload. The stream ends with either a response.completed event or an error event. OpenAPI 2.0 represents the response body as a string, so generated clients may expose the raw response without typed event parsing. Do not deserialize the complete response body as a single JSON document.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?_overload=retrieveStream&api-version=2026-08-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	Required	Type	Description
Accept	True	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-query-work-iq-source-authorization		string (password)	User assertion token for a customer-owned Entra app registration configured on a Work IQ knowledge source. Used for on-behalf-of authentication to the Work IQ API.
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: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	The retrieval reasoning effort configuration.

Responses

Name	Type	Description
200 OK	string	The request has succeeded. Media Types: "text/event-stream", "application/json"
Other Status Codes	ErrorResponse	An unexpected error response. Media Types: "text/event-stream", "application/json"

Name

Type

Description

200 OK

string

The request has succeeded.

Media Types: "text/event-stream", "application/json"

Other Status Codes

ErrorResponse

An unexpected error response.

Media Types: "text/event-stream", "application/json"

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

KnowledgeBaseRetrieveStream

Sample request

HTTP

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





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    }
  ]
}

Sample response

Status code:: 200

"event: retrieval.started\ndata: {\"requestId\":\"00000000-0000-0000-0000-000000000001\",\"knowledgeBaseName\":\"base-preview-test\",\"outputMode\":\"answerSynthesis\",\"reasoningEffort\":{\"kind\":\"auto\"}}\n\nevent: activity.started\ndata: {\"id\":0,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:44.000Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":0,\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"startedAt\":\"2025-01-01T00:08:44.000Z\",\"completedAt\":\"2025-01-01T00:08:45.045Z\",\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":null,\"semanticConfigurationName\":\"testconfig\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"id\"}],\"searchFields\":[]}}\n\nevent: activity.started\ndata: {\"id\":1,\"type\":\"agenticReasoning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"agenticReasoning\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:45.400Z\",\"reasoningTokens\":39,\"retrievalReasoningEffort\":{\"kind\":\"auto\"},\"logicalReasoningEffort\":{\"kind\":\"auto\"}}\n\nevent: activity.started\ndata: {\"id\":2,\"type\":\"modelAnswerSynthesis\",\"startedAt\":\"2025-01-01T00:08:45.400Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelAnswerSynthesis\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.400Z\",\"completedAt\":\"2025-01-01T00:08:45.900Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":500,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: answer.completed\ndata: {\"messageIndex\":0,\"message\":{\"content\":[{\"type\":\"text\",\"text\":\"Hello! How can I help you today?\"}]}}\n\nevent: references.completed\ndata: [{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":0,\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"},\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://previewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cid&api-version=2026-08-01-preview\"}]\n\nevent: response.completed\ndata: {\"statusCode\":200,\"response\":{\"response\":[{\"content\":[{\"type\":\"text\",\"text\":\"Hello! How can I help you today?\"}]}],\"activity\":[{\"type\":\"searchIndex\",\"id\":0,\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"startedAt\":\"2025-01-01T00:08:44.000Z\",\"completedAt\":\"2025-01-01T00:08:45.045Z\",\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":null,\"semanticConfigurationName\":\"testconfig\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"id\"}],\"searchFields\":[]}},{\"type\":\"agenticReasoning\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:45.400Z\",\"reasoningTokens\":39,\"retrievalReasoningEffort\":{\"kind\":\"auto\"},\"logicalReasoningEffort\":{\"kind\":\"auto\"}},{\"type\":\"modelAnswerSynthesis\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.400Z\",\"completedAt\":\"2025-01-01T00:08:45.900Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":500,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}],\"references\":[{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":0,\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"},\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://previewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cid&api-version=2026-08-01-preview\"}]}}\n\n"

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
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
KnowledgeBaseImageContent	Image content.
KnowledgeBaseMessage	The natural language message style object.
KnowledgeBaseMessageContentType	The type of message content.
KnowledgeBaseMessageImageContent	Image message type.
KnowledgeBaseMessageTextContent	Text message type.
KnowledgeBaseRetrievalRequest	The input contract for the retrieval request.
KnowledgeRetrievalAutoReasoningEffort	Automatically select the reasoning effort during retrieval. The service seeds every request at the cheapest tier and escalates only as far as needed, up to the service's maximum available tier.
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.
KnowledgeSourceResultsProcessing	Controls whether a knowledge source's results are reranked.
McpServerKnowledgeSourceParams	Specifies runtime parameters for an MCP server knowledge source
RemoteSharePointKnowledgeSourceParams	Specifies runtime parameters for a remote SharePoint knowledge source
SearchIndexKnowledgeSourceBoostKind	The kind of boost hint for a search index knowledge source.
SearchIndexKnowledgeSourceFieldValueBoost	A hint that boosts documents based on a field value.
SearchIndexKnowledgeSourceFilterHint	A hint that identifies a field and representative values the query planner can use when constructing a filter.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	A hint that boosts documents based on a multi-word expression.
SearchIndexKnowledgeSourceParams	Specifies runtime parameters for a search index knowledge source
SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts for a search index knowledge source.
WebKnowledgeSourceParams	Specifies runtime parameters for a web knowledge source
WorkIQKnowledgeSourceParams	Specifies runtime parameters for a WorkIQ knowledge source

Accept

Enumeration

The Accept header.

Value	Description
text/event-stream

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	searchservice.knowledgeretrieval.retrievestream	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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

KnowledgeBaseImageContent

Object

Image content.

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

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

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: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	The retrieval reasoning effort configuration.

KnowledgeRetrievalAutoReasoningEffort

Object

Automatically select the reasoning effort during retrieval. The service seeds every request at the cheapest tier and escalates only as far as needed, up to the service's maximum available tier.

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

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.
auto	Automatically select the reasoning effort during retrieval, escalating from the cheapest tier only as far as needed.

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.

KnowledgeSourceResultsProcessing

Enumeration

Controls whether a knowledge source's results are reranked.

Value	Description
rerank	Results from this knowledge source go through the reranking pipeline. This is the default behavior.
none	Results from this knowledge source bypass reranking and preserve their underlying order.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

SearchIndexKnowledgeSourceBoostKind

Enumeration

The kind of boost hint for a search index knowledge source.

Value	Description
fieldValue	Boost documents based on a field value.
multiWordExpression	Boost documents based on a multi-word expression.

SearchIndexKnowledgeSourceFieldValueBoost

Object

A hint that boosts documents based on a field value.

Name	Type	Description
boost	number (double)	A multiplier for the document score. Must be a positive number not equal to 1.0.
boostInstructions	string	Natural-language instructions that explain when and how to apply the boost.
field	string minLength: 1	The name of the search index field.
fieldValues	string[]	Representative values for the field.
kind	string: fieldValue	The kind of boost hint.

SearchIndexKnowledgeSourceFilterHint

Object

A hint that identifies a field and representative values the query planner can use when constructing a filter.

Name	Type	Description
field	string minLength: 1	The name of the filterable search index field.
fieldValues	string[]	Representative values for the field.
filterInstructions	string	Natural-language instructions that explain when and how to filter on the field.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

A hint that boosts documents based on a multi-word expression.

Name	Type	Description
boost	number (double)	A multiplier for the document score. Must be a positive number not equal to 1.0.
boostInstructions	string	Natural-language instructions that explain when and how to apply the boost.
fieldValues	string[]	Representative values for the boost.
kind	string: multiWordExpression	The kind of boost hint.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Hints that guide query planning toward useful filters and boosts. If specified, this object replaces the complete set of query hints configured on the knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

SearchIndexKnowledgeSourceQueryHints

Object

Hints that guide query planning toward useful filters and boosts for a search index knowledge source.

Name	Type	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Boost hints that identify conditions the query planner can use to influence document ranking.
filters	SearchIndexKnowledgeSourceFilterHint[]	Filter hints that identify fields and representative values the query planner can use when constructing filters.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.

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.
neverQuerySource	boolean	Indicates that this knowledge source should be excluded from the request's candidate set and never queried at retrieval time. The exclusion is request-local and does not modify knowledge base membership. Cannot be combined with alwaysQuerySource on the same knowledge source.
rerankerThreshold	number (float)	The reranker threshold all retrieved documents must meet to be included in the response.
resultsProcessing	KnowledgeSourceResultsProcessing	Overrides the knowledge source's stored resultsProcessing for this retrieve call only. When omitted, the stored knowledge source value applies.