Knowledge Bases - Get

Szolgáltatás:: Search Service

API-verzió:: 2026-05-01-preview

Előveszi a tudásbázis definícióját.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
knowledgeBaseName	path	True	string	A tudásbázis neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.
Accept		Accept	Az Elfogadás fejléce.

Válaszok

Név	Típus	Description
200 OK	KnowledgeBase	A kérés sikeres volt.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

SearchServiceGetKnowledgeBase

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
AzureOpenAIModelName	A meghívott Azure Open AI-modell neve.
AzureOpenAIVectorizerParameters	Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit.
CorsOptions	Meghatározza az indexek forrásközi erőforrás-megosztásának (CORS) beállítását.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
KnowledgeBase	Tudásbázis definícióját képviseli.
KnowledgeBaseAzureOpenAIModel	Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást.
KnowledgeBaseModelKind	A lekérdezések tervezéséhez használt AI-modell.
KnowledgeRetrievalLowReasoningEffort	Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel.
KnowledgeRetrievalMediumReasoningEffort	Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel.
KnowledgeRetrievalMinimalReasoningEffort	Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel.
KnowledgeRetrievalOutputMode	A lekérés kimeneti konfigurációja.
KnowledgeRetrievalReasoningEffortKind	A visszakeresés során felhasználandó erőfeszítés mértéke.
KnowledgeSourceReference	Hivatkozás egy tudásforrásra.
SearchIndexerDataNoneIdentity	Törli az adatforrás identitástulajdonságát.
SearchIndexerDataUserAssignedIdentity	Megadja a használni kívánt adatforrás identitását.
SearchResourceEncryptionKey	Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=minimal

AzureOpenAIModelName

Felsorolás

A meghívott Azure Open AI-modell neve.

Érték	Description
text-embedding-ada-002	TextEmbeddingAda002 modell.
text-embedding-3-large	TextEmbedding3Large modell.
text-embedding-3-small	TextEmbedding3Small 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.

AzureOpenAIVectorizerParameters

Tárgy

Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit.

Név	Típus	Description
apiKey	string	A kijelölt Azure OpenAI-erőforrás API-kulcsa.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás.
deploymentId	string	Az Azure OpenAI-modell üzembe helyezésének azonosítója a kijelölt erőforráson.
modelName	AzureOpenAIModelName	A megadott deploymentId elérési úton üzembe helyezett beágyazási modell neve.
resourceUri	string (uri)	Az Azure OpenAI-erőforrás erőforrás-URI-ja.

CorsOptions

Tárgy

Meghatározza az indexek forrásközi erőforrás-megosztásának (CORS) beállítását.

Név	Típus	Description
allowedOrigins	string[]	Azon források listája, amelyekből a JavaScript-kód hozzáférést kap az indexhez. Tartalmazhatja a {protocol}://{fully-qualified-domain-name}[:{port#}] formátumú állomások listáját, vagy egyetlen "*"-ot az összes forrás engedélyezéséhez (nem ajánlott).
maxAgeInSeconds	integer (int64)	Az az időtartam, ameddig a böngészőknek gyorsítótárazniuk kell a CORS elővizsgálati válaszait. Alapértelmezés szerint 5 perc.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

KnowledgeBase

Tárgy

Tudásbázis definícióját képviseli.

Név	Típus	Description
@odata.etag	string	A tudásbázis ETag-je.
answerInstructions	string	Utasítások, amelyeket a tudásbázis figyelembe vesz válaszok generálásakor figyelembe venni.
corsOptions	CorsOptions	Opciók a Cross-Origin Resource Sharing (CORS) vezérlésére a tudásbázishoz.
description	string	A tudásbázis leírása.
encryptionKey	SearchResourceEncryptionKey	Az Azure Key Vaultban létrehozott titkosítási kulcs leírása.
knowledgeSources	KnowledgeSourceReference[]	A tudásbázis által hivatkozott tudásforrások.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Konfigurációs beállításokat tartalmaz az AI-modellekhez való csatlakozáshoz.
name	string	A tudásbázis neve.
outputMode	KnowledgeRetrievalOutputMode	A tudásbázis kimeneti módja.
retrievalInstructions	string	Utasítások, amelyeket a tudásbázis figyelembe vesz lekérdezési terv kidolgozásakor.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	A visszakeresés, érvelési erőfeszítés konfigurációja.

KnowledgeBaseAzureOpenAIModel

Tárgy

Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást.

Név	Típus	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI paraméterek.
kind	string: azureOpenAI	A lekérdezések tervezéséhez használt AI-modell.

KnowledgeBaseModelKind

Felsorolás

A lekérdezések tervezéséhez használt AI-modell.

Érték	Description
azureOpenAI	Lekérdezéstervezéshez használja az Azure Open AI-modelleket.

KnowledgeRetrievalLowReasoningEffort

Tárgy

Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel.

Név	Típus	Description
kind	string: low	Az a fajta érvelési erőfeszítés.

KnowledgeRetrievalMediumReasoningEffort

Tárgy

Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel.

Név	Típus	Description
kind	string: medium	Az a fajta érvelési erőfeszítés.

KnowledgeRetrievalMinimalReasoningEffort

Tárgy

Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel.

Név	Típus	Description
kind	string: minimal	Az a fajta érvelési erőfeszítés.

KnowledgeRetrievalOutputMode

Felsorolás

A lekérés kimeneti konfigurációja.

Érték	Description
extractiveData	Adatok visszaadása a tudásforrásokból közvetlenül, generatív módosítás nélkül.
answerSynthesis	Szintetizáljon egy választ a válasz hasznos adataira.

KnowledgeRetrievalReasoningEffortKind

Felsorolás

A visszakeresés során felhasználandó erőfeszítés mértéke.

Érték	Description
minimal	Nem végez forrásválasztást, lekérdezéstervezést vagy iteratív keresést.
low	Használjon alacsony érvelést a lekérés során.
medium	Használjon mérsékelt érvelést a visszakeresés során.

KnowledgeSourceReference

Tárgy

Hivatkozás egy tudásforrásra.

Név	Típus	Description
enableFreshness	boolean	Jelzi, hogy a frissesség-tudatos lekérdezést engedélyezni kell-e ezen a tudásforrásnak. Ha igaz, a lekérdezés során frissességi pontszámozási profilt alkalmaznak, hogy az eredményeket az újabb dokumentumok felé torzítsák.
enableImageServing	boolean	Jelzi, hogy engedélyezni kell-e a képszolgáltatást ezen a tudásforrásnak. Ha igaz, a felvétel során kinyert képek a lekérdezés idején érkeznek a lefelé vezető modellekhez.
name	string	A tudásforrás neve.

SearchIndexerDataNoneIdentity

Tárgy

Törli az adatforrás identitástulajdonságát.

Név	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Az identitás típusát meghatározó URI-töredék.

SearchIndexerDataUserAssignedIdentity

Tárgy

Megadja a használni kívánt adatforrás identitását.

Név	Típus	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Az identitás típusát meghatározó URI-töredék.
federatedIdentityClientId	string	Többbérlős User-Assigned Managed Identity Support: A több-tendens alkalmazás kliensazonosítója, amelyet a felhasználó által rendelt menedzselt identitással való szövetségre konfiguráltak.
userAssignedIdentity	string	A felhasználó által hozzárendelt felügyelt identitás teljes Azure-erőforrás-azonosítója általában "/subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" formában található, amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz.

SearchResourceEncryptionKey

Tárgy

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.

Név	Típus	Alapértelmezett érték	Description
accessCredentials.applicationId	string		Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával.
accessCredentials.applicationSecret	string		A megadott AAD-alkalmazás hitelesítési kulcsa.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Explicit felügyelt identitás ehhez a titkosítási kulcshoz. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonság null értékű, akkor a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az erőforrás frissítésekor, ha az explicit identitás nincs meghatározva, az változatlan marad. Ha nincs megadva, a tulajdonság értéke törlődik.
isServiceLevelKey	boolean	False	Egy opcionális érték, amely jelzi, hogy ez a kulcs szolgáltatási szintű kulcs-e. Az alapértelmezett érték false.
keyVaultKeyName	string		A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve.
keyVaultKeyVersion	string		Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója.
keyVaultUri	string		Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használandó kulcsot. Példa URI lehet `https://my-keyvault-name.vault.azure.net`.