Knowledge Retrieval - Retrieve

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

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-05-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 Vyžadováno 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[]:

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů ve výstupu.

maxOutputSize

integer (int32)

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

maxOutputSizeInTokens

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:

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

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



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

Ukázková odpověď

{
  "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,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "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"
    }
  ],
  "responseSensitivityLabelInfo": {
    "displayName": "Confidential",
    "sensitivityLabelId": "00000000-0000-0000-0000-000000000001",
    "toolTip": "This content is confidential.",
    "priority": 2,
    "color": "#FF0000",
    "isEncrypted": false
  }
}
{
  "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

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



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

Ukázková odpověď

{
  "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"
    }
  ]
}
{
  "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ě při správě 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.)

FabricDataAgentKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí Fabric Data Agenta

FabricOntologyKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí Fabric Ontology

FileKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí souboru

ImageServingStatistics

Statistiky o podávání obrazu během obnovovací činnosti.

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

IndexedSqlKnowledgeSourceParams

Specifikuje parametry běhu pro indexovaný zdroj znalostí SQL

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ě při správě prostředků

KnowledgeBaseErrorDetail

Podrobnosti o chybě.

KnowledgeBaseFabricDataAgentActivityArguments

Reprezentuje argumenty, se kterými byla aktivnost při získávání Fabric Data Agent spuštěna.

KnowledgeBaseFabricDataAgentActivityRecord

Představuje záznam aktivity pro získání Fabric Data Agent.

KnowledgeBaseFabricDataAgentReference

Představuje referenci dokumentu Fabric Data Agent.

KnowledgeBaseFabricOntologyActivityArguments

Představuje argumenty, se kterými byla provedena aktivita vyhledávání Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Představuje záznam aktivity vyhledávání Fabric Ontology.

KnowledgeBaseFabricOntologyReference

Představuje referenci dokumentu Fabric Ontology.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, se kterými byla aktivnost načtení souboru provedena.

KnowledgeBaseFileActivityRecord

Představuje záznam aktivity při získávání souboru.

KnowledgeBaseFileReference

Představuje odkaz na dokument souboru.

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.

KnowledgeBaseIndexedSqlActivityArguments

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

KnowledgeBaseIndexedSqlActivityRecord

Představuje indexovaný záznam SQL retrieval aktivity.

KnowledgeBaseIndexedSqlReference

Představuje referenční dokument Azure SQL.

KnowledgeBaseMcpServerActivityArguments

Představuje argumenty, se kterými byla aktivnost načítání MCP serveru provedena.

KnowledgeBaseMcpServerActivityRecord

Představuje záznam o načítání MCP serveru.

KnowledgeBaseMcpServerReference

Představuje referenci dokumentu MCP serveru.

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.

KnowledgeBaseModelWebSummarizationActivityRecord

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

KnowledgeBaseWorkIQActivityArguments

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

KnowledgeBaseWorkIQActivityRecord

Představuje záznam aktivity vyhledávání ve WorkIQ.

KnowledgeBaseWorkIQReference

Představuje referenci na dokument WorkIQ.

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

McpServerKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí MCP serveru

PurviewSensitivityLabelInfo

Informace o citlivém štítku aplikovaném na dokument

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í

WebKnowledgeSourceParams

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

WorkIQAttribution

Informace o atribuci pro referenci WorkIQ.

WorkIQKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí WorkIQ

Accept

Hlavička Accept.

Hodnota Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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

Další informace o chybě při správě prostředků

Name Typ Description
info

Další informace.

type

string

Další typ informací.

ErrorDetail

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

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.

FabricDataAgentKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí Fabric Data Agenta

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

fabricDataAgent

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

FabricOntologyKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí Fabric Ontology

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

fabricOntology

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

FileKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí souboru

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

file

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

ImageServingStatistics

Statistiky o podávání obrazu během obnovovací činnosti.

Name Typ Description
imagesRetrieved

integer (int32)

Počet obrázků získaných z asset store.

imagesSentToModel

integer (int32)

Počet obrázků odeslaných do downstream modelu.

totalImageSizeBytes

integer (int64)

Celková velikost obrázků zaslaných modelu v bajtech.

verbalizationUsed

boolean

Označuje, zda byla použita verbální formace obrázků místo přímého podávání obrázků.

IndexedOneLakeKnowledgeSourceParams

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

IndexedSqlKnowledgeSourceParams

Specifikuje parametry běhu pro indexovaný zdroj znalostí SQL

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

indexedSql

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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

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.

workIQ

Aktivita na obnovu WorkIQ.

fabricDataAgent

Aktivita získávání Fabric Data Agent.

fabricOntology

Aktivita vyhledávání Fabric Ontology.

mcpServer

Aktivita načítání MCP serveru.

file

Aktivita vyhledávání souborů.

indexedSql

Indexovaná aktivita vyhledávání SQL.

modelQueryPlanning

Aktivita plánování dotazů pro LLM.

modelAnswerSynthesis

Aktivita syntézy odpovědí LLM.

modelWebSummarization

Aktivita shrnutí webu LLM.

agenticReasoning

Činnost agentického uvažování.

KnowledgeBaseAgenticReasoningActivityRecord

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:

Konfigurace úsilí o vyhledávání a uvažování.

type string:

agenticReasoning

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseAzureBlobActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseAzureBlobReference

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.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informace o citlivosti pro referenci.

sourceData

Zdrojová data pro referenci.

type string:

azureBlob

Typ odkazu.

KnowledgeBaseErrorAdditionalInfo

Další informace o chybě při správě prostředků

Name Typ Description
info

Další informace.

type

string

Další typ informací.

KnowledgeBaseErrorDetail

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.

KnowledgeBaseFabricDataAgentActivityArguments

Reprezentuje argumenty, se kterými byla aktivnost při získávání Fabric Data Agent spuštěna.

Name Typ Description
search

string

Vyhledávací řetězec používaný k dotazování na zdroj znalostí Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Představuje záznam aktivity pro získání Fabric Data Agent.

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

fabricDataAgentArguments

KnowledgeBaseFabricDataAgentActivityArguments

Argumenty Fabric Data Agent pro aktivnost vyhledávání.

id

integer (int32)

ID záznamu aktivity.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

knowledgeSourceName

string

Zdroj znalostí pro vyhledávací aktivitu.

queryTime

string (date-time)

Čas dotazu pro tuto aktivitu načítání.

type string:

fabricDataAgent

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseFabricDataAgentReference

Představuje referenci dokumentu Fabric Data Agent.

Name Typ Description
activitySource

integer (int32)

ID zdrojové aktivity odkazu.

dataAgentId

string

ID Fabric Data Agent.

id

string

ID odkazu.

rerankerScore

number (float)

Skóre opětovného hodnocení pro odkaz na dokument.

sourceData

Zdrojová data pro referenci.

type string:

fabricDataAgent

Typ odkazu.

workspaceId

string

ID pracovního prostoru Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Představuje argumenty, se kterými byla provedena aktivita vyhledávání Fabric Ontology.

Name Typ Description
search

string

Vyhledávací řetězec používaný k dotazování na zdroj znalostí Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Představuje záznam aktivity vyhledávání Fabric Ontology.

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

fabricOntologyArguments

KnowledgeBaseFabricOntologyActivityArguments

Argumenty Fabric Ontology podporují aktivitu vyhledávání.

id

integer (int32)

ID záznamu aktivity.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

knowledgeSourceName

string

Zdroj znalostí pro vyhledávací aktivitu.

queryTime

string (date-time)

Čas dotazu pro tuto aktivitu načítání.

type string:

fabricOntology

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseFabricOntologyReference

Představuje referenci dokumentu Fabric Ontology.

Name Typ Description
activitySource

integer (int32)

ID zdrojové aktivity odkazu.

id

string

ID odkazu.

ontologyId

string

Ontology ID v rámci pracovního prostoru.

rerankerScore

number (float)

Skóre opětovného hodnocení pro odkaz na dokument.

sourceData

Zdrojová data pro referenci.

type string:

fabricOntology

Typ odkazu.

workspaceId

string

ID pracovního prostoru Fabric.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, se kterými byla aktivnost načtení souboru provedena.

Name Typ Description
search

string

Vyhledávací řetězec používaný k dotazování obsahu souboru.

KnowledgeBaseFileActivityRecord

Představuje záznam aktivity při získávání souboru.

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

fileArguments

KnowledgeBaseFileActivityArguments

Argumenty souboru pro aktivnost vyhledávání.

id

integer (int32)

ID záznamu aktivity.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

knowledgeSourceName

string

Zdroj znalostí pro vyhledávací aktivitu.

queryTime

string (date-time)

Čas dotazu pro tuto aktivitu načítání.

type string:

file

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseFileReference

Představuje odkaz na dokument souboru.

Name Typ Description
activitySource

integer (int32)

ID zdrojové aktivity odkazu.

docName

string

Název 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:

file

Typ odkazu.

KnowledgeBaseImageContent

Obsah.

Name Typ Description
url

string (uri)

Adresa URL obrázku.

KnowledgeBaseIndexedOneLakeActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseIndexedOneLakeReference

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.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informace o citlivosti pro referenci.

sourceData

Zdrojová data pro referenci.

type string:

indexedOneLake

Typ odkazu.

KnowledgeBaseIndexedSharePointActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseIndexedSharePointReference

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.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informace o citlivosti pro referenci.

sourceData

Zdrojová data pro referenci.

type string:

indexedSharePoint

Typ odkazu.

KnowledgeBaseIndexedSqlActivityArguments

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

Name Typ Description
search

string

Vyhledávací řetězec používaný k dotazování indexovaného obsahu SQL.

KnowledgeBaseIndexedSqlActivityRecord

Představuje indexovaný záznam SQL retrieval aktivity.

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

Indexované SQL argumenty pro aktivitu 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:

indexedSql

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseIndexedSqlReference

Představuje referenční dokument Azure SQL.

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:

indexedSql

Typ odkazu.

KnowledgeBaseMcpServerActivityArguments

Představuje argumenty, se kterými byla aktivnost načítání MCP serveru provedena.

Name Typ Description
toolArguments

Argumenty byly předávány nástroji MCP serveru.

toolName

string

Název nástroje MCP serveru používaného pro tuto aktivitu vyhledávání.

KnowledgeBaseMcpServerActivityRecord

Představuje záznam o načítání MCP serveru.

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

knowledgeSourceName

string

Zdroj znalostí pro vyhledávací aktivitu.

mcpServerArguments

KnowledgeBaseMcpServerActivityArguments

Argumenty MCP serveru pro aktivnost získávání.

queryTime

string (date-time)

Čas dotazu pro tuto aktivitu načítání.

type string:

mcpServer

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseMcpServerReference

Představuje referenci dokumentu MCP serveru.

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 výsledku nástroje MCP server.

toolName

string

Název MCP serverového nástroje, který generoval tuto referenci.

type string:

mcpServer

Typ odkazu.

KnowledgeBaseMessage

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

Name Typ Description
content KnowledgeBaseMessageContent[]:

Obsah zprávy.

role

string

Role odezvy nástroje.

KnowledgeBaseMessageContentType

Typ obsahu zprávy.

Hodnota Description
text

Druh obsahu textové zprávy.

image

Druh obsahu obrazové zprávy.

KnowledgeBaseMessageImageContent

Typ obrazové zprávy.

Name Typ Description
image

KnowledgeBaseImageContent

Obsah obrázků.

type string:

image

Typ zprávy

KnowledgeBaseMessageTextContent

Typ textové zprávy.

Name Typ Description
text

string

Textový obsah.

type string:

text

Typ zprávy

KnowledgeBaseModelAnswerSynthesisActivityRecord

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.

modelName

string

Název modelu používaného pro aktivitu syntézy odpovědí v LLM.

outputTokens

integer (int32)

Počet výstupních tokenů pro aktivitu syntézy odpovědí LLM.

type string:

modelAnswerSynthesis

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseModelQueryPlanningActivityRecord

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.

modelName

string

Název modelu používaného pro plánování dotazů v LLM.

outputTokens

integer (int32)

Počet výstupních tokenů pro aktivitu plánování dotazů LLM.

type string:

modelQueryPlanning

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseModelWebSummarizationActivityRecord

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.

modelName

string

Název modelu používaného pro aktivitu shrnutí webu LLM.

outputTokens

integer (int32)

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

type string:

modelWebSummarization

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseReferenceType

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.

workIQ

Reference na dokument o pracovním IQ.

fabricDataAgent

Reference dokumentu Fabric Data Agent.

fabricOntology

Reference dokumentu Fabric Ontology.

mcpServer

Reference na dokument MCP serveru.

file

Odkaz na dokument.

indexedSql

Indexovaný SQL dokument.

KnowledgeBaseRemoteSharePointActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseRemoteSharePointReference

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

PurviewSensitivityLabelInfo

Informace o citlivosti pro referenci.

sourceData

Zdrojová data pro referenci.

type string:

remoteSharePoint

Typ odkazu.

webUrl

string (uri)

Adresa URL, ze které pocházejí referenční data.

KnowledgeBaseRetrievalRequest

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.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů ve výstupu.

maxOutputSize

integer (int32)

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

maxOutputSizeInTokens

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:

Konfigurace úsilí o vyhledávání a uvažování.

KnowledgeBaseRetrievalResponse

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.

responseSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informace o citlivosti pro celkovou odpověď.

KnowledgeBaseSearchIndexActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

KnowledgeBaseSearchIndexReference

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.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informace o citlivosti pro referenci.

sourceData

Zdrojová data pro referenci.

type string:

searchIndex

Typ odkazu.

KnowledgeBaseWebActivityArguments

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

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

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.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

webArguments

KnowledgeBaseWebActivityArguments

Web argumentuje pro aktivitu vyhledávání.

KnowledgeBaseWebReference

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.

KnowledgeBaseWorkIQActivityArguments

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

Name Typ Description
search

string

Vyhledávací řetězec používaný k dotazování na zdroj znalostí WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Představuje záznam aktivity vyhledávání ve WorkIQ.

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.

imageServing

ImageServingStatistics

Statistiky o službě obrazů pro tuto obnovovací aktivitu

knowledgeSourceName

string

Zdroj znalostí pro vyhledávací aktivitu.

queryTime

string (date-time)

Čas dotazu pro tuto aktivitu načítání.

type string:

workIQ

Typ záznamu aktivity.

warning

string

Varovná zpráva odhalující možné konfigurační problémy pozorované během aktivity, například dokumenty ztracené kvůli prahovému skórování, zkrácení limitu tokenů nebo podmínkám časového limitu.

workIQArguments

KnowledgeBaseWorkIQActivityArguments

WorkIQ argumenty pro aktivnost vyhledávání.

KnowledgeBaseWorkIQReference

Představuje referenci na dokument WorkIQ.

Name Typ Description
activitySource

integer (int32)

ID zdrojové aktivity odkazu.

attributions

WorkIQAttribution[]

Připisování 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:

workIQ

Typ odkazu.

KnowledgeRetrievalIntentType

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

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

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

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

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

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

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.

indexedSql

Zdroj znalostí, který získává a zpracovává data z Azure SQL Database nebo SQL Managed Instance do vyhledávacího indexu.

web

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

remoteSharePoint

Zdroj znalostí, který čte data z vzdáleného SharePointu.

workIQ

Zdroj znalostí, který čte data z pracovního IQ

file

Zdroj znalostí, který podporuje přímé nahrávání a indexování souborů.

mcpServer

Zdroj znalostí podporovaný serverem MCP (Model Context Protocol).

fabricDataAgent

Zdroj znalostí, který získává data z Fabric Data Agent.

fabricOntology

Zdroj znalostí, který získává data z ontologií Microsoft Fabric Ontology.

McpServerKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí MCP serveru

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

mcpServer

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

PurviewSensitivityLabelInfo

Informace o citlivém štítku aplikovaném na dokument

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

RemoteSharePointKnowledgeSourceParams

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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

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

Name Typ Description
name

string

Název pole.

SearchIndexKnowledgeSourceParams

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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

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.

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.

WorkIQAttribution

Informace o atribuci pro referenci WorkIQ.

Name Typ Description
seeMoreWebUrl

string (uri)

URL pro připisování.

WorkIQKnowledgeSourceParams

Specifikuje parametry běhu pro zdroj znalostí WorkIQ

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

enableImageServing

boolean

Uvádí, zda by mělo být při vyhledávání pro tento zdroj znalostí povoleno servisování obrazů. Pokud je to pravda, jsou obrázky extrahované při pojetí doručeny do modelů za nimi.

failOnError

boolean

Označuje, že celý požadavek na vyhledání by měl selhat, pokud načtení z tohoto zdroje znalostí narazí na chybu. Výchozí nastavení je „false“.

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:

workIQ

Typ zdroje znalostí.

knowledgeSourceName

string

Název indexu, na který se parametry vztahují.

maxOutputDocuments

integer (int32)

Omezuje maximální počet dokumentů vrácených z tohoto zdroje znalostí.

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.