Knowledge Retrieval - Retrieve Stream
Ruft relevante Daten aus dem Backup ab, speichert und streamt Fortschritt und Ergebnisse als servergesendete Ereignisse.
Verarbeiten Sie die Antwort inkrementell mithilfe von servergesendetem Ereignis-Framing. Jedes Ereignis enthält einen Ereignisnamen und eine JSON-kodierte Datenladung. Der Stream endet entweder mit einem Event response.completed oder einem Ereignis error . OpenAPI 2.0 stellt den Antwortkörper als Zeichenkette dar, sodass generierte Clients die Rohantwort ohne typisiertes Ereignisparsen offenlegen können. Deserialisieren Sie den vollständigen Antwortkörper nicht als ein einziges JSON-Dokument.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?_overload=retrieveStream&api-version=2026-11-01-preview
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 | True |
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-query-work-iq-source-authorization |
string (password) |
Benutzer-Assertions-Token für eine kundeneigene Entra-App-Registrierung, die auf einer Work IQ-Wissensquelle konfiguriert ist. Wird für die On-Be-of-Authentifizierung der Work IQ API verwendet. |
|
| 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. |
| maxOutputSize |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| 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. |
| toolName |
string |
Das auszuwählende Werkzeug. Für KB-weite Abrufe weglassen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
string |
Die Anforderung ist erfolgreich. Media Types: "text/event-stream", "application/json" |
| Other Status Codes |
Unerwartete Fehlerantwort. Media Types: "text/event-stream", "application/json" |
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
KnowledgeBaseRetrieveStream
Beispielanforderung
POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?_overload=retrieveStream&api-version=2026-11-01-preview
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSize": 100000,
"maxOutputDocuments": 50,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-preview-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"alwaysQuerySource": false,
"neverQuerySource": false,
"failOnError": false,
"rerankerThreshold": 2.1,
"resultsProcessing": "rerank",
"kind": "searchIndex",
"filterAddOn": "foo eq bar",
"queryHintOverrides": {
"filters": [
{
"field": "country",
"fieldValues": [
"United States",
"Japan",
"France",
"Germany"
],
"filterInstructions": "Country associated with the document."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Prefer documents matching the user's locale.",
"field": "language",
"fieldValues": [
"en-US",
"ja-JP",
"fr-FR",
"de-DE"
],
"boost": 1.5
}
]
},
"topicGraph": {
"kind": "diverse",
"diversityFactor": 0.1
}
}
],
"toolName": "product-search"
}
Beispiel für eine Antwort
"event: retrieval.started\ndata: {\"requestId\":\"00000000-0000-0000-0000-000000000000\",\"knowledgeBaseName\":\"base-preview-test\",\"outputMode\":\"answerSynthesis\",\"reasoningEffort\":{\"kind\":\"low\"}}\n\nevent: activity.started\ndata: {\"id\":0,\"type\":\"modelQueryPlanning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelQueryPlanning\",\"id\":0,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":1,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":2,\"type\":\"searchIndex\",\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"knowledgeSourceName\":\"ks-preview-test\"}\n\nevent: activity.completed\ndata: {\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}}\n\nevent: activity.started\ndata: {\"id\":3,\"type\":\"modelAnswerSynthesis\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}}\n\nevent: activity.started\ndata: {\"id\":4,\"type\":\"agenticReasoning\",\"startedAt\":\"2025-01-01T00:08:45.045Z\"}\n\nevent: activity.completed\ndata: {\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}\n\nevent: answer.completed\ndata: {\"messageIndex\":0,\"message\":{\"content\":[{\"type\":\"text\",\"text\":\"[{...}]\"}]}}\n\nevent: references.completed\ndata: [{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]\n\nevent: response.completed\ndata: {\"statusCode\":200,\"response\":{\"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,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"searchIndex\",\"id\":1,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"searchIndex\",\"id\":2,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"knowledgeSourceName\":\"ks-preview-test\",\"queryTime\":\"2025-01-01T00:08:45.045Z\",\"count\":2,\"elapsedMs\":1234,\"searchIndexArguments\":{\"search\":\"hello world two\",\"filter\":\"((category eq 'news') and ((id ne null) and (foo eq bar))) and (Key eq 'myDocKey1')\",\"semanticConfigurationName\":\"testconfig\",\"queryType\":\"simple\",\"sourceDataFields\":[{\"name\":\"category\"},{\"name\":\"description\"},{\"name\":\"ownerId\"},{\"name\":\"id\"}],\"searchFields\":[]},\"queryHintProcessing\":{\"generatedFilter\":\"Key eq 'myDocKey1'\"}},{\"type\":\"modelAnswerSynthesis\",\"id\":3,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"inputTokens\":11,\"outputTokens\":22,\"elapsedMs\":1234,\"model\":{\"modelName\":\"gpt-4o\",\"deploymentId\":\"gpt-4o-deployment\"}},{\"type\":\"agenticReasoning\",\"id\":4,\"startedAt\":\"2025-01-01T00:08:45.045Z\",\"completedAt\":\"2025-01-01T00:08:46.279Z\",\"reasoningTokens\":78,\"retrievalReasoningEffort\":{\"kind\":\"low\"},\"logicalReasoningEffort\":{\"kind\":\"low\"}}],\"references\":[{\"type\":\"searchIndex\",\"id\":\"83dd7d40\",\"activitySource\":1,\"rerankerScore\":4,\"docKey\":\"myDocKey1\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey1\",\"title\":\"high_doc\",\"content\":\"hello world\"}},{\"type\":\"searchIndex\",\"id\":\"83dd7d41\",\"activitySource\":1,\"rerankerScore\":3.9,\"docKey\":\"myDocKey2\",\"citationUrl\":\"https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-11-01-preview&allowUnsafeKeys=true\",\"sourceData\":{\"id\":\"myDocKey2\",\"title\":\"low_doc\",\"content\":\"goodbye world\"}}]}}\n\n"
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Der Accept-Header. |
|
Agent |
Auswahl- und Zählgrenzen für hydratisierte Quelldokumente, die durch Wissensabruf zurückgegeben werden. |
|
Agent |
Graphspezifische Überschreitungen für eine graphfähige Azure Blob-Wissensquelle während des Abrufs. |
|
Agent |
Quelldokument-Hydratationsrichtlinie für Wissensabruf-Graphenergebnisse. |
|
Azure |
Gibt Laufzeitparameter für eine Azure Blob-Wissensquelle an |
|
Balanced |
Verbindet reine Vektorähnlichkeit mit diversitätsbewusstem Retrieval. Empfohlene Standardeinstellung, um Vielfalt mit Relevanz auszubalancieren. |
|
Diverse |
Verwendet Themengraph-Diversitätsabruf. |
|
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.) |
|
Fabric |
Spezifiziert Laufzeitparameter für eine Fabric Data Agent-Wissensquelle |
|
Fabric |
Spezifiziert Laufzeitparameter für eine Fabric-Ontologie-Wissensquelle |
|
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 |
Bildinhalt. |
|
Knowledge |
Das Nachrichtenstilobjekt in natürlicher Sprache. |
|
Knowledge |
Die Art des Nachrichteninhalts. |
|
Knowledge |
Typ der Bildnachricht. |
|
Knowledge |
Art der Textnachricht. |
|
Knowledge |
Der Eingabevertrag für den Abrufauftrag. |
|
Knowledge |
Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services. |
|
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 |
Quelldokument-Verhalten für graphbasierte Wissensabrufe. |
|
Knowledge |
Die Art der Wissensquelle. |
|
Knowledge |
Kontrolliert, ob die Ergebnisse einer Wissensquelle neu bewertet werden. |
|
Mcp |
Spezifiziert Laufzeitparameter für eine MCP-Server-Wissensquelle |
|
None |
Verwendet normale Vektorsuche ohne Themengraph-Diversitätsabruf. |
|
Remote |
Gibt Laufzeitparameter für eine SharePoint-Remotewissensquelle an. |
|
Search |
Die Art von Boost-Hinweis für eine Suchindex-Informationsquelle. |
|
Search |
Ein Hinweis, der Dokumente basierend auf einem Feldwert verbessert. |
|
Search |
Ein Hinweis, der ein Feld und umfassende Grounding-Werte identifiziert, die der Abfrageplaner beim Erstellen eines Filters verwenden kann. |
|
Search |
Konfiguriert die automatische Auflösung der Erdungswerte eines Filterhints anhand der Zielindex-Facetten. |
|
Search |
Ein Hinweis, der Dokumente basierend auf einem mehrsprachigen Ausdruck verbessert. |
|
Search |
Gibt Laufzeitparameter für eine Wissensquelle für Suchindex an |
|
Search |
Hinweise, die die Abfrageplanung zu nützlichen Filtern und Verbesserungen für eine Suchindex-Wissensquelle führen. |
|
Vector |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
|
Web |
Gibt Laufzeitparameter für eine Webwissensquelle an |
|
Work |
Spezifiziert Laufzeitparameter für eine WorkIQ-Wissensquelle |
Accept
Der Accept-Header.
| Wert | Beschreibung |
|---|---|
| text/event-stream |
AgentRuntimeGraphHydrateDocumentsParams
Auswahl- und Zählgrenzen für hydratisierte Quelldokumente, die durch Wissensabruf zurückgegeben werden.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| select |
string |
Mit Komma getrennte abrufbare Quellfelder einzubeziehen. |
|
| top |
integer (int32) minimum: 1maximum: 100 |
50 |
Maximal hydrierte Dokumente zurückzugeben. Standardmäßig 50; dies ist unabhängig von der Anzahl der Graphzeilen. |
AgentRuntimeGraphParams
Graphspezifische Überschreitungen für eine graphfähige Azure Blob-Wissensquelle während des Abrufs.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| includeQuery |
boolean |
False |
Enthalten Sie generierte GQL in graphSearchArguments.gql. Ausgelassen oder falsch wird kein generierter Abfragetext offengelegt. |
| provenance |
Steuert auch, ob Quelldokumente, die Graphergebnisse unterstützen, zurückgegeben werden. |
AgentRuntimeGraphProvenanceParams
Quelldokument-Hydratationsrichtlinie für Wissensabruf-Graphenergebnisse.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| hydrateDocuments |
Optionen für das Quelldokument; nur gültig, wenn die Art hydratisiert ist. |
||
| kind | none |
Ob der Graphabruf nur Graphzeilen zurückgibt oder zugleich Quelldokumente hydratisiert. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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“. |
| graphParameters |
Optionen für Diagrammabfrage und Quelldokument-Hydratation für eine graphenfähige Quelle. |
|
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
|
| topicGraph | VectorQueryTopicGraph: |
Überschreibt für diesen Abruf das gespeicherte topicGraph der Wissensquelle. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
BalancedVectorQueryTopicGraph
Verbindet reine Vektorähnlichkeit mit diversitätsbewusstem Retrieval. Empfohlene Standardeinstellung, um Vielfalt mit Relevanz auszubalancieren.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
balanced |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Die Mindestanzahl von Vektorkandidaten, die vor der Themagraphenstichprobenaufnahme abgerufen werden müssen. Der Standardwert ist 1.000. |
DiverseVectorQueryTopicGraph
Verwendet Themengraph-Diversitätsabruf.
| Name | Typ | Beschreibung |
|---|---|---|
| diversityFactor |
number (float) minimum: 0maximum: 1 |
Der Diversitätsfaktor, der für den Themengraphen-Diversitätsabruf verwendet wird. Wenn ausgelassen, wird die Standardeinstellung für das Thema-Graphenprofil verwendet. |
| kind |
string:
diverse |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Die Mindestanzahl von Vektorkandidaten, die vor der Themagraphenstichprobenaufnahme abgerufen werden müssen. Der Standardwert ist 1.000. |
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. |
FabricDataAgentKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Fabric Data Agent-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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:
fabric |
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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
FabricOntologyKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine Fabric-Ontologie-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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:
fabric |
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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
KnowledgeBaseImageContent
Bildinhalt.
| Name | Typ | Beschreibung |
|---|---|---|
| url |
string (uri) |
Die URL des Bildes. |
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 |
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. |
| maxOutputSize |
integer (int32) |
Begrenzt die maximale Größe des Inhalts in der Ausgabe. |
| 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. |
| toolName |
string |
Das auszuwählende Werkzeug. Für KB-weite Abrufe weglassen. |
KnowledgeRetrievalAutoReasoningEffort
Wählen Sie automatisch den Schlussaufwand während des Abrufs aus. Der Service setzt jede Anfrage auf die günstigste Stufe und eskaliert nur so weit, wie nötig, bis zur maximal verfügbaren Stufe des Services.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
auto |
Die Art des Argumentationsaufwands. |
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. |
| auto |
Wähle automatisch den Argumentationsaufwand während des Abrufs aus und eskaliere nur so weit wie nötig von der günstigsten Stufe. |
KnowledgeRetrievalSemanticIntent
Eine semantische Abfrageabsicht.
| Name | Typ | Beschreibung |
|---|---|---|
| search |
string |
Die semantische Abfrage, die ausgeführt werden soll |
| type |
string:
semantic |
Der Typ der Absicht. |
KnowledgeSourceGraphProvenanceKind
Quelldokument-Verhalten für graphbasierte Wissensabrufe.
| Wert | Beschreibung |
|---|---|
| none |
Geben Sie Graphenergebnisse zurück, ohne ihre Quelldokumente zu hydratisieren. |
| hydrate |
Geben Sie außerdem ausgewählte Quelldokumente aus dem konfigurierten Herkunftsindex zurück. |
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. |
| remoteSharePoint |
Eine Wissensquelle, die Daten von entferntem SharePoint liest. |
| workIQ |
Eine Wissensquelle, die Daten aus dem Arbeits-IQ liest |
| file |
Eine Wissensquelle, die das direkte Uploaden und Indexieren von Dateien unterstützt. |
| mcpServer |
Eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird. |
| fabricDataAgent |
Eine Wissensquelle, die Daten von einem Fabric Data Agent abruft. |
| fabricOntology |
Eine Wissensquelle, die Daten aus Microsoft Fabric Ontology-Ontologien abruft. |
KnowledgeSourceResultsProcessing
Kontrolliert, ob die Ergebnisse einer Wissensquelle neu bewertet werden.
| Wert | Beschreibung |
|---|---|
| rerank |
Ergebnisse aus dieser Wissensquelle durchlaufen die Reranking-Pipeline. Dies ist das Standardverhalten. |
| none |
Die Ergebnisse dieser Wissensquelle umgehen das Reranking und behalten ihre zugrundeliegende Ordnung bei. |
McpServerKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine MCP-Server-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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:
mcp |
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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
NoneVectorQueryTopicGraph
Verwendet normale Vektorsuche ohne Themengraph-Diversitätsabruf.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
none |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
RemoteSharePointKnowledgeSourceParams
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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“. |
| 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:
remote |
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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
SearchIndexKnowledgeSourceBoostKind
Die Art von Boost-Hinweis für eine Suchindex-Informationsquelle.
| Wert | Beschreibung |
|---|---|
| fieldValue |
Verbessern Sie Dokumente basierend auf einem Feldwert. |
| multiWordExpression |
Booste Dokumente basierend auf einem mehrsprachigen Ausdruck. |
SearchIndexKnowledgeSourceFieldValueBoost
Ein Hinweis, der Dokumente basierend auf einem Feldwert verbessert.
| Name | Typ | Beschreibung |
|---|---|---|
| boost |
number (double) |
Ein Multiplikator für die Dokumentenbewertung. Muss eine positive Zahl sein, die nicht gleich 1,0 ist. |
| boostInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie der Boost angewendet werden soll. |
| field |
string minLength: 1 |
Der Name des Suchindexfeldes. |
| fieldValues |
string[] |
Repräsentative Werte für das Feld. |
| kind |
string:
field |
So eine Art Boost-Hinweis. |
SearchIndexKnowledgeSourceFilterHint
Ein Hinweis, der ein Feld und umfassende Grounding-Werte identifiziert, die der Abfrageplaner beim Erstellen eines Filters verwenden kann.
| Name | Typ | Beschreibung |
|---|---|---|
| autoConfiguration |
Konfiguriert den Dienst so, dass er Erdungswerte aus den Facetten des Feldes auflöst. Seine Präsenz ermöglicht eine automatische Konfiguration. Das Feld muss filterbar und facetable sein. Nicht unterstützt, wenn der Zielindex dokumentenweitige Berechtigungen oder Purview-Sensitivitätsbezeichnungen aktiviert hat; diese Einschränkung wird zum Zeitpunkt der Erstellung und Aktualisierung der Wissensquelle und beim Wissensdatenbank-Abrufen validiert. Gegenseitiger Ausschluss mit |
|
| field |
string minLength: 1 |
Der Name des filterbaren Suchindexfeldes. |
| fieldValues |
string[] |
Das umfassende Werteverzeichnis für das Fachgebiet. Höchstens 160 Werte, mit maximal 128 Zeichen pro Wert und insgesamt 2048 Zeichen. In Versionen, die , unterstützen |
| filterInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie man auf dem Feld filtert. |
SearchIndexKnowledgeSourceFilterHintAutoConfiguration
Konfiguriert die automatische Auflösung der Erdungswerte eines Filterhints anhand der Zielindex-Facetten.
| Name | Typ | Beschreibung |
|---|---|---|
| cacheTtl |
integer (int32) minimum: 60maximum: 3600 |
Die Anzahl der aufgelösten Facettenwerte wird zwischengespeichert. Der erlaubte Bereich beträgt 60 bis 3600 bei dedizierten Diensten und 60 bis 900 bei serverlosen Diensten. Wenn ausgelassen, beträgt es standardmäßig 3600 Sekunden bei dedizierten Diensten und 900 Sekunden bei serverlosen Diensten. |
| maxFacetValueCount |
integer (int32) minimum: 1maximum: 64 |
Die maximale Anzahl von Facetwerten, die als Masseierung verwendet werden sollen. Standardmäßig 64; der erlaubte Bereich beträgt 1 bis 64. Werte werden in absteigender Reihenfolge der Facettenzahl ausgewählt, wobei dieselbe 2048-Zeichen-Kombinationslänge- und 128-Zeichen-Pro-Wert-Grenze wie manuell festgelegte Filterwerte unterliegen. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Ein Hinweis, der Dokumente basierend auf einem mehrsprachigen Ausdruck verbessert.
| Name | Typ | Beschreibung |
|---|---|---|
| boost |
number (double) |
Ein Multiplikator für die Dokumentenbewertung. Muss eine positive Zahl sein, die nicht gleich 1,0 ist. |
| boostInstructions |
string |
Anweisungen in natürlicher Sprache, die erklären, wann und wie der Boost angewendet werden soll. |
| fieldValues |
string[] |
Repräsentative Werte für den Schub. |
| kind |
string:
multi |
So eine Art Boost-Hinweis. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| queryHintOverrides |
Tipps, die die Abfrageplanung zu nützlichen Filtern und Boosts führen. Falls angegeben, ersetzt dieses Objekt die vollständige Menge an Abfragehinweisen, die auf der Wissensquelle konfiguriert sind. |
|
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
|
| topicGraph | VectorQueryTopicGraph: |
Überschreibt für diesen Abruf das gespeicherte topicGraph der Wissensquelle. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
SearchIndexKnowledgeSourceQueryHints
Hinweise, die die Abfrageplanung zu nützlichen Filtern und Verbesserungen für eine Suchindex-Wissensquelle führen.
| Name | Typ | Beschreibung |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Verbessern Sie Hinweise, die Bedingungen identifizieren, die der Abfrageplaner nutzen kann, um das Dokumentranking zu beeinflussen. |
| filters |
Filterhinweise, die Felder und repräsentative Werte identifizieren, die der Abfrageplaner beim Erstellen von Filtern verwenden kann. |
VectorSearchTopicGraphKind
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte.
| Wert | Beschreibung |
|---|---|
| none |
Verwenden Sie die normale Vektorsuche, wenn die Themengraphen-Diversitätsabfrage ausgeschaltet ist. |
| diverse |
Verwenden Sie Themengraph-Diversitätsabruf. |
| balanced |
Verbindet reine Vektorähnlichkeit mit diversitätsbewusstem Retrieval. Empfohlene Standardeinstellung, um Vielfalt mit Relevanz auszubalancieren. |
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. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |
WorkIQKnowledgeSourceParams
Spezifiziert Laufzeitparameter für eine WorkIQ-Wissensquelle
| Name | Typ | Beschreibung |
|---|---|---|
| alwaysQuerySource |
boolean |
Gibt an, dass diese Wissensquelle die Quellenauswahl umgehen und immer zum Zeitpunkt des Abrufs abgefragt werden soll. |
| enableImageServing |
boolean |
Gibt an, ob die Bildbereitstellung für diese Wissensquelle zum Abruf aktiviert werden sollte. Wenn sie zutreffen, werden während der Aufnahme extrahierte Bilder an nachgelagerte Modelle geliefert. |
| 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:
workIQ |
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. |
| neverQuerySource |
boolean |
Gibt an, dass diese Wissensquelle aus dem Kandidatenset der Anfrage ausgeschlossen und beim Abruf niemals abgefragt werden sollte. Der Ausschluss ist request-lokal und ändert die Mitgliedschaft in der Wissensdatenbank nicht. Kann nicht mit alwaysQuerySource auf derselben Wissensquelle kombiniert werden. |
| rerankerThreshold |
number (float) |
Der Reranker-Schwellenwert, den alle abgerufenen Dokumente erfüllen müssen, um in die Antwort aufgenommen zu werden. |
| resultsProcessing |
Überschreibt die gespeicherten Ergebnisse der Wissensquelle. Bearbeitung nur für diesen Abruf. Wenn dieser weggelassen wird, gilt der Wert der gespeicherten Wissensquelle. |