Knowledge Retrieval - Retrieve Stream

Pobiera istotne dane z backupu, przechowuje postępy i wyniki streamingu jako zdarzenia wysyłane przez serwer.

Przetwarzaj odpowiedź stopniowo, korzystając z ramek zdarzeń wysyłanych przez serwer. Każde zdarzenie zawiera nazwę zdarzenia oraz ładunek danych zakodowany w JSON. Stream kończy się albo response.completed wydarzeniem, albo error wydarzeniem. OpenAPI 2.0 reprezentuje ciało odpowiedzi jako ciąg znaków, dzięki czemu generowane klienty mogą udostępniać surową odpowiedź bez parsowania zdarzeń typowych. Nie deserializuj całego ciała odpowiedzi jako pojedynczego dokumentu JSON.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?_overload=retrieveStream&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
Accept True

Accept

Nagłówek „Accept”.

x-ms-query-source-authorization

string (password)

Token identyfikujący użytkownika, dla którego jest wykonywane zapytanie. Ten token służy do wymuszania ograniczeń zabezpieczeń dokumentów.

x-ms-query-work-iq-source-authorization

string (password)

Token asercji użytkownika dla rejestracji aplikacji Entra należącej do klienta, skonfigurowany na źródle wiedzy Work IQ. Używany do uwierzytelniania na zlecenie do API Work IQ.

x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwisko Typ Opis
includeActivity

boolean

Wskazuje, że wyniki pobierania powinny zawierać informacje o aktywności.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Lista zamierzonych zapytań, które mają być wykonywane bez planowania zapytań modelu.

knowledgeSourceParams KnowledgeSourceParams[]:

Lista parametrów środowiska uruchomieniowego dla źródeł wiedzy.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów w wydruku.

maxOutputSize

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxOutputSizeInTokens

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxRuntimeInSeconds

integer (int32)

Maksymalny czas pracy w sekundach.

messages

KnowledgeBaseMessage[]

Lista danych wejściowych stylu wiadomości czatu.

outputMode

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfiguracja wysiłku rozumowania wyszukiwania.

toolName

string

Narzędzie do wyboru. Pomiń przy wyszukiwaniu na poziomie całej klawiatury.

Odpowiedzi

Nazwisko Typ Opis
200 OK

string

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

Media Types: "text/event-stream", "application/json"

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Media Types: "text/event-stream", "application/json"

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

KnowledgeBaseRetrieveStream

Przykładowe żądanie

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?_overload=retrieveStream&api-version=2026-11-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      },
      "topicGraph": {
        "kind": "diverse",
        "diversityFactor": 0.1
      }
    }
  ],
  "toolName": "product-search"
}

Przykładowa odpowiedź

"event: retrieval.started\ndata: {\"requestId\":\"00000000-0000-0000-0000-000000000000\",\"knowledgeBaseName\":\"base-preview-test\",\"outputMode\":\"answerSynthesis\",\"reasoningEffort\":{\"kind\":\"low\"}}\n\nevent: activity.started\ndata: {\"id\":0,\"type\":\"modelQueryPlanning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":1,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":2,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":3,\"type\":\"modelAnswerSynthesis\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":4,\"type\":\"agenticReasoning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}\n\nevent: answer.completed\ndata: {\"messageIndex\":0,\"message\":{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}}\n\nevent: references.completed\ndata: [{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]\n\nevent: response.completed\ndata: {\"statusCode\":200,\"response\":{\"response\":[{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}],\"activity\":[{\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}],\"references\":[{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]}}\n\n"

Definicje

Nazwisko Opis
Accept

Nagłówek „Accept”.

AgentRuntimeGraphHydrateDocumentsParams

Limity wyboru i liczby dla nawodnionych dokumentów źródłowych zwracanych przez wyszukiwanie wiedzy.

AgentRuntimeGraphParams

Nadpisania specyficzne dla grafu dla źródła wiedzy Azure Blob z włączonym grafem podczas pobierania.

AgentRuntimeGraphProvenanceParams

Polityka hydratacji źródeł i dokumentów dla wyników wykresów wyszukiwania wiedzy.

AzureBlobKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy obiektu blob platformy Azure

BalancedVectorQueryTopicGraph

Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością.

DiverseVectorQueryTopicGraph

Wykorzystuje wykres tematyczny do różnorodnego wyszukiwania.

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

FabricDataAgentKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Data Agent

FabricOntologyKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Ontology

FileKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy plikowej

IndexedOneLakeKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy OneLake

IndexedSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy programu SharePoint

IndexedSqlKnowledgeSourceParams

Określa parametry wykonawcze dla indeksowanego źródła wiedzy SQL

KnowledgeBaseImageContent

Treści obrazowe.

KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.

KnowledgeBaseMessageContentType

Typ treści wiadomości.

KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.

KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.

KnowledgeBaseRetrievalRequest

Kontrakt wejściowy dla żądania pobrania.

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.

KnowledgeRetrievalIntentType

Rodzaj konfiguracji bazy wiedzy, która ma być używana.

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.

KnowledgeRetrievalSemanticIntent

Zamiar zapytania semantycznego.

KnowledgeSourceGraphProvenanceKind

Zachowanie dokumentu źródłowego dla wyszukiwania wiedzy opartej na grafach.

KnowledgeSourceKind

Rodzaj źródła wiedzy.

KnowledgeSourceResultsProcessing

Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane.

McpServerKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy serwera MCP

NoneVectorQueryTopicGraph

Używa normalnego wyszukiwania wektorowego bez wykresu tematów – różnorodne wyszukiwanie.

RemoteSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla zdalnego źródła wiedzy programu SharePoint

SearchIndexKnowledgeSourceBoostKind

Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy.

SearchIndexKnowledgeSourceFieldValueBoost

Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola.

SearchIndexKnowledgeSourceFilterHint

Podpowiedzi identyfikującej pole oraz wyczerpujące wartości uziemienia, które planer zapytań może wykorzystać podczas tworzenia filtra.

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

Konfiguruje automatyczne rozwiązywanie wartości uziemienia wskazówki filtra na podstawie faset indeksu docelowego.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu.

SearchIndexKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy indeksu wyszukiwania

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania.

VectorSearchTopicGraphKind

Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.

WebKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla internetowego źródła wiedzy

WorkIQKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy WorkIQ

Accept

Nagłówek „Accept”.

Wartość Opis
text/event-stream

AgentRuntimeGraphHydrateDocumentsParams

Limity wyboru i liczby dla nawodnionych dokumentów źródłowych zwracanych przez wyszukiwanie wiedzy.

Nazwisko Typ Domyślna wartość Opis
select

string

Pole źródłowe oddzielone przecinkami do uwzględnienia.

top

integer (int32)

minimum: 1
maximum: 100
50

Maksymalna ilość nawodnionych dokumentów do zwrotu. Domyślnie 50; jest to niezależne od liczby wierszy grafu.

AgentRuntimeGraphParams

Nadpisania specyficzne dla grafu dla źródła wiedzy Azure Blob z włączonym grafem podczas pobierania.

Nazwisko Typ Domyślna wartość Opis
includeQuery

boolean

False

Uwzględnij wygenerowany GQL w graphSearchArguments.gql. Pominięcie lub fałsz nie ujawnia wygenerowanego tekstu zapytania.

provenance

AgentRuntimeGraphProvenanceParams

Kontroluje, czy zwracane są również dokumenty źródłowe wspierające wyniki wykresów.

AgentRuntimeGraphProvenanceParams

Polityka hydratacji źródeł i dokumentów dla wyników wykresów wyszukiwania wiedzy.

Nazwisko Typ Domyślna wartość Opis
hydrateDocuments

AgentRuntimeGraphHydrateDocumentsParams

Opcje dokumentu źródłowego; obowiązują tylko wtedy, gdy rodzaj jest hydratowany.

kind

KnowledgeSourceGraphProvenanceKind

none

Czy pobieranie grafów zwraca tylko wiersze grafu, czy także nawadnia dokumenty źródłowe.

AzureBlobKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy obiektu blob platformy Azure

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

graphParameters

AgentRuntimeGraphParams

Widoczność zapytań grafowych oraz opcje hydratacji dokumentu źródłowego dla źródła obsługującego wykresy.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

azureBlob

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

topicGraph VectorQueryTopicGraph:

Nadpisuje przechowywany topicGraph źródła wiedzy dla tego pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

BalancedVectorQueryTopicGraph

Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością.

Nazwisko Typ Opis
kind string:

balanced

Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

Minimalna liczba kandydatów na wektory do pobrania przed próbkowaniem grafu tematycznego. Wartość domyślna to 1000.

DiverseVectorQueryTopicGraph

Wykorzystuje wykres tematyczny do różnorodnego wyszukiwania.

Nazwisko Typ Opis
diversityFactor

number (float)

minimum: 0
maximum: 1

Współczynnik różnorodności używany do wyszukiwania różnorodności na wykresie tematycznym. Jeśli zostanie pominięty, używany jest domyślny profil wykresu tematu.

kind string:

diverse

Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.

minDiversityPoolSize

integer (int32)

minimum: 250
maximum: 10000

Minimalna liczba kandydatów na wektory do pobrania przed próbkowaniem grafu tematycznego. Wartość domyślna to 1000.

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.

FabricDataAgentKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Data Agent

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

fabricDataAgent

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

FabricOntologyKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Ontology

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

fabricOntology

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

FileKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy plikowej

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

file

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

IndexedOneLakeKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy OneLake

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedOneLake

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

IndexedSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy programu SharePoint

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedSharePoint

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

IndexedSqlKnowledgeSourceParams

Określa parametry wykonawcze dla indeksowanego źródła wiedzy SQL

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedSql

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

KnowledgeBaseImageContent

Treści obrazowe.

Nazwisko Typ Opis
url

string (uri)

Adres URL obrazu.

KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.

Nazwisko Typ Opis
content KnowledgeBaseMessageContent[]:

Zawartość wiadomości.

role

string

Rola odpowiedzi narzędzia.

KnowledgeBaseMessageContentType

Typ treści wiadomości.

Wartość Opis
text

Rodzaj treści wiadomości tekstowej.

image

Rodzaj treści wiadomości obrazu.

KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.

Nazwisko Typ Opis
image

KnowledgeBaseImageContent

Treść obrazów.

type string:

image

Typ komunikatu

KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.

Nazwisko Typ Opis
text

string

Zawartość tekstowa.

type string:

text

Typ komunikatu

KnowledgeBaseRetrievalRequest

Kontrakt wejściowy dla żądania pobrania.

Nazwisko Typ Opis
includeActivity

boolean

Wskazuje, że wyniki pobierania powinny zawierać informacje o aktywności.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Lista zamierzonych zapytań, które mają być wykonywane bez planowania zapytań modelu.

knowledgeSourceParams KnowledgeSourceParams[]:

Lista parametrów środowiska uruchomieniowego dla źródeł wiedzy.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów w wydruku.

maxOutputSize

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxOutputSizeInTokens

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxRuntimeInSeconds

integer (int32)

Maksymalny czas pracy w sekundach.

messages

KnowledgeBaseMessage[]

Lista danych wejściowych stylu wiadomości czatu.

outputMode

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfiguracja wysiłku rozumowania wyszukiwania.

toolName

string

Narzędzie do wyboru. Pomiń przy wyszukiwaniu na poziomie całej klawiatury.

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.

KnowledgeRetrievalIntentType

Rodzaj konfiguracji bazy wiedzy, która ma być używana.

Wartość Opis
semantic

Intencja zapytania semantycznego języka naturalnego.

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.

KnowledgeRetrievalSemanticIntent

Zamiar zapytania semantycznego.

Nazwisko Typ Opis
search

string

Zapytanie semantyczne do wykonania

type string:

semantic

Typ intencji.

KnowledgeSourceGraphProvenanceKind

Zachowanie dokumentu źródłowego dla wyszukiwania wiedzy opartej na grafach.

Wartość Opis
none

Zwracaj wyniki wykresów bez nawadniania ich dokumentów źródłowych.

hydrate

Zwracaj także wybrane dokumenty źródłowe z skonfigurowanego indeksu pochodzenia.

KnowledgeSourceKind

Rodzaj źródła wiedzy.

Wartość Opis
searchIndex

Źródło wiedzy, które odczytuje dane z indeksu wyszukiwania.

azureBlob

Źródło wiedzy, które odczytuje i pozyskuje dane z Azure Blob Storage do indeksu wyszukiwania.

indexedSharePoint

Źródło wiedzy odczytujące dane z indeksowanego SharePoint.

indexedOneLake

Źródło wiedzy odczytujące dane z indeksowanego OneLake.

indexedSql

Źródło wiedzy, które pobiera i przetwarza dane z Azure SQL Database lub SQL Managed Instance do indeksu wyszukiwania.

web

Źródło wiedzy, które odczytuje dane z internetu.

remoteSharePoint

Źródło wiedzy, które odczytuje dane ze zdalnego SharePoint.

workIQ

Źródło wiedzy, które odczytuje dane z IQ pracy

file

Źródło wiedzy wspierające bezpośredni przesyłanie i indeksowanie plików.

mcpServer

Źródło wiedzy wspierane przez serwer MCP (Model Context Protocol).

fabricDataAgent

Źródło wiedzy pobierające dane z agenta danych Fabric.

fabricOntology

Źródło wiedzy pozyskujące dane z ontologii ontologii Microsoft Fabric.

KnowledgeSourceResultsProcessing

Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane.

Wartość Opis
rerank

Wyniki z tego źródła wiedzy przechodzą przez proces rerankingu. Jest to zachowanie domyślne.

none

Wyniki tego źródła wiedzy omijają ponowne rankingi i zachowują ich pierwotny porządek.

McpServerKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy serwera MCP

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

mcpServer

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

NoneVectorQueryTopicGraph

Używa normalnego wyszukiwania wektorowego bez wykresu tematów – różnorodne wyszukiwanie.

Nazwisko Typ Opis
kind string:

none

Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.

RemoteSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla zdalnego źródła wiedzy programu SharePoint

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

filterExpressionAddOn

string

Warunek filtru zastosowany do źródła danych programu SharePoint. Musi być ona określona w składni języka zapytań słów kluczowych. Zostanie on połączony jako połączenie z wyrażeniem filtru określonym w definicji źródła wiedzy.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

remoteSharePoint

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

SearchIndexKnowledgeSourceBoostKind

Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy.

Wartość Opis
fieldValue

Ulepszaj dokumenty na podstawie wartości pola.

multiWordExpression

Ulepszaj dokumenty oparte na wielowyrazowym wyrażeniu.

SearchIndexKnowledgeSourceFieldValueBoost

Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola.

Nazwisko Typ Opis
boost

number (double)

Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0.

boostInstructions

string

Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost.

field

string

minLength: 1

Nazwa pola indeksu wyszukiwania.

fieldValues

string[]

Reprezentatywne wartości dla tej dziedziny.

kind string:

fieldValue

Taka wskazówka do boostu.

SearchIndexKnowledgeSourceFilterHint

Podpowiedzi identyfikującej pole oraz wyczerpujące wartości uziemienia, które planer zapytań może wykorzystać podczas tworzenia filtra.

Nazwisko Typ Opis
autoConfiguration

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

Konfiguruje usługę do rozwiązywania wartości uziemienia z faset pola. Jego obecność umożliwia automatyczną konfigurację. Pole musi być filtrowalne i mieć tablicę do tablic twarzy. Nie obsługiwane, gdy indeks docelowy ma włączone uprawnienia na poziomie dokumentu lub etykiety wrażliwości Purview; to ograniczenie jest weryfikowane w czasie tworzenia/aktualizacji źródła wiedzy oraz pobierania bazy wiedzy. Wzajemnie wykluczające się z fieldValues. Obsługiwane tylko w magazynowanych queryHintsw źródle wiedzy, a nie w czasie queryHintOverridesżądania.

field

string

minLength: 1

Nazwa filtrowalnego pola indeksu wyszukiwania.

fieldValues

string[]

Pełny zestaw wartości dla pola. Maksymalnie 160 wartości, z maksymalnie 128 znakami na wartość oraz łącznie 2048 znakami. W wersjach obsługujących autoConfiguration, wymagane, chyba że autoConfiguration jest to określone i wzajemnie się z nim wyklucza.

filterInstructions

string

Instrukcje w języku naturalnym, które wyjaśniają, kiedy i jak filtrować na polu.

SearchIndexKnowledgeSourceFilterHintAutoConfiguration

Konfiguruje automatyczne rozwiązywanie wartości uziemienia wskazówki filtra na podstawie faset indeksu docelowego.

Nazwisko Typ Opis
cacheTtl

integer (int32)

minimum: 60
maximum: 3600

Liczba sekund rozwiązywanych wartości fasetów jest buforowana. Dozwolony zakres to 60 do 3600 dla usług dedykowanych oraz od 60 do 900 dla usług bezserwerowych. Po pominięciu domyślnie 3600 sekund dla usług dedykowanych i 900 sekund dla usług bezserwerowych.

maxFacetValueCount

integer (int32)

minimum: 1
maximum: 64

Maksymalna liczba wartości faset, które można użyć jako uziemienie. Domyślnie ustawione jest 64; dozwolony zakres to od 1 do 64. Wartości są wybierane w kolejności malejącej liczby faset, z tym samym limitem łącznej długości 2048 znaków oraz limitem 128 znaków na wartość jak ręcznie określone wartości filtra.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu.

Nazwisko Typ Opis
boost

number (double)

Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0.

boostInstructions

string

Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost.

fieldValues

string[]

Reprezentatywne wartości dla boostu.

kind string:

multiWordExpression

Taka wskazówka do boostu.

SearchIndexKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy indeksu wyszukiwania

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

filterAddOn

string

Warunek filtru zastosowany do indeksu (np. "State eq VA").

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

searchIndex

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

topicGraph VectorQueryTopicGraph:

Nadpisuje przechowywany topicGraph źródła wiedzy dla tego pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania.

Nazwisko Typ Opis
boosts SearchIndexKnowledgeSourceBoost[]:

Wzmacniaj wskazówki, które identyfikują warunki, które planista zapytań może wykorzystać, aby wpłynąć na pozycję dokumentu.

filters

SearchIndexKnowledgeSourceFilterHint[]

Podpowiedzi filtrujące identyfikujące pola i reprezentatywne wartości, których planer zapytań może używać podczas tworzenia filtrów.

VectorSearchTopicGraphKind

Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.

Wartość Opis
none

Używaj normalnego wyszukiwania wektorowego, gdy wyszukiwanie różnorodności wykresu tematów jest nieprawidłowe.

diverse

Korzystaj z wykresu tematycznego – różnorodne wyszukiwanie.

balanced

Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością.

WebKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla internetowego źródła wiedzy

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

count

integer (int32)

Liczba wyników z sieci Web do zwrócenia.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

freshness

string

Świeżość wyników internetowych.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

web

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

language

string

Język wyników internetowych.

market

string

Wyniki rynku internetowego.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

WorkIQKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy WorkIQ

Nazwisko Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

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

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

workIQ

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.