Documents - Suggest Post
Navrhne v indexu dokumenty, které odpovídají danému textu částečného dotazu.
POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2024-05-01-preview
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Adresa URL koncového bodu vyhledávací služby. |
index
|
path | True |
string |
Název indexu. |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID sledování odeslané spolu s požadavkem na pomoc s laděním. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
search | True |
string |
Hledaný text, který se má použít k návrhu dokumentů. Musí obsahovat alespoň 1 znak a nesmí být delší než 100 znaků. |
suggesterName | True |
string |
Název navrhovatele zadaný v kolekci navrhovatelů, která je součástí definice indexu. |
filter |
string |
Výraz OData, který filtruje zvažovaný dokument pro návrhy. |
|
fuzzy |
boolean |
Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že hledaný text obsahuje nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovává více prostředků. |
|
highlightPostTag |
string |
Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je zakázaná. |
|
highlightPreTag |
string |
Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je zakázaná. |
|
minimumCoverage |
number |
Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhovým dotazem, aby se dotaz ohlásil jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby, které mají jenom jednu repliku. Výchozí hodnota je 80. |
|
orderby |
string |
Seznam OData oddělený čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
|
searchFields |
string |
Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnutá v zadaném navrhovateli. |
|
select |
string |
Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem. |
|
top |
integer |
Počet návrhů, které se mají načíst. Musí to být hodnota mezi 1 a 100. Výchozí hodnota je 5. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Odpověď obsahující navrhované dokumenty, které odpovídají částečnému vstupu. |
|
Other Status Codes |
Chybová odpověď. |
Příklady
SearchIndexSuggestDocumentsPost
Ukázkový požadavek
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-05-01-preview
{
"filter": "rating gt 4.0",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"orderby": "rating desc",
"search": "hote",
"searchFields": "title",
"select": "docId,title,description",
"suggesterName": "sg",
"top": 10
}
Ukázková odpověď
{
"value": [
{
"@search.text": "Nice <em>Hotel</em>",
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.text": "Fancy <em>Hotel</em>",
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
]
}
Definice
Name | Description |
---|---|
Error |
Další informace o chybě správy prostředků |
Error |
Podrobnosti o chybě |
Error |
Chybová odpověď |
Suggest |
Odpověď obsahující výsledky návrhového dotazu z indexu |
Suggest |
Parametry pro filtrování, řazení, přibližné porovnávání a další návrhy chování dotazů. |
Suggest |
Výsledek obsahující dokument nalezený návrhovým dotazem a přidružená metadata. |
ErrorAdditionalInfo
Další informace o chybě správy prostředků
Name | Typ | Description |
---|---|---|
info |
object |
Další informace. |
type |
string |
Typ další informace. |
ErrorDetail
Podrobnosti o chybě
Name | Typ | Description |
---|---|---|
additionalInfo |
Další informace o chybě. |
|
code |
string |
Kód chyby |
details |
Podrobnosti o chybě. |
|
message |
string |
Chybová zpráva |
target |
string |
Cíl chyby. |
ErrorResponse
Chybová odpověď
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
SuggestDocumentsResult
Odpověď obsahující výsledky návrhového dotazu z indexu
Name | Typ | Description |
---|---|---|
@search.coverage |
number |
Hodnota označující procento indexu, které bylo zahrnuto do dotazu, nebo hodnotu null, pokud v požadavku nebyla nastavena hodnota minimumCoverage. |
value |
Posloupnost výsledků vrácených dotazem |
SuggestRequest
Parametry pro filtrování, řazení, přibližné porovnávání a další návrhy chování dotazů.
Name | Typ | Description |
---|---|---|
filter |
string |
Výraz OData, který filtruje zvažovaný dokument pro návrhy. |
fuzzy |
boolean |
Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že hledaný text obsahuje nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovává více prostředků. |
highlightPostTag |
string |
Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je zakázaná. |
highlightPreTag |
string |
Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Pokud ho vynecháte, možnost zvýrazňování návrhů je zakázaná. |
minimumCoverage |
number |
Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhovým dotazem, aby se dotaz ohlásil jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby, které mají jenom jednu repliku. Výchozí hodnota je 80. |
orderby |
string |
Seznam OData oddělený čárkami $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí. |
search |
string |
Hledaný text, který se má použít k návrhu dokumentů. Musí obsahovat alespoň 1 znak a nesmí být delší než 100 znaků. |
searchFields |
string |
Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnutá v zadaném navrhovateli. |
select |
string |
Seznam polí oddělených čárkami, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem. |
suggesterName |
string |
Název navrhovatele zadaný v kolekci navrhovatelů, která je součástí definice indexu. |
top |
integer |
Počet návrhů, které se mají načíst. Musí to být hodnota mezi 1 a 100. Výchozí hodnota je 5. |
SuggestResult
Výsledek obsahující dokument nalezený návrhovým dotazem a přidružená metadata.
Name | Typ | Description |
---|---|---|
@search.text |
string |
Text výsledku návrhu |