Documents - Search Post

Usługa:: Search Service

Wersja interfejsu API:: 2025-08-01-preview

Wyszukuje dokumenty w indeksie.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string (uuid)	Identyfikator śledzenia wysłany z żądaniem, aby pomóc w debugowaniu.
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.

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 ma zostać pobrana łączna liczba wyników. Wartość domyślna to „false”. Ustawienie tej wartości na true może mieć wpływ na wydajność. Należy pamiętać, że zwrócona liczba jest przybliżona.
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ń aspektu, które mają zostać zastosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po której opcjonalnie następuje rozdzielana przecinkami lista par nazwa:wartość.
filter	string	Wyrażenie OData $filter, które ma zostać zastosowane do zapytania wyszukiwania.
highlight	string	Rozdzielona przecinkami lista nazw pól, które mają być używane do wyróżniania trafień. Tylko pola, które można przeszukiwać, mogą być używane do wyróżniania trafień.
highlightPostTag	string	Znacznik ciągu, który jest dołączany w celu przeznaczenia trafień. Musi być ustawiony za pomocą highlightPreTag. Wartość domyślna to </em>.
highlightPreTag	string	Znacznik ciągu, który jest poprzedzany w celu trafienia w podświetlenia. Musi być ustawiony za pomocą highlightPostTag. Wartość domyślna to <em>.
hybridSearch	HybridSearch	Parametry zapytania służące do konfigurowania zachowań wyszukiwania hybrydowego.
minimumCoverage	number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać pokryty przez kwerendę wyszukiwania, aby kwerenda została zgłoszona jako powodzenie. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet w przypadku 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że następować asc, aby wskazać rosnąco, lub desc, aby wskazać malejąco. Wartość domyślna to kolejność rosnąca. Remisy zostaną rozstrzygnięte na podstawie wyników meczów w dokumentach. Jeśli nie zostanie określona żadna $orderby, domyślna kolejność sortowania jest malejąca według wyniku dopasowania dokumentu. Klauzule $orderby mogą składać się z maksymalnie 32.
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ę wyszukiwanego zapytania. Wartość domyślna to "simple". Użyj wartości "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 "mojalokalizacja", ciąg parametru będzie miał postać "mojalokalizacja--122,2,44,8" (bez cudzysłowów).
scoringProfile	string	Nazwa profilu oceniania służącego do oceniania wyników dopasowania dla pasujących dokumentów w celu sortowania wyników.
scoringStatistics	ScoringStatistics	Wartość określająca, czy chcemy obliczać statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania, czy lokalnie, w celu zmniejszenia 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ć stosowany zakres wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania w polu mają pierwszeństwo przed wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode	SearchMode	Wartość określająca, czy którykolwiek lub wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za zgodny.
select	string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określony, zostaną uwzględnione 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 używany jest ten sam identyfikator sessionId, zostanie podjęta najlepsza próba kierowania tego samego zestawu replik. Należy pamiętać, że wielokrotne używanie tych samych wartości sessionID 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 zaczynać 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 chcesz skanować dokumenty w sekwencji, ale nie możesz użyć opcji pomijania ze względu na to ograniczenie, rozważ użycie orderby dla klucza całkowicie uporządkowanego i filtrowanie za pomocą zapytania zakresu.
speller	QuerySpellerType	Wartość określająca typ modułu sprawdzania pisowni, który ma być używany do poprawiania pisowni poszczególnych terminów wyszukiwanego hasła.
top	integer (int32)	Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki zostaną obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, którego można użyć do wystawienia kolejnego żą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[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	Parametry zapytania dla zapytań wyszukiwania wektorowego i hybrydowego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchDocumentsResult	Odpowiedź zawierająca dokumenty spełniające kryteria wyszukiwania.
Other Status Codes	SearchDocumentsResult	Odpowiedź zawierająca częściowe dokumenty spełniające kryteria wyszukiwania.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Przykładowe żądanie

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2025-08-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

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-08-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
AnswerResult	Odpowiedź to fragment tekstu wyodrębniony z zawartości najistotniejszych dokumentów, które pasowały do zapytania. Odpowiedzi są wyodrębniane z najlepszych wyników wyszukiwania. Kandydaci do odpowiedzi są oceniani, a najlepsze odpowiedzi są wybierane.
CaptionResult	Podpisy są najbardziej reprezentatywnymi fragmentami dokumentu w stosunku do wyszukiwanego zapytania. Są one często używane jako podsumowanie dokumentów. Podpisy są zwracane tylko dla zapytań typu `semantic`.
DebugInfo	Zawiera informacje debugowania, które można wykorzystać do dalszego eksplorowania wyników wyszukiwania.
DocumentDebugInfo	Zawiera informacje debugowania, które można wykorzystać do dalszego eksplorowania wyników wyszukiwania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
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.
QueryAnswerType	Wartość określająca, czy odpowiedzi powinny być zwracane w ramach odpowiedzi wyszukiwania.
QueryCaptionType	Wartość określająca, czy podpisy powinny być zwracane w ramach odpowiedzi wyszukiwania.
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 połączone 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 sposób ich użycia
QueryResultDocumentSubscores	Podział wyników cząstkowych między składnikami zapytania tekstowego i wektorowego zapytania wyszukiwania dla tego dokumentu. Każde zapytanie wektorowe jest wyświetlane jako osobny obiekt w tej samej kolejności, w jakiej zostały odebrane.
QueryRewritesDebugInfo	Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.
QueryRewritesType	Wartość określająca, czy powinno być generowane ponowne zapisywanie zapytania w celu rozszerzenia zapytania wyszukiwania.
QueryRewritesValuesDebugInfo	Zawiera informacje debugowania specyficzne dla ponownego zapisywania zapytań.
QuerySpellerType	Wartość określająca typ modułu sprawdzania pisowni, który ma być używany do poprawiania pisowni poszczególnych terminów wyszukiwanego hasła.
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.
RawVectorQuery	Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy zostanie podana nieprzetworzona wartość wektorowa.
ScoringStatistics	Wartość określająca, czy chcemy obliczać statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania, czy lokalnie, w celu zmniejszenia 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 filtrowania, sortowania, aspektowania, 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 wartości "@search.score". Należy pamiętać, że jest to wartość @search.score zwracana w ramach odpowiedzi wyszukiwania. Kierunek progu zostanie wybrany na wyższy @search.score.
SemanticDebugInfo
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.
SemanticErrorReason	Przyczyna, dla której zwrócono częściową odpowiedź dla żądania klasyfikacji semantycznej.
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)
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 z pojedynczego pola wektorowego. Zwracane są zarówno wartości podobieństwa wektorów, jak @search.score i wartości wektora. Podobieństwo wektorowe jest powiązane @search.score równaniem.
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 podano plik binarny zakodowany w formacie podstawowym 64 obrazu, który musi być wektoryzowany.
VectorizableImageUrlQuery	Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy zostanie podany adres URL reprezentujący wartość obrazu, która musi zostać zwektoryzowana.
VectorizableTextQuery	Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy zostanie podana wartość tekstowa, która musi zostać wektoryzowana.
VectorQueryKind	Rodzaj wykonywanego zapytania wektorowego.
VectorsDebugInfo
VectorSimilarityThreshold	Wyniki zapytania wektorowego zostaną przefiltrowane na podstawie metryki podobieństwa wektora. Zauważ, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryką używaną przez pole.
VectorThresholdKind	Rodzaj wykonywanego zapytania wektorowego.

AnswerResult

Objekt

Odpowiedź to fragment tekstu wyodrębniony z zawartości najistotniejszych dokumentów, które pasowały do zapytania. Odpowiedzi są wyodrębniane z najlepszych wyników wyszukiwania. Kandydaci do odpowiedzi są oceniani, a najlepsze odpowiedzi są wybierane.

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

CaptionResult

Objekt

Podpisy są najbardziej reprezentatywnymi fragmentami dokumentu w stosunku do wyszukiwanego zapytania. Są one często używane jako podsumowanie dokumentów. Podpisy są zwracane tylko dla 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.

DebugInfo

Objekt

Zawiera informacje debugowania, które można wykorzystać 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óre można wykorzystać 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	object	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

Odpowiedź na błąd

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.

QueryAnswerType

Wyliczenie

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

Wartość	Opis
none	Nie zwracaj odpowiedzi na zapytanie.
extractive	Wyodrębnia kandydatów do odpowiedzi z treści dokumentów zwróconych w odpowiedzi na zapytanie wyrażone jako pytanie w języku naturalnym.

QueryCaptionType

Wyliczenie

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

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	Pozwala użytkownikowi na dalsze przeglądanie wyników w zmienionej klasyfikacji.
vector	Umożliwia użytkownikowi dalsze eksplorowanie wyników zapytań hybrydowych i wektorowych.
queryRewrites	Umożliwia użytkownikowi eksplorowanie listy ponownych zapisów 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 języka 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 połączone 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 sposób 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ł wyników cząstkowych między składnikami zapytania tekstowego i wektorowego zapytania wyszukiwania dla tego dokumentu. Każde zapytanie wektorowe jest wyświetlane jako osobny obiekt w tej samej kolejności, w jakiej 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 @search.score wartości dla każdego zapytania wektorowego.

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

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

Wartość	Opis
none	Nie generuj dodatkowych ponownych zapisów zapytań dla tego zapytania.
generative	Generuj alternatywne terminy zapytania, aby zwiększyć liczbę odwołań żą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

Wartość określająca typ modułu sprawdzania pisowni, który ma być używany do poprawiania pisowni poszczególnych terminów wyszukiwanego hasła.

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.

RawVectorQuery

Objekt

Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy zostanie podana nieprzetworzona wartość wektorowa.

Nazwa	Typ	Opis
exhaustive	boolean	W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k-najbliższego sąsiada we wszystkich wektorach w indeksie wektora. Przydatne w scenariuszach, w których dokładne dopasowania mają kluczowe znaczenie, takie jak określanie wartości prawdy podstawowej.
fields	string	Pola wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze.
filterOverride	string	Wyrażenie filtru OData, które ma zostać zastosowane do tego konkretnego zapytania wektorowego. Jeśli na poziomie wektora nie zdefiniowano żadnego wyrażenia filtru, zamiast niego używane jest wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu.
k	integer (int32)	Liczba najbliższych sąsiadów, którzy mają zostać zwróconi jako najczęstsze trafienia.
kind	string: vector	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	Współczynnik nadpró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 odniesieniu do bazowego pola wektora.
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: SearchScoreThreshold VectorSimilarityThreshold	Próg używany dla zapytań wektorowych. Pamiętaj, że można to ustawić tylko wtedy, gdy wszystkie "pola" używają tego samego wskaźnika podobieństwa.
vector	number[] (float)	Wektorowa reprezentacja zapytania wyszukiwania.
weight	number (float)	Względna waga zapytania wektorowego w porównaniu z innymi zapytaniami wektorowymi i/lub zapytaniami tekstowymi w tym samym żądaniu wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list klasyfikacyjnych utworzonych przez różne zapytania wektorowe i/lub wyników pobranych za pomocą kwerendy tekstowej. Im wyższa waga, tym wyżej w końcowej klasyfikacji znajdą się dokumenty pasujące do tego zapytania. Wartość domyślna to 1,0, a wartość musi być liczbą dodatnią większą od zera.

ScoringStatistics

Wyliczenie

Wartość określająca, czy chcemy obliczać statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania, czy lokalnie, w celu zmniejszenia 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 zażądana. Jeśli jest obecna, 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	AnswerResult[]	Wyniki zapytania odpowiedzi dla operacji wyszukiwania; null, jeśli parametr zapytania answers nie został określony lub ustawiony na wartość "none".
@search.coverage	number (double)	Wartość wskazująca procent indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli minimumCoverage nie został określony 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ło żadnych wyrażeń aspektu.
@search.nextPageParameters	SearchRequest	Ładunek JSON kontynuacji zwracany, gdy zapytanie nie może zwrócić wszystkich żądanych wyników w jednej odpowiedzi. Możesz użyć tego kodu JSON wraz z @odata.nextLink , aby sformułować kolejne żądanie wyszukiwania POST, aby uzyskać następną część odpowiedzi wyszukiwania.
@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, które zostało użyte do pobrania dokumentów.
value	SearchResult[]	Sekwencja wyników zwracanych 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 filtrowania, sortowania, aspektowania, 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 ma zostać pobrana łączna liczba wyników. Wartość domyślna to „false”. Ustawienie tej wartości na true może mieć wpływ na wydajność. Należy pamiętać, że zwrócona liczba jest przybliżona.
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ń aspektu, które mają zostać zastosowane do zapytania wyszukiwania. Każde wyrażenie aspektu zawiera nazwę pola, po której opcjonalnie następuje rozdzielana przecinkami lista par nazwa:wartość.
filter	string	Wyrażenie OData $filter, które ma zostać zastosowane do zapytania wyszukiwania.
highlight	string	Rozdzielona przecinkami lista nazw pól, które mają być używane do wyróżniania trafień. Tylko pola, które można przeszukiwać, mogą być używane do wyróżniania trafień.
highlightPostTag	string	Znacznik ciągu, który jest dołączany w celu przeznaczenia trafień. Musi być ustawiony za pomocą highlightPreTag. Wartość domyślna to </em>.
highlightPreTag	string	Znacznik ciągu, który jest poprzedzany w celu trafienia w podświetlenia. Musi być ustawiony za pomocą highlightPostTag. Wartość domyślna to <em>.
hybridSearch	HybridSearch	Parametry zapytania służące do konfigurowania zachowań wyszukiwania hybrydowego.
minimumCoverage	number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać pokryty przez kwerendę wyszukiwania, aby kwerenda została zgłoszona jako powodzenie. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet w przypadku 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że następować asc, aby wskazać rosnąco, lub desc, aby wskazać malejąco. Wartość domyślna to kolejność rosnąca. Remisy zostaną rozstrzygnięte na podstawie wyników meczów w dokumentach. Jeśli nie zostanie określona żadna $orderby, domyślna kolejność sortowania jest malejąca według wyniku dopasowania dokumentu. Klauzule $orderby mogą składać się z maksymalnie 32.
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ę wyszukiwanego zapytania. Wartość domyślna to "simple". Użyj wartości "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 "mojalokalizacja", ciąg parametru będzie miał postać "mojalokalizacja--122,2,44,8" (bez cudzysłowów).
scoringProfile	string	Nazwa profilu oceniania służącego do oceniania wyników dopasowania dla pasujących dokumentów w celu sortowania wyników.
scoringStatistics	ScoringStatistics	Wartość określająca, czy chcemy obliczać statystyki oceniania (takie jak częstotliwość dokumentów) globalnie w celu uzyskania bardziej spójnego oceniania, czy lokalnie, w celu zmniejszenia 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ć stosowany zakres wyszukiwania pełnotekstowego. W przypadku korzystania z wyszukiwania w polu (fieldName:searchExpression) w pełnym zapytaniu Lucene nazwy pól każdego wyrażenia wyszukiwania w polu mają pierwszeństwo przed wszystkimi nazwami pól wymienionymi w tym parametrze.
searchMode	SearchMode	Wartość określająca, czy którykolwiek lub wszystkie wyszukiwane terminy muszą być dopasowane, aby dokument został uznany za zgodny.
select	string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określony, zostaną uwzględnione 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 używany jest ten sam identyfikator sessionId, zostanie podjęta najlepsza próba kierowania tego samego zestawu replik. Należy pamiętać, że wielokrotne używanie tych samych wartości sessionID 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 zaczynać 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 chcesz skanować dokumenty w sekwencji, ale nie możesz użyć opcji pomijania ze względu na to ograniczenie, rozważ użycie orderby dla klucza całkowicie uporządkowanego i filtrowanie za pomocą zapytania zakresu.
speller	QuerySpellerType	Wartość określająca typ modułu sprawdzania pisowni, który ma być używany do poprawiania pisowni poszczególnych terminów wyszukiwanego hasła.
top	integer (int32)	Liczba wyników wyszukiwania do pobrania. Może to być używane w połączeniu z $skip do implementowania stronicowania wyników wyszukiwania po stronie klienta. Jeśli wyniki zostaną obcięte z powodu stronicowania po stronie serwera, odpowiedź będzie zawierać token kontynuacji, którego można użyć do wystawienia kolejnego żą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[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	Parametry zapytania dla zapytań wyszukiwania wektorowego i hybrydowego.

SearchResult

Objekt

Zawiera dokument znaleziony przez zapytanie wyszukiwania oraz skojarzone metadane.

Nazwa	Typ	Opis
@search.captions	CaptionResult[]	Podpisy są najbardziej reprezentatywnymi fragmentami dokumentu w stosunku do wyszukiwanego zapytania. Są one często używane jako podsumowanie dokumentów. Podpisy są zwracane tylko w przypadku zapytań typu "semantyczne".
@search.documentDebugInfo	DocumentDebugInfo	Zawiera informacje debugowania, które można wykorzystać 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ą sortowane według RerankerScore/RerankerBoostedScore na podstawie useScoringProfileBoostedRanking w konfiguracji semantycznej. RerankerBoostedScore jest zwracany tylko dla zapytań typu "semantic"
@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 wartości "@search.score". Należy pamiętać, że jest to wartość @search.score zwracana w ramach odpowiedzi wyszukiwania. Kierunek progu zostanie wybrany na wyższy @search.score.

Nazwa	Typ	Opis
kind	string: searchScore	Rodzaj progu używanego do filtrowania zapytań wektorowych
value	number (double)	Próg będzie filtrowany na podstawie wartości "@search.score". Należy pamiętać, że jest to wartość @search.score zwracana w ramach odpowiedzi wyszukiwania. Kierunek progu zostanie wybrany na wyższy @search.score.

SemanticDebugInfo

Objekt

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 połączone 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

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.

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 zostało użyte w procesie wzbogacania semantycznego (w pełni używane, częściowo używane lub nieużywane)

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. Do pobrania wyników użyto tylko oryginalnego zapytania.

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 z pojedynczego pola wektorowego. Zwracane są zarówno wartości podobieństwa wektorów, jak @search.score i wartości wektora. Podobieństwo wektorowe jest powiązane @search.score równaniem.

Nazwa	Typ	Opis
searchScore	number (double)	Wartość @search.score obliczana na podstawie wyniku podobieństwa wektora. Jest to wynik, który jest widoczny w zapytaniu jednowektorowym z czystym pojedynczym polem.
vectorSimilarity	number (double)	Wynik podobieństwa wektorowego dla tego dokumentu. Zauważ, ż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 podano plik binarny zakodowany w formacie podstawowym 64 obrazu, który musi być 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ższego sąsiada we wszystkich wektorach w indeksie wektora. Przydatne w scenariuszach, w których dokładne dopasowania mają kluczowe znaczenie, takie jak określanie wartości prawdy podstawowej.
fields	string	Pola wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze.
filterOverride	string	Wyrażenie filtru OData, które ma zostać zastosowane do tego konkretnego zapytania wektorowego. Jeśli na poziomie wektora nie zdefiniowano żadnego wyrażenia filtru, zamiast niego używane jest wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu.
k	integer (int32)	Liczba najbliższych sąsiadów, którzy mają zostać zwróconi jako najczęstsze trafienia.
kind	string: imageBinary	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	Współczynnik nadpró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 odniesieniu do bazowego pola wektora.
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: SearchScoreThreshold VectorSimilarityThreshold	Próg używany dla zapytań wektorowych. Pamiętaj, że można to ustawić tylko wtedy, gdy wszystkie "pola" używają tego samego wskaźnika podobieństwa.
weight	number (float)	Względna waga zapytania wektorowego w porównaniu z innymi zapytaniami wektorowymi i/lub zapytaniami tekstowymi w tym samym żądaniu wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list klasyfikacyjnych utworzonych przez różne zapytania wektorowe i/lub wyników pobranych za pomocą kwerendy tekstowej. Im wyższa waga, tym wyżej w końcowej klasyfikacji znajdą się dokumenty pasujące do tego zapytania. Wartość domyślna to 1,0, a wartość musi być liczbą dodatnią większą od zera.

VectorizableImageUrlQuery

Objekt

Parametry zapytania, które mają być używane do wyszukiwania wektorowego, gdy zostanie podany adres URL reprezentujący wartość obrazu, która musi zostać zwektoryzowana.

Nazwa	Typ	Opis
exhaustive	boolean	W przypadku wartości true wyzwala wyczerpujące wyszukiwanie k-najbliższego sąsiada we wszystkich wektorach w indeksie wektora. Przydatne w scenariuszach, w których dokładne dopasowania mają kluczowe znaczenie, takie jak określanie wartości prawdy podstawowej.
fields	string	Pola wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze.
filterOverride	string	Wyrażenie filtru OData, które ma zostać zastosowane do tego konkretnego zapytania wektorowego. Jeśli na poziomie wektora nie zdefiniowano żadnego wyrażenia filtru, zamiast niego używane jest wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu.
k	integer (int32)	Liczba najbliższych sąsiadów, którzy mają zostać zwróconi jako najczęstsze trafienia.
kind	string: imageUrl	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	Współczynnik nadpró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 odniesieniu do bazowego pola wektora.
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: SearchScoreThreshold VectorSimilarityThreshold	Próg używany dla zapytań wektorowych. Pamiętaj, że można to ustawić tylko wtedy, gdy wszystkie "pola" używają tego samego wskaźnika podobieństwa.
url	string	Adres URL obrazu, który ma zostać zwektoryzowany w celu wykonania zapytania wyszukiwania wektorowego.
weight	number (float)	Względna waga zapytania wektorowego w porównaniu z innymi zapytaniami wektorowymi i/lub zapytaniami tekstowymi w tym samym żądaniu wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list klasyfikacyjnych utworzonych przez różne zapytania wektorowe i/lub wyników pobranych za pomocą kwerendy tekstowej. Im wyższa waga, tym wyżej w końcowej klasyfikacji znajdą się dokumenty pasujące do tego zapytania. Wartość domyślna to 1,0, a wartość musi być liczbą dodatnią większą od zera.

VectorizableTextQuery

Objekt

Parametry zapytania, które mają być używane 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ższego sąsiada we wszystkich wektorach w indeksie wektora. Przydatne w scenariuszach, w których dokładne dopasowania mają kluczowe znaczenie, takie jak określanie wartości prawdy podstawowej.
fields	string	Pola wektorowe typu Collection(Edm.Single), które mają zostać uwzględnione w wyszukiwanym wektorze.
filterOverride	string	Wyrażenie filtru OData, które ma zostać zastosowane do tego konkretnego zapytania wektorowego. Jeśli na poziomie wektora nie zdefiniowano żadnego wyrażenia filtru, zamiast niego używane jest wyrażenie zdefiniowane w parametrze filtru najwyższego poziomu.
k	integer (int32)	Liczba najbliższych sąsiadów, którzy mają zostać zwróconi jako najczęstsze trafienia.
kind	string: text	Rodzaj wykonywanego zapytania wektorowego.
oversampling	number (double)	Współczynnik nadpró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 odniesieniu do bazowego pola wektora.
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 generatywnemu ponowne zapisanie zapytania przed wysłaniem go do wektoryzacji.
text	string	Tekst, który ma zostać zwektoryzowany w celu wykonania zapytania wyszukiwania wektorowego.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	Próg używany dla zapytań wektorowych. Pamiętaj, że można to ustawić tylko wtedy, gdy wszystkie "pola" używają tego samego wskaźnika podobieństwa.
weight	number (float)	Względna waga zapytania wektorowego w porównaniu z innymi zapytaniami wektorowymi i/lub zapytaniami tekstowymi w tym samym żądaniu wyszukiwania. Ta wartość jest używana podczas łączenia wyników wielu list klasyfikacyjnych utworzonych przez różne zapytania wektorowe i/lub wyników pobranych za pomocą kwerendy tekstowej. Im wyższa waga, tym wyżej w końcowej klasyfikacji znajdą się dokumenty pasujące do tego zapytania. Wartość domyślna to 1,0, a wartość musi być liczbą dodatnią większą od zera.

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

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 zostaną przefiltrowane na podstawie metryki podobieństwa wektora. Zauważ, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryką używaną przez pole.

Nazwa	Typ	Opis
kind	string: vectorSimilarity	Rodzaj progu używanego do filtrowania zapytań wektorowych
value	number (double)	Próg będzie filtrowany na podstawie wartości metryki podobieństwa. Zauważ, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryką używaną przez pole.

VectorThresholdKind

Wyliczenie

Rodzaj wykonywanego zapytania wektorowego.

Wartość	Opis
vectorSimilarity	Wyniki zapytania wektorowego zostaną przefiltrowane na podstawie metryki podobieństwa wektora. Zauważ, że jest to kanoniczna definicja metryki podobieństwa, a nie wersja "odległość". Kierunek progu (większy lub mniejszy) zostanie wybrany automatycznie zgodnie z metryką używaną przez pole.
searchScore	Wyniki zapytania wektorowego będą filtrowane na podstawie wartości "@search.score". Należy pamiętać, że jest to wartość @search.score zwracana w ramach odpowiedzi wyszukiwania. Kierunek progu zostanie wybrany na wyższy @search.score.