Documents - Search Post

Usługa:: Search Service

Wersja interfejsu API:: 2025-09-01

Wyszukuje dokumenty w indeksie.

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

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.

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>.
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.
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.
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.
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[]	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://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "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",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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": 1.0779930353164673
            },
            "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": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Kod stanu:: 206

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "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": 1.0779930353164673
            },
            "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": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "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-09-01

{
  "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=2024-07-01"
}

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=2024-07-01"
}

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`.
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
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.
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.
QueryType	Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "full", jeśli zapytanie używa składni zapytania Lucene.
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.
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.
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.
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

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.

DocumentDebugInfo

Objekt

Zawiera informacje debugowania, które można wykorzystać do dalszego eksplorowania wyników wyszukiwania.

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

QueryAnswerType

Wyliczanie

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

Wyliczanie

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

Wyliczanie

Włącza narzędzie do debugowania, którego można użyć do dalszego eksplorowania wyników wyszukiwania.

Wartość	Opis
disabled	Nie zostaną zwrócone żadne informacje debugowania zapytania.
vector	Umożliwia użytkownikowi dalsze eksplorowanie wyników zapytań hybrydowych i wektorowych.

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.

QueryType

Wyliczanie

Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "full", jeśli zapytanie używa składni zapytania Lucene.

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

Wyliczanie

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.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.
value	SearchResult[]	Sekwencja wyników zwracanych przez zapytanie.

SearchMode

Wyliczanie

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

SemanticErrorMode

Wyliczanie

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

Wyliczanie

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

SemanticSearchResultsType

Wyliczanie

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

Wyliczanie

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.

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.
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.
text	string	Tekst, 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.

VectorQueryKind

Wyliczanie

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.

VectorsDebugInfo

Objekt

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

Udostępnij przez

Documents - Search Post

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Przykłady

SearchIndexSearchDocumentsPost

Przykładowe żądanie

Przykładowa odpowiedź

SearchIndexSearchDocumentsSemanticPost

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnswerResult

CaptionResult

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryResultDocumentSubscores

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

SingleVectorFieldResult

TextResult

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo