Knowledge Retrieval - Retrieve

Služba:
Search Service
Verze rozhraní API:
2026-04-01

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

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

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 Vyžadováno Typ Description
Accept

Accept

Hlavička Accept.
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[]:

Seznam běhových parametrů pro znalostní zdroje.
maxOutputSizeInTokens

integer (int32)

Omezuje maximální velikost obsahu ve výstupu.
maxRuntimeInSeconds

integer (int32)

Maximální doba běhu v sekundách.

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

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"
    }
  ]
}

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-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"
    }
  ]
}
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-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

Ukázkový požadavek

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"
    }
  ]
}

Ukázková odpověď

Stavový kód:
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"
    }
  ]
}
Stavový kód:
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"
    }
  ]
}

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

Představuje záznam aktivity webové sumarizace LLM.
KnowledgeBaseReferenceType

Typ odkazu.
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.
KnowledgeRetrievalMinimalReasoningEffort

Spouštějte načítání znalostí s minimálním úsilím při uvažování.
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í.
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í
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
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
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.

KnowledgeBaseActivityRecordType

Výčet

Typ záznamu o aktivitě.

Hodnota Description
searchIndex

Vyhledávání indexové aktivity.
azureBlob

Azure Blob retrieval activity.
indexedOneLake

Indexovaná aktivita vyhledávání OneLake.
web

Aktivita vyhledávání webu.
modelWebSummarization

Aktivita shrnutí webu 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:

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.

KnowledgeBaseMessage

Objekt

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

Name Typ Description
content KnowledgeBaseMessageContent[]:

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

KnowledgeBaseModelWebSummarizationActivityRecord

Objekt

Představuje záznam aktivity webové sumarizace 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 webové sumarizace LLM.
outputTokens

integer (int32)

Počet výstupních tokenů pro aktivitu shrnutí webu LLM.
type string:

modelWebSummarization

Typ záznamu aktivity.

KnowledgeBaseReferenceType

Výčet

Typ odkazu.

Hodnota Description
searchIndex

Vyhledejte index, reference dokumentu.
azureBlob

Azure Blob document reference.
indexedOneLake

Indexovaný dokument OneLake.
web

Odkaz na webový dokument.

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[]:

Seznam běhových parametrů pro znalostní zdroje.
maxOutputSizeInTokens

integer (int32)

Omezuje maximální velikost obsahu ve výstupu.
maxRuntimeInSeconds

integer (int32)

Maximální doba běhu v sekundách.

KnowledgeBaseRetrievalResponse

Objekt

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

Name Typ Description
activity KnowledgeBaseActivityRecord[]:

Záznamy o aktivitách pro sledování průběhu a důsledků fakturace.
references KnowledgeBaseReference[]:

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.

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

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

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

Zdroj znalostí, který čte data z indexovaného OneLake.
web

Zdroj znalostí, který čte data z webu.

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

WebKnowledgeSourceParams

Objekt

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

Name Typ Description
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.