Knowledge Retrieval - Retrieve

Usługa:
Search Service
Wersja interfejsu API:
2026-04-01

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

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

Parametry identyfikatora URI

Nazwa 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

Nazwa Wymagane Typ Opis
Accept

Accept

Nagłówek Accept.
x-ms-client-request-id

string (uuid)

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

Treść żądania

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

integer (int32)

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

integer (int32)

Maksymalny czas pracy w sekundach.

Odpowiedzi

Nazwa 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

Nazwa Opis
https://search.azure.com/.default

Przykłady

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Przykładowe żądanie

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Kod stanu:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Przykładowe żądanie

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Kod stanu:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Definicje

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

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy OneLake
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.
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.
KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.
KnowledgeBaseMessageContentType

Typ treści wiadomości.
KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.
KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.
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.
KnowledgeRetrievalMinimalReasoningEffort

Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem.
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

Wyliczenie

Nagłówek Accept.

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

AzureBlobKnowledgeSourceParams

Objekt

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

Nazwa Typ Opis
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.
rerankerThreshold

number (float)

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

ErrorAdditionalInfo

Objekt

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

Nazwa Typ Opis
info

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa 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

Objekt

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

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

IndexedOneLakeKnowledgeSourceParams

Objekt

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

Nazwa Typ Opis
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.
rerankerThreshold

number (float)

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

KnowledgeBaseActivityRecordType

Wyliczenie

Rodzaj rejestru aktywności.

Wartość Opis
searchIndex

Wyszukaj aktywność wyszukiwania indeksu.
azureBlob

Azure Blob retrieval activity.
indexedOneLake

Indeksowana aktywność odzyskiwania OneLake.
web

Aktywność wyszukiwania w sieci.
modelWebSummarization

Aktywność podsumowująca LLM w sieci.
agenticReasoning

Aktywność rozumowania agentycznego.

KnowledgeBaseAgenticReasoningActivityRecord

Objekt

Reprezentuje rekord działania wnioskowania agentycznego.

Nazwa Typ Opis
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.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

KnowledgeRetrievalMinimalReasoningEffort

Konfiguracja wysiłku rozumowania wyszukiwania.
type string:

agenticReasoning

Typ rekordu działania.

KnowledgeBaseAzureBlobActivityArguments

Objekt

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

Nazwa Typ Opis
search

string

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

KnowledgeBaseAzureBlobActivityRecord

Objekt

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

Nazwa Typ Opis
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Argumenty obiektu blob platformy Azure dla działania pobierania.
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.
type string:

azureBlob

Typ rekordu działania.

KnowledgeBaseAzureBlobReference

Objekt

Reprezentuje dokumentację Azure Blob Storage.

Nazwa Typ Opis
activitySource

integer (int32)

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

string

Adres URL obiektu blob 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.
type string:

azureBlob

Typ odwołania.

KnowledgeBaseErrorAdditionalInfo

Objekt

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

Nazwa Typ Opis
info

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

KnowledgeBaseErrorDetail

Objekt

Szczegóły błędu.

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

KnowledgeBaseImageContent

Objekt

Treści obrazowe.

Nazwa Typ Opis
url

string (uri)

Adres URL obrazu.

KnowledgeBaseIndexedOneLakeActivityArguments

Objekt

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

Nazwa Typ Opis
search

string

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

KnowledgeBaseIndexedOneLakeActivityRecord

Objekt

Reprezentuje indeksowany rekord aktywności pobierania OneLake.

Nazwa Typ Opis
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.
type string:

indexedOneLake

Typ rekordu działania.

KnowledgeBaseIndexedOneLakeReference

Objekt

Reprezentuje indeksowany dokument OneLake.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.
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.

KnowledgeBaseMessage

Objekt

Obiekt stylu komunikatu w języku naturalnym.

Nazwa Typ Opis
content KnowledgeBaseMessageContent[]:

Zawartość wiadomości.
role

string

Rola odpowiedzi narzędzia.

KnowledgeBaseMessageContentType

Wyliczenie

Typ treści wiadomości.

Wartość Opis
text

Rodzaj treści wiadomości tekstowej.
image

Rodzaj treści wiadomości obrazu.

KnowledgeBaseMessageImageContent

Objekt

Typ wiadomości obrazu.

Nazwa Typ Opis
image

KnowledgeBaseImageContent

Treść obrazów.
type string:

image

Typ wiadomości

KnowledgeBaseMessageTextContent

Objekt

Typ wiadomości tekstowej.

Nazwa Typ Opis
text

string

Zawartość tekstowa.
type string:

text

Typ wiadomości

KnowledgeBaseModelWebSummarizationActivityRecord

Objekt

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

Nazwa Typ Opis
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.
outputTokens

integer (int32)

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

modelWebSummarization

Typ rekordu działania.

KnowledgeBaseReferenceType

Wyliczenie

Typ odwołania.

Wartość Opis
searchIndex

Wyszukaj indeks dokumentów referencyjnych.
azureBlob

Azure Blob document reference.
indexedOneLake

Indeksowany dokument OneLake.
web

Odniesienie do dokumentu internetowego.

KnowledgeBaseRetrievalRequest

Objekt

Kontrakt wejściowy dla żądania pobrania.

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

integer (int32)

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

integer (int32)

Maksymalny czas pracy w sekundach.

KnowledgeBaseRetrievalResponse

Objekt

Kontrakt wyjściowy dla odpowiedzi pobierania.

Nazwa 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

Objekt

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

Nazwa 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

Objekt

Reprezentuje rekord działania pobierania indeksu wyszukiwania.

Nazwa Typ Opis
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.
type string:

searchIndex

Typ rekordu działania.

KnowledgeBaseSearchIndexReference

Objekt

Reprezentuje dokumentację usługi Azure Search.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.
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

Objekt

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

Nazwa 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

Objekt

Reprezentuje rekord aktywności wyszukiwania w sieci.

Nazwa Typ Opis
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.
type string:

web

Typ rekordu działania.
webArguments

KnowledgeBaseWebActivityArguments

Argumenty internetowe za aktywnością wyszukiwania.

KnowledgeBaseWebReference

Objekt

Reprezentuje odniesienie do dokumentu sieci Web.

Nazwa 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

Wyliczenie

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

Wartość Opis
semantic

Intencja zapytania semantycznego języka naturalnego.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

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

Nazwa Typ Opis
kind string:

minimal

Rodzaj wysiłku rozumowania.

KnowledgeRetrievalReasoningEffortKind

Wyliczenie

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

Wartość Opis
minimal

Nie wykonuje żadnych wyborów źródłowych, planowania zapytań ani wyszukiwania iteracyjnego.

KnowledgeRetrievalSemanticIntent

Objekt

Zamiar zapytania semantycznego.

Nazwa Typ Opis
search

string

Zapytanie semantyczne do wykonania
type string:

semantic

Typ intencji.

KnowledgeSourceKind

Wyliczenie

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

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

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

SearchIndexFieldReference

Objekt

Referencja polowa dla indeksu wyszukiwania.

Nazwa Typ Opis
name

string

Nazwa pola.

SearchIndexKnowledgeSourceParams

Objekt

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

Nazwa Typ Opis
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.
rerankerThreshold

number (float)

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

WebKnowledgeSourceParams

Objekt

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

Nazwa Typ Opis
count

integer (int32)

Liczba wyników z sieci Web do zwrócenia.
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.
rerankerThreshold

number (float)

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