Knowledge Bases - Get

Pobiera definicję bazy wiedzy.

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

Parametry identyfikatora URI

Nazwisko W Wymagane Typ Opis
endpoint
path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.

knowledgeBaseName
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

Accept

Nagłówek „Accept”.

Odpowiedzi

Nazwisko Typ Opis
200 OK

KnowledgeBase

Żądanie zakończyło się pomyślnie.

Other Status Codes

ErrorResponse

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
SearchServiceGetKnowledgeBaseMicrosoftRetriever1
SearchServiceGetKnowledgeBaseOpenAICompatible

SearchServiceGetKnowledgeBase

Przykładowe żądanie

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


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-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
  },
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ]
}

SearchServiceGetKnowledgeBaseMicrosoftRetriever1

Przykładowe żądanie

GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('travel-knowledgebase')?api-version=2026-11-01-preview


Przykładowa odpowiedź

{
  "name": "travel-knowledgebase",
  "knowledgeSources": [
    {
      "name": "hotels"
    }
  ],
  "models": [
    {
      "kind": "microsoftRetriever1"
    }
  ],
  "outputMode": "extractiveData",
  "description": "Find hotels using Microsoft Retriever 1."
}

SearchServiceGetKnowledgeBaseOpenAICompatible

Przykładowe żądanie

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


Przykładowa odpowiedź

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "compatible-model-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": "openAICompatible",
      "openAICompatibleParameters": {
        "uri": "https://model-gateway.contoso.com/teams/catalog/chat/completions?route=primary&api-version=2026-01-01",
        "modelName": "gpt-4.1-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
  },
  "tools": [
    {
      "name": "product-search",
      "description": "Search product documentation.",
      "knowledgeSources": [
        {
          "name": "ks-preview-test",
          "alwaysQuerySource": false,
          "filterAddOn": "id ne null",
          "maxOutputDocuments": 50,
          "failOnError": true
        }
      ],
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "retrieveDefaults": {
        "maxRuntimeInSeconds": 30,
        "maxOutputDocuments": 2,
        "maxOutputSizeInTokens": 5000
      }
    }
  ]
}

Definicje

Nazwisko Opis
Accept

Nagłówek „Accept”.

AzureOpenAIModelName

Nazwa modelu Azure Open AI, który zostanie wywołany.

AzureOpenAIVectorizerParameters

Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.

CorsOptions

Definiuje opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły 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).

KnowledgeBase

Reprezentuje definicję bazy wiedzy.

KnowledgeBaseAzureOpenAIModel

Określa zasób usługi Azure OpenAI używany do planowania zapytań.

KnowledgeBaseMicrosoftRetriever1Model

Określa Microsoft Retriever 1 używany do planowania i pobierania zapytań.

KnowledgeBaseModelKind

Model sztucznej inteligencji, który ma być używany do planowania zapytań.

KnowledgeBaseOpenAICompatibleModel

Określa kontrolowany przez klienta model zgodny z OpenAI do wyszukiwania bazy wiedzy lub werbalizacji obrazu źródła wiedzy w trybie minimalnym. Do pobrania profil modelu wybiera Zakończenia czatu lub Odpowiedzi. Nie obsługiwane dla ekstrakcji Standard/CU lub baz wiedzy z Web Resources Resources.

KnowledgeBaseOpenAICompatibleParameters

Parametry połączenia dla kompatybilnego z OpenAI punktu końcowego Chat Completions lub Responses. Tworzenie wymaga dokładnie jednego z niepustych nagłówków lub managedIdentityAudience. Aktualizacje mogą pominąć nagłówki, aby zachować dane uwierzytelniające dla niezmienionego połączenia i profilu modelu.

KnowledgeBaseRetrieveDefaults

Utrzymujące się domyślne ustawienia dla żądań pobierania bazy wiedzy. Każda wartość dostarcza domyślną wartość dla odpowiadającego pola pobierania-żądanie; domyślne wartości usługi mają zastosowanie, gdy są nieustawione, a wartości czasu żądania mają pierwszeństwo, gdy są obecne.

KnowledgeBaseTool

Narzędzie wyszukiwania nazw, z opisem dostarczonym przez klienta oraz podzbiorem źródeł bazy wiedzy.

KnowledgeBaseToolKnowledgeSourceReference

Odwołanie do istniejącego źródła wiedzy oraz wybrany podzbiór domyślnych ustawień trwałego pobierania, a nie pełny model parametrów czasu żądania. Źródło referencyjne określa rodzaj; niekompatybilne domyślne wartości są odrzucane podczas zapisywania bazy wiedzy. Jawne wartości żądania pobierania mają pierwszeństwo, z wyjątkiem filtrów łączących się z AND.

KnowledgeRetrievalAutoReasoningEffort

Automatycznie wybierz wysiłek rozumowania podczas pobierania. Usługa zasiewa każde żądanie na najtańszym poziomie i eskaluje tylko do poziomu potrzebnego, do maksymalnego dostępnego poziomu usługi.

KnowledgeRetrievalLowReasoningEffort

Uruchamiaj pobieranie wiedzy przy niewielkim wysiłku związanym z rozumowaniem.

KnowledgeRetrievalMediumReasoningEffort

Uruchamianie wyszukiwania wiedzy ze średnim wysiłkiem rozumowania.

KnowledgeRetrievalMinimalReasoningEffort

Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem.

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

KnowledgeRetrievalReasoningEffortKind

Ilość wysiłku do użycia podczas pobierania.

KnowledgeSourceReference

Odniesienie do źródła wiedzy.

SearchIndexerDataNoneIdentity

Czyści właściwość tożsamości źródła danych.

SearchIndexerDataUserAssignedIdentity

Określa tożsamość źródła danych do użycia.

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.

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

gpt-6-astra

Model Gpt6Astra.

gpt-6-sol

Model Gpt6Sol.

gpt-6-luna

Model Gpt6Luna.

gpt-6.1-sol

Model GPT61Sol.

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

AzureOpenAIModelName

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

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie

code

string

Kod błędu.

details

ErrorDetail[]

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

ErrorDetail

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

CorsOptions

Opcje kontroli Cross-Origin Resource Sharing (CORS) dla bazy wiedzy.

description

string

Opis bazy wiedzy.

encryptionKey

SearchResourceEncryptionKey

Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault.

knowledgeSources

KnowledgeSourceReference[]

Ź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

KnowledgeRetrievalOutputMode

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.

retrieveDefaults

KnowledgeBaseRetrieveDefaults

Utrzymuj domyślne pobieranie dla tej bazy wiedzy na poziomie całego żądania. Wartości te mają zastosowanie do pobierania żądań, które pomijają odpowiadające im pola; wartości czasu żądania mają pierwszeństwo, gdy są obecne.

tags

object

Zdefiniowane przez użytkownika pary klucz-wartość do kategoryzowania bazy wiedzy oraz przypisywania jej wykorzystania i kosztów.

tools

KnowledgeBaseTool[]

Nazwane narzędzia wyszukiwania, każde ograniczone do podzbioru źródeł tej bazy wiedzy. Po skonfigurowaniu MCP reklamuje te narzędzia oprócz wbudowanego narzędzia knowledge_base_retrieve, które pobiera z pełnej bazy wiedzy. Pominięcie narzędzi lub podanie pustej tablicy w tej wersji API usuwa istniejące narzędzia.

KnowledgeBaseAzureOpenAIModel

Określa zasób usługi Azure OpenAI używany do planowania zapytań.

Nazwisko Typ Opis
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI parametry.

kind string:

azureOpenAI

Model sztucznej inteligencji, który ma być używany do planowania zapytań.

KnowledgeBaseMicrosoftRetriever1Model

Określa Microsoft Retriever 1 używany do planowania i pobierania zapytań.

Nazwisko Typ Opis
kind string:

microsoftRetriever1

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

openAICompatible

Używaj kontrolowanego przez klienta punktu końcowego zgodnego z OpenAI do wyszukiwania bazy wiedzy lub werbalizacji obrazów źródłowych wiedzy.

microsoftRetriever1

Używaj Microsoft Retriever 1 do planowania i wyszukiwania zapytań.

KnowledgeBaseOpenAICompatibleModel

Określa kontrolowany przez klienta model zgodny z OpenAI do wyszukiwania bazy wiedzy lub werbalizacji obrazu źródła wiedzy w trybie minimalnym. Do pobrania profil modelu wybiera Zakończenia czatu lub Odpowiedzi. Nie obsługiwane dla ekstrakcji Standard/CU lub baz wiedzy z Web Resources Resources.

Nazwisko Typ Opis
kind string:

openAICompatible

Model sztucznej inteligencji, który ma być używany do planowania zapytań.

openAICompatibleParameters

KnowledgeBaseOpenAICompatibleParameters

Parametry połączenia i uwierzytelniania dla punktu końcowego zgodnego z OpenAI.

KnowledgeBaseOpenAICompatibleParameters

Parametry połączenia dla kompatybilnego z OpenAI punktu końcowego Chat Completions lub Responses. Tworzenie wymaga dokładnie jednego z niepustych nagłówków lub managedIdentityAudience. Aktualizacje mogą pominąć nagłówki, aby zachować dane uwierzytelniające dla niezmienionego połączenia i profilu modelu.

Nazwisko Typ Opis
authIdentity SearchIndexerDataIdentity:

Przypisana przez użytkownika zarządzana tożsamość używana do pozyskania tokena dla managedIdentityAudience. Pomiń używanie systemowej tożsamości usługi wyszukiwania. Dozwolone tylko z managedIdentityAudience.

headers

object (password)

Niepuste przechowywane nagłówki HTTP do uwierzytelniania punktów końcowych. Zarówno nazwy, jak i wartości są tajne i nigdy nie są zwracane w odpowiedziach. Puste mapy są nieprawidłowe. Wzajemnie wyłączające się z managedIdentityAudience i authIdentity. Po aktualizacji pominięte nagłówki są zachowywane tylko na tym samym powiązaniu zasobu i modelu, gdy dokładny punkt końcowy, profil modelu i tożsamość uwierzytelniania pozostają niezmienione; w przeciwnym razie należy podać świeże dane uwierzytelniające.

managedIdentityAudience

string

Podstawowy kanoniczny identyfikator GUID aplikacji klienta Microsoft Entra do uwierzytelniania zarządzanej tożsamości. Nie dołączaj prefiksu api:// ani sufiksu /.default. Wzajemnie wykluczające się z nagłówkami.

modelName

AzureOpenAIModelName

Obsługiwana nazwa modelu czatu, która określa możliwości i ograniczenia Search. Dla werbalizacji obrazu źródła wiedzy jest to wysyłane jako selektor modelu w treści żądania; ścieżka URI wybiera Zakończenia czatu lub Odpowiedzi niezależnie od tej nazwy. Do wyszukiwania bazy wiedzy profile modeli GPT-6 używają Responses, a istniejące profile modeli korzystają z Chat Completions; punkt końcowy musi wspierać wybrany protokół, w tym kontynuację narzędzi bezstanowych dla Responses. Ciało żądania pobierania pomija model; URI lub brama wybiera właściwy model i podaje wymagany identyfikator modelu dostawcy. Modele osadzania i dowolne protokoły dostawców nie są obsługiwane.

uri

string (uri)

Pełny adres HTTPS POST URL, wraz ze ścieżką i parametrami zapytania. Wysyłane bez zmian bez dodawania ścieżki lub wersji API; przekierowania nie są śledzone. Aby pobrać bazę wiedzy, punkt końcowy musi akceptować protokół Chat Completions lub Responses profilu modelu. Dla werbalizacji obrazu źródła wiedzy ścieżka URI musi kończyć się na /chat/completions lub /response; parametry zapytania nie wybierają protokołu.

KnowledgeBaseRetrieveDefaults

Utrzymujące się domyślne ustawienia dla żądań pobierania bazy wiedzy. Każda wartość dostarcza domyślną wartość dla odpowiadającego pola pobierania-żądanie; domyślne wartości usługi mają zastosowanie, gdy są nieustawione, a wartości czasu żądania mają pierwszeństwo, gdy są obecne.

Nazwisko Typ Opis
maxOutputDocuments

integer (int32)

Domyślna maksymalna liczba dokumentów w wyjściu pobierania.

maxOutputSizeInTokens

integer (int32)

Domyślny maksymalny rozmiar, w tokenach, treści w wyjściu pobierania.

maxRuntimeInSeconds

integer (int32)

Domyślny maksymalny czas działania w sekundach dla żądania pobrania.

KnowledgeBaseTool

Narzędzie wyszukiwania nazw, z opisem dostarczonym przez klienta oraz podzbiorem źródeł bazy wiedzy.

Nazwisko Typ Opis
description

string

minLength: 1
maxLength: 1024

Niepusty opis czasu użycia narzędzia, maksymalnie 1024 znaki. Reklamowane dosłownie w katalogu MCP.

knowledgeSources

KnowledgeBaseToolKnowledgeSourceReference[]

Niepusta lista unikalnych odniesień źródłowych. Każde źródło musi należeć do bazy wiedzy. Różne narzędzia mogą odwoływać się do tego samego źródła.

name

string

minLength: 2
maxLength: 64
pattern: ^[a-z0-9](?:[a-z0-9-]{0,62}[a-z0-9])$

Unikalna, rozróżniająca wielkość liter nazwa narzędzia. Zawiera od 2 do 64 małych liter ASCII, cyfr lub łączników, bez myślnika na początku lub na końcu.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Nadpisuje wysiłek rozumowania bazy wiedzy dla tego narzędzia. Wyraźne wartości żądania pobierania mają pierwszeństwo.

retrieveDefaults

KnowledgeBaseRetrieveDefaults

Pobierz domyślne ustawienia, które zastępują domyślne ustawienia bazy wiedzy dla tego narzędzia. Wyraźne wartości żądania pobierania mają pierwszeństwo.

KnowledgeBaseToolKnowledgeSourceReference

Odwołanie do istniejącego źródła wiedzy oraz wybrany podzbiór domyślnych ustawień trwałego pobierania, a nie pełny model parametrów czasu żądania. Źródło referencyjne określa rodzaj; niekompatybilne domyślne wartości są odrzucane podczas zapisywania bazy wiedzy. Jawne wartości żądania pobierania mają pierwszeństwo, z wyjątkiem filtrów łączących się z AND.

Nazwisko Typ Opis
alwaysQuerySource

boolean

Czy źródło musi być zapytane. Nie obsługiwane dla źródeł serwera MCP. Pierwszeństwo ma wyraźne wyłączenie żądania.

failOnError

boolean

Czy pobieranie powinno się nie powieść, jeśli to źródło napotka błąd.

filterAddOn

string

Dodatkowy filtr OData dla źródeł indeksu wyszukiwania. Odrzucone dla nieobsługiwanych rodzajów źródeł podczas zapisywania bazy wiedzy. Połączone z filtrami źródłowych i żądaniowych za pomocą AND.

maxOutputDocuments

integer (int32)

minimum: 50
maximum: 200

Maksymalna liczba dokumentów pobranych z tego źródła wynosi od 50 do 200.

name

string

minLength: 1

Nazwa źródła wiedzy w bazie wiedzy.

rerankerThreshold

number (float)

Minimalny wynik ponownego odtwarzania dla zwróconych dokumentów. Wymaga włączenia zmiany rankingu.

KnowledgeRetrievalAutoReasoningEffort

Automatycznie wybierz wysiłek rozumowania podczas pobierania. Usługa zasiewa każde żądanie na najtańszym poziomie i eskaluje tylko do poziomu potrzebnego, do maksymalnego dostępnego poziomu usługi.

Nazwisko Typ Opis
kind string:

auto

Rodzaj wysiłku rozumowania.

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.

auto

Automatycznie wybieraj wysiłek rozumowania podczas pobierania, eskalując od najtańszego poziomu tylko do potrzeby.

KnowledgeSourceReference

Odniesienie do źródła wiedzy.

Nazwisko Typ Opis
enableFreshness

boolean

Wskazuje, czy należy umożliwić wyszukiwanie z uwzględnieniem świeżości dla tego źródła wiedzy. Gdy jest to prawdziwe, podczas wyszukiwania stosuje się profil oceny świeżości, aby uprzedzić wyniki w kierunku nowszych dokumentów.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy. Gdy jest to prawda, obrazy wyodrębnione podczas pobierania są dostarczane do modeli dalszych w czasie zapytania.

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.Azure.Search.DataNoneIdentity

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.Azure.Search.DataUserAssignedIdentity

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 Domyślna wartość 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.

isServiceLevelKey

boolean

False

Opcjonalna wartość wskazująca, czy ten klucz jest kluczem poziomu usługi. Wartość domyślna to „false”.

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ć https://my-keyvault-name.vault.azure.net.