Knowledge Bases - Get

Dienst:: Search Service

API-Version:: 2026-08-01-preview

Ruft eine Definition einer Wissensdatenbank ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
knowledgeBaseName	path	True	string	Der Name der Wissensbasis.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgeBase	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

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

Beispiele

SearchServiceGetKnowledgeBase

Beispielanforderung

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-08-01-preview

Beispiel für eine Antwort

Statuscode:: 200

{
  "@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": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    }
  ],
  "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
  }
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
AzureOpenAIModelName	Der Name des Azure Open AI-Modells, der aufgerufen wird.
AzureOpenAIVectorizerParameters	Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.
CorsOptions	Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index.
ErrorAdditionalInfo	Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
KnowledgeBase	Stellt eine Definition einer Wissensbasis dar.
KnowledgeBaseAzureOpenAIModel	Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.
KnowledgeBaseModelKind	Das KI-Modell, das für die Abfrageplanung verwendet werden soll.
KnowledgeBaseRetrieveDefaults	Bestehende anforderungsweite Standardeinstellungen für Anfragen zur Abruf der Wissensdatenbank. Jeder Wert liefert den Standard für das entsprechende Abruf-Anfragefeld; Service-Standardwerte gelten, wenn sie nicht gesetzt werden, und Anfragezeit-Werte haben Vorrang, wenn vorhanden.
KnowledgeRetrievalAutoReasoningEffort	Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.
KnowledgeRetrievalLowReasoningEffort	Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.
KnowledgeRetrievalMediumReasoningEffort	Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.
KnowledgeRetrievalMinimalReasoningEffort	Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.
KnowledgeRetrievalOutputMode	Die Ausgabekonfiguration für diesen Abruf.
KnowledgeRetrievalReasoningEffortKind	Der Aufwand, der beim Abrufen verwendet werden soll.
KnowledgeSourceReference	Verweise auf eine Wissensquelle.
SearchIndexerDataNoneIdentity	Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataUserAssignedIdentity	Gibt die Identität für eine zu verwendende Datenquelle an.
SearchResourceEncryptionKey	Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

AzureOpenAIModelName

Enumeration

Der Name des Azure Open AI-Modells, der aufgerufen wird.

Wert	Beschreibung
text-embedding-ada-002	TextEmbeddingAda002 Modell.
text-embedding-3-large	TextEmbedding3Großes Modell.
text-embedding-3-small	TextEmbedding3Kleines Modell.
gpt-4o	Gpt4o Modell.
gpt-4o-mini	Gpt4oMini-Modell.
gpt-4.1	Gpt41-Modell.
gpt-4.1-mini	Gpt41Mini Modell.
gpt-4.1-nano	Gpt41Nano-Modell.
gpt-5	Gpt5-Modell.
gpt-5-mini	Gpt5Mini-Modell.
gpt-5-nano	Gpt5Nano-Modell.
gpt-5.1	Gpt51 Modell.
gpt-5.2	Gpt52 Modell.
gpt-5.4	Gpt54-Modell.
gpt-5.4-mini	Gpt54Mini Modell.
gpt-5.4-nano	Gpt54Nano-Modell.
gpt-5.5	Gpt55-Modell.
gpt-5.6-sol	Gpt56Sol-Modell.
gpt-5.6-terra	Gpt56Terra Modell.
gpt-5.6-luna	Gpt56Luna Modell.

AzureOpenAIVectorizerParameters

Objekt

Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.

Name	Typ	Beschreibung
apiKey	string	API-Schlüssel der angegebenen Azure OpenAI-Ressource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird.
deploymentId	string	ID der Azure OpenAI-Modellbereitstellung für die angegebene Ressource.
modelName	AzureOpenAIModelName	Der Name des Einbettungsmodells, das im bereitgestellten deploymentId-Pfad bereitgestellt wird.
resourceUri	string (uri)	Der Ressourcen-URI der Azure OpenAI-Ressource.

CorsOptions

Objekt

Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index.

Name	Typ	Beschreibung
allowedOrigins	string[]	Die Liste der Ursprünge, von denen aus JavaScript-Code Zugriff auf Ihren Index erhält. Kann eine Liste von Hosts in der Form {protocol}://{fully-qualified-domain-name}[:{port#}] oder ein einzelnes '*' enthalten, um alle Ursprünge zuzulassen (nicht empfohlen).
maxAgeInSeconds	integer (int64)	Die Dauer, für die Browser CORS-Preflight-Antworten zwischenspeichern sollen. Der Standardwert ist 5 Minuten.

ErrorAdditionalInfo

Objekt

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name	Typ	Beschreibung
info		Zusätzliche Informationen.
type	string	Typ der Zusatzinformationen.

ErrorDetail

Objekt

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die Zusatzinformationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Der Fehlerzielwert.

ErrorResponse

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

KnowledgeBase

Objekt

Stellt eine Definition einer Wissensbasis dar.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag der Wissensdatenbank.
answerInstructions	string	Anweisungen, die von der Wissensdatenbank bei der Erstellung von Antworten berücksichtigt werden.
corsOptions	CorsOptions	Optionen zur Steuerung des Cross-Origin Resource Sharing (CORS) für die Wissensbasis.
description	string	Die Beschreibung der Wissensdatenbank.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen.
knowledgeSources	KnowledgeSourceReference[]	Wissensquellen, die von dieser Wissensdatenbank referenziert werden.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Enthält Konfigurationsoptionen zum Herstellen einer Verbindung mit KI-Modellen.
name	string	Der Name der Wissensbasis.
outputMode	KnowledgeRetrievalOutputMode	Der Ausgabemodus für die Wissensdatenbank.
retrievalInstructions	string	Anweisungen, die von der Wissensdatenbank bei der Erstellung eines Abfrageplans berücksichtigt werden.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Die Konfiguration des Wiederholungs-Denkens.
retrieveDefaults	KnowledgeBaseRetrieveDefaults	Persistierte, request-weite Abruf-Standardwerte für diese Wissensdatenbank. Diese Werte gelten, um Anfragen abzurufen, die die entsprechenden Felder weglassen; Anfragezeitwerte haben Vorrang, wenn sie vorhanden sind.
tags	object	Benutzerdefinierte Schlüssel-Wert-Paare zur Kategorisierung der Wissensdatenbank sowie zur Verteilung ihrer Nutzung und Kosten.

KnowledgeBaseAzureOpenAIModel

Objekt

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.

Name	Typ	Beschreibung
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parameters.
kind	string: azureOpenAI	Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseModelKind

Enumeration

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

Wert	Beschreibung
azureOpenAI	Verwenden Sie Azure Open AI-Modelle für die Abfrageplanung.

KnowledgeBaseRetrieveDefaults

Objekt

Bestehende anforderungsweite Standardeinstellungen für Anfragen zur Abruf der Wissensdatenbank. Jeder Wert liefert den Standard für das entsprechende Abruf-Anfragefeld; Service-Standardwerte gelten, wenn sie nicht gesetzt werden, und Anfragezeit-Werte haben Vorrang, wenn vorhanden.

Name	Typ	Beschreibung
maxOutputDocuments	integer (int32)	Die standardmäßige maximale Anzahl an Dokumenten im Abruf-Output.
maxOutputSizeInTokens	integer (int32)	Die Standardmaximalgröße, in Tokens, des Inhalts im Abruf-Output.
maxRuntimeInSeconds	integer (int32)	Die standardmäßige maximale Laufzeit in Sekunden für eine Abrufanforderung.

KnowledgeRetrievalAutoReasoningEffort

Objekt

Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.

Name	Typ	Beschreibung
kind	string: auto	Die Art des Argumentationsaufwands.

KnowledgeRetrievalLowReasoningEffort

Objekt

Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: low	Die Art des Argumentationsaufwands.

KnowledgeRetrievalMediumReasoningEffort

Objekt

Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: medium	Die Art des Argumentationsaufwands.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: minimal	Die Art des Argumentationsaufwands.

KnowledgeRetrievalOutputMode

Enumeration

Die Ausgabekonfiguration für diesen Abruf.

Wert	Beschreibung
extractiveData	Geben Sie Daten aus den Wissensquellen direkt und ohne generative Änderung zurück.
answerSynthesis	Synthetisieren Sie eine Antwort für die Antwortnutzlast.

KnowledgeRetrievalReasoningEffortKind

Enumeration

Der Aufwand, der beim Abrufen verwendet werden soll.

Wert	Beschreibung
minimal	Führt keine Quellenauswahl, Abfrageplanung oder iterative Suche durch.
low	Verwenden Sie beim Abrufen eine geringe Argumentation.
medium	Verwenden Sie beim Abrufen ein moderates Maß an Argumentation.
auto	Wähle automatisch den Argumentationsaufwand während des Abrufs aus und eskaliere nur so weit wie nötig von der günstigsten Stufe.

KnowledgeSourceReference

Objekt

Verweise auf eine Wissensquelle.

Name	Typ	Beschreibung
enableFreshness	boolean	Gibt an, ob für diese Wissensquelle eine frischebewusste Abfrage aktiviert werden sollte. Wenn zutreffend, wird beim Abruf ein Frische-Bewertungsprofil angewendet, um Ergebnisse zugunsten neuerer Dokumente zu verzerren.
enableImageServing	boolean	Gibt an, ob die Bildbereitstellung für diese Wissensquelle aktiviert werden sollte. Wenn zutreffend, werden während der Aufnahme extrahierte Bilder zur Abfragezeit an nachgelagerte Modelle geliefert.
name	string	Der Name der Wissensquelle.

SearchIndexerDataNoneIdentity

Objekt

Löscht die Identitätseigenschaft einer Datenquelle.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Ein URI-Fragment, das den Typ der Identität angibt.

SearchIndexerDataUserAssignedIdentity

Objekt

Gibt die Identität für eine zu verwendende Datenquelle an.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ein URI-Fragment, das den Typ der Identität angibt.
federatedIdentityClientId	string	Multi-Tenant User-Assigned Managed Identity Support: Die Client-ID der Multi-Tentant-App, die so konfiguriert wurde, dass sie mit der vom Benutzer zugewiesenen verwalteten Identität föderiert.
userAssignedIdentity	string	Die vollqualifizierte Azure-Ressourcen-ID einer vom Benutzer zugewiesenen verwalteten Identität in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst zugewiesen werden sollen.

SearchResourceEncryptionKey

Objekt

Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Name	Typ	Standardwert	Beschreibung
accessCredentials.applicationId	string		Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.
accessCredentials.applicationSecret	string		Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn diese Eigenschaft nicht angegeben ist und die Eigenschaft für Zugriffsanmeldeinformationen null ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität nicht angegeben ist, bleibt die Aktualisierung der Ressource unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht.
isServiceLevelKey	boolean	False	Ein optionaler Wert, der angibt, ob dieser Schlüssel ein Service-Level-Schlüssel ist. Die Standardeinstellung ist "false".
keyVaultKeyName	string		Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultKeyVersion	string		Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll.
keyVaultUri	string		Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann `https://my-keyvault-name.vault.azure.net`sein.