Knowledge Bases - Get

Service:: Search Service

API-versie:: 2026-04-01

Haalt een kennisbasisdefinitie op.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
knowledgeBaseName	path	True	string	De naam van de kennisbank.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Accept		Accept	De Accepteer kop.
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	KnowledgeBase	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

SearchServiceGetKnowledgeBase

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:: 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>"
    }
  }
}

Definities

Name	Description
Accept	De Accepteer kop.
AzureOpenAIModelName	De Azure Open AI-modelnaam die wordt aangeroepen.
AzureOpenAIVectorizerParameters	Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
KnowledgeBase	Vertegenwoordigt een definitie van een kennisbasis.
KnowledgeBaseAzureOpenAIModel	Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.
KnowledgeBaseModelKind	Het AI-model dat moet worden gebruikt voor queryplanning.
KnowledgeSourceReference	Verwijs naar een kennisbron.
SearchIndexerDataNoneIdentity	Hiermee wist u de identiteitseigenschap van een gegevensbron.
SearchIndexerDataUserAssignedIdentity	Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.
SearchResourceEncryptionKey	Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=minimal

AzureOpenAIModelName

Opsomming

De Azure Open AI-modelnaam die wordt aangeroepen.

Waarde	Description
text-embedding-ada-002	TextEmbeddingAda002 model.
text-embedding-3-large	TextEmbedding3Groot model.
text-embedding-3-small	TextEmbedding3Small-model.
gpt-5-mini	Gpt5Mini model.
gpt-5-nano	Gpt5Nano-model.
gpt-5.4-mini	Gpt54Mini model.
gpt-5.4-nano	Gpt54Nano model.

AzureOpenAIVectorizerParameters

Object

Hiermee geeft u de parameters voor het maken van verbinding met de Azure OpenAI-resource.

Name	Type	Description
apiKey	string	API-sleutel van de aangewezen Azure OpenAI-resource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	De door de gebruiker toegewezen beheerde identiteit die wordt gebruikt voor uitgaande verbindingen.
deploymentId	string	ID van de implementatie van het Azure OpenAI-model op de aangewezen resource.
modelName	AzureOpenAIModelName	De naam van het insluitmodel dat is geïmplementeerd op het opgegeven deploymentId-pad.
resourceUri	string (uri)	De resource-URI van de Azure OpenAI-resource.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

KnowledgeBase

Object

Vertegenwoordigt een definitie van een kennisbasis.

Name	Type	Description
@odata.etag	string	De ETag van de kennisbank.
description	string	De beschrijving van de kennisbank.
encryptionKey	SearchResourceEncryptionKey	Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt.
knowledgeSources	KnowledgeSourceReference[]	Kennisbronnen die door deze kennisbasis worden aangehaald.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Bevat configuratieopties voor het maken van verbinding met AI-modellen.
name	string	De naam van de kennisbank.

KnowledgeBaseAzureOpenAIModel

Object

Hiermee geeft u de Azure OpenAI-resource op die wordt gebruikt om queryplanning uit te voeren.

Name	Type	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parameters.
kind	string: azureOpenAI	Het AI-model dat moet worden gebruikt voor queryplanning.

KnowledgeBaseModelKind

Opsomming

Het AI-model dat moet worden gebruikt voor queryplanning.

Waarde	Description
azureOpenAI	Gebruik Azure Open AI-modellen voor het plannen van query's.

KnowledgeSourceReference

Object

Verwijs naar een kennisbron.

Name	Type	Description
name	string	De naam van de kennisbron.

SearchIndexerDataNoneIdentity

Object

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Een URI-fragment dat het type identiteit specificeert.

SearchIndexerDataUserAssignedIdentity

Object

Hiermee geeft u de identiteit op voor een gegevensbron die moet worden gebruikt.

Name	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Een URI-fragment dat het type identiteit specificeert.
userAssignedIdentity	string	De volledig gekwalificeerde Azure-resource-id van een door de gebruiker toegewezen beheerde identiteit, meestal in de vorm '/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId' die aan de zoekservice moet zijn toegewezen.

SearchResourceEncryptionKey

Object

Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt om inactieve gegevens, zoals indexen en synoniementoewijzingen, te versleutelen of te ontsleutelen.

Name	Type	Description
accessCredentials.applicationId	string	Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw data-at-rest. De toepassings-id mag niet worden verward met de object-id voor uw AAD-toepassing.
accessCredentials.applicationSecret	string	De verificatiesleutel van de opgegeven AAD-toepassing.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Een expliciete beheerde identiteit die moet worden gebruikt voor deze versleutelingssleutel. Als dit niet is opgegeven en de eigenschap toegangsreferenties null is, wordt de door het systeem toegewezen beheerde identiteit gebruikt. Bij het bijwerken van de resource, als de expliciete identiteit niet is opgegeven, blijft deze ongewijzigd. Als 'geen' is opgegeven, wordt de waarde van deze eigenschap gewist.
keyVaultKeyName	string	De naam van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultKeyVersion	string	De versie van uw Azure Key Vault-sleutel die moet worden gebruikt om uw data-at-rest te versleutelen.
keyVaultUri	string	De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan `https://my-keyvault-name.vault.azure.net`zijn.