Knowledge Bases - Create

Service:: Search Service

API-versie:: 2026-08-01-preview

Maakt een nieuwe kennisbank.

POST {endpoint}/knowledgebases?api-version=2026-08-01-preview

URI-parameters

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

Aanvraagkoptekst

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

Aanvraagbody

Naam	Vereist	Type	Description
knowledgeSources	True	KnowledgeSourceReference[]	Kennisbronnen die door deze kennisbasis worden aangehaald.
name	True	string	De naam van de kennisbank.
@odata.etag		string	De ETag van de kennisbank.
answerInstructions		string	Instructies die door de kennisbank worden meegenomen bij het genereren van antwoorden.
corsOptions		CorsOptions	Opties om Cross-Origin Resource Sharing (CORS) voor de kennisbank te beheren.
description		string	De beschrijving van de kennisbank.
encryptionKey		SearchResourceEncryptionKey	Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt.
models		KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Bevat configuratieopties voor het maken van verbinding met AI-modellen.
outputMode		KnowledgeRetrievalOutputMode	De uitvoermodus voor de kennisbasis.
retrievalInstructions		string	Instructies die door de kennisbank worden meegenomen bij het ontwikkelen van queryplannen.
retrievalReasoningEffort		KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De configuratie van de ophaal-redeneerinspanning.
retrieveDefaults		KnowledgeBaseRetrieveDefaults	Standaard ophalen van persistente verzoeken voor deze kennisbank. Deze waarden zijn van toepassing om verzoeken op te halen die de bijbehorende velden weglaten; verzoektijdwaarden krijgen voorrang wanneer aanwezig.
tags		object	Door de gebruiker gedefinieerde sleutel-waardeparen om de kennisbank te categoriseren en het gebruik en de kosten toe te wijzen.

Antwoorden

Naam	Type	Description
201 Created	KnowledgeBase	De aanvraag is geslaagd en er is een nieuwe resource gemaakt.
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

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

Voorbeelden

SearchServiceCreateKnowledgeBase

Voorbeeldaanvraag

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases?api-version=2026-08-01-preview



{
  "name": "base-preview-test",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      }
    }
  ],
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "outputMode": "extractiveData",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "description": "Description of the knowledge base.",
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Voorbeeldrespons

Statuscode:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

Definities

Naam	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.
CorsOptions	Hiermee definieert u opties voor het beheren van CORS (Cross-Origin Resource Sharing) voor een index.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	Het foutdetail.
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.
KnowledgeBaseRetrieveDefaults	Behoudende verzoekbrede standaardinstellingen voor kennisbank-ophaalverzoeken. Elke waarde geeft de standaard voor het bijbehorende ophaal-verzoekveld; servicestandaardwaarden gelden wanneer niet ingesteld, en verzoektijdwaarden krijgen voorrang wanneer aanwezig.
KnowledgeRetrievalAutoReasoningEffort	Selecteer automatisch de redeneerinspanning tijdens het ophalen. De dienst zaadt elk verzoek op het goedkoopste niveau en escaleert alleen zover dat nodig is, tot het maximaal beschikbare niveau van de dienst.
KnowledgeRetrievalLowReasoningEffort	Voer het ophalen van kennis uit met weinig redeneerinspanning.
KnowledgeRetrievalMediumReasoningEffort	Voer het ophalen van kennis uit met gemiddelde redeneerinspanning.
KnowledgeRetrievalMinimalReasoningEffort	Voer het ophalen van kennis uit met minimale redeneerinspanning.
KnowledgeRetrievalOutputMode	De uitvoerconfiguratie voor dit ophalen.
KnowledgeRetrievalReasoningEffortKind	De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.
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-4o	Gpt4o model.
gpt-4o-mini	Gpt4oMini model.
gpt-4.1	Gpt41-model.
gpt-4.1-mini	Gpt41Mini model.
gpt-4.1-nano	Gpt41Nano-model.
gpt-5	Gpt5-model.
gpt-5-mini	Gpt5Mini model.
gpt-5-nano	Gpt5Nano-model.
gpt-5.1	Gpt51 model.
gpt-5.2	Gpt52-model.
gpt-5.4	Gpt54 model.
gpt-5.4-mini	Gpt54Mini model.
gpt-5.4-nano	Gpt54Nano model.
gpt-5.5	Gpt55 model.
gpt-5.6-sol	Gpt56Sol model.
gpt-5.6-terra	Gpt56Terra model.
gpt-5.6-luna	Gpt56Luna model.

AzureOpenAIVectorizerParameters

Object

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

Naam	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.

CorsOptions

Object

Hiermee definieert u opties voor het beheren van CORS (Cross-Origin Resource Sharing) voor een index.

Naam	Type	Description
allowedOrigins	string[]	De lijst met herkomsten van waaruit JavaScript-code toegang krijgt tot uw index. Kan een lijst met hosts van de vorm {protocol}://{fully-qualified-domain-name}[:{port#}] bevatten, of een enkele '*' om alle origines toe te staan (niet aanbevolen).
maxAgeInSeconds	integer (int64)	De duur waarvoor browsers CORS preflight-antwoorden in de cache moeten opslaan. Standaard ingesteld op 5 minuten.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

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

ErrorDetail

Object

Het foutdetail.

Naam	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutgegevens.
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.)

Naam	Type	Description
error	ErrorDetail	Het foutobject.

KnowledgeBase

Object

Vertegenwoordigt een definitie van een kennisbasis.

Naam	Type	Description
@odata.etag	string	De ETag van de kennisbank.
answerInstructions	string	Instructies die door de kennisbank worden meegenomen bij het genereren van antwoorden.
corsOptions	CorsOptions	Opties om Cross-Origin Resource Sharing (CORS) voor de kennisbank te beheren.
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.
outputMode	KnowledgeRetrievalOutputMode	De uitvoermodus voor de kennisbasis.
retrievalInstructions	string	Instructies die door de kennisbank worden meegenomen bij het ontwikkelen van queryplannen.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De configuratie van de ophaal-redeneerinspanning.
retrieveDefaults	KnowledgeBaseRetrieveDefaults	Standaard ophalen van persistente verzoeken voor deze kennisbank. Deze waarden zijn van toepassing om verzoeken op te halen die de bijbehorende velden weglaten; verzoektijdwaarden krijgen voorrang wanneer aanwezig.
tags	object	Door de gebruiker gedefinieerde sleutel-waardeparen om de kennisbank te categoriseren en het gebruik en de kosten toe te wijzen.

KnowledgeBaseAzureOpenAIModel

Object

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

Naam	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.

KnowledgeBaseRetrieveDefaults

Object

Behoudende verzoekbrede standaardinstellingen voor kennisbank-ophaalverzoeken. Elke waarde geeft de standaard voor het bijbehorende ophaal-verzoekveld; servicestandaardwaarden gelden wanneer niet ingesteld, en verzoektijdwaarden krijgen voorrang wanneer aanwezig.

Naam	Type	Description
maxOutputDocuments	integer (int32)	Het standaard maximale aantal documenten in de ophaaluitvoer.
maxOutputSizeInTokens	integer (int32)	De standaard maximale grootte, in tokens, van de inhoud in de ophaaluitvoer.
maxRuntimeInSeconds	integer (int32)	De standaard maximale runtime in seconden voor een ophaalverzoek.

KnowledgeRetrievalAutoReasoningEffort

Object

Selecteer automatisch de redeneerinspanning tijdens het ophalen. De dienst zaadt elk verzoek op het goedkoopste niveau en escaleert alleen zover dat nodig is, tot het maximaal beschikbare niveau van de dienst.

Naam	Type	Description
kind	string: auto	Het soort redeneerinspanning.

KnowledgeRetrievalLowReasoningEffort

Object

Voer het ophalen van kennis uit met weinig redeneerinspanning.

Naam	Type	Description
kind	string: low	Het soort redeneerinspanning.

KnowledgeRetrievalMediumReasoningEffort

Object

Voer het ophalen van kennis uit met gemiddelde redeneerinspanning.

Naam	Type	Description
kind	string: medium	Het soort redeneerinspanning.

KnowledgeRetrievalMinimalReasoningEffort

Object

Voer het ophalen van kennis uit met minimale redeneerinspanning.

Naam	Type	Description
kind	string: minimal	Het soort redeneerinspanning.

KnowledgeRetrievalOutputMode

Opsomming

De uitvoerconfiguratie voor dit ophalen.

Waarde	Description
extractiveData	Retourneer gegevens uit de kennisbronnen direct zonder generatieve wijziging.
answerSynthesis	Synthetiseer een antwoord voor de payload van het antwoord.

KnowledgeRetrievalReasoningEffortKind

Opsomming

De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.

Waarde	Description
minimal	Voert geen bronselecties, queryplanning of iteratieve zoekopdrachten uit.
low	Gebruik een lage redenering tijdens het ophalen.
medium	Gebruik een matige hoeveelheid redeneren tijdens het ophalen.
auto	Selecteer automatisch de redeneerinspanning tijdens het ophalen, en escaleer vanaf de goedkoopste laag alleen zo ver als nodig is.

KnowledgeSourceReference

Object

Verwijs naar een kennisbron.

Naam	Type	Description
enableFreshness	boolean	Geeft aan of versheidsbewuste retrieval voor deze kennisbron moet worden ingeschakeld. Wanneer het waar is, wordt tijdens het ophalen een freshness scoring profiel toegepast om resultaten te bevoordelen ten gunste van nieuwere documenten.
enableImageServing	boolean	Geeft aan of beeldservering ingeschakeld moet worden voor deze kennisbron. Wanneer het waar is, worden de tijdens het innemen extraheren van afbeeldingen bij de query aan downstream-modellen geleverd.
name	string	De naam van de kennisbron.

SearchIndexerDataNoneIdentity

Object

Hiermee wist u de identiteitseigenschap van een gegevensbron.

Naam	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.

Naam	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Een URI-fragment dat het type identiteit specificeert.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: De client-id van de multi-tentant app die is geconfigureerd om te federeren met de door de gebruiker toegewezen beheerde identiteit.
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.

Naam	Type	Default value	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.
isServiceLevelKey	boolean	False	Een optionele waarde die aangeeft of deze sleutel een serviceniveausleutel is. De standaardwaarde is vals.
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.