Knowledge Retrieval - Retrieve

Serviço:: Search Service

Versão da API:: 2026-04-01

A KnowledgeBase recupera dados relevantes de armazenamentos de backup.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
knowledgeBaseName	path	True	string	O nome da base de dados de conhecimento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo da solicitação

Nome	Tipo	Description
includeActivity	boolean	Indica que os resultados da recuperação devem incluir informações sobre a atividade.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Uma lista de consultas pretendidas a serem executadas sem planejamento de consulta de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Uma lista de parâmetros de tempo de execução para as fontes de conhecimento.
maxOutputSizeInTokens	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxRuntimeInSeconds	integer (int32)	O tempo máximo de execução em segundos.

Respostas

Nome	Tipo	Description
200 OK	KnowledgeBaseRetrievalResponse	Resposta de coleta bem-sucedida.
Other Status Codes	KnowledgeBaseRetrievalResponse	Resposta parcial de recuperação.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

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

Exemplos

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Solicitação de exemplo

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "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": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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"
    }
  ]
}

Código de status:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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

Solicitação de exemplo

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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"
    }
  ]
}

Código de status:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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"
    }
  ]
}

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
AzureBlobKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento de blob do Azure
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).
IndexedOneLakeKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento indexada do OneLake
KnowledgeBaseActivityRecordType	O tipo de registro de atividade.
KnowledgeBaseAgenticReasoningActivityRecord	Representa um registro de atividade de raciocínio agente.
KnowledgeBaseAzureBlobActivityArguments	Representa os argumentos com os quais a atividade de recuperação de blob do Azure foi executada.
KnowledgeBaseAzureBlobActivityRecord	Representa um registro de atividade de recuperação de blob do Azure.
KnowledgeBaseAzureBlobReference	Representa uma referência de documento do Armazenamento de Blobs do Azure.
KnowledgeBaseErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
KnowledgeBaseErrorDetail	Os detalhes do erro.
KnowledgeBaseImageContent	Conteúdo de imagens.
KnowledgeBaseIndexedOneLakeActivityArguments	Representa os argumentos com que a atividade de recuperação indexada do OneLake foi conduzida.
KnowledgeBaseIndexedOneLakeActivityRecord	Representa um registro indexado de atividade de recuperação do OneLake.
KnowledgeBaseIndexedOneLakeReference	Representa uma referência indexada de documento OneLake.
KnowledgeBaseMessage	O objeto de estilo de mensagem de linguagem natural.
KnowledgeBaseMessageContentType	O tipo de conteúdo da mensagem.
KnowledgeBaseMessageImageContent	Tipo de mensagem de imagem.
KnowledgeBaseMessageTextContent	Tipo de mensagem de texto.
KnowledgeBaseModelWebSummarizationActivityRecord	Representa um registro de atividade de resumo web de LLM.
KnowledgeBaseReferenceType	O tipo de referência.
KnowledgeBaseRetrievalRequest	O contrato de entrada para a solicitação de recuperação.
KnowledgeBaseRetrievalResponse	O contrato de saída para a resposta de recuperação.
KnowledgeBaseSearchIndexActivityArguments	Representa os argumentos com os quais a atividade de recuperação de índice de pesquisa foi executada.
KnowledgeBaseSearchIndexActivityRecord	Representa um registro de atividade de recuperação de índice de pesquisa.
KnowledgeBaseSearchIndexReference	Representa uma referência de documento do Azure Search.
KnowledgeBaseWebActivityArguments	Representa os argumentos com que a atividade de recuperação web foi conduzida.
KnowledgeBaseWebActivityRecord	Representa um registro de atividade de recuperação web.
KnowledgeBaseWebReference	Representa uma referência de documento da Web.
KnowledgeRetrievalIntentType	O tipo de configuração da base de dados de conhecimento a ser usada.
KnowledgeRetrievalMinimalReasoningEffort	Execute a recuperação de conhecimento com o mínimo de esforço de raciocínio.
KnowledgeRetrievalReasoningEffortKind	A quantidade de esforço a ser usado durante a recuperação.
KnowledgeRetrievalSemanticIntent	Uma intenção de consulta semântica.
KnowledgeSourceKind	O tipo de fonte de conhecimento.
SearchIndexFieldReference	Referência de campo para um índice de busca.
SearchIndexKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento de índice de pesquisa
WebKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento da Web

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento de blob do Azure

Nome	Tipo	Description
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: azureBlob	O tipo da fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem atender para serem incluídos na resposta.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em operações falhadas. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexedOneLakeKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento indexada do OneLake

Nome	Tipo	Description
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: indexedOneLake	O tipo da fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem atender para serem incluídos na resposta.

KnowledgeBaseActivityRecordType

Enumeração

O tipo de registro de atividade.

Valor	Description
searchIndex	Atividade de busca de índice de recuperação.
azureBlob	Atividade de recuperação do Azure Blob.
indexedOneLake	Atividade de recuperação indexada do OneLake.
web	Atividade de recuperação web.
modelWebSummarization	Atividade de resumo web de LLM.
agenticReasoning	Atividade de raciocínio agente.

KnowledgeBaseAgenticReasoningActivityRecord

Objeto

Representa um registro de atividade de raciocínio agente.

Nome	Tipo	Description
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
reasoningTokens	integer (int32)	O número de tokens de entrada para o raciocínio agente.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalMinimalReasoningEffort	A configuração do esforço de raciocínio de recuperação.
type	string: agenticReasoning	O tipo de registro de atividade.

KnowledgeBaseAzureBlobActivityArguments

Objeto

Representa os argumentos com os quais a atividade de recuperação de blob do Azure foi executada.

Nome	Tipo	Description
search	string	A cadeia de caracteres de pesquisa usada para consultar o conteúdo do blob.

KnowledgeBaseAzureBlobActivityRecord

Objeto

Representa um registro de atividade de recuperação de blob do Azure.

Nome	Tipo	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Os argumentos do blob azul para a atividade de recuperação.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limite do reclassificador.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
type	string: azureBlob	O tipo de registro de atividade.

KnowledgeBaseAzureBlobReference

Objeto

Representa uma referência de documento do Armazenamento de Blobs do Azure.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
blobUrl	string	A URL do blob para a referência.
id	string	A ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: azureBlob	O tipo da referência.

KnowledgeBaseErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

KnowledgeBaseErrorDetail

Objeto

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	KnowledgeBaseErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

KnowledgeBaseImageContent

Objeto

Conteúdo de imagens.

Nome	Tipo	Description
url	string (uri)	O url da imagem.

KnowledgeBaseIndexedOneLakeActivityArguments

Objeto

Representa os argumentos com que a atividade de recuperação indexada do OneLake foi conduzida.

Nome	Tipo	Description
search	string	A string de busca usada para consultar indexava o conteúdo do OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objeto

Representa um registro indexado de atividade de recuperação do OneLake.

Nome	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limite do reclassificador.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Os argumentos indexados do OneLake para a atividade de recuperação.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
type	string: indexedOneLake	O tipo de registro de atividade.

KnowledgeBaseIndexedOneLakeReference

Objeto

Representa uma referência indexada de documento OneLake.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
docUrl	string	A URL do documento para a referência.
id	string	A ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: indexedOneLake	O tipo da referência.

KnowledgeBaseMessage

Objeto

O objeto de estilo de mensagem de linguagem natural.

Nome	Tipo	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	O conteúdo da mensagem.
role	string	O papel da resposta da ferramenta.

KnowledgeBaseMessageContentType

Enumeração

O tipo de conteúdo da mensagem.

Valor	Description
text	Tipo de conteúdo de mensagem de texto.
image	Tipo de conteúdo da mensagem de imagem.

KnowledgeBaseMessageImageContent

Objeto

Tipo de mensagem de imagem.

Nome	Tipo	Description
image	KnowledgeBaseImageContent	O conteúdo da imagem.
type	string: image	O tipo da mensagem

KnowledgeBaseMessageTextContent

Objeto

Tipo de mensagem de texto.

Nome	Tipo	Description
text	string	O conteúdo do texto.
type	string: text	O tipo da mensagem

KnowledgeBaseModelWebSummarizationActivityRecord

Objeto

Representa um registro de atividade de resumo web de LLM.

Nome	Tipo	Description
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
inputTokens	integer (int32)	O número de tokens de entrada para a atividade de resumo web do LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de resumo web do LLM.
type	string: modelWebSummarization	O tipo de registro de atividade.

KnowledgeBaseReferenceType

Enumeração

O tipo de referência.

Valor	Description
searchIndex	Pesquise índice de referência de documentos.
azureBlob	Referência de documento Azure Blob.
indexedOneLake	Referência indexada do documento OneLake.
web	Referência de documentos na web.

KnowledgeBaseRetrievalRequest

Objeto

O contrato de entrada para a solicitação de recuperação.

Nome	Tipo	Description
includeActivity	boolean	Indica que os resultados da recuperação devem incluir informações sobre a atividade.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Uma lista de consultas pretendidas a serem executadas sem planejamento de consulta de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Uma lista de parâmetros de tempo de execução para as fontes de conhecimento.
maxOutputSizeInTokens	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxRuntimeInSeconds	integer (int32)	O tempo máximo de execução em segundos.

KnowledgeBaseRetrievalResponse

Objeto

O contrato de saída para a resposta de recuperação.

Nome	Tipo	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Os registros de atividade para acompanhar o progresso e as implicações de cobrança.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	As referências para os dados de recuperação usados na resposta.
response	KnowledgeBaseMessage[]	As mensagens de resposta.

KnowledgeBaseSearchIndexActivityArguments

Objeto

Representa os argumentos com os quais a atividade de recuperação de índice de pesquisa foi executada.

Nome	Tipo	Description
filter	string	A cadeia de caracteres de filtro.
search	string	A cadeia de caracteres de pesquisa usada para consultar o índice de pesquisa.
searchFields	SearchIndexFieldReference[]	Quais campos foram pesquisados.
semanticConfigurationName	string	Qual configuração semântica foi usada a partir do índice de busca.
sourceDataFields	SearchIndexFieldReference[]	Quais campos foram selecionados para busca.

KnowledgeBaseSearchIndexActivityRecord

Objeto

Representa um registro de atividade de recuperação de índice de pesquisa.

Nome	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limite do reclassificador.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Os argumentos do índice de pesquisa para a atividade de recuperação.
type	string: searchIndex	O tipo de registro de atividade.

KnowledgeBaseSearchIndexReference

Objeto

Representa uma referência de documento do Azure Search.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
docKey	string	A chave do documento para a referência.
id	string	A ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: searchIndex	O tipo da referência.

KnowledgeBaseWebActivityArguments

Objeto

Representa os argumentos com que a atividade de recuperação web foi conduzida.

Nome	Tipo	Description
count	integer (int32)	O número de resultados web retornados.
freshness	string	A frescura para a atividade de recuperação.
language	string	A linguagem para a atividade de recuperação.
market	string	O mercado para a atividade de recuperação.
search	string	A string de busca usada para consultar a web.

KnowledgeBaseWebActivityRecord

Objeto

Representa um registro de atividade de recuperação web.

Nome	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limite do reclassificador.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
type	string: web	O tipo de registro de atividade.
webArguments	KnowledgeBaseWebActivityArguments	Os argumentos da web para a atividade de recuperação.

KnowledgeBaseWebReference

Objeto

Representa uma referência de documento da Web.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
title	string	O título do documento da Web.
type	string: web	O tipo da referência.
url	string (uri)	A url da origem dos dados de referência.

KnowledgeRetrievalIntentType

Enumeração

O tipo de configuração da base de dados de conhecimento a ser usada.

Valor	Description
semantic	Uma intenção de consulta semântica de linguagem natural.

KnowledgeRetrievalMinimalReasoningEffort

Objeto

Execute a recuperação de conhecimento com o mínimo de esforço de raciocínio.

Nome	Tipo	Description
kind	string: minimal	O tipo de esforço de raciocínio.

KnowledgeRetrievalReasoningEffortKind

Enumeração

A quantidade de esforço a ser usado durante a recuperação.

Valor	Description
minimal	Não executa nenhuma seleção de origem, planejamento de consulta ou pesquisa iterativa.

KnowledgeRetrievalSemanticIntent

Objeto

Uma intenção de consulta semântica.

Nome	Tipo	Description
search	string	A consulta semântica a ser executada
type	string: semantic	O tipo da intenção.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Description
searchIndex	Uma fonte de conhecimento que lê dados de um Índice de Pesquisa.
azureBlob	Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure em um Índice de Pesquisa.
indexedOneLake	Uma fonte de conhecimento que lê dados do OneLake indexado.
web	Uma fonte de conhecimento que lê dados da web.

SearchIndexFieldReference

Objeto

Referência de campo para um índice de busca.

Nome	Tipo	Description
name	string	O nome do campo.

SearchIndexKnowledgeSourceParams

Objeto

Especifica parâmetros de tempo de execução para uma fonte de conhecimento de índice de pesquisa

Nome	Tipo	Description
filterAddOn	string	Uma condição de filtro aplicada ao índice (por exemplo, 'State eq VA').
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: searchIndex	O tipo da fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem atender para serem incluídos na resposta.

WebKnowledgeSourceParams

Objeto

Especifica parâmetros de tempo de execução para uma fonte de conhecimento da Web

Nome	Tipo	Description
count	integer (int32)	O número de resultados da Web a serem retornados.
freshness	string	O frescor dos resultados da web.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: web	O tipo da fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
language	string	O idioma dos resultados da web.
market	string	O mercado dos resultados da web.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem atender para serem incluídos na resposta.