Documents - Graph
Führt eine Graphabfrage über einen Index mit einem Kantenlisten-Graphprofil aus.
POST {endpoint}/indexes('{indexName}')/docs/search.graph?api-version=2026-11-01-preview
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
index
|
path | True |
string |
Der Name des Index. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
|
| Accept |
Der Accept-Header. |
||
| x-ms-query-source-authorization |
string (password) |
Token, das den Benutzer identifiziert, für den die Abfrage ausgeführt wird. Dieses Token wird verwendet, um Sicherheitseinschränkungen für Dokumente durchzusetzen. |
|
| x-ms-enable-elevated-read |
boolean |
Ein Wert, der erhöhte Lesevorgänge ermöglicht, die Berechtigungsüberprüfungen auf Dokumentebene für den Abfragevorgang umgehen. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| gql | True |
string minLength: 1 |
Die nicht leere GQL-Abfrage zu binden und auszuführen. |
| executionMode |
Führt die Abfrage standardmäßig aus. planOnly erstellt den Plan ohne Backend-Abfrageausführung und erfordert mindestens eine Erklärungsphase. |
||
| explain |
Diagnoseplan-Phasen, die in die Antwort aufgenommen werden sollten. Plandarstellungen sind diagnostische Informationen und nicht ein ausführbarer Client-Vertrag. |
||
| filter |
string |
Ein OData-Filter über Graphenindexfelder, der während der gesamten Graphenausführung angewendet wird. |
|
| includeDiagnostics |
boolean |
Ob informative Diagnostik einbezogen werden soll. Fehler und Warnungen werden unabhängig von dieser Einstellung zurückgegeben. |
|
| includeStatistics |
boolean |
Ob Graphausführungsstatistiken einbezogen werden sollen. Die Standardeinstellung ist „true“. |
|
| provenance |
Kontrolliert begrenzte Behauptungsnachweise und optionale Hydratation in Quelldokumenten. |
||
| search |
string |
Volltext-Suchtext, der zur Einschränkung von Graph-Backend-Anfragen verwendet wird. |
|
| vectorQueries | VectorQuery[]: |
Vektorabfragen, die zur Einschränkung der Backend-Suchen des Graphen verwendet werden. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Anforderung ist erfolgreich. |
|
| Other Status Codes |
Unerwartete Fehlerantwort. Header x-ms-error-code: string |
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
SearchIndexGraphDocuments
Beispielanforderung
POST https://typespecpreviewexampleservice.search.windows.net/indexes('people-graph')/docs/search.graph?api-version=2026-11-01-preview
{
"gql": "MATCH (p:Person)-[r:worksFor]->(o:Organization) WHERE p.id = 'person:ada' RETURN o.name AS organization",
"filter": "graph_name eq 'contoso-people'",
"includeStatistics": false,
"provenance": {
"kind": "ids",
"maxEvidencePerRow": 5
}
}
Beispiel für eine Antwort
{
"@odata.count": 1,
"value": [
{
"@search.graphProvenance": {
"kind": "ids",
"evidenceCount": {
"value": 1,
"relation": "exact"
},
"evidence": [
{
"edgeId": "assertion-1",
"chunkId": "people-chunk-1",
"parentId": "people-document-1"
}
]
},
"organization": "Contoso"
}
]
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Der Accept-Header. |
|
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. |
|
Graph |
Eine Graphenplanungs- oder Ausführungsdiagnostik. |
|
Graph |
Die Stufe, die eine Graphabfrage-Diagnose erzeugte. |
|
Graph |
Die Bedeutung einer Graphabfrage-Diagnose. |
|
Graph |
Eine fehlgeschlagene Graphanfrage mit Standard-Suchfehlerinformationen und optionaler Graphdiagnostik. |
|
Graph |
Quellbehauptungsidentifikatoren und Konfidenzwerte werden als Graphenbelege beibehalten. |
|
Graph |
Vertrauenswerte, die auf einer unterstützenden Behauptung aufgezeichnet werden. |
|
Graph |
Eine Beweiszahl, deren Beziehung beschreibt, ob die Sammlung abgeschlossen war. |
|
Graph |
Vollständigkeit einer Beweiszahl. |
|
Graph |
Ob eine Graphabfrage ausgeführt oder nur geplant ist. |
|
Graph |
Diagnosestufen, die bei der Inspektion einer Graphabfrage verfügbar sind. |
|
Graph |
Wählt Felder aus dem von graphProfile.provenanceIndexName konfigurierten Quellindex aus. |
|
Graph |
Die Art von Behauptungsbelegen, die mit Graphenzeilen zurückkehrte. |
|
Graph |
Optionen für begrenzte Herkunftssammlungen für eine Graphabfrage. |
|
Graph |
Abfragefelder für die Abfrage des logischen Graphen, der durch das graphProfile eines Index abgebildet wird. |
|
Graph |
Projizierte Zeilen und optionale Ausführungsinformationen einer Graphabfrage. |
|
Graph |
Eine dynamische Graphprojektionszeile mit optionalen beschränkten Behauptungsnachweisen. |
|
Graph |
Behauptungsbelege zur Unterstützung einer projizierten Graphzeile. |
|
Graph |
Ausführungsstatistiken für eine Graphabfrage; Zähler beschreiben die geleistete Arbeit statt der Ergebniszeilenzahl. |
|
None |
Verwendet normale Vektorsuche ohne Themengraph-Diversitätsabruf. |
|
Query |
Dieser Parameter ist nur gültig, wenn der Abfragetyp |
|
Search |
Die Ergebnisse der Vektoranfrage filtern basierend auf dem ' |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine base64-codierte Binärdatei eines Bilds bereitgestellt wird, das vektorisiert werden muss. |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL, die einen Bildwert darstellt, der vektorisiert werden muss, bereitgestellt wird. |
|
Vectorizable |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert bereitgestellt wird, der vektorisiert werden muss. |
|
Vectorized |
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert bereitgestellt wird. |
|
Vector |
Die Art der Vektorabfrage, die ausgeführt wird. |
|
Vector |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
|
Vector |
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
|
Vector |
Die Art von Schwelle, die zum Filtern von Vektorabfragen verwendet wird. |
Accept
Der Accept-Header.
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=none |
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. |
GraphQueryDiagnostic
Eine Graphenplanungs- oder Ausführungsdiagnostik.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
string |
Stabiler, maschinenlesbarer Diagnosekenner. |
| message |
string |
Für Menschen lesbare Erklärung; Anwendungen sollten Code verwenden, statt diesen Text zu parsen. |
| phase |
Die Stufe, die die Diagnose erzeugte. |
|
| severity |
Die Bedeutung der Diagnose. |
|
| span |
string |
Optionale Quellspan-Beschreibung, die mit der Diagnose verknüpft ist. |
| suggestions |
string[] |
Vorgeschlagene Korrekturen oder Alternativen. |
GraphQueryDiagnosticPhase
Die Stufe, die eine Graphabfrage-Diagnose erzeugte.
| Wert | Beschreibung |
|---|---|
| parse |
Abfragesyntax und Parsing. |
| bind |
Variable, Parameter, Funktion und semantische Bindung. |
| validation |
Anfrage-Option-Validierung. |
| planning |
Abfrageplanung, einschließlich nicht unterstützter Abfrageformen und Einschränkungen der Abfragebreite. |
| execution |
Laufzeitbewertung, Ausführungslimitwarnungen und Ausführungszusammenfassungen. |
GraphQueryDiagnosticSeverity
Die Bedeutung einer Graphabfrage-Diagnose.
| Wert | Beschreibung |
|---|---|
| error |
Die Abfrage wurde abgelehnt oder konnte nicht erfolgreich bewertet werden. |
| warning |
Die Ausführung lieferte ein Ergebnis mit einem Vorbehalt, etwa einer Hinrichtungs- oder Herkunftsbegrenzung. |
| info |
Informative Diagnosen, wie eine optionale Ausführungszusammenfassung. |
GraphQueryError
Eine fehlgeschlagene Graphanfrage mit Standard-Suchfehlerinformationen und optionaler Graphdiagnostik.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.count |
integer (int64) |
Anzahl der projizierten Zeilen in dieser Antwort, nicht die Größe einer unbegrenzten Graphpopulation. |
| @search.graphDiagnostics |
Strukturierte Fehler, Warnungen und angeforderte Informationsdiagnostik. |
|
| @search.graphExplain |
Graph |
Angeforderte diagnostische Phasen. Fehlende Phasen werden weggelassen. |
| @search.graphProvenanceDocuments |
object |
Hydratierte Quelldokumente, die nach Dokument-ID eingeschlüsselt sind und über Ergebniszeilen hinweg geteilt werden. |
| @search.graphStats |
Ausführungsstatistiken, wenn angefordert und verfügbar. |
|
| error |
Standard-Fehlerinformationen bei der Suche. Ablehnungen von Graphabfragen verwenden InvalidRequestParameter und erhalten ihre spezifischen Codes in der Graph-Diagnostik. |
|
| value |
Abfrage von Projektionszeilen. planOnly gibt eine leere Sammlung zurück. |
GraphQueryEvidence
Quellbehauptungsidentifikatoren und Konfidenzwerte werden als Graphenbelege beibehalten.
| Name | Typ | Beschreibung |
|---|---|---|
| chunkId |
string |
Quell-Chunk-Kennung, der für die Quelldokumentabfrage verwendet wird. |
| confidence |
Vertrauenswerte, die mit der Behauptung und ihren Komponenten verbunden sind. |
|
| edgeId |
string |
Behauptungsdokument-Identifikator im Graphindex. |
| parentId |
string |
Übergeordnete Quelldokument-Kennung. |
GraphQueryEvidenceConfidence
Vertrauenswerte, die auf einer unterstützenden Behauptung aufgezeichnet werden.
| Name | Typ | Beschreibung |
|---|---|---|
| edge |
number (double) |
Vertrauen in die gesamte Beziehung. |
| object |
number (double) |
Vertrauen in die Erdestellung des Objekts. |
| predicate |
number (double) |
Vertrauen in die Ausrichtung der Prädikaten. |
| subject |
number (double) |
Vertrauen in das Fach zu verankern. |
GraphQueryEvidenceCount
Eine Beweiszahl, deren Beziehung beschreibt, ob die Sammlung abgeschlossen war.
| Name | Typ | Beschreibung |
|---|---|---|
| relation |
Ob der Wert die exakte Zahl oder eine untere Grenze ist. |
|
| value |
integer (int32) |
Anzahl der beobachteten unterstützenden Beweiseinträge. |
GraphQueryEvidenceCountRelation
Vollständigkeit einer Beweiszahl.
| Wert | Beschreibung |
|---|---|
| exact |
Alle unterstützenden Beweise wurden ausgezählt. |
| lowerBound |
Mindestens so viele unterstützende Einträge existieren; die Sammlung war begrenzt. |
GraphQueryExecutionMode
Ob eine Graphabfrage ausgeführt oder nur geplant ist.
| Wert | Beschreibung |
|---|---|
| execute |
Erstellen und führen Sie den Graphenplan aus. |
| planOnly |
Erstellen Sie den Graphenplan, ohne Backend-Suchen durchzuführen. |
GraphQueryExplainStage
Diagnosestufen, die bei der Inspektion einer Graphabfrage verfügbar sind.
| Wert | Beschreibung |
|---|---|
| syntax |
Parsierte Abfragesyntax. |
| semanticIr |
Gebundene semantische Zwischenrepräsentation. |
| logicalPlan |
Logischer Plan vor der Optimierung. |
| optimizedLogicalPlan |
Logischer Plan nach der Optimierung. |
| physicalPlan |
Physischer Ausführungsplan. |
| requestAttributions |
Zuschreibung von Backend-Anfragen an Ausführungsplan-Knoten. |
| full |
Alle verfügbaren diagnostischen Stufen. |
GraphQueryProvenanceHydrateDocumentsParameters
Wählt Felder aus dem von graphProfile.provenanceIndexName konfigurierten Quellindex aus.
| Name | Typ | Beschreibung |
|---|---|---|
| select |
string |
Komma-getrennte Quelldokumentfelder zurückzugeben; ausgelassen wählt die standardmäßig abrufbaren Felder des Dienstes aus. |
GraphQueryProvenanceKind
Die Art von Behauptungsbelegen, die mit Graphenzeilen zurückkehrte.
| Wert | Beschreibung |
|---|---|
| ids |
Geben Sie Beweisidentifikatoren ohne Quellendokumente zurück. |
| hydrate |
Geben Sie Beweisidentifikatoren und ausgewählte Dokumente aus dem profilkonfigurierten Herkunftsindex zurück. |
GraphQueryProvenanceParameters
Optionen für begrenzte Herkunftssammlungen für eine Graphabfrage.
| Name | Typ | Beschreibung |
|---|---|---|
| hydrateDocuments |
Optionen für die Auswahl von Quelldokumenten. Notwendig, wenn die Sorte ausreichend trinken. |
|
| kind |
Ob man Beweisidentifikatoren zurückschicken oder deren Quellendokumente bewässern soll. |
|
| maxEvidencePerRow |
integer (int32) minimum: 1 |
Maximale Anzahl der Beweiseinträge, die pro Ergebniszeile gesammelt werden. Wenn sie begrenzt ist, zeigt die Antwort an, ob die Beweiszahl exakt oder eine untere Grenze ist. |
GraphQueryRequest
Abfragefelder für die Abfrage des logischen Graphen, der durch das graphProfile eines Index abgebildet wird.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| executionMode | execute |
Führt die Abfrage standardmäßig aus. planOnly erstellt den Plan ohne Backend-Abfrageausführung und erfordert mindestens eine Erklärungsphase. |
|
| explain |
Diagnoseplan-Phasen, die in die Antwort aufgenommen werden sollten. Plandarstellungen sind diagnostische Informationen und nicht ein ausführbarer Client-Vertrag. |
||
| filter |
string |
Ein OData-Filter über Graphenindexfelder, der während der gesamten Graphenausführung angewendet wird. |
|
| gql |
string minLength: 1 |
Die nicht leere GQL-Abfrage zu binden und auszuführen. |
|
| includeDiagnostics |
boolean |
False |
Ob informative Diagnostik einbezogen werden soll. Fehler und Warnungen werden unabhängig von dieser Einstellung zurückgegeben. |
| includeStatistics |
boolean |
True |
Ob Graphausführungsstatistiken einbezogen werden sollen. Die Standardeinstellung ist „true“. |
| provenance |
Kontrolliert begrenzte Behauptungsnachweise und optionale Hydratation in Quelldokumenten. |
||
| search |
string |
Volltext-Suchtext, der zur Einschränkung von Graph-Backend-Anfragen verwendet wird. |
|
| vectorQueries | VectorQuery[]: |
Vektorabfragen, die zur Einschränkung der Backend-Suchen des Graphen verwendet werden. |
GraphQueryResult
Projizierte Zeilen und optionale Ausführungsinformationen einer Graphabfrage.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.count |
integer (int64) |
Anzahl der projizierten Zeilen in dieser Antwort, nicht die Größe einer unbegrenzten Graphpopulation. |
| @search.graphDiagnostics |
Strukturierte Fehler, Warnungen und angeforderte Informationsdiagnostik. |
|
| @search.graphExplain |
Graph |
Angeforderte diagnostische Phasen. Fehlende Phasen werden weggelassen. |
| @search.graphProvenanceDocuments |
object |
Hydratierte Quelldokumente, die nach Dokument-ID eingeschlüsselt sind und über Ergebniszeilen hinweg geteilt werden. |
| @search.graphStats |
Ausführungsstatistiken, wenn angefordert und verfügbar. |
|
| value |
Abfrage von Projektionszeilen. planOnly gibt eine leere Sammlung zurück. |
GraphQueryRow
Eine dynamische Graphprojektionszeile mit optionalen beschränkten Behauptungsnachweisen.
| Name | Typ | Beschreibung |
|---|---|---|
| @search.graphProvenance |
Behauptungsbelege zur Unterstützung dieser prognostizierten Streitreihe. |
GraphQueryRowProvenance
Behauptungsbelege zur Unterstützung einer projizierten Graphzeile.
| Name | Typ | Beschreibung |
|---|---|---|
| evidence |
Begrenzte Beweiseinträge für diese Ergebniszeile. |
|
| evidenceCount |
Anzahl der unterstützenden Behauptungen und die Vollständigkeitsrelation dieser Zählung. |
|
| kind |
Unabhängig davon, ob die Anfrage Beweismittel-IDs oder Quellenhydratation anforderte. |
GraphQueryStatistics
Ausführungsstatistiken für eine Graphabfrage; Zähler beschreiben die geleistete Arbeit statt der Ergebniszeilenzahl.
| Name | Typ | Beschreibung |
|---|---|---|
| documentsFetched |
integer (int32) |
Backend-Assertionsdokumente, die während der Ausführung abgerufen werden. |
| executionMode |
Ob die Anfrage ausgeführt wurde oder nur ein Plan hervorgebracht wurde. |
|
| isEstimated |
boolean |
Ob die Ausführung ein geschätztes Ergebnis meldet. |
| planningMs |
integer (int64) |
Zeit, die in Millisekunden mit der Erstellung des Abfrageplans aufgewendet wurde. |
| queryCount |
integer (int32) |
Backend-Suchanfragen, die von der Graphabfrage durchgeführt werden. |
| searchMs |
integer (int64) |
Gemeldete Suchzeit in Millisekunden. |
| totalMs |
integer (int64) |
Gemeldete Gesamtausführungszeit in Millisekunden. |
NoneVectorQueryTopicGraph
Verwendet normale Vektorsuche ohne Themengraph-Diversitätsabruf.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
none |
Die Art der Thema-Graphen-Vektorsuche, die man verwenden sollte. |
QueryRewritesType
Dieser Parameter ist nur gültig, wenn der Abfragetyp semanticist. Wenn QueryRewrites auf generativefestgelegt ist, werden die Abfragebegriffe an ein Generierungsmodell gesendet, das 10 (Standard-)Umschreibungen erzeugt, um den Abruf der Anforderung zu erhöhen. Die angeforderte Anzahl kann konfiguriert werden, indem Sie den senkrechten Strich | gefolgt von der count-<number of rewrites> Option anhängen, z. B generative|count-3. . . Wird standardmäßig auf None festgelegt.
| Wert | Beschreibung |
|---|---|
| none |
Generieren Sie keine zusätzlichen Abfrageumschreibungen für diese Abfrage. |
| generative |
Generieren Sie alternative Abfragebegriffe, um den Rückruf einer Suchanforderung zu erhöhen. |
SearchScoreThreshold
Die Ergebnisse der Vektoranfrage filtern basierend auf dem '
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
search |
Art der Schwelle. |
| value |
number (double) |
Der Schwellenwert filtert basierend auf dem ' |
VectorizableImageBinaryQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine base64-codierte Binärdatei eines Bilds bereitgestellt wird, das vektorisiert werden muss.
| Name | Typ | Beschreibung |
|---|---|---|
| base64Image |
string |
Die Basis-64-kodierte Binärdatei eines Bildes, das vektorisiert werden soll, um eine Vektorsuchabfrage durchzuführen. |
| exhaustive |
boolean |
Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten. |
| fields |
string |
Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet. |
| k |
integer (int32) |
Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen. |
| kind |
string:
image |
Abfragetyp. |
| oversampling |
number (double) |
Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| topicGraph | VectorQueryTopicGraph: |
Thema-Vektorsuchoptionen für Graphen. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein. |
VectorizableImageUrlQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn eine URL, die einen Bildwert darstellt, der vektorisiert werden muss, bereitgestellt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten. |
| fields |
string |
Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet. |
| k |
integer (int32) |
Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen. |
| kind |
string:
image |
Abfragetyp. |
| oversampling |
number (double) |
Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| topicGraph | VectorQueryTopicGraph: |
Thema-Vektorsuchoptionen für Graphen. |
| url |
string |
Die URL eines Bilds, das vektorisiert werden soll, um eine Vektorsuchabfrage auszuführen. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein. |
VectorizableTextQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein Textwert bereitgestellt wird, der vektorisiert werden muss.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten. |
| fields |
string |
Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet. |
| k |
integer (int32) |
Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen. |
| kind |
string:
text |
Abfragetyp. |
| oversampling |
number (double) |
Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| queryRewrites |
Kann so konfiguriert werden, dass ein generatives Modell die Abfrage neu schreiben kann, bevor sie an die Vektorisierung gesendet wird. |
|
| text |
string |
Der text, der vektorisiert werden soll, um eine Vektorsuchabfrage auszuführen. |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| topicGraph | VectorQueryTopicGraph: |
Thema-Vektorsuchoptionen für Graphen. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein. |
VectorizedQuery
Die Abfrageparameter, die für die Vektorsuche verwendet werden sollen, wenn ein unformatierter Vektorwert bereitgestellt wird.
| Name | Typ | Beschreibung |
|---|---|---|
| exhaustive |
boolean |
Wenn wahr, löst eine vollständige k-nächste Nachbarsuche über alle Vektoren innerhalb des Vektorindex aus. Nützlich für Szenarien, in denen genaue Übereinstimmungen kritisch sind, z. B. das Bestimmen von Boden-Wahrheitswerten. |
| fields |
string |
Vektorfelder vom Typ Collection(Edm.Single), die in den durchsuchten Vektor einbezogen werden sollen. |
| filterOverride |
string |
Der OData-Filterausdruck, der auf diese spezifische Vektorabfrage angewendet werden soll. Wenn kein Filterausdruck auf Vektorebene definiert ist, wird stattdessen der im Filterparameter der obersten Ebene definierte Ausdruck verwendet. |
| k |
integer (int32) |
Die Anzahl der nächsten Nachbarn, die als Toptreffer zurückgegeben werden sollen. |
| kind |
string:
vector |
Abfragetyp. |
| oversampling |
number (double) |
Übersamplingfaktor. Der Mindestwert ist 1. Er überschreibt den in der Indexdefinition konfigurierten Parameter "defaultOversampling". Sie kann nur festgelegt werden, wenn "rerankWithOriginalVectors" wahr ist. Dieser Parameter ist nur zulässig, wenn eine Komprimierungsmethode für das zugrunde liegende Vektorfeld verwendet wird. |
| perDocumentVectorLimit |
integer (int32) |
Steuert, wie viele Vektoren aus jedem Dokument in einer Vektorsuchabfrage abgeglichen werden können. Wenn Sie den Wert auf 1 setzen, wird sichergestellt, dass maximal ein Vektor pro Dokument abgeglichen wird, wodurch sichergestellt wird, dass die Ergebnisse aus unterschiedlichen Dokumenten stammen. Wenn Sie den Wert auf 0 (unbegrenzt) setzen, können mehrere relevante Vektoren aus demselben Dokument abgeglichen werden. Standard ist "0". |
| threshold | VectorThreshold: |
Der Schwellenwert, der für Vektorabfragen verwendet wird. Beachten Sie, dass dies nur festgelegt werden kann, wenn alle "Felder" dieselbe Ähnlichkeitsmetrik verwenden. |
| topicGraph | VectorQueryTopicGraph: |
Thema-Vektorsuchoptionen für Graphen. |
| vector |
number[] (float) |
Die Vektordarstellung einer Suchabfrage. |
| weight |
number (float) |
Relative Gewichtung der Vektorabfrage im Vergleich zu anderen Vektorabfragen und/oder der Textabfrage innerhalb derselben Suchanforderung. Dieser Wert wird verwendet, wenn die Ergebnisse mehrerer Bewertungslisten kombiniert werden, die von den verschiedenen Vektorabfragen und/oder den ergebnissen, die über die Textabfrage abgerufen wurden. Je höher die Gewichtung ist, desto höher sind die Dokumente, die dieser Abfrage entsprechen, in der endgültigen Rangfolge. Der Standardwert ist 1,0 und der Wert muss eine positive Zahl größer als 0 sein. |
VectorQueryKind
Die Art der Vektorabfrage, die ausgeführt wird.
| Wert | Beschreibung |
|---|---|
| vector |
Vektorabfrage, bei der ein unformatierter Vektorwert bereitgestellt wird. |
| text |
Vektorabfrage, bei der ein Textwert bereitgestellt wird, der vektorisiert werden muss. |
| imageUrl |
Vektorabfrage, bei der eine URL bereitgestellt wird, die einen Bildwert darstellt, der vektorisiert werden muss. |
| imageBinary |
Vektorabfrage, bei der eine Base64-kodierte Binärdatei eines Bildes bereitgestellt wird, das vektorisiert werden muss. |
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. |
VectorSimilarityThreshold
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt.
| Name | Typ | Beschreibung |
|---|---|---|
| kind |
string:
vector |
Art der Schwelle. |
| value |
number (double) |
Der Schwellenwert wird basierend auf dem Wert der Ähnlichkeitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
VectorThresholdKind
Die Art von Schwelle, die zum Filtern von Vektorabfragen verwendet wird.
| Wert | Beschreibung |
|---|---|
| vectorSimilarity |
Die Ergebnisse der Vektorabfrage werden basierend auf der Vektorgleichheitsmetrik gefiltert. Beachten Sie, dass dies die kanonische Definition der Ähnlichkeitsmetrik ist, nicht die Version des Abstands. Die Schwellenwertrichtung (größer oder kleiner) wird automatisch entsprechend der vom Feld verwendeten Metrik ausgewählt. |
| searchScore |
Die Ergebnisse der Vektorabfrage werden basierend auf dem Wert "@search.score" gefiltert. Beachten Sie, dass dies die @search.score, die als Teil der Suchantwort zurückgegeben wird. Die Schwellenwertrichtung wird für höhere @search.scoreausgewählt. |