- Risorsa: valutazione
- EvaluationSpec
- ImageQuery
- FacetSpec
- FacetKey
- Intervallo
- QueryExpansionSpec
- Condizione
- SpellCorrectionSpec
- Modalità
- EmbeddingSpec
- EmbeddingVector
- RankingExpressionBackend
- NaturalLanguageQueryUnderstandingSpec
- FilterExtractionCondition
- ExtractedFilterBehavior
- SearchAsYouTypeSpec
- Condizione
- DisplaySpec
- MatchHighlightingCondition
- SessionSpec
- RelevanceThreshold
- RelevanceScoreSpec
- SearchAddonSpec
- QuerySetSpec
- QualityMetrics
- TopkMetrics
- Stato
- Metodi
Risorsa: valutazione
Una valutazione è una singola esecuzione (o run) di un processo di valutazione. Incapsula lo stato della valutazione e i dati risultanti.
Rappresentazione JSON |
---|
{ "name": string, "evaluationSpec": { object ( |
Campi | |
---|---|
name |
Identificatore. Il nome completo della risorsa di Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri. |
evaluationSpec |
Obbligatorio. La specifica della valutazione. |
qualityMetrics |
Solo output. Le metriche prodotte dalla valutazione, calcolate in media su tutti i Compilato solo quando lo stato della valutazione è RIUSCITO. |
state |
Solo output. Lo stato della valutazione. |
error |
Solo output. L'errore che si è verificato durante la valutazione. Viene compilato solo quando lo stato della valutazione è FAILED. |
createTime |
Solo output. Timestamp della creazione di Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
endTime |
Solo output. Timestamp del completamento di Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: |
errorSamples[] |
Solo output. Un campione degli errori riscontrati durante l'elaborazione della richiesta. |
EvaluationSpec
Descrive la specifica della valutazione.
Rappresentazione JSON |
---|
{ "querySetSpec": { object ( |
Campi | |
---|---|
querySetSpec |
Facoltativo. La specifica dell'insieme di query. |
Campo unione search_spec . La specifica di ricerca. search_spec può essere solo uno dei seguenti: |
|
searchRequest |
Obbligatorio. La richiesta di ricerca utilizzata per eseguire la valutazione. Sono supportati solo i seguenti campi all'interno di SearchRequest; se vengono forniti altri campi, verrà restituito un errore UNSUPPORTED: |
ImageQuery
Specifica l'input della query di immagini.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione
|
|
imageBytes |
Byte dell'immagine con codifica Base64. Formati immagine supportati: JPEG, PNG e BMP. |
FacetSpec
Una specifica del facet per eseguire la ricerca con facet.
Rappresentazione JSON |
---|
{
"facetKey": {
object ( |
Campi | |
---|---|
facetKey |
Obbligatorio. La specifica della chiave facet. |
limit |
Numero massimo di valori di facet restituiti per questo facet. Se non specificato, il valore predefinito è 20. Il valore massimo consentito è 300. I valori superiori a 300 vengono forzati a 300. Per l'aggregazione nella ricerca nel settore sanitario, quando [FacetKey.key] è "healthcare_aggregation_key", il limite verrà sostituito internamente con 10.000, indipendentemente dal valore impostato qui. Se questo campo è negativo, viene restituito un |
excludedFilterKeys[] |
Elenco delle chiavi da escludere durante la creazione di sfaccettature. Per impostazione predefinita, L'elenco di una chiave di facet in questo campo consente di visualizzare i relativi valori come risultati di facet, anche se sono filtrati dai risultati di ricerca. L'utilizzo di questo campo non influisce sui risultati di ricerca restituiti. Ad esempio, supponiamo che ci siano 100 documenti con la sfaccettatura di colore "Rosso" e 200 documenti con la sfaccettatura di colore "Blu". Una query contenente il filtro "color:ANY("Red")" e con "color" come Se "color" è elencato in "excludedFilterKeys", la query restituisce i valori della sfaccettatura "Red" con conteggio 100 e "Blue" con conteggio 200, perché la chiave "color" è ora esclusa dal filtro. Poiché questo campo non influisce sui risultati di ricerca, questi ultimi vengono comunque filtrati correttamente per restituire solo i documenti "Rossi". Sono consentiti massimo 100 valori. In caso contrario, viene restituito un errore |
enableDynamicPosition |
Attiva la posizione dinamica per questo facet. Se è impostata su true, la posizione di questa sfaccettatura tra tutte le sfaccettature nella risposta viene determinata automaticamente. Se i facet dinamici sono abilitati, vengono ordinati insieme. Se impostato su false, la posizione di questo facet nella risposta è la stessa della richiesta e viene classificato prima dei facet con posizione dinamica abilitata e di tutti i facet dinamici. Ad esempio, potresti voler sempre restituire la sfaccettatura della valutazione nella risposta, ma non è necessario visualizzarla sempre in alto. In questo caso, puoi impostare enableDynamicPosition su true in modo che la posizione del facet di valutazione nella risposta venga determinata automaticamente. Un altro esempio, supponendo di avere i seguenti facet nella richiesta:
Inoltre, hai attivato i facet dinamici, che generano un facet |
FacetKey
Specifica come viene calcolata una sfaccettatura.
Rappresentazione JSON |
---|
{
"key": string,
"intervals": [
{
object ( |
Campi | |
---|---|
key |
Obbligatorio. Chiavi di sfaccettatura testuali e numeriche supportate nell'oggetto |
intervals[] |
Imposta solo se i valori devono essere suddivisi in bucket in intervalli. Deve essere impostato per le sfaccettature con valori numerici. Non deve essere impostato per il facet con valori di testo. Il numero massimo di intervalli è 30. |
restrictedValues[] |
Ottieni solo la sfaccettatura per i valori con limitazioni specificati. Supportato solo sui campi di testo. Ad esempio, supponiamo che "category" abbia tre valori: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se imposti "restrictedValues" su "Azione > 2022", la sfaccettatura "category" (categoria) contiene solo "Azione > 2022". Supportato solo sui campi di testo. Il valore massimo è 10. |
prefixes[] |
Recupera solo i valori delle sfaccettature che iniziano con il prefisso della stringa specificato. Ad esempio, supponiamo che "category" abbia tre valori: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se imposti "prefissi" su "Azione", la sfaccettatura "categoria" contiene solo "Azione > 2022" e "Azione > 2021". Supportato solo sui campi di testo. Il valore massimo è 10. |
contains[] |
Recupera solo i valori delle sfaccettature che contengono le stringhe specificate. Ad esempio, supponiamo che "category" abbia tre valori: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se imposti "contiene" su "2022", la sfaccettatura "categoria" contiene solo "Azione > 2022" e "Fantascienza > 2022". Supportato solo sui campi di testo. Il valore massimo è 10. |
caseInsensitive |
True per rendere le chiavi di sfaccettatura non sensibili alle maiuscole e minuscole quando si ottengono valori di sfaccettatura con prefissi o contiene; false in caso contrario. |
orderBy |
L'ordine in cui vengono restituiti i documenti. I valori consentiti sono:
Se non viene impostato, i valori testuali vengono ordinati in ordine naturale; gli intervalli numerici vengono ordinati nell'ordine indicato da |
Intervallo
Un intervallo con rappresentazione in virgola mobile.
Rappresentazione JSON |
---|
{ // Union field |
Campi | |
---|---|
Campo unione Questo campo non deve essere maggiore del valore massimo. In caso contrario, viene restituito un errore |
|
minimum |
Limite inferiore inclusivo. |
exclusiveMinimum |
Limite inferiore esclusivo. |
Campo unione Questo campo non deve essere inferiore al valore minimo. In caso contrario, viene restituito un errore |
|
maximum |
Limite superiore inclusivo. |
exclusiveMaximum |
Limite superiore esclusivo. |
QueryExpansionSpec
Specifica per determinare in quali condizioni deve verificarsi l'espansione della query.
Rappresentazione JSON |
---|
{
"condition": enum ( |
Campi | |
---|---|
condition |
La condizione in base alla quale deve verificarsi l'espansione delle query. Il valore predefinito è |
pinUnexpandedResults |
Se bloccare i risultati non espansi. Se questo campo è impostato su true, i prodotti non espansi si trovano sempre nella parte superiore dei risultati di ricerca, seguiti dai risultati espansi. |
Condizione
Enumerazione che descrive in quale condizione deve verificarsi l'espansione della query.
Enum | |
---|---|
CONDITION_UNSPECIFIED |
Condizione di espansione delle query non specificata. In questo caso, il comportamento del server è impostato su Condition.DISABLED per impostazione predefinita. |
DISABLED |
Espansione delle query disattivata. Viene utilizzata solo la query di ricerca esatta, anche se SearchResponse.total_size è pari a zero. |
AUTO |
Espansione automatica delle query creata dall'API Search. |
SpellCorrectionSpec
La specifica per la correzione ortografica delle query.
Rappresentazione JSON |
---|
{
"mode": enum ( |
Campi | |
---|---|
mode |
La modalità in cui la correzione ortografica sostituisce la query di ricerca originale. Il valore predefinito è |
Modalità
Enumerazione che descrive in quale modalità deve essere eseguita la correzione ortografica.
Enum | |
---|---|
MODE_UNSPECIFIED |
Modalità di correzione ortografica non specificata. In questo caso, il comportamento del server è impostato su Mode.AUTO per impostazione predefinita. |
SUGGESTION_ONLY |
L'API Search tenta di trovare un suggerimento ortografico. Se viene trovato un suggerimento, questo viene inserito in SearchResponse.corrected_query . Il suggerimento ortografico non verrà utilizzato come query di ricerca. |
AUTO |
Correzione ortografica automatica integrata nell'API Search. La ricerca si baserà sulla query corretta, se trovata. |
EmbeddingSpec
La specifica che utilizza il vettore di incorporamento delle query personalizzato per eseguire il recupero semantico dei documenti.
Rappresentazione JSON |
---|
{
"embeddingVectors": [
{
object ( |
Campi | |
---|---|
embeddingVectors[] |
Il vettore di embedding utilizzato per il recupero. Limita a 1. |
EmbeddingVector
Vettore di embedding.
Rappresentazione JSON |
---|
{ "fieldPath": string, "vector": [ number ] } |
Campi | |
---|---|
fieldPath |
Percorso campo di embedding nello schema. |
vector[] |
Vettore di embedding della query. |
RankingExpressionBackend
Il backend da utilizzare per la valutazione dell'espressione di ranking.
Enum | |
---|---|
RANKING_EXPRESSION_BACKEND_UNSPECIFIED |
Opzione predefinita per i valori non specificati/sconosciuti. |
BYOE |
Deprecato: utilizza |
CLEARBOX |
Deprecato: utilizza |
RANK_BY_EMBEDDING |
Classificazione in base al modello di incorporamento personalizzato, il modo predefinito per valutare l'espressione di ranking. |
RANK_BY_FORMULA |
Classifica in base alla formula personalizzata. |
NaturalLanguageQueryUnderstandingSpec
Specifica per abilitare le funzionalità di comprensione del linguaggio naturale per le richieste di ricerca.
Rappresentazione JSON |
---|
{ "filterExtractionCondition": enum ( |
Campi | |
---|---|
filterExtractionCondition |
La condizione in base alla quale deve essere eseguita l'estrazione del filtro. Il comportamento del server è impostato per impostazione predefinita su |
geoSearchQueryDetectionFieldNames[] |
Nomi dei campi utilizzati per il filtro basato sulla posizione, in cui i filtri di geolocalizzazione vengono rilevati nelle query di ricerca in linguaggio naturale. Valido solo quando FilterExtractionCondition è impostato su Se questo campo è impostato, sostituisce i nomi dei campi impostati in |
extractedFilterBehavior |
Facoltativo. Controlla il comportamento di applicazione dei filtri estratti alla ricerca. Il comportamento predefinito dipende dalla richiesta. Per la ricerca strutturata in un singolo datastore, il valore predefinito è |
allowedFieldNames[] |
Facoltativo. Elenco consentito di campi che possono essere utilizzati per l'estrazione di filtri in linguaggio naturale. Per impostazione predefinita, se non viene specificato, tutti i campi indicizzabili sono idonei all'estrazione del filtro in linguaggio naturale (ma non è garantito che vengano utilizzati). Se vengono specificati dei campi in allowedFieldNames, solo i campi contrassegnati come indicizzabili nello schema e specificati nella lista consentita saranno idonei per l'estrazione dei filtri in linguaggio naturale. Nota: per la ricerca in più datastore, questa funzionalità non è ancora supportata e verrà ignorata. |
FilterExtractionCondition
Enumerazione che descrive in quale condizione deve avvenire l'estrazione del filtro.
Enum | |
---|---|
CONDITION_UNSPECIFIED |
Il comportamento del server è impostato per impostazione predefinita su DISABLED . |
DISABLED |
Disattiva l'estrazione dei filtri NL. |
ENABLED |
Consente l'estrazione dei filtri NL. |
ExtractedFilterBehavior
Enumerazione che descrive come i filtri estratti vengono applicati alla ricerca.
Enum | |
---|---|
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED |
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED utilizzerà il comportamento predefinito per i filtri estratti. Per la ricerca in un singolo datastore, il comportamento predefinito è l'applicazione come filtri rigidi. Per la ricerca in più datastore, l'impostazione predefinita prevede l'applicazione come soft boost. |
HARD_FILTER |
Applica tutti i filtri estratti come filtri rigidi ai risultati. I risultati che non superano i filtri estratti non verranno restituiti nel set di risultati. |
SOFT_BOOST |
Applica tutti i filtri estratti come aggiustamenti morbidi. I risultati che superano i filtri verranno promossi a posizioni più elevate nel set di risultati. |
SearchAsYouTypeSpec
Specifica per la ricerca durante la digitazione nelle richieste di ricerca.
Rappresentazione JSON |
---|
{
"condition": enum ( |
Campi | |
---|---|
condition |
La condizione in base alla quale deve verificarsi la ricerca durante la digitazione. Il valore predefinito è |
Condizione
Enumerazione che descrive in quale condizione deve verificarsi la ricerca durante la digitazione.
Enum | |
---|---|
CONDITION_UNSPECIFIED |
Il comportamento del server è impostato per impostazione predefinita su Condition.DISABLED . |
DISABLED |
Disattiva la ricerca durante la digitazione. |
ENABLED |
Attiva la ricerca durante la digitazione. |
AUTO |
Passaggio automatico tra le modalità di ricerca durante la digitazione e ricerca standard, ideale per implementazioni di una sola API (ad es. debouncing). |
DisplaySpec
Specifica le funzionalità di visualizzazione, come l'evidenziazione delle corrispondenze.
Rappresentazione JSON |
---|
{
"matchHighlightingCondition": enum ( |
Campi | |
---|---|
matchHighlightingCondition |
La condizione in base alla quale deve verificarsi l'evidenziazione della corrispondenza. |
MatchHighlightingCondition
Enumerazione che descrive in quale condizione deve verificarsi l'evidenziazione della corrispondenza.
Enum | |
---|---|
MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED |
Il comportamento del server è lo stesso di MATCH_HIGHLIGHTING_DISABLED . |
MATCH_HIGHLIGHTING_DISABLED |
Disattiva l'evidenziazione delle corrispondenze in tutti i documenti. |
MATCH_HIGHLIGHTING_ENABLED |
Attiva l'evidenziazione delle corrispondenze in tutti i documenti. |
SessionSpec
Specifica della sessione.
La funzionalità di ricerca multiconversazione è attualmente in fase GA privata. Utilizza la versione v1alpha o v1beta prima del lancio di questa funzionalità in disponibilità generale pubblica. In alternativa, richiedi l'inserimento nella lista consentita tramite il team di assistenza Google.
Rappresentazione JSON |
---|
{ "queryId": string, "searchResultPersistenceCount": integer } |
Campi | |
---|---|
queryId |
Se impostato, il risultato di ricerca viene memorizzato nel "turno" specificato da questo ID query. Esempio: supponiamo che la sessione sia la seguente: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" queryId: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" queryId: ".../questions/zzz" } } } L'utente può chiamare l'API /search con una richiesta come questa: session: ".../sessions/xxx" sessionSpec { queryId: ".../questions/zzz" } L'API memorizza quindi il risultato della ricerca, associato all'ultimo turno. Il risultato della ricerca memorizzato può essere utilizzato da una successiva chiamata API /answer (con l'ID sessione e l'ID query specificati). Inoltre, è possibile chiamare /search e /answer in parallelo con lo stesso ID sessione e ID query. |
searchResultPersistenceCount |
Il numero di risultati di ricerca principali da conservare. I risultati di ricerca persistenti possono essere utilizzati per la successiva chiamata API /answer. Questo campo è simile al campo Al massimo 10 risultati per la modalità Documenti o 50 per la modalità Chunk. |
RelevanceThreshold
La soglia di pertinenza dei risultati di ricerca. Maggiore è la soglia di pertinenza, maggiore è il numero di risultati pertinenti mostrati e minore è il numero di risultati restituiti.
Enum | |
---|---|
RELEVANCE_THRESHOLD_UNSPECIFIED |
Valore predefinito. In questo caso, il comportamento del server è impostato sulla soglia definita da Google. |
LOWEST |
Soglia di pertinenza più bassa. |
LOW |
Soglia di pertinenza bassa. |
MEDIUM |
Soglia di pertinenza media. |
HIGH |
Soglia di pertinenza elevata. |
RelevanceScoreSpec
La specifica per la restituzione del punteggio di pertinenza del documento.
Rappresentazione JSON |
---|
{ "returnRelevanceScore": boolean } |
Campi | |
---|---|
returnRelevanceScore |
Facoltativo. Indica se restituire il punteggio di pertinenza per i risultati di ricerca. Più alto è il punteggio, più pertinente è il documento rispetto alla query. |
SearchAddonSpec
SearchAddonSpec viene utilizzato per disattivare i componenti aggiuntivi per la ricerca in base al nuovo modello di ricalcolo dei prezzi. Per impostazione predefinita, se SearchAddonSpec non è specificato, riteniamo che il cliente voglia attivarli ovunque applicabile.
Rappresentazione JSON |
---|
{ "disableSemanticAddOn": boolean, "disableKpiPersonalizationAddOn": boolean, "disableGenerativeAnswerAddOn": boolean } |
Campi | |
---|---|
disableSemanticAddOn |
Facoltativo. Se è true, il componente aggiuntivo semantico è disattivato. Il componente aggiuntivo semantico include incorporamenti e jetstream. |
disableKpiPersonalizationAddOn |
Facoltativo. Se è true, disattiva la riassegnazione del ranking e la personalizzazione degli eventi per ottimizzare i KPI e personalizzare i risultati. |
disableGenerativeAnswerAddOn |
Facoltativo. Se è true, il componente aggiuntivo per le risposte di AI generativa è disattivato. Il componente aggiuntivo per le risposte generative include il linguaggio naturale per i filtri e le risposte semplici. |
QuerySetSpec
Descrive la specifica del set di query.
Rappresentazione JSON |
---|
{ "sampleQuerySet": string } |
Campi | |
---|---|
sampleQuerySet |
Facoltativo. Il nome completo della risorsa di |
QualityMetrics
Descrive le metriche prodotte dalla valutazione.
Rappresentazione JSON |
---|
{ "docRecall": { object ( |
Campi | |
---|---|
docRecall |
Richiamo per documento, a vari livelli di soglia top-k. Il richiamo è la frazione di documenti pertinenti recuperati su tutti i documenti pertinenti. Esempio (primi 5): * Per un singolo |
docPrecision |
Precisione per documento, a vari livelli di cutoff top-k. La precisione è la frazione di documenti recuperati pertinenti. Esempio (top 5): * Per un singolo |
docNdcg |
Guadagno cumulativo scontato normalizzato (NDCG) per documento, a vari livelli di interruzione top-k. NDCG misura la qualità del ranking, dando maggiore pertinenza ai risultati migliori. Esempio (migliori 3): supponiamo che Recuperato: [D3 (0), D1 (1), D2 (1)] Ideale: [D1 (1), D2 (1), D3 (0)] Calcola NDCG@3 per ogni |
pageRecall |
Richiamo per pagina, a vari livelli di cutoff top-k. Il richiamo è la frazione di pagine pertinenti recuperate sul totale delle pagine pertinenti. Esempio (prime 5): * Per un singolo |
pageNdcg |
Guadagno cumulativo scontato normalizzato (NDCG) per pagina, a vari livelli di cutoff top-k. NDCG misura la qualità del ranking, dando maggiore pertinenza ai risultati migliori. Esempio (prime 3): supponiamo che Recuperati: [P3 (0), P1 (1), P2 (1)] Ideale: [P1 (1), P2 (1), P3 (0)] Calcola NDCG@3 per |
TopkMetrics
Memorizza i valori delle metriche a livelli top-k specifici.
Rappresentazione JSON |
---|
{ "top1": number, "top3": number, "top5": number, "top10": number } |
Campi | |
---|---|
top1 |
Il valore principale. |
top3 |
Il valore top-3. |
top5 |
Il valore top-5. |
top10 |
Il valore top-10. |
Stato
Descrive lo stato di una valutazione.
Enum | |
---|---|
STATE_UNSPECIFIED |
La valutazione non è specificata. |
PENDING |
Il servizio si sta preparando a eseguire la valutazione. |
RUNNING |
La valutazione è in corso. |
SUCCEEDED |
La valutazione è stata completata. |
FAILED |
La valutazione non è riuscita. |
Metodi |
|
---|---|
|
Crea un Evaluation . |
|
Riceve un Evaluation . |
|
Recupera un elenco di Evaluation . |
|
Recupera un elenco di risultati per un determinato Evaluation . |