Documents - Search Post

Usługa:
Search Service
Wersja interfejsu API:
2025-11-01-preview

Wyszukuje dokumenty w indeksie.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-11-01-preview

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
 path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.
indexName
 path True

string

Nazwa indeksu.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Accept

Accept

Nagłówek Accept.
x-ms-query-source-authorization

string

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.
x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwa Typ Opis
answers

QueryAnswerType

Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
captions

QueryCaptionType

Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.
count

boolean

Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to „false”. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwracana liczba jest przybliżeniem.
debug

QueryDebugMode

Włącza narzędzie do debugowania, które może być używane do dalszego eksplorowania wyników w zmienionej klasyfikacji.
facets

string[]

Lista wyrażeń aspektów, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value.
filter

string

Wyrażenie $filter OData, które ma być stosowane do zapytania wyszukiwania.
highlight

string

Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania.
highlightPostTag

string

Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. Wartość domyślna to </em>.
highlightPreTag

string

Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Wartość domyślna to <>.
hybridSearch

HybridSearch

Parametry zapytania do konfigurowania zachowań wyszukiwania hybrydowego.
minimumCoverage

number (double)

Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 100.
orderby

string

Rozdzielona przecinkami lista wyrażeń OData $orderby, według których mają być sortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowania dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
queryLanguage

QueryLanguage

Wartość określająca język wyszukiwanego zapytania.
queryRewrites

QueryRewritesType

Wartość określająca, czy powinno być generowane ponowne zapisywanie zapytania w celu rozszerzenia zapytania wyszukiwania.
queryType

QueryType

Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene.
scoringParameters

string[]

Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru to "mylocation--122.2,44.8" (bez cudzysłowów).
scoringProfile

string

Nazwa profilu oceniania do oceny wyników dla pasujących dokumentów w celu sortowania wyników.
scoringStatistics

ScoringStatistics

Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "lokalna". Użyj wartości "global", aby zagregować statystyki punktacji globalnie przed oceną. Korzystanie z globalnych statystyk punktacji może zwiększyć opóźnienie zapytań wyszukiwania.
search

string

Wyrażenie zapytania wyszukiwania pełnotekstowego; Użyj "*" lub pomiń ten parametr, aby dopasować wszystkie dokumenty.
searchFields

string

Rozdzielona przecinkami lista nazw pól, do których ma być objęte wyszukiwanie pełnotekstowe. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode

SearchMode

Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania.
select

string

Rozdzielona przecinkami lista pól do pobrania. W przypadku nieokreślonego dołączono wszystkie pola oznaczone jako możliwe do pobrania w schemacie.
semanticConfiguration

string

Nazwa konfiguracji semantycznej, która będzie używana podczas przetwarzania dokumentów dla zapytań typu semantycznego.
semanticErrorHandling

SemanticErrorMode

Umożliwia użytkownikowi wybór, czy wywołanie semantyczne powinno zakończyć się całkowitym niepowodzeniem (zachowanie domyślne / bieżące), czy też zwrócić częściowe wyniki.
semanticFields

string

Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Umożliwia użytkownikowi ustawienie górnej granicy czasu potrzebnego na zakończenie przetwarzania wzbogacania semantycznego przed zakończeniem żądania niepowodzeniem.
semanticQuery

string

Umożliwia ustawienie osobnego zapytania wyszukiwania, które będzie używane wyłącznie do zmiany klasyfikacji semantycznej, podpisów semantycznych i odpowiedzi semantycznych. Jest to przydatne w scenariuszach, w których istnieje potrzeba użycia różnych zapytań między fazą pobierania i klasyfikowania bazy a fazą semantyczną L2.
sessionId

string

Wartość, która ma być używana do tworzenia sesji trwałej, co może pomóc w uzyskaniu bardziej spójnych wyników. Tak długo, jak jest używany ten sam identyfikator sessionId, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy się uważać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_".
skip

integer (int32)

Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pominięcia z powodu tego ograniczenia, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtru z zapytaniem zakresu.
speller

QuerySpellerType

Wartość określająca typ literowca, którego należy użyć do poprawy poszczególnych zapytań wyszukiwania.
top

integer (int32)

Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania po stronie klienta wyników wyszukiwania. Jeśli wyniki zostaną obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania wyszukiwania dla następnej strony wyników.
vectorFilterMode

VectorFilterMode

Określa, czy filtry są stosowane przed czy po przeprowadzeniu wyszukiwania wektorowego. Wartość domyślna to "preFilter" dla nowych indeksów.
vectorQueries VectorQuery[]:

Parametry zapytania dla wektorów i zapytań wyszukiwania hybrydowego.

Odpowiedzi

Nazwa Typ Opis
200 OK

SearchDocumentsResult

Żądanie zakończyło się pomyślnie.
Other Status Codes

SearchDocumentsResult

Powodzenie
Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

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

Nazwa Opis
https://search.azure.com/.default

Przykłady

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Przykładowe żądanie

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2025-11-01-preview




{
  "count": true,
  "facets": [
    "ownerId",
    "price,metric:sum,default:10"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "queryLanguage": "en-us",
  "speller": "lexicon",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "queryRewrites": "generative",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "oversampling": 20,
      "weight": 1,
      "threshold": {
        "value": 0.984,
        "kind": "vectorSimilarity"
      },
      "filterOverride": "ownerId eq 'sam'"
    }
  ],
  "vectorFilterMode": "preFilter",
  "hybridSearch": {
    "maxTextRecallSize": 100,
    "countAndFacetMode": "countAllResults"
  }
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 27.725889205932617
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 39.23316955566406
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 23.01456642150879
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}
Kod stanu:
206 
{
  "@odata.count": 27,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ],
    "price": [
      {
        "sum": 320
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.015625,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 27.725889205932617
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011904762126505375,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012345679104328156,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0117647061124444,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.01666666753590107,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 39.23316955566406
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.013698630034923553,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 21.559860229492188
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.013888888992369175,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 23.01456642150879
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.012658228166401386,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 6.500757217407227
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Przykładowe żądanie

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-11-01-preview

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}
Kod stanu:
206 
{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}

Definicje

Nazwa Opis
Accept

Nagłówek Accept.
DebugInfo

Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.
DocumentDebugInfo

Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
HybridCountAndFacetMode

Określa, czy liczba i aspekty powinny obejmować wszystkie dokumenty pasujące do zapytania wyszukiwania, czy tylko dokumenty pobrane w oknie "maxTextRecallSize". Wartość domyślna to "countAllResults".
HybridSearch

Parametry zapytania do konfigurowania zachowań wyszukiwania hybrydowego.
QueryAnswerResult

Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z pierwszych wyników wyszukiwania. Kandydaci odpowiedzi są oceniani i wybierane są najważniejsze odpowiedzi.
QueryAnswerType

Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to semantic. Jeśli ta wartość jest ustawiona, zapytanie zwraca odpowiedzi wyodrębnione z kluczowych fragmentów w najwyżej sklasyfikowanych dokumentach. Liczbę zwracanych odpowiedzi można skonfigurować, dołączając znak | pionowej kreski count-<number of answers> , a następnie opcję po wartości parametru answers, na przykład extractive|count-3. Domyślna liczba to 1. Próg ufności można skonfigurować, dołączając znak | pionowej kreski threshold-<confidence threshold> , a następnie opcję po wartości parametru answers, na przykład extractive|threshold-0.9. Domyślny próg to 0,7. Maksymalną długość znaków w odpowiedziach można skonfigurować, dołączając znak kreski pionowej "|", po którym następuje "liczba-liczby< znaków o maksymalnej długości>", na przykład "extractive|maxcharlength-600".
QueryCaptionResult

Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu semantic.
QueryCaptionType

Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to semantic. W przypadku ustawienia zapytanie zwraca podpisy wyodrębnione z kluczowych fragmentów w najwyżej sklasyfikowanych dokumentach. Gdy opcja Podpisy jest ustawiona na extractive, podświetlanie jest domyślnie włączone i można je skonfigurować, dołączając znak | pionowej kreski highlight-<true/false> , a następnie opcję, taką jak extractive|highlight-true. Wartość domyślna to None. Maksymalną długość znaków podpisów można skonfigurować, dołączając znak kreski pionowej "|", po którym następuje "liczba-liczby< maksymalnej długości> znaków", na przykład "extractive|maxcharlength-600".
QueryDebugMode

Włącza narzędzie do debugowania, którego można użyć do dalszego eksplorowania wyników wyszukiwania. Możesz włączyć wiele trybów debugowania jednocześnie, oddzielając je znakiem | znak, na przykład: semantic|queryRewrites.
QueryLanguage

Język zapytania.
QueryResultDocumentRerankerInput

Nieprzetworzone ciągi, które zostały wysłane do procesu wzbogacania semantycznego.
QueryResultDocumentSemanticField

Opis pól, które zostały wysłane do procesu wzbogacania semantycznego, a także sposobu ich użycia
QueryResultDocumentSubscores

Podział podscores między składnikami zapytania tekstowego i wektorowego dla tego dokumentu. Każde zapytanie wektorowe jest wyświetlane jako oddzielny obiekt w tej samej kolejności, w której zostały odebrane.
QueryRewritesDebugInfo

Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.
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.
QueryRewritesValuesDebugInfo

Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.
QuerySpellerType

Popraw kompletność wyszukiwania przez poprawianie pisowni poszczególnych terminów zapytania wyszukiwania.
QueryType

Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "pełna", jeśli zapytanie używa składni zapytania Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.
ScoringStatistics

Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "lokalna". Użyj wartości "global", aby zagregować statystyki punktacji globalnie przed oceną. Korzystanie z globalnych statystyk punktacji może zwiększyć opóźnienie zapytań wyszukiwania.
SearchDocumentsResult

Odpowiedź zawierająca wyniki wyszukiwania z indeksu.
SearchMode

Określa, czy którykolwiek lub wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za zgodny.
SearchRequest

Parametry do filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.
SearchResult

Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.
SearchScoreThreshold

Wyniki zapytania wektorowego będą filtrowane na podstawie '
SemanticDebugInfo

Zawiera informacje debugowania specyficzne dla żądań klasyfikacji semantycznej.
SemanticErrorMode

Pozwala użytkownikowi wybrać, czy wywołanie semantyczne powinno całkowicie zawiódć, czy też zwrócić częściowe wyniki.
SemanticErrorReason

Przyczyna, dla której zwrócono częściową odpowiedź dla żądania klasyfikacji semantycznej.
SemanticFieldState

Sposób, w jaki pole było wykorzystywane do procesu wzbogacania semantycznego.
SemanticQueryRewritesResultType

Typ ponownego zapisywania zapytania, które zostało użyte dla tego żądania.
SemanticSearchResultsType

Typ częściowej odpowiedzi, która została zwrócona dla żądania klasyfikacji semantycznej.
SingleVectorFieldResult

Wynik pojedynczego pola wektorowego. Both
TextResult

Wynik BM25 lub klasyczny dla części tekstowej zapytania.
VectorFilterMode

Określa, czy filtry są stosowane przed czy po przeprowadzeniu wyszukiwania wektorowego.
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.
VectorizableImageUrlQuery

Parametry zapytania do użycia do wyszukiwania wektorowego, gdy podano adres URL reprezentujący wartość obrazu, która musi być wektoryzowana.
VectorizableTextQuery

Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.
VectorizedQuery

Parametry zapytania do użycia do wyszukiwania wektorów po podaniu nieprzetworzonej wartości wektora.
VectorQueryKind

Rodzaj wykonywanego zapytania wektorowego.
VectorsDebugInfo

"Zawiera informacje o debugowaniu specyficzne dla wyszukiwania wektorowego i hybrydowego.")
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.
VectorThresholdKind

Taki próg używany do filtrowania zapytań wektorowych.

Accept

Wyliczenie

Nagłówek Accept.

Wartość Opis
application/json;odata.metadata=none

DebugInfo

Objekt

Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.

Nazwa Typ Opis
queryRewrites

QueryRewritesDebugInfo

Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.

DocumentDebugInfo

Objekt

Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.

Nazwa Typ Opis
innerHits

object

Zawiera informacje debugowania specyficzne dla wektorów dopasowanych w kolekcji typów złożonych.
semantic

SemanticDebugInfo

Zawiera informacje debugowania specyficzne dla żądań klasyfikacji semantycznej.
vectors

VectorsDebugInfo

Zawiera informacje debugowania specyficzne dla wyszukiwania wektorowego i hybrydowego.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

HybridCountAndFacetMode

Wyliczenie

Określa, czy liczba i aspekty powinny obejmować wszystkie dokumenty pasujące do zapytania wyszukiwania, czy tylko dokumenty pobrane w oknie "maxTextRecallSize". Wartość domyślna to "countAllResults".

Wartość Opis
countRetrievableResults

Uwzględnij tylko dokumenty, które zostały dopasowane w oknie pobierania "maxTextRecallSize" podczas obliczania wartości "liczba" i "aspekty".
countAllResults

Uwzględnij wszystkie dokumenty, które zostały dopasowane przez zapytanie wyszukiwania podczas obliczania wartości "count" i "facets", niezależnie od tego, czy te dokumenty znajdują się w oknie pobierania "maxTextRecallSize".

HybridSearch

Objekt

Parametry zapytania do konfigurowania zachowań wyszukiwania hybrydowego.

Nazwa Typ Opis
countAndFacetMode

HybridCountAndFacetMode

Określa, czy liczba i aspekty powinny obejmować wszystkie dokumenty pasujące do zapytania wyszukiwania, czy tylko dokumenty pobrane w oknie "maxTextRecallSize".
maxTextRecallSize

integer (int32)

Określa maksymalną liczbę dokumentów do pobrania przez część zapytania tekstowego żądania wyszukiwania hybrydowego. Dokumenty te zostaną połączone z dokumentami pasującymi do zapytań wektorowych w celu utworzenia jednej końcowej listy wyników. Wybranie większej wartości maxTextRecallSize umożliwi pobieranie i stronicowanie większej liczby dokumentów (przy użyciu parametrów top i skip), kosztem większego wykorzystania zasobów i większego opóźnienia. Wartość musi należeć do zakresu od 1 do 10 000. Wartość domyślna to 1000.

QueryAnswerResult

Objekt

Odpowiedź to fragment tekstowy wyodrębniony z zawartości najbardziej odpowiednich dokumentów pasujących do zapytania. Odpowiedzi są wyodrębniane z pierwszych wyników wyszukiwania. Kandydaci odpowiedzi są oceniani i wybierane są najważniejsze odpowiedzi.

Nazwa Typ Opis
highlights

string

Ten sam fragment tekstu, co we właściwości Text z wyróżnionymi frazami tekstowymi najbardziej istotnymi dla zapytania.
key

string

Klucz dokumentu, z którego uzyskano odpowiedź.
score

number (double)

Wartość wyniku określa, jak istotna jest odpowiedź na zapytanie względem innych odpowiedzi zwróconych dla zapytania.
text

string

Fragment tekstu wyodrębniony z zawartości dokumentu jako odpowiedź.

QueryAnswerType

Wyliczenie

Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to semantic. Jeśli ta wartość jest ustawiona, zapytanie zwraca odpowiedzi wyodrębnione z kluczowych fragmentów w najwyżej sklasyfikowanych dokumentach. Liczbę zwracanych odpowiedzi można skonfigurować, dołączając znak | pionowej kreski count-<number of answers> , a następnie opcję po wartości parametru answers, na przykład extractive|count-3. Domyślna liczba to 1. Próg ufności można skonfigurować, dołączając znak | pionowej kreski threshold-<confidence threshold> , a następnie opcję po wartości parametru answers, na przykład extractive|threshold-0.9. Domyślny próg to 0,7. Maksymalną długość znaków w odpowiedziach można skonfigurować, dołączając znak kreski pionowej "|", po którym następuje "liczba-liczby< znaków o maksymalnej długości>", na przykład "extractive|maxcharlength-600".

Wartość Opis
none

Nie zwracaj odpowiedzi na zapytanie.
extractive

Wyodrębnia kandydatów odpowiedzi z zawartości dokumentów zwracanych w odpowiedzi na zapytanie wyrażone jako pytanie w języku naturalnym.

QueryCaptionResult

Objekt

Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu semantic.

Nazwa Typ Opis
highlights

string

Ten sam fragment tekstu, co we właściwości Text z wyróżnionymi frazami najbardziej istotnymi dla zapytania.
text

string

Reprezentatywny fragment tekstu wyodrębniony z dokumentu, który jest najbardziej istotny dla wyszukiwanego hasła.

QueryCaptionType

Wyliczenie

Ten parametr jest prawidłowy tylko wtedy, gdy typ zapytania to semantic. W przypadku ustawienia zapytanie zwraca podpisy wyodrębnione z kluczowych fragmentów w najwyżej sklasyfikowanych dokumentach. Gdy opcja Podpisy jest ustawiona na extractive, podświetlanie jest domyślnie włączone i można je skonfigurować, dołączając znak | pionowej kreski highlight-<true/false> , a następnie opcję, taką jak extractive|highlight-true. Wartość domyślna to None. Maksymalną długość znaków podpisów można skonfigurować, dołączając znak kreski pionowej "|", po którym następuje "liczba-liczby< maksymalnej długości> znaków", na przykład "extractive|maxcharlength-600".

Wartość Opis
none

Nie zwracaj podpisów zapytania.
extractive

Wyodrębnia podpisy z pasujących dokumentów, które zawierają fragmenty istotne dla zapytania wyszukiwania.

QueryDebugMode

Wyliczenie

Włącza narzędzie do debugowania, którego można użyć do dalszego eksplorowania wyników wyszukiwania. Możesz włączyć wiele trybów debugowania jednocześnie, oddzielając je znakiem | znak, na przykład: semantic|queryRewrites.

Wartość Opis
disabled

Nie zostaną zwrócone żadne informacje debugowania zapytania.
semantic

Umożliwia użytkownikowi dalsze eksplorowanie ponownie sklasyfikowanych wyników.
vector

Umożliwia użytkownikowi dalsze eksplorowanie wyników zapytania hybrydowego i wektorowego.
queryRewrites

Umożliwia użytkownikowi eksplorowanie listy ponownego zapisywania zapytań wygenerowanych dla żądania wyszukiwania.
innerHits

Umożliwia użytkownikowi pobieranie informacji o ocenianiu dotyczących wektorów dopasowanych w kolekcji typów złożonych.
all

Włącz wszystkie opcje debugowania.

QueryLanguage

Wyliczenie

Język zapytania.

Wartość Opis
none

Nie określono języka zapytania.
en-us

Wartość języka zapytania dla angielskiego (Stany Zjednoczone).
en-gb

Wartość języka zapytania dla języka angielskiego (Wielka Brytania).
en-in

Wartość języka zapytania dla języka angielskiego (Indie).
en-ca

Wartość języka zapytania dla języka angielskiego (Kanada).
en-au

Wartość języka zapytania dla języka angielskiego (Australia).
fr-fr

Wartość języka zapytania dla języka francuskiego (Francja).
fr-ca

Wartość języka zapytania dla języka francuskiego (Kanada).
de-de

Wartość języka zapytania dla języka niemieckiego (Niemcy).
es-es

Wartość języka zapytania dla języka hiszpańskiego (Hiszpania).
es-mx

Wartość języka zapytania dla języka hiszpańskiego (Meksyk).
zh-cn

Wartość języka zapytania dla języka chińskiego (Chiny).
zh-tw

Wartość języka zapytania dla języka chińskiego (Tajwan).
pt-br

Wartość języka zapytania dla języka portugalskiego (Brazylia).
pt-pt

Wartość języka zapytania dla języka portugalskiego (Portugalia).
it-it

Wartość języka zapytania dla języka włoskiego (Włochy).
ja-jp

Wartość języka zapytania dla języka japońskiego (Japonia).
ko-kr

Wartość języka zapytania dla języka koreańskiego (Korea).
ru-ru

Wartość języka zapytania dla języka rosyjskiego (Rosja).
cs-cz

Wartość języka zapytania dla języka czeskiego (Republika Czeska).
nl-be

Wartość języka zapytania dla języka niderlandzkiego (Belgia).
nl-nl

Wartość języka zapytania dla języka niderlandzkiego (Holandia).
hu-hu

Wartość języka zapytania dla języka węgierskiego (Węgry).
pl-pl

Wartość języka zapytania dla języka polskiego (Polska).
sv-se

Wartość języka zapytania dla języka szwedzkiego (Szwecja).
tr-tr

Wartość języka zapytania dla języka tureckiego (Turcja).
hi-in

Wartość języka zapytania dla języka hindi (Indie).
ar-sa

Wartość języka zapytania dla języka arabskiego (Arabia Saudyjska).
ar-eg

Wartość języka zapytania dla języka arabskiego (Egipt).
ar-ma

Wartość języka zapytania dla języka arabskiego (Maroko).
ar-kw

Wartość języka zapytania dla języka arabskiego (Kuwejt).
ar-jo

Wartość języka zapytania dla języka arabskiego (Jordania).
da-dk

Wartość języka zapytania dla języka duńskiego (Dania).
no-no

Wartość języka zapytania dla języka norweskiego (Norwegia).
bg-bg

Wartość języka zapytania dla języka bułgarskiego (Bułgaria).
hr-hr

Wartość języka zapytania dla języka chorwackiego (Chorwacja).
hr-ba

Wartość języka zapytania dla języka chorwackiego (Bośnia i Hercegowina).
ms-my

Wartość języka zapytania dla języka malajskiego (Malezja).
ms-bn

Wartość języka zapytania dla języka malajskiego (Brunei Darussalam).
sl-sl

Wartość języka zapytania dla języka słoweńskiego (Słowenia).
ta-in

Wartość języka zapytania dla języka tamilskiego (Indie).
vi-vn

Wartość języka zapytania dla języka wietnamskiego (Wietnam).
el-gr

Wartość języka zapytania dla języka greckiego (Grecja).
ro-ro

Wartość języka zapytania dla języka rumuńskiego (Rumunia).
is-is

Wartość języka zapytania dla języka islandzkiego (Islandia).
id-id

Wartość języka zapytania dla języka indonezyjskiego (Indonezja).
th-th

Wartość języka zapytania dla języka tajskiego (Tajlandia).
lt-lt

Wartość języka zapytania dla języka litewskiego (Litwa).
uk-ua

Wartość języka zapytania dla języka ukraińskiego (Ukraina).
lv-lv

Wartość języka zapytania dla języka łotewskiego (Łotwa).
et-ee

Wartość języka zapytania dla języka estońskiego (Estonia).
ca-es

Wartość języka zapytania dla języka katalońskiego.
fi-fi

Wartość języka zapytania dla języka fińskiego (Finlandia).
sr-ba

Wartość języka zapytania dla języka serbskiego (Bośnia i Hercegowina).
sr-me

Wartość języka zapytania dla języka serbskiego (Czarnogóra).
sr-rs

Wartość języka zapytania dla języka serbskiego (Serbia).
sk-sk

Wartość języka zapytania dla języka słowackiego (Słowacja).
nb-no

Wartość języka zapytania dla języka norweskiego (Norwegia).
hy-am

Wartość języka zapytania dla języka ormiańskiego (Armenia).
bn-in

Wartość języka zapytania dla języka bengalskiego (Indie).
eu-es

Wartość języka zapytania dla języka baskijskiego.
gl-es

Wartość języka zapytania dla języka galicyjskiego.
gu-in

Wartość języka zapytania dla języka gudżarati (Indie).
he-il

Wartość języka zapytania dla języka hebrajskiego (Izrael).
ga-ie

Wartość języka zapytania dla języka irlandzkiego (Irlandia).
kn-in

Wartość języka zapytania dla kannada (Indie).
ml-in

Wartość języka zapytania dla języka malajalam (Indie).
mr-in

Wartość języka zapytania dla języka marathi (Indie).
fa-ae

Wartość języka zapytania dla języka perskiego (U.A.E.).
pa-in

Wartość języka zapytania dla języka pendżabskiego (Indie).
te-in

Wartość języka zapytania dla telugu (Indie).
ur-pk

Wartość języka zapytania dla języka urdu (Pakistan).

QueryResultDocumentRerankerInput

Objekt

Nieprzetworzone ciągi, które zostały wysłane do procesu wzbogacania semantycznego.

Nazwa Typ Opis
content

string

Nieprzetworzone połączone ciągi dla pól zawartości, które zostały użyte do wzbogacania semantycznego.
keywords

string

Nieprzetworzone połączone ciągi dla pól słów kluczowych, które zostały użyte do wzbogacania semantycznego.
title

string

Nieprzetworzony ciąg dla pola tytułu, które zostało użyte do wzbogacenia semantycznego.

QueryResultDocumentSemanticField

Objekt

Opis pól, które zostały wysłane do procesu wzbogacania semantycznego, a także sposobu ich użycia

Nazwa Typ Opis
name

string

Nazwa pola, które zostało wysłane do procesu wzbogacania semantycznego
state

SemanticFieldState

Sposób, w jaki pole zostało użyte w procesie wzbogacania semantycznego (w pełni używane, częściowo używane lub nieużywane)

QueryResultDocumentSubscores

Objekt

Podział podscores między składnikami zapytania tekstowego i wektorowego dla tego dokumentu. Każde zapytanie wektorowe jest wyświetlane jako oddzielny obiekt w tej samej kolejności, w której zostały odebrane.

Nazwa Typ Opis
documentBoost

number (double)

Wynik BM25 lub klasyczny dla części tekstowej zapytania.
text

TextResult

Wynik BM25 lub klasyczny dla części tekstowej zapytania.
vectors

<string,  SingleVectorFieldResult>

Podobieństwo wektorowe i

QueryRewritesDebugInfo

Objekt

Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.

Nazwa Typ Opis
text

QueryRewritesValuesDebugInfo

Lista ponownych zapisów zapytań wygenerowanych dla zapytania tekstowego.
vectors

QueryRewritesValuesDebugInfo[]

Lista ponownych zapisów zapytań wygenerowanych dla wektoryzowalnych zapytań tekstowych.

QueryRewritesType

Wyliczenie

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.

QueryRewritesValuesDebugInfo

Objekt

Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.

Nazwa Typ Opis
inputQuery

string

Tekst wejściowy do modelu ponownego zapisywania zapytań generatywnych. Mogą wystąpić przypadki, w których zapytanie użytkownika i dane wejściowe do modelu generatywnego nie są identyczne.
rewrites

string[]

Lista ponownie zapisanych zapytań.

QuerySpellerType

Wyliczenie

Popraw kompletność wyszukiwania przez poprawianie pisowni poszczególnych terminów zapytania wyszukiwania.

Wartość Opis
none

Pisownia nie jest włączona.
lexicon

Moduł sprawdzania poprawności koryguje poszczególne terminy zapytania przy użyciu leksykonu statycznego dla języka określonego przez parametr queryLanguage.

QueryType

Wyliczenie

Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "pełna", jeśli zapytanie używa składni zapytania Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.

Wartość Opis
simple

Używa prostej składni zapytania do wyszukiwania. Wyszukiwany tekst jest interpretowany przy użyciu prostego języka zapytań, który zezwala na symbole, takie jak +, * i "". Zapytania są domyślnie oceniane we wszystkich polach z możliwością wyszukiwania, chyba że określono parametr searchFields.
full

Używa pełnej składni zapytania Lucene do wyszukiwania. Tekst wyszukiwania jest interpretowany przy użyciu języka zapytań Lucene, który umożliwia wyszukiwanie specyficzne dla pola i ważone, a także inne zaawansowane funkcje.
semantic

Najlepiej nadaje się do zapytań wyrażonych w języku naturalnym, a nie w słowach kluczowych. Zwiększa precyzję wyników wyszukiwania przez ponowne uszeregowanie najlepszych wyników wyszukiwania przy użyciu modelu klasyfikacji wytrenowanego w korpusie sieci Web.

ScoringStatistics

Wyliczenie

Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "lokalna". Użyj wartości "global", aby zagregować statystyki punktacji globalnie przed oceną. Korzystanie z globalnych statystyk punktacji może zwiększyć opóźnienie zapytań wyszukiwania.

Wartość Opis
local

Statystyki punktacji będą obliczane lokalnie w celu uzyskania mniejszego opóźnienia.
global

Statystyki punktacji będą obliczane globalnie w celu zapewnienia bardziej spójnej punktacji.

SearchDocumentsResult

Objekt

Odpowiedź zawierająca wyniki wyszukiwania z indeksu.

Nazwa Typ Opis
@odata.count

integer (int64)

Łączna liczba wyników znalezionych przez operację wyszukiwania lub wartość null, jeśli liczba nie została żądana. Jeśli istnieje, liczba może być większa niż liczba wyników w tej odpowiedzi. Może się tak zdarzyć, jeśli używasz parametrów $top lub $skip lub jeśli zapytanie nie może zwrócić wszystkich żądanych dokumentów w jednej odpowiedzi.
@odata.nextLink

string

Adres URL kontynuacji zwracany, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz użyć tego adresu URL, aby sformułować kolejne żądanie wyszukiwania GET lub POST, aby uzyskać następną część odpowiedzi wyszukiwania. Upewnij się, że używasz tego samego czasownika (GET lub POST) co żądanie, które wygenerowało tę odpowiedź.
@search.answers

QueryAnswerResult[]

Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania odpowiedzi nie został określony lub ustawiony na wartość "none".
@search.coverage

number (double)

Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimalna wartośćCoverage nie została określona w żądaniu.
@search.debug

DebugInfo

Debugowanie informacji, które mają zastosowanie do wyników wyszukiwania jako całości.
@search.facets

object

Wyniki zapytania aspektowego dla operacji wyszukiwania zorganizowane jako kolekcja zasobników dla każdego pola aspektowego; null, jeśli zapytanie nie zawiera żadnych wyrażeń aspektów.
@search.nextPageParameters

SearchRequest

Ładunek JSON kontynuacji zwracany, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz używać tego JSON-a razem z
@search.semanticPartialResponseReason

SemanticErrorReason

Przyczyna, dla której zwrócono częściową odpowiedź dla żądania klasyfikacji semantycznej.
@search.semanticPartialResponseType

SemanticSearchResultsType

Typ częściowej odpowiedzi, która została zwrócona dla żądania klasyfikacji semantycznej.
@search.semanticQueryRewritesResultType

SemanticQueryRewritesResultType

Typ ponownego zapisywania zapytania używanego do pobierania dokumentów.
value

SearchResult[]

Sekwencja wyników zwróconych przez zapytanie.

SearchMode

Wyliczenie

Określa, czy którykolwiek lub wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za zgodny.

Wartość Opis
any

Wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za pasujący.
all

Wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za pasujący.

SearchRequest

Objekt

Parametry do filtrowania, sortowania, tworzenia aspektów, stronicowania i innych zachowań zapytań wyszukiwania.

Nazwa Typ Opis
answers

QueryAnswerType

Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
captions

QueryCaptionType

Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.
count

boolean

Wartość określająca, czy pobrać łączną liczbę wyników. Wartość domyślna to „false”. Ustawienie tej wartości na wartość true może mieć wpływ na wydajność. Zwróć uwagę, że zwracana liczba jest przybliżeniem.
debug

QueryDebugMode

Włącza narzędzie do debugowania, które może być używane do dalszego eksplorowania wyników w zmienionej klasyfikacji.
facets

string[]

Lista wyrażeń aspektów, które mają być stosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po którym opcjonalnie następuje rozdzielona przecinkami lista par name:value.
filter

string

Wyrażenie $filter OData, które ma być stosowane do zapytania wyszukiwania.
highlight

string

Rozdzielona przecinkami lista nazw pól używanych do wyróżniania trafień. Do wyróżniania trafień można używać tylko pól z możliwością wyszukiwania.
highlightPostTag

string

Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. Wartość domyślna to </em>.
highlightPreTag

string

Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Wartość domyślna to <>.
hybridSearch

HybridSearch

Parametry zapytania do konfigurowania zachowań wyszukiwania hybrydowego.
minimumCoverage

number (double)

Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem wyszukiwania w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 100.
orderby

string

Rozdzielona przecinkami lista wyrażeń OData $orderby, według których mają być sortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazując malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowania dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
queryLanguage

QueryLanguage

Wartość określająca język wyszukiwanego zapytania.
queryRewrites

QueryRewritesType

Wartość określająca, czy powinno być generowane ponowne zapisywanie zapytania w celu rozszerzenia zapytania wyszukiwania.
queryType

QueryType

Wartość określająca składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj ciągu "full", jeśli zapytanie używa składni zapytania Lucene.
scoringParameters

string[]

Lista wartości parametrów, które mają być używane w funkcjach oceniania (na przykład referencePointParameter) przy użyciu formatu name-values. Jeśli na przykład profil oceniania definiuje funkcję z parametrem o nazwie "mylocation", ciąg parametru to "mylocation--122.2,44.8" (bez cudzysłowów).
scoringProfile

string

Nazwa profilu oceniania do oceny wyników dla pasujących dokumentów w celu sortowania wyników.
scoringStatistics

ScoringStatistics

Wartość określająca, czy chcemy obliczyć statystyki oceniania (takie jak częstotliwość dokumentu) globalnie w celu uzyskania bardziej spójnego oceniania lub lokalnie w celu uzyskania mniejszego opóźnienia. Wartość domyślna to "lokalna". Użyj wartości "global", aby zagregować statystyki punktacji globalnie przed oceną. Korzystanie z globalnych statystyk punktacji może zwiększyć opóźnienie zapytań wyszukiwania.
search

string

Wyrażenie zapytania wyszukiwania pełnotekstowego; Użyj "*" lub pomiń ten parametr, aby dopasować wszystkie dokumenty.
searchFields

string

Rozdzielona przecinkami lista nazw pól, do których ma być objęte wyszukiwanie pełnotekstowe. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania pól mają pierwszeństwo przed wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode

SearchMode

Wartość określająca, czy dowolne lub wszystkie terminy wyszukiwania muszą być dopasowane w celu zliczenia dokumentu jako dopasowania.
select

string

Rozdzielona przecinkami lista pól do pobrania. W przypadku nieokreślonego dołączono wszystkie pola oznaczone jako możliwe do pobrania w schemacie.
semanticConfiguration

string

Nazwa konfiguracji semantycznej, która będzie używana podczas przetwarzania dokumentów dla zapytań typu semantycznego.
semanticErrorHandling

SemanticErrorMode

Umożliwia użytkownikowi wybór, czy wywołanie semantyczne powinno zakończyć się całkowitym niepowodzeniem (zachowanie domyślne / bieżące), czy też zwrócić częściowe wyniki.
semanticFields

string

Rozdzielona przecinkami lista nazw pól używanych do klasyfikacji semantycznej.
semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Umożliwia użytkownikowi ustawienie górnej granicy czasu potrzebnego na zakończenie przetwarzania wzbogacania semantycznego przed zakończeniem żądania niepowodzeniem.
semanticQuery

string

Umożliwia ustawienie osobnego zapytania wyszukiwania, które będzie używane wyłącznie do zmiany klasyfikacji semantycznej, podpisów semantycznych i odpowiedzi semantycznych. Jest to przydatne w scenariuszach, w których istnieje potrzeba użycia różnych zapytań między fazą pobierania i klasyfikowania bazy a fazą semantyczną L2.
sessionId

string

Wartość, która ma być używana do tworzenia sesji trwałej, co może pomóc w uzyskaniu bardziej spójnych wyników. Tak długo, jak jest używany ten sam identyfikator sessionId, zostanie podjęta najlepsza próba ukierunkowana na ten sam zestaw replik. Należy się uważać, że ponowne użycie tych samych wartości sessionID wielokrotnie może zakłócać równoważenie obciążenia żądań między replikami i niekorzystnie wpływać na wydajność usługi wyszukiwania. Wartość używana jako sessionId nie może rozpoczynać się od znaku "_".
skip

integer (int32)

Liczba wyników wyszukiwania do pominięcia. Ta wartość nie może być większa niż 100 000. Jeśli musisz skanować dokumenty w sekwencji, ale nie można użyć pominięcia z powodu tego ograniczenia, rozważ użycie kolejności na całkowicie uporządkowanym kluczu i filtru z zapytaniem zakresu.
speller

QuerySpellerType

Wartość określająca typ literowca, którego należy użyć do poprawy poszczególnych zapytań wyszukiwania.
top

integer (int32)

Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania po stronie klienta wyników wyszukiwania. Jeśli wyniki zostaną obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, który może służyć do wystawiania innego żądania wyszukiwania dla następnej strony wyników.
vectorFilterMode

VectorFilterMode

Określa, czy filtry są stosowane przed czy po przeprowadzeniu wyszukiwania wektorowego. Wartość domyślna to "preFilter" dla nowych indeksów.
vectorQueries VectorQuery[]:

Parametry zapytania dla wektorów i zapytań wyszukiwania hybrydowego.

SearchResult

Objekt

Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.

Nazwa Typ Opis
@search.captions

QueryCaptionResult[]

Podpisy są najbardziej reprezentatywnymi fragmentami z dokumentu stosunkowo do zapytania wyszukiwania. Są one często używane jako podsumowanie dokumentu. Podpisy są zwracane tylko w przypadku zapytań typu "semantyczne".
@search.documentDebugInfo

DocumentDebugInfo

Zawiera informacje debugowania, których można użyć do dalszego eksplorowania wyników wyszukiwania.
@search.highlights

object

Fragmenty tekstu z dokumentu, które wskazują pasujące terminy wyszukiwania, uporządkowane według każdego odpowiedniego pola; null, jeśli wyróżnianie trafień nie było włączone dla zapytania.
@search.rerankerBoostedScore

number (double)

Ocena trafności obliczana przez zwiększenie wyniku Rerankera. Wyniki wyszukiwania są posortowane według RerankerScore/RerankerBoostedScore na podstawie useScoringProfileBoostedRanking w konfiguracji semantycznej. RerankerBoostedScore zwraca się tylko dla zapytań typu 'semantyczne'.
@search.rerankerScore

number (double)

Wynik trafności obliczony przez klasyfikację semantyczną dla najlepszych wyników wyszukiwania. Wyniki wyszukiwania są sortowane najpierw według RerankerScore, a następnie według Score. RerankerScore jest zwracany tylko dla zapytań typu "semantic".
@search.score

number (double)

Ocena istotności dokumentu w porównaniu z innymi dokumentami zwracanymi przez zapytanie.

SearchScoreThreshold

Objekt

Wyniki zapytania wektorowego będą filtrowane na podstawie '

Nazwa Typ Opis
kind string:

searchScore

Rodzaj progu.
value

number (double)

Próg będzie filtrowany na podstawie '

SemanticDebugInfo

Objekt

Zawiera informacje debugowania specyficzne dla żądań klasyfikacji semantycznej.

Nazwa Typ Opis
contentFields

QueryResultDocumentSemanticField[]

Pola zawartości, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia
keywordFields

QueryResultDocumentSemanticField[]

Pola słów kluczowych, które zostały wysłane do procesu wzbogacania semantycznego, a także sposób ich użycia
rerankerInput

QueryResultDocumentRerankerInput

Nieprzetworzone ciągi, które zostały wysłane do procesu wzbogacania semantycznego.
titleField

QueryResultDocumentSemanticField

Pole tytułu, które zostało wysłane do procesu wzbogacania semantycznego, a także sposób jego użycia

SemanticErrorMode

Wyliczenie

Pozwala użytkownikowi wybrać, czy wywołanie semantyczne powinno całkowicie zawiódć, czy też zwrócić częściowe wyniki.

Wartość Opis
partial

Jeśli przetwarzanie semantyczne zakończy się niepowodzeniem, wyniki częściowe nadal będą zwracane. Definicja wyników cząstkowych zależy od tego, który krok semantyczny nie powiódł się i co było przyczyną niepowodzenia.
fail

Jeśli podczas kroku przetwarzania semantycznego wystąpi wyjątek, zapytanie zakończy się niepowodzeniem i zwróci odpowiedni kod HTTP w zależności od błędu.

SemanticErrorReason

Wyliczenie

Przyczyna, dla której zwrócono częściową odpowiedź dla żądania klasyfikacji semantycznej.

Wartość Opis
maxWaitExceeded

Jeśli semanticMaxWaitInMilliseconds została ustawiona, a czas przetwarzania semantycznego przekroczył tę wartość. Zwrócone zostały tylko wyniki podstawowe.
capacityOverloaded

Żądanie zostało ograniczone. Zwrócone zostały tylko wyniki podstawowe.
transient

Co najmniej jeden krok procesu semantycznego nie powiódł się.

SemanticFieldState

Wyliczenie

Sposób, w jaki pole było wykorzystywane do procesu wzbogacania semantycznego.

Wartość Opis
used

Pole zostało w pełni wykorzystane do wzbogacenia semantycznego.
unused

Pole nie zostało wykorzystane do wzbogacenia semantycznego.
partial

Pole zostało częściowo wykorzystane do wzbogacenia semantycznego.

SemanticQueryRewritesResultType

Wyliczenie

Typ ponownego zapisywania zapytania, które zostało użyte dla tego żądania.

Wartość Opis
originalQueryOnly

Ponowne zapisywanie zapytań nie zostało pomyślnie wygenerowane dla tego żądania. Tylko oryginalne zapytanie zostało użyte do pobrania wyników.

SemanticSearchResultsType

Wyliczenie

Typ częściowej odpowiedzi, która została zwrócona dla żądania klasyfikacji semantycznej.

Wartość Opis
baseResults

Wyniki bez wzbogacania semantycznego lub ponownego klasyfikowania.
rerankedResults

Wyniki zostały ponownie sklasyfikowane za pomocą modelu rerankera i będą zawierać podpisy semantyczne. Nie będą one zawierać żadnych odpowiedzi, wyróżnień odpowiedzi ani wyróżnień podpisów.

SingleVectorFieldResult

Objekt

Wynik pojedynczego pola wektorowego. Both

Nazwa Typ Opis
searchScore

number (double)

Ten
vectorSimilarity

number (double)

Wynik podobieństwa wektorowego dla tego dokumentu. Należy pamiętać, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Na przykład podobieństwo cosinusowe zamiast odległości cosinusowej.

TextResult

Objekt

Wynik BM25 lub klasyczny dla części tekstowej zapytania.

Nazwa Typ Opis
searchScore

number (double)

Wynik BM25 lub klasyczny dla części tekstowej zapytania.

VectorFilterMode

Wyliczenie

Określa, czy filtry są stosowane przed czy po przeprowadzeniu wyszukiwania wektorowego.

Wartość Opis
postFilter

Filtr zostanie zastosowany po zwróceniu kandydującego zestawu wyników wektora. W zależności od selektywności filtra może to skutkować mniejszą liczbą wyników niż żąda tego parametr "k".
preFilter

Filtr zostanie zastosowany przed zapytaniem wyszukiwania.
strictPostFilter

Filtr zostanie zastosowany po zwróceniu globalnego zestawu wyników wektorowych najwyższego k kandydatów. Spowoduje to uzyskanie mniejszej liczby wyników niż żąda parametr "k".

VectorizableImageBinaryQuery

Objekt

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.

Nazwa 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:

imageBinary

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

Objekt

Parametry zapytania do użycia do wyszukiwania wektorowego, gdy podano adres URL reprezentujący wartość obrazu, która musi być wektoryzowana.

Nazwa 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:

imageUrl

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

Objekt

Parametry zapytania do użycia do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.

Nazwa 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

QueryRewritesType

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

Objekt

Parametry zapytania do użycia do wyszukiwania wektorów po podaniu nieprzetworzonej wartości wektora.

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

Wyliczenie

Rodzaj wykonywanego zapytania wektorowego.

Wartość Opis
vector

Zapytanie wektorowe, w którym podana jest nieprzetworzona wartość wektorowa.
text

Zapytanie wektorowe, w którym podana jest 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.

VectorsDebugInfo

Objekt

"Zawiera informacje o debugowaniu specyficzne dla wyszukiwania wektorowego i hybrydowego.")

Nazwa Typ Opis
subscores

QueryResultDocumentSubscores

Podział wyników cząstkowych dokumentu przed wybraną metodą łączenia/łączenia zestawu wyników, taką jak RRF.

VectorSimilarityThreshold

Objekt

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.

Nazwa Typ Opis
kind string:

vectorSimilarity

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

Wyliczenie

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.