Knowledge Retrieval - Retrieve
Die KnowledgeBase ruft relevante Daten aus Sicherungsspeichern ab.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-10-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
knowledge
|
path | True |
string |
Der Name der Wissensbasis. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| Accept |
Der Accept-Header. |
||
| x-ms-query-source-authorization |
string (password) |
Token, das den Benutzer identifiziert, für den die Abfrage ausgeführt wird. Dieses Token wird verwendet, um Sicherheitseinschränkungen für Dokumente durchzusetzen. |
|
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
Anforderungstext
| Name | Typ | Beschreibung |
|---|---|---|
| includeActivity |
boolean |
Gibt an, dass die Abrufergebnisse Aktivitätsinformationen enthalten sollten. |
| intents | KnowledgeRetrievalIntent[]: |
Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
Eine Liste von Laufzeitparametern für die Wissensquellen. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der Dokumente im Output. |
| maxOutputSizeInTokens |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxRuntimeInSeconds |
integer (int32) |
Die maximale Laufzeit in Sekunden. |
| messages |
Eine Liste von Eingaben im Stil von Chatnachrichten. |
|
| outputMode |
Die Ausgabekonfiguration für diesen Abruf. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Die Konfiguration des Wiederholungs-Denkens. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Erfolgreiche Rücknahmereaktion. |
|
| Other Status Codes |
Partielle Entnahmereaktion. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
api-key
Typ:
apiKey
In:
header
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://search.azure.com/.default |
Beispiele
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputDocuments": 5,
"maxOutputSizeInTokens": 100000,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-stable-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex",
"alwaysQuerySource": true,
"filterAddOn": "foo eq bar"
}
]
}
Beispiel für eine Antwort
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-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": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "modelQueryPlanning",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world two",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveWithIntents
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01
{
"intents": [
{
"type": "semantic",
"search": "foo"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSizeInTokens": 100000,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-stable-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex",
"alwaysQuerySource": true,
"filterAddOn": "foo eq bar"
}
]
}
Beispiel für eine Antwort
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"response": [
{
"content": [
{
"type": "text",
"text": "[{...}]"
}
]
}
],
"activity": [
{
"type": "searchIndex",
"id": 0,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "foo",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Der Accept-Header. |
|
Azure |
Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an |
|
Error |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Error |
Die Fehlerdetails. |
|
Error |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
|
File |
Spezifiziert Laufzeitparameter für eine Datei-Wissensquelle |
|
Indexed |
Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an. |
|
Indexed |
Gibt Laufzeitparameter für eine indizierte SharePoint-Wissensquelle an. |
|
Indexed |
Spezifiziert Laufzeitparameter für eine indexierte SQL-Wissensquelle |
|
Knowledge |
Repräsentiert das Modell, das für eine Knowledge Base-LLM-Aktivität verwendet wird, einschließlich des Modellnamens und der Bereitstellungskennung. |
|
Knowledge |
Die Art der Aktivitätsaufzeichnung. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für agentisches Denken dar. |
|
Knowledge |
Stellt die Argumente dar, mit denen die Azure Blob-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar. |
|
Knowledge |
Stellt eine Azure Blob Storage-Dokumentreferenz dar. |
|
Knowledge |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Knowledge |
Die Fehlerdetails. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Dateiabrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Datensatz für die Dateiabrufaktivität dar. |
|
Knowledge |
Stellt eine Dateidokumentreferenz dar. |
|
Knowledge |
Bildinhalt. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte OneLake-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar. |
|
Knowledge |
Stellt eine indexierte OneLake-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte SharePoint-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten SharePoint-Abrufaktivitätseintrag dar. |
|
Knowledge |
Stellt eine indexierte SharePoint-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die indexierte SQL-Abrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen indexierten SQL-Abrufaktivitätseintrag dar. |
|
Knowledge |
Stellt eine Azure SQL-Dokumentreferenz dar. |
|
Knowledge |
Das Nachrichtenstilobjekt in natürlicher Sprache. |
|
Knowledge |
Die Art des Nachrichteninhalts. |
|
Knowledge |
Typ der Bildnachricht. |
|
Knowledge |
Art der Textnachricht. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar. |
|
Knowledge |
Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar. |
|
Knowledge |
Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag. |
|
Knowledge |
Der Typ des Bezugs. |
|
Knowledge |
Der Eingabevertrag für den Abrufauftrag. |
|
Knowledge |
Der Ausgabevertrag für die Abrufantwort. |
|
Knowledge |
Stellt die Argumente dar, mit denen die Aktivität zum Abrufen des Suchindex ausgeführt wurde. |
|
Knowledge |
Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar. |
|
Knowledge |
Stellt eine Azure Search-Dokumentreferenz dar. |
|
Knowledge |
Repräsentiert die Argumente, mit denen die Webabrufaktivität ausgeführt wurde. |
|
Knowledge |
Stellt einen Datensatz für Webabrufaktivitäten dar. |
|
Knowledge |
Stellt einen Verweis auf ein Webdokument dar. |
|
Knowledge |
Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte. |
|
Knowledge |
Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch. |
|
Knowledge |
Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch. |
|
Knowledge |
Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch. |
|
Knowledge |
Die Ausgabekonfiguration für diesen Abruf. |
|
Knowledge |
Der Aufwand, der beim Abrufen verwendet werden soll. |
|
Knowledge |
Eine semantische Abfrageabsicht. |
|
Knowledge |
Die Art der Wissensquelle. |
|
Search |
Feldreferenz für einen Suchindex. |
|
Search |
Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an |
|
Web |
Gibt Laufzeitparameter für eine Webwissensquelle an |
Accept
Der Accept-Header.
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
azure |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
ErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
ErrorResponse
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
FileKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Datei-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
file |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
IndexedOneLakeKnowledgeSourceParams
Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
IndexedSharePointKnowledgeSourceParams
Gibt Laufzeitparameter für eine indizierte SharePoint-Wissensquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
IndexedSqlKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine indexierte SQL-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
KnowledgeBaseActivityRecordModel
Repräsentiert das Modell, das für eine Knowledge Base-LLM-Aktivität verwendet wird, einschließlich des Modellnamens und der Bereitstellungskennung.
| Name | Typ | Beschreibung |
|---|---|---|
| deploymentId |
string |
Die Bereitstellungskennung des für die Aktivität verwendeten Modells. |
| modelName |
string |
Der Name des Modells, das für die Aktivität verwendet wurde. |
KnowledgeBaseActivityRecordType
Die Art der Aktivitätsaufzeichnung.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Suche nach Index-Abrufaktivität. |
| azureBlob |
Azure Blob Retrieval Activity. |
| indexedSharePoint |
Indexierte SharePoint-Abrufaktivität. |
| indexedOneLake |
Indexierte OneLake-Rückholaktivität. |
| web |
Web-Abruf-Aktivität. |
| file |
Dateiabruf-Aktivität. |
| indexedSql |
Indexierte SQL-Abrufaktivität. |
| modelQueryPlanning |
LLM-Abfrageplanungsaktivität. |
| modelAnswerSynthesis |
LLM-Antwort-Synthese-Aktivität. |
| modelWebSummarization |
LLM-Webzusammenfassungsaktivität. |
| agenticReasoning |
Agentisches Denken. |
KnowledgeBaseAgenticReasoningActivityRecord
Stellt einen Aktivitätsdatensatz für agentisches Denken dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| reasoningTokens |
integer (int32) |
Die Anzahl der Eingabetoken für agentisches Denken. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
agentic |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseAzureBlobActivityArguments
Stellt die Argumente dar, mit denen die Azure Blob-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenfolge, die zum Abfragen von Blobinhalten verwendet wird. |
KnowledgeBaseAzureBlobActivityRecord
Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| azureBlobArguments |
Das azure-Blob argumentiert für die Abrufaktivität. |
|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
azure |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseAzureBlobReference
Stellt eine Azure Blob Storage-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| blobUrl |
string |
Die Blob-URL für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
azure |
Der Typ der Referenz. |
KnowledgeBaseErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
KnowledgeBaseErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
KnowledgeBaseFileActivityArguments
Repräsentiert die Argumente, mit denen die Dateiabrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchfolge, die zur Abfrage von Dateiinhalten verwendet wird. |
KnowledgeBaseFileActivityRecord
Stellt einen Datensatz für die Dateiabrufaktivität dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| fileArguments |
Die Datei-Argumente für die Abrufaktivität. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
file |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseFileReference
Stellt eine Dateidokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docName |
string |
Der Dokumentname für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
file |
Der Typ der Referenz. |
KnowledgeBaseImageContent
Bildinhalt.
| Name | Typ | Beschreibung |
|---|---|---|
| url |
string (uri) |
Die URL des Bildes. |
KnowledgeBaseIndexedOneLakeActivityArguments
Repräsentiert die Argumente, mit denen die indexierte OneLake-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Der Suchstring zur Abfrage von OneLake-Inhalten wurde indexiert. |
KnowledgeBaseIndexedOneLakeActivityRecord
Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| indexedOneLakeArguments |
Die indexierten OneLake-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedOneLakeReference
Stellt eine indexierte OneLake-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseIndexedSharePointActivityArguments
Repräsentiert die Argumente, mit denen die indexierte SharePoint-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenkette, die zur Abfrage indexierter SharePoint-Inhalte verwendet wird. |
KnowledgeBaseIndexedSharePointActivityRecord
Stellt einen indexierten SharePoint-Abrufaktivitätseintrag dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| indexedSharePointArguments |
Die indexierten SharePoint-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedSharePointReference
Stellt eine indexierte SharePoint-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseIndexedSqlActivityArguments
Repräsentiert die Argumente, mit denen die indexierte SQL-Abrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die Suchzeichenkette, die zur Abfrage indexierter SQL-Inhalte verwendet wird. |
KnowledgeBaseIndexedSqlActivityRecord
Stellt einen indexierten SQL-Abrufaktivitätseintrag dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| indexedSqlArguments |
Die indizierten SQL-Argumente für die Abrufaktivität. |
|
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
indexed |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseIndexedSqlReference
Stellt eine Azure SQL-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docUrl |
string |
Die Dokument-URL für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
indexed |
Der Typ der Referenz. |
KnowledgeBaseMessage
Das Nachrichtenstilobjekt in natürlicher Sprache.
| Name | Typ | Beschreibung |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Der Inhalt der Nachricht. |
| role |
string |
Die Rolle der Tool-Reaktion. |
KnowledgeBaseMessageContentType
Die Art des Nachrichteninhalts.
| Wert | Beschreibung |
|---|---|
| text |
Art des Inhalts von Textnachrichten. |
| image |
Art des Inhalts von Bildnachrichten. |
KnowledgeBaseMessageImageContent
Typ der Bildnachricht.
| Name | Typ | Beschreibung |
|---|---|---|
| image |
Der Bildinhalt. |
|
| type |
string:
image |
Der Typ der Nachricht |
KnowledgeBaseMessageTextContent
Art der Textnachricht.
| Name | Typ | Beschreibung |
|---|---|---|
| text |
string |
Der Textinhalt. |
| type |
string:
text |
Der Typ der Nachricht |
KnowledgeBaseModelAnswerSynthesisActivityRecord
Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Antwortsyntheseaktivität. |
| model |
Das Modell, das für die LLM-Antwortsynthese-Aktivität verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Antwortsyntheseaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseModelQueryPlanningActivityRecord
Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Abfrageplanungsaktivität. |
| model |
Das Modell, das für die LLM-Abfrageplanung verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Abfrageplanungsaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseModelWebSummarizationActivityRecord
Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| inputTokens |
integer (int32) |
Die Anzahl der Eingabetoken für die LLM-Webzusammenfassungsaktivität. |
| model |
Das Modell, das für die LLM-Webzusammenfassungsaktivität verwendet wird. |
|
| outputTokens |
integer (int32) |
Die Anzahl der Ausgabetoken für die LLM-Webzusammenfassungs-Aktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
model |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseReferenceType
Der Typ des Bezugs.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Suche nach Dokumentenreferenz im Index. |
| azureBlob |
Azure Blob-Dokumentreferenz. |
| indexedSharePoint |
Indexierte SharePoint-Dokumentreferenz. |
| indexedOneLake |
Indexierte OneLake-Dokumentreferenz. |
| web |
Web-Dokumentenreferenz. |
| file |
Dokumentenreferenz einreichen. |
| indexedSql |
Indexierte SQL-Dokumentreferenz. |
KnowledgeBaseRetrievalRequest
Der Eingabevertrag für den Abrufauftrag.
| Name | Typ | Beschreibung |
|---|---|---|
| includeActivity |
boolean |
Gibt an, dass die Abrufergebnisse Aktivitätsinformationen enthalten sollten. |
| intents | KnowledgeRetrievalIntent[]: |
Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
Eine Liste von Laufzeitparametern für die Wissensquellen. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der Dokumente im Output. |
| maxOutputSizeInTokens |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| maxRuntimeInSeconds |
integer (int32) |
Die maximale Laufzeit in Sekunden. |
| messages |
Eine Liste von Eingaben im Stil von Chatnachrichten. |
|
| outputMode |
Die Ausgabekonfiguration für diesen Abruf. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
Die Konfiguration des Wiederholungs-Denkens. |
KnowledgeBaseRetrievalResponse
Der Ausgabevertrag für die Abrufantwort.
| Name | Typ | Beschreibung |
|---|---|---|
| activity |
KnowledgeBaseActivityRecord[]:
|
Die Aktivitätsdatensätze zur Nachverfolgung des Fortschritts und der Auswirkungen auf die Abrechnung. |
| references | KnowledgeBaseReference[]: |
Die Referenzen für die Abrufdaten, die in der Antwort verwendet werden. |
| response |
Die Antwortnachrichten. |
KnowledgeBaseSearchIndexActivityArguments
Stellt die Argumente dar, mit denen die Aktivität zum Abrufen des Suchindex ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| filter |
string |
Die Filterzeichenfolge. |
| search |
string |
Die Suchzeichenfolge, die zum Abfragen des Suchindex verwendet wird. |
| searchFields |
Gegen welche Felder wurde gesucht. |
|
| semanticConfigurationName |
string |
Welche semantische Konfiguration wurde aus dem Suchindex verwendet? |
| sourceDataFields |
Welche Felder wurden für die Suche ausgewählt? |
KnowledgeBaseSearchIndexActivityRecord
Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| searchIndexArguments |
Die Suchindexargumente für die Abrufaktivität. |
|
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
search |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
KnowledgeBaseSearchIndexReference
Stellt eine Azure Search-Dokumentreferenz dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| citationUrl |
string (uri) |
Eine Search-eigene URL, die auf das Backing-Dokument für diese Referenz verweist und als Zitationsziel verwendet werden kann. |
| docKey |
string |
Der Dokumentschlüssel für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| type |
string:
search |
Der Typ der Referenz. |
KnowledgeBaseWebActivityArguments
Repräsentiert die Argumente, mit denen die Webabrufaktivität ausgeführt wurde.
| Name | Typ | Beschreibung |
|---|---|---|
| count |
integer (int32) |
Die Anzahl der Webergebnisse wurde zurückgegeben. |
| freshness |
string |
Die Frische für die Apportationsaktivität. |
| language |
string |
Die Sprache für die Abrufaktivität. |
| market |
string |
Der Markt für die Abrufaktivität. |
| search |
string |
Die Suchsequenz, die zur Abfrage des Webs verwendet wird. |
KnowledgeBaseWebActivityRecord
Stellt einen Datensatz für Webabrufaktivitäten dar.
| Name | Typ | Beschreibung |
|---|---|---|
| completedAt |
string (date-time) |
Die Zeit, zu der die Aktivität abgeschlossen wurde. |
| count |
integer (int32) |
Die Anzahl der abgerufenen Dokumente, die ausreichend relevant waren, um den Reranker-Schwellenwert zu überschreiten. |
| elapsedMs |
integer (int32) |
Die verstrichene Zeit in Millisekunden für die Abrufaktivität. |
| error |
Das Fehler-Detail, das erklärt, warum die Operation fehlgeschlagen ist. Diese Eigenschaft ist nur dann enthalten, wenn die Aktivität nicht erfolgreich ist. |
|
| id |
integer (int32) |
Die ID des Aktivitätsdatensatzes. |
| knowledgeSourceName |
string |
Die Wissensquelle für die Abrufaktivität. |
| queryTime |
string (date-time) |
Die Abfragezeit für diese Abrufaktivität. |
| startedAt |
string (date-time) |
Die Zeit, zu der die Aktivität begann. |
| type |
string:
web |
Der Typ des Aktivitätsdatensatzes. |
| warning |
string |
Eine Warnmeldung, die potenzielle Konfigurationsprobleme aufzeigt, die während der Aktivität beobachtet wurden, wie Dokumente, die durch Score-Thresholding, Token-Limit-Kürzung oder Timeout-Bedingungen verloren gehen. |
| webArguments |
Die Webargumente für die Abrufaktivität. |
KnowledgeBaseWebReference
Stellt einen Verweis auf ein Webdokument dar.
| Name | Typ | Beschreibung |
|---|---|---|
| activitySource |
integer (int32) |
Die Quellaktivitäts-ID für die Referenz. |
| id |
string |
Die ID der Referenz. |
| rerankerScore |
number (float) |
Die Reranker-Bewertung für die Dokumentreferenz. |
| sourceData |
Die Quelldaten für die Referenz. |
|
| title |
string |
Der Titel des Webdokuments. |
| type |
string:
web |
Der Typ der Referenz. |
| url |
string (uri) |
Die URL, von der die Referenzdaten stammen. |
KnowledgeRetrievalIntentType
Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte.
| Wert | Beschreibung |
|---|---|
| semantic |
Eine semantische Abfrageabsicht in natürlicher Sprache. |
KnowledgeRetrievalLowReasoningEffort
Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
low |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalMediumReasoningEffort
Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
medium |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalMinimalReasoningEffort
Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
minimal |
Die Art des Argumentationsaufwands. |
KnowledgeRetrievalOutputMode
Die Ausgabekonfiguration für diesen Abruf.
| Wert | Beschreibung |
|---|---|
| extractiveData |
Geben Sie Daten aus den Wissensquellen direkt und ohne generative Änderung zurück. |
| answerSynthesis |
Synthetisieren Sie eine Antwort für die Antwortnutzlast. |
KnowledgeRetrievalReasoningEffortKind
Der Aufwand, der beim Abrufen verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| minimal |
Führt keine Quellenauswahl, Abfrageplanung oder iterative Suche durch. |
| low |
Verwenden Sie beim Abrufen eine geringe Argumentation. |
| medium |
Verwenden Sie beim Abrufen ein moderates Maß an Argumentation. |
KnowledgeRetrievalSemanticIntent
Eine semantische Abfrageabsicht.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die semantische Abfrage, die ausgeführt werden soll |
| type |
string:
semantic |
Der Typ der Absicht. |
KnowledgeSourceKind
Die Art der Wissensquelle.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Eine Wissensquelle, die Daten aus einem Suchindex liest. |
| azureBlob |
Eine Wissensquelle, die Daten aus Azure Blob Storage liest und in einem Suchindex erfasst. |
| indexedSharePoint |
Eine Wissensquelle, die Daten von indexiertem SharePoint liest. |
| indexedOneLake |
Eine Wissensquelle, die Daten von indexierten OneLake ausliest. |
| indexedSql |
Eine Wissensquelle, die Daten aus der Azure SQL-Datenbank oder der SQL Managed Instance in einen Search Index abruft und aufnimmt. |
| web |
Eine Wissensquelle, die Daten aus dem Web liest. |
| file |
Eine Wissensquelle, die das direkte Uploaden und Indexieren von Dateien unterstützt. |
SearchIndexFieldReference
Feldreferenz für einen Suchindex.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name des Felds. |
SearchIndexKnowledgeSourceParams
Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| filterAddOn |
string |
Eine Filterbedingung, die auf den Index angewendet wird (z. B. "State eq VA"). |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
search |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
WebKnowledgeSourceParams
Gibt Laufzeitparameter für eine Webwissensquelle an
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| count |
integer (int32) |
Die Anzahl der Webergebnisse, die zurückgegeben werden müssen. |
| failOnError |
boolean |
Zeigt an, dass die gesamte Abrufanfrage fehlschlagen sollte, wenn die Abruf aus dieser Wissensquelle auf einen Fehler stößt. Der Standardwert ist „false“. |
| freshness |
string |
Die Frische der Webergebnisse. |
| includeReferenceSourceData |
boolean |
Gibt an, ob Verweise die strukturierten Daten, die während des Abrufs abgerufen wurden, in ihre Nutzlast aufnehmen sollen. |
| includeReferences |
boolean |
Gibt an, ob Verweise für Daten enthalten sein sollen, die aus dieser Quelle abgerufen werden. |
| kind |
string:
web |
Der Typ der Wissensquelle. |
| knowledgeSourceName |
string |
Der Name des Indexes, auf den die Parameter angewendet werden. |
| language |
string |
Die Sprache des Webs ergibt sich. |
| market |
string |
Der Markt des Internets ist Ergebnis. |
| maxOutputDocuments |
integer (int32) |
Begrenzt die maximale Anzahl der aus dieser Wissensquelle zurückgegebenen Dokumente. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |