Documents - Search Post

Servizio:: Search Service

Versione API:: 2023-10-01-Preview

Cerca documenti nell'indice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-01-Preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
indexName	path	True	string	Nome dell'indice.
api-version	query	True	string	Versione dell'API client.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	ID di rilevamento inviato con la richiesta per facilitare il debug.

Corpo della richiesta

Nome	Tipo	Descrizione
answers	QueryAnswerType	Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca.
captions	QueryCaptionType	Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca.
count	boolean	Valore che specifica se recuperare il conteggio totale dei risultati. Il valore predefinito è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione.
debug	QueryDebugMode	Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati classificati.
facets	string[]	Elenco di espressioni facet da applicare alla query di ricerca. Ogni espressione facet contiene un nome di campo, seguito facoltativamente da un elenco delimitato da virgole di coppie nome:valore.
filter	string	L'espressione OData $filter da applicare alla query di ricerca.
highlight	string	Elenco delimitato da virgole di nomi di campo da usare per l'evidenziazione dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati.
highlightPostTag	string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>.
highlightPreTag	string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>.
minimumCoverage	number (double)	Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di ricerca affinché la query venga segnalata come riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. Il valore predefinito è 100.
orderby	string	Elenco delimitato da virgole di espressioni OData $orderby in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
queryLanguage	QueryLanguage	Valore che specifica il linguaggio della query di ricerca.
queryType	QueryType	Valore che specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene.
scoringParameters	string[]	Elenco dei valori dei parametri da usare nelle funzioni di assegnazione dei punteggi , ad esempio referencePointParameter, usando il formato name-values. Ad esempio, se il profilo di punteggio definisce una funzione con un parametro denominato "mylocation", la stringa di parametro sarà "mylocation--122.2,44.8" (senza virgolette).
scoringProfile	string	Nome di un profilo di punteggio per valutare i punteggi di corrispondenza per i documenti corrispondenti per ordinare i risultati.
scoringStatistics	ScoringStatistics	Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. Il valore predefinito è "local". Usare "global" per aggregare le statistiche di assegnazione dei punteggi a livello globale prima di assegnare punteggi. L'uso delle statistiche di assegnazione dei punteggi globali può aumentare la latenza delle query di ricerca.
search	string	Espressione di query di ricerca full-text; Usare "*" o omettere questo parametro per trovare le corrispondenze con tutti i documenti.
searchFields	string	Elenco delimitato da virgole di nomi di campo a cui definire l'ambito della ricerca full-text. Quando si usa la ricerca campiata (fieldName:searchExpression) in una query Lucene completa, i nomi dei campi di ogni espressione di ricerca con campi hanno la precedenza su tutti i nomi di campo elencati in questo parametro.
searchMode	SearchMode	Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza.
select	string	Elenco delimitato da virgole di campi da recuperare. Se non specificato, vengono inclusi tutti i campi contrassegnati come recuperabili nello schema.
semanticConfiguration	string	Nome di una configurazione semantica che verrà utilizzata durante l'elaborazione dei documenti per le query di tipo semantico.
semanticErrorHandling	SemanticErrorMode	Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).
semanticFields	string	Elenco delimitato da virgole di nomi di campo usati per la classificazione semantica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Consente all'utente di impostare un limite superiore per il tempo necessario per completare l'elaborazione dell'arricchimento semantico prima che la richiesta non riesca.
semanticQuery	string	Consente di impostare una query di ricerca separata che verrà usata esclusivamente per il reranking semantico, le didascalie semantiche e le risposte semantiche. È utile per gli scenari in cui è necessario usare query diverse tra la fase di recupero di base e di classificazione e la fase semantica L2.
sessionId	string	Valore da usare per creare una sessione permanente, che consente di ottenere risultati più coerenti. Se si usa lo stesso sessionId, verrà effettuato un tentativo di eseguire un tentativo di destinazione dello stesso set di repliche. Tenere presente che il riutilizzo degli stessi valori sessionID può interferire ripetutamente con il bilanciamento del carico delle richieste tra le repliche e influire negativamente sulle prestazioni del servizio di ricerca. Il valore usato come sessionId non può iniziare con un carattere '_'.
skip	integer (int32)	Numero di risultati della ricerca da ignorare. Questo valore non può essere maggiore di 100.000. Se è necessario analizzare i documenti in sequenza, ma non è possibile usare skip a causa di questa limitazione, è consigliabile usare orderby su una chiave completamente ordinata e filtrare con una query di intervallo.
speller	QuerySpellerType	Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca.
top	integer (int32)	Numero di risultati della ricerca da recuperare. Questa operazione può essere usata in combinazione con $skip per implementare il paging lato client dei risultati della ricerca. Se i risultati vengono troncati a causa del paging lato server, la risposta includerà un token di continuazione che può essere usato per inviare un'altra richiesta di ricerca per la pagina successiva dei risultati.
vectorFilterMode	VectorFilterMode	Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametri di query per le query di ricerca ibrida e vettoriali.

Risposte

Nome	Tipo	Descrizione
200 OK	SearchDocumentsResult	Risposta contenente documenti che soddisfano i criteri di ricerca.
Other Status Codes	SearchError	Risposta di errore.

Esempio

SearchIndexSearchDocumentsPost

Esempio di richiesta

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Risposta di esempio

Codice di stato:: 200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "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"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

Definizioni

Nome	Descrizione
AnswerResult	Una risposta è un passaggio di testo estratto dal contenuto dei documenti più rilevanti che corrispondono alla query. Le risposte vengono estratte dai primi risultati della ricerca. I candidati alle risposte vengono assegnati punteggi e vengono selezionate le risposte principali.
CaptionResult	Le didascalie sono i passaggi più rappresentativi del documento relativamente alla query di ricerca. Vengono spesso usati come riepilogo dei documenti. Le didascalie vengono restituite solo per le query di tipo 'semantic'.
DocumentDebugInfo	Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca.
QueryAnswerType	Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca.
QueryCaptionType	Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca.
QueryDebugMode	Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati della ricerca.
QueryLanguage	Linguaggio della query.
QueryResultDocumentRerankerInput	Stringhe concatenate non elaborate inviate al processo di arricchimento semantico.
QueryResultDocumentSemanticField	Descrizione dei campi inviati al processo di arricchimento semantico, nonché del modo in cui sono stati usati
QuerySpellerType	Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca.
QueryType	Specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare 'full' se la query usa la sintassi di query Lucene e 'semantic' se la sintassi della query non è necessaria.
RawVectorQuery	Parametri di query da usare per la ricerca vettoriale quando viene specificato un valore di vettore non elaborato.
ScoringStatistics	Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. Il valore predefinito è "local". Usare "global" per aggregare le statistiche di assegnazione dei punteggi a livello globale prima di assegnare punteggi. L'uso delle statistiche di assegnazione dei punteggi globali può aumentare la latenza delle query di ricerca.
SearchDocumentsResult	Risposta contenente i risultati della ricerca da un indice.
SearchError	Descrive una condizione di errore per l'API.
SearchMode	Specifica se deve essere trovata una corrispondenza tra uno o tutti i termini di ricerca per contare il documento come corrispondenza.
SearchRequest	Parametri per il filtro, l'ordinamento, il facet, il paging e altri comportamenti delle query di ricerca.
SearchResult	Contiene un documento trovato da una query di ricerca, oltre ai metadati associati.
SemanticDebugInfo
SemanticErrorMode	Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).
SemanticErrorReason	Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.
SemanticFieldState	Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato)
SemanticSearchResultsType	Tipo di risposta parziale restituita per una richiesta di classificazione semantica.
VectorFilterMode	Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale.
VectorizableTextQuery	Parametri di query da usare per la ricerca vettoriale quando viene fornito un valore di testo che deve essere vettorializzato.
VectorQueryKind	Tipo di query vettoriale da eseguire.

AnswerResult

Oggetto

Una risposta è un passaggio di testo estratto dal contenuto dei documenti più rilevanti che corrispondono alla query. Le risposte vengono estratte dai primi risultati della ricerca. I candidati alle risposte vengono assegnati punteggi e vengono selezionate le risposte principali.

Nome	Tipo	Descrizione
highlights	string	Stesso passaggio di testo della proprietà Text con frasi di testo evidenziate più rilevanti per la query.
key	string	Chiave del documento da cui è stata estratta la risposta.
score	number (double)	Il valore del punteggio rappresenta la rilevanza della risposta alla query rispetto ad altre risposte restituite per la query.
text	string	Il passaggio di testo estratto dal contenuto del documento come risposta.

CaptionResult

Oggetto

Le didascalie sono i passaggi più rappresentativi del documento relativamente alla query di ricerca. Vengono spesso usati come riepilogo dei documenti. Le didascalie vengono restituite solo per le query di tipo 'semantic'.

Nome	Tipo	Descrizione
highlights	string	Stesso passaggio di testo della proprietà Text con frasi evidenziate più rilevanti per la query.
text	string	Passaggio di testo rappresentativo estratto dal documento più rilevante per la query di ricerca.

DocumentDebugInfo

Oggetto

Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca.

Nome	Tipo	Descrizione
semantic	SemanticDebugInfo	Contiene informazioni di debug specifiche per le richieste di classificazione semantica.

QueryAnswerType

Enumerazione

Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca.

Valore	Descrizione
none	Non restituire risposte per la query.
extractive	Estrae i candidati di risposta dal contenuto dei documenti restituiti in risposta a una query espressa come domanda in linguaggio naturale.

QueryCaptionType

Enumerazione

Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca.

Valore	Descrizione
none	Non restituire didascalie per la query.
extractive	Estrae le didascalie dai documenti corrispondenti che contengono passaggi rilevanti per la query di ricerca.

QueryDebugMode

Enumerazione

Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati della ricerca.

Valore	Descrizione
disabled	Non verranno restituite informazioni di debug delle query.
semantic	Consente all'utente di esplorare ulteriormente i risultati classificati.

QueryLanguage

Enumerazione

Linguaggio della query.

Valore	Descrizione
none	Linguaggio di query non specificato.
en-us	Valore della lingua di query per l'inglese (Stati Uniti).
en-gb	Valore della lingua di query per l'inglese (Gran Bretagna).
en-in	Valore della lingua di query per l'inglese (India).
en-ca	Valore della lingua di query per l'inglese (Canada).
en-au	Valore della lingua di query per l'inglese (Australia).
fr-fr	Valore della lingua di query per il francese (Francia).
fr-ca	Valore della lingua di query per il francese (Canada).
de-de	Valore della lingua di query per il tedesco (Germania).
es-es	Valore della lingua di query per spagnolo (Spagna).
es-mx	Valore della lingua di query per lo spagnolo (Messico).
zh-cn	Valore della lingua di query per il cinese (Cina).
zh-tw	Valore della lingua di query per il cinese (Taiwan).
pt-br	Valore della lingua di query per il portoghese (Brasile).
pt-pt	Valore della lingua di query per il portoghese (Portogallo).
it-it	Valore della lingua di query per l'italiano (Italia).
ja-jp	Valore del linguaggio di query per il giapponese (Giappone).
ko-kr	Valore del linguaggio di query per coreano (Corea).
ru-ru	Valore della lingua di query per russo (Russia).
cs-cz	Valore della lingua di query per il ceco (Repubblica Ceca).
nl-be	Valore della lingua di query per l'olandese (Belgio).
nl-nl	Valore della lingua di query per l'olandese (Paesi Bassi).
hu-hu	Valore della lingua di query per ungherese (Ungheria).
pl-pl	Valore del linguaggio di query per polacco (Polonia).
sv-se	Valore della lingua di query per svedese (Svezia).
tr-tr	Valore della lingua di query per turco (Turchia).
hi-in	Valore del linguaggio di query per hindi (India).
ar-sa	Valore della lingua di query per l'arabo (Arabia Saudita).
ar-eg	Valore della lingua di query per l'arabo (Egitto).
ar-ma	Valore della lingua di query per l'arabo (Marocco).
ar-kw	Valore della lingua di query per l'arabo (Kuwait).
ar-jo	Valore della lingua di query per l'arabo (Jordan).
da-dk	Valore della lingua di query per danese (Danimarca).
no-no	Valore della lingua di query per Norvegese (Norvegia).
bg-bg	Valore della lingua di query per bulgaro (Bulgaria).
hr-hr	Valore della lingua di query per croato (Croazia).
hr-ba	Valore della lingua di query per croato (Bosnia ed Erzegovina).
ms-my	Valore del linguaggio di query per la malese (Malaysia).
ms-bn	Valore del linguaggio di query per malese (Language Darussalam).
sl-sl	Valore del linguaggio di query per sloveno (Slovenia).
ta-in	Valore del linguaggio di query per Il Tamil (India).
vi-vn	Valore del linguaggio di query per vietnamita (Viet Nam).
el-gr	Valore della lingua di query per greco (Grecia).
ro-ro	Valore della lingua di query per romeno (Romania).
is-is	Valore del linguaggio di query per islandese (Islanda).
id-id	Valore della lingua di query per indonesiano (Indonesia).
th-th	Valore del linguaggio di query per Thai (Thailandia).
lt-lt	Valore della lingua di query per lituano (Lituania).
uk-ua	Valore della lingua di query per ucraino (Ucraina).
lv-lv	Valore lingua di query per lettone (Lettonia).
et-ee	Valore della lingua di query per Estonian (Estonia).
ca-es	Valore del linguaggio di query per catalano.
fi-fi	Valore della lingua di query per finlandese (Finlandia).
sr-ba	Valore del linguaggio di query per serbo (Bosnia ed Erzegovina).
sr-me	Valore lingua di query per serbo (Montenegro).
sr-rs	Valore della lingua di query per serbo (Serbia).
sk-sk	Valore della lingua di query per slovacchia (Slovacchia).
nb-no	Valore della lingua di query per Norvegese (Norvegia).
hy-am	Valore del linguaggio di query per armeno (Armenia).
bn-in	Valore del linguaggio di query per Bengali (India).
eu-es	Valore del linguaggio di query per basco.
gl-es	Valore del linguaggio di query per la Galizia.
gu-in	Valore del linguaggio di query per Gujarati (India).
he-il	Valore della lingua di query per l'ebraico (Israele).
ga-ie	Valore della lingua di query per irlandese (Irlanda).
kn-in	Valore del linguaggio di query per Kannada (India).
ml-in	Valore del linguaggio di query per Malayalam (India).
mr-in	Valore del linguaggio di query per Marathi (India).
fa-ae	Valore della lingua di query per persiano (U.A.E.).
pa-in	Valore del linguaggio di query per Punjabi (India).
te-in	Valore del linguaggio di query per Telugu (India).
ur-pk	Valore del linguaggio di query per Urdu (Pakistan).

QueryResultDocumentRerankerInput

Oggetto

Stringhe concatenate non elaborate inviate al processo di arricchimento semantico.

Nome	Tipo	Descrizione
content	string	Stringhe concatenate non elaborate per i campi di contenuto utilizzati per l'arricchimento semantico.
keywords	string	Stringhe concatenate non elaborate per i campi parola chiave usati per l'arricchimento semantico.
title	string	Stringa non elaborata per il campo del titolo utilizzato per l'arricchimento semantico.

QueryResultDocumentSemanticField

Oggetto

Descrizione dei campi inviati al processo di arricchimento semantico, nonché del modo in cui sono stati usati

Nome	Tipo	Descrizione
name	string	Nome del campo inviato al processo di arricchimento semantico
state	SemanticFieldState	Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato)

QuerySpellerType

Enumerazione

Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca.

Valore	Descrizione
none	Correttore ortografico non abilitato.
lexicon	Il correttore ortografico corregge i singoli termini di query usando un lessico statico per il linguaggio specificato dal parametro queryLanguage.

QueryType

Enumerazione

Specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare 'full' se la query usa la sintassi di query Lucene e 'semantic' se la sintassi della query non è necessaria.

Valore	Descrizione
simple	Usa la sintassi di query semplice per le ricerche. Il testo di ricerca viene interpretato usando un linguaggio di query semplice che consente simboli come +, * e "". Le query vengono valutate in tutti i campi ricercabili per impostazione predefinita, a meno che non venga specificato il parametro searchFields.
full	Usa la sintassi di query Lucene completa per le ricerche. Il testo di ricerca viene interpretato usando il linguaggio di query Lucene che consente ricerche specifiche del campo e ponderate, nonché altre funzionalità avanzate.
semantic	Ideale per le query espresse in linguaggio naturale anziché parole chiave. Migliora la precisione dei risultati della ricerca rivalutando i primi risultati della ricerca usando un modello di classificazione sottoposto a training nel corpus Web.

RawVectorQuery

Oggetto

Parametri di query da usare per la ricerca vettoriale quando viene specificato un valore di vettore non elaborato.

Nome	Tipo	Descrizione
exhaustive	boolean	Se true, attiva una ricerca completa k-nearest neighbor in tutti i vettori all'interno dell'indice vettoriale. Utile per gli scenari in cui le corrispondenze esatte sono critiche, ad esempio per determinare i valori di verità di base.
fields	string	Campi vettoriali di tipo Collection(Edm.Single) da includere nel vettore cercato.
k	integer (int32)	Numero di vicini più vicini da restituire come top hit.
kind	string: vector	Tipo di query vettoriale da eseguire.
vector	number[] (float)	Rappresentazione vettoriale di una query di ricerca.

ScoringStatistics

Enumerazione

Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. Il valore predefinito è "local". Usare "global" per aggregare le statistiche di assegnazione dei punteggi a livello globale prima di assegnare punteggi. L'uso delle statistiche di assegnazione dei punteggi globali può aumentare la latenza delle query di ricerca.

Valore	Descrizione
local	Le statistiche di assegnazione dei punteggi verranno calcolate in locale per una latenza inferiore.
global	Le statistiche di assegnazione dei punteggi verranno calcolate a livello globale per un punteggio più coerente.

SearchDocumentsResult

Oggetto

Risposta contenente i risultati della ricerca da un indice.

Nome	Tipo	Descrizione
@odata.count	integer (int64)	Conteggio totale dei risultati rilevati dall'operazione di ricerca oppure Null se il conteggio non è stato richiesto. Se presente, il conteggio può essere maggiore del numero di risultati in questa risposta. Ciò può verificarsi se si usano i parametri $top o $skip oppure se la query non può restituire tutti i documenti richiesti in una singola risposta.
@odata.nextLink	string	URL di continuazione restituito quando la query non può restituire tutti i risultati richiesti in una singola risposta. È possibile usare questo URL per formulare un'altra richiesta GET o POST Search per ottenere la parte successiva della risposta di ricerca. Assicurarsi di usare lo stesso verbo (GET o POST) della richiesta che ha generato questa risposta.
@search.answers	AnswerResult[]	Risposte ai risultati della query per l'operazione di ricerca; Null se il parametro di query answers non è stato specificato o impostato su 'none'.
@search.coverage	number (double)	Valore che indica la percentuale dell'indice incluso nella query oppure null se minimumCoverage non è stato specificato nella richiesta.
@search.facets	object	Risultati della query facet per l'operazione di ricerca, organizzati come raccolta di bucket per ogni campo in base a facet; Null se la query non include espressioni facet.
@search.nextPageParameters	SearchRequest	Payload JSON di continuazione restituito quando la query non può restituire tutti i risultati richiesti in una singola risposta. È possibile usare questo codice JSON insieme a @odata.nextLink per formulare un'altra richiesta di ricerca POST per ottenere la parte successiva della risposta di ricerca.
@search.semanticPartialResponseReason	SemanticErrorReason	Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.
@search.semanticPartialResponseType	SemanticSearchResultsType	Tipo di risposta parziale restituita per una richiesta di classificazione semantica.
value	SearchResult[]	Sequenza di risultati restituiti dalla query.

SearchError

Oggetto

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
message	string	Rappresentazione leggibile dell'errore.

SearchMode

Enumerazione

Specifica se deve essere trovata una corrispondenza tra uno o tutti i termini di ricerca per contare il documento come corrispondenza.

Valore	Descrizione
any	Per contare il documento come corrispondenza, è necessario trovare una corrispondenza tra i termini di ricerca.
all	Per contare il documento come corrispondenza, è necessario che tutti i termini di ricerca corrispondano.

SearchRequest

Oggetto

Parametri per il filtro, l'ordinamento, il facet, il paging e altri comportamenti delle query di ricerca.

Nome	Tipo	Descrizione
answers	QueryAnswerType	Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca.
captions	QueryCaptionType	Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca.
count	boolean	Valore che specifica se recuperare il conteggio totale dei risultati. Il valore predefinito è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione.
debug	QueryDebugMode	Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati classificati.
facets	string[]	Elenco di espressioni facet da applicare alla query di ricerca. Ogni espressione facet contiene un nome di campo, seguito facoltativamente da un elenco delimitato da virgole di coppie nome:valore.
filter	string	L'espressione OData $filter da applicare alla query di ricerca.
highlight	string	Elenco delimitato da virgole di nomi di campo da usare per l'evidenziazione dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati.
highlightPostTag	string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>.
highlightPreTag	string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>.
minimumCoverage	number (double)	Numero compreso tra 0 e 100 che indica la percentuale dell'indice che deve essere coperta da una query di ricerca affinché la query venga segnalata come riuscita. Questo parametro può essere utile per garantire la disponibilità della ricerca anche per i servizi con una sola replica. Il valore predefinito è 100.
orderby	string	Elenco delimitato da virgole di espressioni OData $orderby in base al quale ordinare i risultati. Ogni espressione può essere un nome di campo o una chiamata alle funzioni geo.distance() o search.score(). Ogni espressione può essere seguita da asc per indicare un valore crescente o desc per indicare la decrescente. Il valore predefinito è crescente. I legami verranno interrotti dai punteggi di corrispondenza dei documenti. Se non viene specificato alcun $orderby, l'ordinamento predefinito è decrescente in base al punteggio di corrispondenza del documento. Possono essere presenti al massimo 32 clausole $orderby.
queryLanguage	QueryLanguage	Valore che specifica il linguaggio della query di ricerca.
queryType	QueryType	Valore che specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene.
scoringParameters	string[]	Elenco dei valori dei parametri da usare nelle funzioni di assegnazione dei punteggi , ad esempio referencePointParameter, usando il formato name-values. Ad esempio, se il profilo di punteggio definisce una funzione con un parametro denominato "mylocation", la stringa di parametro sarà "mylocation--122.2,44.8" (senza virgolette).
scoringProfile	string	Nome di un profilo di punteggio per valutare i punteggi di corrispondenza per i documenti corrispondenti per ordinare i risultati.
scoringStatistics	ScoringStatistics	Valore che specifica se si desidera calcolare le statistiche di assegnazione dei punteggi (ad esempio, la frequenza del documento) a livello globale per un punteggio più coerente, o localmente, per una latenza inferiore. Il valore predefinito è "local". Usare "global" per aggregare le statistiche di assegnazione dei punteggi a livello globale prima di assegnare punteggi. L'uso delle statistiche di assegnazione dei punteggi globali può aumentare la latenza delle query di ricerca.
search	string	Espressione di query di ricerca full-text; Usare "*" o omettere questo parametro per trovare le corrispondenze con tutti i documenti.
searchFields	string	Elenco delimitato da virgole di nomi di campo a cui definire l'ambito della ricerca full-text. Quando si usa la ricerca campiata (fieldName:searchExpression) in una query Lucene completa, i nomi dei campi di ogni espressione di ricerca con campi hanno la precedenza su tutti i nomi di campo elencati in questo parametro.
searchMode	SearchMode	Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza.
select	string	Elenco delimitato da virgole di campi da recuperare. Se non specificato, vengono inclusi tutti i campi contrassegnati come recuperabili nello schema.
semanticConfiguration	string	Nome di una configurazione semantica che verrà utilizzata durante l'elaborazione dei documenti per le query di tipo semantico.
semanticErrorHandling	SemanticErrorMode	Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).
semanticFields	string	Elenco delimitato da virgole di nomi di campo usati per la classificazione semantica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Consente all'utente di impostare un limite superiore per il tempo necessario per completare l'elaborazione dell'arricchimento semantico prima che la richiesta non riesca.
semanticQuery	string	Consente di impostare una query di ricerca separata che verrà usata esclusivamente per il reranking semantico, le didascalie semantiche e le risposte semantiche. È utile per gli scenari in cui è necessario usare query diverse tra la fase di recupero di base e di classificazione e la fase semantica L2.
sessionId	string	Valore da usare per creare una sessione permanente, che consente di ottenere risultati più coerenti. Se si usa lo stesso sessionId, verrà effettuato un tentativo di eseguire un tentativo di destinazione dello stesso set di repliche. Tenere presente che il riutilizzo degli stessi valori sessionID può interferire ripetutamente con il bilanciamento del carico delle richieste tra le repliche e influire negativamente sulle prestazioni del servizio di ricerca. Il valore usato come sessionId non può iniziare con un carattere '_'.
skip	integer (int32)	Numero di risultati della ricerca da ignorare. Questo valore non può essere maggiore di 100.000. Se è necessario analizzare i documenti in sequenza, ma non è possibile usare skip a causa di questa limitazione, è consigliabile usare orderby su una chiave completamente ordinata e filtrare con una query di intervallo.
speller	QuerySpellerType	Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca.
top	integer (int32)	Numero di risultati della ricerca da recuperare. Questa operazione può essere usata in combinazione con $skip per implementare il paging lato client dei risultati della ricerca. Se i risultati vengono troncati a causa del paging lato server, la risposta includerà un token di continuazione che può essere usato per inviare un'altra richiesta di ricerca per la pagina successiva dei risultati.
vectorFilterMode	VectorFilterMode	Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter'.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametri di query per le query di ricerca ibrida e vettoriali.

SearchResult

Oggetto

Contiene un documento trovato da una query di ricerca, oltre ai metadati associati.

Nome	Tipo	Descrizione
@search.captions	CaptionResult[]	Le didascalie sono i passaggi più rappresentativi del documento relativamente alla query di ricerca. Vengono spesso usati come riepilogo dei documenti. Le didascalie vengono restituite solo per le query di tipo 'semantic'.
@search.documentDebugInfo	DocumentDebugInfo[]	Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca.
@search.highlights	object	Frammenti di testo del documento che indicano i termini di ricerca corrispondenti, organizzati per ogni campo applicabile; Null se l'evidenziazione dell'hit non è stata abilitata per la query.
@search.rerankerScore	number (double)	Punteggio di pertinenza calcolato dal ranker semantico per i primi risultati della ricerca. I risultati della ricerca vengono ordinati prima in base a RerankerScore e quindi in base al punteggio. RerankerScore viene restituito solo per le query di tipo 'semantic'.
@search.score	number (double)	Punteggio di pertinenza del documento rispetto ad altri documenti restituiti dalla query.

SemanticDebugInfo

Oggetto

Nome	Tipo	Descrizione
contentFields	QueryResultDocumentSemanticField[]	I campi di contenuto inviati al processo di arricchimento semantico, nonché il modo in cui sono stati usati
keywordFields	QueryResultDocumentSemanticField[]	Campi di parole chiave inviati al processo di arricchimento semantico, nonché il modo in cui sono stati usati
rerankerInput	QueryResultDocumentRerankerInput	Stringhe concatenate non elaborate inviate al processo di arricchimento semantico.
titleField	QueryResultDocumentSemanticField	Campo del titolo inviato al processo di arricchimento semantico, nonché come è stato usato

SemanticErrorMode

Enumerazione

Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).

Valore	Descrizione
partial	Se l'elaborazione semantica non riesce, i risultati parziali vengono comunque restituiti. La definizione dei risultati parziali dipende dal passaggio semantico non riuscito e dal motivo dell'errore.
fail	Se si verifica un'eccezione durante il passaggio di elaborazione semantica, la query avrà esito negativo e restituirà il codice HTTP appropriato a seconda dell'errore.

SemanticErrorReason

Enumerazione

Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.

Valore	Descrizione
maxWaitExceeded	Se 'semanticMaxWaitInMilliseconds' è stato impostato e la durata dell'elaborazione semantica ha superato tale valore. Sono stati restituiti solo i risultati di base.
capacityOverloaded	La richiesta è stata limitata. Sono stati restituiti solo i risultati di base.
transient	Almeno un passaggio del processo semantico non è riuscito.

SemanticFieldState

Enumerazione

Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato)

Valore	Descrizione
used	Il campo è stato usato completamente per l'arricchimento semantico.
unused	Il campo non è stato utilizzato per l'arricchimento semantico.
partial	Il campo è stato utilizzato parzialmente per l'arricchimento semantico.

SemanticSearchResultsType

Enumerazione

Tipo di risposta parziale restituita per una richiesta di classificazione semantica.

Valore	Descrizione
baseResults	Risultati senza arricchimento semantico o reranking.
rerankedResults	I risultati sono stati rivalutati con il modello reranker e includeranno didascalie semantiche. Non includeranno risposte, risposte evidenziate o didascalie.

VectorFilterMode

Enumerazione

Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale.

Valore	Descrizione
postFilter	Il filtro verrà applicato dopo la restituzione del set candidato di risultati vettoriali. A seconda della selettività del filtro, questo può comportare un minor numero di risultati rispetto a quanto richiesto dal parametro 'k'.
preFilter	Il filtro verrà applicato prima della query di ricerca.

VectorizableTextQuery

Oggetto

Parametri di query da usare per la ricerca vettoriale quando viene fornito un valore di testo che deve essere vettorializzato.

Nome	Tipo	Descrizione
exhaustive	boolean	Se true, attiva una ricerca completa k-nearest neighbor in tutti i vettori all'interno dell'indice vettoriale. Utile per gli scenari in cui le corrispondenze esatte sono critiche, ad esempio per determinare i valori di verità di base.
fields	string	Campi vettoriali di tipo Collection(Edm.Single) da includere nel vettore cercato.
k	integer (int32)	Numero di vicini più vicini da restituire come top hit.
kind	string: text	Tipo di query vettoriale da eseguire.
text	string	Testo da vettorizzare per eseguire una query di ricerca vettoriale.

VectorQueryKind

Enumerazione

Tipo di query vettoriale da eseguire.

Valore	Descrizione
vector	Query vettoriale in cui viene fornito un valore vettoriale non elaborato.
text	Query vettoriale in cui viene fornito un valore di testo che deve essere vettorializzato.