Documents - Suggest Get

Tjänst:: Search Service

API-version:: 2026-04-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}

Med valfria parametrar:

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
indexName	path	True	string	Namnet på indexet.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
search	query	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	query	True	string	Namnet på förslagstagaren enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.
$filter	query		string	Ett OData-uttryck som filtrerar de dokument som övervägs för förslag.
$orderby	query		string[]	Listan ö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 sjunker standardsorteringsordningen efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
$select	query		string[]	Listan över fält som ska hämtas. Om det inte anges kommer endast nyckelfältet att inkluderas i resultatet.
$top	query		integer (int32)	Antalet förslag som ska hämtas. Värdet måste vara ett tal mellan 1 och 100. Standardvärdet är 5.
fuzzy	query		boolean	Ett värde som anger om fuzzy-matchning ska användas för förslagsfrågan. Standardvärdet är false. När värdet är true hittar frågan termer även om det finns ett ersatt eller saknat tecken i söktexten. Även om detta ger en bättre upplevelse i vissa scenarier, medför det en prestandakostnad eftersom fuzzy-förslagsfrågor är långsammare och förbrukar mer resurser.
highlightPostTag	query		string	En strängtagg som läggs till för att träffa markeringar. Måste anges med highlightPreTag. Om det utelämnas inaktiveras träffmarkering av förslag.
highlightPreTag	query		string	En strängtagg som förbereds för att träffa markeringar. Måste anges med highlightPostTag. Om det utelämnas inaktiveras träffmarkering av förslag.
minimumCoverage	query		number (double)	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 lyckad. 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.
searchFields	query		string[]	Listan med fältnamn för att söka efter den angivna söktexten. Målfält måste ingå i den angivna förslagsställaren.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Accept		Accept	Acceptera-rubriken.
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Svar

Name	Typ	Description
200 OK	SuggestDocumentsResult	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

Name	Description
https://search.azure.com/.default

Exempel

SearchIndexSuggestDocumentsGet

Exempelbegäran

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10

Exempelsvar

Statuskod:: 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
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
SuggestDocumentsResult	Svar som innehåller förslag på frågeresultat från ett index.
SuggestResult	Ett resultat som innehåller ett dokument som hittas av en förslagsfråga, plus associerade metadata.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Den ytterligare informationen.
type	string	Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Felet ytterligare information.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felet objektet.

SuggestDocumentsResult

Objekt

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

Name	Typ	Description
@search.coverage	number (double)	Ett värde som anger procentandelen av indexet som ingick i frågan, eller null om minimumCoverage inte har angetts i begäran.
value	SuggestResult[]	Resultatsekvensen som returneras av frågan.

SuggestResult

Objekt

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

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