Knowledge Retrieval - Retrieve

Dienst:
Search Service
API-Version:
2026-04-01

Die KnowledgeBase ruft relevante Daten aus Sicherungsspeichern ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

Die Endpunkt-URL des Suchdiensts.
knowledgeBaseName
 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

Accept

Die Überschrift "Annehmen".
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[]:

Eine Liste von Laufzeitparametern für die Wissensquellen.
maxOutputSizeInTokens

integer (int32)

Begrenzt die maximale Größe des Inhalts in der Ausgabe.
maxRuntimeInSeconds

integer (int32)

Die maximale Laufzeit in Sekunden.

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

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

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-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Statuscode:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Beispielanforderung

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Statuscode:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

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

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
IndexedOneLakeKnowledgeSourceParams

Gibt Laufzeitparameter für eine indizierte OneLake-Wissensquelle an.
KnowledgeBaseActivityRecordType

Die Art der Aktivitätsaufzeichnung.
KnowledgeBaseAgenticReasoningActivityRecord

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

Stellt die Argumente dar, mit denen die Azure Blob-Abrufaktivität ausgeführt wurde.
KnowledgeBaseAzureBlobActivityRecord

Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar.
KnowledgeBaseAzureBlobReference

Stellt eine Azure Blob Storage-Dokumentreferenz dar.
KnowledgeBaseErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
KnowledgeBaseErrorDetail

Die Fehlerdetails.
KnowledgeBaseImageContent

Bildinhalt.
KnowledgeBaseIndexedOneLakeActivityArguments

Repräsentiert die Argumente, mit denen die indexierte OneLake-Abrufaktivität ausgeführt wurde.
KnowledgeBaseIndexedOneLakeActivityRecord

Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar.
KnowledgeBaseIndexedOneLakeReference

Stellt eine indexierte OneLake-Dokumentreferenz dar.
KnowledgeBaseMessage

Das Nachrichtenstilobjekt in natürlicher Sprache.
KnowledgeBaseMessageContentType

Die Art des Nachrichteninhalts.
KnowledgeBaseMessageImageContent

Typ der Bildnachricht.
KnowledgeBaseMessageTextContent

Art der Textnachricht.
KnowledgeBaseModelWebSummarizationActivityRecord

Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag.
KnowledgeBaseReferenceType

Der Verweistyp.
KnowledgeBaseRetrievalRequest

Der Eingabevertrag für den Abrufauftrag.
KnowledgeBaseRetrievalResponse

Der Ausgabevertrag für die Abrufantwort.
KnowledgeBaseSearchIndexActivityArguments

Stellt die Argumente dar, mit denen die Aktivität zum Abrufen des Suchindex ausgeführt wurde.
KnowledgeBaseSearchIndexActivityRecord

Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar.
KnowledgeBaseSearchIndexReference

Stellt eine Azure Search-Dokumentreferenz dar.
KnowledgeBaseWebActivityArguments

Repräsentiert die Argumente, mit denen die Webabrufaktivität ausgeführt wurde.
KnowledgeBaseWebActivityRecord

Stellt einen Datensatz für Webabrufaktivitäten dar.
KnowledgeBaseWebReference

Stellt einen Verweis auf ein Webdokument dar.
KnowledgeRetrievalIntentType

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

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.
KnowledgeRetrievalReasoningEffortKind

Der Aufwand, der beim Abrufen verwendet werden soll.
KnowledgeRetrievalSemanticIntent

Eine semantische Abfrageabsicht.
KnowledgeSourceKind

Die Art der Wissensquelle.
SearchIndexFieldReference

Feldreferenz für einen Suchindex.
SearchIndexKnowledgeSourceParams

Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an
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
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

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen 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
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.

KnowledgeBaseActivityRecordType

Enumeration

Die Art der Aktivitätsaufzeichnung.

Wert Beschreibung
searchIndex

Suche nach Index-Abrufaktivität.
azureBlob

Azure Blob Retrieval Activity.
indexedOneLake

Indexierte OneLake-Rückholaktivität.
web

Web-Abruf-Aktivität.
modelWebSummarization

LLM-Webzusammenfassungsaktivitä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:

KnowledgeRetrievalMinimalReasoningEffort

Die Konfiguration des Wiederholungs-Denkens.
type string:

agenticReasoning

Der Typ des Aktivitätsdatensatzes.

KnowledgeBaseAzureBlobActivityArguments

Objekt

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

Objekt

Stellt einen Azure-Blob-Abrufaktivitätsdatensatz dar.

Name Typ Beschreibung
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Das azure-Blob argumentiert für die Abrufaktivität.
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

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

string

Die Wissensquelle für die Abrufaktivität.
queryTime

string (date-time)

Die Abfragezeit für diese Abrufaktivität.
type string:

azureBlob

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.

KnowledgeBaseIndexedOneLakeActivityArguments

Objekt

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

Objekt

Stellt einen indexierten OneLake-Abrufaktivitätsrekord dar.

Name Typ Beschreibung
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

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

KnowledgeBaseIndexedOneLakeActivityArguments

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.
type string:

indexedOneLake

Der Typ des Aktivitätsdatensatzes.

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.

KnowledgeBaseMessage

Objekt

Das Nachrichtenstilobjekt in natürlicher Sprache.

Name Typ Beschreibung
content KnowledgeBaseMessageContent[]:

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

KnowledgeBaseModelWebSummarizationActivityRecord

Objekt

Repräsentiert einen LLM-Webzusammenfassungsaktivitätseintrag.

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-Webzusammenfassungsaktivität.
outputTokens

integer (int32)

Die Anzahl der Ausgabetoken für die LLM-Webzusammenfassungs-Aktivität.
type string:

modelWebSummarization

Der Typ des Aktivitätsdatensatzes.

KnowledgeBaseReferenceType

Enumeration

Der Verweistyp.

Wert Beschreibung
searchIndex

Suche nach Dokumentenreferenz im Index.
azureBlob

Azure Blob document reference.
indexedOneLake

Indexierte OneLake-Dokumentreferenz.
web

Web-Dokumentenreferenz.

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[]:

Eine Liste von Laufzeitparametern für die Wissensquellen.
maxOutputSizeInTokens

integer (int32)

Begrenzt die maximale Größe des Inhalts in der Ausgabe.
maxRuntimeInSeconds

integer (int32)

Die maximale Laufzeit in Sekunden.

KnowledgeBaseRetrievalResponse

Objekt

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

KnowledgeBaseMessage[]

Die Antwortnachrichten.

KnowledgeBaseSearchIndexActivityArguments

Objekt

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

SearchIndexFieldReference[]

Gegen welche Felder wurde gesucht.
semanticConfigurationName

string

Welche semantische Konfiguration wurde aus dem Suchindex verwendet?
sourceDataFields

SearchIndexFieldReference[]

Welche Felder wurden für die Suche ausgewählt?

KnowledgeBaseSearchIndexActivityRecord

Objekt

Stellt einen Aktivitätsdatensatz für den Suchindexabruf dar.

Name Typ Beschreibung
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

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

string

Die Wissensquelle für die Abrufaktivität.
queryTime

string (date-time)

Die Abfragezeit für diese Abrufaktivität.
searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Die Suchindexargumente für die Abrufaktivität.
type string:

searchIndex

Der Typ des Aktivitätsdatensatzes.

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.

KnowledgeBaseWebActivityArguments

Objekt

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

Objekt

Stellt einen Datensatz für Webabrufaktivitäten dar.

Name Typ Beschreibung
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

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

string

Die Wissensquelle für die Abrufaktivität.
queryTime

string (date-time)

Die Abfragezeit für diese Abrufaktivität.
type string:

web

Der Typ des Aktivitätsdatensatzes.
webArguments

KnowledgeBaseWebActivityArguments

Die Webargumente für die Abrufaktivität.

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.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Führen Sie den Wissensabruf mit minimalem Argumentationsaufwand durch.

Name Typ Beschreibung
kind string:

minimal

Die Art des Argumentationsaufwands.

KnowledgeRetrievalReasoningEffortKind

Enumeration

Der Aufwand, der beim Abrufen verwendet werden soll.

Wert Beschreibung
minimal

Führt keine Quellenauswahl, Abfrageplanung oder iterative Suche durch.

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

Eine Wissensquelle, die Daten von indexierten OneLake ausliest.
web

Eine Wissensquelle, die Daten aus dem Web liest.

SearchIndexFieldReference

Objekt

Feldreferenz für einen Suchindex.

Name Typ Beschreibung
name

string

Der Name des Felds.

SearchIndexKnowledgeSourceParams

Objekt

Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an

Name Typ Beschreibung
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.

WebKnowledgeSourceParams

Objekt

Gibt Laufzeitparameter für eine Webwissensquelle an

Name Typ Beschreibung
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.