Knowledge Retrieval - Retrieve

Szolgáltatás:: Search Service

API-verzió:: 2026-04-01

A Tudásbázis lekéri a releváns adatokat a háttértárakból.

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

URI-paraméterek

Név	In	Kötelező	Típus	Description
endpoint	path	True	string (uri)	A keresési szolgáltatás végpontjának URL-címe.
knowledgeBaseName	path	True	string	A tudásbázis neve.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Név	Kötelező	Típus	Description
Accept		Accept	Az Elfogadás fejléce.
x-ms-client-request-id		string (uuid)	A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója.

Kérelem törzse

Név	Típus	Description
includeActivity	boolean	Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	A tudásforrások futásidejű paramétereinek listája.
maxOutputSizeInTokens	integer (int32)	Korlátozza a kimenet tartalmának maximális méretét.
maxRuntimeInSeconds	integer (int32)	A maximális futási idő másodpercben.

Válaszok

Név	Típus	Description
200 OK	KnowledgeBaseRetrievalResponse	Sikeres visszaszerzési válasz.
Other Status Codes	KnowledgeBaseRetrievalResponse	Részleges visszanyerési válasz.
Other Status Codes	ErrorResponse	Váratlan hibaválasz.

Biztonság

api-key

Típus: apiKey
In: header

OAuth2Auth

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Hatókörök

Név	Description
https://search.azure.com/.default

Példák

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
    }
  ]
}

Állapotkó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

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
    }
  ]
}

Állapotkó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"
    }
  ]
}

Definíciók

Név	Description
Accept	Az Elfogadás fejléce.
AzureBlobKnowledgeSourceParams	Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
IndexedOneLakeKnowledgeSourceParams	Megadja az indexelt OneLake tudásforrás futásidejű paramétereit
KnowledgeBaseActivityRecordType	A tevékenységi nyilvántartás típusa.
KnowledgeBaseAgenticReasoningActivityRecord	Ügynöki érvelési tevékenységrekordot képvisel.
KnowledgeBaseAzureBlobActivityArguments	Az Azure Blob lekérési tevékenység argumentumait jelöli.
KnowledgeBaseAzureBlobActivityRecord	Egy Azure Blob lekérési tevékenységrekordot jelöl.
KnowledgeBaseAzureBlobReference	Egy Azure Blob Storage-dokumentumhivatkozást jelöl.
KnowledgeBaseErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
KnowledgeBaseErrorDetail	A hiba részletei.
KnowledgeBaseImageContent	Képtartalom.
KnowledgeBaseIndexedOneLakeActivityArguments	Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott.
KnowledgeBaseIndexedOneLakeActivityRecord	Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel.
KnowledgeBaseIndexedOneLakeReference	Egy indexelt OneLake dokumentumhivatkozást képvisel.
KnowledgeBaseMessage	A természetes nyelvű üzenetstílus-objektum.
KnowledgeBaseMessageContentType	Az üzenet tartalmának típusa.
KnowledgeBaseMessageImageContent	Kép üzenet típusa.
KnowledgeBaseMessageTextContent	Szöveges üzenet típusa.
KnowledgeBaseModelWebSummarizationActivityRecord	Egy LLM webes összefoglaló tevékenységi rekordot képvisel.
KnowledgeBaseReferenceType	A hivatkozás típusa.
KnowledgeBaseRetrievalRequest	A lekérési kérelem bemeneti szerződése.
KnowledgeBaseRetrievalResponse	A lekérési válasz kimeneti szerződése.
KnowledgeBaseSearchIndexActivityArguments	A keresési index lekérési tevékenységét futtató argumentumokat jelöli.
KnowledgeBaseSearchIndexActivityRecord	A keresési index lekérési tevékenységrekordját jelöli.
KnowledgeBaseSearchIndexReference	Egy Azure Search-dokumentumhivatkozást jelöl.
KnowledgeBaseWebActivityArguments	Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott.
KnowledgeBaseWebActivityRecord	Egy web-visszakeresési tevékenységi rekordot képvisel.
KnowledgeBaseWebReference	Webes dokumentumhivatkozást jelöl.
KnowledgeRetrievalIntentType	A használni kívánt tudásbázis-konfiguráció típusa.
KnowledgeRetrievalSemanticIntent	Egy szemantikai lekérdezési szándék.
KnowledgeSourceKind	A tudásforrás fajtája.
SearchIndexFieldReference	Mezőreferenciát a keresési indexhez.
SearchIndexKnowledgeSourceParams	Futásidejű paramétereket ad meg egy keresési index tudásforráshoz
WebKnowledgeSourceParams	Futásidejű paramétereket ad meg egy webes tudásforráshoz

Accept

Felsorolás

Az Elfogadás fejléce.

Érték	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Tárgy

Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz

Név	Típus	Description
includeReferenceSourceData	boolean	Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban.
includeReferences	boolean	Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni.
kind	string: azureBlob	A tudásforrás típusa.
knowledgeSourceName	string	Annak az indexnek a neve, amelyre a paraméterek vonatkoznak.
rerankerThreshold	number (float)	Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban.

ErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

ErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

ErrorResponse

Tárgy

Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)

Név	Típus	Description
error	ErrorDetail	A hibaobjektum.

IndexedOneLakeKnowledgeSourceParams

Tárgy

Megadja az indexelt OneLake tudásforrás futásidejű paramétereit

Név	Típus	Description
includeReferenceSourceData	boolean	Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban.
includeReferences	boolean	Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni.
kind	string: indexedOneLake	A tudásforrás típusa.
knowledgeSourceName	string	Annak az indexnek a neve, amelyre a paraméterek vonatkoznak.
rerankerThreshold	number (float)	Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban.

KnowledgeBaseActivityRecordType

Felsorolás

A tevékenységi nyilvántartás típusa.

Érték	Description
searchIndex	Keresési index keresési tevékenység.
azureBlob	Azure Blob retrieval activity.
indexedOneLake	Indexelt OneLake visszakeresési tevékenység.
web	Webes keresési tevékenység.
modelWebSummarization	LLM webes összefoglaló tevékenység.
agenticReasoning	Ügynöki gondolkodási tevékenység.

KnowledgeBaseAgenticReasoningActivityRecord

Tárgy

Ügynöki érvelési tevékenységrekordot képvisel.

Név	Típus	Description
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
reasoningTokens	integer (int32)	Az ügynöki érveléshez szükséges bemeneti tokenek száma.
type	string: agenticReasoning	A tevékenységrekord típusa.

KnowledgeBaseAzureBlobActivityArguments

Tárgy

Az Azure Blob lekérési tevékenység argumentumait jelöli.

Név	Típus	Description
search	string	A blob tartalmának lekérdezéséhez használt keresési sztring.

KnowledgeBaseAzureBlobActivityRecord

Tárgy

Egy Azure Blob lekérési tevékenységrekordot jelöl.

Név	Típus	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	A lekérési tevékenység Azure Blob-argumentumai.
count	integer (int32)	A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket.
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
knowledgeSourceName	string	A lekérési tevékenység tudásforrása.
queryTime	string (date-time)	A lekérési tevékenység lekérdezési ideje.
type	string: azureBlob	A tevékenységrekord típusa.

KnowledgeBaseAzureBlobReference

Tárgy

Egy Azure Blob Storage-dokumentumhivatkozást jelöl.

Név	Típus	Description
activitySource	integer (int32)	A hivatkozás forrástevékenység-azonosítója.
blobUrl	string	A referencia blob URL-címe.
id	string	A hivatkozás azonosítója.
rerankerScore	number (float)	A dokumentumhivatkozás reranker pontszáma.
sourceData		A hivatkozás forrásadatai.
type	string: azureBlob	A hivatkozás típusa.

KnowledgeBaseErrorAdditionalInfo

Tárgy

Az erőforrás-kezelési hiba további információi.

Név	Típus	Description
info		A további információk.
type	string	A további információtípus.

KnowledgeBaseErrorDetail

Tárgy

A hiba részletei.

Név	Típus	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	KnowledgeBaseErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hiba célpontja.

KnowledgeBaseImageContent

Tárgy

Képtartalom.

Név	Típus	Description
url	string (uri)	A kép URL-címe.

KnowledgeBaseIndexedOneLakeActivityArguments

Tárgy

Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott.

Név	Típus	Description
search	string	A kereső string indexelt OneLake tartalmának lekérdezésére szolgált.

KnowledgeBaseIndexedOneLakeActivityRecord

Tárgy

Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel.

Név	Típus	Description
count	integer (int32)	A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket.
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Az indexelt OneLake argumentumok a visszakeresési tevékenységhez.
knowledgeSourceName	string	A lekérési tevékenység tudásforrása.
queryTime	string (date-time)	A lekérési tevékenység lekérdezési ideje.
type	string: indexedOneLake	A tevékenységrekord típusa.

KnowledgeBaseIndexedOneLakeReference

Tárgy

Egy indexelt OneLake dokumentumhivatkozást képvisel.

Név	Típus	Description
activitySource	integer (int32)	A hivatkozás forrástevékenység-azonosítója.
docUrl	string	A hivatkozás dokumentumának URL-címe.
id	string	A hivatkozás azonosítója.
rerankerScore	number (float)	A dokumentumhivatkozás reranker pontszáma.
sourceData		A hivatkozás forrásadatai.
type	string: indexedOneLake	A hivatkozás típusa.

KnowledgeBaseMessage

Tárgy

A természetes nyelvű üzenetstílus-objektum.

Név	Típus	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Az üzenet tartalma.
role	string	Az eszközválasz szerepe.

KnowledgeBaseMessageContentType

Felsorolás

Az üzenet tartalmának típusa.

Érték	Description
text	Szöveges üzenet tartalomtípusa.
image	Képüzenet tartalma típus.

KnowledgeBaseMessageImageContent

Tárgy

Kép üzenet típusa.

Név	Típus	Description
image	KnowledgeBaseImageContent	A kép tartalma.
type	string: image	Az üzenet típusa

KnowledgeBaseMessageTextContent

Tárgy

Szöveges üzenet típusa.

Név	Típus	Description
text	string	A szöveges tartalom.
type	string: text	Az üzenet típusa

KnowledgeBaseModelWebSummarizationActivityRecord

Tárgy

Egy LLM webes összefoglaló tevékenységi rekordot képvisel.

Név	Típus	Description
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
inputTokens	integer (int32)	Az LLM webes összefoglaló tevékenységhez bemeneti tokenek száma.
outputTokens	integer (int32)	Az LLM webes összefoglaló tevékenységhez tartozó kimeneti tokenek száma.
type	string: modelWebSummarization	A tevékenységrekord típusa.

KnowledgeBaseReferenceType

Felsorolás

A hivatkozás típusa.

Érték	Description
searchIndex	Keress index dokumentum hivatkozást.
azureBlob	Azure Blob document reference.
indexedOneLake	Indexelt OneLake dokumentumhivatkozás.
web	Webes dokumentum hivatkozás.

KnowledgeBaseRetrievalRequest

Tárgy

A lekérési kérelem bemeneti szerződése.

Név	Típus	Description
includeActivity	boolean	Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	A tudásforrások futásidejű paramétereinek listája.
maxOutputSizeInTokens	integer (int32)	Korlátozza a kimenet tartalmának maximális méretét.
maxRuntimeInSeconds	integer (int32)	A maximális futási idő másodpercben.

KnowledgeBaseRetrievalResponse

Tárgy

A lekérési válasz kimeneti szerződése.

Név	Típus	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	A tevékenységrekordok az előrehaladás és a számlázási következmények nyomon követésére.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	A válaszban használt lekérési adatok hivatkozásai.
response	KnowledgeBaseMessage[]	A válaszüzenetek.

KnowledgeBaseSearchIndexActivityArguments

Tárgy

A keresési index lekérési tevékenységét futtató argumentumokat jelöli.

Név	Típus	Description
filter	string	A szűrősztring.
search	string	A keresési index lekérdezéséhez használt keresési sztring.
searchFields	SearchIndexFieldReference[]	Milyen területekre kerestek.
semanticConfigurationName	string	Milyen szemantikai konfigurációt használtak a keresési indexből.
sourceDataFields	SearchIndexFieldReference[]	Milyen mezőket választottak ki a kereséshez.

KnowledgeBaseSearchIndexActivityRecord

Tárgy

A keresési index lekérési tevékenységrekordját jelöli.

Név	Típus	Description
count	integer (int32)	A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket.
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
knowledgeSourceName	string	A lekérési tevékenység tudásforrása.
queryTime	string (date-time)	A lekérési tevékenység lekérdezési ideje.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	A lekérési tevékenység keresési indexargumentumai.
type	string: searchIndex	A tevékenységrekord típusa.

KnowledgeBaseSearchIndexReference

Tárgy

Egy Azure Search-dokumentumhivatkozást jelöl.

Név	Típus	Description
activitySource	integer (int32)	A hivatkozás forrástevékenység-azonosítója.
docKey	string	A hivatkozás dokumentumkulcsa.
id	string	A hivatkozás azonosítója.
rerankerScore	number (float)	A dokumentumhivatkozás reranker pontszáma.
sourceData		A hivatkozás forrásadatai.
type	string: searchIndex	A hivatkozás típusa.

KnowledgeBaseWebActivityArguments

Tárgy

Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott.

Név	Típus	Description
count	integer (int32)	A visszanyert webes eredmények száma.
freshness	string	A frissesség a visszaszerzési tevékenységhez.
language	string	A visszahívási tevékenység nyelve.
market	string	A visszanyerési tevékenység piaca.
search	string	A keresőlánc, amelyet a weben lekérdezésre használtak.

KnowledgeBaseWebActivityRecord

Tárgy

Egy web-visszakeresési tevékenységi rekordot képvisel.

Név	Típus	Description
count	integer (int32)	A visszakeresett dokumentumok száma, amelyek kellően relevánsak voltak ahhoz, hogy átlépjék a reranker küszöbértéket.
elapsedMs	integer (int32)	A lekérési tevékenység eltelt ideje ezredmásodpercben.
error	KnowledgeBaseErrorDetail	A hiba részletei, amelyek megmagyarázzák, hogy miért nem sikerült a művelet. Ez a tulajdonság csak akkor szerepel, ha a tevékenység nem sikeres.
id	integer (int32)	A tevékenységrekord azonosítója.
knowledgeSourceName	string	A lekérési tevékenység tudásforrása.
queryTime	string (date-time)	A lekérési tevékenység lekérdezési ideje.
type	string: web	A tevékenységrekord típusa.
webArguments	KnowledgeBaseWebActivityArguments	A webes érvek a visszakeresési tevékenységre.

KnowledgeBaseWebReference

Tárgy

Webes dokumentumhivatkozást jelöl.

Név	Típus	Description
activitySource	integer (int32)	A hivatkozás forrástevékenység-azonosítója.
id	string	A hivatkozás azonosítója.
rerankerScore	number (float)	A dokumentumhivatkozás reranker pontszáma.
sourceData		A hivatkozás forrásadatai.
title	string	A webes dokumentum címe.
type	string: web	A hivatkozás típusa.
url	string (uri)	Az az URL, ahonnan a referenciaadatok származnak.

KnowledgeRetrievalIntentType

Felsorolás

A használni kívánt tudásbázis-konfiguráció típusa.

Érték	Description
semantic	Természetes nyelvi szemantikai lekérdezési szándék.

KnowledgeRetrievalSemanticIntent

Tárgy

Egy szemantikai lekérdezési szándék.

Név	Típus	Description
search	string	A végrehajtandó szemantikai lekérdezés
type	string: semantic	A szándék típusa.

KnowledgeSourceKind

Felsorolás

A tudásforrás fajtája.

Érték	Description
searchIndex	Olyan tudásforrás, amely adatokat olvas be egy keresési indexből.
azureBlob	Olyan tudásforrás, amely adatokat olvas és tölt be az Azure Blob Storage-ból egy keresési indexbe.
indexedOneLake	Egy tudásforrás, amely adatokat olvas az indexelt OneLake-ből.
web	Egy tudásforrás, amely adatokat olvas a webről.

SearchIndexFieldReference

Tárgy

Mezőreferenciát a keresési indexhez.

Név	Típus	Description
name	string	A mező neve.

SearchIndexKnowledgeSourceParams

Tárgy

Futásidejű paramétereket ad meg egy keresési index tudásforráshoz

Név	Típus	Description
filterAddOn	string	Az indexre alkalmazott szűrési feltétel (pl. "State eq VA").
includeReferenceSourceData	boolean	Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban.
includeReferences	boolean	Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni.
kind	string: searchIndex	A tudásforrás típusa.
knowledgeSourceName	string	Annak az indexnek a neve, amelyre a paraméterek vonatkoznak.
rerankerThreshold	number (float)	Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban.

WebKnowledgeSourceParams

Tárgy

Futásidejű paramétereket ad meg egy webes tudásforráshoz

Név	Típus	Description
count	integer (int32)	A visszaadandó webes találatok száma.
freshness	string	A webes eredmények frissessége.
includeReferenceSourceData	boolean	Azt jelzi, hogy a hivatkozásoknak tartalmazniuk kell-e a lekérés során kapott strukturált adatokat a hasznos adatokban.
includeReferences	boolean	Azt jelzi, hogy a forrásból beolvasott adatokhoz kell-e hivatkozásokat is belefoglalni.
kind	string: web	A tudásforrás típusa.
knowledgeSourceName	string	Annak az indexnek a neve, amelyre a paraméterek vonatkoznak.
language	string	A webes eredmények nyelve.
market	string	A webes eredmények piaca.
rerankerThreshold	number (float)	Az újrarangsoroló küszöbértéke, amelyet minden lekért dokumentumnak meg kell felelnie ahhoz, hogy szerepeljen a válaszban.