Knowledge Retrieval - Retrieve

Baza wiedzy KnowledgeBase pobiera odpowiednie dane z magazynów zapasowych.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?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.

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

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

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.

Odpowiedzi

Nazwisko Typ Opis
200 OK

KnowledgeBaseRetrievalResponse

Pomyślna reakcja na pobranie.

Other Status Codes

KnowledgeBaseRetrievalResponse

Częściowa reakcja na pobranie.

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

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Przykładowe żądanie

POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputDocuments": 5,
  "maxOutputSizeInTokens": 100000,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-stable-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex",
      "alwaysQuerySource": true,
      "filterAddOn": "foo eq bar"
    }
  ]
}

Przykładowa odpowiedź

{
  "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
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 1234
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}
{
  "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
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 1234
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Przykładowe żądanie

POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01



{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-stable-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex",
      "alwaysQuerySource": true,
      "filterAddOn": "foo eq bar"
    }
  ]
}

Przykładowa odpowiedź

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-stable-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 3.5,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 2.7,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Definicje

Nazwisko Opis
Accept

Nagłówek „Accept”.

AzureBlobKnowledgeSourceParams

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

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

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

KnowledgeBaseActivityRecordModel

Reprezentuje model używany w aktywności LLM bazy wiedzy, w tym nazwę modelu i identyfikator wdrożenia.

KnowledgeBaseActivityRecordType

Rodzaj rejestru aktywności.

KnowledgeBaseAgenticReasoningActivityRecord

Reprezentuje rekord działania wnioskowania agentycznego.

KnowledgeBaseAzureBlobActivityArguments

Reprezentuje argumenty, z którymi uruchomiono działanie pobierania obiektów blob platformy Azure.

KnowledgeBaseAzureBlobActivityRecord

Reprezentuje rekord działania pobierania obiektów blob platformy Azure.

KnowledgeBaseAzureBlobReference

Reprezentuje dokumentację Azure Blob Storage.

KnowledgeBaseErrorAdditionalInfo

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

KnowledgeBaseErrorDetail

Szczegóły błędu.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania plików.

KnowledgeBaseFileActivityRecord

Reprezentuje rekord aktywności pobierania plików.

KnowledgeBaseFileReference

Reprezentuje referencję do pliku dokumentu.

KnowledgeBaseImageContent

Treści obrazowe.

KnowledgeBaseIndexedOneLakeActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania indeksowanego OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Reprezentuje indeksowany rekord aktywności pobierania OneLake.

KnowledgeBaseIndexedOneLakeReference

Reprezentuje indeksowany dokument OneLake.

KnowledgeBaseIndexedSharePointActivityArguments

Reprezentuje argumenty, z których wykonano aktywność wyszukiwania indeksowanego SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Reprezentuje zindeksowany rekord aktywności pobierania w SharePoint.

KnowledgeBaseIndexedSharePointReference

Reprezentuje indeksowany dokument SharePoint.

KnowledgeBaseIndexedSqlActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność wyszukiwania indeksowanego SQL.

KnowledgeBaseIndexedSqlActivityRecord

Reprezentuje zindeksowany rekord aktywności wyszukiwania SQL.

KnowledgeBaseIndexedSqlReference

Reprezentuje referencję dokumentu Azure SQL.

KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.

KnowledgeBaseMessageContentType

Typ treści wiadomości.

KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.

KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.

KnowledgeBaseModelAnswerSynthesisActivityRecord

Reprezentuje rekord działania syntezy odpowiedzi LLM.

KnowledgeBaseModelQueryPlanningActivityRecord

Reprezentuje rekord działania planowania zapytań LLM.

KnowledgeBaseModelWebSummarizationActivityRecord

Reprezentuje rekord aktywności streszczającej LLM w sieci.

KnowledgeBaseReferenceType

Typ odwołania.

KnowledgeBaseRetrievalRequest

Kontrakt wejściowy dla żądania pobrania.

KnowledgeBaseRetrievalResponse

Kontrakt wyjściowy dla odpowiedzi pobierania.

KnowledgeBaseSearchIndexActivityArguments

Reprezentuje argumenty, z którymi zostało uruchomione działanie pobierania indeksu wyszukiwania.

KnowledgeBaseSearchIndexActivityRecord

Reprezentuje rekord działania pobierania indeksu wyszukiwania.

KnowledgeBaseSearchIndexReference

Reprezentuje dokumentację usługi Azure Search.

KnowledgeBaseWebActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania sieci.

KnowledgeBaseWebActivityRecord

Reprezentuje rekord aktywności wyszukiwania w sieci.

KnowledgeBaseWebReference

Reprezentuje odniesienie do dokumentu sieci Web.

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.

KnowledgeSourceKind

Rodzaj źródła wiedzy.

SearchIndexFieldReference

Referencja polowa dla indeksu wyszukiwania.

SearchIndexKnowledgeSourceParams

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

WebKnowledgeSourceParams

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

Accept

Nagłówek „Accept”.

Wartość Opis
application/json;odata.metadata=minimal

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.

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:

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.

rerankerThreshold

number (float)

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

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.

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.

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.

rerankerThreshold

number (float)

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

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.

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.

rerankerThreshold

number (float)

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

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.

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.

rerankerThreshold

number (float)

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

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.

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.

rerankerThreshold

number (float)

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

KnowledgeBaseActivityRecordModel

Reprezentuje model używany w aktywności LLM bazy wiedzy, w tym nazwę modelu i identyfikator wdrożenia.

Nazwisko Typ Opis
deploymentId

string

Identyfikator wdrożenia modelu użytego w danej aktywności.

modelName

string

Nazwa modelu użytego w danej aktywności.

KnowledgeBaseActivityRecordType

Rodzaj rejestru aktywności.

Wartość Opis
searchIndex

Wyszukaj aktywność wyszukiwania indeksu.

azureBlob

Aktywność pobierania Azure Blob.

indexedSharePoint

Aktywność wyszukiwania indeksowanego SharePoint.

indexedOneLake

Indeksowana aktywność odzyskiwania OneLake.

web

Aktywność wyszukiwania w sieci.

file

Aktywność pobierania plików.

indexedSql

Aktywność wyszukiwania indeksowanego SQL.

modelQueryPlanning

Aktywność planowania zapytań LLM.

modelAnswerSynthesis

Aktywność syntezy odpowiedzi LLM.

modelWebSummarization

Aktywność podsumowująca LLM w sieci.

agenticReasoning

Aktywność rozumowania agentycznego.

KnowledgeBaseAgenticReasoningActivityRecord

Reprezentuje rekord działania wnioskowania agentycznego.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

reasoningTokens

integer (int32)

Liczba tokenów wejściowych na potrzeby wnioskowania agenta.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

agenticReasoning

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseAzureBlobActivityArguments

Reprezentuje argumenty, z którymi uruchomiono działanie pobierania obiektów blob platformy Azure.

Nazwisko Typ Opis
search

string

Ciąg wyszukiwania używany do wykonywania zapytań dotyczących zawartości obiektu blob.

KnowledgeBaseAzureBlobActivityRecord

Reprezentuje rekord działania pobierania obiektów blob platformy Azure.

Nazwisko Typ Opis
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Argumenty obiektu blob platformy Azure dla działania pobierania.

completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

azureBlob

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseAzureBlobReference

Reprezentuje dokumentację Azure Blob Storage.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

blobUrl

string

Adres URL obiektu blob dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

azureBlob

Typ odwołania.

KnowledgeBaseErrorAdditionalInfo

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

Nazwisko Typ Opis
info

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

KnowledgeBaseErrorDetail

Szczegóły błędu.

Nazwisko Typ Opis
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Dodatkowe informacje o błędzie

code

string

Kod błędu.

details

KnowledgeBaseErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Cel błędu.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania plików.

Nazwisko Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania o zawartość plików.

KnowledgeBaseFileActivityRecord

Reprezentuje rekord aktywności pobierania plików.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

fileArguments

KnowledgeBaseFileActivityArguments

Argument pliku za aktywnością odzysku.

id

integer (int32)

Identyfikator rekordu działania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

file

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseFileReference

Reprezentuje referencję do pliku dokumentu.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docName

string

Nazwa dokumentu dla odniesienia.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

file

Typ odwołania.

KnowledgeBaseImageContent

Treści obrazowe.

Nazwisko Typ Opis
url

string (uri)

Adres URL obrazu.

KnowledgeBaseIndexedOneLakeActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania indeksowanego OneLake.

Nazwisko Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania do indeksowanych treści OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Reprezentuje indeksowany rekord aktywności pobierania OneLake.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

Indeksowane argumenty OneLake za aktywnością odzyskiwania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedOneLake

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedOneLakeReference

Reprezentuje indeksowany dokument OneLake.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedOneLake

Typ odwołania.

KnowledgeBaseIndexedSharePointActivityArguments

Reprezentuje argumenty, z których wykonano aktywność wyszukiwania indeksowanego SharePoint.

Nazwisko Typ Opis
search

string

Ciąg wyszukiwania używany do zapytań o indeksowane treści SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Reprezentuje zindeksowany rekord aktywności pobierania w SharePoint.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

Zindeksowane argumenty SharePoint dla aktywności pobierania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedSharePoint

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedSharePointReference

Reprezentuje indeksowany dokument SharePoint.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedSharePoint

Typ odwołania.

KnowledgeBaseIndexedSqlActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność wyszukiwania indeksowanego SQL.

Nazwisko Typ Opis
search

string

Ciąg wyszukiwania używany do zapytań o indeksowane treści SQL.

KnowledgeBaseIndexedSqlActivityRecord

Reprezentuje zindeksowany rekord aktywności wyszukiwania SQL.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

Zindeksowane argumenty SQL dla aktywności pobierania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedSql

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedSqlReference

Reprezentuje referencję dokumentu Azure SQL.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedSql

Typ odwołania.

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

KnowledgeBaseModelAnswerSynthesisActivityRecord

Reprezentuje rekord działania syntezy odpowiedzi LLM.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla działania syntezy odpowiedzi LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do syntezy odpowiedzi w LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania syntezy odpowiedzi LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelAnswerSynthesis

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseModelQueryPlanningActivityRecord

Reprezentuje rekord działania planowania zapytań LLM.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla działania planowania zapytań LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do planowania zapytań LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania planowania zapytań LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelQueryPlanning

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseModelWebSummarizationActivityRecord

Reprezentuje rekord aktywności streszczającej LLM w sieci.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla aktywności podsumowania stron LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do działania podsumowania stron internetowych LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania podsumowania stron LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelWebSummarization

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseReferenceType

Typ odwołania.

Wartość Opis
searchIndex

Wyszukaj indeks dokumentów referencyjnych.

azureBlob

Referencja dokumentów Azure Blob.

indexedSharePoint

Indeksowane odniesienie dokumentów SharePoint.

indexedOneLake

Indeksowany dokument OneLake.

web

Odniesienie do dokumentu internetowego.

file

Referencje do dokumentu.

indexedSql

Indeksowane odniesienie do dokumentu SQL.

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.

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.

KnowledgeBaseRetrievalResponse

Kontrakt wyjściowy dla odpowiedzi pobierania.

Nazwisko Typ Opis
activity KnowledgeBaseActivityRecord[]:

Rejestry aktywności do śledzenia postępów i implikacji rozliczeniowych.

references KnowledgeBaseReference[]:

Odwołania do danych wyszukiwania używanych w odpowiedzi.

response

KnowledgeBaseMessage[]

Wiadomości z odpowiedziami.

KnowledgeBaseSearchIndexActivityArguments

Reprezentuje argumenty, z którymi zostało uruchomione działanie pobierania indeksu wyszukiwania.

Nazwisko Typ Opis
filter

string

Ciąg filtru.

search

string

Ciąg wyszukiwania używany do wykonywania zapytań dotyczących indeksu wyszukiwania.

searchFields

SearchIndexFieldReference[]

Jakie pola były przeszukiwane.

semanticConfigurationName

string

Jaka konfiguracja semantyczna została użyta z indeksu wyszukiwania.

sourceDataFields

SearchIndexFieldReference[]

Jakie pola zostały wybrane do wyszukiwania.

KnowledgeBaseSearchIndexActivityRecord

Reprezentuje rekord działania pobierania indeksu wyszukiwania.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Argumenty indeksu wyszukiwania dla działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

searchIndex

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseSearchIndexReference

Reprezentuje dokumentację usługi Azure Search.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docKey

string

Klucz dokumentu dla referencji.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

searchIndex

Typ odwołania.

KnowledgeBaseWebActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania sieci.

Nazwisko Typ Opis
count

integer (int32)

Liczba wyników internetowych.

freshness

string

Świeżość do aktywności odzyskiwania.

language

string

Język do aktywności odzyskiwania.

market

string

Rynek aktywności odzyskiwania.

search

string

Ciąg wyszukiwania używany do zapytania w sieci.

KnowledgeBaseWebActivityRecord

Reprezentuje rekord aktywności wyszukiwania w sieci.

Nazwisko Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

web

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

webArguments

KnowledgeBaseWebActivityArguments

Argumenty internetowe za aktywnością wyszukiwania.

KnowledgeBaseWebReference

Reprezentuje odniesienie do dokumentu sieci Web.

Nazwisko Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

title

string

Tytuł dokumentu internetowego.

type string:

web

Typ odwołania.

url

string (uri)

Adres URL, z którego pochodzą dane referencyjne.

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.

KnowledgeRetrievalSemanticIntent

Zamiar zapytania semantycznego.

Nazwisko Typ Opis
search

string

Zapytanie semantyczne do wykonania

type string:

semantic

Typ intencji.

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.

file

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

SearchIndexFieldReference

Referencja polowa dla indeksu wyszukiwania.

Nazwisko Typ Opis
name

string

Nazwa pola.

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.

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.

rerankerThreshold

number (float)

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

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.

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.

rerankerThreshold

number (float)

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