Documents - Suggest Post

Referens

Service:: Search Service

API Version:: 2023-11-01

Föreslår dokument i indexet som matchar den angivna partiella frågetexten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string uuid	Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning.

Begärandetext

Name	Obligatorisk	Typ	Description
search	True	string	Söktexten som ska användas för att föreslå dokument. Måste vara minst 1 tecken och högst 100 tecken.
suggesterName	True	string	Namnet på förslagsverktyget enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.
filter		string	Ett OData-uttryck som filtrerar de dokument som övervägs för förslag.
fuzzy		boolean	Ett värde som anger om fuzzy-matchning ska användas för förslagsfrågan. Standardvärdet är false. När frågan är inställd på true hittar den förslag även om det finns ett ersatt eller saknat tecken i söktexten. Även om detta ger en bättre upplevelse i vissa scenarier, kommer det till en prestandakostnad eftersom fuzzy förslag sökningar är långsammare och förbrukar mer resurser.
highlightPostTag		string	En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Om det utelämnas inaktiveras markering av förslag.
highlightPreTag		string	En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Om det utelämnas inaktiveras markering av förslag.
minimumCoverage		number	Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste omfattas av en förslagsfråga för att frågan ska rapporteras som en lyckad fråga. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 80.
orderby		string	Kommaavgränsad lista över OData $orderby uttryck som resultatet ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till funktionerna geo.distance() eller search.score(). Varje uttryck kan följas av asc för att indikera stigande eller desc för att indikera fallande. Standardvärdet är stigande ordning. Banden kommer att brytas av matchningspoängen för dokument. Om ingen $orderby har angetts är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
searchFields		string	Kommaavgränsad lista med fältnamn för att söka efter den angivna söktexten. Målfält måste inkluderas i den angivna förslagsverktyget.
select		string	Kommaavgränsad lista över fält som ska hämtas. Om det är ospecificerat inkluderas bara nyckelfältet i resultaten.
top		integer	Antalet förslag som ska hämtas. Detta måste vara ett värde mellan 1 och 100. Standardvärdet är 5.

Svar

Name	Typ	Description
200 OK	SuggestDocumentsResult	Svar som innehåller föreslagna dokument som matchar de partiella indata.
Other Status Codes	SearchError	Felsvar.

Exempel

SearchIndexSuggestDocumentsPost

Sample Request

HTTP

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

{
  "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
}

Sample Response

Status code:: 200

{
  "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"
    }
  ]
}

Definitioner

Name	Description
SearchError	Beskriver ett feltillstånd för API:et.
SuggestDocumentsResult	Svar som innehåller förslag på frågeresultat från ett index.
SuggestRequest	Parametrar för filtrering, sortering, fuzzy-matchning och andra frågebeteenden för förslag.
SuggestResult	Ett resultat som innehåller ett dokument som hittats av en förslagsfråga, plus associerade metadata.

SearchError

Beskriver ett feltillstånd för API:et.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	SearchError[]	En matris med information om specifika fel som ledde till det rapporterade felet.
message	string	En läsbar återgivning av felet.

SuggestDocumentsResult

Svar som innehåller förslag på frågeresultat från ett index.

Name	Typ	Description
@search.coverage	number	Ett värde som anger procentandelen av indexet som inkluderades i frågan eller null om minimumCoverage inte angavs i begäran.
value	SuggestResult[]	Resultatsekvensen som returneras av frågan.

SuggestRequest

Parametrar för filtrering, sortering, fuzzy-matchning och andra frågebeteenden för förslag.

Name	Typ	Description
filter	string	Ett OData-uttryck som filtrerar de dokument som övervägs för förslag.
fuzzy	boolean	Ett värde som anger om fuzzy-matchning ska användas för förslagsfrågan. Standardvärdet är false. När frågan är inställd på true hittar den förslag även om det finns ett ersatt eller saknat tecken i söktexten. Även om detta ger en bättre upplevelse i vissa scenarier, kommer det till en prestandakostnad eftersom fuzzy förslag sökningar är långsammare och förbrukar mer resurser.
highlightPostTag	string	En strängtagg som läggs till för att träffa höjdpunkter. Måste anges med highlightPreTag. Om det utelämnas inaktiveras markering av förslag.
highlightPreTag	string	En strängtagg som förbereds för att träffa höjdpunkter. Måste anges med highlightPostTag. Om det utelämnas inaktiveras markering av förslag.
minimumCoverage	number	Ett tal mellan 0 och 100 som anger procentandelen av indexet som måste omfattas av en förslagsfråga för att frågan ska rapporteras som en lyckad fråga. Den här parametern kan vara användbar för att säkerställa söktillgänglighet även för tjänster med endast en replik. Standardvärdet är 80.
orderby	string	Kommaavgränsad lista över OData $orderby uttryck som resultatet ska sorteras efter. Varje uttryck kan vara antingen ett fältnamn eller ett anrop till funktionerna geo.distance() eller search.score(). Varje uttryck kan följas av asc för att indikera stigande eller desc för att indikera fallande. Standardvärdet är stigande ordning. Banden kommer att brytas av matchningspoängen för dokument. Om ingen $orderby har angetts är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
search	string	Söktexten som ska användas för att föreslå dokument. Måste vara minst 1 tecken och högst 100 tecken.
searchFields	string	Kommaavgränsad lista med fältnamn för att söka efter den angivna söktexten. Målfält måste inkluderas i den angivna förslagsverktyget.
select	string	Kommaavgränsad lista över fält som ska hämtas. Om det är ospecificerat inkluderas bara nyckelfältet i resultaten.
suggesterName	string	Namnet på förslagsverktyget enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.
top	integer	Antalet förslag som ska hämtas. Detta måste vara ett värde mellan 1 och 100. Standardvärdet är 5.

SuggestResult

Ett resultat som innehåller ett dokument som hittats av en förslagsfråga, plus associerade metadata.

Name	Typ	Description
@search.text	string	Texten i förslagsresultatet.

Dela via