Documents - Search Get

Zoekt naar documenten in de index.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2023-10-01-Preview
GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&semanticQuery={semanticQuery}&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&debug={debug}&searchFields={searchFields}&queryLanguage={queryLanguage}&speller={speller}&answers={answers}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&captions={captions}&semanticFields={semanticFields}&api-version=2023-10-01-Preview

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

De eindpunt-URL van de zoekservice.

indexName
path True

string

De naam van de index.

api-version
query True

string

Client-API-versie.

$count
query

boolean

Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is onwaar. Het instellen van deze waarde op True kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.

$filter
query

string

De OData $filter-expressie die moet worden toegepast op de zoekquery.

$orderby
query

string[]

De lijst met OData $orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven en desc om aflopend aan te geven. De standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen OrderBy is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. Er kunnen maximaal 32 $orderby componenten zijn.

$select
query

string[]

De lijst met velden die moeten worden opgehaald. Indien niet opgegeven, worden alle velden opgenomen die zijn gemarkeerd als ophaalbaar in het schema.

$skip
query

integer (int32)

Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde wilt scannen, maar niet $skip vanwege deze beperking wilt gebruiken, kunt u overwegen om $orderby te gebruiken op een volledig geordende sleutel en $filter met een bereikquery.

$top
query

integer (int32)

Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te geven voor de volgende pagina met resultaten.

answers
query

QueryAnswerType

Deze parameter is alleen geldig als het querytype semanticis. Indien ingesteld, retourneert de query antwoorden die zijn geëxtraheerd uit belangrijke passages in de hoogste gerangschikte documenten. Het aantal geretourneerde antwoorden kan worden geconfigureerd door het pipeteken toe te voegen | gevolgd door de optie count-<number of answers> na de parameterwaarde voor antwoorden, zoals extractive|count-3. Het standaardaantal is 1. De betrouwbaarheidsdrempel kan worden geconfigureerd door het sluisteken toe te voegen | gevolgd door de optie threshold-<confidence threshold> na de parameterwaarde voor antwoorden, zoals extractive|threshold-0.9. De standaarddrempelwaarde is 0,7.

captions
query

QueryCaptionType

Deze parameter is alleen geldig als het querytype semanticis. Als deze optie is ingesteld, retourneert de query bijschriften die zijn geëxtraheerd uit belangrijke passages in de hoogste gerangschikte documenten. Wanneer bijschriften is ingesteld op extractive, wordt markering standaard ingeschakeld en kan deze worden geconfigureerd door het pipeteken toe te voegen | gevolgd door de optie highlight-<true/false>, zoals extractive|highlight-true. Standaard ingesteld op None.

debug
query

QueryDebugMode

Hiermee kunt u een hulpprogramma voor foutopsporing inschakelen dat kan worden gebruikt om uw zoekresultaten verder te verkennen.

facet
query

string[]

De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.

highlight
query

string[]

De lijst met veldnamen die moeten worden gebruikt voor markeringen van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.

highlightPostTag
query

string

Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.

highlightPreTag
query

string

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em->.

minimumCoverage
query

number (double)

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een zoekquery, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 100.

queryLanguage
query

QueryLanguage

De taal van de query.

queryType
query

QueryType

Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis.

scoringParameter
query

string[]

De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatienaamwaarden. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', is de parametertekenreeks 'mylocation--122.2,44.8' (zonder de aanhalingstekens).

scoringProfile
query

string

De naam van een scoreprofiel om overeenkomende scores voor overeenkomende documenten te evalueren om de resultaten te sorteren.

scoringStatistics
query

ScoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie.

search
query

string

Een zoekquery-expressie in volledige tekst; Gebruik *of laat deze parameter weg om aan alle documenten te voldoen.

searchFields
query

string[]

De lijst met veldnamen waarop de zoekopdracht in volledige tekst moet worden afgestemd. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke in een veld geplaatste zoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.

searchMode
query

SearchMode

Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.

semanticConfiguration
query

string

De naam van de semantische configuratie waarin wordt vermeld welke velden moeten worden gebruikt voor semantische rangschikking, bijschriften, markeringen en antwoorden

semanticErrorHandling
query

SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten (standaard) moet retourneren.

semanticFields
query

string[]

De lijst met veldnamen die worden gebruikt voor semantische rangschikking.

semanticMaxWaitInMilliseconds
query

integer (int32)

minimum: 700

Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is voor semantische verrijking om de verwerking te voltooien voordat de aanvraag mislukt.

semanticQuery
query

string

Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische rerankering, semantische bijschriften en semantische antwoorden. Dit is handig voor scenario's waarbij er verschillende query's moeten worden gebruikt tussen de fase basis ophalen en rangschikken, en de Semantische L2-fase.

sessionId
query

string

Een waarde die moet worden gebruikt om een plaksessie te maken, wat kan helpen om consistentere resultaten te verkrijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen tussen replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, kan niet beginnen met een _-teken.

speller
query

Speller

Verbeter het intrekken van zoekopdrachten door afzonderlijke zoekquerytermen te corrigeren.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

Name Type Description
200 OK

SearchDocumentsResult

Antwoord met documenten die voldoen aan de zoekcriteria.

Other Status Codes

SearchError

Foutreactie.

Voorbeelden

SearchIndexSearchDocumentsGet

Voorbeeldaanvraag

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&speller={speller}&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2023-10-01-Preview

Voorbeeldrespons

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

Definities

Name Description
AnswerResult

Een antwoord is een tekstfragment dat is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de query. Antwoorden worden geëxtraheerd uit de bovenste zoekresultaten. Antwoordkandidaten worden beoordeeld en de belangrijkste antwoorden worden geselecteerd.

CaptionResult

Bijschriften zijn de meest representatieve passages uit het document relatief ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.

DocumentDebugInfo

Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.

QueryAnswerType

Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.

QueryCaptionType

Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.

QueryDebugMode

Hiermee kunt u een hulpprogramma voor foutopsporing inschakelen dat kan worden gebruikt om uw zoekresultaten verder te verkennen.

QueryLanguage

De taal van de query.

QueryResultDocumentRerankerInput

De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.

QueryResultDocumentSemanticField

Beschrijving van velden die zijn verzonden naar het semantische verrijkingsproces en hoe ze zijn gebruikt

QuerySpellerType

Een waarde die het type spellingcontrole heeft opgegeven dat moet worden gebruikt om afzonderlijke zoekquerytermen te spellen.

QueryType

Hiermee geeft u de syntaxis van de zoekquery. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.

RawVectorQuery

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een onbewerkte vectorwaarde wordt opgegeven.

ScoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.

SearchDocumentsResult

Antwoord met zoekresultaten van een index.

SearchError

Beschrijft een foutvoorwaarde voor de API.

SearchMode

Hiermee geeft u op of een of alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.

SearchRequest

Parameters voor filteren, sorteren, facet, paging en ander gedrag van zoekquery's.

SearchResult

Bevat een document dat is gevonden door een zoekquery, plus de bijbehorende metagegevens.

SemanticDebugInfo
SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten (standaard) moet retourneren.

SemanticErrorReason

Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische classificatieaanvraag.

SemanticFieldState

De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)

SemanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.

Speller

Verbeter het intrekken van zoekopdrachten door afzonderlijke zoekquerytermen te corrigeren.

VectorFilterMode

Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.

VectorizableTextQuery

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

VectorQueryKind

Het type vectorquery dat wordt uitgevoerd.

AnswerResult

Een antwoord is een tekstfragment dat is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de query. Antwoorden worden geëxtraheerd uit de bovenste zoekresultaten. Antwoordkandidaten worden beoordeeld en de belangrijkste antwoorden worden geselecteerd.

Name Type Description
highlights

string

Hetzelfde tekstgedeelte als in de eigenschap Tekst met gemarkeerde teksttermen die het meest relevant zijn voor de query.

key

string

De sleutel van het document waaruit het antwoord is geëxtraheerd.

score

number (double)

De scorewaarde geeft aan hoe relevant het antwoord is voor de query ten opzichte van andere antwoorden die voor de query worden geretourneerd.

text

string

Het tekstfragment dat uit de inhoud van het document is geëxtraheerd als antwoord.

CaptionResult

Bijschriften zijn de meest representatieve passages uit het document relatief ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.

Name Type Description
highlights

string

Hetzelfde tekstgedeelte als in de eigenschap Tekst met gemarkeerde woordgroepen die het meest relevant zijn voor de query.

text

string

Een representatieve tekstfragment dat is geëxtraheerd uit het document dat het meest relevant is voor de zoekquery.

DocumentDebugInfo

Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.

Name Type Description
semantic

SemanticDebugInfo

Bevat foutopsporingsinformatie die specifiek is voor semantische classificatieaanvragen.

QueryAnswerType

Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.

Waarde Description
none

Retourneert geen antwoorden voor de query.

extractive

Extraheert antwoordkandidaten uit de inhoud van de documenten die worden geretourneerd als reactie op een query die wordt uitgedrukt als een vraag in natuurlijke taal.

QueryCaptionType

Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.

Waarde Description
none

Retourneer geen bijschriften voor de query.

extractive

Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekquery.

QueryDebugMode

Hiermee kunt u een hulpprogramma voor foutopsporing inschakelen dat kan worden gebruikt om uw zoekresultaten verder te verkennen.

Waarde Description
disabled

Er worden geen queryopsporingsgegevens geretourneerd.

semantic

Hiermee kan de gebruiker de gererankeerde resultaten verder verkennen.

QueryLanguage

De taal van de query.

Waarde Description
none

Querytaal is niet opgegeven.

en-us

Querytaalwaarde voor Engels (Verenigde Staten).

en-gb

Querytaalwaarde voor Engels (Groot-Brittannië).

en-in

Querytaalwaarde voor Engels (India).

en-ca

Querytaalwaarde voor Engels (Canada).

en-au

Querytaalwaarde voor Engels (Australië).

fr-fr

Querytaalwaarde voor Frans (Frankrijk).

fr-ca

Querytaalwaarde voor Frans (Canada).

de-de

Querytaalwaarde voor Duits (Duitsland).

es-es

Querytaalwaarde voor Spaans (Spanje).

es-mx

Querytaalwaarde voor Spaans (Mexico).

zh-cn

Querytaalwaarde voor Chinees (China).

zh-tw

Querytaalwaarde voor Chinees (Taiwan).

pt-br

Querytaalwaarde voor Portugees (Brazilië).

pt-pt

Querytaalwaarde voor Portugees (Portugal).

it-it

Querytaalwaarde voor Italiaans (Italië).

ja-jp

Querytaalwaarde voor Japans (Japan).

ko-kr

Querytaalwaarde voor Koreaans (Korea).

ru-ru

Querytaalwaarde voor Russisch (Rusland).

cs-cz

Querytaalwaarde voor Tsjechisch (Tsjechische Republiek).

nl-be

Querytaalwaarde voor Nederlands (België).

nl-nl

Querytaalwaarde voor Nederlands (Nederland).

hu-hu

Querytaalwaarde voor Hongaars (Hongarije).

pl-pl

Querytaalwaarde voor Pools (Polen).

sv-se

Querytaalwaarde voor Zweeds (Zweden).

tr-tr

Querytaalwaarde voor Turks (Turkije).

hi-in

Querytaalwaarde voor Hindi (India).

ar-sa

Querytaalwaarde voor Arabisch (Saoedi-Arabië).

ar-eg

Querytaalwaarde voor Arabisch (Egypte).

ar-ma

Querytaalwaarde voor Arabisch (Marokko).

ar-kw

Querytaalwaarde voor Arabisch (Koeweit).

ar-jo

Querytaalwaarde voor Arabisch (Jordanië).

da-dk

Querytaalwaarde voor Deens (Denemarken).

no-no

Querytaalwaarde voor Noors (Noorwegen).

bg-bg

Querytaalwaarde voor Bulgaars (Bulgarije).

hr-hr

Querytaalwaarde voor Kroatisch (Kroatië).

hr-ba

Querytaalwaarde voor Kroatisch (Bosnië en Herzegovina).

ms-my

Querytaalwaarde voor Maleis (Maleisië).

ms-bn

Querytaalwaarde voor Maleis (Brunei Darussalam).

sl-sl

Querytaalwaarde voor Sloveens (Slovenië).

ta-in

Querytaalwaarde voor Tamil (India).

vi-vn

Querytaalwaarde voor Vietnamees (Viet Nam).

el-gr

Querytaalwaarde voor Grieks (Griekenland).

ro-ro

Querytaalwaarde voor Roemeens (Roemenië).

is-is

Querytaalwaarde voor IJsland (IJsland).

id-id

Querytaalwaarde voor Indonesisch (Indonesië).

th-th

Querytaalwaarde voor Thai (Thailand).

lt-lt

Querytaalwaarde voor Litouws (Litouwen).

uk-ua

Querytaalwaarde voor Oekraïens (Oekraïne).

lv-lv

Querytaalwaarde voor Lets (Letland).

et-ee

Querytaalwaarde voor Ests (Estland).

ca-es

Querytaalwaarde voor Catalaans.

fi-fi

Querytaalwaarde voor Fins (Finland).

sr-ba

Querytaalwaarde voor Servisch (Bosnië en Herzegovina).

sr-me

Querytaalwaarde voor Servisch (Montenegro).

sr-rs

Querytaalwaarde voor Servisch (Servië).

sk-sk

Querytaalwaarde voor Slowaaks (Slowakije).

nb-no

Querytaalwaarde voor Noors (Noorwegen).

hy-am

Querytaalwaarde voor Armeens (Armenië).

bn-in

Querytaalwaarde voor Bengali (India).

eu-es

Querytaalwaarde voor Baskisch.

gl-es

Querytaalwaarde voor Galicisch.

gu-in

Querytaalwaarde voor Gujarati (India).

he-il

Querytaalwaarde voor Hebreeuws (Israël).

ga-ie

Querytaalwaarde voor Iers (Ierland).

kn-in

Querytaalwaarde voor Kannada (India).

ml-in

Querytaalwaarde voor Malayalam (India).

mr-in

Querytaalwaarde voor Marathi (India).

fa-ae

Querytaalwaarde voor Perzisch (U.A.E.).

pa-in

Querytaalwaarde voor Punjabi (India).

te-in

Querytaalwaarde voor Telugu (India).

ur-pk

Querytaalwaarde voor Urdu (Pakistan).

QueryResultDocumentRerankerInput

De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.

Name Type Description
content

string

De onbewerkte samengevoegde tekenreeksen voor de inhoudsvelden die zijn gebruikt voor semantische verrijking.

keywords

string

De onbewerkte samengevoegde tekenreeksen voor de trefwoordvelden die zijn gebruikt voor semantische verrijking.

title

string

De onbewerkte tekenreeks voor het titelveld dat is gebruikt voor semantische verrijking.

QueryResultDocumentSemanticField

Beschrijving van velden die zijn verzonden naar het semantische verrijkingsproces en hoe ze zijn gebruikt

Name Type Description
name

string

De naam van het veld dat is verzonden naar het semantische verrijkingsproces

state

SemanticFieldState

De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)

QuerySpellerType

Een waarde die het type spellingcontrole heeft opgegeven dat moet worden gebruikt om afzonderlijke zoekquerytermen te spellen.

Waarde Description
none

Spellingcontrole is niet ingeschakeld.

lexicon

De spellingcontrole corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven door de parameter queryLanguage.

QueryType

Hiermee geeft u de syntaxis van de zoekquery. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.

Waarde Description
simple

Gebruikt de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige querytaal waarmee symbolen zoals +, * en '' kunnen worden gebruikt. Query's worden standaard geëvalueerd in alle doorzoekbare velden, tenzij de parameter searchFields is opgegeven.

full

Gebruikt de volledige Lucene-querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal waarmee veldspecifieke en gewogen zoekopdrachten, evenals andere geavanceerde functies mogelijk zijn.

semantic

Het meest geschikt voor query's die in natuurlijke taal worden uitgedrukt in plaats van trefwoorden. Verbetert de nauwkeurigheid van zoekresultaten door de bovenste zoekresultaten opnieuw te rangschikken met behulp van een classificatiemodel dat is getraind op het web-corpus.

RawVectorQuery

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een onbewerkte vectorwaarde wordt opgegeven.

Name Type Description
exhaustive

boolean

Wanneer waar, activeert u een uitgebreide k-dichtstbijzijnde buurzoekopdracht voor alle vectoren binnen de vectorindex. Handig voor scenario's waarbij exacte overeenkomsten essentieel zijn, zoals het bepalen van waarden voor de grondwaarheid.

fields

string

Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de vector die wordt doorzocht.

k

integer (int32)

Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.

kind string:

vector

Het type vectorquery dat wordt uitgevoerd.

vector

number[] (float)

De vectorweergave van een zoekquery.

ScoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.

Waarde Description
local

De scorestatistieken worden lokaal berekend voor een lagere latentie.

global

De scorestatistieken worden globaal berekend voor consistentere scores.

SearchDocumentsResult

Antwoord met zoekresultaten van een index.

Name Type Description
@odata.count

integer (int64)

Het totale aantal resultaten dat is gevonden door de zoekbewerking of null als het aantal niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in dit antwoord. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als de query niet alle aangevraagde documenten in één antwoord kan retourneren.

@odata.nextLink

string

Vervolg-URL geretourneerd wanneer de query niet alle aangevraagde resultaten in één antwoord kan retourneren. U kunt deze URL gebruiken om een andere GET- of POST-zoekaanvraag te formuleren om het volgende deel van het zoekantwoord op te halen. Zorg ervoor dat u hetzelfde werkwoord (GET of POST) gebruikt als de aanvraag die dit antwoord heeft geproduceerd.

@search.answers

AnswerResult[]

De antwoordenqueryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of is ingesteld op 'none'.

@search.coverage

number (double)

Een waarde die het percentage aangeeft van de index die is opgenomen in de query of null als minimumCoverage niet is opgegeven in de aanvraag.

@search.facets

object

De facetqueryresultaten voor de zoekbewerking, geordend als een verzameling buckets voor elk facetveld; null als de query geen facetexpressies bevat.

@search.nextPageParameters

SearchRequest

Vervolg-JSON-nettolading geretourneerd wanneer de query niet alle aangevraagde resultaten in één antwoord kan retourneren. U kunt deze JSON samen met @odata.nextLink gebruiken om een andere POST-zoekaanvraag te formuleren om het volgende deel van het zoekantwoord op te halen.

@search.semanticPartialResponseReason

SemanticErrorReason

Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische classificatieaanvraag.

@search.semanticPartialResponseType

SemanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.

value

SearchResult[]

De reeks resultaten die door de query worden geretourneerd.

SearchError

Beschrijft een foutvoorwaarde voor de API.

Name Type Description
code

string

Een van een door de server gedefinieerde set foutcodes.

details

SearchError[]

Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.

message

string

Een leesbare weergave van de fout.

SearchMode

Hiermee geeft u op of een of alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.

Waarde Description
any

Een van de zoektermen moet worden vergeleken om het document als overeenkomst te tellen.

all

Alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.

SearchRequest

Parameters voor filteren, sorteren, facet, paging en ander gedrag van zoekquery's.

Name Type Description
answers

QueryAnswerType

Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van het zoekantwoord.

captions

QueryCaptionType

Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van het zoekantwoord.

count

boolean

Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is onwaar. Het instellen van deze waarde op True kan invloed hebben op de prestaties. Houd er rekening mee dat het geretourneerde aantal een benadering is.

debug

QueryDebugMode

Hiermee kunt u een hulpprogramma voor foutopsporing inschakelen dat kan worden gebruikt om uw gererankeerde resultaten verder te verkennen.

facets

string[]

De lijst met facetexpressies die moeten worden toegepast op de zoekquery. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met naam:waardeparen.

filter

string

De OData $filter-expressie die moet worden toegepast op de zoekquery.

highlight

string

De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor markeringen van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.

highlightPostTag

string

Een tekenreekstag die wordt toegevoegd om markeringen te raken. Moet worden ingesteld met highlightPreTag. De standaardwaarde is </em>.

highlightPreTag

string

Een tekenreekstag die is voorbereid om markeringen te raken. Moet worden ingesteld met highlightPostTag. De standaardwaarde is <em->.

minimumCoverage

number (double)

Een getal tussen 0 en 100 dat het percentage van de index aangeeft dat moet worden gedekt door een zoekquery, zodat de query kan worden gerapporteerd als geslaagd. Deze parameter kan handig zijn voor het garanderen van de beschikbaarheid van zoekopdrachten, zelfs voor services met slechts één replica. De standaardwaarde is 100.

orderby

string

De door komma's gescheiden lijst met OData $orderby expressies waarmee de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam of een aanroep zijn van de functies geo.distance() of search.score(). Elke expressie kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardvolgorde is oplopend. Ties worden verbroken door de overeenkomende scores van documenten. Als er geen $orderby is opgegeven, wordt de standaardsorteervolgorde aflopend op de score van de documentovereenkomst. Er kunnen maximaal 32 $orderby componenten zijn.

queryLanguage

QueryLanguage

Een waarde die de taal van de zoekquery aangeeft.

queryType

QueryType

Een waarde die de syntaxis van de zoekquery aangeeft. De standaardwaarde is 'eenvoudig'. Gebruik 'volledig' als uw query gebruikmaakt van de Lucene-querysyntaxis.

scoringParameters

string[]

De lijst met parameterwaarden die moeten worden gebruikt in scorefuncties (bijvoorbeeld referencePointParameter) met behulp van de notatienaamwaarden. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', is de parametertekenreeks 'mylocation--122.2,44.8' (zonder de aanhalingstekens).

scoringProfile

string

De naam van een scoreprofiel om overeenkomende scores voor overeenkomende documenten te evalueren om de resultaten te sorteren.

scoringStatistics

ScoringStatistics

Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) globaal willen berekenen voor consistentere scoren, of lokaal, voor een lagere latentie. De standaardwaarde is 'local'. Gebruik 'global' om scorestatistieken globaal samen te voegen voordat u scoren. Het gebruik van globale scorestatistieken kan de latentie van zoekquery's verhogen.

search

string

Een zoekquery-expressie in volledige tekst; Gebruik *of laat deze parameter weg om aan alle documenten te voldoen.

searchFields

string

De door komma's gescheiden lijst met veldnamen waarop de zoekopdracht in volledige tekst moet worden afgestemd. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke in een veld geplaatste zoekexpressie voorrang op alle veldnamen die in deze parameter worden vermeld.

searchMode

SearchMode

Een waarde die aangeeft of een of alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.

select

string

De door komma's gescheiden lijst met velden die moeten worden opgehaald. Indien niet opgegeven, worden alle velden opgenomen die zijn gemarkeerd als ophaalbaar in het schema.

semanticConfiguration

string

De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch.

semanticErrorHandling

SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten (standaard) moet retourneren.

semanticFields

string

De door komma's gescheiden lijst met veldnamen die worden gebruikt voor semantische rangschikking.

semanticMaxWaitInMilliseconds

integer (int32)

minimum: 700

Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is voor semantische verrijking om de verwerking te voltooien voordat de aanvraag mislukt.

semanticQuery

string

Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische rerankering, semantische bijschriften en semantische antwoorden. Dit is handig voor scenario's waarbij er verschillende query's moeten worden gebruikt tussen de fase basis ophalen en rangschikken, en de Semantische L2-fase.

sessionId

string

Een waarde die moet worden gebruikt om een plaksessie te maken, waarmee u consistentere resultaten kunt krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Wees voorzichtig dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen tussen replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, kan niet beginnen met een _-teken.

skip

integer (int32)

Het aantal zoekresultaten dat moet worden overgeslagen. Deze waarde mag niet groter zijn dan 100.000. Als u documenten op volgorde wilt scannen, maar deze beperking niet kunt gebruiken, kunt u in plaats daarvan orderby gebruiken op een volledig geordende sleutel en filteren met een bereikquery.

speller

QuerySpellerType

Een waarde die het type spellingcontrole heeft opgegeven dat moet worden gebruikt om afzonderlijke zoekquerytermen te spellen.

top

integer (int32)

Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paging aan de clientzijde van zoekresultaten te implementeren. Als de resultaten worden afgekapt vanwege paging aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een andere zoekaanvraag uit te geven voor de volgende pagina met resultaten.

vectorFilterMode

VectorFilterMode

Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd. De standaardwaarde is 'preFilter'.

vectorQueries VectorQuery[]:

De queryparameters voor vector- en hybride zoekquery's.

SearchResult

Bevat een document dat is gevonden door een zoekquery, plus de bijbehorende metagegevens.

Name Type Description
@search.captions

CaptionResult[]

Bijschriften zijn de meest representatieve passages uit het document relatief ten opzichte van de zoekquery. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.

@search.documentDebugInfo

DocumentDebugInfo[]

Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.

@search.highlights

object

Tekstfragmenten uit het document die de overeenkomende zoektermen aangeven, geordend op elk toepasselijk veld; null als het markeren van treffers niet is ingeschakeld voor de query.

@search.rerankerScore

number (double)

De relevantiescore berekend door de semantische rangschikking voor de bovenste zoekresultaten. Zoekresultaten worden eerst gesorteerd op de RerankerScore en vervolgens op de score. RerankerScore wordt alleen geretourneerd voor query's van het type 'semantisch'.

@search.score

number (double)

De relevantiescore van het document vergeleken met andere documenten die door de query worden geretourneerd.

SemanticDebugInfo

Name Type Description
contentFields

QueryResultDocumentSemanticField[]

De inhoudsvelden die naar het semantische verrijkingsproces zijn verzonden en hoe ze zijn gebruikt

keywordFields

QueryResultDocumentSemanticField[]

De trefwoordvelden die zijn verzonden naar het semantische verrijkingsproces en hoe ze zijn gebruikt

rerankerInput

QueryResultDocumentRerankerInput

De onbewerkte samengevoegde tekenreeksen die naar het semantische verrijkingsproces zijn verzonden.

titleField

QueryResultDocumentSemanticField

Het titelveld dat is verzonden naar het semantische verrijkingsproces en hoe het is gebruikt

SemanticErrorMode

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken of gedeeltelijke resultaten (standaard) moet retourneren.

Waarde Description
partial

Als de semantische verwerking mislukt, retourneren gedeeltelijke resultaten nog steeds. De definitie van gedeeltelijke resultaten is afhankelijk van welke semantische stap is mislukt en wat de reden voor de fout was.

fail

Als er een uitzondering is tijdens de semantische verwerkingsstap, mislukt de query en retourneert de juiste HTTP-code, afhankelijk van de fout.

SemanticErrorReason

Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische classificatieaanvraag.

Waarde Description
maxWaitExceeded

Als 'semanticMaxWaitInMilliseconds' is ingesteld en de duur van de semantische verwerking die waarde heeft overschreden. Alleen de basisresultaten zijn geretourneerd.

capacityOverloaded

De aanvraag is beperkt. Alleen de basisresultaten zijn geretourneerd.

transient

Ten minste één stap van het semantische proces is mislukt.

SemanticFieldState

De manier waarop het veld is gebruikt voor het semantische verrijkingsproces (volledig gebruikt, gedeeltelijk gebruikt of ongebruikt)

Waarde Description
used

Het veld is volledig gebruikt voor semantische verrijking.

unused

Het veld is niet gebruikt voor semantische verrijking.

partial

Het veld werd gedeeltelijk gebruikt voor semantische verrijking.

SemanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische classificatieaanvraag.

Waarde Description
baseResults

Resultaten zonder semantische verrijking of herrankering.

rerankedResults

De resultaten zijn gererankeerd met het rerankermodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, antwoorden met markeringen of bijschriften.

Speller

Verbeter het intrekken van zoekopdrachten door afzonderlijke zoekquerytermen te corrigeren.

Waarde Description
none

Spellingcontrole is niet ingeschakeld.

lexicon

De spellingcontrole corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven door de parameter queryLanguage.

VectorFilterMode

Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.

Waarde Description
postFilter

Het filter wordt toegepast nadat de kandidaatset vectorresultaten is geretourneerd. Afhankelijk van de filterselectiviteit kan dit resulteren in minder resultaten dan is aangevraagd door de parameter k.

preFilter

Het filter wordt toegepast vóór de zoekquery.

VectorizableTextQuery

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

Name Type Description
exhaustive

boolean

Wanneer waar, activeert u een uitgebreide k-dichtstbijzijnde buurzoekopdracht voor alle vectoren binnen de vectorindex. Handig voor scenario's waarbij exacte overeenkomsten essentieel zijn, zoals het bepalen van waarden voor de grondwaarheid.

fields

string

Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de vector die wordt doorzocht.

k

integer (int32)

Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.

kind string:

text

Het type vectorquery dat wordt uitgevoerd.

text

string

De tekst die moet worden gevectoriseerd om een vectorzoekquery uit te voeren.

VectorQueryKind

Het type vectorquery dat wordt uitgevoerd.

Waarde Description
vector

Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven.

text

Vectorquery waarbij een tekstwaarde die moet worden gevectoriseerd wordt opgegeven.