Knowledge Bases - Get

Služba:: Search Service

Verze rozhraní API:: 2026-08-01-preview

Získává definici znalostní báze.

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
knowledgeBaseName	path	True	string	Název znalostní báze.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.
Accept		Accept	Hlavička Accept.

Odpovědi

Název	Typ	Description
200 OK	KnowledgeBase	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Název	Description
https://search.azure.com/.default

Příklady

SearchServiceGetKnowledgeBase

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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
  }
}

Definice

Název	Description
Accept	Hlavička Accept.
AzureOpenAIModelName	Název modelu Azure Open AI, který se bude volat.
AzureOpenAIVectorizerParameters	Určuje parametry pro připojení k prostředku Azure OpenAI.
CorsOptions	Definuje možnosti pro řízení sdílení prostředků mezi zdroji (CORS) pro index.
ErrorAdditionalInfo	Další informace o chybě při správě prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
KnowledgeBase	Představuje definici znalostní báze.
KnowledgeBaseAzureOpenAIModel	Určuje prostředek Azure OpenAI používaný k plánování dotazů.
KnowledgeBaseModelKind	Model umělé inteligence, který se má použít pro plánování dotazů.
KnowledgeBaseRetrieveDefaults	Trvalé celopožadové výchozí hodnoty pro požadavky na získání znalostní báze. Každá hodnota poskytuje výchozí hodnotu pro odpovídající pole pro načtení požadavků; výchozí nastavení služby platí, když není nastaveno, a hodnoty času požadavku mají přednost, pokud jsou přítomny.
KnowledgeRetrievalAutoReasoningEffort	Automaticky vyberte úsilí při vyhledání uvažování. Služba zase zasílá každou žádost na nejlevnější úrovni a eskaluje pouze do míry potřeba, až do maximální dostupné úrovně služby.
KnowledgeRetrievalLowReasoningEffort	Provádějte načítání znalostí s nízkým úsilím při uvažování.
KnowledgeRetrievalMediumReasoningEffort	Spusťte získávání znalostí se středním úsilím při uvažování.
KnowledgeRetrievalMinimalReasoningEffort	Spouštějte načítání znalostí s minimálním úsilím při uvažování.
KnowledgeRetrievalOutputMode	Výstupní konfigurace pro toto načtení.
KnowledgeRetrievalReasoningEffortKind	Množství úsilí, které je třeba vynaložit při načítání.
KnowledgeSourceReference	Odkaz na zdroj znalostí.
SearchIndexerDataNoneIdentity	Vymaže vlastnost identity zdroje dat.
SearchIndexerDataUserAssignedIdentity	Určuje identitu zdroje dat, která se má použít.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

AzureOpenAIModelName

Výčet

Název modelu Azure Open AI, který se bude volat.

Hodnota	Description
text-embedding-ada-002	Model TextEmbeddingAda002.
text-embedding-3-large	TextEmbedding3Large model.
text-embedding-3-small	Model TextEmbedding3Small.
gpt-4o	Model Gpt4o.
gpt-4o-mini	Model Gpt4oMini.
gpt-4.1	Model Gpt41.
gpt-4.1-mini	Model Gpt41Mini.
gpt-4.1-nano	Model Gpt41Nano.
gpt-5	Model GPT5.
gpt-5-mini	Model Gpt5Mini.
gpt-5-nano	Model Gpt5Nano.
gpt-5.1	Model GPT51.
gpt-5.2	Model Gpt52.
gpt-5.4	Model GPT54.
gpt-5.4-mini	Model Gpt54Mini.
gpt-5.4-nano	Model Gpt54Nano.
gpt-5.5	Model Gpt55.
gpt-5.6-sol	Model Gpt56Sol.
gpt-5.6-terra	Model Gpt56Terra.
gpt-5.6-luna	Model Gpt56Luna.

AzureOpenAIVectorizerParameters

Objekt

Určuje parametry pro připojení k prostředku Azure OpenAI.

Název	Typ	Description
apiKey	string	Klíč rozhraní API určeného prostředku Azure OpenAI
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Spravovaná identita přiřazená uživatelem používaná pro odchozí připojení.
deploymentId	string	ID nasazení modelu Azure OpenAI v určeném prostředku
modelName	AzureOpenAIModelName	Název modelu vložení, který je nasazený na zadané cestě deploymentId.
resourceUri	string (uri)	Identifikátor URI prostředku Azure OpenAI.

CorsOptions

Objekt

Definuje možnosti pro řízení sdílení prostředků mezi zdroji (CORS) pro index.

Název	Typ	Description
allowedOrigins	string[]	Seznam zdrojů, ze kterých bude kódu JavaScript udělen přístup k vašemu indexu. Může obsahovat seznam hostitelů ve tvaru {protocol}://{fully-qualified-domain-name}[:{port#}] nebo jeden znak *, který povoluje všechny zdroje (nedoporučuje se).
maxAgeInSeconds	integer (int64)	Doba, po kterou by prohlížeče měly ukládat předběžné odpovědi CORS do mezipaměti. Výchozí hodnota je 5 minut.

ErrorAdditionalInfo

Objekt

Další informace o chybě při správě prostředků

Název	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Název	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Název	Typ	Description
error	ErrorDetail	Objekt chyby.

KnowledgeBase

Objekt

Představuje definici znalostní báze.

Název	Typ	Description
@odata.etag	string	Značka ETag znalostní báze.
answerInstructions	string	Instrukce zohledněné znalostní bází při generování odpovědí.
corsOptions	CorsOptions	Možnosti pro kontrolu sdílení zdrojů napříč původem (CORS) pro znalostní bázi.
description	string	Popis znalostní báze.
encryptionKey	SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault.
knowledgeSources	KnowledgeSourceReference[]	Znalostní zdroje odkazující v této znalostní bázi.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Obsahuje možnosti konfigurace, jak se připojit k modelům AI.
name	string	Název znalostní báze.
outputMode	KnowledgeRetrievalOutputMode	Výstupní režim znalostní báze.
retrievalInstructions	string	Instrukce zohledněné znalostní bází při tvorbě plánu dotazů.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurace úsilí o vyhledávání a uvažování.
retrieveDefaults	KnowledgeBaseRetrieveDefaults	Trvalé výchozí nastavení pro vyhledávání pro celou poptávku pro tuto znalostní bázi. Tyto hodnoty se používají pro získání požadavků, které vynechávají odpovídající pole; hodnoty času požadavku mají přednost, pokud jsou přítomny.
tags	object	Uživatelsky definované páry klíč-hodnota pro kategorizaci znalostní báze a přiřazení jejího využití a nákladů.

KnowledgeBaseAzureOpenAIModel

Objekt

Určuje prostředek Azure OpenAI používaný k plánování dotazů.

Název	Typ	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parametry.
kind	string: azureOpenAI	Model umělé inteligence, který se má použít pro plánování dotazů.

KnowledgeBaseModelKind

Výčet

Model umělé inteligence, který se má použít pro plánování dotazů.

Hodnota	Description
azureOpenAI	K plánování dotazů používejte modely Azure Open AI.

KnowledgeBaseRetrieveDefaults

Objekt

Trvalé celopožadové výchozí hodnoty pro požadavky na získání znalostní báze. Každá hodnota poskytuje výchozí hodnotu pro odpovídající pole pro načtení požadavků; výchozí nastavení služby platí, když není nastaveno, a hodnoty času požadavku mají přednost, pokud jsou přítomny.

Název	Typ	Description
maxOutputDocuments	integer (int32)	Výchozí maximální počet dokumentů ve výstupu pro načtení.
maxOutputSizeInTokens	integer (int32)	Výchozí maximální velikost, v tokenech, obsahu ve výstupu pro načtení.
maxRuntimeInSeconds	integer (int32)	Výchozí maximální doba běhu v sekundách pro požadavek na načtení.

KnowledgeRetrievalAutoReasoningEffort

Objekt

Automaticky vyberte úsilí při vyhledání uvažování. Služba zase zasílá každou žádost na nejlevnější úrovni a eskaluje pouze do míry potřeba, až do maximální dostupné úrovně služby.

Název	Typ	Description
kind	string: auto	Druh úsilí o uvažování.

KnowledgeRetrievalLowReasoningEffort

Objekt

Provádějte načítání znalostí s nízkým úsilím při uvažování.

Název	Typ	Description
kind	string: low	Druh úsilí o uvažování.

KnowledgeRetrievalMediumReasoningEffort

Objekt

Spusťte získávání znalostí se středním úsilím při uvažování.

Název	Typ	Description
kind	string: medium	Druh úsilí o uvažování.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Spouštějte načítání znalostí s minimálním úsilím při uvažování.

Název	Typ	Description
kind	string: minimal	Druh úsilí o uvažování.

KnowledgeRetrievalOutputMode

Výčet

Výstupní konfigurace pro toto načtení.

Hodnota	Description
extractiveData	Vraťte data ze zdrojů znalostí přímo bez generativních změn.
answerSynthesis	Syntetizuje odpověď pro datovou část odpovědi.

KnowledgeRetrievalReasoningEffortKind

Výčet

Množství úsilí, které je třeba vynaložit při načítání.

Hodnota	Description
minimal	Neprovádí žádné výběry zdrojů, plánování dotazů ani iterativní vyhledávání.
low	Při načítání používejte nízké uvažování.
medium	Při načítání používejte mírné množství uvažování.
auto	Automaticky zvolte úsilí o uvažování při získávání, postupně postupujte od nejlevnější úrovně jen tak daleko, jak je potřeba.

KnowledgeSourceReference

Objekt

Odkaz na zdroj znalostí.

Název	Typ	Description
enableFreshness	boolean	Uvádí, zda by mělo být pro tento zdroj znalostí umožněno vyhledávání s ohledem na čerstvost. Pokud je to pravda, při vyhledávání se používá profil hodnocení čerstvosti, který zkresluje výsledky směrem k novějším dokumentům.
enableImageServing	boolean	Uvádí, zda by mělo být pro tento zdroj znalostí povoleno podávání obrazů. Pokud je to pravda, obrázky extrahované během ingesteru jsou doručeny modelům po proudu v době dotazu.
name	string	Název zdroje znalostí.

SearchIndexerDataNoneIdentity

Objekt

Vymaže vlastnost identity zdroje dat.

Název	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

Objekt

Určuje identitu zdroje dat, která se má použít.

Název	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
federatedIdentityClientId	string	Multi-tenant User-Assigned Managed Identity Support: Klientské ID multi-tentant aplikace, které bylo nakonfigurováno tak, aby federovalo s uživatelem přiřazenou spravovanou identitou.
userAssignedIdentity	string	Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve formátu /subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId, které by měly být přiřazeny vyhledávací službě.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě Azure Key Vault. Klíče, které vytvoříte a spravujete, lze použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Název	Typ	Default value	Description
accessCredentials.applicationId	string		ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění ke službě Azure Key Vault, která se má použít při šifrování neaktivních uložených dat. ID aplikace by nemělo být zaměňováno s ID objektu pro vaši aplikaci AAD.
accessCredentials.applicationSecret	string		Ověřovací klíč zadané aplikace AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána vlastnost přihlašovacích údajů přístupu null, použije se spravovaná identita přiřazená systémem. Při aktualizaci prostředku zůstane explicitní identita beze změny. Pokud je zadána hodnota "none", hodnota této vlastnosti je vymazána.
isServiceLevelKey	boolean	False	Volitelná hodnota označující, zda je tento klíč klíčem na úrovni služby. Výchozí hodnota je nastavená na false.
keyVaultKeyName	string		Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string		Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string		Identifikátor URI služby Azure Key Vault, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.