Documents - Search Post
Cerca i documenti nell'indice.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-04-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL dell'endpoint del servizio di ricerca. |
|
index
|
path | True |
string |
Nome dell'indice. |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| Accept |
L'intestazione Accetta. |
||
| x-ms-client-request-id |
string (uuid) |
Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta. |
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. 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 |
Abilita uno strumento di debug che può essere utilizzato per esplorare ulteriormente i risultati riclassificati. |
|
| 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. L'impostazione predefinita è 100. |
| orderby |
string |
L'elenco delimitato da virgole di OData $orderby espressioni in base alle quali 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 |
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 |
Un valore che specifica se si desidera calcolare le statistiche di punteggio (ad esempio la frequenza dei documenti) a livello globale per un punteggio più coerente o a livello locale, per una latenza inferiore. Il valore predefinito è 'locale'. Utilizza "globale" per aggregare le statistiche di punteggio a livello globale prima di segnare. L'uso delle statistiche di punteggio globali può aumentare la latenza delle query di ricerca. |
|
| search |
string |
Un'espressione di query di ricerca full-text; Utilizzare "*" o omettere questo parametro per la corrispondenza di 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 |
Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza. |
|
| select |
string |
L'elenco delimitato da virgole dei 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 completo (comportamento predefinito/corrente) o se deve restituire risultati parziali. |
|
| 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 |
Un valore da utilizzare per creare una sessione permanente, che può aiutare a 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. |
| 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 |
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter' per i nuovi indici. |
|
| vectorQueries | VectorQuery[]: |
Parametri di query per le query di ricerca ibrida e vettoriali. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. |
|
| Other Status Codes |
Operazione completata |
|
| Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
api-key
Tipo:
apiKey
In:
header
OAuth2Auth
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://search.azure.com/.default |
Esempio
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Esempio di richiesta
POST https://exampleservice.search.windows.net/indexes('test-index')/docs/search.post.search?api-version=2026-04-01
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1
}
],
"vectorFilterMode": "preFilter"
}
Risposta di esempio
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "This is a caption from the document.",
"highlights": "This is a <em>caption</em> from the document."
}
],
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}
SearchIndexSearchDocumentsSemanticPost
Esempio di richiesta
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
Risposta di esempio
{
"@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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01"
}
{
"@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
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"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"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-04-01"
}
Definizioni
| Nome | Descrizione |
|---|---|
| Accept |
L'intestazione Accetta. |
|
Document |
Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca. |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Error |
Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData. |
|
Query |
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. |
|
Query |
Questo parametro è valido solo se il tipo di query è |
|
Query |
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 |
|
Query |
Questo parametro è valido solo se il tipo di query è |
|
Query |
Abilita uno strumento di debug che può essere utilizzato per esplorare ulteriormente i risultati della ricerca. È possibile abilitare più modalità di debug contemporaneamente separandole con un | carattere, ad esempio: semantic|queryRewrites. |
|
Query |
Suddivisione dei caratteri di sottolineatura tra i componenti di query di testo e vettore della query di ricerca per questo documento. Ogni query vettoriale viene visualizzata come oggetto separato nello stesso ordine in cui sono stati ricevuti. |
|
Query |
Specifica la sintassi della query di ricerca. Il valore predefinito è 'simple'. Utilizzare 'full' se la query utilizza la sintassi della query Lucene e 'semantic' se la sintassi della query non è necessaria. |
|
Scoring |
Un valore che specifica se si desidera calcolare le statistiche di punteggio (ad esempio la frequenza dei documenti) a livello globale per un punteggio più coerente o a livello locale, per una latenza inferiore. Il valore predefinito è 'locale'. Utilizza "globale" per aggregare le statistiche di punteggio a livello globale prima di segnare. L'uso delle statistiche di punteggio globali può aumentare la latenza delle query di ricerca. |
|
Search |
Risposta contenente i risultati della ricerca da un indice. |
|
Search |
Specifica se è necessario trovare una corrispondenza tra uno o tutti i termini di ricerca per poter conteggiare il documento come corrispondenza. |
|
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 |
Permette all'utente di scegliere se una chiamata semantica fallisca completamente o di restituire risultati parziali. |
|
Semantic |
Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica. |
|
Semantic |
Tipo di risposta parziale restituita per una richiesta di classificazione semantica. |
|
Single |
Risultato di un singolo campo vettoriale. Entrambi |
|
Text |
Punteggio BM25 o Classico per la parte di testo della query. |
|
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 file binario con codifica base 64 di un'immagine che deve essere vettorializzata. |
|
Vectorizable |
Parametri di query da usare per la ricerca vettoriale quando viene fornito un URL che rappresenta un valore di immagine che deve essere vettorializzato. |
|
Vectorizable |
Parametri di query da usare per la ricerca vettoriale quando viene fornito un valore di testo che deve essere vettorializzato. |
|
Vectorized |
Parametri di query da usare per la ricerca vettoriale quando viene specificato un valore di vettore non elaborato. |
|
Vector |
Tipo di query vettoriale eseguita. |
|
Vectors |
"Contiene informazioni di debug specifiche per la ricerca vettoriale e ibrida.") |
Accept
L'intestazione Accetta.
| Valore | Descrizione |
|---|---|
| application/json;odata.metadata=none |
DocumentDebugInfo
Contiene informazioni di debug che possono essere usate per esplorare ulteriormente i risultati della ricerca.
| Nome | Tipo | Descrizione |
|---|---|---|
| vectors |
Contiene informazioni di debug specifiche per la ricerca ibrida e vettoriale. |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
Informazioni aggiuntive. |
|
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
Destinazione dell'errore. |
ErrorResponse
Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
QueryAnswerResult
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. |
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 confidenza 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. La lunghezza massima dei caratteri delle risposte può essere configurata aggiungendo il carattere pipe '|' seguito dal 'numero di conteggio< della lunghezza> massima dei caratteri', ad esempio 'extractive|maxcharlength-600'.
| Valore | Descrizione |
|---|---|
| none |
Non restituisce 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. |
QueryCaptionResult
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. |
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 Didascalie è 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. Di default è None. La lunghezza massima dei caratteri delle didascalie può essere configurata aggiungendo il carattere pipe '|' seguito dal 'numero di conteggio< della lunghezza> massima dei caratteri', ad esempio 'extractive|maxcharlength-600'.
| 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
Abilita uno strumento di debug che può essere utilizzato per esplorare ulteriormente i risultati della ricerca. È possibile abilitare più modalità di debug contemporaneamente separandole con un | carattere, ad esempio: semantic|queryRewrites.
| Valore | Descrizione |
|---|---|
| disabled |
Non verranno restituite informazioni di debug delle query. |
| semantic |
Consente all'utente di esplorare ulteriormente i risultati classificati. |
| vector |
Consente all'utente di esplorare ulteriormente i risultati delle query ibride e vettoriali. |
| queryRewrites |
Consente all'utente di esplorare l'elenco di riscritture delle query generate per la richiesta di ricerca. |
| innerHits |
Consente all'utente di recuperare le informazioni sul punteggio relative ai vettori corrispondenti all'interno di una raccolta di tipi complessi. |
| all |
Attivare tutte le opzioni di debug. |
QueryResultDocumentSubscores
Suddivisione dei caratteri di sottolineatura tra i componenti di query di testo e vettore della query di ricerca per questo documento. Ogni query vettoriale viene visualizzata come oggetto separato nello stesso ordine in cui sono stati ricevuti.
| Nome | Tipo | Descrizione |
|---|---|---|
| documentBoost |
number (double) |
Punteggio BM25 o Classico per la parte di testo della query. |
| text |
Punteggio BM25 o Classico per la parte di testo della query. |
|
| vectors |
<string,
Single |
La somiglianza vettoriale e |
QueryType
Specifica la sintassi della query di ricerca. Il valore predefinito è 'simple'. Utilizzare 'full' se la query utilizza la sintassi della query Lucene e 'semantic' se la sintassi della query non è necessaria.
| Valore | Descrizione |
|---|---|
| simple |
Utilizza la sintassi di query semplice per le ricerche. Il testo di ricerca viene interpretato utilizzando un semplice linguaggio di query che consente l'uso di simboli come +, * e "". Per impostazione predefinita, le query vengono valutate in tutti i campi in cui è possibile eseguire la ricerca, a meno che non venga specificato il parametro searchFields. |
| full |
Utilizza la sintassi di query Lucene completa per le ricerche. Il testo di ricerca viene interpretato utilizzando il linguaggio di query Lucene, che consente ricerche specifiche per campo e ponderate, oltre ad altre funzionalità avanzate. |
| semantic |
Ideale per query espresse in linguaggio naturale anziché con parole chiave. Migliora la precisione dei risultati di ricerca riclassificando i primi risultati di ricerca utilizzando un modello di classificazione addestrato sul corpus Web. |
ScoringStatistics
Un valore che specifica se si desidera calcolare le statistiche di punteggio (ad esempio la frequenza dei documenti) a livello globale per un punteggio più coerente o a livello locale, per una latenza inferiore. Il valore predefinito è 'locale'. Utilizza "globale" per aggregare le statistiche di punteggio a livello globale prima di segnare. L'uso delle statistiche di punteggio globali può aumentare la latenza delle query di ricerca.
| Valore | Descrizione |
|---|---|
| local |
Le statistiche di punteggio verranno calcolate localmente per ridurre la latenza. |
| global |
Le statistiche di punteggio saranno calcolate a livello globale per un punteggio più coerente. |
SearchDocumentsResult
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. Questo problema può verificarsi se si utilizzano i parametri $top o $skip o se la query non è in grado di restituire tutti i documenti richiesti in un'unica risposta. |
| @odata.nextLink |
string |
URL di continuazione restituito quando la query non è in grado di restituire tutti i risultati richiesti in un'unica risposta. È possibile utilizzare questo URL per formulare un'altra richiesta di ricerca GET o POST per ottenere la parte successiva della risposta di ricerca. Assicurati di utilizzare lo stesso verbo (GET o POST) della richiesta che ha prodotto 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 (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 |
Payload JSON di continuazione restituito quando la query non è in grado di restituire tutti i risultati richiesti in un'unica risposta. Puoi usare questo JSON insieme a |
|
| @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. |
SearchMode
Specifica se è necessario trovare una corrispondenza tra uno o tutti i termini di ricerca per poter conteggiare il documento come corrispondenza.
| Valore | Descrizione |
|---|---|
| any |
Per poter contare il documento come corrispondenza, è necessario trovare una corrispondenza tra i termini di ricerca. |
| all |
Tutti i termini di ricerca devono essere abbinati per poter contare il documento come corrispondenza. |
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. 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 |
Abilita uno strumento di debug che può essere utilizzato per esplorare ulteriormente i risultati riclassificati. |
|
| 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. L'impostazione predefinita è 100. |
| orderby |
string |
L'elenco delimitato da virgole di OData $orderby espressioni in base alle quali 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 |
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 |
Un valore che specifica se si desidera calcolare le statistiche di punteggio (ad esempio la frequenza dei documenti) a livello globale per un punteggio più coerente o a livello locale, per una latenza inferiore. Il valore predefinito è 'locale'. Utilizza "globale" per aggregare le statistiche di punteggio a livello globale prima di segnare. L'uso delle statistiche di punteggio globali può aumentare la latenza delle query di ricerca. |
|
| search |
string |
Un'espressione di query di ricerca full-text; Utilizzare "*" o omettere questo parametro per la corrispondenza di 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 |
Valore che specifica se uno o tutti i termini di ricerca devono essere corrispondenti per contare il documento come corrispondenza. |
|
| select |
string |
L'elenco delimitato da virgole dei 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 completo (comportamento predefinito/corrente) o se deve restituire risultati parziali. |
|
| 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 |
Un valore da utilizzare per creare una sessione permanente, che può aiutare a 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. |
| 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 |
Determina se i filtri vengono applicati prima o dopo l'esecuzione della ricerca vettoriale. Il valore predefinito è 'preFilter' per i nuovi indici. |
|
| vectorQueries | VectorQuery[]: |
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 |
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 'semantico'. |
|
| @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 ciascun campo applicabile; null se l'evidenziazione dei risultati non è stata abilitata per la query. |
| @search.rerankerBoostedScore |
number (double) |
Il punteggio di pertinenza calcolato aumentando il punteggio Reranker. I risultati della ricerca sono ordinati per RerankerScore/RerankerBoostedScore basandosi su useScoringProfileBoostedRanking nella Configurazione Semantica. RerankerBoostedScore viene restituito solo per query di tipo 'semantica'. |
| @search.rerankerScore |
number (double) |
Punteggio di pertinenza calcolato dal classificatore semantico per i primi risultati di ricerca. I risultati della ricerca vengono ordinati prima in base al RerankerScore e poi in base al punteggio. RerankerScore viene restituito solo per le query di tipo 'semantico'. |
| @search.score |
number (double) |
Punteggio di pertinenza del documento rispetto ad altri documenti restituiti dalla query. |
SemanticErrorMode
Permette all'utente di scegliere se una chiamata semantica fallisca completamente o di restituire risultati parziali.
| 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
Motivo per cui è stata restituita una risposta parziale per una richiesta di classificazione semantica.
| Valore | Descrizione |
|---|---|
| maxWaitExceeded |
Se |
| capacityOverloaded |
La richiesta è stata limitata. Sono stati restituiti solo i risultati di base. |
| transient |
Almeno un passaggio del processo semantico non è riuscito. |
SemanticSearchResultsType
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. |
SingleVectorFieldResult
Risultato di un singolo campo vettoriale. Entrambi
| Nome | Tipo | Descrizione |
|---|---|---|
| searchScore |
number (double) |
Le |
| vectorSimilarity |
number (double) |
Punteggio di somiglianza vettoriale per questo documento. Si noti che si tratta della definizione canonica della metrica di somiglianza, non della versione "distance". Ad esempio, la somiglianza del coseno invece della distanza del coseno. |
TextResult
Punteggio BM25 o Classico per la parte di testo della query.
| Nome | Tipo | Descrizione |
|---|---|---|
| searchScore |
number (double) |
Punteggio BM25 o Classico per la parte di testo della query. |
VectorFilterMode
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. |
| strictPostFilter |
Il filtro verrà applicato dopo che viene restituito il set globale di risultati vettoriali candidati top-k. Ciò si tradurrà in un numero di risultati inferiore a quello richiesto dal parametro 'k'. |
VectorizableImageBinaryQuery
Parametri di query da usare per la ricerca vettoriale quando viene fornito un file binario con codifica base 64 di un'immagine che deve essere vettorializzata.
| Nome | Tipo | Descrizione |
|---|---|---|
| base64Image |
string |
Il binario codificato in base 64 di un'immagine da vettorializzare per eseguire una query di ricerca vettoriale. |
| 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:
image |
Tipo di query. |
| oversampling |
number (double) |
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. |
| weight |
number (float) |
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. |
VectorizableImageUrlQuery
Parametri di query da usare per la ricerca vettoriale quando viene fornito un URL che rappresenta un valore di immagine 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:
image |
Tipo di query. |
| oversampling |
number (double) |
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. |
| url |
string |
URL di un'immagine da vettorizzare per eseguire una query di ricerca vettoriale. |
| weight |
number (float) |
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. |
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 (int32) |
Numero di vicini più vicini da restituire come top hit. |
| kind |
string:
text |
Tipo di query. |
| oversampling |
number (double) |
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 (float) |
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. |
VectorizedQuery
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. |
| oversampling |
number (double) |
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[] (float) |
Rappresentazione vettoriale di una query di ricerca. |
| weight |
number (float) |
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 eseguita.
| 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. |
| imageUrl |
Query vettoriale in cui viene fornito un URL che rappresenta un valore di immagine che deve essere vettorializzato. |
| imageBinary |
Query vettoriale in cui viene fornito un file binario codificato in base 64 di un'immagine che deve essere vettorializzata. |
VectorsDebugInfo
"Contiene informazioni di debug specifiche per la ricerca vettoriale e ibrida.")
| Nome | Tipo | Descrizione |
|---|---|---|
| subscores |
La suddivisione dei punteggi parziali del documento prima del metodo di fusione/combinazione del set di risultati scelto, ad esempio RRF. |