Knowledge Bases - Get

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

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

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

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://exampleservice.search.windows.net/knowledgebases('base-example-index')?api-version=2026-04-01

Mintaválasz

Állapotkód:: 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>"
    }
  }
}

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.
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.
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-5-mini	Gpt5Mini modell.
gpt-5-nano	Gpt5Nano modell.
gpt-5.4-mini	Gpt54Mini modell.
gpt-5.4-nano	Gpt54Nano 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.

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

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.

KnowledgeSourceReference

Tárgy

Hivatkozás egy tudásforrásra.

Név	Típus	Description
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.
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	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.
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`.