Javaslatok (Azure AI Search REST API)

A Javaslatkérések olyan keresés mint ön típusú lekérdezések, amelyek egyező értékeket keresnek a javaslattevő által felismert mezőkben, és egyezést tartalmazó dokumentumokat ad vissza. Ha például engedélyezi a javaslatokat egy városmezőn , a "tenger" szöveg beírásával a "Seattle", a "Sea Tac" és a "Seaside" (az összes tényleges városnév) dokumentumot hoz létre az adott mezőhöz.

A válasz egy egyező dokumentum tartalma, valamint a dokumentumkulcs. Az automatikus kiegészítéssel ellentétben, amely egy másodlagos lekérdezésben használt befejezett kifejezést vagy kifejezést ad vissza, ez a kérés olyan információkat ad vissza, amelyek a tényleges dokumentumokra lesznek feloldva. Ha az egyező kifejezések vagy kifejezések azonosak a dokumentumokban, a rendszer megismétli az egyező tartalmat. Az eredmények szerkezetének javítása érdekében fontolja meg a $select szűrő használatát további mezők visszaadására, amelyek nagyobb különbséget és környezetet biztosítanak.

A szolgáltatáskérésekhez HTTPS szükséges. A Javaslat kérés a GET vagy POST metódussal hozható létre.

GET https://[service name].search.windows.net/indexes/[index name]/docs/suggest?[query parameters]  
  Content-Type: application/json  
  api-key: [admin or query key]   

POST https://[service name].search.windows.net/indexes/[index name]/docs/suggest?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin or query key]  

A Keresési dokumentumok kéréssel ellentétben előfordulhat, hogy a Javaslatok hívást a billentyűzet bemenetéhez köti, míg a Keresési hívás egy kattintáseseményhez van kötve.

A GET használatával történő meghívás esetén a kérelem URL-címe nem haladhatja meg a 8 KB-ot. Ez a hossz általában elegendő a legtöbb alkalmazáshoz. Egyes alkalmazások azonban nagyon nagy lekérdezéseket hoznak létre, különösen OData-szűrőkifejezések használatakor. Ezekben az alkalmazásokban a HTTP POST jobb választás, mert nagyobb szűrőket tesz lehetővé, mint a GET.

A POST esetében a szűrő záradékainak száma a korlátozó tényező, nem pedig a nyers szűrősztring mérete, mivel a POST kérelemméretkorlátja körülbelül 16 MB. Bár a POST-kérelem méretkorlátja nagyon nagy, a szűrőkifejezések nem lehetnek tetszőlegesen összetettek. A szűrés összetettségére vonatkozó korlátozásokkal kapcsolatos további információkért lásd: OData Expression Szintaxis az Azure AI Search szolgáltatáshoz.

URI-paraméterek

URL-kódolási javaslatok

Ne felejtse el URL-kódolással megadni a lekérdezési paramétereket a GET REST API közvetlen meghívásakor. A Javaslatok műveletekhez a következők tartoznak:

• keresés
• $filter
• highlightPreTag
• highlightPostTag

Az URL-kódolás csak az egyes paraméterekhez ajánlott. Ha véletlenül URL-kódolással kódolja a teljes lekérdezési sztringet (minden a után), a ?kérések megszakadnak.

Emellett az URL-kódolás csak akkor szükséges, ha a REST API-t közvetlenül a GET használatával hívja meg. Nem szükséges URL-kódolás a Javaslatok POST használatával történő meghívásakor, vagy ha az Azure AI Search .NET ügyfélkódtára kezeli az URL-kódolást.

Kérelemfejlécek

Az alábbi táblázat a szükséges és nem kötelező kérelemfejléceket ismerteti.

Kérelem törzse

GET esetén: Nincs.

POST esetén:

{  
      "filter": "odata_filter_expression",  
      "fuzzy": true | false (default),  
      "highlightPreTag": "pre_tag",  
      "highlightPostTag": "post_tag",  
      "minimumCoverage": # (% of index that must be covered to declare query successful; default 80),  
      "orderby": "orderby_expression",  
      "search": "partial_search_input",  
      "searchFields": "field_name_1, field_name_2, ...",  
      "select": "field_name_1, field_name_2, ...",  
      "suggesterName": "suggester_name",  
      "top": # (default 5)  
}  

Lekérdezési paraméterek

A lekérdezések több paramétert is elfogadnak az URL-címben, ha a GET-et meghívják, és JSON-tulajdonságokként a kérelem törzsében, amikor POST használatával hívják meg őket. Egyes paraméterek szintaxisa kissé eltér a GET és a POST függvény között. Ezeket a különbségeket alább találja.

Reagálás

Állapotkód: A rendszer az "200 OK" értéket adja vissza a sikeres válaszhoz.

{  
  "@search.coverage": # (if minimumCoverage was provided in the query),  
  "value": [  
    {  
      "@search.text": "...",  
      "<key field>": "..."  
    },  
    ...  
  ]  
}  

Ha a leképezési beállítással kéri le a mezőket, a tömb minden eleme tartalmazza őket:

{  
  "value": [  
    {  
      "@search.text": "...",  
      "<key field>": "..."  
      <other projected data fields>  
    },  
    ...  
  ]  
}  

Példák

5 javaslat lekérése, ahol a részleges keresési bemenet "lux":

GET /indexes/hotels/docs/suggest?search=lux&$top=5&suggesterName=sg&api-version=2020-06-30 

POST /indexes/hotels/docs/suggest?api-version=2020-06-30 
    {  
      "search": "lux",  
      "top": 5,  
      "suggesterName": "sg"  
    }  

Figyelje meg, hogy a suggesterName megadása kötelező a Javaslatok műveletben.

Lásd még

• Javaslattevők hozzáadása indexhez
• Javaslatok vagy automatikus kiegészítés hozzáadása egy alkalmazáshoz
• HTTP-állapotkódok