Documents - Suggest Get

  • Referens
Service:
Search Service
API Version:
2023-11-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-11-01
With optional parameters: 
GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&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.
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. Oavgjort kommer att brytas av matchningspoängen för dokument. Om ingen $orderby anges är standardsorteringsordningen fallande efter dokumentmatchningspoäng. Det kan finnas högst 32 $orderby-satser.
$select
 query

string[]

Listan över fält som ska hämtas. Om det är ospecificerat inkluderas endast nyckelfältet i resultaten.
$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, innebä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 höjdpunkter. Måste anges med highlightPreTag. Om det utelämnas inaktiveras markering av förslag.
highlightPreTag
 query

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
 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 över fältnamn som ska söka efter den angivna söktexten. Målfält måste inkluderas i den angivna förslagsspelaren.

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.

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

SearchIndexSuggestDocumentsGet

Sample Request

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?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&api-version=2023-11-01

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 felvillkor för API:et.
SuggestDocumentsResult

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

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

SearchError

Beskriver ett felvillkor 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 mänsklig läsbar representation 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 ingick i frågan, eller null om minimumCoverage inte angavs i begäran.
value

SuggestResult[]

Resultatsekvensen som returneras av frågan.

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.