Knowledge Bases - Get
Pobiera definicję bazy wiedzy.
GET {endpoint}/knowledgebases('{knowledgeBaseName}')?api-version=2026-10-01
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adres URL punktu końcowego usługi wyszukiwania. |
|
knowledge
|
path | True |
string |
Nazwa bazy wiedzy. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
|
| Accept |
Nagłówek „Accept”. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
api-key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Zakresy
| Nazwisko | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchServiceGetKnowledgeBase
Przykładowe żądanie
GET https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-10-01
Przykładowa odpowiedź
{
"@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-stable-test"
}
],
"models": [
{
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-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
}
}
Definicje
| Nazwisko | Opis |
|---|---|
| Accept |
Nagłówek „Accept”. |
|
Azure |
Nazwa modelu Azure Open AI, który zostanie wywołany. |
|
Azure |
Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI. |
|
Cors |
Definiuje opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
|
Knowledge |
Reprezentuje definicję bazy wiedzy. |
|
Knowledge |
Określa zasób usługi Azure OpenAI używany do planowania zapytań. |
|
Knowledge |
Model sztucznej inteligencji, który ma być używany do planowania zapytań. |
|
Knowledge |
Uruchamiaj pobieranie wiedzy przy niewielkim wysiłku związanym z rozumowaniem. |
|
Knowledge |
Uruchamianie wyszukiwania wiedzy ze średnim wysiłkiem rozumowania. |
|
Knowledge |
Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem. |
|
Knowledge |
Konfiguracja wyjściowa dla tego pobierania. |
|
Knowledge |
Ilość wysiłku do użycia podczas pobierania. |
|
Knowledge |
Odniesienie do źródła wiedzy. |
|
Search |
Czyści właściwość tożsamości źródła danych. |
|
Search |
Określa tożsamość źródła danych do użycia. |
|
Search |
Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów. |
Accept
Nagłówek „Accept”.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=minimal |
AzureOpenAIModelName
Nazwa modelu Azure Open AI, który zostanie wywołany.
| Wartość | Opis |
|---|---|
| text-embedding-ada-002 |
Model TextEmbeddingAda002. |
| text-embedding-3-large |
Model TextEmbedding3Large. |
| text-embedding-3-small |
Model TextEmbedding3Small. |
| gpt-5-mini |
Model Gpt5Mini. |
| gpt-5-nano |
Model Gpt5Nano. |
| 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
Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.
| Nazwisko | Typ | Opis |
|---|---|---|
| apiKey |
string |
Klucz interfejsu API wyznaczonego zasobu usługi Azure OpenAI. |
| authIdentity | SearchIndexerDataIdentity: |
Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. |
| deploymentId |
string |
Identyfikator wdrożenia modelu Usługi Azure OpenAI w wyznaczonym zasobie. |
| modelName |
Nazwa modelu osadzania wdrożonego w podanej ścieżce deploymentId. |
|
| resourceUri |
string (uri) |
Identyfikator URI zasobu usługi Azure OpenAI. |
CorsOptions
Definiuje opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu.
| Nazwisko | Typ | Opis |
|---|---|---|
| allowedOrigins |
string[] |
Lista źródeł, z których kod JavaScript będzie miał dostęp do indeksu. Może zawierać listę hostów w postaci {protocol}://{fully-qualified-domain-name}[:{port#}] lub pojedynczy znak "*", aby zezwolić na wszystkie źródła (niezalecane). |
| maxAgeInSeconds |
integer (int64) |
Czas, przez jaki przeglądarki powinny buforować odpowiedzi inspekcji wstępnej CORS. Wartość domyślna to 5 minut. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwisko | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwisko | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Cel błędu. |
ErrorResponse
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
| Nazwisko | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
KnowledgeBase
Reprezentuje definicję bazy wiedzy.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
Element ETag bazy wiedzy. |
| answerInstructions |
string |
Instrukcje uwzględniane przez bazę wiedzy podczas generowania odpowiedzi. |
| corsOptions |
Opcje kontroli Cross-Origin Resource Sharing (CORS) dla bazy wiedzy. |
|
| description |
string |
Opis bazy wiedzy. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. |
|
| knowledgeSources |
Źródła wiedzy odwoływane przez tę bazę wiedzy. |
|
| models | KnowledgeBaseModel[]: |
Zawiera opcje konfiguracji dotyczące sposobu nawiązywania połączenia z modelami AI. |
| name |
string |
Nazwa bazy wiedzy. |
| outputMode |
Tryb wyjściowy bazy wiedzy. |
|
| retrievalInstructions |
string |
Instrukcje brane pod uwagę w bazie wiedzy podczas opracowywania planu zapytań. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Konfiguracja wysiłku rozumowania wyszukiwania. |
KnowledgeBaseAzureOpenAIModel
Określa zasób usługi Azure OpenAI używany do planowania zapytań.
| Nazwisko | Typ | Opis |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI parametry. |
|
| kind |
string:
azure |
Model sztucznej inteligencji, który ma być używany do planowania zapytań. |
KnowledgeBaseModelKind
Model sztucznej inteligencji, który ma być używany do planowania zapytań.
| Wartość | Opis |
|---|---|
| azureOpenAI |
Używanie modeli sztucznej inteligencji usługi Azure Open do planowania zapytań. |
KnowledgeRetrievalLowReasoningEffort
Uruchamiaj pobieranie wiedzy przy niewielkim wysiłku związanym z rozumowaniem.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
low |
Rodzaj wysiłku rozumowania. |
KnowledgeRetrievalMediumReasoningEffort
Uruchamianie wyszukiwania wiedzy ze średnim wysiłkiem rozumowania.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
medium |
Rodzaj wysiłku rozumowania. |
KnowledgeRetrievalMinimalReasoningEffort
Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
minimal |
Rodzaj wysiłku rozumowania. |
KnowledgeRetrievalOutputMode
Konfiguracja wyjściowa dla tego pobierania.
| Wartość | Opis |
|---|---|
| extractiveData |
Zwracanie danych ze źródeł wiedzy bezpośrednio bez generatywnych zmian. |
| answerSynthesis |
Zsyntetyzuj odpowiedź dla ładunku odpowiedzi. |
KnowledgeRetrievalReasoningEffortKind
Ilość wysiłku do użycia podczas pobierania.
| Wartość | Opis |
|---|---|
| minimal |
Nie wykonuje żadnych wyborów źródłowych, planowania zapytań ani wyszukiwania iteracyjnego. |
| low |
Używaj niskiego rozumowania podczas pobierania. |
| medium |
Używaj umiarkowanej ilości rozumowania podczas pobierania. |
KnowledgeSourceReference
Odniesienie do źródła wiedzy.
| Nazwisko | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa źródła wiedzy. |
SearchIndexerDataNoneIdentity
Czyści właściwość tożsamości źródła danych.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragment identyfikatora URI określający typ tożsamości. |
SearchIndexerDataUserAssignedIdentity
Określa tożsamość źródła danych do użycia.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragment identyfikatora URI określający typ tożsamości. |
| federatedIdentityClientId |
string |
Wsparcie tożsamości zarządzanej User-Assigned wielodzierżawcowej: identyfikator klienta aplikacji wielonamiętnej, skonfigurowanej do federacji z przypisaną przez użytkownika tożsamością zarządzaną. |
| userAssignedIdentity |
string |
W pełni kwalifikowany identyfikator zasobu platformy Azure przypisanej przez użytkownika tożsamości zarządzanej zazwyczaj w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania. |
SearchResourceEncryptionKey
Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
| Nazwisko | Typ | Opis |
|---|---|---|
| accessCredentials.applicationId |
string |
Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, która ma być używana podczas szyfrowania danych magazynowanych. Identyfikator aplikacji nie powinien być mylony z identyfikatorem obiektu aplikacji usługi AAD. |
| accessCredentials.applicationSecret |
string |
Klucz uwierzytelniania określonej aplikacji usługi AAD. |
| identity | SearchIndexerDataIdentity: |
Jawna tożsamość zarządzana używana dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Po zaktualizowaniu zasobu, jeśli tożsamość jawna jest nieokreślona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości zostanie wyczyszczone. |
| keyVaultKeyName |
string |
Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych. |
| keyVaultKeyVersion |
string |
Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych. |
| keyVaultUri |
string |
Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz używany do szyfrowania danych magazynowanych. Przykładowy identyfikator URI może być |