Documents - Search Post
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. |
index
|
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 di assistenza per il debug. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
answers |
Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca. |
|
captions |
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. L'impostazione predefinita è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione. |
debug |
Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati rivalutati. |
|
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 le evidenziazioni dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati. |
highlightPostTag |
string |
Tag stringa aggiunto per l'hit highlights. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>. |
highlightPreTag |
string |
Tag stringa anteporto ai punti di evidenziazione. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>. |
minimumCoverage |
number |
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 l'ordine crescente o desc per indicare la decrescente. Per impostazione predefinita, l'ordinamento è crescente. Le situazioni di parità di priorità vengono risolte in base ai 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 |
Valore che specifica la lingua della query di ricerca. |
|
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 i valori dei nomi di formato. Ad esempio, se il profilo di assegnazione dei punteggi definisce una funzione con un parametro denominato "mylocation", la stringa di parametro sarebbe "mylocation--122.2.44.8" (senza virgolette). |
scoringProfile |
string |
Nome di un profilo di punteggio da usare per la valutazione di punteggi di corrispondenza per i documenti corrispondenti, in modo da ordinare i risultati. |
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 in locale per una latenza inferiore. Il valore predefinito è "local". Usare "globale" 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 corrispondere a 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 in campi (fieldName:searchExpression) in una query Lucene completa, i nomi di campo di ogni espressione di ricerca a campi hanno la precedenza su tutti i nomi di campo elencati in questo parametro. |
searchMode |
Valore che specifica se qualsiasi 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à usata durante l'elaborazione dei documenti per le query di tipo semantica. |
semanticErrorHandling |
Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo o restituire risultati parziali (impostazione predefinita). |
|
semanticFields |
string |
Elenco delimitato da virgole dei nomi di campo usati per la classificazione semantica. |
semanticMaxWaitInMilliseconds |
integer |
Consente all'utente di impostare un limite superiore per la quantità di tempo necessario per l'arricchimento semantico per completare l'elaborazione prima che la richiesta non riesca. |
semanticQuery |
string |
Consente di impostare una query di ricerca separata che verrà usata esclusivamente per la reranking semantica, le didascalie semantiche e le risposte semantiche. È utile per gli scenari in cui è necessario usare query diverse tra la fase di recupero e classificazione di base e la fase semantica L2. |
sessionId |
string |
Valore da usare per creare una sessione permanenti, che consente di ottenere risultati più coerenti. Purché venga usato 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 |
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 ignorare a causa di questa limitazione, prendere in considerazione l'uso di orderby su una chiave completamente ordinata e filtrare con una query di intervallo. |
speller |
Valore che specifica il tipo del ortografico da usare per correggere in modo ortografico i singoli termini di query di ricerca. |
|
top |
integer |
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 |
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca del vettore. Il valore predefinito è 'preFilter'. |
|
vectorQueries | VectorQuery[]: |
Parametri di query per query di ricerca ibrida e vettore. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Risposta contenente documenti che corrispondono ai criteri di ricerca. |
|
Other Status Codes |
Risposta di errore. |
Esempio
SearchIndexSearchDocumentsPost
Sample Request
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"
}
Sample Response
{
"@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 |
---|---|
Answer |
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 di risposta vengono assegnati punteggi e vengono selezionate le risposte principali. |
Caption |
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'. |
Document |
Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca. |
Query |
Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca. |
Query |
Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca. |
Query |
Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati della ricerca. |
Query |
Linguaggio della query. |
Query |
Stringhe concatenate non elaborate inviate al processo di arricchimento semantico. |
Query |
Descrizione dei campi inviati al processo di arricchimento semantico, nonché del modo in cui sono stati usati |
Query |
Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca. |
Query |
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. |
Raw |
Parametri di query da usare per la ricerca vettoriale quando viene specificato un valore di vettore non elaborato. |
Scoring |
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 in locale per una latenza inferiore. Il valore predefinito è "local". Usare "globale" 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 |
Risposta contenente i risultati della ricerca da un indice. |
Search |
Descrive una condizione di errore per l'API. |
Search |
Specifica se è necessario trovare una corrispondenza con uno o tutti i termini di ricerca per includere il documento nel numero delle corrispondenze. |
Search |
Parametri per il filtro, l'ordinamento, il facet, il paging e altri comportamenti delle query di ricerca. |
Search |
Contiene un documento trovato da una query di ricerca, oltre ai metadati associati. |
Semantic |
|
Semantic |
Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita). |
Semantic |
Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica. |
Semantic |
Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato) |
Semantic |
Tipo di risposta parziale restituita per una richiesta di classificazione semantica. |
Vector |
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. |
Vectorizable |
Parametri di query da usare per la ricerca vettoriale quando viene fornito un valore di testo che deve essere vettorializzato. |
Vector |
Tipo di query vettoriale da eseguire. |
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 di risposta 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 |
Il valore del punteggio rappresenta la rilevanza della risposta alla query rispetto ad altre risposte restituite per la query. |
text |
string |
Passaggio di testo estratto dal contenuto del documento come risposta. |
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'.
Nome | Tipo | Descrizione |
---|---|---|
highlights |
string |
Stesso passaggio di testo della proprietà Text con frasi evidenziate più rilevanti per la query. |
text |
string |
Un passaggio di testo rappresentativo estratto dal documento più rilevante per la query di ricerca. |
DocumentDebugInfo
Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca.
Nome | Tipo | Descrizione |
---|---|---|
semantic |
Contiene informazioni di debug specifiche per le richieste di classificazione semantica. |
QueryAnswerType
Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
extractive |
string |
Estrae i candidati alle risposte dal contenuto dei documenti restituiti in risposta a una query espressa come domanda nel linguaggio naturale. |
none |
string |
Non restituire risposte per la query. |
QueryCaptionType
Valore che specifica se le didascalie devono essere restituite come parte della risposta di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
extractive |
string |
Estrae le didascalie dai documenti corrispondenti che contengono passaggi rilevanti per la query di ricerca. |
none |
string |
Non restituire didascalie per la query. |
QueryDebugMode
Abilita uno strumento di debug che può essere usato per esplorare ulteriormente i risultati della ricerca.
Nome | Tipo | Descrizione |
---|---|---|
disabled |
string |
Non verranno restituite informazioni di debug delle query. |
semantic |
string |
Consente all'utente di esplorare ulteriormente i risultati classificati nuovamente. |
QueryLanguage
Linguaggio della query.
Nome | Tipo | Descrizione |
---|---|---|
ar-eg |
string |
Valore della lingua di query per l'arabo (Egitto). |
ar-jo |
string |
Valore della lingua di query per arabo (Giordania). |
ar-kw |
string |
Valore della lingua di query per l'arabo (Kuwait). |
ar-ma |
string |
Valore della lingua di query per l'arabo (Marocco). |
ar-sa |
string |
Valore della lingua di query per l'arabo (Arabia Saudita). |
bg-bg |
string |
Valore della lingua di query per bulgaro (Bulgaria). |
bn-in |
string |
Valore del linguaggio di query per Bengali (India). |
ca-es |
string |
Valore del linguaggio di query per catalano. |
cs-cz |
string |
Valore della lingua di query per ceco (Repubblica Ceca). |
da-dk |
string |
Valore della lingua di query per danese (Danimarca). |
de-de |
string |
Valore della lingua di query per il tedesco (Germania). |
el-gr |
string |
Valore della lingua di query per greco (Grecia). |
en-au |
string |
Valore della lingua di query per l'inglese (Australia). |
en-ca |
string |
Valore della lingua di query per l'inglese (Canada). |
en-gb |
string |
Valore della lingua di query per l'inglese (Gran Bretagna). |
en-in |
string |
Valore della lingua di query per l'inglese (India). |
en-us |
string |
Valore della lingua di query per l'inglese (Stati Uniti). |
es-es |
string |
Valore della lingua di query per spagnolo (Spagna). |
es-mx |
string |
Valore della lingua di query per spagnolo (Messico). |
et-ee |
string |
Valore del linguaggio di query per estonia (Estonia). |
eu-es |
string |
Valore della lingua di query per basco. |
fa-ae |
string |
Valore della lingua di query per persiano (U.A.E.). |
fi-fi |
string |
Valore della lingua di query per il finlandese (Finlandia). |
fr-ca |
string |
Valore della lingua di query per il francese (Canada). |
fr-fr |
string |
Valore della lingua di query per il francese (Francia). |
ga-ie |
string |
Valore della lingua di query per irlandese (Irlanda). |
gl-es |
string |
Valore del linguaggio di query per la Galizia. |
gu-in |
string |
Valore del linguaggio di query per Gujarati (India). |
he-il |
string |
Valore della lingua di query per l'ebraico (Israele). |
hi-in |
string |
Valore del linguaggio di query per Hindi (India). |
hr-ba |
string |
Valore della lingua di query per croato (Bosnia ed Erzegovina). |
hr-hr |
string |
Valore della lingua di query per croato (Croazia). |
hu-hu |
string |
Valore della lingua di query per l'ungherese (Ungheria). |
hy-am |
string |
Valore della lingua di query per armeno (Armenia). |
id-id |
string |
Valore del linguaggio di query per indonesiano (Indonesia). |
is-is |
string |
Valore del linguaggio di query per Islanda (Islanda). |
it-it |
string |
Valore della lingua di query per l'italiano (Italia). |
ja-jp |
string |
Valore della lingua di query per il giapponese (Giappone). |
kn-in |
string |
Valore del linguaggio di query per Kannada (India). |
ko-kr |
string |
Valore del linguaggio di query per coreano (Corea). |
lt-lt |
string |
Valore della lingua di query per lituano (Lituania). |
lv-lv |
string |
Valore della lingua di query per lettonia (Lettonia). |
ml-in |
string |
Valore del linguaggio di query per Malayalam (India). |
mr-in |
string |
Valore del linguaggio di query per Marathi (India). |
ms-bn |
string |
Valore del linguaggio di query per il malese (Brunei Darussalam). |
ms-my |
string |
Valore del linguaggio di query per la Malese (Malaysia). |
nb-no |
string |
Valore del linguaggio di query per Norvegese (Norvegia). |
nl-be |
string |
Valore della lingua di query per l'olandese (Belgio). |
nl-nl |
string |
Valore della lingua di query per olandese (Paesi Bassi). |
no-no |
string |
Valore del linguaggio di query per Norvegese (Norvegia). |
none |
string |
Linguaggio di query non specificato. |
pa-in |
string |
Valore del linguaggio di query per Punjabi (India). |
pl-pl |
string |
Valore del linguaggio di query per polacco (Polonia). |
pt-br |
string |
Valore della lingua di query per portoghese (Brasile). |
pt-pt |
string |
Valore della lingua di query per portoghese (Portogallo). |
ro-ro |
string |
Valore della lingua di query per il romeno (Romania). |
ru-ru |
string |
Valore della lingua di query per russo (Russia). |
sk-sk |
string |
Valore della lingua di query per slovacchia (Slovacchia). |
sl-sl |
string |
Valore della lingua di query per sloveno (Slovenia). |
sr-ba |
string |
Valore del linguaggio di query per serbo (Bosnia ed Erzegovina). |
sr-me |
string |
Valore della lingua di query per serbo (Montenegro). |
sr-rs |
string |
Valore della lingua di query per serbo (Serbia). |
sv-se |
string |
Valore della lingua di query per svedese (Svezia). |
ta-in |
string |
Valore del linguaggio di query per Tamil (India). |
te-in |
string |
Valore del linguaggio di query per Telugu (India). |
th-th |
string |
Valore del linguaggio di query per Thai (Thailandia). |
tr-tr |
string |
Valore della lingua di query per turco (Turchia). |
uk-ua |
string |
Valore della lingua di query per ucraino (Ucraina). |
ur-pk |
string |
Valore del linguaggio di query per Urdu (Pakistan). |
vi-vn |
string |
Valore del linguaggio di query per vietnamiti (Viet Nam). |
zh-cn |
string |
Valore della lingua di query per il cinese (Cina). |
zh-tw |
string |
Valore della lingua di query per il cinese (Taiwan). |
QueryResultDocumentRerankerInput
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 utilizzati per l'arricchimento semantico. |
title |
string |
Stringa non elaborata per il campo del titolo utilizzato per l'arricchimento semantico. |
QueryResultDocumentSemanticField
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 |
Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato) |
QuerySpellerType
Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
lexicon |
string |
Il correttore ortografico corregge i singoli termini di query usando un lessico statico per il linguaggio specificato dal parametro queryLanguage. |
none |
string |
Correttore ortografico non abilitato. |
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.
Nome | Tipo | Descrizione |
---|---|---|
full |
string |
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 |
string |
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. |
simple |
string |
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. |
RawVectorQuery
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-near near 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 |
Numero di vicini più vicini da restituire come primi riscontri. |
kind |
string:
vector |
Tipo di query vettoriale da eseguire. |
vector |
number[] |
Rappresentazione vettoriale di una query di ricerca. |
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 in locale per una latenza inferiore. Il valore predefinito è "local". Usare "globale" 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.
Nome | Tipo | Descrizione |
---|---|---|
global |
string |
Le statistiche di assegnazione dei punteggi verranno calcolate a livello globale per un punteggio più coerente. |
local |
string |
Le statistiche di assegnazione dei punteggi verranno calcolate localmente per una latenza inferiore. |
SearchDocumentsResult
Risposta contenente i risultati della ricerca da un indice.
Nome | Tipo | Descrizione |
---|---|---|
@odata.count |
integer |
Conteggio totale dei risultati trovati dall'operazione di ricerca o 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 |
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 |
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 |
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 @odata.nextLink a per formulare un'altra richiesta di ricerca POST per ottenere la parte successiva della risposta di ricerca. |
|
@search.semanticPartialResponseReason |
Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica. |
|
@search.semanticPartialResponseType |
Tipo di risposta parziale restituita per una richiesta di classificazione semantica. |
|
value |
Sequenza di risultati restituiti dalla query. |
SearchError
Descrive una condizione di errore per l'API.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Uno dei set definiti dal server di codici di errore. |
details |
Matrice di dettagli sugli errori specifici che hanno causato questo errore segnalato. |
|
message |
string |
Rappresentazione leggibile dell'errore. |
SearchMode
Specifica se è necessario trovare una corrispondenza con uno o tutti i termini di ricerca per includere il documento nel numero delle corrispondenze.
Nome | Tipo | Descrizione |
---|---|---|
all |
string |
Tutti i termini di ricerca devono essere confrontati per contare il documento come corrispondenza. |
any |
string |
Per contare il documento come corrispondenza, è necessario che i termini di ricerca corrispondano. |
SearchRequest
Parametri per il filtro, l'ordinamento, il facet, il paging e altri comportamenti delle query di ricerca.
Nome | Tipo | Descrizione |
---|---|---|
answers |
Valore che specifica se le risposte devono essere restituite come parte della risposta di ricerca. |
|
captions |
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. L'impostazione predefinita è false. L'impostazione di questo valore su true può avere un impatto sulle prestazioni. Si noti che il conteggio restituito è un'approssimazione. |
debug |
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 le evidenziazioni dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati. |
highlightPostTag |
string |
Tag stringa aggiunto per l'hit highlights. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>. |
highlightPreTag |
string |
Tag stringa anteporto ai punti di evidenziazione. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>. |
minimumCoverage |
number |
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 l'ordine crescente o desc per indicare la decrescente. Per impostazione predefinita, l'ordinamento è crescente. Le situazioni di parità di priorità vengono risolte in base ai 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 |
Valore che specifica il linguaggio della query di ricerca. |
|
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 di 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 da usare per la valutazione di punteggi di corrispondenza per i documenti corrispondenti, in modo da ordinare i risultati. |
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 in locale per una latenza inferiore. Il valore predefinito è "local". Usare "globale" 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 la corrispondenza 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 campi (fieldName:searchExpression) in una query Lucene completa, i nomi di campo di ogni espressione di ricerca campi hanno la precedenza su qualsiasi nome di campo elencato in questo parametro. |
searchMode |
Valore che specifica se qualsiasi o tutti i termini di ricerca devono essere confrontati 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 |
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 dei nomi di campo usati per la classificazione semantica. |
semanticMaxWaitInMilliseconds |
integer |
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 permanenti, che consente di ottenere risultati più coerenti. Purché venga usato 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 |
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 per una chiave completamente ordinata e filtrare con una query di intervallo. |
speller |
Valore che ha specificato il tipo del correttore ortografico da usare per correggere i singoli termini di query di ricerca. |
|
top |
integer |
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 sul 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 |
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter'. |
|
vectorQueries | VectorQuery[]: |
Parametri di query per query di ricerca ibrida e vettoriali. |
SearchResult
Contiene un documento trovato da una query di ricerca, oltre ai metadati associati.
Nome | Tipo | Descrizione |
---|---|---|
@search.captions |
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 |
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 in base a ogni campo applicabile; Null se l'evidenziazione dei risultati non è stata abilitata per la query. |
@search.rerankerScore |
number |
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 |
Punteggio di pertinenza del documento rispetto ad altri documenti restituiti dalla query. |
SemanticDebugInfo
Nome | Tipo | Descrizione |
---|---|---|
contentFields |
I campi di contenuto inviati al processo di arricchimento semantico, nonché il modo in cui sono stati usati |
|
keywordFields |
Campi parola chiave inviati al processo di arricchimento semantico, nonché come sono stati usati |
|
rerankerInput |
Stringhe concatenate non elaborate inviate al processo di arricchimento semantico. |
|
titleField |
Campo del titolo inviato al processo di arricchimento semantico, nonché come è stato usato |
SemanticErrorMode
Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).
Nome | Tipo | Descrizione |
---|---|---|
fail |
string |
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. |
partial |
string |
Se l'elaborazione semantica ha esito negativo, i risultati parziali vengono comunque restituiti. La definizione dei risultati parziali dipende dal passaggio semantico non riuscito e dal motivo dell'errore. |
SemanticErrorReason
Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.
Nome | Tipo | Descrizione |
---|---|---|
capacityOverloaded |
string |
La richiesta è stata limitata. Vengono restituiti solo i risultati di base. |
maxWaitExceeded |
string |
Se 'semanticMaxWaitInMilliseconds' è stato impostato e la durata di elaborazione semantica ha superato tale valore. Vengono restituiti solo i risultati di base. |
transient |
string |
Almeno un passaggio del processo semantico non è riuscito. |
SemanticFieldState
Modalità di utilizzo del campo per il processo di arricchimento semantico (completamente usato, parzialmente usato o inutilizzato)
Nome | Tipo | Descrizione |
---|---|---|
partial |
string |
Il campo è stato utilizzato parzialmente per l'arricchimento semantico. |
unused |
string |
Il campo non è stato utilizzato per l'arricchimento semantico. |
used |
string |
Il campo è stato utilizzato completamente per l'arricchimento semantico. |
SemanticSearchResultsType
Tipo di risposta parziale restituita per una richiesta di classificazione semantica.
Nome | Tipo | Descrizione |
---|---|---|
baseResults |
string |
Risultati senza arricchimento semantico o reranking. |
rerankedResults |
string |
I risultati sono stati classificati nuovamente con il modello reranker e includeranno didascalie semantiche. Non includeranno risposte, risposte evidenziate o didascalia evidenziazioni. |
VectorFilterMode
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale.
Nome | Tipo | Descrizione |
---|---|---|
postFilter |
string |
Il filtro verrà applicato dopo la restituzione del set candidato di risultati vettoriali. A seconda della selettività del filtro, ciò può comportare un minor numero di risultati rispetto a quello richiesto dal parametro 'k'. |
preFilter |
string |
Il filtro verrà applicato prima della query di ricerca. |
VectorizableTextQuery
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-near near 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 |
Numero di vicini più vicini da restituire come primi riscontri. |
kind |
string:
text |
Tipo di query vettoriale da eseguire. |
text |
string |
Testo da vettorizzare per eseguire una query di ricerca vettoriale. |
VectorQueryKind
Tipo di query vettoriale da eseguire.
Nome | Tipo | Descrizione |
---|---|---|
text |
string |
Query vettoriale in cui viene fornito un valore di testo che deve essere vettorializzato. |
vector |
string |
Query vettoriale in cui viene fornito un valore di vettore non elaborato. |