Documents - Search Get

Referentie

Service:: Search Service

API-versie:: 2024-09-01-preview

Zoekt naar documenten in de index.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-09-01-preview

Met optionele parameters:

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}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-09-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

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 `semantic`is. 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 `semantic`is. 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	ErrorResponse	Foutreactie.

Voorbeelden

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Voorbeeldaanvraag

HTTP

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&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-09-01-preview&speller={speller}

Voorbeeldrespons

Statuscode:: 200

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

SearchIndexSearchDocumentsSemanticGet

Voorbeeldaanvraag

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-09-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

Voorbeeldrespons

Statuscode:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

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 `semantic`.
DocumentDebugInfo	Bevat foutopsporingsgegevens die kunnen worden gebruikt om uw zoekresultaten verder te verkennen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HybridCountAndFacetMode	Bepaalt of het aantal en facetten alle documenten bevat die overeenkomen met de zoekquery, of alleen de documenten die worden opgehaald in het venster maxTextRecallSize. De standaardwaarde is countAllResults.
HybridSearch	TDe queryparameters voor het configureren van hybride zoekgedrag.
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
QueryResultDocumentSubscores	De uitsplitsing van substrepingstekens tussen de onderdelen van de tekst- en vectorquery van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde als ze zijn ontvangen.
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.
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.
SearchScoreThreshold	De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Dit is de @search.score geretourneerd als onderdeel van het zoekantwoord. De richting van de drempelwaarde wordt gekozen voor een hogere @search.score.
SemanticDebugInfo
SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard/huidig gedrag) of gedeeltelijke resultaten 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.
SingleVectorFieldResult	Eén vectorveldresultaat. Zowel @search.score als vector-overeenkomsten worden geretourneerd. Vector-gelijkenis is gerelateerd aan @search.score door een vergelijking.
Speller	Verbeter het intrekken van zoekopdrachten door afzonderlijke zoekquerytermen te corrigeren.
TextResult	De BM25- of Klassieke score voor het tekstgedeelte van de query.
VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of nadat de vectorzoekopdracht is uitgevoerd.
VectorizableImageBinaryQuery	De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een met base 64 gecodeerd binair bestand van een afbeelding wordt opgegeven die moet worden gevectoriseerd.
VectorizableImageUrlQuery	De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een URL die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd, wordt opgegeven.
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.
VectorsDebugInfo
VectorSimilarityThreshold	De resultaten van de vectorquery worden gefilterd op basis van de metrische vector-overeenkomsten. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. De drempelwaarderichting (groter of kleiner) wordt automatisch gekozen op basis van de metrische gegevens die door het veld worden gebruikt.
VectorThresholdKind	Het type vectorquery dat wordt uitgevoerd.

AnswerResult

Object

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

Object

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 semantic.

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

Object

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.
vectors	VectorsDebugInfo	Bevat foutopsporingsinformatie die specifiek is voor vector- en hybride zoekopdrachten.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HybridCountAndFacetMode

Inventarisatie

Bepaalt of het aantal en facetten alle documenten bevat die overeenkomen met de zoekquery, of alleen de documenten die worden opgehaald in het venster maxTextRecallSize. De standaardwaarde is countAllResults.

Waarde	Description
countAllResults	Neem alle documenten op die overeenkomen met de zoekquery bij het berekenen van 'count' en 'facets', ongeacht of deze documenten zich in het ophaalvenster 'maxTextRecallSize' bevinden.
countRetrievableResults	Neem alleen documenten op die overeenkomen in het ophaalvenster 'maxTextRecallSize' bij het berekenen van 'count' en 'facets'.

HybridSearch

Object

TDe queryparameters voor het configureren van hybride zoekgedrag.

Name	Type	Description
countAndFacetMode	HybridCountAndFacetMode	Bepaalt of het aantal en facetten alle documenten bevat die overeenkomen met de zoekquery, of alleen de documenten die worden opgehaald in het venster maxTextRecallSize.
maxTextRecallSize	integer (int32)	Bepaalt het maximum aantal documenten dat moet worden opgehaald door het tekstquerygedeelte van een hybride zoekaanvraag. Deze documenten worden gecombineerd met de documenten die overeenkomen met de vectorquery's om één definitieve lijst met resultaten te produceren. Als u een grotere waarde voor maxTextRecallSize kiest, kunt u meer documenten ophalen en paglen (met behulp van de parameters bovenaan en overslaan), ten koste van een hoger resourcegebruik en een hogere latentie. De waarde moet tussen 1 en 10.000 zijn. De standaardwaarde is 1000.

QueryAnswerType

Inventarisatie

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

Waarde	Description
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.
none	Retourneert geen antwoorden voor de query.

QueryCaptionType

Inventarisatie

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

Waarde	Description
extractive	Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekquery.
none	Retourneer geen bijschriften voor de query.

QueryDebugMode

Inventarisatie

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

Inventarisatie

De taal van de query.

Waarde	Description
ar-eg	Querytaalwaarde voor Arabisch (Egypte).
ar-jo	Querytaalwaarde voor Arabisch (Jordanië).
ar-kw	Querytaalwaarde voor Arabisch (Koeweit).
ar-ma	Querytaalwaarde voor Arabisch (Marokko).
ar-sa	Querytaalwaarde voor Arabisch (Saoedi-Arabië).
bg-bg	Querytaalwaarde voor Bulgaars (Bulgarije).
bn-in	Querytaalwaarde voor Bengali (India).
ca-es	Querytaalwaarde voor Catalaans.
cs-cz	Querytaalwaarde voor Tsjechisch (Tsjechische Republiek).
da-dk	Querytaalwaarde voor Deens (Denemarken).
de-de	Querytaalwaarde voor Duits (Duitsland).
el-gr	Querytaalwaarde voor Grieks (Griekenland).
en-au	Querytaalwaarde voor Engels (Australië).
en-ca	Querytaalwaarde voor Engels (Canada).
en-gb	Querytaalwaarde voor Engels (Groot-Brittannië).
en-in	Querytaalwaarde voor Engels (India).
en-us	Querytaalwaarde voor Engels (Verenigde Staten).
es-es	Querytaalwaarde voor Spaans (Spanje).
es-mx	Querytaalwaarde voor Spaans (Mexico).
et-ee	Querytaalwaarde voor Ests (Estland).
eu-es	Querytaalwaarde voor Baskisch.
fa-ae	Querytaalwaarde voor Perzisch (U.A.E.).
fi-fi	Querytaalwaarde voor Fins (Finland).
fr-ca	Querytaalwaarde voor Frans (Canada).
fr-fr	Querytaalwaarde voor Frans (Frankrijk).
ga-ie	Querytaalwaarde voor Iers (Ierland).
gl-es	Querytaalwaarde voor Galicisch.
gu-in	Querytaalwaarde voor Gujarati (India).
he-il	Querytaalwaarde voor Hebreeuws (Israël).
hi-in	Querytaalwaarde voor Hindi (India).
hr-ba	Querytaalwaarde voor Kroatisch (Bosnië en Herzegovina).
hr-hr	Querytaalwaarde voor Kroatisch (Kroatië).
hu-hu	Querytaalwaarde voor Hongaars (Hongarije).
hy-am	Querytaalwaarde voor Armeens (Armenië).
id-id	Querytaalwaarde voor Indonesisch (Indonesië).
is-is	Querytaalwaarde voor IJsland (IJsland).
it-it	Querytaalwaarde voor Italiaans (Italië).
ja-jp	Querytaalwaarde voor Japans (Japan).
kn-in	Querytaalwaarde voor Kannada (India).
ko-kr	Querytaalwaarde voor Koreaans (Korea).
lt-lt	Querytaalwaarde voor Litouws (Litouwen).
lv-lv	Querytaalwaarde voor Lets (Letland).
ml-in	Querytaalwaarde voor Malayalam (India).
mr-in	Querytaalwaarde voor Marathi (India).
ms-bn	Querytaalwaarde voor Maleis (Brunei Darussalam).
ms-my	Querytaalwaarde voor Maleis (Maleisië).
nb-no	Querytaalwaarde voor Noors (Noorwegen).
nl-be	Querytaalwaarde voor Nederlands (België).
nl-nl	Querytaalwaarde voor Nederlands (Nederland).
no-no	Querytaalwaarde voor Noors (Noorwegen).
none	Querytaal is niet opgegeven.
pa-in	Querytaalwaarde voor Punjabi (India).
pl-pl	Querytaalwaarde voor Pools (Polen).
pt-br	Querytaalwaarde voor Portugees (Brazilië).
pt-pt	Querytaalwaarde voor Portugees (Portugal).
ro-ro	Querytaalwaarde voor Roemeens (Roemenië).
ru-ru	Querytaalwaarde voor Russisch (Rusland).
sk-sk	Querytaalwaarde voor Slowaaks (Slowakije).
sl-sl	Querytaalwaarde voor Sloveens (Slovenië).
sr-ba	Querytaalwaarde voor Servisch (Bosnië en Herzegovina).
sr-me	Querytaalwaarde voor Servisch (Montenegro).
sr-rs	Querytaalwaarde voor Servisch (Servië).
sv-se	Querytaalwaarde voor Zweeds (Zweden).
ta-in	Querytaalwaarde voor Tamil (India).
te-in	Querytaalwaarde voor Telugu (India).
th-th	Querytaalwaarde voor Thai (Thailand).
tr-tr	Querytaalwaarde voor Turks (Turkije).
uk-ua	Querytaalwaarde voor Oekraïens (Oekraïne).
ur-pk	Querytaalwaarde voor Urdu (Pakistan).
vi-vn	Querytaalwaarde voor Vietnamees (Viet Nam).
zh-cn	Querytaalwaarde voor Chinees (China).
zh-tw	Querytaalwaarde voor Chinees (Taiwan).

QueryResultDocumentRerankerInput

Object

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

Object

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)

QueryResultDocumentSubscores

Object

De uitsplitsing van substrepingstekens tussen de onderdelen van de tekst- en vectorquery van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde als ze zijn ontvangen.

Name	Type	Description
documentBoost	number (double)	De BM25- of Klassieke score voor het tekstgedeelte van de query.
text	TextResult	De BM25- of Klassieke score voor het tekstgedeelte van de query.
vectors	<string, SingleVectorFieldResult>	De vector-overeenkomsten en @search.score waarden voor elke vectorquery.

QuerySpellerType

Inventarisatie

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

Waarde	Description
lexicon	De spellingcontrole corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven door de parameter queryLanguage.
none	Spellingcontrole is niet ingeschakeld.

QueryType

Inventarisatie

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
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.
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.

RawVectorQuery

Object

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.
filterOverride	string	De OData-filterexpressie die moet worden toegepast op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau.
k	integer (int32)	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: vector	Het type vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	De drempelwaarde die wordt gebruikt voor vectorquery's. Houd er rekening mee dat dit alleen kan worden ingesteld als alle 'velden' dezelfde metrische overeenkomst gebruiken.
vector	number[] (float)	De vectorweergave van een zoekquery.
weight	number (float)	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

ScoringStatistics

Inventarisatie

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
global	De scorestatistieken worden globaal berekend voor consistentere scores.
local	De scorestatistieken worden lokaal berekend voor een lagere latentie.

SearchDocumentsResult

Object

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.

SearchMode

Inventarisatie

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

Waarde	Description
all	Alle zoektermen moeten worden vergeleken om het document als overeenkomst te tellen.
any	Een van de zoektermen moet worden vergeleken om het document als overeenkomst te tellen.

SearchRequest

Object

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->.
hybridSearch	HybridSearch	De queryparameters voor het configureren van hybride zoekgedrag.
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 (standaard/huidig gedrag) of gedeeltelijke resultaten 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' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

SearchResult

Object

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.

SearchScoreThreshold

Object

De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Dit is de @search.score geretourneerd als onderdeel van het zoekantwoord. De richting van de drempelwaarde wordt gekozen voor een hogere @search.score.

Name	Type	Description
kind	string: searchScore	Het type drempelwaarde dat wordt gebruikt voor het filteren van vectorquery's
value	number (double)	De drempelwaarde wordt gefilterd op basis van de waarde '@search.score'. Dit is de @search.score geretourneerd als onderdeel van het zoekantwoord. De richting van de drempelwaarde wordt gekozen voor een hogere @search.score.

SemanticDebugInfo

Object

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

Inventarisatie

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

Waarde	Description
fail	Als er een uitzondering is tijdens de semantische verwerkingsstap, mislukt de query en retourneert de juiste HTTP-code, afhankelijk van de fout.
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.

SemanticErrorReason

Inventarisatie

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

Waarde	Description
capacityOverloaded	De aanvraag is beperkt. Alleen de basisresultaten zijn geretourneerd.
maxWaitExceeded	Als `semanticMaxWaitInMilliseconds` is ingesteld en de duur van de semantische verwerking die waarde heeft overschreden. Alleen de basisresultaten zijn geretourneerd.
transient	Ten minste één stap van het semantische proces is mislukt.

SemanticFieldState

Inventarisatie

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

Waarde	Description
partial	Het veld werd gedeeltelijk gebruikt voor semantische verrijking.
unused	Het veld is niet gebruikt voor semantische verrijking.
used	Het veld is volledig gebruikt voor semantische verrijking.

SemanticSearchResultsType

Inventarisatie

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.

SingleVectorFieldResult

Object

Eén vectorveldresultaat. Zowel @search.score als vector-overeenkomsten worden geretourneerd. Vector-gelijkenis is gerelateerd aan @search.score door een vergelijking.

Name	Type	Description
searchScore	number (double)	De @search.score waarde die wordt berekend op basis van de vector-overeenkomstenscore. Dit is de score die zichtbaar is in een pure enkelvoudige vectorquery.
vectorSimilarity	number (double)	De vector-overeenkomstenscore voor dit document. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. Bijvoorbeeld cosinus-gelijkenis in plaats van cosinusafstand.

Speller

Inventarisatie

Verbeter het intrekken van zoekopdrachten door afzonderlijke zoekquerytermen te corrigeren.

Waarde	Description
lexicon	De spellingcontrole corrigeert afzonderlijke querytermen met behulp van een statisch lexicon voor de taal die is opgegeven door de parameter queryLanguage.
none	Spellingcontrole is niet ingeschakeld.

TextResult

Object

De BM25- of Klassieke score voor het tekstgedeelte van de query.

Name	Type	Description
searchScore	number (double)	De BM25- of Klassieke score voor het tekstgedeelte van de query.

VectorFilterMode

Inventarisatie

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.

VectorizableImageBinaryQuery

Object

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een met base 64 gecodeerd binair bestand van een afbeelding wordt opgegeven die moet worden gevectoriseerd.

Name	Type	Description
base64Image	string	Het met base 64 gecodeerde binaire bestand van een afbeelding dat moet worden gevectoriseerd om een vectorzoekquery uit te voeren.
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.
filterOverride	string	De OData-filterexpressie die moet worden toegepast op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau.
k	integer (int32)	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: imageBinary	Het type vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	De drempelwaarde die wordt gebruikt voor vectorquery's. Houd er rekening mee dat dit alleen kan worden ingesteld als alle 'velden' dezelfde metrische overeenkomst gebruiken.
weight	number (float)	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

VectorizableImageUrlQuery

Object

De queryparameters die moeten worden gebruikt voor vectorzoekopdrachten wanneer een URL die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd, 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.
filterOverride	string	De OData-filterexpressie die moet worden toegepast op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau.
k	integer (int32)	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: imageUrl	Het type vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	De drempelwaarde die wordt gebruikt voor vectorquery's. Houd er rekening mee dat dit alleen kan worden ingesteld als alle 'velden' dezelfde metrische overeenkomst gebruiken.
url	string	De URL van een afbeelding die moet worden gevectoriseerd om een vectorzoekquery uit te voeren.
weight	number (float)	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

VectorizableTextQuery

Object

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.
filterOverride	string	De OData-filterexpressie die moet worden toegepast op deze specifieke vectorquery. Als er geen filterexpressie is gedefinieerd op vectorniveau, wordt in plaats daarvan de expressie gebruikt die is gedefinieerd in de filterparameter op het hoogste niveau.
k	integer (int32)	Aantal dichtstbijzijnde buren dat als belangrijkste treffers moet worden geretourneerd.
kind	string: text	Het type vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling-factor. De minimumwaarde is 1. De parameter defaultOversampling wordt overschreven die is geconfigureerd in de indexdefinitie. Deze kan alleen worden ingesteld wanneer 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan wanneer een compressiemethode wordt gebruikt voor het onderliggende vectorveld.
text	string	De tekst die moet worden gevectoriseerd om een vectorzoekquery uit te voeren.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	De drempelwaarde die wordt gebruikt voor vectorquery's. Houd er rekening mee dat dit alleen kan worden ingesteld als alle 'velden' dezelfde metrische overeenkomst gebruiken.
weight	number (float)	Relatief gewicht van de vectorquery in vergelijking met andere vectorquery's en/of de tekstquery binnen dezelfde zoekaanvraag. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere classificatielijsten die worden geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die overeenkomen met die query, worden in de uiteindelijke rangschikking geplaatst. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

VectorQueryKind

Inventarisatie

Het type vectorquery dat wordt uitgevoerd.

Waarde	Description
imageBinary	Vectorquery waarbij een met base 64 gecodeerd binair bestand van een afbeelding wordt opgegeven die moet worden gevectoriseerd.
imageUrl	Vectorquery waarbij een URL die een afbeeldingswaarde vertegenwoordigt die moet worden gevectoriseerd, wordt opgegeven.
text	Vectorquery waarbij een tekstwaarde die moet worden gevectoriseerd wordt opgegeven.
vector	Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven.

VectorsDebugInfo

Object

Name	Type	Description
subscores	QueryResultDocumentSubscores	De uitsplitsing van substrepingstekens van het document vóór de gekozen methode voor samenvoeging/combinatie van resultatensets, zoals RRF.

VectorSimilarityThreshold

Object

De resultaten van de vectorquery worden gefilterd op basis van de metrische vector-overeenkomsten. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. De drempelwaarderichting (groter of kleiner) wordt automatisch gekozen op basis van de metrische gegevens die door het veld worden gebruikt.

Name	Type	Description
kind	string: vectorSimilarity	Het type drempelwaarde dat wordt gebruikt voor het filteren van vectorquery's
value	number (double)	De drempelwaarde wordt gefilterd op basis van de metrische waarde voor overeenkomsten. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. De drempelwaarderichting (groter of kleiner) wordt automatisch gekozen op basis van de metrische gegevens die door het veld worden gebruikt.

VectorThresholdKind

Inventarisatie

Het type vectorquery dat wordt uitgevoerd.

Waarde	Description
searchScore	De resultaten van de vectorquery worden gefilterd op basis van de waarde '@search.score'. Dit is de @search.score geretourneerd als onderdeel van het zoekantwoord. De richting van de drempelwaarde wordt gekozen voor een hogere @search.score.
vectorSimilarity	De resultaten van de vectorquery worden gefilterd op basis van de metrische vector-overeenkomsten. Let op: dit is de canonieke definitie van overeenkomsten metrische gegevens, niet de 'afstand'-versie. De drempelwaarderichting (groter of kleiner) wordt automatisch gekozen op basis van de metrische gegevens die door het veld worden gebruikt.

Delen via

Documents - Search Get

URI-parameters

Aanvraagkoptekst

Antwoorden

Voorbeelden

SearchIndexSearchDocumentsGet

Voorbeeldaanvraag

Voorbeeldrespons

SearchIndexSearchDocumentsSemanticGet

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AnswerResult

CaptionResult

DocumentDebugInfo

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HybridCountAndFacetMode

HybridSearch

QueryAnswerType

QueryCaptionType

QueryDebugMode

QueryLanguage

QueryResultDocumentRerankerInput

QueryResultDocumentSemanticField

QueryResultDocumentSubscores

QuerySpellerType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SearchScoreThreshold

SemanticDebugInfo

SemanticErrorMode

SemanticErrorReason

SemanticFieldState

SemanticSearchResultsType

SingleVectorFieldResult

Speller

TextResult

VectorFilterMode

VectorizableImageBinaryQuery

VectorizableImageUrlQuery

VectorizableTextQuery

VectorQueryKind

VectorsDebugInfo

VectorSimilarityThreshold

VectorThresholdKind

Aanvullende resources