Knowledge Retrieval - Retrieve
A Tudásbázis lekéri a releváns adatokat a háttértárakból.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2025-11-01-preview
URI-paraméterek
| Name | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A keresési szolgáltatás végpontjának URL-címe. |
|
knowledge
|
path | True |
string |
A tudásbázis neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használandó API-verzió. |
Kérelem fejléce
| Name | Kötelező | Típus | Description |
|---|---|---|---|
| Accept |
Az Elfogadás fejléce. |
||
| x-ms-query-source-authorization |
string |
A lekérdezés végrehajtásához használt felhasználót azonosító jogkivonat. Ez a jogkivonat a dokumentumokra vonatkozó biztonsági korlátozások érvényesítésére szolgál. |
|
| 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
| Name | Típus | Description |
|---|---|---|
| includeActivity |
boolean |
Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait. |
| intents | KnowledgeRetrievalIntent[]: |
A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
A tudásforrások futásidejű paramétereinek listája. |
| maxOutputSize |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxRuntimeInSeconds |
integer (int32) |
A maximális futási idő másodpercben. |
| messages |
A csevegőüzenetek stílusának listája. |
|
| outputMode |
A lekérés kimeneti konfigurációja. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
Válaszok
| Name | Típus | Description |
|---|---|---|
| 200 OK |
Sikeres visszaszerzési válasz. |
|
| Other Status Codes |
Részleges visszanyerési válasz. |
|
| Other Status Codes |
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
| Name | Description |
|---|---|
| https://search.azure.com/.default |
Példák
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Mintakérelem
POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"text": "hello world",
"type": "text"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"filterAddOn": "foo eq bar",
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"rerankerThreshold": 2.1,
"kind": "searchIndex"
}
]
}
Mintaválasz
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 10
},
{
"type": "searchIndex",
"id": 1,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "searchIndex",
"id": 2,
"knowledgeSourceName": "ks-preview-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "foo eq bar",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": [],
"semanticConfigurationName": "testconfig"
}
},
{
"type": "agenticReasoning",
"id": 3,
"retrievalReasoningEffort": {
"kind": "low"
},
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"inputTokens": 664,
"outputTokens": 1328,
"elapsedMs": 10
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
},
"rerankerScore": 3.5,
"docKey": "myDocKey1"
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
},
"rerankerScore": 2.7,
"docKey": "myDocKey2"
}
]
}
{
"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
Mintakérelem
POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview
{
"intents": [
{
"search": "foo",
"type": "semantic"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"outputMode": "extractiveData",
"knowledgeSourceParams": [
{
"filterAddOn": "foo eq bar",
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex"
}
]
}
Mintaválasz
{
"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"
}
]
}
Definíciók
| Name | Description |
|---|---|
| Accept |
Az Elfogadás fejléce. |
|
Azure |
Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
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.) |
|
Indexed |
Megadja az indexelt OneLake tudásforrás futásidejű paramétereit |
|
Indexed |
Futásidejű paramétereket ad meg egy indexelt SharePoint-tudásforráshoz |
|
Knowledge |
A tevékenységi nyilvántartás típusa. |
|
Knowledge |
Ügynöki érvelési tevékenységrekordot képvisel. |
|
Knowledge |
Az Azure Blob lekérési tevékenység argumentumait jelöli. |
|
Knowledge |
Egy Azure Blob lekérési tevékenységrekordot jelöl. |
|
Knowledge |
Egy Azure Blob Storage-dokumentumhivatkozást jelöl. |
|
Knowledge |
Az erőforrás-kezelési hiba további információi. |
|
Knowledge |
A hiba részletei. |
|
Knowledge |
Képtartalom. |
|
Knowledge |
Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott. |
|
Knowledge |
Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy indexelt OneLake dokumentumhivatkozást képvisel. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel az indexelt SharePoint lekérdezési tevékenység futott. |
|
Knowledge |
Egy indexelt SharePoint lekérési tevékenységi rekordot képvisel. |
|
Knowledge |
Egy indexelt SharePoint dokumentumhivatkozást képvisel. |
|
Knowledge |
A természetes nyelvű üzenetstílus-objektum. |
|
Knowledge |
Az üzenet tartalmának típusa. |
|
Knowledge |
Kép üzenet típusa. |
|
Knowledge |
Szöveges üzenet típusa. |
|
Knowledge |
Egy LLM-válaszszintézis tevékenységrekordot jelöl. |
|
Knowledge |
Egy LLM-lekérdezéstervezési tevékenységrekordot jelöl. |
|
Knowledge |
A hivatkozás típusa. |
|
Knowledge |
Képviseli azokat az argumentumokat, amelyekkel a távoli SharePoint-lekérési tevékenység futott. |
|
Knowledge |
Egy távoli SharePoint lekérdezési tevékenységi rekordot képvisel. |
|
Knowledge |
Távoli SharePoint-dokumentumhivatkozást jelöl. |
|
Knowledge |
A lekérési kérelem bemeneti szerződése. |
|
Knowledge |
A lekérési válasz kimeneti szerződése. |
|
Knowledge |
A keresési index lekérési tevékenységét futtató argumentumokat jelöli. |
|
Knowledge |
A keresési index lekérési tevékenységrekordját jelöli. |
|
Knowledge |
Egy Azure Search-dokumentumhivatkozást jelöl. |
|
Knowledge |
Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott. |
|
Knowledge |
Egy web-visszakeresési tevékenységi rekordot képvisel. |
|
Knowledge |
Webes dokumentumhivatkozást jelöl. |
|
Knowledge |
A használni kívánt tudásbázis-konfiguráció típusa. |
|
Knowledge |
Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel. |
|
Knowledge |
Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel. |
|
Knowledge |
Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel. |
|
Knowledge |
A lekérés kimeneti konfigurációja. |
|
Knowledge |
A visszakeresés során felhasználandó erőfeszítés mértéke. |
|
Knowledge |
Egy szemantikai lekérdezési szándék. |
|
Knowledge |
A tudásforrás fajtája. |
|
Remote |
Távoli SharePoint-tudásforrás futásidejű paramétereit adja meg |
|
Search |
Mezőreferenciát a keresési indexhez. |
|
Search |
Futásidejű paramétereket ad meg egy keresési index tudásforráshoz |
|
Share |
A SharePoint-dokumentumokra alkalmazott bizalmassági címkével kapcsolatos információk. |
|
Web |
Futásidejű paramétereket ad meg egy webes tudásforráshoz |
Accept
Az Elfogadás fejléce.
| Érték | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Futásidejű paramétereket ad meg egy Azure Blob tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| 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:
azure |
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
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hibacél. |
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.)
| Name | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
IndexedOneLakeKnowledgeSourceParams
Megadja az indexelt OneLake tudásforrás futásidejű paramétereit
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| 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:
indexed |
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. |
IndexedSharePointKnowledgeSourceParams
Futásidejű paramétereket ad meg egy indexelt SharePoint-tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| 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:
indexed |
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
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. |
| indexedSharePoint |
Indexelt SharePoint lekérdezési tevékenység. |
| indexedOneLake |
Indexelt OneLake visszakeresési tevékenység. |
| web |
Webes keresési tevékenység. |
| remoteSharePoint |
Távoli SharePoint lekérdezési tevékenység. |
| modelQueryPlanning |
LLM lekérdezés tervezési tevékenység. |
| modelAnswerSynthesis |
LLM válasz szintézis aktivitás. |
| agenticReasoning |
Ügynöki gondolkodási tevékenység. |
KnowledgeBaseAgenticReasoningActivityRecord
Ügynöki érvelési tevékenységrekordot képvisel.
| Name | Típus | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
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. |
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
| type |
string:
agentic |
A tevékenységrekord típusa. |
KnowledgeBaseAzureBlobActivityArguments
Az Azure Blob lekérési tevékenység argumentumait jelöli.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A blob tartalmának lekérdezéséhez használt keresési sztring. |
KnowledgeBaseAzureBlobActivityRecord
Egy Azure Blob lekérési tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| azureBlobArguments |
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 |
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:
azure |
A tevékenységrekord típusa. |
KnowledgeBaseAzureBlobReference
Egy Azure Blob Storage-dokumentumhivatkozást jelöl.
| Name | 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:
azure |
A hivatkozás típusa. |
KnowledgeBaseErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Name | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
KnowledgeBaseErrorDetail
A hiba részletei.
| Name | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hibacél. |
KnowledgeBaseImageContent
Képtartalom.
| Name | Típus | Description |
|---|---|---|
| url |
string (uri) |
A kép URL-címe. |
KnowledgeBaseIndexedOneLakeActivityArguments
Képviseli azokat az argumentokat, amelyekkel az indexelt OneLake-keresési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string indexelt OneLake tartalmának lekérdezésére szolgált. |
KnowledgeBaseIndexedOneLakeActivityRecord
Egy indexelt OneLake lekérdezési tevékenységi rekordot képvisel.
| Name | 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 |
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 |
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:
indexed |
A tevékenységrekord típusa. |
KnowledgeBaseIndexedOneLakeReference
Egy indexelt OneLake dokumentumhivatkozást képvisel.
| Name | 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:
indexed |
A hivatkozás típusa. |
KnowledgeBaseIndexedSharePointActivityArguments
Képviseli azokat az argumentumokat, amelyekkel az indexelt SharePoint lekérdezési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A kereső string indexelt SharePoint tartalmak lekérdezésére szolgált. |
KnowledgeBaseIndexedSharePointActivityRecord
Egy indexelt SharePoint lekérési tevékenységi rekordot képvisel.
| Name | 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 |
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. |
| indexedSharePointArguments |
Az indexelt SharePoint argumentumok a lekérdezé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:
indexed |
A tevékenységrekord típusa. |
KnowledgeBaseIndexedSharePointReference
Egy indexelt SharePoint dokumentumhivatkozást képvisel.
| Name | 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:
indexed |
A hivatkozás típusa. |
KnowledgeBaseMessage
A természetes nyelvű üzenetstílus-objektum.
| Name | Típus | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Az üzenet tartalma. |
| role |
string |
Az eszközválasz szerepe. |
KnowledgeBaseMessageContentType
Az üzenet tartalmának típusa.
| Érték | Description |
|---|---|
| text |
Szöveges üzenet tartalomtípusa. |
| image |
Képüzenet tartalma típus. |
KnowledgeBaseMessageImageContent
Kép üzenet típusa.
| Name | Típus | Description |
|---|---|---|
| image |
A kép tartalma. |
|
| type |
string:
image |
Az üzenet típusa |
KnowledgeBaseMessageTextContent
Szöveges üzenet típusa.
| Name | Típus | Description |
|---|---|---|
| text |
string |
A szöveges tartalom. |
| type |
string:
text |
Az üzenet típusa |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Egy LLM-válaszszintézis tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
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-válaszszintézis tevékenység bemeneti tokenjeinek száma. |
| outputTokens |
integer (int32) |
Az LLM-válaszszintézis tevékenység kimeneti jogkivonatainak száma. |
| type |
string:
model |
A tevékenységrekord típusa. |
KnowledgeBaseModelQueryPlanningActivityRecord
Egy LLM-lekérdezéstervezési tevékenységrekordot jelöl.
| Name | Típus | Description |
|---|---|---|
| elapsedMs |
integer (int32) |
A lekérési tevékenység eltelt ideje ezredmásodpercben. |
| error |
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-lekérdezés tervezési tevékenységének bemeneti jogkivonatainak száma. |
| outputTokens |
integer (int32) |
Az LLM-lekérdezés tervezési tevékenységének kimeneti jogkivonatainak száma. |
| type |
string:
model |
A tevékenységrekord típusa. |
KnowledgeBaseReferenceType
A hivatkozás típusa.
| Érték | Description |
|---|---|
| searchIndex |
Keress index dokumentum hivatkozást. |
| azureBlob |
Azure Blob document reference. |
| indexedSharePoint |
Indexelt SharePoint dokumentumhivatkozás. |
| indexedOneLake |
Indexelt OneLake dokumentumhivatkozás. |
| web |
Webes dokumentum hivatkozás. |
| remoteSharePoint |
Távoli SharePoint dokumentumhivatkozás. |
KnowledgeBaseRemoteSharePointActivityArguments
Képviseli azokat az argumentumokat, amelyekkel a távoli SharePoint-lekérési tevékenység futott.
| Name | Típus | Description |
|---|---|---|
| filterExpressionAddOn |
string |
A szűrő kifejezés kiegészítője a visszakeresési tevékenységhez. |
| search |
string |
A keresési string a távoli SharePoint tudásforrás lekérdezésére szolgált. |
KnowledgeBaseRemoteSharePointActivityRecord
Egy távoli SharePoint lekérdezési tevékenységi rekordot képvisel.
| Name | 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 |
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. |
| remoteSharePointArguments |
A távoli SharePoint argumentumok a lekérdezési tevékenységhez. |
|
| type |
string:
remote |
A tevékenységrekord típusa. |
KnowledgeBaseRemoteSharePointReference
Távoli SharePoint-dokumentumhivatkozást jelöl.
| Name | 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. |
| searchSensitivityLabelInfo |
Információ a SharePoint dokumentumra alkalmazott érzékenységi címkéről. |
|
| sourceData |
A hivatkozás forrásadatai. |
|
| type |
string:
remote |
A hivatkozás típusa. |
| webUrl |
string (uri) |
Az az URL, ahonnan a referenciaadatok származnak. |
KnowledgeBaseRetrievalRequest
A lekérési kérelem bemeneti szerződése.
| Name | Típus | Description |
|---|---|---|
| includeActivity |
boolean |
Azt jelzi, hogy a lekérési eredményeknek tartalmazniuk kell a tevékenység adatait. |
| intents | KnowledgeRetrievalIntent[]: |
A modelllekérdezés-tervezés nélkül végrehajtandó tervezett lekérdezések listája. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
A tudásforrások futásidejű paramétereinek listája. |
| maxOutputSize |
integer (int32) |
Korlátozza a kimenet tartalmának maximális méretét. |
| maxRuntimeInSeconds |
integer (int32) |
A maximális futási idő másodpercben. |
| messages |
A csevegőüzenetek stílusának listája. |
|
| outputMode |
A lekérés kimeneti konfigurációja. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
A visszakeresés, érvelési erőfeszítés konfigurációja. |
KnowledgeBaseRetrievalResponse
A lekérési válasz kimeneti szerződése.
| Name | Típus | Description |
|---|---|---|
| activity |
KnowledgeBaseActivityRecord[]:
|
A tevékenységrekordok az előrehaladás és a számlázási következmények nyomon követésére. |
| references | KnowledgeBaseReference[]: |
A válaszban használt lekérési adatok hivatkozásai. |
| response |
A válaszüzenetek. |
KnowledgeBaseSearchIndexActivityArguments
A keresési index lekérési tevékenységét futtató argumentumokat jelöli.
| Name | 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 |
Milyen területekre kerestek. |
|
| semanticConfigurationName |
string |
Milyen szemantikai konfigurációt használtak a keresési indexből. |
| sourceDataFields |
Milyen mezőket választottak ki a kereséshez. |
KnowledgeBaseSearchIndexActivityRecord
A keresési index lekérési tevékenységrekordját jelöli.
| Name | 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 |
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 |
A lekérési tevékenység keresési indexargumentumai. |
|
| type |
string:
search |
A tevékenységrekord típusa. |
KnowledgeBaseSearchIndexReference
Egy Azure Search-dokumentumhivatkozást jelöl.
| Name | 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:
search |
A hivatkozás típusa. |
KnowledgeBaseWebActivityArguments
Képviseli azokat az argumentokat, amelyekkel a web-visszakeresési tevékenység futott.
| Name | 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
Egy web-visszakeresési tevékenységi rekordot képvisel.
| Name | 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 |
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 |
A webes érvek a visszakeresési tevékenységre. |
KnowledgeBaseWebReference
Webes dokumentumhivatkozást jelöl.
| Name | 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
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. |
KnowledgeRetrievalLowReasoningEffort
Futtassa a tudás visszakeresését alacsony érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
low |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalMediumReasoningEffort
Futtassa a tudás visszakeresését közepes érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
medium |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalMinimalReasoningEffort
Futtassa a tudás visszakeresését minimális érvelési erőfeszítéssel.
| Name | Típus | Description |
|---|---|---|
| kind |
string:
minimal |
Az a fajta érvelési erőfeszítés. |
KnowledgeRetrievalOutputMode
A lekérés kimeneti konfigurációja.
| Érték | Description |
|---|---|
| extractiveData |
Adatok visszaadása a tudásforrásokból közvetlenül, generatív módosítás nélkül. |
| answerSynthesis |
Szintetizáljon egy választ a válasz hasznos adataira. |
KnowledgeRetrievalReasoningEffortKind
A visszakeresés során felhasználandó erőfeszítés mértéke.
| Érték | Description |
|---|---|
| minimal |
Nem végez forrásválasztást, lekérdezéstervezést vagy iteratív keresést. |
| low |
Használjon alacsony érvelést a lekérés során. |
| medium |
Használjon mérsékelt érvelést a visszakeresés során. |
KnowledgeRetrievalSemanticIntent
Egy szemantikai lekérdezési szándék.
| Name | Típus | Description |
|---|---|---|
| search |
string |
A végrehajtandó szemantikai lekérdezés |
| type |
string:
semantic |
A szándék típusa. |
KnowledgeSourceKind
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. |
| indexedSharePoint |
Egy tudásforrás, amely adatokat olvas az indexelt SharePoint-ről. |
| indexedOneLake |
Egy tudásforrás, amely adatokat olvas az indexelt OneLake-ből. |
| web |
Egy tudásforrás, amely adatokat olvas a webről. |
| remoteSharePoint |
Egy tudásforrás, amely adatokat olvas a távoli SharePoint-ról. |
RemoteSharePointKnowledgeSourceParams
Távoli SharePoint-tudásforrás futásidejű paramétereit adja meg
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| filterExpressionAddOn |
string |
A SharePoint-adatforrásra alkalmazott szűrési feltétel. Ezt meg kell adni a Kulcsszó lekérdezési nyelve szintaxisban. A rendszer a tudásforrás definíciójában megadott szűrőkifejezéssel együttesen kombinálja. |
| 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:
remote |
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. |
SearchIndexFieldReference
Mezőreferenciát a keresési indexhez.
| Name | Típus | Description |
|---|---|---|
| name |
string |
A mező neve. |
SearchIndexKnowledgeSourceParams
Futásidejű paramétereket ad meg egy keresési index tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| 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:
search |
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. |
SharePointSensitivityLabelInfo
A SharePoint-dokumentumokra alkalmazott bizalmassági címkével kapcsolatos információk.
| Name | Típus | Description |
|---|---|---|
| color |
string |
A felhasználói felület által megjelenítendő szín a címkénél, ha konfigurálva van. |
| displayName |
string |
A bizalmassági címke megjelenítendő neve. |
| isEncrypted |
boolean |
Azt jelzi, hogy a bizalmassági címke kényszeríti-e a titkosítást. |
| priority |
integer (int32) |
A bizalmassági címke alkalmazásának prioritása. |
| sensitivityLabelId |
string |
A bizalmassági címke azonosítója. |
| tooltip |
string |
A felhasználói felületen a címkéhez megjelenítendő elemleírás. |
WebKnowledgeSourceParams
Futásidejű paramétereket ad meg egy webes tudásforráshoz
| Name | Típus | Description |
|---|---|---|
| alwaysQuerySource |
boolean |
Azt jelzi, hogy ennek a tudásforrásnak meg kell kerülnie a forrás kiválasztását, és mindig le kell kérdeznie a lekéréskor. |
| 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. |