Documents - Graph
Wykonuje zapytanie grafowe nad indeksem z profilem grafu z listą krawędzi.
POST {endpoint}/indexes('{indexName}')/docs/search.graph?api-version=2026-11-01-preview
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adres URL punktu końcowego usługi wyszukiwania. |
|
index
|
path | True |
string |
Nazwa indeksu. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
|
| Accept |
Nagłówek „Accept”. |
||
| x-ms-query-source-authorization |
string (password) |
Token identyfikujący użytkownika, dla którego jest wykonywane zapytanie. Ten token służy do wymuszania ograniczeń zabezpieczeń dokumentów. |
|
| x-ms-enable-elevated-read |
boolean |
Wartość, która umożliwia odczyt z podwyższonym poziomem uprawnień, który pomija sprawdzanie uprawnień na poziomie dokumentu dla operacji zapytania. |
Treść żądania
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| gql | True |
string minLength: 1 |
Niepuste zapytanie GQL do powiązania i wykonania. |
| executionMode |
Domyślnie wykonuje zapytanie. planOnly buduje plan bez wykonywania zapytań backendowych i wymaga co najmniej jednego etapu wyjaśnienia. |
||
| explain |
Etapy planu diagnostycznego uwzględnić w odpowiedzi. Oświadczenia planu to informacje diagnostyczne, a nie wykonalna umowa z klientem. |
||
| filter |
string |
Filtr OData nad polami indeksu grafu stosowany podczas wykonywania wykresu. |
|
| includeDiagnostics |
boolean |
Czy uwzględnić diagnostykę informacyjną. Błędy i ostrzeżenia są zwracane niezależnie od tego ustawienia. |
|
| includeStatistics |
boolean |
Czy uwzględnić statystyki wykonania grafu. Domyślnie ustawione na true. |
|
| provenance |
Kontroluje ograniczone dowody asercyjne oraz opcjonalne nawodnianie dokumentu źródłowego. |
||
| search |
string |
Pełnotekstowy tekst wyszukiwania używany do ograniczania żądań zaplecza grafu. |
|
| vectorQueries | VectorQuery[]: |
Zapytania wektorowe używane do ograniczania wyszukiwań zaplecza grafu. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 200 OK |
Żądanie zakończyło się pomyślnie. |
|
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string |
Zabezpieczenia
api-key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Zakresy
| Nazwisko | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchIndexGraphDocuments
Przykładowe żądanie
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
}
}
Przykładowa odpowiedź
{
"@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"
}
]
}
Definicje
| Nazwisko | Opis |
|---|---|
| Accept |
Nagłówek „Accept”. |
|
Balanced |
Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością. |
|
Diverse |
Wykorzystuje wykres tematyczny do różnorodnego wyszukiwania. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Graph |
Diagnostyka planowania lub wykonania grafu. |
|
Graph |
Etap, który generował diagnostykę zapytania grafowego. |
|
Graph |
Znaczenie diagnostyki zapytania grafowego. |
|
Graph |
Nieudane żądanie wykresu ze standardowymi informacjami o błędzie wyszukiwania oraz opcjonalną diagnostyką wykresu. |
|
Graph |
Identyfikatory asercji źródła i wartości zaufania zachowane jako dowód grafu. |
|
Graph |
Wartości zaufania zapisane w twierdzeniu wspierającym. |
|
Graph |
Liczba dowodów, której relacja opisuje, czy zebranie było kompletne. |
|
Graph |
Kompletność liczby dowodów. |
|
Graph |
Czy zapytanie grafowe jest wykonywane, czy tylko planowane. |
|
Graph |
Dostępne etapy diagnostyki podczas inspekcji zapytania grafu. |
|
Graph |
Wybiera pola z indeksu źródłowego skonfigurowanego przez graphProfile.provenanceIndexName. |
|
Graph |
Rodzaj dowodów asercji, które zwracają się wraz z wierszami grafów. |
|
Graph |
Opcje kolekcji ograniczonej provenancji dla zapytania grafu. |
|
Graph |
Pola żądania do zapytania do grafu logicznego mapowanego przez graphProfile indeksu. |
|
Graph |
Rzutowane wiersze zapytania grafu oraz opcjonalne informacje o wykonaniu. |
|
Graph |
Dynamiczny wiersz projekcji grafu z opcjonalnym ograniczonym dowodem asercji. |
|
Graph |
Dowody twierdzeń wspierające jeden rzutowany wiersz grafu. |
|
Graph |
Statystyki wykonania zapytania grafowego; liczniki opisują wykonaną pracę, a nie liczbę wierszy wyników. |
|
None |
Używa normalnego wyszukiwania wektorowego bez wykresu tematów – różnorodne wyszukiwanie. |
|
Query |
Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to |
|
Search |
Wyniki zapytania wektorowego będą filtrowane na podstawie ' |
|
Vectorizable |
Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy jest udostępniany zakodowany w formacie base 64 plik binarny obrazu, który musi zostać wektoryzowany. |
|
Vectorizable |
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy podano adres URL reprezentujący wartość obrazu, która musi być wektoryzowana. |
|
Vectorizable |
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana. |
|
Vectorized |
Parametry zapytania do użycia do wyszukiwania wektorów po podaniu nieprzetworzonej wartości wektora. |
|
Vector |
Rodzaj wykonywanego zapytania wektorowego. |
|
Vector |
Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć. |
|
Vector |
Wyniki zapytania wektorowego będą filtrowane na podstawie metryki podobieństwa wektorów. Należy pamiętać, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryki używanej przez pole. |
|
Vector |
Taki próg używany do filtrowania zapytań wektorowych. |
Accept
Nagłówek „Accept”.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=none |
BalancedVectorQueryTopicGraph
Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
balanced |
Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Minimalna liczba kandydatów na wektory do pobrania przed próbkowaniem grafu tematycznego. Wartość domyślna to 1000. |
DiverseVectorQueryTopicGraph
Wykorzystuje wykres tematyczny do różnorodnego wyszukiwania.
| Nazwisko | Typ | Opis |
|---|---|---|
| diversityFactor |
number (float) minimum: 0maximum: 1 |
Współczynnik różnorodności używany do wyszukiwania różnorodności na wykresie tematycznym. Jeśli zostanie pominięty, używany jest domyślny profil wykresu tematu. |
| kind |
string:
diverse |
Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć. |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
Minimalna liczba kandydatów na wektory do pobrania przed próbkowaniem grafu tematycznego. Wartość domyślna to 1000. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwisko | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwisko | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Cel błędu. |
GraphQueryDiagnostic
Diagnostyka planowania lub wykonania grafu.
| Nazwisko | Typ | Opis |
|---|---|---|
| code |
string |
Stabilny, czytelny maszynowo identyfikator diagnostyczny. |
| message |
string |
Wyjaśnienie czytelne dla człowieka; aplikacje powinny używać kodu, a nie analizować ten tekst. |
| phase |
Etap, który wywołał diagnostykę. |
|
| severity |
Znaczenie diagnostyki. |
|
| span |
string |
Opcjonalny opis zakresu źródła powiązany z diagnostyką. |
| suggestions |
string[] |
Proponowane poprawki lub alternatywy. |
GraphQueryDiagnosticPhase
Etap, który generował diagnostykę zapytania grafowego.
| Wartość | Opis |
|---|---|
| parse |
Składnia zapytań i parsowanie. |
| bind |
Powiązanie zmiennych, parametrów, funkcji i semantyki. |
| validation |
Walidacja żądania i opcji. |
| planning |
Planowanie zapytań, w tym nieobsługiwane kształty zapytań oraz ograniczenia szerokości zapytań. |
| execution |
Ocena w czasie wykonywania, ostrzeżenia o limitach wykonania oraz podsumowania wykonania. |
GraphQueryDiagnosticSeverity
Znaczenie diagnostyki zapytania grafowego.
| Wartość | Opis |
|---|---|
| error |
Zapytanie zostało odrzucone lub nie mogło zostać pomyślnie ocenione. |
| warning |
Wykonanie zwracało wynik z zastrzeżeniem, takim jak limit wykonania lub pochodzenia. |
| info |
Diagnostyka informacyjna, taka jak opcjonalne podsumowanie wykonania. |
GraphQueryError
Nieudane żądanie wykresu ze standardowymi informacjami o błędzie wyszukiwania oraz opcjonalną diagnostyką wykresu.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.count |
integer (int64) |
Liczba przewidywanych wierszy w tej odpowiedzi, a nie rozmiar populacji grafu nieograniczonego. |
| @search.graphDiagnostics |
Strukturalne błędy, ostrzeżenia i żądane diagnostyki informacyjne. |
|
| @search.graphExplain |
Graph |
Wnioskowano o etapy diagnostyczne. Brakujące etapy są pomijane. |
| @search.graphProvenanceDocuments |
object |
Nawodnione dokumenty źródłowe kluczowane według ID dokumentu, współdzielone między wierszami wyników. |
| @search.graphStats |
Statystyki wykonania, gdy są na żądanie i dostępne. |
|
| error |
Informacje o błędzie standardowego wyszukiwania. Odrzucenia zapytań grafowych używają InvalidRequestParameter i zachowują swoje specyficzne kody w diagnostyce grafów. |
|
| value |
Zapytaj wiersze projekcji. planOnly zwraca pustą kolekcję. |
GraphQueryEvidence
Identyfikatory asercji źródła i wartości zaufania zachowane jako dowód grafu.
| Nazwisko | Typ | Opis |
|---|---|---|
| chunkId |
string |
Identyfikator fragmentu źródła używany do wyszukiwania dokumentu źródłowego. |
| confidence |
Wartości zaufania powiązane z asercją i jej komponentami. |
|
| edgeId |
string |
Identyfikator dokumentu asercji w indeksie wykresu. |
| parentId |
string |
Identyfikator dokumentu źródłowego nadrzędnego. |
GraphQueryEvidenceConfidence
Wartości zaufania zapisane w twierdzeniu wspierającym.
| Nazwisko | Typ | Opis |
|---|---|---|
| edge |
number (double) |
Pewność siebie w całym związku. |
| object |
number (double) |
Pewność co do uziemienia obiektu. |
| predicate |
number (double) |
Pewność co do wyrównania predykatów. |
| subject |
number (double) |
Pewność co do podstaw przedmiotu. |
GraphQueryEvidenceCount
Liczba dowodów, której relacja opisuje, czy zebranie było kompletne.
| Nazwisko | Typ | Opis |
|---|---|---|
| relation |
Czy wartość jest dokładną liczbą, czy dolną granicą. |
|
| value |
integer (int32) |
Liczba zaobserwowanych wpisów dowodowych. |
GraphQueryEvidenceCountRelation
Kompletność liczby dowodów.
| Wartość | Opis |
|---|---|
| exact |
Wszystkie dowody zostały policzone. |
| lowerBound |
Przynajmniej tyle wpisów wspierających istnieje; kolekcja była ograniczona. |
GraphQueryExecutionMode
Czy zapytanie grafowe jest wykonywane, czy tylko planowane.
| Wartość | Opis |
|---|---|
| execute |
Zbuduj i wykonaj plan wykresu. |
| planOnly |
Twórz plan grafu bez wykonywania wyszukiwań zaplecza. |
GraphQueryExplainStage
Dostępne etapy diagnostyki podczas inspekcji zapytania grafu.
| Wartość | Opis |
|---|---|
| syntax |
Składnia zapytania parsowanego. |
| semanticIr |
Związana reprezentacja pośrednia semantyczna. |
| logicalPlan |
Logiczny plan przed optymalizacją. |
| optimizedLogicalPlan |
Logiczny plan po optymalizacji. |
| physicalPlan |
Plan fizycznej egzekucji. |
| requestAttributions |
Przypisywanie żądań backendowych węzłom planu wykonywania. |
| full |
Wszystkie dostępne etapy diagnostyczne. |
GraphQueryProvenanceHydrateDocumentsParameters
Wybiera pola z indeksu źródłowego skonfigurowanego przez graphProfile.provenanceIndexName.
| Nazwisko | Typ | Opis |
|---|---|---|
| select |
string |
Pola źródłowego dokumentu oddzielone przecinkami do zwracania; pominięcie wybiera domyślne pola do pobrania usługi. |
GraphQueryProvenanceKind
Rodzaj dowodów asercji, które zwracają się wraz z wierszami grafów.
| Wartość | Opis |
|---|---|
| ids |
Zwracaj identyfikatory dowodów bez dokumentów źródłowych. |
| hydrate |
Zwracaj identyfikatory dowodów i wybrane dokumenty z indeksu pochodzenia skonfigurowanego przez profil. |
GraphQueryProvenanceParameters
Opcje kolekcji ograniczonej provenancji dla zapytania grafu.
| Nazwisko | Typ | Opis |
|---|---|---|
| hydrateDocuments |
Opcje wyboru dokumentu źródłowego. Wymagane, gdy rodzaj jest nawadniony. |
|
| kind |
Czy zwracać identyfikatory dowodów, czy także nawodnić ich dokumenty źródłowe. |
|
| maxEvidencePerRow |
integer (int32) minimum: 1 |
Maksymalna liczba wpisów dowodowych zebranych na wiersz wyników. Gdy jest ograniczona, odpowiedź wskazuje, czy liczba dowodów jest dokładna, czy dolna. |
GraphQueryRequest
Pola żądania do zapytania do grafu logicznego mapowanego przez graphProfile indeksu.
| Nazwisko | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| executionMode | execute |
Domyślnie wykonuje zapytanie. planOnly buduje plan bez wykonywania zapytań backendowych i wymaga co najmniej jednego etapu wyjaśnienia. |
|
| explain |
Etapy planu diagnostycznego uwzględnić w odpowiedzi. Oświadczenia planu to informacje diagnostyczne, a nie wykonalna umowa z klientem. |
||
| filter |
string |
Filtr OData nad polami indeksu grafu stosowany podczas wykonywania wykresu. |
|
| gql |
string minLength: 1 |
Niepuste zapytanie GQL do powiązania i wykonania. |
|
| includeDiagnostics |
boolean |
False |
Czy uwzględnić diagnostykę informacyjną. Błędy i ostrzeżenia są zwracane niezależnie od tego ustawienia. |
| includeStatistics |
boolean |
True |
Czy uwzględnić statystyki wykonania grafu. Domyślnie ustawione na true. |
| provenance |
Kontroluje ograniczone dowody asercyjne oraz opcjonalne nawodnianie dokumentu źródłowego. |
||
| search |
string |
Pełnotekstowy tekst wyszukiwania używany do ograniczania żądań zaplecza grafu. |
|
| vectorQueries | VectorQuery[]: |
Zapytania wektorowe używane do ograniczania wyszukiwań zaplecza grafu. |
GraphQueryResult
Rzutowane wiersze zapytania grafu oraz opcjonalne informacje o wykonaniu.
| Nazwisko | Typ | Opis |
|---|---|---|
| @odata.count |
integer (int64) |
Liczba przewidywanych wierszy w tej odpowiedzi, a nie rozmiar populacji grafu nieograniczonego. |
| @search.graphDiagnostics |
Strukturalne błędy, ostrzeżenia i żądane diagnostyki informacyjne. |
|
| @search.graphExplain |
Graph |
Wnioskowano o etapy diagnostyczne. Brakujące etapy są pomijane. |
| @search.graphProvenanceDocuments |
object |
Nawodnione dokumenty źródłowe kluczowane według ID dokumentu, współdzielone między wierszami wyników. |
| @search.graphStats |
Statystyki wykonania, gdy są na żądanie i dostępne. |
|
| value |
Zapytaj wiersze projekcji. planOnly zwraca pustą kolekcję. |
GraphQueryRow
Dynamiczny wiersz projekcji grafu z opcjonalnym ograniczonym dowodem asercji.
| Nazwisko | Typ | Opis |
|---|---|---|
| @search.graphProvenance |
Dowody twierdzeń wspierające ten przewidywany wiersz. |
GraphQueryRowProvenance
Dowody twierdzeń wspierające jeden rzutowany wiersz grafu.
| Nazwisko | Typ | Opis |
|---|---|---|
| evidence |
Ograniczone wpisy dowodowe dla tego wiersza wyników. |
|
| evidenceCount |
Liczba twierdzeń wspierających oraz relacja zupełności tej liczby. |
|
| kind |
Czy zapytanie wymagało identyfikatorów dowodów, czy nawodnienia źródła. |
GraphQueryStatistics
Statystyki wykonania zapytania grafowego; liczniki opisują wykonaną pracę, a nie liczbę wierszy wyników.
| Nazwisko | Typ | Opis |
|---|---|---|
| documentsFetched |
integer (int32) |
Dokumenty asercji backendu pobierane podczas wykonywania. |
| executionMode |
Czy prośba została zrealizowana, czy tylko wygenerowała plan. |
|
| isEstimated |
boolean |
Czy wykonanie raportuje szacunkowy wynik. |
| planningMs |
integer (int64) |
Czas poświęcony na tworzenie planu zapytania, w milisekundach. |
| queryCount |
integer (int32) |
Żądania wyszukiwania w tle wykonywane przez zapytanie grafowe. |
| searchMs |
integer (int64) |
Zgłoszony czas wyszukiwania w milisekundach. |
| totalMs |
integer (int64) |
Zgłoszono całkowity czas wykonania w milisekundach. |
NoneVectorQueryTopicGraph
Używa normalnego wyszukiwania wektorowego bez wykresu tematów – różnorodne wyszukiwanie.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
none |
Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć. |
QueryRewritesType
Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to semantic. Gdy parametr QueryRewrites jest ustawiony na generativewartość , warunki zapytania są wysyłane do modelu generowania, który spowoduje wygenerowanie 10 (domyślnych) ponownych zapisów, aby zwiększyć odwołanie żądania. Żądaną liczbę można skonfigurować, dołączając znak | pionowej kreski count-<number of rewrites> , a następnie opcję, taką jak generative|count-3. Wartość domyślna to None.
| Wartość | Opis |
|---|---|
| none |
Nie generuj dodatkowych ponownych zapisów zapytań dla tego zapytania. |
| generative |
Wygeneruj alternatywne terminy zapytania, aby zwiększyć kompletność żądania wyszukiwania. |
SearchScoreThreshold
Wyniki zapytania wektorowego będą filtrowane na podstawie '
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
search |
Rodzaj progu. |
| value |
number (double) |
Próg będzie filtrowany na podstawie ' |
VectorizableImageBinaryQuery
Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy jest udostępniany zakodowany w formacie base 64 plik binarny obrazu, który musi zostać wektoryzowany.
| Nazwisko | Typ | Opis |
|---|---|---|
| base64Image |
string |
Plik binarny zakodowany w formacie binarnym o podstawie 64, który ma zostać zwektoryzowany w celu wykonania zapytania wyszukiwania wektorowego. |
| exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości podstawowych prawdy. |
| fields |
string |
Pola wektorów typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze. |
| filterOverride |
string |
Wyrażenie filtru OData, które ma być stosowane do tego konkretnego zapytania wektorowego. Jeśli nie zdefiniowano wyrażenia filtru na poziomie wektora, zamiast tego zostanie użyte wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu. |
| k |
integer (int32) |
Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia. |
| kind |
string:
image |
Typ zapytania. |
| oversampling |
number (double) |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
| perDocumentVectorLimit |
integer (int32) |
Określa, ile wektorów może być dopasowanych z każdego dokumentu w zapytaniu wyszukiwania wektorowego. Ustawienie wartości 1 gwarantuje, że dopasowany jest co najwyżej jeden wektor na dokument, co gwarantuje, że wyniki pochodzą z różnych dokumentów. Ustawienie go na 0 (nieograniczony) umożliwia dopasowanie wielu odpowiednich wektorów z tego samego dokumentu. Wartość domyślna to 0. |
| threshold | VectorThreshold: |
Próg używany dla zapytań wektorowych. Należy pamiętać, że można to ustawić tylko wtedy, gdy wszystkie pola używają tej samej metryki podobieństwa. |
| topicGraph | VectorQueryTopicGraph: |
Opcje wyszukiwania wektorowego wykresu tematycznego. |
| weight |
number (float) |
Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero. |
VectorizableImageUrlQuery
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy podano adres URL reprezentujący wartość obrazu, która musi być wektoryzowana.
| Nazwisko | Typ | Opis |
|---|---|---|
| exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości podstawowych prawdy. |
| fields |
string |
Pola wektorów typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze. |
| filterOverride |
string |
Wyrażenie filtru OData, które ma być stosowane do tego konkretnego zapytania wektorowego. Jeśli nie zdefiniowano wyrażenia filtru na poziomie wektora, zamiast tego zostanie użyte wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu. |
| k |
integer (int32) |
Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia. |
| kind |
string:
image |
Typ zapytania. |
| oversampling |
number (double) |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
| perDocumentVectorLimit |
integer (int32) |
Określa, ile wektorów może być dopasowanych z każdego dokumentu w zapytaniu wyszukiwania wektorowego. Ustawienie wartości 1 gwarantuje, że dopasowany jest co najwyżej jeden wektor na dokument, co gwarantuje, że wyniki pochodzą z różnych dokumentów. Ustawienie go na 0 (nieograniczony) umożliwia dopasowanie wielu odpowiednich wektorów z tego samego dokumentu. Wartość domyślna to 0. |
| threshold | VectorThreshold: |
Próg używany dla zapytań wektorowych. Należy pamiętać, że można to ustawić tylko wtedy, gdy wszystkie pola używają tej samej metryki podobieństwa. |
| topicGraph | VectorQueryTopicGraph: |
Opcje wyszukiwania wektorowego wykresu tematycznego. |
| url |
string |
Adres URL obrazu, który ma zostać wektoryzowany w celu wykonania zapytania wyszukiwania wektorowego. |
| weight |
number (float) |
Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero. |
VectorizableTextQuery
Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.
| Nazwisko | Typ | Opis |
|---|---|---|
| exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości podstawowych prawdy. |
| fields |
string |
Pola wektorów typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze. |
| filterOverride |
string |
Wyrażenie filtru OData, które ma być stosowane do tego konkretnego zapytania wektorowego. Jeśli nie zdefiniowano wyrażenia filtru na poziomie wektora, zamiast tego zostanie użyte wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu. |
| k |
integer (int32) |
Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia. |
| kind |
string:
text |
Typ zapytania. |
| oversampling |
number (double) |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
| perDocumentVectorLimit |
integer (int32) |
Określa, ile wektorów może być dopasowanych z każdego dokumentu w zapytaniu wyszukiwania wektorowego. Ustawienie wartości 1 gwarantuje, że dopasowany jest co najwyżej jeden wektor na dokument, co gwarantuje, że wyniki pochodzą z różnych dokumentów. Ustawienie go na 0 (nieograniczony) umożliwia dopasowanie wielu odpowiednich wektorów z tego samego dokumentu. Wartość domyślna to 0. |
| queryRewrites |
Można skonfigurować tak, aby umożliwić modelowi generowania ponownego zapisywania zapytania przed wysłaniem go do wektoryzowanego. |
|
| text |
string |
Tekst, który ma zostać wektoryzowany w celu wykonania zapytania wyszukiwania wektorowego. |
| threshold | VectorThreshold: |
Próg używany dla zapytań wektorowych. Należy pamiętać, że można to ustawić tylko wtedy, gdy wszystkie pola używają tej samej metryki podobieństwa. |
| topicGraph | VectorQueryTopicGraph: |
Opcje wyszukiwania wektorowego wykresu tematycznego. |
| weight |
number (float) |
Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero. |
VectorizedQuery
Parametry zapytania do użycia do wyszukiwania wektorów po podaniu nieprzetworzonej wartości wektora.
| Nazwisko | Typ | Opis |
|---|---|---|
| exhaustive |
boolean |
W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k najbliższych sąsiadów we wszystkich wektorach w indeksie wektorów. Przydatne w scenariuszach, w których dokładne dopasowania są krytyczne, takie jak określanie wartości podstawowych prawdy. |
| fields |
string |
Pola wektorów typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze. |
| filterOverride |
string |
Wyrażenie filtru OData, które ma być stosowane do tego konkretnego zapytania wektorowego. Jeśli nie zdefiniowano wyrażenia filtru na poziomie wektora, zamiast tego zostanie użyte wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu. |
| k |
integer (int32) |
Liczba najbliższych sąsiadów, które mają być zwracane jako pierwsze trafienia. |
| kind |
string:
vector |
Typ zapytania. |
| oversampling |
number (double) |
Współczynnik nadmiernego próbkowania. Wartość minimalna to 1. Zastępuje on parametr "defaultOversampling" skonfigurowany w definicji indeksu. Można go ustawić tylko wtedy, gdy wartość "rerankWithOriginalVectors" ma wartość true. Ten parametr jest dozwolony tylko wtedy, gdy metoda kompresji jest używana w polu wektora bazowego. |
| perDocumentVectorLimit |
integer (int32) |
Określa, ile wektorów może być dopasowanych z każdego dokumentu w zapytaniu wyszukiwania wektorowego. Ustawienie wartości 1 gwarantuje, że dopasowany jest co najwyżej jeden wektor na dokument, co gwarantuje, że wyniki pochodzą z różnych dokumentów. Ustawienie go na 0 (nieograniczony) umożliwia dopasowanie wielu odpowiednich wektorów z tego samego dokumentu. Wartość domyślna to 0. |
| threshold | VectorThreshold: |
Próg używany dla zapytań wektorowych. Należy pamiętać, że można to ustawić tylko wtedy, gdy wszystkie pola używają tej samej metryki podobieństwa. |
| topicGraph | VectorQueryTopicGraph: |
Opcje wyszukiwania wektorowego wykresu tematycznego. |
| vector |
number[] (float) |
Wektorowa reprezentacja zapytania wyszukiwania. |
| weight |
number (float) |
Względna waga zapytania wektorowego w porównaniu z innym zapytaniem wektorowym i/lub zapytaniem tekstowym w ramach tego samego żądania wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list rankingowych generowanych przez różne zapytania wektorowe i/lub wyniki pobrane za pośrednictwem zapytania tekstowego. Im większa waga, tym wyższa liczba dokumentów pasujących do tego zapytania będzie znajdować się w końcowej klasyfikacji. Wartość domyślna to 1.0, a wartość musi być liczbą dodatnią większą niż zero. |
VectorQueryKind
Rodzaj wykonywanego zapytania wektorowego.
| Wartość | Opis |
|---|---|
| vector |
Zapytanie wektorowe, w którym jest podana nieprzetworzona wartość wektora. |
| text |
Zapytanie wektorowe, w którym jest udostępniana wartość tekstowa, która musi zostać wektoryzowana. |
| imageUrl |
Zapytanie wektorowe, w którym podaje się adres URL reprezentujący wartość obrazu, która musi zostać zwektoryzowana. |
| imageBinary |
Zapytanie wektorowe, w którym podano zakodowany binarnie obraz o podstawie 64, który musi zostać zwektoryzowany. |
VectorSearchTopicGraphKind
Rodzaj wyszukiwania wektorowego na grafach tematycznych, którego należy użyć.
| Wartość | Opis |
|---|---|
| none |
Używaj normalnego wyszukiwania wektorowego, gdy wyszukiwanie różnorodności wykresu tematów jest nieprawidłowe. |
| diverse |
Korzystaj z wykresu tematycznego – różnorodne wyszukiwanie. |
| balanced |
Łączy czyste podobieństwo wektorowe z wyszukiwaniem uwzględniającym różnorodność. Zalecany domyślny sposób jest równoważenie różnorodności z trafnością. |
VectorSimilarityThreshold
Wyniki zapytania wektorowego będą filtrowane na podstawie metryki podobieństwa wektorów. Należy pamiętać, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryki używanej przez pole.
| Nazwisko | Typ | Opis |
|---|---|---|
| kind |
string:
vector |
Rodzaj progu. |
| value |
number (double) |
Próg będzie filtrowany na podstawie wartości metryki podobieństwa. Należy pamiętać, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryki używanej przez pole. |
VectorThresholdKind
Taki próg używany do filtrowania zapytań wektorowych.
| Wartość | Opis |
|---|---|
| vectorSimilarity |
Wyniki zapytania wektorowego będą filtrowane na podstawie metryki podobieństwa wektorów. Należy pamiętać, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryki używanej przez pole. |
| searchScore |
Wyniki zapytania wektorowego będą filtrować na podstawie wartości "@search.score". Zwróć uwagę, że jest to @search.score zwrócona jako część odpowiedzi wyszukiwania. Kierunek progu zostanie wybrany dla wyższego @search.score. |