Knowledge Retrieval - Retrieve

Služba:: Search Service

Verze rozhraní API:: 2025-11-01-preview

Znalostní báze získává relevantní data ze záložních skladů.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2025-11-01-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
knowledgeBaseName	path	True	string	Název znalostní báze.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Typ	Description
Accept	Accept	Hlavička Accept.
x-ms-query-source-authorization	string	Token identifikující uživatele, pro kterého je dotaz prováděn. Tento token se používá k vynucení bezpečnostních omezení dokumentů.
x-ms-client-request-id	string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Text požadavku

Name	Typ	Description
includeActivity	boolean	Označuje, že výsledky načítání by měly obsahovat informace o aktivitě.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Seznam zamýšlených dotazů, které mají být provedeny bez plánování dotazů na model.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Seznam běhových parametrů pro znalostní zdroje.
maxOutputSize	integer (int32)	Omezuje maximální velikost obsahu ve výstupu.
maxRuntimeInSeconds	integer (int32)	Maximální doba běhu v sekundách.
messages	KnowledgeBaseMessage[]	Seznam vstupů ve stylu chatových zpráv.
outputMode	KnowledgeRetrievalOutputMode	Výstupní konfigurace pro toto načtení.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurace úsilí o vyhledávání a uvažování.

Odpovědi

Name	Typ	Description
200 OK	KnowledgeBaseRetrievalResponse	Úspěšná reakce při odběru.
Other Status Codes	KnowledgeBaseRetrievalResponse	Částečná reakce na odběr.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Name	Description
https://search.azure.com/.default

Příklady

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Ukázkový požadavek

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



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

Ukázková odpověď

Stavový kód:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "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-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "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"
    }
  ]
}

Stavový kód:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "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

Ukázkový požadavek

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



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

Ukázková odpověď

Stavový kód:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "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"
    }
  ]
}

Stavový kód:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "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"
    }
  ]
}

Definice

Name	Description
Accept	Hlavička Accept.
AzureBlobKnowledgeSourceParams	Určuje parametry běhového prostředí pro zdroj znalostí o objektech blob v Azure
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
IndexedOneLakeKnowledgeSourceParams	Určuje parametry běhového prostředí pro indexovaný zdroj znalostí OneLake
IndexedSharePointKnowledgeSourceParams	Určuje parametry běhového prostředí pro indexovaný zdroj znalostí služby SharePoint
KnowledgeBaseActivityRecordType	Typ záznamu o aktivitě.
KnowledgeBaseAgenticReasoningActivityRecord	Představuje záznam aktivity agentického uvažování.
KnowledgeBaseAzureBlobActivityArguments	Představuje argumenty, se kterými byla spuštěna aktivita načítání objektů blob Azure.
KnowledgeBaseAzureBlobActivityRecord	Představuje záznam aktivity načítání objektů blob v Azure.
KnowledgeBaseAzureBlobReference	Představuje referenční informace k dokumentu služby Azure Blob Storage.
KnowledgeBaseErrorAdditionalInfo	Další informace o chybě správy prostředků
KnowledgeBaseErrorDetail	Podrobnosti o chybě.
KnowledgeBaseImageContent	Obsah.
KnowledgeBaseIndexedOneLakeActivityArguments	Reprezentuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Představuje indexovaný záznam o vyhledání OneLake.
KnowledgeBaseIndexedOneLakeReference	Představuje indexovaný odkaz na dokument OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Představuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání SharePointu.
KnowledgeBaseIndexedSharePointActivityRecord	Představuje indexovaný záznam aktivity vyhledávání v SharePointu.
KnowledgeBaseIndexedSharePointReference	Představuje indexovaný odkaz na dokument SharePoint.
KnowledgeBaseMessage	Objekt stylu zprávy v přirozeném jazyce.
KnowledgeBaseMessageContentType	Typ obsahu zprávy.
KnowledgeBaseMessageImageContent	Typ obrazové zprávy.
KnowledgeBaseMessageTextContent	Typ textové zprávy.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Představuje záznam aktivity syntézy odpovědí LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Představuje záznam aktivity plánování dotazu LLM.
KnowledgeBaseReferenceType	Typ odkazu.
KnowledgeBaseRemoteSharePointActivityArguments	Představuje argumenty, se kterými byla aktivnost vzdáleného vyhledávání SharePointu spuštěna.
KnowledgeBaseRemoteSharePointActivityRecord	Představuje záznam vzdálené aktivity pro vyhledávání SharePointu.
KnowledgeBaseRemoteSharePointReference	Představuje odkaz na vzdálený dokument služby SharePoint.
KnowledgeBaseRetrievalRequest	Vstupní kontrakt pro požadavek na načtení.
KnowledgeBaseRetrievalResponse	Výstupní kontrakt pro odpověď na načtení.
KnowledgeBaseSearchIndexActivityArguments	Představuje argumenty, se kterými byla spuštěna aktivita načítání vyhledávacího indexu.
KnowledgeBaseSearchIndexActivityRecord	Představuje záznam aktivity načítání indexu vyhledávání.
KnowledgeBaseSearchIndexReference	Představuje referenční dokument Azure Search.
KnowledgeBaseWebActivityArguments	Představuje argumenty, se kterými byla aktivita webového vyhledávání spuštěna.
KnowledgeBaseWebActivityRecord	Představuje záznam o aktivitách vyhledávání na webu.
KnowledgeBaseWebReference	Představuje odkaz na webový dokument.
KnowledgeRetrievalIntentType	Druh konfigurace znalostní báze, který se má použít.
KnowledgeRetrievalLowReasoningEffort	Provádějte načítání znalostí s nízkým úsilím při uvažování.
KnowledgeRetrievalMediumReasoningEffort	Spusťte získávání znalostí se středním úsilím při uvažování.
KnowledgeRetrievalMinimalReasoningEffort	Spouštějte načítání znalostí s minimálním úsilím při uvažování.
KnowledgeRetrievalOutputMode	Výstupní konfigurace pro toto načtení.
KnowledgeRetrievalReasoningEffortKind	Množství úsilí, které je třeba vynaložit při načítání.
KnowledgeRetrievalSemanticIntent	Záměr sémantického dotazu.
KnowledgeSourceKind	Druh zdroje znalostí.
RemoteSharePointKnowledgeSourceParams	Určuje parametry běhového prostředí pro vzdálený zdroj znalostí služby SharePoint
SearchIndexFieldReference	Referenční pole pro vyhledávací index.
SearchIndexKnowledgeSourceParams	Určuje parametry běhového prostředí pro zdroj znalostí o indexu vyhledávání
SharePointSensitivityLabelInfo	Informace o popisku citlivosti použitém u dokumentu SharePoint.
WebKnowledgeSourceParams	Určuje parametry běhového prostředí pro webový zdroj znalostí

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro zdroj znalostí o objektech blob v Azure

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: azureBlob	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

IndexedOneLakeKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro indexovaný zdroj znalostí OneLake

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: indexedOneLake	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.

IndexedSharePointKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro indexovaný zdroj znalostí služby SharePoint

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: indexedSharePoint	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.

KnowledgeBaseActivityRecordType

Výčet

Typ záznamu o aktivitě.

Hodnota	Description
searchIndex	Vyhledávání indexové aktivity.
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	Indexovaná aktivita vyhledávání SharePointu.
indexedOneLake	Indexovaná aktivita vyhledávání OneLake.
web	Aktivita vyhledávání webu.
remoteSharePoint	Aktivita vzdáleného vyhledávání SharePointu.
modelQueryPlanning	Aktivita plánování dotazů pro LLM.
modelAnswerSynthesis	Aktivita syntézy odpovědí LLM.
agenticReasoning	Činnost agentického uvažování.

KnowledgeBaseAgenticReasoningActivityRecord

Objekt

Představuje záznam aktivity agentického uvažování.

Name	Typ	Description
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
reasoningTokens	integer (int32)	Počet vstupních tokenů pro agentické uvažování.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurace úsilí o vyhledávání a uvažování.
type	string: agenticReasoning	Typ záznamu aktivity.

KnowledgeBaseAzureBlobActivityArguments

Objekt

Představuje argumenty, se kterými byla spuštěna aktivita načítání objektů blob Azure.

Name	Typ	Description
search	string	Vyhledávací řetězec používaný k dotazování na obsah objektů blob.

KnowledgeBaseAzureBlobActivityRecord

Objekt

Představuje záznam aktivity načítání objektů blob v Azure.

Name	Typ	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Argumenty objektu blob azure pro aktivitu načítání.
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
type	string: azureBlob	Typ záznamu aktivity.

KnowledgeBaseAzureBlobReference

Objekt

Představuje referenční informace k dokumentu služby Azure Blob Storage.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
blobUrl	string	Adresa URL objektu blob pro referenci.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
sourceData		Zdrojová data pro referenci.
type	string: azureBlob	Typ odkazu.

KnowledgeBaseErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

KnowledgeBaseErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	KnowledgeBaseErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

KnowledgeBaseImageContent

Objekt

Obsah.

Name	Typ	Description
url	string (uri)	Adresa URL obrázku.

KnowledgeBaseIndexedOneLakeActivityArguments

Objekt

Reprezentuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání OneLake.

Name	Typ	Description
search	string	Vyhledávací řetězec používaný k dotazování na obsah indexovaného OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objekt

Představuje indexovaný záznam o vyhledání OneLake.

Name	Typ	Description
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Indexované OneLake argumenty pro aktivnost vyhledávání.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
type	string: indexedOneLake	Typ záznamu aktivity.

KnowledgeBaseIndexedOneLakeReference

Objekt

Představuje indexovaný odkaz na dokument OneLake.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
docUrl	string	Adresa URL dokumentu pro referenci.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
sourceData		Zdrojová data pro referenci.
type	string: indexedOneLake	Typ odkazu.

KnowledgeBaseIndexedSharePointActivityArguments

Objekt

Představuje argumenty, se kterými byla spuštěna indexovaná aktivita vyhledávání SharePointu.

Name	Typ	Description
search	string	Vyhledávací řetězec používaný k dotazování indexovaného obsahu SharePointu.

KnowledgeBaseIndexedSharePointActivityRecord

Objekt

Představuje indexovaný záznam aktivity vyhledávání v SharePointu.

Name	Typ	Description
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Indexované argumenty SharePointu pro aktivnost vyhledávání.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
type	string: indexedSharePoint	Typ záznamu aktivity.

KnowledgeBaseIndexedSharePointReference

Objekt

Představuje indexovaný odkaz na dokument SharePoint.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
docUrl	string	Adresa URL dokumentu pro referenci.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
sourceData		Zdrojová data pro referenci.
type	string: indexedSharePoint	Typ odkazu.

KnowledgeBaseMessage

Objekt

Objekt stylu zprávy v přirozeném jazyce.

Name	Typ	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Obsah zprávy.
role	string	Role odezvy nástroje.

KnowledgeBaseMessageContentType

Výčet

Typ obsahu zprávy.

Hodnota	Description
text	Druh obsahu textové zprávy.
image	Druh obsahu obrazové zprávy.

KnowledgeBaseMessageImageContent

Objekt

Typ obrazové zprávy.

Name	Typ	Description
image	KnowledgeBaseImageContent	Obsah obrázků.
type	string: image	Typ zprávy

KnowledgeBaseMessageTextContent

Objekt

Typ textové zprávy.

Name	Typ	Description
text	string	Textový obsah.
type	string: text	Typ zprávy

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objekt

Představuje záznam aktivity syntézy odpovědí LLM.

Name	Typ	Description
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
inputTokens	integer (int32)	Počet vstupních tokenů pro aktivitu syntézy odpovědí LLM.
outputTokens	integer (int32)	Počet výstupních tokenů pro aktivitu syntézy odpovědí LLM.
type	string: modelAnswerSynthesis	Typ záznamu aktivity.

KnowledgeBaseModelQueryPlanningActivityRecord

Objekt

Představuje záznam aktivity plánování dotazu LLM.

Name	Typ	Description
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
inputTokens	integer (int32)	Počet vstupních tokenů pro aktivitu plánování dotazů LLM.
outputTokens	integer (int32)	Počet výstupních tokenů pro aktivitu plánování dotazů LLM.
type	string: modelQueryPlanning	Typ záznamu aktivity.

KnowledgeBaseReferenceType

Výčet

Typ odkazu.

Hodnota	Description
searchIndex	Vyhledejte index, reference dokumentu.
azureBlob	Azure Blob document reference.
indexedSharePoint	Indexovaná reference na dokumenty SharePoint.
indexedOneLake	Indexovaný dokument OneLake.
web	Odkaz na webový dokument.
remoteSharePoint	Reference dokumentů v Remote SharePoint.

KnowledgeBaseRemoteSharePointActivityArguments

Objekt

Představuje argumenty, se kterými byla aktivnost vzdáleného vyhledávání SharePointu spuštěna.

Name	Typ	Description
filterExpressionAddOn	string	Filtrační výrazový doplněk pro retrievalní aktivitu.
search	string	Vyhledávací řetězec používaný k dotazování vzdáleného zdroje znalostí SharePointu.

KnowledgeBaseRemoteSharePointActivityRecord

Objekt

Představuje záznam vzdálené aktivity pro vyhledávání SharePointu.

Name	Typ	Description
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Argumenty vzdáleného SharePointu pro aktivnost vyhledávání.
type	string: remoteSharePoint	Typ záznamu aktivity.

KnowledgeBaseRemoteSharePointReference

Objekt

Představuje odkaz na vzdálený dokument služby SharePoint.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
searchSensitivityLabelInfo	SharePointSensitivityLabelInfo	Informace o citlivém štítku aplikované na dokument SharePoint.
sourceData		Zdrojová data pro referenci.
type	string: remoteSharePoint	Typ odkazu.
webUrl	string (uri)	Adresa URL, ze které pocházejí referenční data.

KnowledgeBaseRetrievalRequest

Objekt

Vstupní kontrakt pro požadavek na načtení.

Name	Typ	Description
includeActivity	boolean	Označuje, že výsledky načítání by měly obsahovat informace o aktivitě.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Seznam zamýšlených dotazů, které mají být provedeny bez plánování dotazů na model.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Seznam běhových parametrů pro znalostní zdroje.
maxOutputSize	integer (int32)	Omezuje maximální velikost obsahu ve výstupu.
maxRuntimeInSeconds	integer (int32)	Maximální doba běhu v sekundách.
messages	KnowledgeBaseMessage[]	Seznam vstupů ve stylu chatových zpráv.
outputMode	KnowledgeRetrievalOutputMode	Výstupní konfigurace pro toto načtení.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurace úsilí o vyhledávání a uvažování.

KnowledgeBaseRetrievalResponse

Objekt

Výstupní kontrakt pro odpověď na načtení.

Name	Typ	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Záznamy o aktivitách pro sledování průběhu a důsledků fakturace.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Odkazy na načítání dat použitých v odpovědi.
response	KnowledgeBaseMessage[]	Odpovědi.

KnowledgeBaseSearchIndexActivityArguments

Objekt

Představuje argumenty, se kterými byla spuštěna aktivita načítání vyhledávacího indexu.

Name	Typ	Description
filter	string	Řetězec filtru.
search	string	Hledaný řetězec použitý k dotazování na vyhledávací index.
searchFields	SearchIndexFieldReference[]	Na jakých polích se prohledávalo.
semanticConfigurationName	string	Jaká sémantická konfigurace byla použita z vyhledávacího indexu.
sourceDataFields	SearchIndexFieldReference[]	Jaká pole byla vybrána pro vyhledávání.

KnowledgeBaseSearchIndexActivityRecord

Objekt

Představuje záznam aktivity načítání indexu vyhledávání.

Name	Typ	Description
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Argumenty indexu vyhledávání pro aktivnost vyhledávání.
type	string: searchIndex	Typ záznamu aktivity.

KnowledgeBaseSearchIndexReference

Objekt

Představuje referenční dokument Azure Search.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
docKey	string	Klíč dokumentu pro odkaz.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
sourceData		Zdrojová data pro referenci.
type	string: searchIndex	Typ odkazu.

KnowledgeBaseWebActivityArguments

Objekt

Představuje argumenty, se kterými byla aktivita webového vyhledávání spuštěna.

Name	Typ	Description
count	integer (int32)	Počet vrácených webových výsledků.
freshness	string	Čerstvost pro vynášení.
language	string	Jazyk pro vyhledávací aktivitu.
market	string	Trh pro aktivitu získávání.
search	string	Vyhledávací řetězec používaný k dotazování na webu.

KnowledgeBaseWebActivityRecord

Objekt

Představuje záznam o aktivitách vyhledávání na webu.

Name	Typ	Description
count	integer (int32)	Počet načtených dokumentů, které byly dostatečně relevantní pro překročení prahové hodnoty pro opětovné pořadí.
elapsedMs	integer (int32)	Čas, který uplynul v milisekundách pro aktivitu načítání.
error	KnowledgeBaseErrorDetail	Chyba podrobně vysvětluje, proč se operace nezdařila. Tato vlastnost je zahrnuta pouze v případě, že aktivita není úspěšná.
id	integer (int32)	ID záznamu aktivity.
knowledgeSourceName	string	Zdroj znalostí pro vyhledávací aktivitu.
queryTime	string (date-time)	Čas dotazu pro tuto aktivitu načítání.
type	string: web	Typ záznamu aktivity.
webArguments	KnowledgeBaseWebActivityArguments	Web argumentuje pro aktivitu vyhledávání.

KnowledgeBaseWebReference

Objekt

Představuje odkaz na webový dokument.

Name	Typ	Description
activitySource	integer (int32)	ID zdrojové aktivity odkazu.
id	string	ID odkazu.
rerankerScore	number (float)	Skóre opětovného hodnocení pro odkaz na dokument.
sourceData		Zdrojová data pro referenci.
title	string	Název webového dokumentu.
type	string: web	Typ odkazu.
url	string (uri)	Adresa URL, ze které pocházejí referenční data.

KnowledgeRetrievalIntentType

Výčet

Druh konfigurace znalostní báze, který se má použít.

Hodnota	Description
semantic	Záměr sémantického dotazu v přirozeném jazyce.

KnowledgeRetrievalLowReasoningEffort

Objekt

Provádějte načítání znalostí s nízkým úsilím při uvažování.

Name	Typ	Description
kind	string: low	Druh úsilí o uvažování.

KnowledgeRetrievalMediumReasoningEffort

Objekt

Spusťte získávání znalostí se středním úsilím při uvažování.

Name	Typ	Description
kind	string: medium	Druh úsilí o uvažování.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Spouštějte načítání znalostí s minimálním úsilím při uvažování.

Name	Typ	Description
kind	string: minimal	Druh úsilí o uvažování.

KnowledgeRetrievalOutputMode

Výčet

Výstupní konfigurace pro toto načtení.

Hodnota	Description
extractiveData	Vraťte data ze zdrojů znalostí přímo bez generativních změn.
answerSynthesis	Syntetizuje odpověď pro datovou část odpovědi.

KnowledgeRetrievalReasoningEffortKind

Výčet

Množství úsilí, které je třeba vynaložit při načítání.

Hodnota	Description
minimal	Neprovádí žádné výběry zdrojů, plánování dotazů ani iterativní vyhledávání.
low	Při načítání používejte nízké uvažování.
medium	Při načítání používejte mírné množství uvažování.

KnowledgeRetrievalSemanticIntent

Objekt

Záměr sémantického dotazu.

Name	Typ	Description
search	string	Sémantický dotaz ke spuštění
type	string: semantic	Typ záměru.

KnowledgeSourceKind

Výčet

Druh zdroje znalostí.

Hodnota	Description
searchIndex	Zdroj znalostí, který čte data z indexu vyhledávání.
azureBlob	Zdroj znalostí, který čte a ingestuje data z Azure Blob Storage do indexu vyhledávání.
indexedSharePoint	Zdroj znalostí, který čte data z indexovaného SharePointu.
indexedOneLake	Zdroj znalostí, který čte data z indexovaného OneLake.
web	Zdroj znalostí, který čte data z webu.
remoteSharePoint	Zdroj znalostí, který čte data z vzdáleného SharePointu.

RemoteSharePointKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro vzdálený zdroj znalostí služby SharePoint

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
filterExpressionAddOn	string	Podmínka filtru použitá na zdroj dat SharePoint. Musí být zadán v syntaxi jazyka dotazu na klíčové slovo. Bude kombinován jako spojení s výrazem filtru uvedeným v definici zdroje znalostí.
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: remoteSharePoint	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.

SearchIndexFieldReference

Objekt

Referenční pole pro vyhledávací index.

Name	Typ	Description
name	string	Název pole.

SearchIndexKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro zdroj znalostí o indexu vyhledávání

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
filterAddOn	string	Podmínka filtru aplikovaná na index (např. 'State eq VA').
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: searchIndex	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.

SharePointSensitivityLabelInfo

Objekt

Informace o popisku citlivosti použitém u dokumentu SharePoint.

Name	Typ	Description
color	string	Barva, kterou má uživatelské rozhraní zobrazit pro popisek, pokud je nakonfigurováno.
displayName	string	Zobrazovaný název popisku citlivosti.
isEncrypted	boolean	Označuje, jestli popisek citlivosti vynucuje šifrování.
priority	integer (int32)	Priorita, ve které se popisek citlivosti použije.
sensitivityLabelId	string	ID popisku citlivosti.
tooltip	string	Popisek nástroje, který by se měl zobrazit pro popisek v uživatelském rozhraní.

WebKnowledgeSourceParams

Objekt

Určuje parametry běhového prostředí pro webový zdroj znalostí

Name	Typ	Description
alwaysQuerySource	boolean	Označuje, že tento zdroj znalostí by měl obejít výběr zdroje a vždy se na něj dotazovat při načítání.
count	integer (int32)	Počet webových výsledků, které se mají vrátit.
freshness	string	Svěžest webových výsledků.
includeReferenceSourceData	boolean	Označuje, zda mají odkazy ve své datové části obsahovat strukturovaná data získaná během načítání.
includeReferences	boolean	Označuje, zda mají být zahrnuty odkazy pro data načtená z tohoto zdroje.
kind	string: web	Typ zdroje znalostí.
knowledgeSourceName	string	Název indexu, na který se parametry vztahují.
language	string	Výsledkem je jazyk webu.
market	string	Trh webových výsledků.
rerankerThreshold	number (float)	Prahová hodnota opětovného pořadí, kterou musí splňovat všechny načtené dokumenty, aby mohly být zahrnuty do odpovědi.