Knowledge Retrieval - Retrieve

Dienst:: Search Service

API-Version:: 2025-11-01-preview

Die KnowledgeBase ruft relevante Daten aus Sicherungsspeichern ab.

POST https:///knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2025-11-01-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
knowledgeBaseName	path	True	string	Der Name der Wissensbasis.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Typ	Beschreibung
Accept	Accept	Die Überschrift "Annehmen".
x-ms-query-source-authorization	string	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[]: KnowledgeRetrievalSemanticIntent[]	Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Eine Liste von Laufzeitparametern für die Wissensquellen.
maxOutputSize	integer (int32)	Begrenzt die maximale Größe des Inhalts in der Ausgabe.
maxRuntimeInSeconds	integer (int32)	Die maximale Laufzeit in Sekunden.
messages	KnowledgeBaseMessage[]	Eine Liste von Eingaben im Stil von Chatnachrichten.
outputMode	KnowledgeRetrievalOutputMode	Die Ausgabekonfiguration für diesen Abruf.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Die Konfiguration des Wiederholungs-Denkens.

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgeBaseRetrievalResponse	Erfolgreiche Rücknahmereaktion.
Other Status Codes	KnowledgeBaseRetrievalResponse	Partielle Entnahmereaktion.
Other Status Codes	ErrorResponse	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

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Beispielanforderung

HTTP

POST https:///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"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "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": [
          {
            "name": "*"
          }
        ],
        "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": [
          {
            "name": "*"
          }
        ],
        "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"
    }
  ]
}

Statuscode:: 206

{
  "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": [
          {
            "name": "*"
          }
        ],
        "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

Beispielanforderung

HTTP

POST https:///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"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "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": [
          {
            "name": "*"
          }
        ],
        "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"
    }
  ]
}

Statuscode:: 206

{
  "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": [
          {
            "name": "*"
          }
        ],
        "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"
    }
  ]
}

Definitionen

Name	Beschreibung
Accept	Die Überschrift "Annehmen".
AzureBlobKnowledgeSourceParams	Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
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.)
IndexedOneLakeKnowledgeSourceParams	Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an.
IndexedSharePointKnowledgeSourceParams	Gibt Laufzeitparameter für eine indizierte SharePoint-Wissensquelle an.
KnowledgeBaseActivityRecordType	Die Art der Aktivitätsaufzeichnung.
KnowledgeBaseAgenticReasoningActivityRecord	Stellt einen Aktivitätsdatensatz für agentisches Denken dar.
KnowledgeBaseAzureBlobReference	Stellt eine Azure Blob Storage-Dokumentreferenz dar.
KnowledgeBaseErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
KnowledgeBaseErrorDetail	Die Fehlerdetails.
KnowledgeBaseImageContent	Bildinhalt.
KnowledgeBaseIndexedOneLakeReference	Stellt eine indexierte OneLake-Dokumentreferenz dar.
KnowledgeBaseIndexedSharePointReference	Stellt eine indexierte SharePoint-Dokumentreferenz dar.
KnowledgeBaseMessage	Das Nachrichtenstilobjekt in natürlicher Sprache.
KnowledgeBaseMessageContentType	Die Art des Nachrichteninhalts.
KnowledgeBaseMessageImageContent	Typ der Bildnachricht.
KnowledgeBaseMessageTextContent	Art der Textnachricht.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar.
KnowledgeBaseModelQueryPlanningActivityRecord	Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar.
KnowledgeBaseReferenceType	Der Verweistyp.
KnowledgeBaseRemoteSharePointReference	Stellt eine entfernte SharePoint-Dokumentreferenz dar.
KnowledgeBaseRetrievalRequest	Der Eingabevertrag für den Abrufauftrag.
KnowledgeBaseRetrievalResponse	Der Ausgabevertrag für die Abrufantwort.
KnowledgeBaseSearchIndexReference	Stellt eine Azure Search-Dokumentreferenz dar.
KnowledgeBaseWebReference	Stellt einen Verweis auf ein Webdokument dar.
KnowledgeRetrievalIntentType	Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte.
KnowledgeRetrievalLowReasoningEffort	Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.
KnowledgeRetrievalMediumReasoningEffort	Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.
KnowledgeRetrievalMinimalReasoningEffort	Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.
KnowledgeRetrievalOutputMode	Die Ausgabekonfiguration für diesen Abruf.
KnowledgeRetrievalReasoningEffortKind	Der Aufwand, der beim Abrufen verwendet werden soll.
KnowledgeRetrievalSemanticIntent	Eine semantische Abfrageabsicht.
KnowledgeSourceKind	Die Art der Wissensquelle.
RemoteSharePointKnowledgeSourceParams	Gibt Laufzeitparameter für eine SharePoint-Remotewissensquelle an.
SearchIndexKnowledgeSourceParams	Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an
SharePointSensitivityLabelInfo	Informationen über das auf ein SharePoint-Dokument angewandte Sensitivitätsetikett.
WebKnowledgeSourceParams	Gibt Laufzeitparameter für eine Webwissensquelle an

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objekt

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.
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: azureBlob	Der Typ der Wissensquelle.
knowledgeSourceName	string	Der Name des Indexes, auf den die Parameter angewendet werden.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

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	ErrorDetail	Das Fehlerobjekt.

IndexedOneLakeKnowledgeSourceParams

Objekt

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.
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: indexedOneLake	Der Typ der Wissensquelle.
knowledgeSourceName	string	Der Name des Indexes, auf den die Parameter angewendet werden.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

IndexedSharePointKnowledgeSourceParams

Objekt

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.
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: indexedSharePoint	Der Typ der Wissensquelle.
knowledgeSourceName	string	Der Name des Indexes, auf den die Parameter angewendet werden.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

KnowledgeBaseActivityRecordType

Enumeration

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.
remoteSharePoint	Remote-SharePoint-Abrufaktivität.
modelQueryPlanning	LLM-Abfrageplanungsaktivität.
modelAnswerSynthesis	LLM-Antwort-Synthese-Aktivität.
agenticReasoning	Agentisches Denken.

KnowledgeBaseAgenticReasoningActivityRecord

Objekt

Stellt einen Aktivitätsdatensatz für agentisches Denken dar.

Name	Typ	Beschreibung
elapsedMs	integer (int32)	Die verstrichene Zeit in Millisekunden für die Abrufaktivität.
error	KnowledgeBaseErrorDetail	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.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Die Konfiguration des Wiederholungs-Denkens.
type	string: agenticReasoning	Der Typ des Aktivitätsdatensatzes.

KnowledgeBaseAzureBlobReference

Objekt

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.
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: azureBlob	Der Typ der Referenz.

KnowledgeBaseErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info		Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

KnowledgeBaseErrorDetail

Objekt

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	KnowledgeBaseErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

KnowledgeBaseImageContent

Objekt

Bildinhalt.

Name	Typ	Beschreibung
url	string (uri)	Die URL des Bildes.

KnowledgeBaseIndexedOneLakeReference

Objekt

Stellt eine indexierte OneLake-Dokumentreferenz dar.

Name	Typ	Beschreibung
activitySource	integer (int32)	Die Quellaktivitäts-ID für die Referenz.
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: indexedOneLake	Der Typ der Referenz.

KnowledgeBaseIndexedSharePointReference

Objekt

Stellt eine indexierte SharePoint-Dokumentreferenz dar.

Name	Typ	Beschreibung
activitySource	integer (int32)	Die Quellaktivitäts-ID für die Referenz.
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: indexedSharePoint	Der Typ der Referenz.

KnowledgeBaseMessage

Objekt

Das Nachrichtenstilobjekt in natürlicher Sprache.

Name	Typ	Beschreibung
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Der Inhalt der Nachricht.
role	string	Die Rolle der Tool-Reaktion.

KnowledgeBaseMessageContentType

Enumeration

Die Art des Nachrichteninhalts.

Wert	Beschreibung
text	Art des Inhalts von Textnachrichten.
image	Art des Inhalts von Bildnachrichten.

KnowledgeBaseMessageImageContent

Objekt

Typ der Bildnachricht.

Name	Typ	Beschreibung
image	KnowledgeBaseImageContent	Der Bildinhalt.
type	string: image	Der Typ der Nachricht

KnowledgeBaseMessageTextContent

Objekt

Art der Textnachricht.

Name	Typ	Beschreibung
text	string	Der Textinhalt.
type	string: text	Der Typ der Nachricht

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objekt

Stellt einen Aktivitätsdatensatz für die LLM-Antwortsynthese dar.

Name	Typ	Beschreibung
elapsedMs	integer (int32)	Die verstrichene Zeit in Millisekunden für die Abrufaktivität.
error	KnowledgeBaseErrorDetail	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.
outputTokens	integer (int32)	Die Anzahl der Ausgabetoken für die LLM-Antwortsyntheseaktivität.
type	string: modelAnswerSynthesis	Der Typ des Aktivitätsdatensatzes.

KnowledgeBaseModelQueryPlanningActivityRecord

Objekt

Stellt einen Datensatz für die LLM-Abfrageplanungsaktivität dar.

Name	Typ	Beschreibung
elapsedMs	integer (int32)	Die verstrichene Zeit in Millisekunden für die Abrufaktivität.
error	KnowledgeBaseErrorDetail	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.
outputTokens	integer (int32)	Die Anzahl der Ausgabetoken für die LLM-Abfrageplanungsaktivität.
type	string: modelQueryPlanning	Der Typ des Aktivitätsdatensatzes.

KnowledgeBaseReferenceType

Enumeration

Der Verweistyp.

Wert	Beschreibung
searchIndex	Suche nach Dokumentenreferenz im Index.
azureBlob	Azure Blob document reference.
indexedSharePoint	Indexierte SharePoint-Dokumentreferenz.
indexedOneLake	Indexierte OneLake-Dokumentreferenz.
web	Web-Dokumentenreferenz.
remoteSharePoint	Remote-SharePoint-Dokumentreferenz.

KnowledgeBaseRemoteSharePointReference

Objekt

Stellt eine entfernte SharePoint-Dokumentreferenz 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.
searchSensitivityLabelInfo	SharePointSensitivityLabelInfo	Informationen über das Sensitivitätslabel, das auf das SharePoint-Dokument angewendet wurde.
sourceData		Die Quelldaten für die Referenz.
type	string: remoteSharePoint	Der Typ der Referenz.
webUrl	string (uri)	Die URL, von der die Referenzdaten stammen.

KnowledgeBaseRetrievalRequest

Objekt

Der Eingabevertrag für den Abrufauftrag.

Name	Typ	Beschreibung
includeActivity	boolean	Gibt an, dass die Abrufergebnisse Aktivitätsinformationen enthalten sollten.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Eine Liste der beabsichtigten Abfragen, die ohne Modellabfrageplanung ausgeführt werden sollen.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Eine Liste von Laufzeitparametern für die Wissensquellen.
maxOutputSize	integer (int32)	Begrenzt die maximale Größe des Inhalts in der Ausgabe.
maxRuntimeInSeconds	integer (int32)	Die maximale Laufzeit in Sekunden.
messages	KnowledgeBaseMessage[]	Eine Liste von Eingaben im Stil von Chatnachrichten.
outputMode	KnowledgeRetrievalOutputMode	Die Ausgabekonfiguration für diesen Abruf.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Die Konfiguration des Wiederholungs-Denkens.

KnowledgeBaseRetrievalResponse

Objekt

Der Ausgabevertrag für die Abrufantwort.

Name	Typ	Beschreibung
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[]	Die Aktivitätsdatensätze zur Nachverfolgung des Fortschritts und der Auswirkungen auf die Abrechnung.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Die Referenzen für die Abrufdaten, die in der Antwort verwendet werden.
response	KnowledgeBaseMessage[]	Die Antwortnachrichten.

KnowledgeBaseSearchIndexReference

Objekt

Stellt eine Azure Search-Dokumentreferenz dar.

Name	Typ	Beschreibung
activitySource	integer (int32)	Die Quellaktivitäts-ID für die Referenz.
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: searchIndex	Der Typ der Referenz.

KnowledgeBaseWebReference

Objekt

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

Enumeration

Die Art von Wissensdatenbank-Konfiguration, die man verwenden sollte.

Wert	Beschreibung
semantic	Eine semantische Abfrageabsicht in natürlicher Sprache.

KnowledgeRetrievalLowReasoningEffort

Objekt

Führen Sie das Abrufen von Wissen mit geringem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: low	Die Art des Argumentationsaufwands.

KnowledgeRetrievalMediumReasoningEffort

Objekt

Führen Sie den Wissensabruf mit mittlerem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: medium	Die Art des Argumentationsaufwands.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.

Name	Typ	Beschreibung
kind	string: minimal	Die Art des Argumentationsaufwands.

KnowledgeRetrievalOutputMode

Enumeration

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

Enumeration

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

Objekt

Eine semantische Abfrageabsicht.

Name	Typ	Beschreibung
search	string	Die semantische Abfrage, die ausgeführt werden soll
type	string: semantic	Der Typ der Absicht.

KnowledgeSourceKind

Enumeration

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.
web	Eine Wissensquelle, die Daten aus dem Web liest.
remoteSharePoint	Eine Wissensquelle, die Daten von entferntem SharePoint liest.

RemoteSharePointKnowledgeSourceParams

Objekt

Gibt Laufzeitparameter für eine SharePoint-Remotewissensquelle an.

Name	Typ	Beschreibung
alwaysQuerySource	boolean	Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll.
filterExpressionAddOn	string	Eine Filterbedingung, die auf die SharePoint-Datenquelle angewendet wird. Sie muss in der Syntax der Keyword Query Language angegeben werden. Sie wird als Konjunktion mit dem in der Knowledge Source Definition angegebenen Filterausdruck kombiniert.
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: remoteSharePoint	Der Typ der Wissensquelle.
knowledgeSourceName	string	Der Name des Indexes, auf den die Parameter angewendet werden.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

SearchIndexKnowledgeSourceParams

Objekt

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.
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: searchIndex	Der Typ der Wissensquelle.
knowledgeSourceName	string	Der Name des Indexes, auf den die Parameter angewendet werden.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

SharePointSensitivityLabelInfo

Objekt

Informationen über das auf ein SharePoint-Dokument angewandte Sensitivitätsetikett.

Name	Typ	Beschreibung
color	string	Die Farbe, die auf der Benutzeroberfläche für die Bezeichnung angezeigt werden soll, sofern konfiguriert.
displayName	string	Der Anzeigename für das Empfindlichkeitslabel.
isEncrypted	boolean	Gibt an, ob die Vertraulichkeitsbezeichnung die Verschlüsselung erzwingt.
priority	integer (int32)	Die Priorität, in der die Vertraulichkeitsbezeichnung angewendet wird.
sensitivityLabelId	string	Die ID der Vertraulichkeitsbezeichnung.
tooltip	string	Die QuickInfo, die für die Bezeichnung in einer Benutzeroberfläche angezeigt werden soll.

WebKnowledgeSourceParams

Objekt

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.
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.
rerankerThreshold	number (float)	Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden.

Freigeben über

Knowledge Retrieval - Retrieve

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

api-key

OAuth2Auth

Bereiche

Beispiele

KnowledgeBaseRetrieve

Beispielanforderung

Beispiel für eine Antwort

KnowledgeBaseRetrieveWithIntents

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Accept

AzureBlobKnowledgeSourceParams

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IndexedOneLakeKnowledgeSourceParams

IndexedSharePointKnowledgeSourceParams

KnowledgeBaseActivityRecordType

KnowledgeBaseAgenticReasoningActivityRecord

KnowledgeBaseAzureBlobReference

KnowledgeBaseErrorAdditionalInfo

KnowledgeBaseErrorDetail

KnowledgeBaseImageContent

KnowledgeBaseIndexedOneLakeReference

KnowledgeBaseIndexedSharePointReference

KnowledgeBaseMessage

KnowledgeBaseMessageContentType

KnowledgeBaseMessageImageContent

KnowledgeBaseMessageTextContent

KnowledgeBaseModelAnswerSynthesisActivityRecord

KnowledgeBaseModelQueryPlanningActivityRecord

KnowledgeBaseReferenceType

KnowledgeBaseRemoteSharePointReference

KnowledgeBaseRetrievalRequest

KnowledgeBaseRetrievalResponse

KnowledgeBaseSearchIndexReference

KnowledgeBaseWebReference

KnowledgeRetrievalIntentType

KnowledgeRetrievalLowReasoningEffort

KnowledgeRetrievalMediumReasoningEffort

KnowledgeRetrievalMinimalReasoningEffort

KnowledgeRetrievalOutputMode

KnowledgeRetrievalReasoningEffortKind

KnowledgeRetrievalSemanticIntent

KnowledgeSourceKind

RemoteSharePointKnowledgeSourceParams

SearchIndexKnowledgeSourceParams

SharePointSensitivityLabelInfo

WebKnowledgeSourceParams