Documents - Search Get

Servizio:

Search Service

Versione API:

2024-07-01

Cerca documenti nell'indice.

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

Con parametri facoltativi:

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-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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.
$count	query		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.
$filter	query		string	L'espressione OData $filter da applicare alla query di ricerca.
$orderby	query		string[]	Elenco 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 e 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.
$select	query		string[]	Elenco di campi da recuperare. Se non specificato, vengono inclusi tutti i campi contrassegnati come recuperabili nello schema.
$skip	query		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 $filter con una query di intervallo.
$top	query		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.
answers	query		QueryAnswerType	Questo parametro è valido solo se il tipo di query è semantic. Se impostata, la query restituisce le risposte estratte dai passaggi chiave nei documenti classificati più alti. Il numero di risposte restituite può essere configurato aggiungendo il carattere pipe | seguito dall'opzione count-<number of answers> dopo il valore del parametro answers, ad esempio extractive|count-3. Il conteggio predefinito è 1. La soglia di attendibilità può essere configurata aggiungendo il carattere pipe | seguito dall'opzione threshold-<confidence threshold> dopo il valore del parametro answers, ad esempio extractive|threshold-0.9. La soglia predefinita è 0,7.
captions	query		QueryCaptionType	Questo parametro è valido solo se il tipo di query è semantic. Se impostata, la query restituisce le didascalie estratte dai passaggi chiave nei documenti classificati più alti. Quando Captions è impostato su extractive, l'evidenziazione è abilitata per impostazione predefinita e può essere configurata aggiungendo il carattere pipe | seguito dall'opzione highlight-<true/false>, ad esempio extractive|highlight-true. Il valore predefinito è None.
facet	query		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.
highlight	query		string[]	Elenco di nomi di campo da usare per l'evidenziazione dei risultati. Solo i campi ricercabili possono essere usati per l'evidenziazione dei risultati.
highlightPostTag	query		string	Tag stringa aggiunto per l'evidenziazione dei riscontri. Deve essere impostato con highlightPreTag. Il valore predefinito è </em>.
highlightPreTag	query		string	Tag stringa anteporto all'evidenziazione dei riscontri. Deve essere impostato con highlightPostTag. Il valore predefinito è <em>.
minimumCoverage	query		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.
queryType	query		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.
scoringParameter	query		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	query		string	Nome di un profilo di punteggio per valutare i punteggi di corrispondenza per i documenti corrispondenti per ordinare i risultati.
scoringStatistics	query		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.
search	query		string	Espressione di query di ricerca full-text; Usare "*" o omettere questo parametro per trovare le corrispondenze con tutti i documenti.
searchFields	query		string[]	Elenco 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	query		SearchMode	Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza.
semanticConfiguration	query		string	Nome della configurazione semantica che elenca i campi da usare per la classificazione semantica, le didascalie, le evidenziazioni e le risposte
semanticErrorHandling	query		SemanticErrorMode	Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente o restituire risultati parziali (impostazione predefinita).
semanticMaxWaitInMilliseconds	query		integer int32	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	query		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	query		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 '_'.

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.

Risposte

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

Esempio

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Esempio di richiesta

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-07-01

Risposta di esempio

Codice di stato:

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

Esempio di richiesta

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-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

Risposta di esempio

Codice di stato:

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

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.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
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.
QueryType	Specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene.
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.
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.
SemanticErrorMode	Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente (comportamento predefinito/corrente) o restituire risultati parziali.
SemanticErrorReason	Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.
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

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

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.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

QueryAnswerType

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

Nome	Tipo	Descrizione
extractive	string	Estrae i candidati di risposta dal contenuto dei documenti restituiti in risposta a una query espressa come domanda in 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.

QueryType

Specifica la sintassi della query di ricerca. Il valore predefinito è "simple". Usare "full" se la query usa la sintassi della query Lucene.

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-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	Numero di vicini più vicini da restituire come top hit.
kind	string: vector	Tipo di query vettoriale da eseguire.
oversampling	number	Fattore di sovracampionamento. Il valore minimo è 1. Esegue l'override del parametro 'defaultOversampling' configurato nella definizione dell'indice. Può essere impostato solo quando 'rerankWithOriginalVectors' è true. Questo parametro è consentito solo quando viene usato un metodo di compressione nel campo vettore sottostante.
vector	number[]	Rappresentazione vettoriale di una query di ricerca.
weight	number	Peso relativo della query vettoriale rispetto ad altre query vettoriali e/o alla query di testo all'interno della stessa richiesta di ricerca. Questo valore viene usato quando si combinano i risultati di più elenchi di classificazione prodotti dalle diverse query vettoriali e/o i risultati recuperati tramite la query di testo. Maggiore è il peso, maggiore sarà il numero di documenti corrispondenti alla query nella classificazione finale. Il valore predefinito è 1,0 e il valore deve essere un numero positivo maggiore di zero.

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.

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 in locale per una latenza inferiore.

SearchDocumentsResult

Risposta contenente i risultati della ricerca da un indice.

Nome	Tipo	Descrizione
@odata.count	integer	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	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.

SearchMode

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

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

SearchRequest

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.
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	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.
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 (comportamento predefinito/corrente) o restituire risultati parziali.
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 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	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.
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	VectorFilterMode	Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter' per i nuovi indici.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parametri di query per le 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	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.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	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.

SemanticErrorMode

Consente all'utente di scegliere se una chiamata semantica deve avere esito negativo completamente (comportamento predefinito/corrente) o restituire risultati parziali.

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 non riesce, 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. Sono stati restituiti solo i risultati di base.
maxWaitExceeded	string	Se semanticMaxWaitInMilliseconds è stato impostato e la durata dell'elaborazione semantica ha superato tale valore. Sono stati restituiti solo i risultati di base.
transient	string	Almeno un passaggio del processo semantico non è riuscito.

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 rivalutati con il modello reranker e includeranno didascalie semantiche. Non includeranno risposte, risposte evidenziate o didascalie.

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, questo può comportare un minor numero di risultati rispetto a quanto 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-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	Numero di vicini più vicini da restituire come top hit.
kind	string: text	Tipo di query vettoriale da eseguire.
oversampling	number	Fattore di sovracampionamento. Il valore minimo è 1. Esegue l'override del parametro 'defaultOversampling' configurato nella definizione dell'indice. Può essere impostato solo quando 'rerankWithOriginalVectors' è true. Questo parametro è consentito solo quando viene usato un metodo di compressione nel campo vettore sottostante.
text	string	Testo da vettorizzare per eseguire una query di ricerca vettoriale.
weight	number	Peso relativo della query vettoriale rispetto ad altre query vettoriali e/o alla query di testo all'interno della stessa richiesta di ricerca. Questo valore viene usato quando si combinano i risultati di più elenchi di classificazione prodotti dalle diverse query vettoriali e/o i risultati recuperati tramite la query di testo. Maggiore è il peso, maggiore sarà il numero di documenti corrispondenti alla query nella classificazione finale. Il valore predefinito è 1,0 e il valore deve essere un numero positivo maggiore di zero.

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 vettoriale non elaborato.