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 do URI

Name	Em	Necessá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 conhecimento.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

Corpo do Pedido

Name	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 de execução máximo em segundos.

Respostas

Name	Tipo	Description
200 OK	KnowledgeBaseRetrievalResponse	Resposta de recolha 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
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Pedido de amostra

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 da amostra

Código de estado:: 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 estado:: 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

Name	Description
Accept	O cabeçalho Aceitar.
AzureBlobKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento azure blob
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
IndexedOneLakeKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento OneLake indexada
KnowledgeBaseActivityRecordType	O tipo de registo de atividade.
KnowledgeBaseAgenticReasoningActivityRecord	Representa um registro de atividade de raciocínio agentico.
KnowledgeBaseAzureBlobActivityArguments	Representa os argumentos com os quais a atividade de recuperação de blob azure foi executada.
KnowledgeBaseAzureBlobActivityRecord	Representa um registro de atividade de recuperação de blob azure.
KnowledgeBaseAzureBlobReference	Representa uma referência de documento do Armazenamento de Blobs do Azure.
KnowledgeBaseErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
KnowledgeBaseErrorDetail	Os detalhes do erro.
KnowledgeBaseImageContent	Conteúdo da imagem.
KnowledgeBaseIndexedOneLakeActivityArguments	Representa os argumentos com que foi conduzida a atividade de recuperação indexada do OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Representa um registo indexado de atividade de recuperação do OneLake.
KnowledgeBaseIndexedOneLakeReference	Representa uma referência indexada de documento OneLake.
KnowledgeBaseMessage	O objeto de estilo de mensagem em 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 registo de atividade de sumarização 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 do í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 da Pesquisa do Azure.
KnowledgeBaseWebActivityArguments	Representa os argumentos com que a atividade de recuperação da web foi conduzida.
KnowledgeBaseWebActivityRecord	Representa um registo de atividade de recuperação web.
KnowledgeBaseWebReference	Representa uma referência de documento 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 esforço de raciocínio.
KnowledgeRetrievalReasoningEffortKind	A quantidade de esforço a utilizar 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 pesquisa.
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

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento azure blob

Name	Tipo	Description
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: azureBlob	O tipo de 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 cumprir para serem incluídos na resposta.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Object

O detalhe do erro.

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

ErrorResponse

Object

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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

IndexedOneLakeKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento OneLake indexada

Name	Tipo	Description
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: indexedOneLake	O tipo de 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 cumprir para serem incluídos na resposta.

KnowledgeBaseActivityRecordType

Enumeração

O tipo de registo de atividade.

Valor	Description
searchIndex	Atividade de pesquisa e de recuperação de índices.
azureBlob	Atividade de recuperação do Azure Blob.
indexedOneLake	Atividade de recuperação indexada no OneLake.
web	Atividade de recuperação da web.
modelWebSummarization	Atividade de resumo web de LLM.
agenticReasoning	Atividade de raciocínio agente.

KnowledgeBaseAgenticReasoningActivityRecord

Object

Representa um registro de atividade de raciocínio agentico.

Name	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. Esta 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 raciocínio agentico.
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

Object

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

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

KnowledgeBaseAzureBlobActivityRecord

Object

Representa um registro de atividade de recuperação de blob azure.

Name	Tipo	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Os argumentos azure blob para a atividade de recuperação.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
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. Esta 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

Object

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

Name	Tipo	Description
activitySource	integer (int32)	O ID da atividade de origem para a referência.
blobUrl	string	O URL de blob para a referência.
id	string	O 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 de referência.

KnowledgeBaseErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

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

KnowledgeBaseErrorDetail

Object

Os detalhes do erro.

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

KnowledgeBaseImageContent

Object

Conteúdo da imagem.

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

KnowledgeBaseIndexedOneLakeActivityArguments

Object

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

Name	Tipo	Description
search	string	A cadeia de pesquisa usada para consultar indexava conteúdos do OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Object

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

Name	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
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. Esta 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

Object

Representa uma referência indexada de documento OneLake.

Name	Tipo	Description
activitySource	integer (int32)	O ID da atividade de origem para a referência.
docUrl	string	O URL do documento para a referência.
id	string	O 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 de referência.

KnowledgeBaseMessage

Object

O objeto de estilo de mensagem em linguagem natural.

Name	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

Object

Tipo de mensagem de imagem.

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

KnowledgeBaseMessageTextContent

Object

Tipo de mensagem de texto.

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

KnowledgeBaseModelWebSummarizationActivityRecord

Object

Representa um registo de atividade de sumarização web de LLM.

Name	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. Esta 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 sumarização web do LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de sumarização 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 web.

KnowledgeBaseRetrievalRequest

Object

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

Name	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 de execução máximo em segundos.

KnowledgeBaseRetrievalResponse

Object

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

Name	Tipo	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Os registros de atividade para acompanhar o progresso e as implicações de faturamento.
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

Object

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

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

KnowledgeBaseSearchIndexActivityRecord

Object

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

Name	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
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. Esta 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

Object

Representa uma referência de documento da Pesquisa do Azure.

Name	Tipo	Description
activitySource	integer (int32)	O ID da atividade de origem para a referência.
docKey	string	A chave do documento para a referência.
id	string	O 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 de referência.

KnowledgeBaseWebActivityArguments

Object

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

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

KnowledgeBaseWebActivityRecord

Object

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

Name	Tipo	Description
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
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. Esta 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

Object

Representa uma referência de documento web.

Name	Tipo	Description
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O 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 web.
type	string: web	O tipo de referência.
url	string (uri)	A URL de onde os dados de referência se originaram.

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 em linguagem natural.

KnowledgeRetrievalMinimalReasoningEffort

Object

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

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

KnowledgeRetrievalReasoningEffortKind

Enumeração

A quantidade de esforço a utilizar durante a recuperação.

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

KnowledgeRetrievalSemanticIntent

Object

Uma intenção de consulta semântica.

Name	Tipo	Description
search	string	A consulta semântica a ser executada
type	string: semantic	O tipo de 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 para 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

Object

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

Name	Tipo	Description
name	string	O nome do campo.

SearchIndexKnowledgeSourceParams

Object

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

Name	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 útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: searchIndex	O tipo de 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 cumprir para serem incluídos na resposta.

WebKnowledgeSourceParams

Object

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

Name	Tipo	Description
count	integer (int32)	O número de resultados da Web a serem retornados.
freshness	string	A frescura dos resultados da web.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: web	O tipo de 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 web.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.