Knowledge Bases - Get

Serviço:: Search Service

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

Recupera uma definição de base de conhecimento.

GET {endpoint}/knowledgebases('{knowledgeBaseName}')?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.

Respostas

Name	Tipo	Description
200 OK	KnowledgeBase	O pedido foi bem-sucedido.
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

SearchServiceGetKnowledgeBase

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-example-index",
  "description": "Description of the knowledge base.",
  "knowledgeSources": [
    {
      "name": "ks-example-index"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-5-nano"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definições

Name	Description
Accept	O cabeçalho Aceitar.
AzureOpenAIModelName	O nome do modelo de IA aberta do Azure que será chamado.
AzureOpenAIVectorizerParameters	Especifica os parâmetros para se conectar ao recurso OpenAI do Azure.
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.)
KnowledgeBase	Representa uma definição de base de conhecimento.
KnowledgeBaseAzureOpenAIModel	Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consultas.
KnowledgeBaseModelKind	O modelo de IA a ser usado para o planejamento de consultas.
KnowledgeSourceReference	Referência a uma fonte de conhecimento.
SearchIndexerDataNoneIdentity	Limpa a propriedade identity de uma fonte de dados.
SearchIndexerDataUserAssignedIdentity	Especifica a identidade a ser usada por uma fonte de dados.
SearchResourceEncryptionKey	Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

AzureOpenAIModelName

Enumeração

O nome do modelo de IA aberta do Azure que será chamado.

Valor	Description
text-embedding-ada-002	Modelo TextEmbeddingAda002.
text-embedding-3-large	TextEmbedding3 Modelo grande.
text-embedding-3-small	TextEmbedding3Small model.
gpt-5-mini	Modelo Gpt5Mini.
gpt-5-nano	Modelo Gpt5Nano.
gpt-5.4-mini	Modelo Gpt54Mini.
gpt-5.4-nano	Modelo Gpt54Nano.

AzureOpenAIVectorizerParameters

Object

Especifica os parâmetros para se conectar ao recurso OpenAI do Azure.

Name	Tipo	Description
apiKey	string	Chave de API do recurso OpenAI do Azure designado.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A identidade gerenciada atribuída pelo usuário usada para conexões de saída.
deploymentId	string	ID da implantação do modelo OpenAI do Azure no recurso designado.
modelName	AzureOpenAIModelName	O nome do modelo de incorporação implantado no caminho deploymentId fornecido.
resourceUri	string (uri)	O URI do recurso Azure OpenAI.

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.

KnowledgeBase

Object

Representa uma definição de base de conhecimento.

Name	Tipo	Description
@odata.etag	string	O ETag da base de conhecimento.
description	string	A descrição da base de conhecimento.
encryptionKey	SearchResourceEncryptionKey	Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure.
knowledgeSources	KnowledgeSourceReference[]	Fontes de conhecimento referenciadas por esta base de conhecimento.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Contém opções de configuração sobre como se conectar a modelos de IA.
name	string	O nome da base de conhecimento.

KnowledgeBaseAzureOpenAIModel

Object

Especifica o recurso OpenAI do Azure usado para fazer o planejamento de consultas.

Name	Tipo	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Parâmetros Azure OpenAI.
kind	string: azureOpenAI	O modelo de IA a ser usado para o planejamento de consultas.

KnowledgeBaseModelKind

Enumeração

O modelo de IA a ser usado para o planejamento de consultas.

Valor	Description
azureOpenAI	Use modelos de IA aberta do Azure para planejamento de consultas.

KnowledgeSourceReference

Object

Referência a uma fonte de conhecimento.

Name	Tipo	Description
name	string	O nome da fonte de conhecimento.

SearchIndexerDataNoneIdentity

Object

Limpa a propriedade identity de uma fonte de dados.

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Um fragmento de URI especificando o tipo de identidade.

SearchIndexerDataUserAssignedIdentity

Object

Especifica a identidade a ser usada por uma fonte de dados.

Name	Tipo	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Um fragmento de URI especificando o tipo de identidade.
userAssignedIdentity	string	A ID de recurso do Azure totalmente qualificada de uma identidade gerenciada atribuída ao usuário normalmente no formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que deveria ter sido atribuída ao serviço de pesquisa.

SearchResourceEncryptionKey

Object

Uma chave de criptografia gerenciada pelo cliente no Cofre de Chaves do Azure. As chaves que você cria e gerencia podem ser usadas para criptografar ou descriptografar dados em repouso, como índices e mapas de sinônimos.

Name	Tipo	Description
accessCredentials.applicationId	string	Uma ID de Aplicativo AAD que recebeu as permissões de acesso necessárias ao Cofre da Chave do Azure que deve ser usada ao criptografar seus dados em repouso. A ID do aplicativo não deve ser confundida com a ID do objeto do seu aplicativo AAD.
accessCredentials.applicationSecret	string	A chave de autenticação do aplicativo AAD especificado.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Uma identidade gerenciada explícita a ser usada para essa chave de criptografia. Se não for especificado e a propriedade de credenciais de acesso for nula, a identidade gerenciada atribuída ao sistema será usada. Na atualização do recurso, se a identidade explícita não for especificada, ela permanecerá inalterada. Se "nenhum" for especificado, o valor dessa propriedade será limpo.
keyVaultKeyName	string	O nome da sua chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultKeyVersion	string	A versão da chave do Cofre da Chave do Azure a ser usada para criptografar seus dados em repouso.
keyVaultUri	string	O URI do seu Cofre da Chave do Azure, também conhecido como nome DNS, que contém a chave a ser usada para criptografar seus dados em repouso. Um exemplo de URI pode ser `https://my-keyvault-name.vault.azure.net`.