Package google.cloud.discoveryengine.v1

QueryClassificationInfo

L'ora in cui è stata eseguita questa ricerca recente.

score

double

Il punteggio di ogni suggerimento. Il punteggio è compreso nell'intervallo [0, 1].

AdvancedSiteSearchConfig

Dati di configurazione per la ricerca avanzata sul sito.

Campi

disable_initial_index

bool

Se impostato su true, l'indicizzazione iniziale viene disattivata per DataStore.

disable_automatic_refresh

bool

Se è impostato su true, l'aggiornamento automatico è disattivato per DataStore.

AlertPolicyConfig

Configurazione degli avvisi a livello di connettore.

Campi

alert_policy_name

string

Immutabile. Il nome risorsa completo di AlertPolicy.

alert_enrollments[]

AlertEnrollment

Facoltativo. Gli stati di registrazione di ogni avviso.

AlertEnrollment

Lo stato di registrazione dell'avviso.

Campi

alert_id

string

Immutabile. L'ID di un avviso.

enroll_state

EnrollStates

Obbligatorio. Lo stato di registrazione di un cliente.

EnrollStates

L'enumerazione dello stato di registrazione per l'avviso.

Enum
`ENROLL_STATES_UNSPECIFIED`	Valore predefinito. Utilizzato per i clienti che non hanno risposto al criterio di avviso.
`ENROLLED`	Il cliente è registrato a queste norme.
`DECLINED`	Il cliente ha rifiutato queste norme.

AlertPolicyResourceConfig

La configurazione degli avvisi a livello di risorsa. Utilizzato in: * UserLicense * EngineUserData L'AlertPolicyConfig nel connettore dati ha lo stesso utilizzo. Nessun modo semplice per eseguire la migrazione.

Campi
`alert_policy`	`string` Immutabile. Il nome risorsa completo di AlertPolicy.
`alert_enrollments[]`	`AlertEnrollment` Facoltativo. Lo stato di registrazione di ogni avviso.
`contact_details[]`	`ContactDetails` Facoltativo. I dettagli di contatto per ogni policy di avviso.
`language_code`	`string` Facoltativo. Il codice lingua utilizzato per le notifiche

AlertEnrollment

Lo stato di registrazione dell'avviso.

Campi

alert_id

string

Immutabile. L'ID di un avviso.

enroll_state

EnrollState

Obbligatorio. Lo stato di registrazione di un cliente.

notification_params

map<string, string>

Facoltativo. Parametri utilizzati per creare un'istanza di notifica. Utilizzato per le notifiche attivate al momento della registrazione. Non memorizzati. * Email di benvenuto di Gemini Business. * Email di invito per gli utenti di Gemini Business.

EnrollState

L'enumerazione dello stato di registrazione per l'avviso.

Enum
`ENROLL_STATE_UNSPECIFIED`	Valore predefinito. Utilizzato per i clienti che non hanno risposto al criterio di avviso.
`ENROLLED`	Il cliente è registrato a queste norme.
`DECLINED`	Il cliente ha rifiutato queste norme.

AlloyDbSource

Origine AlloyDB da cui importare i dati.

Campi
`project_id`	`string` L'ID progetto che contiene l'origine AlloyDB. Ha un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`location_id`	`string` Obbligatorio. La posizione di AlloyDB da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`cluster_id`	`string` Obbligatorio. Il cluster AlloyDB da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`database_id`	`string` Obbligatorio. Il database AlloyDB da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`table_id`	`string` Obbligatorio. La tabella AlloyDB da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`gcs_staging_dir`	`string` Directory intermedia di Cloud Storage usata per l'importazione con un limite di lunghezza di 2000 caratteri. Può essere specificata se si desidera che AlloyDB esegua l'esportazione in una directory specifica di Cloud Storage. Assicurati che l'account di servizio AlloyDB disponga delle autorizzazioni di amministratore Cloud Storage necessarie per accedere alla directory Cloud Storage specificata.

Risposta

Definisce una risposta.

Campi
`name`	`string` Immutabile. Nome completo `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` Lo stato della generazione della risposta.
`answer_text`	`string` La risposta testuale.
`citations[]`	`Citation` Citazioni.
`grounding_supports[]`	`GroundingSupport` Facoltativo. Supporta il grounding.
`references[]`	`Reference` Riferimenti.
`related_questions[]`	`string` Domande correlate suggerite.
`steps[]`	`Step` Passaggi per la generazione della risposta.
`query_understanding_info`	`QueryUnderstandingInfo` Informazioni sulla comprensione delle query.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Altri motivi per cui le risposte sono state saltate. Fornisce il motivo dei casi ignorati. Se non viene ignorato nulla, questo campo non viene impostato.
`create_time`	`Timestamp` Solo output. Timestamp di creazione della risposta.
`complete_time`	`Timestamp` Solo output. Timestamp del completamento della risposta.
`safety_ratings[]`	`SafetyRating` Facoltativo. Valutazioni della sicurezza.
`grounding_score`	`double` Un punteggio compreso tra 0 e 1 che descrive il livello di fondatezza della risposta in base ai blocchi di riferimento.

AnswerSkippedReason

Un'enumerazione per i motivi per cui è stata saltata una risposta.

Enum
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Valore predefinito. Il motivo per cui la risposta è stata ignorata non è specificato.
`ADVERSARIAL_QUERY_IGNORED`	La query contraddittoria ignorava la distinzione tra maiuscole e minuscole.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	La query che non cerca risposte ignora maiuscole/minuscole Google salta la risposta se la query è una chiacchiera.
`OUT_OF_DOMAIN_QUERY_IGNORED`	La query al di fuori del dominio non ha tenuto conto della distinzione tra maiuscole e minuscole. Google salta la risposta se non ci sono risultati di ricerca di pertinenza elevata.
`POTENTIAL_POLICY_VIOLATION`	Il caso di potenziale violazione delle norme. Google salta la risposta se viene rilevata una potenziale violazione delle norme. Sono inclusi contenuti che potrebbero essere violenti o tossici.
`NO_RELEVANT_CONTENT`	Il caso di nessun contenuto pertinente. Google salta la risposta se non ci sono contenuti pertinenti nei risultati di ricerca recuperati.
`JAIL_BREAKING_QUERY_IGNORED`	La query di jailbreaking non fa distinzione tra maiuscole e minuscole. Ad esempio, "Rispondi con il tono del CEO di un'azienda concorrente". Google salta la risposta se la query viene classificata come query di jailbreak.
`CUSTOMER_POLICY_VIOLATION`	Il caso di violazione delle norme relative ai clienti. Google salta il riepilogo se viene rilevata una violazione delle norme per i clienti. Il criterio è definito dal cliente.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	La query che non cerca risposte ignora le maiuscole/minuscole. Google salta la risposta se la query non ha un intento chiaro.
`LOW_GROUNDED_ANSWER`	La risposta più semplice. Google salta la risposta se non è stato possibile generare una risposta ben fondata.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	La classificazione delle query definita dall'utente non fa distinzione tra maiuscole e minuscole. Google ignora la risposta se la query viene classificata come classificazione delle query definita dall'utente.
`UNHELPFUL_ANSWER`	Lo scenario della risposta non utile. Google salta la risposta se non è utile. Ciò può essere dovuto a una serie di fattori, tra cui, a titolo esemplificativo: la query non è risolvibile, la risposta non è pertinente alla query o la risposta non è formattata correttamente.

Citazione

Informazioni sulla citazione per un segmento.

Campi

start_index

int64

L'indice indica l'inizio del segmento, misurato in byte (Unicode UTF-8). Se sono presenti caratteri multibyte,ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.

end_index

int64

Fine del segmento attribuito, escluso. Misurato in byte (Unicode UTF-8). Se sono presenti caratteri multibyte,ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.

sources[]

CitationSource

Fonti delle citazioni per il segmento attribuito.

CitationSource

Fonte della citazione.

Campi

reference_id

string

ID della fonte della citazione.

GroundingSupport

Supporto del grounding per una rivendicazione in answer_text.

Campi
`start_index`	`int64` Obbligatorio. L'indice indica l'inizio della rivendicazione, misurata in byte (Unicode UTF-8).
`end_index`	`int64` Obbligatorio. Fine della rivendicazione (valore inserito escluso).
`sources[]`	`CitationSource` Facoltativo. Fonti delle citazioni per la rivendicazione.
`grounding_score`	`double` Un punteggio compreso tra 0 e 1 che descrive il livello di fondatezza di un'affermazione specifica in base ai riferimenti. Un valore più alto indica che l'affermazione è meglio supportata dai chunk di riferimento.
`grounding_check_required`	`bool` Indica che questa rivendicazione richiedeva un controllo della messa a terra. Quando il sistema ha deciso che questa affermazione non richiedeva un controllo di attribuzione/fondatezza, questo campo è impostato su false. In questo caso, non è stato eseguito alcun controllo di fondatezza per la rivendicazione e pertanto non viene restituito `grounding_score`, `sources`.

QueryUnderstandingInfo

Informazioni sulla comprensione delle query.

Campi

query_classification_info[]

Informazioni sulla classificazione delle query.

QueryClassificationInfo

Informazioni sulla classificazione delle query.

Campi

type

Type

Tipo di classificazione delle query.

positive

bool

Output della classificazione.

Tipo

Tipi di classificazione delle query.

Enum
`TYPE_UNSPECIFIED`	Tipo di classificazione delle query non specificato.
`ADVERSARIAL_QUERY`	Tipo di classificazione delle query avversative.
`NON_ANSWER_SEEKING_QUERY`	Tipo di classificazione delle query che non cercano risposte, per le conversazioni informali.
`JAIL_BREAKING_QUERY`	Tipo di classificazione delle query di jailbreaking.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo di classificazione delle query che non cercano risposte, senza un intento chiaro.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo di classificazione delle query definito dall'utente.

Riferimento

Riferimento.

Campi
Campo unione `content`. Contenuti dei risultati di ricerca. `content` può essere solo uno dei seguenti:
`unstructured_document_info`	`UnstructuredDocumentInfo` Informazioni sui documenti non strutturati.
`chunk_info`	`ChunkInfo` Informazioni sui chunk.
`structured_document_info`	`StructuredDocumentInfo` Informazioni strutturate sui documenti.

ChunkInfo

Informazioni sui chunk.

Campi
`chunk`	`string` Nome della risorsa del blocco.
`content`	`string` Dividi i contenuti testuali in blocchi.
`document_metadata`	`DocumentMetadata` Metadati del documento.
`relevance_score`	`float` La pertinenza del segmento per una determinata query. I valori vanno da 0,0 (completamente irrilevante) a 1,0 (completamente pertinente). Questo valore è fornito unicamente a scopo informativo. Può cambiare per la stessa query e lo stesso blocco in qualsiasi momento a causa di un nuovo addestramento del modello o di una modifica dell'implementazione.

DocumentMetadata

Metadati del documento.

Campi
`document`	`string` Nome della risorsa del documento.
`uri`	`string` URI del documento.
`title`	`string` Titolo.
`page_identifier`	`string` Identificatore della pagina.
`struct_data`	`Struct` I metadati JSON strutturati per il documento. Viene compilato con i dati strutturati del blocco nel risultato di ricerca.

StructuredDocumentInfo

Informazioni strutturate sulla ricerca.

Campi
`document`	`string` Nome della risorsa del documento.
`struct_data`	`Struct` Dati strutturati della ricerca.
`title`	`string` Solo output. Il titolo del documento.
`uri`	`string` Solo output. L'URI del documento.

UnstructuredDocumentInfo

Informazioni sui documenti non strutturati.

Campi
`document`	`string` Nome della risorsa del documento.
`uri`	`string` URI del documento.
`title`	`string` Titolo.
`chunk_contents[]`	`ChunkContent` Elenco dei contenuti dei chunk citati derivati dai contenuti del documento.
`struct_data`	`Struct` I metadati JSON strutturati per il documento. Viene compilato con i dati strutturati del blocco nel risultato di ricerca.

ChunkContent

Dividere i contenuti in blocchi.

Campi

content

string

Dividi i contenuti testuali in blocchi.

page_identifier

string

Identificatore della pagina.

relevance_score

float

La pertinenza del segmento per una determinata query. I valori vanno da 0,0 (completamente irrilevante) a 1,0 (completamente pertinente). Questo valore è fornito unicamente a scopo informativo. Può cambiare per la stessa query e lo stesso blocco in qualsiasi momento a causa di un nuovo addestramento del modello o di una modifica dell'implementazione.

Stato

Enumerazione dello stato di generazione della risposta.

Enum
`STATE_UNSPECIFIED`	Sconosciuto.
`IN_PROGRESS`	La generazione della risposta è attualmente in corso.
`FAILED`	Al momento la generazione della risposta non è riuscita.
`SUCCEEDED`	La generazione della risposta è riuscita.
`STREAMING`	La generazione della risposta è attualmente in corso.

Passaggio

Informazioni sul passaggio.

Campi
`state`	`State` Lo stato del passaggio.
`description`	`string` La descrizione del passaggio.
`thought`	`string` Il pensiero del passo.
`actions[]`	`Action` Azioni.

Azione

Azione.

Campi

observation

Observation

Osservazione.

Campo unione action. L'azione. action può essere solo uno dei seguenti:

search_action

SearchAction

Azione di ricerca.

Osservazione

Osservazione.

Campi

search_results[]

SearchResult

Risultati di ricerca osservati dall'azione di ricerca. Possono essere informazioni sugli snippet o sui chunk, a seconda del tipo di citazione impostato dall'utente.

SearchResult

Campi
`document`	`string` Nome della risorsa del documento.
`uri`	`string` URI del documento.
`title`	`string` Titolo.
`snippet_info[]`	`SnippetInfo` Se citation_type è DOCUMENT_LEVEL_CITATION, compila gli snippet a livello di documento.
`chunk_info[]`	`ChunkInfo` Se citation_type è CHUNK_LEVEL_CITATION e la modalità chunk è attiva, compila le informazioni sui chunk.
`struct_data`	`Struct` Rappresentazione dei dati. I dati JSON strutturati per il documento. Viene compilato con i dati strutturati del documento o del segmento nel risultato di ricerca.

ChunkInfo

Informazioni sui chunk.

Campi

chunk

string

Nome della risorsa del blocco.

content

string

Dividi i contenuti testuali in blocchi.

relevance_score

float

SnippetInfo

Informazioni sullo snippet.

Campi

snippet

string

Contenuti dello snippet.

snippet_status

string

Stato dello snippet definito dal team di ricerca.

SearchAction

Azione di ricerca.

Campi

query

string

La query da cercare.

Stato

Enumerazione dello stato del passaggio.

Enum
`STATE_UNSPECIFIED`	Sconosciuto.
`IN_PROGRESS`	Il passaggio è attualmente in corso.
`FAILED`	Il passaggio non è riuscito.
`SUCCEEDED`	Il passaggio è riuscito.

AnswerGenerationSpec

La specifica per la generazione delle risposte.

Campi

user_defined_classifier_spec

UserDefinedClassifierSpec

Facoltativo. La specifica per la specifica del classificatore specificato dall'utente.

UserDefinedClassifierSpec

La specifica per il classificatore definito dall'utente.

Campi
`enable_user_defined_classifier`	`bool` Facoltativo. Indica se attivare e includere il classificatore definito dall'utente.
`preamble`	`string` Facoltativo. Il preambolo da utilizzare per il classificatore definito dall'utente.
`model_id`	`string` Facoltativo. L'ID modello da utilizzare per il classificatore definito dall'utente.
`task_marker`	`string` Facoltativo. Il marcatore dell'attività da utilizzare per il classificatore definito dall'utente.
`top_p`	`double` Facoltativo. Il valore top-p da utilizzare per il classificatore definito dall'utente.
`top_k`	`int64` Facoltativo. Il valore top-k da utilizzare per il classificatore definito dall'utente.
`temperature`	`double` Facoltativo. Il valore della temperatura da utilizzare per il classificatore definito dall'utente.
`seed`	`int32` Facoltativo. Il valore iniziale da utilizzare per il classificatore definito dall'utente.

AnswerQueryRequest

Richiesta di messaggio per il metodo ConversationalSearchService.AnswerQuery.

Campi
`serving_config`	`string` Obbligatorio. Il nome risorsa della configurazione di pubblicazione della ricerca, ad esempio `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` o `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`. Questo campo viene utilizzato per identificare il nome della configurazione di pubblicazione, l'insieme di modelli utilizzati per eseguire la ricerca.
`query`	`Query` Obbligatorio. Query utente corrente.
`session`	`string` Il nome della risorsa della sessione. Non obbligatorio. Quando il campo della sessione non è impostato, l'API è in modalità senza sessione. Supportiamo la modalità di sessione automatica: gli utenti possono utilizzare il carattere jolly `-` come ID sessione. Verrà generato e assegnato automaticamente un nuovo ID.
`safety_spec`	`SafetySpec` Specifiche del modello.
`related_questions_spec`	`RelatedQuestionsSpec` Specifica delle domande correlate.
`grounding_spec`	`GroundingSpec` Facoltativo. Specifiche di messa a terra.
`answer_generation_spec`	`AnswerGenerationSpec` Specifica per la generazione delle risposte.
`search_spec`	`SearchSpec` Specifica della ricerca.
`query_understanding_spec`	`QueryUnderstandingSpec` Specifica della comprensione delle query.
`asynchronous_mode (deprecated)`	`bool` Questo elemento è deprecato. Obsoleto: questo campo è obsoleto. L'API Streaming Answer sarà supportata. Controllo della modalità asincrona. Se l'opzione è abilitata, la risposta verrà restituita con il nome della risorsa risposta/sessione senza la risposta finale. Gli utenti dell'API devono eseguire il polling per ottenere lo stato più recente della risposta/sessione chiamando il metodo `ConversationalSearchService.GetAnswer` o `ConversationalSearchService.GetSession`.
`user_pseudo_id`	`string` Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore accede o esce dal sito web. Questo campo NON deve avere un valore fisso come `unknown_visitor`. Il campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per ulteriori dettagli, consulta il documento Google Cloud.
`end_user_spec`	`EndUserSpec` Facoltativo. Specifica dell'utente finale.

AnswerGenerationSpec

Specifica per la generazione delle risposte.

Campi
`model_spec`	`ModelSpec` Specifica del modello di generazione delle risposte.
`prompt_spec`	`PromptSpec` Specifica del prompt di generazione delle risposte.
`include_citations`	`bool` Specifica se includere i metadati delle citazioni nella risposta. Il valore predefinito è `false`.
`answer_language_code`	`string` Codice lingua per la risposta. Utilizza i tag di lingua definiti da BCP47. Nota: questa è una funzionalità sperimentale.
`ignore_adversarial_query`	`bool` Specifica se filtrare le query contraddittorie. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query ostili. Se la query di ricerca viene classificata come query ostile, non viene restituita alcuna risposta. Ad esempio, un utente potrebbe porre una domanda relativa a commenti negativi sull'azienda o inviare una query progettata per generare output non sicuri che violano le norme. Se questo campo è impostato su `true`, non generiamo risposte per le query ostili e restituiamo invece messaggi di riserva.
`ignore_non_answer_seeking_query`	`bool` Specifica se filtrare le query che non cercano risposte. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query che cercano risposte. Se la query di ricerca viene classificata come query che non cerca risposte, non viene restituita alcuna risposta. Se questo campo è impostato su `true`, saltiamo la generazione di risposte per le query che non cercano risposte e restituiamo invece messaggi di riserva.
`ignore_jail_breaking_query`	`bool` Facoltativo. Specifica se filtrare le query di jailbreaking. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query di jailbreaking. Non viene restituito alcun riepilogo se la query di ricerca viene classificata come query di evasione. Un utente potrebbe aggiungere istruzioni alla query per modificare il tono, lo stile, la lingua, il contenuto della risposta o chiedere al modello di agire come un'entità diversa, ad esempio "Rispondi con il tono del CEO di un'azienda concorrente". Se questo campo è impostato su `true`, saltiamo la generazione di riepiloghi per le query di jailbreaking e restituiamo invece messaggi di riserva.
`ignore_low_relevant_content`	`bool` Specifica se filtrare le query con scarsa pertinenza. Se questo campo è impostato su `false`, vengono utilizzati tutti i risultati di ricerca, indipendentemente dalla pertinenza, per generare le risposte. Se impostato su `true` o non configurato, il comportamento verrà determinato automaticamente dal servizio.

ModelSpec

Specifica del modello di generazione delle risposte.

Campi

model_version

string

Versione del modello. Se non è impostato, verrà utilizzato il modello stabile predefinito. I valori consentiti sono: stable, preview.

PromptSpec

Specifica del prompt di generazione delle risposte.

Campi

preamble

string

Preambolo personalizzato.

EndUserSpec

Specifica dell'utente finale.

Campi

end_user_metadata[]

EndUserMetaData

Facoltativo. Metadati utente finale.

EndUserMetaData

Metadati utente finale.

Campi

Campo unione content. Contenuti dei risultati di ricerca. content può essere solo uno dei seguenti:

chunk_info

ChunkInfo

Informazioni sui chunk.

ChunkInfo

Informazioni sui chunk.

Campi

content

string

Dividi i contenuti testuali in blocchi. È limitato a 8000 caratteri.

document_metadata

QueryClassificationSpec

I metadati del documento del chunk corrente.

DocumentMetadata

I metadati del documento contengono le informazioni del documento del chunk attuale.

Campi

title

string

Il titolo del documento.

GroundingSpec

Specifiche di messa a terra.

Campi

include_grounding_supports

bool

Facoltativo. Specifica se includere grounding_supports nella risposta. Il valore predefinito è false.

Quando questo campo è impostato su true, la risposta restituita avrà grounding_score e conterrà GroundingSupports per ogni affermazione.

filtering_level

FilteringLevel

Facoltativo. Specifica se attivare il filtro in base al punteggio di fondatezza e a quale livello.

FilteringLevel

Livello da filtrare in base alla fondatezza della risposta.

Enum
`FILTERING_LEVEL_UNSPECIFIED`	Il valore predefinito è nessun filtro
`FILTERING_LEVEL_LOW`	Filtra le risposte in base a una soglia bassa.
`FILTERING_LEVEL_HIGH`	Filtra le risposte in base a una soglia elevata.

QueryUnderstandingSpec

Specifica della comprensione delle query.

Campi

query_classification_spec

Specifica di classificazione delle query.

query_rephraser_spec

QueryRephraserSpec

Specifica del riformulatore di query.

disable_spell_correction

bool

Facoltativo. Se disattivare la correzione ortografica. Il valore predefinito è false.

QueryClassificationSpec

Specifica di classificazione delle query.

Campi

types[]

Type

Tipi di classificazione delle query abilitati.

Tipo

Tipi di classificazione delle query.

Enum
`TYPE_UNSPECIFIED`	Tipo di classificazione delle query non specificato.
`ADVERSARIAL_QUERY`	Tipo di classificazione delle query avversative.
`NON_ANSWER_SEEKING_QUERY`	Tipo di classificazione delle query che non cercano risposte, per le conversazioni informali.
`JAIL_BREAKING_QUERY`	Tipo di classificazione delle query di jailbreaking.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo di classificazione delle query che non cercano risposte, senza un intento chiaro.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo di classificazione delle query definito dall'utente.

QueryRephraserSpec

Specifica del riformulatore di query.

Campi

disable

bool

Disattiva la riformulazione delle query.

max_rephrase_steps

int32

Numero massimo di passaggi per riformulare la query. Il numero massimo è 5 passaggi. Se non viene impostato o è impostato su < 1, il valore predefinito è 1.

model_spec

ModelSpec

Facoltativo. Specifica del modello di riformulazione delle query.

ModelSpec

Specifica del modello di riformulazione delle query.

Campi

model_type

ModelType

Facoltativo. È stato attivato il tipo di modello di riformulazione delle query. Se non viene impostato, verrà utilizzato LARGE per impostazione predefinita.

ModelType

Tipi di riformulazione delle query. Al momento supporta solo le selezioni di modelli a un solo passaggio (max_rephrase_steps = 1). Per il multihop (max_rephrase_steps > 1), esiste un solo modello predefinito.

Enum
`MODEL_TYPE_UNSPECIFIED`	Tipo di modello non specificato.
`SMALL`	Modello di riformulazione di query di piccole dimensioni. Modello Gemini 1.0 XS.
`LARGE`	Modello di riformulazione delle query di grandi dimensioni. Modello Gemini 1.0 Pro.

RelatedQuestionsSpec

Specifica delle domande correlate.

Campi

enable

bool

Abilita la funzionalità delle domande correlate se è vera.

SafetySpec

Specifiche di sicurezza. Esistono due casi d'uso: 1. quando è impostato solo safety_spec.enable, la soglia BLOCK_LOW_AND_ABOVE verrà applicata a tutte le categorie. 2. Quando safety_spec.enable è impostato e alcune safety_settings sono impostate, vengono applicate solo le safety_settings specificate.

Campi

enable

bool

Attiva il filtro di sicurezza nella risposta. Per impostazione predefinita, è false.

safety_settings[]

SafetySetting

Facoltativo. Impostazioni di sicurezza. Queste impostazioni sono efficaci solo quando safety_spec.enable è impostato su true.

SafetySetting

Impostazioni di sicurezza.

Campi

category

HarmCategory

Obbligatorio. Categoria del danno.

threshold

HarmBlockThreshold

Obbligatorio. La soglia di blocco dei contenuti dannosi.

HarmBlockThreshold

Livelli di soglia basati sulla probabilità per il blocco.

Enum
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Soglia HarmBlockThreshold non specificata.
`BLOCK_LOW_AND_ABOVE`	Blocco soglia bassa e superiore (ovvero blocca di più).
`BLOCK_MEDIUM_AND_ABOVE`	Blocca la soglia media e superiore.
`BLOCK_ONLY_HIGH`	Blocco solo soglia alta (ovvero blocco ridotto).
`BLOCK_NONE`	Nessun blocco.
`OFF`	Disattiva il filtro di sicurezza.

SearchSpec

Specifica della ricerca.

Campi

Campo unione input. Parametri di ricerca per controllare il comportamento della ricerca. In alternativa, fornisci l'elenco dei risultati di ricerca per generare la risposta. input può essere solo uno dei seguenti:

search_params

SearchParams

Parametri di ricerca.

search_result_list

SearchResultList

Elenco dei risultati di ricerca.

SearchParams

Parametri di ricerca.

Campi
`max_return_results`	`int32` Il numero di risultati di ricerca da restituire. Il valore predefinito è 10.
`filter`	`string` La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti da filtrare. L'espressione del filtro è sensibile alle maiuscole. Queste informazioni verranno utilizzate per filtrare i risultati di ricerca, il che potrebbe influire sulla risposta di Answer. Se questo campo non è riconoscibile, viene restituito un `INVALID_ARGUMENT`. Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente di contenuti multimediali potrebbe avere un campo "nome" nel proprio schema. In questo caso, il filtro sarà simile a questo: filter --> name:'ANY("king kong")' Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.
`boost_spec`	`BoostSpec` Specifica del boost per aumentare il ranking di determinati documenti nei risultati di ricerca, il che potrebbe influire sulla risposta alla query. Per ulteriori informazioni sul boosting, consulta la sezione Boosting.
`order_by`	`string` L'ordine in cui vengono restituiti i documenti. I documenti possono essere ordinati in base a un campo in un oggetto `Document`. Lascia il campo vuoto se l'ordine è per pertinenza. L'espressione `order_by` è sensibile alle maiuscole. Per ulteriori informazioni sugli ordini, consulta la sezione Ordini. Se questo campo non è riconoscibile, viene restituito un `INVALID_ARGUMENT`.
`search_result_mode`	`SearchResultMode` Specifica la modalità dei risultati di ricerca. Se non specificata, la modalità dei risultati di ricerca è impostata su `DOCUMENTS` per impostazione predefinita. Consulta Analizzare e dividere i documenti in blocchi.
`data_store_specs[]`	`DataStoreSpec` Specifiche che definiscono i data store su cui filtrare in una chiamata di ricerca e configurazioni per questi data store. Questo viene preso in considerazione solo per i motori con più casi d'uso di datastore. Per un singolo datastore all'interno di un motore, devono utilizzare le specifiche di primo livello.

SearchResultList

Elenco dei risultati di ricerca.

Campi

search_results[]

SearchResult

Risultati di ricerca.

SearchResult

Risultato di ricerca.

Campi

Campo unione content. Contenuti dei risultati di ricerca. content può essere solo uno dei seguenti:

unstructured_document_info

UnstructuredDocumentInfo

Informazioni sui documenti non strutturati.

chunk_info

ChunkInfo

Informazioni sui chunk.

ChunkInfo

Informazioni sui chunk.

Campi

chunk

string

Nome della risorsa del blocco.

content

string

Dividi i contenuti testuali in blocchi.

document_metadata

I metadati del documento del chunk corrente.

DocumentMetadata

I metadati del documento contengono le informazioni del documento del chunk attuale.

Campi

uri

string

L'URI del documento.

title

string

Il titolo del documento.

UnstructuredDocumentInfo

Informazioni sui documenti non strutturati.

Campi
`document`	`string` Nome della risorsa del documento.
`uri`	`string` URI del documento.
`title`	`string` Titolo.
`document_contexts[]`	`DocumentContext` Elenco dei contesti del documento. I contenuti verranno utilizzati per la generazione di risposte. Questi dovrebbero essere i contenuti principali del documento, che possono essere lunghi e completi.
`extractive_segments[]`	`ExtractiveSegment` Elenco dei segmenti estrattivi.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` Questo elemento è deprecato. Obsoleto: questo campo è obsoleto e non avrà alcun effetto sulla generazione di risposte. Utilizza i campi document_contexts e extractive_segments. Elenco delle risposte estrattive.

DocumentContext

Contesto del documento.

Campi

page_identifier

string

Identificatore della pagina.

content

string

Contenuti del documento da utilizzare per generare le risposte.

ExtractiveAnswer

Risposta estrattiva. Guida

Campi

page_identifier

string

Identificatore della pagina.

content

string

Contenuto della risposta estrattiva.

ExtractiveSegment

Segmento estrattivo. Guida La generazione di risposte lo utilizzerà solo se document_contexts è vuoto. Questi dovrebbero essere snippet più brevi.

Campi

page_identifier

string

Identificatore della pagina.

content

string

Contenuti del segmento estrattivo.

AnswerQueryResponse

Messaggio di risposta per il metodo ConversationalSearchService.AnswerQuery.

Campi

answer

Answer

Oggetto risorsa risposta. Se AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps è maggiore di 1, utilizza Answer.name per recuperare le informazioni sulle risposte utilizzando l'API ConversationalSearchService.GetAnswer.

session

PolicyEnforcementResult

Oggetto risorsa sessione. Sarà disponibile solo quando il campo della sessione è impostato e valido nella richiesta AnswerQueryRequest.

answer_query_token

string

Un ID univoco globale utilizzato per la registrazione.

AssistAnswer

Risorsa AssistAnswer, parte principale di AssistResponse.

Campi
`name`	`string` Immutabile. Identificatore. Nome risorsa di `AssistAnswer`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
`state`	`State` Stato della generazione della risposta.
`replies[]`	`Reply` Risposte dell'assistente.
`assist_skipped_reasons[]`	`AssistSkippedReason` Motivi per cui non rispondere alla chiamata di assistenza.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Facoltativo. Il campo contiene informazioni sui risultati dei vari controlli delle norme, come le frasi vietate o i controlli Model Armor. Questo campo viene compilato solo se la chiamata di assistenza è stata ignorata a causa di una violazione delle norme.

AssistSkippedReason

Possibili motivi per cui non si risponde a una chiamata di assistenza.

Enum
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Valore predefinito. Il motivo del salto non è specificato.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	L'assistente ha ignorato la query perché non sembrava essere una domanda.
`CUSTOMER_POLICY_VIOLATION`	L'assistente ha ignorato la query o si è rifiutato di rispondere a causa di una violazione delle norme relative ai clienti (ad esempio, la query o la risposta conteneva una frase vietata).

CustomerPolicyEnforcementResult

Risultati dell'applicazione delle norme relative ai clienti. Contiene i risultati dei vari controlli delle norme, come le frasi vietate o i controlli di Model Armor.

Campi

verdict

Verdict

Verdetto finale sull'applicazione delle norme per i clienti. Se solo una norma ha bloccato l'elaborazione, il verdetto è BLOCCA.

policy_results[]

Risultati dell'applicazione delle norme relative ai clienti. Compilato solo se la chiamata di assistenza è stata ignorata a causa di una violazione delle norme. Contiene i risultati dei filtri che hanno bloccato l'elaborazione della query.

BannedPhraseEnforcementResult

Risultato dell'applicazione delle norme per i clienti per le norme relative alle frasi vietate.

Campi

banned_phrases[]

string

Le frasi vietate trovate nella query o nella risposta.

ModelArmorEnforcementResult

Risultato dell'applicazione delle norme relative ai clienti per le norme Model Armor.

Campi

Campo unione result. Il risultato del criterio Model Armor. result può essere solo uno dei seguenti:

model_armor_violation

string

La violazione di Model Armor rilevata.

error

BannedPhraseEnforcementResult

L'errore restituito da Model Armor se l'applicazione forzata del criterio non è riuscita per qualche motivo.

PolicyEnforcementResult

Risultato dell'applicazione forzata dei criteri del cliente per un singolo tipo di norma.

Campi

Campo unione enforcement_result. Il risultato specifico del tipo di norma. Può trattarsi di un errore o di informazioni dettagliate sul risultato dell'applicazione delle norme. enforcement_result può essere solo uno dei seguenti:

banned_phrase_enforcement_result

Il risultato dell'applicazione forzata delle norme per le norme relative alle frasi vietate.

model_armor_enforcement_result

ModelArmorEnforcementResult

Il risultato dell'applicazione forzata del criterio Model Armor.

Verdetto

Il verdetto dell'applicazione delle norme per i clienti.

Enum
`UNSPECIFIED`	Valore sconosciuto.
`ALLOW`	Non è stata rilevata alcuna violazione delle norme.
`BLOCK`	L'elaborazione è stata bloccata dalle norme relative ai clienti.

Rispondi

Una parte della risposta in più parti della chiamata di assistenza.

Campi

Campo unione reply. Alternative per la risposta dell'assistente. reply può essere solo uno dei seguenti:

grounded_content

AssistantGroundedContent

Testo o contenuti multimediali della risposta dell'assistente che potrebbero essere basati su informazioni non aggiornate.

Stato

Stato della generazione della risposta.

Enum
`STATE_UNSPECIFIED`	Sconosciuto.
`IN_PROGRESS`	L'operazione di assistenza è attualmente in corso.
`FAILED`	L'operazione di assistenza non è riuscita.
`SUCCEEDED`	L'operazione di assistenza è riuscita.
`SKIPPED`	L'operazione di assistenza è stata ignorata.

AssistRequest

Richiesta per il metodo AssistantService.Assist.

Campi
`name`	`string` Obbligatorio. Il nome della risorsa di `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Facoltativo. Query utente corrente. La query vuota è supportata solo se vengono forniti `file_ids`. In questo caso, la risposta verrà generata in base a questi file di contesto.
`session`	`string` Facoltativo. La sessione da utilizzare per la richiesta. Se specificato, l'assistente ha accesso alla cronologia della sessione e la query e la risposta vengono memorizzate. Se `-` viene specificato come ID sessione o viene lasciato vuoto, viene creata una nuova sessione con un ID generato automaticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` Facoltativo. Determina i casi in cui l'assistente non risponderà alla query. Se la risposta viene ignorata, i motivi verranno elencati in `AssistAnswer.assist_skipped_reasons` entro `AssistResponse.answer`.
`file_ids[]`	`string` Facoltativo. Gli ID dei file da utilizzare per rispondere alla richiesta. Quando carichi un file, il suo ID viene restituito in `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Facoltativo. Informazioni sull'utente che avvia la query.

AssistSkippingMode

Comportamenti di salto disponibili per le richieste di assistenza.

Enum
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Valore predefinito. La risposta può essere ignorata se la query non richiede assistenza.
`REQUEST_ASSIST`	Richiedi la risposta dell'assistente. La risposta può comunque essere ignorata se la query non supera i controlli delle norme.

AssistResponse

Risposta per il metodo AssistantService.Assist.

Campi

answer

AssistAnswer

La risorsa AssistAnswer generata in risposta alla query.

session_info

SessionInfo

Informazioni sulla sessione.

assist_token

string

Un ID univoco globale che identifica la coppia richiesta-risposta corrente. Utilizzato per feedback e assistenza.

SessionInfo

Informazioni sulla sessione.

Campi

session

string

Nome della sessione appena generata o continuata.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

query_id

string

ID query corrispondente a questa chiamata API Assist. Una sessione può avere più turni, ognuno con un ID query univoco.

Se specifichi il nome della sessione e questo ID query nella chiamata all'API Assist, la richiesta di assistenza viene eseguita nel contesto dei risultati di ricerca di questa chiamata di ricerca.

AssistUserMetadata

Metadati utente della richiesta.

Campi

time_zone

string

Facoltativo. Fuso orario IANA, ad es. Europe/Budapest.

preferred_language_code

string

Facoltativo. Lingua preferita da utilizzare per rispondere se il rilevamento della lingua non va a buon fine. Utilizzata anche come lingua dei messaggi di errore creati dalle azioni, indipendentemente dai risultati del rilevamento della lingua.

Assistente

Risorsa Discovery Engine Assistant.

Campi
`name`	`string` Immutabile. Nome risorsa dell'assistente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` Deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
`display_name`	`string` Obbligatorio. Il nome visualizzato dell'assistente. Deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri.
`description`	`string` Facoltativo. Descrizione per ulteriori informazioni. Previsto per essere mostrato nella UI di configurazione, non agli utenti dell'assistente.
`generation_config`	`GenerationConfig` Facoltativo. Configurazione per la generazione della risposta dell'assistente.
`google_search_grounding_enabled (deprecated)`	`bool` Questo elemento è deprecato. Facoltativo. Deprecato. Utilizza invece `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Facoltativo. Il tipo di grounding web da utilizzare.
`enabled_actions (deprecated)`	`map<string, ActionList>` Questo elemento è deprecato. Facoltativo. Deprecato: verrà sostituito da `enabled_tools`. Le azioni attivate su questo assistente. Le chiavi sono il nome del connettore, ad esempio "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. I valori sono costituiti dalle azioni abilitate dall'amministratore nei confronti dell'istanza del connettore. L'amministratore può attivare in modo selettivo più azioni su una qualsiasi delle istanze del connettore create nel progetto. Ad esempio {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Facoltativo. Nota: non ancora implementata. Utilizza invece `enabled_actions`. Gli strumenti attivati in questo assistente. Le chiavi sono il nome del connettore, ad esempio "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. I valori sono costituiti da strumenti abilitati dall'amministratore per l'istanza del connettore. L'amministratore può attivare selettivamente più strumenti in una qualsiasi delle istanze del connettore create nel progetto. Ad esempio {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Facoltativo. Norme per i clienti per l'assistente.

ActionInfo

Deprecato: verrà sostituito da ToolInfo. Informazioni per identificare un'azione.

Campi

action_name

string

Il nome dell'azione come definito da DataConnectorService.QueryAvailableActions.

action_display_name

string

Il nome visualizzato dell'azione.

ActionList

Deprecato: verrà sostituito da ToolList. Le azioni abilitate su un connettore

Campi

action_info[]

ActionInfo

L'elenco delle azioni con le informazioni corrispondenti.

CustomerPolicy

Norme definite dal cliente per l'assistente.

Campi

banned_phrases[]

BannedPhrase

Facoltativo. Elenco delle frasi vietate.

model_armor_config

ModelArmorConfig

Facoltativo. Configurazione di Model Armor da utilizzare per la sanitizzazione dei prompt degli utenti e delle risposte dell'assistente.

BannedPhrase

Definizione di una frase vietata definita dal cliente. Una frase vietata non può essere visualizzata nella query dell'utente o nella risposta del LLM, altrimenti la risposta verrà rifiutata.

Campi

phrase

string

Obbligatorio. I contenuti della stringa non elaborata da vietare.

match_type

BannedPhraseMatchType

Facoltativo. Tipo di corrispondenza per la frase vietata.

ignore_diacritics

bool

Facoltativo. Se true, i segni diacritici (ad es. accenti, umlaut) vengono ignorati durante la corrispondenza con le frasi vietate. Ad esempio, "cafe" corrisponderà a "café".

BannedPhraseMatchType

Il metodo di corrispondenza per la frase vietata.

Enum
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	Il valore predefinito è SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	La frase vietata corrisponde se viene trovata in qualsiasi punto del testo come sottostringa esatta.
`WORD_BOUNDARY_STRING_MATCH`	La corrispondenza della frase vietata si verifica solo se il pattern trovato nel testo è racchiuso tra delimitatori di parole. La frase stessa può comunque contenere delimitatori di parole.

ModelArmorConfig

Configurazione dei modelli Model Armor definiti dal cliente da utilizzare per la sanificazione dei prompt dell'utente e delle risposte dell'assistente.

Campi

user_prompt_template

string

Facoltativo. Il nome risorsa del modello Model Armor per la sanificazione dei prompt dell'utente. Formato: projects/{project}/locations/{location}/templates/{template_id}

Se non specificato, non verrà applicata alcuna sanificazione al prompt dell'utente.

response_template

string

Facoltativo. Il nome risorsa del template Model Armor per la sanificazione delle risposte dell'assistente. Formato: projects/{project}/locations/{location}/templates/{template_id}

Se non specificato, alla risposta dell'assistente non verrà applicata alcuna sanificazione.

failure_mode

FailureMode

Facoltativo. Definisce la modalità di errore per la sanificazione di Model Armor.

FailureMode

Determina il comportamento quando Model Armor non riesce a elaborare una richiesta.

Enum
`FAILURE_MODE_UNSPECIFIED`	Modalità di errore non specificata, il comportamento predefinito è `FAIL_CLOSED`.
`FAIL_OPEN`	In caso di errore di elaborazione di Model Armor, la richiesta può procedere senza modifiche.
`FAIL_CLOSED`	In caso di errore di elaborazione di Model Armor, la richiesta viene rifiutata.

GenerationConfig

Configurazione per la generazione della risposta dell'assistente.

Campi

system_instruction

SystemInstruction

Istruzione di sistema, nota anche come preambolo del prompt per le chiamate LLM. Vedi anche https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

La lingua predefinita da utilizzare per la generazione della risposta dell'assistente. Utilizza un codice lingua ISO 639-1 come en. Se non specificata, la lingua verrà rilevata automaticamente.

SystemInstruction

Istruzione di sistema, nota anche come preambolo del prompt per le chiamate LLM.

Campi

additional_system_instruction

string

Facoltativo. Istruzione di sistema aggiuntiva che verrà aggiunta all'istruzione di sistema predefinita.

ToolInfo

Informazioni per identificare uno strumento.

Campi

tool_name

string

Il nome dello strumento come definito da DataConnectorService.QueryAvailableActions. Nota: utilizza action nelle API DataConnectorService, ma sono uguali a tool qui.

tool_display_name

string

Il nome visualizzato dello strumento.

ToolList

Gli strumenti abilitati su un connettore

Campi

tool_info[]

ToolInfo

L'elenco degli strumenti con le informazioni corrispondenti.

WebGroundingType

Il tipo di grounding web da utilizzare.

Enum
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Impostazione predefinita non specificata. Equivale a disattivato.
`WEB_GROUNDING_TYPE_DISABLED`	Il grounding web è disattivato.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	Il grounding con la Ricerca Google è abilitato.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	Il grounding con la ricerca web aziendale è abilitato.

AssistantContent

Contenuti multimodali.

Campi
`role`	`string` Il produttore dei contenuti. Può essere "model" o "user".
`thought`	`bool` Facoltativo. Indica se la parte è stata pensata dal modello.
Campo unione `data`. Dati contenuti. `data` può essere solo uno dei seguenti:
`text`	`string` Testo in linea.
`inline_data`	`Blob` Dati binari in linea.
`file`	`File` Un file, ad esempio un riepilogo audio.
`executable_code`	`ExecutableCode` Codice generato dal modello che deve essere eseguito.
`code_execution_result`	`CodeExecutionResult` Risultato dell'esecuzione di un ExecutableCode.

Blob

Blob in linea.

Campi

mime_type

string

Obbligatorio. Il tipo di media (tipo MIME) dei dati generati.

data

bytes

Obbligatorio. Byte non elaborati.

CodeExecutionResult

Risultato dell'esecuzione di ExecutableCode.

Campi

outcome

Outcome

Obbligatorio. Risultato dell'esecuzione del codice.

output

string

Facoltativo. Contiene stdout se l'esecuzione del codice è riuscita, stderr o un'altra descrizione in caso contrario.

Risultato

Enumerazione dei possibili risultati dell'esecuzione del codice.

Enum
`OUTCOME_UNSPECIFIED`	Stato non specificato. Questo valore non deve essere utilizzato.
`OUTCOME_OK`	Esecuzione del codice completata correttamente.
`OUTCOME_FAILED`	L'esecuzione del codice è terminata, ma con un errore. `stderr` deve contenere il motivo.
`OUTCOME_DEADLINE_EXCEEDED`	L'esecuzione del codice è durata troppo a lungo ed è stata annullata. Potrebbe essere presente o meno un output parziale.

ExecutableCode

Codice generato dal modello che deve essere eseguito dal modello.

Campi

code

string

Obbligatorio. Il contenuto del codice. Al momento supporta solo Python.

File

Un file, ad esempio un riepilogo audio.

Campi

mime_type

string

Obbligatorio. Il tipo di media (tipo MIME) del file.

file_id

string

Obbligatorio. L'ID file.

AssistantGroundedContent

Un contenuto ed eventualmente le relative informazioni di base.

Non tutti i contenuti richiedono un grounding. Frasi come "Certo, lo cercherò volentieri per te" non richiedono una base.

Campi
`content`	`AssistantContent` I contenuti.
`citation_metadata`	`CitationMetadata` Attribuzione della fonte dei contenuti generati. Vedi anche https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
`content_metadata`	`ContentMetadata` Facoltativo. Metadati per i contenuti. Attualmente utilizzato solo per le risposte degli assistenti alla ricerca.
Campo unione `metadata`. Metadati di base per varie finestre modali. Per ora supporta solo il testo. `metadata` può essere solo uno dei seguenti:
`text_grounding_metadata`	`TextGroundingMetadata` Metadati per la contestualizzazione basata su fonti di testo.

ContentMetadata

Metadati per i contenuti.

Campi

content_kind

ContentKind

Il tipo di contenuti. Mostra a quale parte della risposta dell'assistente alla ricerca appartengono questi contenuti.

content_id

string

ID dei contenuti. Viene utilizzato per collegare le domande di ricerca alle relative risposte. Ad esempio, le parti della risposta a una domanda di ricerca avranno lo stesso content_id della domanda.

ContentKind

Possibili tipi di contenuti. Attualmente utilizzato solo per differenziare le sezioni nella risposta completa di un assistente alla ricerca.

Enum
`CONTENT_KIND_UNSPECIFIED`	Sconosciuto.
`RESEARCH_PLAN`	Piano di ricerca.
`RESEARCH_QUESTION`	Domanda di ricerca.
`RESEARCH_ANSWER`	Risposta della ricerca.
`RESEARCH_REPORT`	Report di ricerca.
`RESEARCH_AUDIO_SUMMARY`	Cerca riepilogo audio.

TextGroundingMetadata

Dettagli di base per le fonti di testo.

Campi

segments[]

Segment

Informazioni di base per parti del testo.

references[]

Reference

Riferimenti per il testo basato su dati reali.

Riferimento

Contenuti a cui viene fatto riferimento e metadati dei documenti correlati.

Campi

content

string

Contenuti testuali a cui viene fatto riferimento.

document_metadata

Metadati del documento.

DocumentMetadata

Metadati del documento.

Campi
`document`	`string` Nome della risorsa del documento.
`uri`	`string` URI del documento. Potrebbe contenere un URL che reindirizza al sito web effettivo.
`title`	`string` Titolo.
`page_identifier`	`string` Identificatore della pagina.
`domain`	`string` Nome di dominio dall'URI del documento. Tieni presente che il campo `uri` potrebbe contenere un URL che reindirizza al sito web effettivo, nel qual caso conterrà il nome di dominio del sito di destinazione.
`mime_type`	`string` Il tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

Segmento

Informazioni di base per un segmento del testo.

Campi
`start_index`	`int64` Indice in base zero che indica l'inizio del segmento, misurato in byte di una stringa UTF-8 (ovvero i caratteri codificati su più byte hanno una lunghezza superiore a uno).
`end_index`	`int64` Fine del segmento, esclusa.
`reference_indices[]`	`int32` Riferimenti per il segmento.
`grounding_score`	`float` Punteggio del segmento.
`text`	`string` Il segmento di testo.

BAPConfig

La configurazione del connettore BAP.

Campi

supported_connector_modes[]

ConnectorMode

Obbligatorio. Le modalità del connettore supportate per la connessione BAP associata.

enabled_actions[]

string

Facoltativo. Le azioni abilitate nella connessione BAP associata.

ConnectorMode

Casi d'uso supportati da questo connettore BAP.

Enum
`CONNECTOR_MODE_UNSPECIFIED`	Modalità connettore non specificata.
`DATA_INGESTION`	Connettore utilizzato per importazione dati.
`ACTIONS`	Connettore utilizzato per le azioni
`END_USER_AUTHENTICATION`	Connettore utilizzato per l'autenticazione dell'utente finale.

BatchCreateTargetSiteMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.BatchCreateTargetSites. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

CreateTargetSiteRequest

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

BatchCreateTargetSitesRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.BatchCreateTargetSites.

Campi

parent

string

Obbligatorio. La risorsa principale condivisa da tutti i TargetSites in fase di creazione. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. Il campo genitore nei messaggi CreateBookRequest deve essere vuoto o corrispondere a questo campo.

requests[]

Obbligatorio. Il messaggio di richiesta che specifica le risorse da creare. È possibile creare un massimo di 20 TargetSite in un batch.

BatchCreateTargetSitesResponse

Messaggio di risposta per il metodo SiteSearchEngineService.BatchCreateTargetSites.

Campi

target_sites[]

TargetSites creato.

BatchGetDocumentsMetadataRequest

Richiesta di messaggio per il metodo DocumentService.BatchGetDocumentsMetadata.

Campi

parent

string

Obbligatorio. Il nome della risorsa del ramo padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Obbligatorio. Matcher per gli Document.

FhirMatcher

Matcher per i Document in base ai nomi delle risorse FHIR.

Campi

fhir_resources[]

string

Obbligatorio. Le risorse FHIR da abbinare. Formato: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Matcher per gli Document. Al momento supporta la corrispondenza per URI esatti.

Campi

Campo unione matcher. Matcher per gli Document. matcher può essere solo uno dei seguenti:

uris_matcher

UrisMatcher

Matcher per URI esatti.

fhir_matcher

FhirMatcher

Matcher in base ai nomi delle risorse FHIR.

UrisMatcher

Matcher per i Document in base agli URI esatti.

Campi

uris[]

string

Gli URI esatti da abbinare.

BatchGetDocumentsMetadataResponse

Messaggio di risposta per il metodo DocumentService.BatchGetDocumentsMetadata.

Campi

documents_metadata[]

I metadati degli Document.

DocumentMetadata

I metadati di un Document.

Campi
`matcher_value`	`MatcherValue` Il valore del matcher utilizzato per trovare una corrispondenza per `Document`.
`state`	`State` Lo stato del documento.
`last_refreshed_time`	`Timestamp` Il timestamp dell'ultima volta che l'`Document` è stato indicizzato.
`data_ingestion_source`	`string` L'origine di importazione dati di `Document`. I valori consentiti sono: `batch`: Dati importati tramite l'API Batch, ad es. ImportDocuments. `streaming` Dati importati tramite l'API Streaming, ad esempio: FHIR streaming.

MatcherValue

Il valore del matcher utilizzato per trovare una corrispondenza per Document.

Campi

Campo unione matcher_value. Il valore del matcher utilizzato per trovare una corrispondenza per Document. matcher_value può essere solo uno dei seguenti:

uri

string

Se la corrispondenza avviene tramite URI, l'URI di Document.

fhir_resource

string

Formato: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Stato

Lo stato di Document.

Enum
`STATE_UNSPECIFIED`	Non deve mai essere impostato.
`INDEXED`	`Document` è indicizzato.
`NOT_IN_TARGET_SITE`	`Document` non è indicizzato perché il suo URI non è in `TargetSite`.
`NOT_IN_INDEX`	`Document` non è indicizzato.

BatchUpdateUserLicensesMetadata

Metadati relativi all'avanzamento dell'operazione UserLicenseService.BatchUpdateUserLicenses. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Il conteggio delle licenze utente è stato aggiornato correttamente.
`failure_count`	`int64` Conteggio delle licenze utente che non sono state aggiornate.

BatchUpdateUserLicensesRequest

Richiesta di messaggio per il metodo UserLicenseService.BatchUpdateUserLicenses.

Campi
`parent`	`string` Obbligatorio. Il nome risorsa [UserStore][] principale, formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Facoltativo. Se è true, se le licenze utente rimosse sono associate alla configurazione della licenza, la licenza utente verrà eliminata. Per impostazione predefinita, ovvero false, la licenza utente verrà aggiornata allo stato non assegnato.
Campo unione `source`. Obbligatorio. L'origine dell'input. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea dei contenuti di input per gli incorporamenti di documenti.

InlineSource

L'origine incorporata per la configurazione di input per il metodo BatchUpdateUserLicenses.

Campi

user_licenses[]

UserLicense

Obbligatorio. Un elenco di licenze utente da aggiornare. Ogni licenza utente deve avere un UserLicense.user_principal valido.

update_mask

Facoltativo. L'elenco dei campi da aggiornare.

BatchUpdateUserLicensesResponse

Messaggio di risposta per il metodo UserLicenseService.BatchUpdateUserLicenses.

Campi

user_licenses[]

UserLicense

UserLicenses aggiornato correttamente.

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

BatchVerifyTargetSitesMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.BatchVerifyTargetSites. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

BatchVerifyTargetSitesRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.BatchVerifyTargetSites.

Campi

parent

string

Obbligatorio. La risorsa principale condivisa da tutti i TargetSites in fase di verifica. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Questo tipo non contiene campi.

Messaggio di risposta per il metodo SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

Importazione dei dati dall'origine BigQuery.

Campi
`project_id`	`string` L'ID o il numero del progetto che contiene l'origine BigQuery. Ha un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`dataset_id`	`string` Obbligatorio. Il set di dati BigQuery da cui copiare i dati con un limite di lunghezza di 1024 caratteri.
`table_id`	`string` Obbligatorio. La tabella BigQuery da cui copiare i dati con un limite di lunghezza di 1024 caratteri.
`gcs_staging_dir`	`string` Directory intermedia di Cloud Storage usata per l'importazione con un limite di lunghezza di 2000 caratteri. Può essere specificata se si desidera che BigQuery esegua l'esportazione in una directory specifica di Cloud Storage.
`data_schema`	`string` Lo schema da utilizzare durante l'analisi dei dati dell'origine. Valori supportati per le importazioni di eventi utente: `user_event` (impostazione predefinita): un `UserEvent` per riga. Valori supportati per le importazioni di documenti: `document` (impostazione predefinita): un formato `Document` per riga. Ogni documento deve avere un `Document.id` valido e uno tra `Document.json_data` o `Document.struct_data`. `custom`: un dato personalizzato per riga in formato arbitrario conforme al `Schema` definito dell'datastore. Può essere utilizzato solo dal verticale GENERIC Data Store.
Campo unione `partition`. Informazioni sulla partizione della tabella BigQuery. Lascia questo campo vuoto se la tabella BigQuery non è partizionata. `partition` può essere solo uno dei seguenti:
`partition_date`	`Date` _PARTITIONDATE della tabella partizionata per ora di BigQuery nel formato AAAA-MM-GG.

BigtableOptions

L'oggetto Bigtable Options che contiene le informazioni per supportare l'importazione.

Campi

key_field_name

string

Il nome del campo utilizzato per salvare il valore della chiave di riga nel documento. Il nome deve corrispondere al pattern [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map<string, BigtableColumnFamily>

Il mapping dai nomi delle famiglie a un oggetto che contiene informazioni a livello di famiglie di colonne per la famiglia di colonne specificata. Se una famiglia non è presente in questa mappatura, verrà ignorata.

BigtableColumn

La colonna di Bigtable.

Campi
`qualifier`	`bytes` Obbligatorio. Qualificatore della colonna. Se non può essere decodificata con UTF-8, utilizza una stringa codificata in base 64.
`field_name`	`string` Il nome del campo da utilizzare per questa colonna nel documento. Il nome deve corrispondere al pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se non è impostato, viene analizzato dai byte qualificatori con il massimo impegno. Tuttavia, a causa di diversi pattern di denominazione, potrebbero verificarsi conflitti tra i nomi dei campi, in cui il comportamento di analisi è indefinito.
`encoding`	`Encoding` La modalità di codifica dei valori quando il tipo non è `STRING`. I valori di codifica accettabili sono: `TEXT`: indica che i valori sono stringhe di testo alfanumeriche. `BINARY`: indica che i valori sono codificati utilizzando la famiglia di funzioni `HBase Bytes.toBytes`. Questa impostazione può essere sovrascritta per una colonna specifica elencandola in `columns` e specificando una codifica.
`type`	`Type` Il tipo di valori in questa famiglia di colonne. I valori devono essere codificati utilizzando la funzione `HBase Bytes.toBytes` quando il valore di codifica è impostato su `BINARY`.

BigtableColumnFamily

La famiglia di colonne di Bigtable.

Campi
`field_name`	`string` Il nome del campo da utilizzare per questa famiglia di colonne nel documento. Il nome deve corrispondere al pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se non è impostato, viene analizzato dal nome della famiglia nel miglior modo possibile. Tuttavia, a causa di diversi pattern di denominazione, potrebbero verificarsi conflitti tra i nomi dei campi, in cui il comportamento di analisi è indefinito.
`encoding`	`Encoding` La modalità di codifica dei valori quando il tipo non è STRING. I valori di codifica accettabili sono: `TEXT`: indica che i valori sono stringhe di testo alfanumeriche. `BINARY`: indica che i valori sono codificati utilizzando la famiglia di funzioni `HBase Bytes.toBytes`. Questa impostazione può essere sovrascritta per una colonna specifica elencandola in `columns` e specificando una codifica.
`type`	`Type` Il tipo di valori in questa famiglia di colonne. I valori devono essere codificati utilizzando la funzione `HBase Bytes.toBytes` quando il valore di codifica è impostato su `BINARY`.
`columns[]`	`BigtableColumn` L'elenco degli oggetti che contiene informazioni a livello di colonna per ogni colonna. Se una colonna non è presente in questo elenco, verrà ignorata.

Codifica

La modalità di codifica di una colonna o di una famiglia di colonne Bigtable.

Enum
`ENCODING_UNSPECIFIED`	La codifica non è specificata.
`TEXT`	Codifica del testo.
`BINARY`	Codifica binaria.

Tipo

Il tipo di valori in una colonna o in una famiglia di colonne Bigtable. Se il valore di codifica è impostato su BINARY, i valori devono essere codificati utilizzando la funzione HBase Bytes.toBytes.

Enum
`TYPE_UNSPECIFIED`	Il tipo non è specificato.
`STRING`	Tipo di stringa.
`NUMBER`	Tipo numerico.
`INTEGER`	Tipo intero.
`VAR_INTEGER`	Tipo di numero intero di lunghezza variabile.
`BIG_NUMERIC`	Tipo BigDecimal.
`BOOLEAN`	Tipo booleano.
`JSON`	Tipo JSON.

BigtableSource

L'origine Cloud Bigtable per l'importazione dei dati.

Campi
`project_id`	`string` L'ID progetto che contiene l'origine Bigtable. Ha un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`instance_id`	`string` Obbligatorio. L'ID istanza di Cloud Bigtable da importare.
`table_id`	`string` Obbligatorio. L'ID tabella di Cloud Bigtable da importare.
`bigtable_options`	`BigtableOptions` Obbligatorio. Opzioni Bigtable che contengono le informazioni necessarie per l'analisi dei dati in strutture tipizzate. Ad esempio, le annotazioni del tipo di colonna.

CheckGroundingRequest

Richiesta di messaggio per il metodo GroundedGenerationService.CheckGrounding.

Campi
`grounding_config`	`string` Obbligatorio. Il nome risorsa della configurazione di grounding, ad esempio `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Risposta del candidato da controllare. Può avere una lunghezza massima di 4096 token.
`facts[]`	`GroundingFact` Elenco dei fatti per il controllo della fondatezza. Supportiamo fino a 200 fatti.
`grounding_spec`	`CheckGroundingSpec` Configurazione del controllo di grounding.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per ulteriori dettagli, consulta il documento Google Cloud.

CheckGroundingResponse

Messaggio di risposta per il metodo GroundedGenerationService.CheckGrounding.

Campi
`cited_chunks[]`	`FactChunk` Elenco dei fatti citati in tutte le rivendicazioni nella risposta candidata. Queste informazioni derivano dai fatti forniti nella richiesta.
`cited_facts[]`	`CheckGroundingFactChunk` Elenco dei fatti citati in tutte le rivendicazioni nella risposta candidata. Queste informazioni derivano dai fatti forniti nella richiesta.
`claims[]`	`Claim` Testi delle rivendicazioni e informazioni sulle citazioni in tutte le rivendicazioni del candidato alla risposta.
`support_score`	`float` Il punteggio di supporto per la risposta candidata inserita. Più alto è il punteggio, maggiore è la frazione di affermazioni supportate dai fatti forniti. Questo valore viene sempre impostato quando viene restituita una risposta.

CheckGroundingFactChunk

Blocco di fatti per il controllo della fondatezza.

Campi

chunk_text

string

Contenuto testuale del blocco di fatti. Può contenere al massimo 10.000 caratteri.

Attestazione

Testo e informazioni sulla citazione per un'affermazione nella risposta candidata.

Campi
`claim_text`	`string` Testo dell'affermazione nel candidato risposta. Fornito sempre, indipendentemente dal fatto che vengano trovate citazioni o anti-citazioni.
`citation_indices[]`	`int32` Un elenco di indici (in "cited_chunks") che specificano le citazioni associate alla rivendicazione. Ad esempio, [1,3,4] significa che cited_chunks[1], cited_chunks[3], cited_chunks[4] sono i fatti citati a sostegno dell'affermazione. Una citazione di un fatto indica che l'affermazione è supportata dal fatto.
`start_pos`	`int32` Posizione che indica l'inizio dell'affermazione nel candidato alla risposta, misurata in byte. Tieni presente che questa metrica non viene misurata in caratteri e, pertanto, deve essere visualizzata nell'interfaccia utente tenendo presente che alcuni caratteri potrebbero occupare più di un byte. Ad esempio, se il testo della rivendicazione contiene caratteri non ASCII, le posizioni iniziale e finale variano se misurate in caratteri (a seconda del linguaggio di programmazione) e se misurate in byte (indipendentemente dal linguaggio di programmazione).
`end_pos`	`int32` Posizione che indica la fine dell'affermazione nel candidato alla risposta, esclusiva, in byte. Tieni presente che non viene misurato in caratteri e, pertanto, deve essere visualizzato come tale. Ad esempio, se il testo della rivendicazione contiene caratteri non ASCII, le posizioni iniziale e finale variano se misurate in caratteri (a seconda del linguaggio di programmazione) e se misurate in byte (indipendentemente dal linguaggio di programmazione).
`grounding_check_required`	`bool` Indica che questa rivendicazione richiedeva un controllo della messa a terra. Quando il sistema ha deciso che questa affermazione non richiede un controllo di attribuzione/fondatezza, questo campo verrà impostato su false. In questo caso, non è stata eseguita alcuna verifica di fondatezza per la rivendicazione e pertanto non deve essere restituito `citation_indices`.
`score`	`double` Punteggio di affidabilità per l'affermazione nel candidato alla risposta, nell'intervallo [0, 1]. Questo valore viene impostato solo quando `CheckGroundingRequest.grounding_spec.enable_claim_level_score` è true.

CheckGroundingSpec

Specifica per il controllo della messa a terra.

Campi

citation_threshold

double

La soglia (in [0,1]) utilizzata per determinare se un fatto deve essere citato per un'affermazione nella risposta candidata. La scelta di una soglia più alta comporterà un numero inferiore di citazioni, ma molto solide, mentre la scelta di una soglia più bassa potrebbe comportare un numero maggiore di citazioni, ma un po' più deboli. Se non viene impostata, la soglia verrà impostata su 0,6 per impostazione predefinita.

enable_claim_level_score

bool

Il flag di controllo che attiva il punteggio di grounding a livello di rivendicazione nella risposta.

Chunk

La modalità Chunk acquisisce tutte le informazioni sui metadati non elaborati degli elementi da consigliare o cercare.

Campi
`name`	`string` Il nome completo della risorsa del blocco. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
`id`	`string` ID univoco del segmento corrente.
`content`	`string` I contenuti sono una stringa di un documento (contenuti analizzati).
`document_metadata`	`DocumentMetadata` I metadati del documento del chunk corrente.
`derived_struct_data`	`Struct` Solo output. Questo campo è OUTPUT_ONLY. Contiene dati derivati che non sono presenti nel documento di input originale.
`page_span`	`PageSpan` Intervallo di pagine del blocco.
`chunk_metadata`	`ChunkMetadata` Solo output. Metadati del chunk corrente.
`data_urls[]`	`string` Solo output. URL dei dati delle immagini se il chunk corrente contiene immagini. Gli URL dei dati sono composti da quattro parti: un prefisso (data:), un tipo MIME che indica il tipo di dati, un token base64 facoltativo se non testuale e i dati stessi: data:[][;base64],
`annotation_contents[]`	`string` Solo output. Contenuti delle annotazioni se il blocco attuale contiene annotazioni.
`annotation_metadata[]`	`AnnotationMetadata` Solo output. I metadati dell'annotazione includono contenuti strutturati nel chunk corrente.
`relevance_score`	`double` Solo output. Rappresenta il punteggio di pertinenza basato sulla somiglianza. Un punteggio più alto indica una maggiore pertinenza del segmento. Il punteggio è compreso nell'intervallo [-1,0, 1,0]. Compilato solo su `SearchResponse`.

AnnotationMetadata

I metadati dell'annotazione includono contenuti strutturati nel chunk corrente.

Campi

structured_content

StructuredContent

Solo output. Le informazioni sui contenuti strutturati.

image_id

string

Solo output. L'ID immagine viene fornito se i contenuti strutturati si basano su un'immagine.

ChunkMetadata

Metadati del chunk corrente. Questo campo viene compilato solo nell'API SearchService.Search.

Campi

previous_chunks[]

Chunk

I chunk precedenti del chunk corrente. Il numero è controllato da SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Questo campo viene compilato solo nell'API SearchService.Search.

next_chunks[]

Chunk

I chunk successivi del chunk corrente. Il numero è controllato da SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Questo campo viene compilato solo nell'API SearchService.Search.

DocumentMetadata

I metadati del documento contengono le informazioni del documento del chunk attuale.

Campi
`uri`	`string` L'URI del documento.
`title`	`string` Il titolo del documento.
`mime_type`	`string` Il tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
`struct_data`	`Struct` Rappresentazione dei dati. I dati JSON strutturati per il documento. Deve essere conforme a `Schema` registrato o viene generato un errore `INVALID_ARGUMENT`.

PageSpan

Intervallo di pagine del blocco.

Campi

page_start

int32

La pagina iniziale del blocco.

page_end

int32

La pagina finale del segmento.

StructureType

Definisce i tipi di contenuti strutturati che possono essere estratti.

Enum
`STRUCTURE_TYPE_UNSPECIFIED`	Valore predefinito.
`SHAREHOLDER_STRUCTURE`	Struttura azionaria.
`SIGNATURE_STRUCTURE`	Struttura della firma.
`CHECKBOX_STRUCTURE`	Struttura della casella di controllo.

StructuredContent

Le informazioni sui contenuti strutturati.

Campi

structure_type

StructureType

Solo output. Il tipo di struttura dei contenuti strutturati.

content

string

Solo output. Il contenuto dei contenuti strutturati.

Citazione

Attribuzioni delle fonti per i contenuti.

Campi
`start_index`	`int32` Solo output. Indice iniziale dei contenuti.
`end_index`	`int32` Solo output. Indice finale dei contenuti.
`uri`	`string` Solo output. Riferimento URL dell'attribuzione.
`title`	`string` Solo output. Titolo dell'attribuzione.
`license`	`string` Solo output. Licenza dell'attribuzione.
`publication_date`	`Date` Solo output. La data di pubblicazione dell'attribuzione.

CitationMetadata

Una raccolta di attribuzioni delle fonti per un contenuto.

Campi

citations[]

Citation

Solo output. Elenco delle citazioni.

CloudSqlSource

Importa i dati di origine Cloud SQL da.

Campi
`project_id`	`string` L'ID progetto che contiene l'origine Cloud SQL. Ha un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`instance_id`	`string` Obbligatorio. L'istanza Cloud SQL da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`database_id`	`string` Obbligatorio. Il database Cloud SQL da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`table_id`	`string` Obbligatorio. La tabella Cloud SQL da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`gcs_staging_dir`	`string` Directory intermedia di Cloud Storage usata per l'importazione con un limite di lunghezza di 2000 caratteri. Può essere specificata se si desidera che Cloud SQL esegua l'esportazione in una directory specifica di Cloud Storage. Assicurati che il account di servizio Cloud SQL disponga delle autorizzazioni di amministratore Cloud Storage necessarie per accedere alla directory Cloud Storage specificata.
`offload`	`bool` Opzione per l'esportazione serverless. L'abilitazione di questa opzione comporta costi aggiuntivi. Puoi trovare maggiori informazioni qui.

CmekConfig

Configurazioni utilizzate per attivare la crittografia dei dati CMEK con le chiavi Cloud KMS.

Campi
`name`	`string` Obbligatorio. Il nome di CmekConfig nel formato `projects/{project}/locations/{location}/cmekConfig` o `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Obbligatorio. Nome risorsa della chiave KMS che verrà utilizzata per criptare le risorse `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
`kms_key_version`	`string` Solo output. Nome risorsa della versione della chiave KMS che verrà utilizzata per criptare le risorse `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Solo output. Gli stati di CmekConfig.
`is_default`	`bool` Solo output. CmekConfig predefinita per il cliente.
`last_rotation_timestamp_micros`	`int64` Solo output. Il timestamp dell'ultima rotazione della chiave.
`single_region_keys[]`	`SingleRegionKey` Facoltativo. Chiavi CMEK monoregionali necessarie per alcune funzionalità di VAIS.
`notebooklm_state`	`NotebookLMState` Solo output. Indica se il corpus di NotebookLM è pronto per essere utilizzato.

NotebookLMState

Stati di NotebookLM.

Enum
`NOTEBOOK_LM_STATE_UNSPECIFIED`	Lo stato di NotebookLM è sconosciuto.
`NOTEBOOK_LM_NOT_READY`	NotebookLM non è pronto.
`NOTEBOOK_LM_READY`	NotebookLM è pronto per essere utilizzato.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM non è abilitato.

Stato

Stati di CmekConfig.

Enum
`STATE_UNSPECIFIED`	Lo stato di CmekConfig è sconosciuto.
`CREATING`	È in corso la creazione di CmekConfig.
`ACTIVE`	CmekConfig può essere utilizzato con i datastore.
`KEY_ISSUE`	CmekConfig non è disponibile, molto probabilmente perché la chiave KMS è stata revocata.
`DELETING`	CmekConfig è in fase di eliminazione.
`DELETE_FAILED`	La procedura di eliminazione di CmekConfig non è riuscita.
`UNUSABLE`	CmekConfig non è utilizzabile, molto probabilmente a causa di un problema interno.
`ACTIVE_ROTATING`	La versione della chiave KMS è in fase di rotazione.
`DELETED`	La chiave KMS viene eliminata temporaneamente. Alla fine verranno applicati alcuni criteri di pulizia.
`EXPIRED`	La chiave KMS è scaduta, il che significa che è stata disabilitata per più di 30 giorni. Il cliente può chiamare DeleteCmekConfig per modificare lo stato in DELETED.

CollectUserEventRequest

Messaggio di richiesta per il metodo CollectUserEvent.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa padre. Se l'azione di raccolta degli eventi utente viene applicata a livello `DataStore`, il formato è: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Se l'azione di raccolta degli eventi utente viene applicata a livello `Location`, ad esempio l'evento con `Document` in più `DataStore`, il formato è: `projects/{project}/locations/{location}`.
`user_event`	`string` Obbligatorio. Proto UserEvent codificato con URL con un limite di lunghezza di 2.000.000 di caratteri.
`uri`	`string` L'URL, inclusi i parametri CGI ma escluso il frammento hash, con un limite di lunghezza di 5000 caratteri. Spesso è più utile dell'URL referrer, perché molti browser inviano solo il dominio per le richieste di terze parti.
`ets`	`int64` Il timestamp dell'evento in millisecondi. In questo modo si impedisce la memorizzazione nella cache del browser di richieste GET altrimenti identiche. Il nome è abbreviato per ridurre i byte del payload.

Raccolta

Una raccolta è un contenitore per la configurazione delle risorse e l'accesso a un insieme di datastore.

Campi

name

string

Immutabile. Il nome completo della risorsa della raccolta. Formato: projects/{project}/locations/{location}/collections/{collection_id}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.

display_name

string

Obbligatorio. Il nome visualizzato della raccolta.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

create_time

Solo output. Timestamp della creazione di Collection.

CompleteQueryRequest

Richiesta di messaggio per il metodo CompletionService.CompleteQuery.

Campi
`data_store`	`string` Obbligatorio. Il nome della risorsa del datastore padre per cui viene eseguito il completamento, ad esempio `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Obbligatorio. L'input di tipo ahead utilizzato per recuperare i suggerimenti. La lunghezza massima è di 128 caratteri.
`query_model`	`string` Specifica il modello dei dati di completamento automatico. Questa impostazione sostituisce qualsiasi modello specificato nella sezione Configurazione > Completamento automatico della console Cloud. Valori attualmente supportati: `document`: utilizzo dei suggerimenti generati dai documenti importati dagli utenti. `search-history`: utilizzo di suggerimenti generati dalla cronologia passata delle chiamate API `SearchService.Search`. Non utilizzarlo quando non c'è traffico per l'API Search. `user-event`: utilizzo dei suggerimenti generati dagli eventi di ricerca importati dagli utenti. `document-completable`: utilizza i suggerimenti presi direttamente dai campi dei documenti importati dagli utenti contrassegnati come completabili. Valori predefiniti: `document` è il modello predefinito per i normali datastore. `search-history` è il modello predefinito per gli archivi dati della ricerca sui siti.
`user_pseudo_id`	`string` Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore accede o esce dal sito web. Questo campo NON deve avere un valore fisso come `unknown_visitor`. Deve essere lo stesso identificatore di `UserEvent.user_pseudo_id` e `SearchRequest.user_pseudo_id`. Il campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`include_tail_suggestions`	`bool` Indica se devono essere restituite le proposte di coda se non sono presenti suggerimenti che corrispondono all'intera query. Anche se impostato su true, se ci sono suggerimenti che corrispondono alla query completa, questi vengono restituiti e non vengono restituiti suggerimenti di coda.

CompleteQueryResponse

Messaggio di risposta per il metodo CompletionService.CompleteQuery.

Campi

query_suggestions[]

QuerySuggestion

Risultati dei suggerimenti per le query corrispondenti. L'elenco dei risultati è ordinato e il primo risultato è un suggerimento principale.

tail_match_triggered

bool

True se tutti i suggerimenti restituiti sono suggerimenti di coda.

Affinché venga attivata la corrispondenza con la coda, include_tail_suggestions nella richiesta deve essere impostato su true e non devono essere presenti suggerimenti che corrispondano alla query completa.

QuerySuggestion

Suggerimenti come query di ricerca.

Campi

suggestion

string

Il suggerimento per la query.

completable_field_paths[]

string

I percorsi dei campi del documento univoci che fungono da origine di questo suggerimento, se è stato generato da campi completabili.

Questo campo viene compilato solo per il modello completabile del documento.

CompletionInfo

Informazioni dettagliate sul completamento, tra cui il token di attribuzione del completamento e le informazioni sul completamento dei clic.

Campi

selected_suggestion

string

Utente finale selezionato CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posizione CompleteQueryResponse.QuerySuggestion.suggestion selezionata dall'utente finale, a partire da 0.

CompletionSuggestion

Suggerimenti di completamento automatico importati da Customer.

Campi
`suggestion`	`string` Obbligatorio. Il testo del suggerimento.
`language_code`	`string` Codice lingua BCP-47 di questo suggerimento.
`group_id`	`string` Se due suggerimenti hanno lo stesso groupId, non verranno restituiti insieme. Verrà restituito invece quello con il ranking più alto. Può essere utilizzato per deduplicare i suggerimenti semanticamente identici.
`group_score`	`double` Il punteggio di questo suggerimento all'interno del gruppo.
`alternative_phrases[]`	`string` Frasi di corrispondenza alternative per questo suggerimento.
Campo unione `ranking_info`. Metriche di ranking di questo suggerimento. `ranking_info` può essere solo uno dei seguenti:
`global_score`	`double` Punteggio globale di questo suggerimento. Controlla il modo in cui questo suggerimento verrà valutato / classificato.
`frequency`	`int64` Frequenza di questo suggerimento. Verrà utilizzato per classificare i suggerimenti quando il punteggio non è disponibile.

Condizione

Definisce le circostanze da verificare prima di consentire un comportamento

Campi

query_terms[]

QueryTerm

Cerca solo un elenco di termini a cui abbinare la query. Non può essere impostato quando è impostato Condition.query_regex.

Massimo 10 termini di query.

active_time_range[]

TimeRange

Intervallo o intervalli di tempo che specificano quando la condizione è attiva.

Massimo 10 intervalli di tempo.

query_regex

string

Facoltativo. Espressione regolare della query per trovare la corrispondenza dell'intera query di ricerca. Non può essere impostato quando è impostato Condition.query_terms. Supportato solo per i controlli di pubblicazione della promozione della ricerca su sito di base.

QueryTerm

Matcher per la query della richiesta di ricerca

Campi

value

string

Il valore della query specifico da confrontare

Deve essere in minuscolo e in formato UTF-8. Può avere al massimo tre termini separati da spazi se full_match è true. Non può essere una stringa vuota. Lunghezza massima di 5000 caratteri.

full_match

bool

Se la query di ricerca deve corrispondere esattamente al termine della query.

TimeRange

Utilizzato per le condizioni che dipendono dal tempo.

Campi

start_time

Inizio dell'intervallo di tempo.

L'intervallo è inclusivo.

end_time

Fine dell'intervallo di tempo.

L'intervallo è inclusivo. Deve essere una data futura.

ConnectorType

Il tipo di connettore.

Enum
`CONNECTOR_TYPE_UNSPECIFIED`	Valore predefinito.
`THIRD_PARTY`	Connettore di terze parti per connettore per applicazione di terze parti.
`GCP_FHIR`	Il connettore dati collega l'archivio FHIR e il datastore VAIS.
`BIG_QUERY`	Connettore BigQuery.
`GCS`	Connettore Google Cloud Storage.
`GOOGLE_MAIL`	Connettore Gmail.
`GOOGLE_CALENDAR`	Connettore Google Calendar.
`GOOGLE_DRIVE`	Connettore Google Drive.
`NATIVE_CLOUD_IDENTITY`	Connettore Cloud Identity nativo per la ricerca di persone basata sull'API People.
`THIRD_PARTY_FEDERATED`	Connettore federato, un connettore di terze parti che non esegue l'importazione dei dati e la ricerca è basata sull'API dell'applicazione di terze parti.
`THIRD_PARTY_EUA`	Connettore utilizzato per le funzionalità di autenticazione dell'utente finale.
`GCNV`	Connettore Google Cloud NetApp Volumes.

ContactDetails

I dati di contatto archiviati a livello di risorsa. Se vengono compilati sia il livello di progetto che quello di risorsa, i dati di contatto a livello di risorsa sostituiranno quelli a livello di progetto.

Campi

email_address

string

Facoltativo. L'indirizzo email del contatto.

Controllo

Definisce un comportamento condizionato da utilizzare durante la pubblicazione. Deve essere allegato a un ServingConfig per essere preso in considerazione al momento della pubblicazione. Azioni consentite a seconda di SolutionType.

Campi
`name`	`string` Immutabile. Nome completo `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Obbligatorio. Nome leggibile. L'identificatore utilizzato nelle visualizzazioni dell'interfaccia utente. Deve essere una stringa codificata in UTF-8. Il limite di lunghezza è di 128 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
`associated_serving_config_ids[]`	`string` Solo output. Elenco di tutti gli ID `ServingConfig` a cui è collegato questo controllo. L'aggiornamento può richiedere fino a 10 minuti dopo le modifiche.
`solution_type`	`SolutionType` Obbligatorio. Immutabile. A quale soluzione appartiene il controllo. Deve essere compatibile con il verticale della risorsa. In caso contrario, viene generato un errore INVALID ARGUMENT.
`use_cases[]`	`SearchUseCase` Specifica il caso d'uso per il controllo. Influisce sui campi delle condizioni che possono essere impostati. Si applica solo a `SOLUTION_TYPE_SEARCH`. Attualmente è consentito un solo caso d'uso per controllo. Deve essere impostato quando solution_type è `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Determina quando verrà attivata l'azione associata. Ometti per applicare sempre l'azione. Al momento è possibile specificare una sola condizione. In caso contrario, viene generato un errore INVALID ARGUMENT.
Campo unione `action`. Le azioni sono limitate in base al verticale e alla soluzione Obbligatorio. `action` può essere solo uno dei seguenti:
`boost_action`	`BoostAction` Definisce un controllo di tipo boost
`filter_action`	`FilterAction` Definisce un controllo di tipo filtro. Attualmente non supportato da Consigli
`redirect_action`	`RedirectAction` Definisce un controllo di tipo reindirizzamento.
`synonyms_action`	`SynonymsAction` Considera un gruppo di termini come sinonimi.
`promote_action`	`PromoteAction` Promuovi determinati link in base a query di attivazione predefinite.

BoostAction

Modifica l'ordine dei prodotti nell'elenco restituito.

Campi
`boost (deprecated)`	`float` Questo elemento è deprecato. L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0 (nessuna operazione).
`filter`	`string` Obbligatorio. Specifica a quali prodotti applicare il boost. Se non viene fornito alcun filtro, tutti i prodotti verranno potenziati (nessuna operazione). Documentazione sulla sintassi: https://cloud.google.com/retail/docs/filter-and-order. La lunghezza massima è di 5000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.
`data_store`	`string` Obbligatorio. Specifica i documenti di quale datastore possono ottenere un boost con questo controllo. Nome completo del datastore, ad es. projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo unione `boost_spec`. Specifiche per l'aumento del valore costante o per il ranking personalizzato basato sull'aumento. `boost_spec` può essere solo uno dei seguenti:
`fixed_boost`	`float` Facoltativo. L'intensità del boost, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0 (nessuna operazione).
`interpolation_boost_spec`	`InterpolationBoostSpec` Facoltativo. Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente.

InterpolationBoostSpec

Specifica per il ranking personalizzato basato sul valore dell'attributo specificato dal cliente. Offre più controlli per la classificazione personalizzata rispetto alla semplice combinazione (condizione, aumento) riportata sopra.

Campi
`field_name`	`string` Facoltativo. Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento.
`attribute_type`	`AttributeType` Facoltativo. Il tipo di attributo da utilizzare per determinare l'importo del boost. Il valore dell'attributo può essere derivato dal valore del campo field_name specificato. Nel caso di valori numerici, è semplice, ad esempio attribute_value = numerical_field_value. Nel caso della freschezza, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Facoltativo. Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito.
`control_points[]`	`ControlPoint` Facoltativo. I punti di controllo utilizzati per definire la curva. La funzione monotona (definita tramite interpolation_type sopra) passa attraverso i punti di controllo elencati qui.

AttributeType

L'attributo(o la funzione) a cui deve essere applicato il ranking personalizzato.

Enum
`ATTRIBUTE_TYPE_UNSPECIFIED`	Tipo di attributo non specificato.
`NUMERICAL`	Il valore del campo numerico verrà utilizzato per aggiornare dinamicamente l'importo dell'incremento. In questo caso, attribute_value (il valore x) del punto di controllo sarà il valore effettivo del campo numerico per cui è specificato boost_amount.
`FRESHNESS`	Per il caso d'uso della freschezza, il valore dell'attributo sarà la durata tra l'ora corrente e la data nel campo datetime specificato. Il valore deve essere formattato come valore XSD `dayTimeDuration` (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: `[nD][T[nH][nM][nS]]`. Ad esempio, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

I punti di controllo utilizzati per definire la curva. La curva definita tramite questi punti di controllo può essere solo crescente o decrescente in modo monotono(i valori costanti sono accettabili).

Campi

attribute_value

string

Facoltativo. Può corrispondere a uno dei seguenti: 1. Il valore del campo numerico. 2. Specifica della durata per l'aggiornamento: il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]].

boost_amount

float

Facoltativo. Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attribute_value restituisce il valore specificato sopra.

InterpolationType

Il tipo di interpolazione da applicare. Il valore predefinito sarà lineare (lineare a tratti).

Enum
`INTERPOLATION_TYPE_UNSPECIFIED`	Il tipo di interpolazione non è specificato. In questo caso, il valore predefinito è Lineare.
`LINEAR`	Verrà applicata l'interpolazione lineare a tratti.

FilterAction

Specifica quali prodotti possono essere inclusi nei risultati. Utilizza lo stesso filtro del boost.

Campi

filter

string

Obbligatorio. Un filtro da applicare ai risultati della condizione di corrispondenza.

Documentazione sulla sintassi obbligatoria: https://cloud.google.com/retail/docs/filter-and-order. La lunghezza massima è di 5000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.

data_store

string

Obbligatorio. Specifica i documenti di quale datastore possono essere filtrati con questo controllo. Nome completo del datastore, ad es. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

Promuovere determinati link in base ad alcune query di attivazione.

Esempio: promuovi il link al negozio di scarpe quando cerchi la parola chiave shoe. Il link può trovarsi al di fuori del datastore associato.

Campi

data_store

string

Obbligatorio. Datastore a cui è collegata questa promozione.

search_link_promotion

SearchLinkPromotion

Obbligatorio. Promozione associata a questa azione.

RedirectAction

Reindirizza un acquirente all'URI fornito.

Campi

redirect_uri

string

Obbligatorio. L'URI a cui verrà reindirizzato l'acquirente.

Obbligatorio. L'URI deve avere una lunghezza uguale o inferiore a 2000 caratteri. In caso contrario, viene generato un errore INVALID ARGUMENT.

SynonymsAction

Crea un insieme di termini che fungeranno da sinonimi l'uno dell'altro.

Esempio: "felice" verrà considerato anche come "contento", "contento" verrà considerato anche come "felice".

Campi

synonyms[]

string

Definisce un insieme di sinonimi. Può specificare fino a 100 sinonimi. Devi specificare almeno 2 sinonimi. In caso contrario, viene generato un errore INVALID ARGUMENT.

Conversazione

Definizione del proto di conversazione esterna.

Campi
`name`	`string` Immutabile. Nome completo `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` o `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` Lo stato della conversazione.
`user_pseudo_id`	`string` Un identificatore univoco per il monitoraggio degli utenti.
`messages[]`	`ConversationMessage` Messaggi delle conversazioni.
`start_time`	`Timestamp` Solo output. L'ora di inizio della conversazione.
`end_time`	`Timestamp` Solo output. L'ora in cui è terminata la conversazione.

Stato

Enumerazione dello stato della conversazione.

Enum
`STATE_UNSPECIFIED`	Sconosciuto.
`IN_PROGRESS`	La conversazione è attualmente aperta.
`COMPLETED`	La conversazione è stata completata.

ConversationContext

Definisce il contesto della conversazione

Campi

context_documents[]

string

L'elenco attuale dei documenti visualizzati dall'utente. Contiene i riferimenti alle risorse del documento.

active_document

string

Il documento attivo corrente aperto dall'utente. Contiene il riferimento alla risorsa del documento.

ConversationMessage

Definisce un messaggio della conversazione.

Campi
`create_time`	`Timestamp` Solo output. Timestamp di creazione del messaggio.
Campo unione `message`. `message` può essere solo uno dei seguenti:
`user_input`	`TextInput` Input di testo dell'utente.
`reply`	`Reply` Cerca risposta.

ConverseConversationRequest

Richiesta di messaggio per il metodo ConversationalSearchService.ConverseConversation.

Campi
`name`	`string` Obbligatorio. Il nome della risorsa della conversazione da recuperare. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Utilizza `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` per attivare la modalità sessione automatica, che crea automaticamente una nuova conversazione all'interno di una sessione ConverseConversation.
`query`	`TextInput` Obbligatorio. Input utente corrente.
`serving_config`	`string` Il nome risorsa della configurazione di pubblicazione da utilizzare. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` Se questo valore non è impostato, verrà utilizzata la configurazione di pubblicazione predefinita.
`conversation`	`Conversation` La conversazione da utilizzare solo per la sessione automatica. Il campo del nome verrà ignorato perché assegniamo automaticamente un nuovo nome alla conversazione nella sessione automatica.
`safe_search`	`bool` Se attivare SafeSearch.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per ulteriori dettagli, consulta il documento Google Cloud.
`summary_spec`	`SummarySpec` Una specifica per la configurazione del riepilogo restituito nella risposta.
`filter`	`string` La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti da filtrare. L'espressione del filtro è sensibile alle maiuscole. Verrà utilizzato per filtrare i risultati di ricerca, il che potrebbe influire sulla risposta riepilogativa. Se questo campo non è riconoscibile, viene restituito un `INVALID_ARGUMENT`. Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente del settore dei media potrebbe avere un campo "nome" nel proprio schema. In questo caso, il filtro sarà simile a questo: filter --> name:'ANY("king kong")' Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.
`boost_spec`	`BoostSpec` Specifica del boost per aumentare il ranking di determinati documenti nei risultati di ricerca, il che potrebbe influire sulla risposta inversa. Per ulteriori informazioni sul boosting, consulta la sezione Boosting.

ConverseConversationResponse

Messaggio di risposta per il metodo ConversationalSearchService.ConverseConversation.

Campi

reply

Reply

Risposta alla query corrente.

conversation

Conversazione aggiornata, inclusa la risposta.

search_results[]

SearchResult

Risultati di ricerca.

CreateAssistantRequest

Richiesta per il metodo AssistantService.CreateAssistant.

Campi

parent

string

Obbligatorio. Il nome della risorsa padre. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Obbligatorio. Assistant da creare.

assistant_id

string

Obbligatorio. L'ID da utilizzare per Assistant, che diventerà il componente finale del nome della risorsa di Assistant.

Questo campo deve essere conforme a RFC-1034 con un limite di lunghezza di 63 caratteri.

CreateControlRequest

Richiesta per il metodo CreateControl.

Campi

parent

string

Obbligatorio. Nome completo risorsa del datastore padre. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} o projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control

Control

Obbligatorio. Il controllo da creare.

control_id

string

Obbligatorio. L'ID da utilizzare per il controllo, che diventerà il componente finale del nome della risorsa del controllo.

Questo valore deve contenere da 1 a 63 caratteri. I caratteri validi sono /[a-z][0-9]-_/.

CreateConversationRequest

Richiesta per il metodo CreateConversation.

Campi

parent

string

Obbligatorio. Nome completo risorsa del datastore padre. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Obbligatorio. La conversazione da creare.

CreateDataStoreMetadata

Metadati relativi all'avanzamento dell'operazione DataStoreService.CreateDataStore. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

CreateDataStoreRequest

Richiesta per il metodo DataStoreService.CreateDataStore.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa padre, ad esempio `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Obbligatorio. `DataStore` da creare.
`data_store_id`	`string` Obbligatorio. L'ID da utilizzare per `DataStore`, che diventerà il componente finale del nome della risorsa di `DataStore`. Questo campo deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`create_advanced_site_search`	`bool` Un flag booleano che indica se l'utente vuole creare direttamente un datastore avanzato per la ricerca sul sito. Se il datastore non è configurato come ricerca sul sito (verticale GENERIC e content_config PUBLIC_WEBSITE), questo flag verrà ignorato.
`skip_default_schema_creation`	`bool` Un flag booleano che indica se ignorare la creazione dello schema predefinito per il datastore. Attiva questo flag solo se hai la certezza che lo schema predefinito non è compatibile con il tuo caso d'uso. Se impostato su true, devi creare manualmente uno schema per il datastore prima di poter importare i documenti. Questo flag non può essere specificato se è specificato `data_store.starting_schema`.
Campo unione `cmek_options`. Opzioni CMEK per DataStore. L'impostazione di questo campo sostituirà CmekConfig predefinito, se ne è impostato uno per il progetto. `cmek_options` può essere solo uno dei seguenti:
`cmek_config_name`	`string` Nome della risorsa di CmekConfig da utilizzare per proteggere questo datastore.
`disable_cmek`	`bool` DataStore senza protezioni CMEK. Se per il progetto è impostato un CmekConfig predefinito, l'impostazione di questo campo sostituirà anche il CmekConfig predefinito.

CreateDocumentRequest

Richiesta di messaggio per il metodo DocumentService.CreateDocument.

Campi

parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Obbligatorio. Document da creare.

document_id

string

Obbligatorio. L'ID da utilizzare per Document, che diventa il componente finale di Document.name.

Se il chiamante non dispone dell'autorizzazione per creare Document, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Il valore di questo campo deve essere univoco tra tutti i Document con lo stesso parent. In caso contrario, viene restituito un errore ALREADY_EXISTS.

Questo campo deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

CreateEngineMetadata

Metadati relativi all'avanzamento dell'operazione EngineService.CreateEngine. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

CreateEngineRequest

Richiesta per il metodo EngineService.CreateEngine.

Campi

parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Obbligatorio. Engine da creare.

engine_id

string

Obbligatorio. L'ID da utilizzare per Engine, che diventerà il componente finale del nome della risorsa di Engine.

Questo campo deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

CreateIdentityMappingStoreRequest

Richiesta di messaggi per IdentityMappingStoreService.CreateIdentityMappingStore

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa raccolta padre, ad esempio `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Obbligatorio. L'ID dell'archivio di mappatura delle identità da creare. L'ID deve contenere solo lettere (a-z, A-Z), numeri (0-9), trattini bassi (_) e trattini (-). La lunghezza massima è di 63 caratteri.
`identity_mapping_store`	`IdentityMappingStore` Obbligatorio. L'Identity Mapping Store da creare.
Campo unione `cmek_options`. Opzioni CMEK per l'archivio di mappatura delle identità. L'impostazione di questo campo sostituirà CmekConfig predefinito, se ne è impostato uno per il progetto. `cmek_options` può essere solo uno dei seguenti:
`cmek_config_name`	`string` Nome della risorsa di CmekConfig da utilizzare per proteggere questo archivio di mappatura delle identità.
`disable_cmek`	`bool` Identity Mapping Store senza protezioni CMEK. Se per il progetto è impostato un CmekConfig predefinito, l'impostazione di questo campo sostituirà anche il CmekConfig predefinito.

CreateLicenseConfigRequest

Richiesta di messaggio per il metodo LicenseConfigService.CreateLicenseConfig.

Campi

parent

string

Obbligatorio. Il nome della risorsa padre, ad esempio projects/{project}/locations/{location}.

license_config

LicenseConfig

Obbligatorio. LicenseConfig da creare.

license_config_id

string

Facoltativo. L'ID da utilizzare per LicenseConfig, che diventerà il componente finale del nome della risorsa di LicenseConfig. Utilizziamo il nome del livello (edizione del prodotto) come ID configurazione della licenza, ad esempio search o search_and_assistant.

CreateSchemaMetadata

Metadati per LRO Create Schema.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

CreateSchemaRequest

Richiesta di messaggio per il metodo SchemaService.CreateSchema.

Campi

parent

string

Obbligatorio. Il nome della risorsa dell'archivio dati padre, nel formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Obbligatorio. Schema da creare.

schema_id

string

Obbligatorio. L'ID da utilizzare per Schema, che diventa il componente finale di Schema.name.

Questo campo deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri.

CreateSessionRequest

Richiesta per il metodo CreateSession.

Campi

parent

string

Obbligatorio. Nome completo risorsa del datastore padre. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Obbligatorio. La sessione da creare.

CreateSitemapMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.CreateSitemap. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

CreateSitemapRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.CreateSitemap.

Campi

parent

string

Obbligatorio. Nome della risorsa padre di SiteSearchEngine, ad esempio projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Obbligatorio. Sitemap da creare.

CreateTargetSiteMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.CreateTargetSite. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

CreateTargetSiteRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.CreateTargetSite.

Campi

parent

string

Obbligatorio. Nome della risorsa padre di TargetSite, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Obbligatorio. TargetSite da creare.

CustomAttribute

Un attributo personalizzato che non è modellato esplicitamente in una risorsa, ad esempio UserEvent.

Campi

text[]

string

I valori testuali di questo attributo personalizzato. Ad esempio, ["yellow", "green"] quando la chiave è "colore".

Non è consentita una stringa vuota. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Deve essere impostato esattamente uno dei valori CustomAttribute.text o CustomAttribute.numbers. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

numbers[]

double

I valori numerici di questo attributo personalizzato. Ad esempio, [2.3, 15.4] quando la chiave è "lengths_cm".

Deve essere impostato esattamente uno dei valori CustomAttribute.text o CustomAttribute.numbers. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

CustomTuningModel

Metadati che descrivono un modello personalizzato.

Campi
`name`	`string` Obbligatorio. Il nome risorsa completo del modello. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Il modello deve essere una stringa alfanumerica con un limite di 40 caratteri.
`display_name`	`string` Il nome visualizzato del modello.
`model_version`	`int64` La versione del modello.
`model_state`	`ModelState` Lo stato in cui si trova il modello (ad es.`TRAINING` o `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Questo elemento è deprecato. Obsoleto: timestamp della creazione del modello.
`training_start_time`	`Timestamp` Timestamp dell'avvio dell'addestramento del modello.
`metrics`	`map<string, double>` Le metriche del modello addestrato.
`error_message`	`string` Al momento, questo campo viene compilato solo se lo stato del modello è `INPUT_VALIDATION_FAILED`.

ModelState

Lo stato del modello.

Enum
`MODEL_STATE_UNSPECIFIED`	Valore predefinito.
`TRAINING_PAUSED`	Il modello è in stato di addestramento in pausa.
`TRAINING`	Il modello è attualmente in fase di addestramento.
`TRAINING_COMPLETE`	L'addestramento del modello è stato completato.
`READY_FOR_SERVING`	Il modello è pronto per la pubblicazione.
`TRAINING_FAILED`	L'addestramento del modello non è riuscito.
`NO_IMPROVEMENT`	L'addestramento del modello è stato completato correttamente, ma le metriche non sono migliorate.
`INPUT_VALIDATION_FAILED`	La convalida dei dati di input non è riuscita. L'addestramento del modello non è stato avviato.

DataConnector

Gestisce la connessione a origini dati esterne per tutti i datastore raggruppati in un Collection. È una risorsa singleton di Collection. L'inizializzazione è supportata solo tramite il metodo DataConnectorService.SetUpDataConnector, che creerà un nuovo Collection e inizializzerà il relativo DataConnector.

Campi
`name`	`string` Solo output. Il nome completo della risorsa del connettore dati. Formato: `projects//locations//collections/*/dataConnector`.
`state`	`State` Solo output. Stato del connettore.
`data_source`	`string` Obbligatorio. Il nome dell'origine dati. Valori supportati: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Facoltativo. Specifica le chiavi da rimuovere dal campo "params". Questa opzione è attiva solo quando "params" è incluso in "update_mask" in una UpdateDataConnectorRequest. L'eliminazione ha la precedenza se una chiave è presente sia in "remove_param_keys" sia nel campo "params" della richiesta.
`refresh_interval`	`Duration` Obbligatorio. L'intervallo di aggiornamento per la sincronizzazione dei dati. Se la durata è impostata su 0, i dati vengono sincronizzati in tempo reale. La funzionalità di streaming non è ancora supportata. Il valore minimo è 30 minuti e il valore massimo è 7 giorni. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata.
`next_sync_time`	`DateTime` Definisce l'ora pianificata per la successiva sincronizzazione dei dati. Questo campo richiede ora, minuti e fuso orario dal database dei fusi orari IANA. Questo viene utilizzato quando il connettore dati ha un intervallo di aggiornamento superiore a 1 giorno. Se non vengono specificati ore o minuti, verrà utilizzato un orario di sincronizzazione di 0:00. L'utente deve fornire un fuso orario per evitare ambiguità.
`entities[]`	`SourceEntity` Elenco delle entità dell'origine dati connessa da importare.
`create_time`	`Timestamp` Solo output. Timestamp della creazione di `DataConnector`.
`latest_pause_time`	`Timestamp` Solo output. Il timestamp più recente in cui questo `DataConnector` è stato messo in pausa, con conseguenze su tutte le funzionalità, come la sincronizzazione dei dati. La sospensione di un connettore ha i seguenti effetti: - Tutte le funzionalità, inclusa la sincronizzazione dei dati, vengono interrotte. - Qualsiasi job di sincronizzazione dei dati in corso verrà annullato. - Non verranno pianificate né attivate esecuzioni future di sincronizzazione dei dati.
`last_sync_time`	`Timestamp` Solo output. Solo per i connettori periodici, l'ultima volta che è stata completata una sincronizzazione dei dati.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento di `DataConnector`.
`errors[]`	`Status` Solo output. Gli errori di inizializzazione o dell'ultima esecuzione del connettore.
`sync_mode`	`SyncMode` La modalità di sincronizzazione dei dati supportata dal connettore dati.
`kms_key_name`	`string` Solo input. La chiave KMS da utilizzare per proteggere i datastore gestiti da questo connettore. Deve essere impostato per le richieste che devono essere conformi alle protezioni delle policy dell'organizzazione CMEK. Se questo campo è impostato ed elaborato correttamente, i Data Store creati da questo connettore saranno protetti dalla chiave KMS.
`destination_configs[]`	`DestinationConfig` Facoltativo. Qualsiasi destinazione di destinazione utilizzata per connettersi a servizi di terze parti.
`action_state`	`State` Solo output. Stato del connettore di azione. Indica se il connettore di azioni è in fase di inizializzazione, attivo o se si sono verificati errori.
`action_config`	`ActionConfig` Facoltativo. Configurazioni delle azioni per fare in modo che il connettore supporti le azioni.
`end_user_config`	`EndUserConfig` Facoltativo. Qualsiasi parametro e credenziale utilizzati specificamente per i connettori EUA.
`federated_config`	`FederatedConfig` Facoltativo. Qualsiasi parametro e credenziale utilizzato specificamente per i connettori ibridi che supportano la modalità FEDERATED. Questo campo deve essere impostato solo se il connettore è un connettore ibrido e vogliamo attivare la modalità FEDERATED.
`connector_modes[]`	`ConnectorMode` Facoltativo. Le modalità abilitate per questo connettore. Lo stato predefinito è CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Facoltativo. Indica se il cliente ha abilitato gli indirizzi IP statici per questo connettore.
`static_ip_addresses[]`	`string` Solo output. Gli indirizzi IP statici utilizzati da questo connettore.
`blocking_reasons[]`	`BlockingReason` Solo output. Azioni dell'utente che devono essere completate prima che il connettore possa iniziare a sincronizzare i dati.
`identity_refresh_interval (deprecated)`	`Duration` Questo elemento è deprecato. L'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti importati da questo connettore. Se il criterio non viene configurato, l'elenco di controllo dell'accesso verrà aggiornato all'intervallo predefinito di 30 minuti. L'intervallo di aggiornamento dell'identità può essere di almeno 30 minuti e al massimo 7 giorni.
`identity_schedule_config`	`IdentityScheduleConfig` La configurazione delle esecuzioni della sincronizzazione dei dati delle identità. Contiene l'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti inseriti da questo connettore.
`private_connectivity_project_id`	`string` Solo output. L'ID progetto tenant associato ai connettori di connettività privata. Per il funzionamento del connettore, questo progetto deve essere incluso nella lista consentita.
`bap_config`	`BAPConfig` Facoltativo. La configurazione per stabilire una connessione BAP.
`connector_type`	`ConnectorType` Solo output. Il tipo di connettore. Ogni origine può essere mappata a un solo tipo. Ad esempio, Salesforce, Confluence e Jira hanno il tipo di connettore THIRD_PARTY. Una volta impostato dal sistema, non è modificabile.
`realtime_state`	`State` Solo output. Stato di sincronizzazione in tempo reale
`alert_policy_configs[]`	`AlertPolicyConfig` Facoltativo. Configurazione degli avvisi a livello di connettore.
`realtime_sync_config`	`RealtimeSyncConfig` Facoltativo. La configurazione per la sincronizzazione in tempo reale.
`acl_enabled`	`bool` Facoltativo. Indica se il connettore verrà creato con una configurazione ACL. Al momento, questo campo influisce solo sui connettori Cloud Storage e BigQuery.
`create_eua_saas`	`bool` Facoltativo. Indica se il connettore END USER AUTHENTICATION è stato creato in SaaS.
`auto_run_disabled`	`bool` Facoltativo. Indica se il connettore è disattivato per l'esecuzione automatica. Può essere utilizzato per mettere in pausa la sincronizzazione periodica e in tempo reale. Aggiornamento: con l'introduzione di incremental_sync_disabled, auto_run_disabled viene utilizzato per mettere in pausa/disattivare solo le sincronizzazioni complete
`incremental_sync_disabled`	`bool` Facoltativo. Indica se le sincronizzazioni incrementali sono in pausa per questo connettore. Questa impostazione è indipendente da auto_run_disabled. Applicabile solo ai connettori di terze parti. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata, ovvero impostata su true.
`incremental_refresh_interval`	`Duration` Facoltativo. L'intervallo di aggiornamento specifico per le sincronizzazioni incrementali dei dati. Se non viene configurato, le sincronizzazioni incrementali utilizzeranno il valore predefinito dell'ambiente, impostato su 3 ore. Il valore minimo è 30 minuti e il valore massimo è 7 giorni. Applicabile solo ai connettori di terze parti. Quando l'intervallo di aggiornamento è impostato sullo stesso valore dell'intervallo di aggiornamento incrementale, la sincronizzazione incrementale viene disattivata.
`hybrid_ingestion_disabled`	`bool` Facoltativo. Se il connettore è un connettore ibrido, determina se l'importazione è abilitata e se viene eseguito il provisioning delle risorse appropriate durante la creazione del connettore. Se il connettore non è un connettore ibrido, questo campo viene ignorato.
Campo unione `data_connector_params`. Parametri necessari per accedere alla sorgente nel formato di coppie (chiave, valore). I valori stringa con il formato `projects//[locations//]secrets//versions/` verranno letti da Secret Manager. Parametri obbligatori per tutte le origini dati: Chiave: `instance_uri` Valore: digita STRING. L'URI per accedere all'origine dati. Parametri obbligatori per le origini che supportano OAUTH, ad es. `salesforce`: Chiave: `client_id` Valore: digita STRING. L'ID client del fornitore di servizi di terze parti per identificare la tua applicazione. Chiave: `client_secret` Valore:tipo STRING. Il client secret generato dal server di autorizzazione di terze parti. Chiave: `access_token` Valore: digita STRING. Token OAuth per UCS per accedere alla risorsa protetta. Chiave: `refresh_token` Valore: digita STRING. Token di aggiornamento OAuth per UCS per ottenere un nuovo token di accesso senza interazione da parte dell'utente. Parametri obbligatori per le origini che supportano l'autenticazione di base con token API, ad esempio `jira`, `confluence`: Chiave: `user_account` Valore: digita STRING. Il nome utente o l'indirizzo email con la fonte. Chiave: `api_token` Valore: digita STRING. Il token API generato per l'account di origine, utilizzato per l'autenticazione ovunque avresti utilizzato una password. Esempio: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` Parametro facoltativo per specificare il tipo di autorizzazione da utilizzare per il supporto di più tipi di autorizzazione: Chiave: `auth_type` Valore: digita STRING. Il tipo di autorizzazione per l'origine dati. Valori supportati: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. `data_connector_params` può essere solo uno dei seguenti:
`params`	`Struct` Parametri del connettore dati obbligatori in formato JSON strutturato.
`json_params`	`string` Parametri del connettore dati obbligatori in formato stringa JSON.

BlockingReason

Azioni dell'utente che devono essere completate prima che il connettore possa iniziare a sincronizzare i dati.

Enum
`BLOCKING_REASON_UNSPECIFIED`	Valore predefinito.
`ALLOWLIST_STATIC_IP`	Il connettore richiede al cliente di inserire gli IP statici nella lista consentita.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	Il connettore richiede al cliente di inserire il nostro progetto nella lista consentita del collegamento del servizio.
`ALLOWLIST_SERVICE_ACCOUNT`	Il connettore richiede che il cliente inserisca nella lista consentita account di servizio nel suo progetto.

ConnectorMode

Le modalità abilitate per questo connettore. INGESTION, ACTIONS, FEDERATED, OR EUA

Enum
`CONNECTOR_MODE_UNSPECIFIED`	Modalità connettore non specificata.
`DATA_INGESTION`	Connettore utilizzato per importazione dati.
`ACTIONS`	Connettore utilizzato per le azioni.
`FEDERATED`	Connettore utilizzato per la ricerca federata.
`EUA`	Connettore utilizzato per l'autenticazione dell'utente finale.
`FEDERATED_AND_EUA`	Connettore ibrido utilizzato per la ricerca federata e l'autenticazione dell'utente finale.

EndUserConfig

Qualsiasi parametro e credenziale utilizzati specificamente per i connettori EUA.

Campi
`additional_params`	`Struct` Facoltativo. Eventuali parametri aggiuntivi necessari per l'EUA.
`tenant`	`Tenant` Facoltativo. Il progetto tenant a cui è connesso il connettore.
Campo unione `auth_config`. Configurazione dell'autenticazione per i connettori EULA. `auth_config` può essere solo uno dei seguenti:
`auth_params`	`Struct` Facoltativo. Eventuali parametri di autenticazione specifici per i connettori EUA.
`json_auth_params`	`string` Facoltativo. Eventuali parametri di autenticazione specifici per i connettori EUA in formato stringa JSON.

FederatedConfig

Qualsiasi parametro e credenziale utilizzato specificamente per i connettori ibridi che supportano la modalità FEDERATED.

Campi
`additional_params`	`Struct` Facoltativo. Eventuali parametri aggiuntivi necessari per FEDERATED.
Campo unione `auth_config`. Configurazione dell'autenticazione per i connettori FEDERATED. `auth_config` può essere solo uno dei seguenti:
`auth_params`	`Struct` Facoltativo. Eventuali parametri di autenticazione specifici per i connettori FEDERATED.
`json_auth_params`	`string` Facoltativo. Qualsiasi parametro di autenticazione specifico per i connettori FEDERATED in formato stringa JSON.

RealtimeSyncConfig

La configurazione per la sincronizzazione in tempo reale per memorizzare parametri aggiuntivi per la sincronizzazione in tempo reale.

Campi

webhook_uri

string

Facoltativo. URL webhook per il connettore per specificare parametri aggiuntivi per la sincronizzazione in tempo reale.

realtime_sync_secret

string

Facoltativo. L'ID del secret di Secret Manager utilizzato per il secret del webhook.

streaming_error

StreamingError

Facoltativo. Dettagli dell'errore di streaming.

StreamingError

Dettagli dell'errore di streaming.

Campi

streaming_error_reason

StreamingErrorReason

Facoltativo. Errore di streaming.

error

Facoltativo. Dettagli errore.

StreamingErrorReason

Tipi generali di errori di streaming.

Enum
`STREAMING_ERROR_REASON_UNSPECIFIED`	Motivo dell'errore di streaming non specificato.
`STREAMING_SETUP_ERROR`	Si è verificato un errore durante la configurazione delle risorse per la sincronizzazione in tempo reale.
`STREAMING_SYNC_ERROR`	Si è verificato un errore durante l'esecuzione della sincronizzazione in tempo reale per il connettore.
`INGRESS_ENDPOINT_REQUIRED`	L'endpoint in entrata è obbligatorio quando si configura la sincronizzazione in tempo reale nella connettività privata.

SourceEntity

Rappresenta un'entità nell'origine dati. Ad esempio, l'oggetto Account in Salesforce.

Campi
`entity_name`	`string` Il nome dell'entità. Valori supportati per origine dati: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Attributi per l'indicizzazione. Chiave: nome del campo. Valore: la proprietà della chiave a cui mappare un campo, ad esempio `title` e `description`. Proprietà principali supportate: `title`: Il titolo del record di dati. Queste informazioni verranno visualizzate nei risultati di ricerca. `description`: La descrizione del record di dati. che verrà visualizzato nei risultati di ricerca.
`data_store`	`string` Solo output. Il nome completo della risorsa del datastore associato per l'entità di origine. Formato: `projects//locations//collections//dataStores/`. Quando il connettore viene inizializzato dal metodo `DataConnectorService.SetUpDataConnector`, viene creato automaticamente un `DataStore` per ogni entità di origine.
`starting_schema`	`Schema` Facoltativo. Lo schema di avvio da utilizzare per `DataStore` creato da questa SourceEntity. Se non impostato, verrà utilizzato uno schema verticale specializzato predefinito. Questo campo viene utilizzato solo dall'API [SetUpDataConnector][] e verrà ignorato se utilizzato in altre API. Questo campo verrà omesso da tutte le risposte API, inclusa l'API [GetDataConnector][]. Per recuperare uno schema di un `DataStore`, utilizza l'API `SchemaService.GetSchema`. Lo schema fornito verrà convalidato in base a determinate regole dello schema. Scopri di più in questo documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Facoltativo. Configurazione per la verticale `HEALTHCARE_FHIR`.
Campo unione `entity_params`. I parametri per l'entità per facilitare l'importazione dati. Ad esempio, per i connettori BigQuery: Chiave: `document_id_column` Valore: digita STRING. Il valore dell'ID colonna. `entity_params` può essere solo uno dei seguenti:
`params`	`Struct` I parametri per l'entità per facilitare l'importazione dati in formato JSON strutturato.
`json_params`	`string` I parametri per l'entità per facilitare l'importazione dati in formato stringa JSON.

Stato

Lo stato del connettore.

Enum
`STATE_UNSPECIFIED`	Valore predefinito.
`CREATING`	Il connettore è in fase di configurazione.
`ACTIVE`	Il connettore è stato configurato correttamente ed è in attesa della prossima esecuzione della sincronizzazione.
`FAILED`	Il connettore è in errore. I dettagli dell'errore sono disponibili in `DataConnector.errors`. Se l'errore non è risolvibile, `DataConnector` può essere eliminato dall'API [CollectionService.DeleteCollection].
`RUNNING`	Il connettore sta sincronizzando attivamente i record dall'origine dati.
`WARNING`	Il connettore ha completato un'esecuzione della sincronizzazione, ma ha riscontrato errori non irreversibili.
`INITIALIZATION_FAILED`	Inizializzazione del connettore non riuscita. Le potenziali cause includono errori di runtime o problemi nella pipeline asincrona, che impediscono alla richiesta di raggiungere i servizi downstream (ad eccezione di alcuni tipi di connettori).
`UPDATING`	Il connettore è in fase di aggiornamento.

SyncMode

Definisce la modalità di sincronizzazione dei dati supportata dal connettore dati.

Enum
`PERIODIC`	Il connettore sincronizzerà i dati periodicamente in base a refresh_interval. Utilizzalo con auto_run_disabled per mettere in pausa la sincronizzazione periodica o indicare una sincronizzazione una tantum.
`STREAMING`	I dati verranno sincronizzati in tempo reale.
`UNSPECIFIED`	Il connettore che non importa dati avrà questo valore

DataStore

DataStore acquisisce le impostazioni e le configurazioni globali a livello di datastore.

Campi
`name`	`string` Immutabile. Identificatore. Il nome completo della risorsa del datastore. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
`display_name`	`string` Obbligatorio. Il nome visualizzato del datastore. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`industry_vertical`	`IndustryVertical` Immutabile. Il verticale del settore registrato dal datastore.
`solution_types[]`	`SolutionType` Le soluzioni registrate dal datastore. Soluzioni disponibili per ogni `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` e `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` viene registrato automaticamente. Non è possibile registrare altre soluzioni.
`default_schema_id`	`string` Solo output. L'ID del `Schema` predefinito associato a questo datastore.
`content_config`	`ContentConfig` Immutabile. La configurazione dei contenuti del datastore. Se questo campo non è impostato, il comportamento del server è `ContentConfig.NO_CONTENT` per impostazione predefinita.
`create_time`	`Timestamp` Solo output. Timestamp della creazione di `DataStore`.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Facoltativo. Configurazione per la ricerca avanzata sul sito.
`kms_key_name`	`string` Solo input. La chiave KMS da utilizzare per proteggere questo datastore al momento della creazione. Deve essere impostato per le richieste che devono essere conformi alle protezioni delle policy dell'organizzazione CMEK. Se questo campo è impostato ed elaborato correttamente, il datastore sarà protetto dalla chiave KMS, come indicato nel campo cmek_config.
`cmek_config`	`CmekConfig` Solo output. Informazioni relative a CMEK per Datastore.
`billing_estimation`	`BillingEstimation` Solo output. Stima delle dimensioni dei dati per la fatturazione.
`acl_enabled`	`bool` Immutabile. Se i dati in `DataStore` contengono informazioni ACL. Se è impostato su `true`, i dati di origine devono avere un elenco di controllo degli accessi. Gli ACL verranno importati quando i dati vengono importati con i metodi `DocumentService.ImportDocuments`. Quando l'ACL è abilitata per `DataStore`, non è possibile accedere a `Document` chiamando `DocumentService.GetDocument` o `DocumentService.ListDocuments`. Al momento, gli ACL sono supportati solo nel verticale del settore `GENERIC` con la configurazione dei contenuti non `PUBLIC_WEBSITE`.
`workspace_config`	`WorkspaceConfig` Configurazione per archiviare la configurazione del tipo di datastore per i dati del workspace. Questo valore deve essere impostato quando `DataStore.content_config` è impostato su `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Configurazione per la comprensione e l'arricchimento dei documenti.
`starting_schema`	`Schema` Lo schema iniziale da utilizzare per questo `DataStore` durante il provisioning. Se non impostato, verrà utilizzato uno schema verticale specializzato predefinito. Questo campo viene utilizzato solo dall'API `CreateDataStore` e verrà ignorato se utilizzato in altre API. Questo campo verrà omesso da tutte le risposte dell'API, inclusa l'API `CreateDataStore`. Per recuperare uno schema di un `DataStore`, utilizza l'API `SchemaService.GetSchema`. Lo schema fornito verrà convalidato in base a determinate regole dello schema. Scopri di più in questo documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Facoltativo. Configurazione per la verticale `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Facoltativo. Configurazione del servizio di archiviazione a livello di datastore.
`identity_mapping_store`	`string` Immutabile. Il nome risorsa completo del `IdentityMappingStore` associato. Questo campo può essere impostato solo per i DataStore acl_enabled con IdP `THIRD_PARTY` o `GSUITE`. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Facoltativo. Se impostato, questo datastore è un datastore FAQ di Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Facoltativo. Configurazione per l'approccio di fatturazione configurabile. Consulta

BillingEstimation

Stima delle dimensioni dei dati per datastore.

Campi
`structured_data_size`	`int64` Dimensioni dei dati strutturati in byte.
`unstructured_data_size`	`int64` Dimensioni dei dati non strutturati in byte.
`website_data_size`	`int64` Dimensioni dei dati per i siti web in byte.
`structured_data_update_time`	`Timestamp` Timestamp dell'ultimo aggiornamento per i dati strutturati.
`unstructured_data_update_time`	`Timestamp` Timestamp dell'ultimo aggiornamento per i dati non strutturati.
`website_data_update_time`	`Timestamp` Timestamp dell'ultimo aggiornamento per i siti web.

ConfigurableBillingApproach

Configurazione per l'approccio di fatturazione configurabile.

Enum
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valore predefinito. Per l'approccio di fatturazione non configurabile Spark e non Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Utilizza la fatturazione base + eccedenza dell'abbonamento per l'indicizzazione di base per l'archiviazione non incorporata.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Utilizza la fatturazione a consumo per il componente aggiuntivo di archiviazione per l'incorporamento.

ContentConfig

Configurazione dei contenuti del datastore.

Enum
`CONTENT_CONFIG_UNSPECIFIED`	Valore predefinito.
`NO_CONTENT`	Contiene solo documenti senza `Document.content`.
`CONTENT_REQUIRED`	Contiene solo documenti con `Document.content`.
`PUBLIC_WEBSITE`	Il datastore viene utilizzato per la ricerca sul sito web pubblico.
`GOOGLE_WORKSPACE`	Il datastore viene utilizzato per la ricerca di Workspace. I dettagli dell'datastore del workspace sono specificati in `WorkspaceConfig`.

ServingConfigDataStore

Memorizza le informazioni relative alle configurazioni di pubblicazione a livello di DataStore.

Campi

disabled_for_serving

bool

Facoltativo. Se impostato su true, DataStore non sarà disponibile per la gestione delle richieste di ricerca.

DeleteAssistantRequest

Messaggio di richiesta per il metodo AssistantService.DeleteAssistant.

Campi

name

string

Obbligatorio. Nome risorsa di Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Se il chiamante non dispone dell'autorizzazione per eliminare Assistant, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Assistant da eliminare non esiste, viene restituito un errore NOT_FOUND.

DeleteCmekConfigMetadata

Metadati relativi all'avanzamento dell'operazione CmekConfigService.DeleteCmekConfig. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteCmekConfigRequest

Richiesta di messaggio per il metodo CmekConfigService.DeleteCmekConfig.

Campi

name

string

Obbligatorio. Il nome della risorsa CmekConfig da eliminare, ad esempio projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Metadati relativi all'avanzamento dell'operazione [CollectionService.UpdateCollection][]. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteCollectionRequest

Richiesta di messaggio per il metodo CollectionService.DeleteCollection.

Campi

name

string

Obbligatorio. Il nome completo della risorsa della raccolta, nel formato projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Richiesta per il metodo DeleteControl.

Campi

name

string

Obbligatorio. Il nome della risorsa del controllo da eliminare. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Richiesta per il metodo DeleteConversation.

Campi

name

string

Obbligatorio. Il nome della risorsa della conversazione da eliminare. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadati relativi all'avanzamento dell'operazione DataStoreService.DeleteDataStore. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteDataStoreRequest

Richiesta di messaggio per il metodo DataStoreService.DeleteDataStore.

Campi

name

string

Obbligatorio. Nome completo della risorsa di DataStore, ad esempio projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Se il chiamante non dispone dell'autorizzazione per eliminare DataStore, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il DataStore da eliminare non esiste, viene restituito un errore NOT_FOUND.

DeleteDocumentRequest

Richiesta di messaggio per il metodo DocumentService.DeleteDocument.

Campi

name

string

Obbligatorio. Nome completo della risorsa di Document, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Se il chiamante non dispone dell'autorizzazione per eliminare Document, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Document da eliminare non esiste, viene restituito un errore NOT_FOUND.

DeleteEngineMetadata

Metadati relativi all'avanzamento dell'operazione EngineService.DeleteEngine. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteEngineRequest

Richiesta di messaggio per il metodo EngineService.DeleteEngine.

Campi

name

string

Obbligatorio. Nome completo della risorsa di Engine, ad esempio projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Se il chiamante non dispone dell'autorizzazione per eliminare Engine, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Engine da eliminare non esiste, viene restituito un errore NOT_FOUND.

DeleteIdentityMappingStoreMetadata

Metadati relativi all'avanzamento dell'operazione IdentityMappingStoreService.DeleteIdentityMappingStore. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteIdentityMappingStoreRequest

Richiesta di messaggi per IdentityMappingStoreService.DeleteIdentityMappingStore

Campi

name

string

Obbligatorio. Il nome dell'archivio di mappatura delle identità da eliminare. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadati per l'operazione LRO DeleteSchema.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteSchemaRequest

Richiesta di messaggio per il metodo SchemaService.DeleteSchema.

Campi

name

string

Obbligatorio. Il nome completo della risorsa dello schema, nel formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteSessionRequest

Richiesta per il metodo DeleteSession.

Campi

name

string

Obbligatorio. Il nome della risorsa della sessione da eliminare. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.DeleteSitemap. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteSitemapRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.DeleteSitemap.

Campi

name

string

Obbligatorio. Nome completo della risorsa di Sitemap, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

Se il chiamante non dispone dell'autorizzazione per accedere a Sitemap, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Sitemap richiesto non esiste, viene restituito un errore NOT_FOUND.

DeleteTargetSiteMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.DeleteTargetSite. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DeleteTargetSiteRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.DeleteTargetSite.

Campi

name

string

Obbligatorio. Nome completo della risorsa di TargetSite, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Se il chiamante non dispone dell'autorizzazione per accedere a TargetSite, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il TargetSite richiesto non esiste, viene restituito un errore NOT_FOUND.

DestinationConfig

Definisce gli endpoint di destinazione utilizzati per connettersi a origini di terze parti.

Campi
`key`	`string` Facoltativo. Identificatore univoco della destinazione supportato dal connettore.
`destinations[]`	`Destination` Facoltativo. Le destinazioni per la chiave corrispondente.
Campo unione `destination_config_params`. Parametri aggiuntivi per questa configurazione della destinazione. `destination_config_params` può essere solo uno dei seguenti:
`params`	`Struct` Facoltativo. Parametri aggiuntivi per questa configurazione della destinazione in formato JSON strutturato.
`json_params`	`string` Parametri aggiuntivi per questa configurazione della destinazione in formato stringa JSON.

Destinazione

Definisce un endpoint di destinazione

Campi

port

int32

Facoltativo. Numero di porta di destinazione accettato dalla destinazione.

Campo unione destination. La destinazione dell'endpoint. destination può essere solo uno dei seguenti:

host

string

Host instradabile pubblicamente.

DisableAdvancedSiteSearchMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.DisableAdvancedSiteSearch. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

DisableAdvancedSiteSearchRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.DisableAdvancedSiteSearch.

Campi

site_search_engine

string

Obbligatorio. Nome completo della risorsa di SiteSearchEngine, ad esempio projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

Questo tipo non contiene campi.

Messaggio di risposta per il metodo SiteSearchEngineService.DisableAdvancedSiteSearch.

Documento

Il documento acquisisce tutte le informazioni sui metadati non elaborati degli elementi da consigliare o cercare.

Campi
`name`	`string` Immutabile. Il nome completo della risorsa del documento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
`id`	`string` Immutabile. L'identificatore del documento. L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 128 caratteri.
`schema_id`	`string` L'identificatore dello schema che si trova nello stesso datastore.
`content`	`Content` I dati non strutturati collegati a questo documento. I contenuti possono essere impostati e devono essere impostati se questo documento si trova in un datastore `CONTENT_REQUIRED`.
`parent_document_id`	`string` L'identificatore del documento principale. Al momento supporta al massimo una gerarchia di documenti a due livelli. L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri.
`derived_struct_data`	`Struct` Solo output. Questo campo è OUTPUT_ONLY. Contiene dati derivati che non sono presenti nel documento di input originale.
`acl_info`	`AclInfo` Informazioni sul controllo dell'accesso per il documento.
`index_time`	`Timestamp` Solo output. L'ultima volta che il documento è stato indicizzato. Se questo campo è impostato, il documento potrebbe essere restituito nei risultati di ricerca. Questo campo è OUTPUT_ONLY. Se questo campo non è compilato, significa che il documento non è mai stato indicizzato.
`index_status`	`IndexStatus` Solo output. Lo stato di indicizzazione del documento. Se il documento viene indicizzato correttamente, il campo index_time viene compilato. In caso contrario, se il documento non viene indicizzato a causa di errori, viene compilato il campo error_samples. In caso contrario, se l'indicizzazione del documento è in corso, il campo pending_message viene compilato.
Campo unione `data`. Rappresentazione dei dati. È necessario fornire `struct_data` o `json_data`, altrimenti viene generato un errore `INVALID_ARGUMENT`. `data` può essere solo uno dei seguenti:
`struct_data`	`Struct` I dati JSON strutturati per il documento. Deve essere conforme a `Schema` registrato o viene generato un errore `INVALID_ARGUMENT`.
`json_data`	`string` Rappresentazione della stringa JSON del documento. Deve essere conforme a `Schema` registrato o viene generato un errore `INVALID_ARGUMENT`.

AclInfo

Informazioni sull'ACL del documento.

Campi

readers[]

AccessRestriction

Lettori del documento.

AccessRestriction

AclRestriction per modellare restrizioni di ereditarietà complesse.

Esempio: modellazione di un'ereditarietà "Entrambe le autorizzazioni", in cui per accedere a un documento secondario, l'utente deve avere accesso al documento principale.

Gerarchia del documento: Space_S --> Page_P.

Lettori: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Limitazione ACL Page_P. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }

Campi

principals[]

Principal

Elenco delle entità.

idp_wide

bool

Tutti gli utenti all'interno del provider di identità.

Contenuti

Dati non strutturati collegati a questo documento.

Campi
`mime_type`	`string` Il tipo MIME dei contenuti. Tipi supportati: `application/pdf` (PDF, per ora sono supportati solo i PDF nativi) `text/html` (HTML) `text/plain` (TXT) `application/xml` o `text/xml` (XML) `application/json` (JSON) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) I seguenti tipi sono supportati solo se l'analisi del layout è attivata nel datastore: `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.
Campo unione `content`. I contenuti del documento non strutturato. `content` può essere solo uno dei seguenti:
`raw_bytes`	`bytes` I contenuti rappresentati come un flusso di byte. La lunghezza massima è di 1.000.000 di byte (1 MB / circa 0,95 MiB). Nota: come per tutti i campi `bytes`, questo campo è rappresentato come binario puro in Protocol Buffers e come stringa con codifica Base64 in JSON. Ad esempio, `abc123!?$*&()'-=@~` deve essere rappresentato come `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. Consulta la pagina https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` L'URI dei contenuti. Sono supportati solo gli URI Cloud Storage (ad es. `gs://bucket-name/path/to/file`). La dimensione massima del file è 2, 5 MB per i formati basati su testo e 200 MB per gli altri formati.

IndexStatus

Stato dell'indicizzazione del documento.

Campi

index_time

L'ora in cui è stato indicizzato il documento. Se questo campo è compilato, significa che il documento è stato indicizzato.

error_samples[]

LayoutBasedChunkingConfig

Un campione degli errori riscontrati durante l'indicizzazione del documento. Se questo campo è compilato, il documento non viene indicizzato a causa di errori.

pending_message

string

Immutabile. Il messaggio indica che l'indicizzazione del documento è in corso. Se questo campo è compilato, l'indice del documento è in attesa.

DocumentInfo

Informazioni dettagliate sul documento associate a un evento utente.

Campi
`promotion_ids[]`	`string` Gli ID promozione associati a questo documento. Al momento, questo campo è limitato a un solo ID.
`joined`	`bool` Solo output. Se il documento a cui viene fatto riferimento è presente nel datastore.
Campo unione `document_descriptor`. Un descrittore obbligatorio del `Document` associato. Se viene specificato `id`, vengono utilizzati i valori predefiniti per `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` durante l'annotazione con il documento archiviato. Se viene specificato `name`, i valori forniti (valori predefiniti consentiti) per `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` vengono utilizzati per l'annotazione con il documento archiviato. `document_descriptor` può essere solo uno dei seguenti:
`id`	`string` L'ID risorsa `Document`.
`name`	`string` Il nome completo della risorsa `Document`, nel formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` L'URI `Document`, consentito solo per i datastore di siti web.
`quantity`	`int32` Quantità del documento associato all'evento utente. Il valore predefinito è 1. Ad esempio, questo campo è 2 se due quantità dello stesso documento sono coinvolte in un evento `add-to-cart`. Obbligatorio per gli eventi dei seguenti tipi di evento: `add-to-cart` `purchase`
`conversion_value`	`float` Facoltativo. Il valore di conversione associato a questo documento. Deve essere impostato se `UserEvent.event_type` è "conversione". Ad esempio, un valore di 1000 indica che sono stati trascorsi 1000 secondi per la visualizzazione di un documento per il tipo di conversione `watch`.

DocumentProcessingConfig

Una risorsa singleton di DataStore. Se è vuoto quando viene creato DataStore e DataStore è impostato su DataStore.ContentConfig.CONTENT_REQUIRED, il parser predefinito verrà impostato sul parser digitale.

Campi
`name`	`string` Il nome completo della risorsa della configurazione dell'elaborazione dei documenti. Formato: `projects//locations//collections//dataStores//documentProcessingConfig`.
`chunking_config`	`ChunkingConfig` Indica se la modalità di suddivisione è attivata.
`default_parsing_config`	`ParsingConfig` Configurazioni per il parser predefinito dei documenti. Se non specificato, verrà configurato come DigitalParsingConfig predefinito e la configurazione di analisi predefinita verrà applicata a tutti i tipi di file per l'analisi dei documenti.
`parsing_config_overrides`	`map<string, ParsingConfig>` Mappa dal tipo di file per eseguire l'override della configurazione di analisi predefinita in base al tipo di file. Chiavi supportate: `pdf`: Esegue l'override della configurazione di analisi per i file PDF. Sono supportate l'analisi digitale, l'analisi OCR o l'analisi del layout. `html`: esegui l'override della configurazione di analisi per i file HTML. Sono supportate solo l'analisi digitale e l'analisi del layout. `docx`: esegue l'override della configurazione di analisi per i file DOCX. Sono supportate solo l'analisi digitale e l'analisi del layout. `pptx`: Esegue l'override della configurazione di analisi per i file PPTX. Sono supportate solo l'analisi digitale e l'analisi del layout. `xlsm`: esegui l'override della configurazione di analisi per i file XLSM. Sono supportate solo l'analisi digitale e l'analisi del layout. `xlsx`: esegui l'override della configurazione di analisi per i file XLSX. Sono supportate solo l'analisi digitale e l'analisi del layout.

ChunkingConfig

Configurazione per la configurazione della suddivisione in blocchi.

Campi

Campo unione chunk_mode. Configurazioni aggiuntive che definiscono il comportamento della suddivisione in blocchi. chunk_mode può essere solo uno dei seguenti:

layout_based_chunking_config

Configurazione per la suddivisione in blocchi basata sul layout.

LayoutBasedChunkingConfig

Configurazione per la suddivisione in blocchi basata sul layout.

Campi

chunk_size

int32

Il limite di dimensioni dei token per ogni blocco.

Valori supportati: 100-500 (estremi inclusi). Valore predefinito: 500.

include_ancestor_headings

bool

Se includere l'aggiunta di diversi livelli di intestazioni ai chunk dalla parte centrale del documento per evitare la perdita di contesto.

Valore predefinito: False.

ParsingConfig

Configurazioni correlate applicate a un tipo specifico di parser dei documenti.

Campi
Campo unione `type_dedicated_config`. Configurazioni per i tipi di elaborazione dei documenti. `type_dedicated_config` può essere solo uno dei seguenti:
`digital_parsing_config`	`DigitalParsingConfig` Configurazioni applicate al parser digitale.
`ocr_parsing_config`	`OcrParsingConfig` Configurazioni applicate al parser OCR. Al momento si applica solo ai PDF.
`layout_parsing_config`	`LayoutParsingConfig` Configurazioni applicate al parser layout.

DigitalParsingConfig

Questo tipo non contiene campi.

Le configurazioni di analisi digitale per i documenti.

LayoutParsingConfig

Le configurazioni di analisi del layout per i documenti.

Campi
`enable_table_annotation`	`bool` Facoltativo. Se true, l'annotazione basata su LLM viene aggiunta alla tabella durante l'analisi.
`enable_image_annotation`	`bool` Facoltativo. Se il valore è impostato su True, durante l'analisi viene aggiunta un'annotazione basata su LLM all'immagine.
`structured_content_types[]`	`string` Facoltativo. Contiene i tipi di struttura richiesti da estrarre dal documento. Valori supportati: `shareholder-structure`
`exclude_html_elements[]`	`string` Facoltativo. Elenco degli elementi HTML da escludere dai contenuti analizzati.
`exclude_html_classes[]`	`string` Facoltativo. Elenco delle classi HTML da escludere dai contenuti analizzati.
`exclude_html_ids[]`	`string` Facoltativo. Elenco di ID HTML da escludere dai contenuti analizzati.
`enable_get_processed_document`	`bool` Facoltativo. Se è true, il documento elaborato sarà disponibile per l'API GetProcessedDocument.

OcrParsingConfig

Le configurazioni di analisi OCR per i documenti.

Campi

enhanced_document_elements[]
(deprecated)

string

[OBSOLETO] Questo campo è obsoleto. Per utilizzare l'elaborazione aggiuntiva degli elementi avanzati del documento, passa a layout_parsing_config.

use_native_text

bool

Se il valore è vero, verrà utilizzato il testo nativo anziché il testo OCR nelle pagine contenenti testo nativo.

DoubleList

Doppio elenco.

Campi

values[]

double

Valori doppi.

EnableAdvancedSiteSearchMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.EnableAdvancedSiteSearch. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

RecommendedForYouFeatureConfig

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

EnableAdvancedSiteSearchRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.EnableAdvancedSiteSearch.

Campi

site_search_engine

string

Obbligatorio. Nome completo della risorsa di SiteSearchEngine, ad esempio projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

Questo tipo non contiene campi.

Messaggio di risposta per il metodo SiteSearchEngineService.EnableAdvancedSiteSearch.

Motore

Metadati che descrivono i parametri di addestramento e pubblicazione di un Engine.

Campi
`name`	`string` Immutabile. Identificatore. Il nome risorsa completo del motore. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri. Formato: il motore `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` deve contenere da 1 a 63 caratteri e i caratteri validi sono /[a-z0-9][a-z0-9-_]*/. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`display_name`	`string` Obbligatorio. Il nome visualizzato del motore. Deve essere leggibile. Stringa codificata UTF-8 con un limite di 1024 caratteri.
`create_time`	`Timestamp` Solo output. Timestamp della creazione del motore per suggerimenti.
`update_time`	`Timestamp` Solo output. Timestamp dell'ultimo aggiornamento di Recommendation Engine.
`data_store_ids[]`	`string` Facoltativo. I datastore associati a questo motore. Per i motori di tipo `SOLUTION_TYPE_SEARCH` e `SOLUTION_TYPE_RECOMMENDATION`, è possibile associarli al massimo a un datastore. Se `solution_type` è `SOLUTION_TYPE_CHAT`, qui possono essere associati più `DataStore` nello stesso `Collection`. Tieni presente che, se utilizzato in `CreateEngineRequest`, deve essere fornito un ID DataStore, che verrà utilizzato dal sistema per le inizializzazioni necessarie.
`solution_type`	`SolutionType` Obbligatorio. Le soluzioni del motore.
`industry_vertical`	`IndustryVertical` Facoltativo. Il verticale di settore registrato dal motore. La limitazione del verticale del settore Motori si basa su `DataStore`: il verticale su Motori deve corrispondere al verticale del datastore collegato al motore.
`common_config`	`CommonConfig` Specifica di configurazione comune che specifica i metadati del motore.
`app_type`	`AppType` Facoltativo. Immutabile. Il tipo di applicazione rappresentato da questa risorsa del motore. NOTA: questo è un nuovo concetto indipendente dal tipo di soluzione o dal settore verticale esistente.
`disable_analytics`	`bool` Facoltativo. Se disattivare o meno l'analisi per le ricerche eseguite su questo motore.
`features`	`map<string, FeatureState>` Facoltativo. Configurazione delle funzionalità per il motore per attivare o disattivare le funzionalità. Chiavi supportate: `*`: tutte le funzionalità, se presenti, tutte le altre impostazioni di stato delle funzionalità vengono ignorate. `agent-gallery` `no-code-agent-builder` `prompt-gallery` `model-selector` `notebook-lm` `people-search` `people-search-org-chart` `bi-directional-audio` `feedback` `session-sharing` `personalization-memory` `disable-agent-sharing` `disable-image-generation` `disable-video-generation` `disable-onedrive-upload` `disable-talk-to-content` `disable-google-drive-upload`
`configurable_billing_approach`	`ConfigurableBillingApproach` Facoltativo. Configurazione per l'approccio di fatturazione configurabile.
Campo unione `engine_config`. Specifiche di configurazione aggiuntive che definiscono il comportamento del motore. `engine_config` può essere solo uno dei seguenti:
`chat_engine_config`	`ChatEngineConfig` Configurazioni per il motore di chat. Applicabile solo se `solution_type` è `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Configurazioni per il motore di ricerca. Applicabile solo se `solution_type` è `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Configurazioni per Media Engine. Applicabile solo ai datastore con verticale `solution_type` `SOLUTION_TYPE_RECOMMENDATION` e `IndustryVertical.MEDIA`.
Campo unione `engine_metadata`. Metadati del motore per monitorare lo stato del motore. `engine_metadata` può essere solo uno dei seguenti:
`chat_engine_metadata`	`ChatEngineMetadata` Solo output. Informazioni aggiuntive su Chat Engine. Applicabile solo se `solution_type` è `SOLUTION_TYPE_CHAT`.

AppType

L'app del motore.

Enum
`APP_TYPE_UNSPECIFIED`	Tutte le app non specificate.
`APP_TYPE_INTRANET`	Tipo di app per la ricerca intranet e Agentspace.

ChatEngineConfig

Configurazioni per un motore di chat.

Campi

agent_creation_config

AgentCreationConfig

La configurazione per generare l'agente Dialogflow associato a questo motore.

Tieni presente che queste configurazioni vengono utilizzate una sola volta e trasmesse al servizio Dialogflow. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore.

dialogflow_agent_to_link

string

Il nome della risorsa di un agente Dialogflow esistente da collegare a questo motore di chat. I clienti possono fornire agent_creation_config per creare l'agente o fornire un nome che lo colleghi al motore di chat.

Formato: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Tieni presente che i dialogflow_agent_to_link vengono utilizzati una sola volta e passati al servizio Dialogflow. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore. Utilizza ChatEngineMetadata.dialogflow_agent per l'associazione effettiva dell'agente dopo la creazione del motore.

allow_cross_region

bool

Facoltativo. Se il flag è impostato su true, l'agente e il motore possono trovarsi in posizioni diverse. In caso contrario, devono trovarsi nella stessa posizione. Il flag è impostato su false per impostazione predefinita.

Tieni presente che i allow_cross_region vengono utilizzati una sola volta e trasferiti a EngineService.CreateEngine. Ciò significa che non possono essere recuperati utilizzando le API EngineService.GetEngine o EngineService.ListEngines dopo la creazione del motore.

AgentCreationConfig

Configurazioni per generare un agente Dialogflow.

Campi
`business`	`string` Nome dell'azienda, dell'organizzazione o di un'altra persona giuridica rappresentata dall'agente. Utilizzato per il prompt LLM del connettore di conoscenza e per la ricerca di conoscenza.
`default_language_code`	`string` Obbligatorio. La lingua predefinita dell'agente come tag di lingua. Consulta la sezione Supporto delle lingue per un elenco dei codici di lingua attualmente supportati.
`time_zone`	`string` Obbligatorio. Il fuso orario dell'agente dal database dei fusi orari, ad esempio America/New_York, Europe/Paris.
`location`	`string` Posizione dell'agente per la creazione dell'agente, valori supportati: global/us/eu. Se non viene specificato, us Engine creerà l'agente utilizzando us-central-1 per impostazione predefinita; eu Engine creerà l'agente utilizzando eu-west-1 per impostazione predefinita.

ChatEngineMetadata

Informazioni aggiuntive su un motore di chat. I campi di questo messaggio sono solo di output.

Campi

dialogflow_agent

string

Il nome della risorsa di un agente Dialogflow a cui fa riferimento questo motore di chat.

Formato: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Configurazioni comuni per un motore.

Campi

company_name

string

Il nome della società, dell'attività o dell'entità associata al motore. L'impostazione di questa opzione può contribuire a migliorare le funzionalità correlate a LLM.

ConfigurableBillingApproach

Configurazione per l'approccio di fatturazione configurabile.

Enum
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valore predefinito. Per l'approccio di fatturazione non configurabile Spark e non Spark. Modello di prezzi generale.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	L'approccio di fatturazione segue le configurazioni specificate dal cliente.

FeatureState

Lo stato della funzionalità per il motore.

Enum
`FEATURE_STATE_UNSPECIFIED`	Lo stato della funzionalità non è specificato.
`FEATURE_STATE_ON`	La funzionalità è attivata per essere accessibile.
`FEATURE_STATE_OFF`	La funzionalità è disattivata per non essere accessibile.

MediaRecommendationEngineConfig

Specifiche di configurazione aggiuntive per un motore di suggerimenti sui contenuti multimediali.

Campi
`type`	`string` Obbligatorio. Il tipo di motore. Ad esempio, `recommended-for-you`. Questo campo, insieme a `optimization_objective`, descrive i metadati del motore da utilizzare per controllare l'addestramento e la pubblicazione del motore. Valori attualmente supportati: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
`optimization_objective`	`string` L'obiettivo di ottimizzazione, ad esempio `cvr`. Questo campo, insieme a `optimization_objective`, descrive i metadati del motore da utilizzare per controllare l'addestramento e la pubblicazione del motore. Valori attualmente supportati: `ctr`, `cvr`. Se non specificato, scegliamo il valore predefinito in base al tipo di motore. Il valore predefinito dipende dal tipo di consiglio: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` Nome e valore della soglia personalizzata per cvr optimization_objective. Per target_field `watch-time`, target_field_value deve essere un valore intero che indica il tempo di avanzamento dei contenuti multimediali in secondi compreso tra (0, 86400] (escluso 0, incluso 86400) (ad es. 90). Per target_field `watch-percentage`, target_field_value deve essere un valore float valido compreso tra (0, 1.0] (escluso 0, incluso 1.0) (ad es. 0,5).
`training_state`	`TrainingState` Lo stato di addestramento del motore (ad es. `TRAINING` o `PAUSED`). Poiché parte del costo di esecuzione del servizio è la frequenza di addestramento, questo può essere utilizzato per determinare quando addestrare il motore al fine di controllare i costi. Se non specificato: il valore predefinito per il metodo `CreateEngine` è `TRAINING`. Il valore predefinito per il metodo `UpdateEngine` è mantenere lo stato invariato.
`engine_features_config`	`EngineFeaturesConfig` Facoltativo. Configurazione delle funzionalità aggiuntive del motore.

EngineFeaturesConfig

Altre configurazioni delle funzionalità del tipo di motore selezionato.

Campi

Campo unione type_dedicated_config. Configurazioni correlate alle funzionalità applicate a un tipo specifico di motori di suggerimenti multimediali. type_dedicated_config può essere solo uno dei seguenti:

recommended_for_you_config

Configurazione della funzionalità del motore consigliata per te.

most_popular_config

MostPopularFeatureConfig

Configurazione della funzionalità del motore più popolare.

MostPopularFeatureConfig

Configurazioni delle funzionalità necessarie per creare un motore Più popolari.

Campi

time_window_days

int64

La finestra temporale in cui viene eseguita la query del motore durante l'addestramento e la previsione. Solo numeri interi positivi. Il valore corrisponde agli eventi degli ultimi X giorni. Attualmente richiesto per il motore most-popular-items.

OptimizationObjectiveConfig

Soglia personalizzata per l'obiettivo di ottimizzazione cvr.

Campi

target_field

string

Obbligatorio. Il nome del campo da scegliere come target. Valori attualmente supportati: watch-percentage, watch-time.

target_field_value_float

float

Obbligatorio. La soglia da applicare al target (ad es. 0,5).

RecommendedForYouFeatureConfig

Configurazioni delle funzionalità aggiuntive per la creazione di un motore recommended-for-you.

Campi

context_event_type

string

Il tipo di evento con cui viene eseguita una query sul motore al momento della previsione. Se impostato su generic, verranno utilizzati solo view-item, media-play e media-complete come context-event nell'addestramento del motore. Se impostato su view-home-page, view-home-page verrà utilizzato anche come context-events oltre a view-item, media-play e media-complete. Attualmente supportato per il motore recommended-for-you. Valori attualmente supportati: view-home-page, generic.

TrainingState

Lo stato di addestramento del motore.

Enum
`TRAINING_STATE_UNSPECIFIED`	Stato di addestramento non specificato.
`PAUSED`	L'addestramento del motore è in pausa.
`TRAINING`	Il motore è in fase di addestramento.

SearchEngineConfig

Configurazioni per un motore di ricerca.

Campi

search_tier

SearchTier

Il livello della funzionalità di ricerca di questo motore.

I diversi livelli potrebbero avere prezzi diversi. Per saperne di più, consulta la documentazione sui prezzi.

Se non specificato, il valore predefinito è SearchTier.SEARCH_TIER_STANDARD.

search_add_ons[]

SearchAddOn

Il componente aggiuntivo che questo motore di ricerca attiva.

FactChunk

Fact Chunk.

Campi
`chunk_text`	`string` Contenuto testuale del blocco di fatti. Può contenere al massimo 10.000 caratteri.
`source`	`string` L'origine da cui è stato recuperato questo blocco di fatti. Se è stato recuperato da GroundingFacts forniti nella richiesta, questo campo conterrà l'indice del fatto specifico da cui è stato recuperato questo chunk.
`index`	`int32` L'indice di questo blocco. Attualmente utilizzato solo per la modalità di streaming.
`source_metadata`	`map<string, string>` Informazioni più granulari per il riferimento alla fonte.
`uri`	`string` L'URI dell'origine.
`title`	`string` Il titolo della fonte.
`domain`	`string` Il dominio della sorgente.

FetchDomainVerificationStatusRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.FetchDomainVerificationStatus.

Campi

site_search_engine

string

Obbligatorio. La risorsa del motore di ricerca del sito in cui recuperiamo tutti gli stati di verifica del dominio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Dimensioni della pagina richiesta. Il server potrebbe restituire un numero di elementi inferiore a quello richiesto. Se non specificato, il server sceglierà un valore predefinito appropriato. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.

page_token

string

Un token di pagina ricevuto da una precedente chiamata FetchDomainVerificationStatus. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a FetchDomainVerificationStatus devono corrispondere alla chiamata che ha fornito il token di pagina.

FetchDomainVerificationStatusResponse

Messaggio di risposta per il metodo SiteSearchEngineService.FetchDomainVerificationStatus.

Campi

target_sites[]

Elenco di TargetSites contenente lo stato di verifica del sito.

next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

total_size

int32

Il numero totale di elementi corrispondenti alla richiesta. Questo campo verrà sempre compilato nella risposta.

FetchSitemapsRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.FetchSitemaps.

Campi

parent

string

Obbligatorio. Nome della risorsa padre di SiteSearchEngine, ad esempio projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Facoltativo. Se specificato, recupera gli Sitemap corrispondenti. Se non specificato, recupera tutti i Sitemap in DataStore.

Matcher

Matcher per gli Sitemap. Al momento supporta solo il matcher di URI.

Campi

Campo unione matcher. Matcher per gli Sitemap. matcher può essere solo uno dei seguenti:

uris_matcher

UrisMatcher

Matcher per URI Sitemap.

UrisMatcher

Matcher per i Sitemap in base ai relativi URI.

Campi

uris[]

string

Gli URI Sitemap.

FetchSitemapsResponse

Messaggio di risposta per il metodo SiteSearchEngineService.FetchSitemaps.

Campi

sitemaps_metadata[]

SitemapMetadata

Elenco dei Sitemap recuperati.

SitemapMetadata

Contiene un Sitemap e i relativi metadati.

Campi

sitemap

Sitemap

Il Sitemap.

FhirStoreSource

Origine di importazione dei dati di Cloud FhirStore.

Campi
`fhir_store`	`string` Obbligatorio. Il nome completo della risorsa dell'archivio FHIR da cui importare i dati, nel formato `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Directory intermedia di Cloud Storage usata per l'importazione con un limite di lunghezza di 2000 caratteri. Può essere specificata se si desidera che FhirStore esegua l'esportazione in una directory specifica di Cloud Storage.
`resource_types[]`	`string` I tipi di risorse FHIR da importare. I tipi di risorse devono essere un sottoinsieme di tutti i tipi di risorse FHIR supportati. Se è vuoto, vengono utilizzati per impostazione predefinita tutti i tipi di risorse FHIR supportati.
`update_from_latest_predefined_schema`	`bool` Facoltativo. Indica se aggiornare lo schema del datastore all'ultimo schema predefinito. Se è true, lo schema DataStore verrà aggiornato in modo da includere tutti i campi FHIR o i tipi di risorse FHIR aggiunti dall'ultima importazione e le risorse FHIR corrispondenti verranno importate dal datastore FHIR. Tieni presente che questo campo non può essere utilizzato insieme a `resource_types`. Deve essere utilizzato dopo l'importazione iniziale.

FirestoreSource

Origine Firestore da cui importare i dati.

Campi
`project_id`	`string` L'ID progetto in cui si trova l'origine Cloud SQL con un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`database_id`	`string` Obbligatorio. Il database Firestore da cui copiare i dati con un limite di lunghezza di 256 caratteri.
`collection_id`	`string` Obbligatorio. La raccolta (o entità) Firestore da cui copiare i dati,con un limite di lunghezza di 1500 caratteri.
`gcs_staging_dir`	`string` Directory intermedia di Cloud Storage usata per l'importazione con un limite di lunghezza di 2000 caratteri. Può essere specificata se si desidera che Firestore esegua l'esportazione in una directory specifica di Cloud Storage. Assicurati che il account di servizio Firestore disponga delle autorizzazioni di amministratore Cloud Storage necessarie per accedere alla directory Cloud Storage specificata.

GcsSource

Percorso di Cloud Storage per i contenuti di input.

Campi

input_uris[]

string

Obbligatorio. URI Cloud Storage dei file di input. Ogni URI può contenere fino a 2000 caratteri. Gli URI possono corrispondere al percorso completo dell'oggetto (ad esempio gs://bucket/directory/object.json) o a un pattern corrispondente a uno o più file, ad esempio gs://bucket/directory/*.json.

Una richiesta può contenere al massimo 100 file (o 100.000 file se data_schema è content). Ogni file può avere dimensioni fino a 2 GB (o 100 MB se data_schema è content).

data_schema

string

Lo schema da utilizzare durante l'analisi dei dati dell'origine.

Valori supportati per le importazioni di documenti:

document (impostazione predefinita): un Document JSON per riga. Ogni documento deve avere un Document.id valido.
content: dati non strutturati (ad es. PDF, HTML). Ogni file corrispondente a input_uris diventa un documento, con l'ID impostato sui primi 128 bit di SHA256(URI) codificati come stringa esadecimale.
custom: Un JSON di dati personalizzati per riga in formato arbitrario conforme al Schema definito dell'datastore. Può essere utilizzato solo dal verticale GENERIC Data Store.
csv: un file CSV con intestazione conforme al Schema definito dell'datastore. Ogni voce dopo l'intestazione viene importata come documento. Può essere utilizzato solo dal verticale GENERIC Data Store.

Valori supportati per le importazioni di eventi utente:

user_event (impostazione predefinita): un UserEvent JSON per riga.

GetAclConfigRequest

Messaggio di richiesta per il metodo GetAclConfigRequest.

Campi

name

string

Obbligatorio. Nome risorsa di AclConfig, ad esempio projects/*/locations/*/aclConfig.

Se il chiamante non dispone dell'autorizzazione per accedere a AclConfig, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

GetAnswerRequest

Richiesta per il metodo GetAnswer.

Campi

name

string

Obbligatorio. Il nome della risorsa della risposta da ottenere. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Messaggio di richiesta per il metodo AssistAnswerService.GetAssistAnswer.

Campi

name

string

Obbligatorio. Nome risorsa di AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Messaggio di richiesta per il metodo AssistantService.GetAssistant.

Campi

name

string

Obbligatorio. Nome risorsa di Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

Messaggio di richiesta per il metodo GetCmekConfigRequest.

Campi

name

string

Obbligatorio. Nome risorsa di CmekConfig, ad esempio projects/*/locations/*/cmekConfig o projects/*/locations/*/cmekConfigs/*.

Se il chiamante non dispone dell'autorizzazione per accedere a CmekConfig, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

GetControlRequest

Richiesta per il metodo GetControl.

Campi

name

string

Obbligatorio. Il nome della risorsa del controllo da ottenere. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Richiesta per il metodo GetConversation.

Campi

name

string

Obbligatorio. Il nome della risorsa della conversazione da recuperare. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Richiesta per il metodo DataConnectorService.GetDataConnector.

Campi

name

string

Obbligatorio. Nome completo della risorsa di DataConnector, ad esempio projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

Se il chiamante non dispone dell'autorizzazione per accedere a DataConnector, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il DataConnector richiesto non esiste, viene restituito un errore NOT_FOUND.

GetDataStoreRequest

Richiesta di messaggio per il metodo DataStoreService.GetDataStore.

Campi

name

string

Obbligatorio. Nome completo della risorsa di DataStore, ad esempio projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Se il chiamante non dispone dell'autorizzazione per accedere a DataStore, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il DataStore richiesto non esiste, viene restituito un errore NOT_FOUND.

GetDocumentRequest

Richiesta di messaggio per il metodo DocumentService.GetDocument.

Campi

name

string

Obbligatorio. Nome completo della risorsa di Document, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Se il chiamante non dispone dell'autorizzazione per accedere a Document, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Document richiesto non esiste, viene restituito un errore NOT_FOUND.

GetEngineRequest

Richiesta di messaggio per il metodo EngineService.GetEngine.

Campi

name

string

Obbligatorio. Nome completo della risorsa di Engine, ad esempio projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetIdentityMappingStoreRequest

Richiesta di messaggi per IdentityMappingStoreService.GetIdentityMappingStore

Campi

name

string

Obbligatorio. Il nome dell'archivio di mappatura delle identità da ottenere. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Richiesta di messaggio per il metodo LicenseConfigService.GetLicenseConfig.

Campi

name

string

Obbligatorio. Nome completo della risorsa di LicenseConfig, ad esempio projects/{project}/locations/{location}/licenseConfigs/*.

Se il chiamante non dispone dell'autorizzazione per accedere a LicenseConfig, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il LicenseConfig richiesto non esiste, viene restituito un errore NOT_FOUND.

GetSchemaRequest

Richiesta di messaggio per il metodo SchemaService.GetSchema.

Campi

name

string

Obbligatorio. Il nome completo della risorsa dello schema, nel formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSessionRequest

Richiesta per il metodo GetSession.

Campi

name

string

Obbligatorio. Il nome della risorsa della sessione da ottenere. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Facoltativo. Se è impostato su true, viene restituita la sessione completa, inclusi tutti i dettagli delle risposte.

GetSiteSearchEngineRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.GetSiteSearchEngine.

Campi

name

string

Obbligatorio. Nome risorsa di SiteSearchEngine, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Se il chiamante non dispone dell'autorizzazione per accedere a [SiteSearchEngine], indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

GetTargetSiteRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.GetTargetSite.

Campi

name

string

Se il chiamante non dispone dell'autorizzazione per accedere a TargetSite, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il TargetSite richiesto non esiste, viene restituito un errore NOT_FOUND.

GroundingFact

Grounding Fact.

Campi

fact_text

string

Contenuto testuale del fatto. Può contenere al massimo 10.000 caratteri.

attributes

map<string, string>

Attributi associati al fatto. Gli attributi comuni includono source (che indica la fonte del fatto), author (che indica l'autore del fatto) e così via.

HarmCategory

Categorie di danni che bloccheranno i contenuti.

Enum
`HARM_CATEGORY_UNSPECIFIED`	La categoria di danno non è specificata.
`HARM_CATEGORY_HATE_SPEECH`	La categoria del danno è incitamento all'odio.
`HARM_CATEGORY_DANGEROUS_CONTENT`	La categoria di danno è "Contenuti pericolosi".
`HARM_CATEGORY_HARASSMENT`	La categoria del danno è molestie.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	La categoria di danno è Contenuti sessualmente espliciti.
`HARM_CATEGORY_CIVIC_INTEGRITY`	La categoria di danno è integrità civica.

HealthcareFhirConfig

Configurazione del datastore per la verticale HEALTHCARE_FHIR.

Campi

enable_configurable_schema

bool

Se abilitare lo schema configurabile per la verticale HEALTHCARE_FHIR.

Se impostato su true, lo schema FHIR sanitario predefinito può essere esteso per una ricerca e un filtro più personalizzati.

enable_static_indexing_for_batch_ingestion

bool

Se abilitare l'indicizzazione statica per l'importazione batch di HEALTHCARE_FHIR.

Se impostato su true, l'importazione batch verrà elaborata in una modalità di indicizzazione statica più lenta, ma più adatta a gestire volumi maggiori.

IdentityMappingEntry

Voce di mappatura delle identità che mappa un'identità esterna a un'identità interna.

Campi
`external_identity`	`string` Obbligatorio. Identità al di fuori del provider di identità del cliente. Il limite di lunghezza dell'identità esterna sarà di 100 caratteri.
Campo unione `identity_provider_id`. Campo unione identity_provider_id. L'ID del provider di identità può essere un utente o un gruppo. `identity_provider_id` può essere solo uno dei seguenti:
`user_id`	`string` Identificatore utente. Per l'account utente Google Workspace, user_id deve essere l'email dell'utente Google Workspace. Per il provider di identità non Google, user_id è l'identificatore utente mappato configurato durante la configurazione di workforcepool.
`group_id`	`string` Identificatore del gruppo. Per l'account utente Google Workspace, group_id deve essere l'email del gruppo Google Workspace. Per il provider di identità non Google, group_id è l'identificatore del gruppo mappato configurato durante la configurazione di workforcepool.

IdentityMappingEntryOperationMetadata

Metadati dell'operazione di lunga durata IdentityMappingEntry per IdentityMappingStoreService.ImportIdentityMappings e IdentityMappingStoreService.PurgeIdentityMappings

Campi

success_count

int64

Il numero di IdentityMappingEntries elaborati correttamente.

failure_count

int64

Il numero di IdentityMappingEntries la cui elaborazione non è riuscita.

total_count

int64

Il numero totale di IdentityMappingEntries elaborati.

IdentityMappingStore

Archivio di mappatura delle identità contenente le voci di mappatura delle identità.

Campi

name

string

Immutabile. Il nome completo della risorsa dell'archivio di mappatura delle identità. Formato: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.

kms_key_name

string

Solo input. La chiave KMS da utilizzare per proteggere questo Identity Mapping Store al momento della creazione.

Deve essere impostato per le richieste che devono essere conformi alle protezioni delle policy dell'organizzazione CMEK.

Se questo campo è impostato ed elaborato correttamente, l'archivio di mappatura delle identità sarà protetto dalla chiave KMS, come indicato nel campo cmek_config.

cmek_config

CmekConfig

Solo output. Informazioni relative a CMEK per l'archivio di mapping delle identità.

IdentityScheduleConfig

La configurazione delle esecuzioni della sincronizzazione dei dati delle identità.

Campi

refresh_interval

Duration

Facoltativo. L'intervallo di aggiornamento per sincronizzare le informazioni dell'elenco di controllo dell'accesso per i documenti importati da questo connettore. Se il criterio non viene configurato, l'elenco di controllo dell'accesso verrà aggiornato all'intervallo predefinito di 30 minuti. L'intervallo di aggiornamento dell'identità può essere di almeno 30 minuti e al massimo 7 giorni.

next_sync_time

DateTime

Facoltativo. L'ora UTC in cui è prevista l'inizio della successiva sincronizzazione dei dati per il connettore dati. I clienti possono specificare solo l'ora e il minuto per pianificare la sincronizzazione dei dati. Questo viene utilizzato quando il connettore dati ha un intervallo di aggiornamento superiore a 1 giorno.

IdpConfig

Configurazione del provider di identità

Campi

idp_type

IdpType

Tipo di provider di identità configurato.

external_idp_config

ExternalIdpConfig

Configurazione del provider di identità esterno.

ExternalIdpConfig

Configurazione IdP di terze parti.

Campi

workforce_pool_name

string

Nome del pool di forza lavoro. Esempio: "locations/global/workforcePools/pool_id"

IdpType

Tipo di provider di identità.

Enum
`IDP_TYPE_UNSPECIFIED`	Valore predefinito. Ricerca ACL non abilitata.
`GSUITE`	Fornitore proprietario di Google.
`THIRD_PARTY`	Fornitore di terze parti.

ImportCompletionSuggestionsMetadata

Metadati relativi all'avanzamento dell'operazione ImportCompletionSuggestions. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Conteggio degli `CompletionSuggestion` importati correttamente.
`failure_count`	`int64` Conteggio degli `CompletionSuggestion` che non è stato possibile importare.

ImportCompletionSuggestionsRequest

Richiesta di messaggio per il metodo CompletionService.ImportCompletionSuggestions.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa dell'archivio dati padre per cui importare i suggerimenti per il completamento automatico dei clienti. Segue il pattern `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` La posizione desiderata degli errori riscontrati durante l'importazione.
Campo unione `source`. L'origine dei suggerimenti di completamento automatico. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea per le voci dei suggerimenti.
`gcs_source`	`GcsSource` Il percorso Cloud Storage per i contenuti di input.
`bigquery_source`	`BigQuerySource` Origine di input BigQuery.

InlineSource

L'origine inline per CompletionSuggestions.

Campi

suggestions[]

CompletionSuggestion

Obbligatorio. Un elenco di tutte le voci della lista bloccata da importare. Massimo 1000 elementi.

ImportCompletionSuggestionsResponse

Risposta del metodo CompletionService.ImportCompletionSuggestions. Se l'operazione a lunga esecuzione è terminata, questo messaggio viene restituito dal campo google.longrunning.Operations.response se l'operazione ha esito positivo.

Campi

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

error_config

ImportErrorConfig

La posizione desiderata degli errori riscontrati durante l'importazione.

ImportDocumentsMetadata

Metadati relativi all'avanzamento dell'operazione ImportDocuments. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Conteggio delle voci elaborate correttamente.
`failure_count`	`int64` Conteggio delle voci che hanno riscontrato errori durante l'elaborazione.
`total_count`	`int64` Il conteggio totale delle voci elaborate.

ImportDocumentsRequest

Messaggio di richiesta per i metodi di importazione.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa del ramo padre, ad esempio `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Richiede l'autorizzazione di creazione/aggiornamento.
`error_config`	`ImportErrorConfig` La posizione desiderata degli errori riscontrati durante l'importazione.
`reconciliation_mode`	`ReconciliationMode` La modalità di riconciliazione tra i documenti esistenti e quelli da importare. Il valore predefinito è `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indica quali campi dei documenti importati forniti devono essere aggiornati. Se non è impostato, il valore predefinito è l'aggiornamento di tutti i campi.
`auto_generate_ids`	`bool` Indica se generare automaticamente gli ID per i documenti in caso di assenza. Se impostato su `true`, gli `Document.id` vengono generati automaticamente in base all'hash del payload, dove gli ID potrebbero non essere coerenti durante più importazioni. In questo caso, ti consigliamo vivamente di utilizzare `ReconciliationMode.FULL` per evitare contenuti duplicati. Se non è impostato o è impostato su `false`, gli `Document.id` devono essere specificati utilizzando `id_field`, altrimenti l'importazione dei documenti senza ID non va a buon fine. Origini dati supportate: `GcsSource`. `GcsSource.data_schema` deve essere `custom` o `csv`. In caso contrario, viene generato un errore INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` deve essere `custom` o `csv`. In caso contrario, viene generato un errore INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` Il campo indica il campo ID o la colonna da utilizzare come ID univoci dei documenti. Per `GcsSource`, è la chiave del campo JSON. Ad esempio, `my_id` per JSON `{"my_id": "some_uuid"}`. Per altri, potrebbe essere il nome della colonna della tabella in cui sono memorizzati gli ID univoci. I valori del campo JSON o della colonna della tabella vengono utilizzati come `Document.id`. Il campo JSON o la colonna della tabella deve essere di tipo stringa e i valori devono essere impostati come stringhe valide conformi a RFC-1034 con 1-63 caratteri. In caso contrario, l'importazione dei documenti senza ID validi non andrà a buon fine. Imposta questo campo solo quando `auto_generate_ids` non è impostato o è impostato su `false`. In caso contrario, viene generato un errore INVALID_ARGUMENT. Se non è impostato, viene utilizzato un valore predefinito `_id` durante l'importazione dalle origini dati consentite. Origini dati supportate: `GcsSource`. `GcsSource.data_schema` deve essere `custom` o `csv`. In caso contrario, viene generato un errore INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` deve essere `custom` o `csv`. In caso contrario, viene generato un errore INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `BigtableSource`.
`force_refresh_content`	`bool` Facoltativo. Indica se forzare l'aggiornamento dei contenuti non strutturati dei documenti. Se impostato su `true`, la parte dei contenuti dei documenti verrà aggiornata indipendentemente dallo stato di aggiornamento dei contenuti di riferimento.
Campo unione `source`. Obbligatorio. L'origine dell'input. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea per i contenuti di input per i documenti.
`gcs_source`	`GcsSource` Il percorso Cloud Storage per i contenuti di input.
`bigquery_source`	`BigQuerySource` Origine di input BigQuery.
`fhir_store_source`	`FhirStoreSource` Origine di input FhirStore.
`spanner_source`	`SpannerSource` Origine di input Spanner.
`cloud_sql_source`	`CloudSqlSource` Origine di input Cloud SQL.
`firestore_source`	`FirestoreSource` Origine di input Firestore.
`alloy_db_source`	`AlloyDbSource` Origine di input AlloyDB.
`bigtable_source`	`BigtableSource` Origine di input Cloud Bigtable.

InlineSource

L'origine incorporata per la configurazione di input per il metodo ImportDocuments.

Campi

documents[]

Obbligatorio. Un elenco di documenti da aggiornare/creare. Ogni documento deve avere un Document.id valido. Consigliamo un massimo di 100 elementi.

ReconciliationMode

Indica in che modo i documenti importati vengono riconciliati con i documenti esistenti creati o importati in precedenza.

Enum
`RECONCILIATION_MODE_UNSPECIFIED`	Il valore predefinito è `INCREMENTAL`.
`INCREMENTAL`	Inserisce nuovi documenti o aggiorna quelli esistenti.
`FULL`	Calcola la differenza e sostituisce l'intero set di dati del documento. I documenti esistenti potrebbero essere eliminati se non sono presenti nella posizione di origine. Quando utilizzi questa modalità, non si verificano tempi di inattività nel set di dati di destinazione. Qualsiasi documento che deve rimanere invariato o che deve essere aggiornato continuerà a essere pubblicato durante l'esecuzione dell'operazione.

ImportDocumentsResponse

Risposta di ImportDocumentsRequest. Se l'operazione a lunga esecuzione è terminata, questo messaggio viene restituito dal campo google.longrunning.Operations.response se l'operazione è andata a buon fine.

Campi

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

error_config

ImportErrorConfig

Se impostata, ripete la destinazione per gli errori completi nella richiesta.

ImportErrorConfig

Configurazione della destinazione per gli errori correlati all'importazione.

Campi

Campo unione destination. Obbligatorio. Destinazione degli errori. destination può essere solo uno dei seguenti:

gcs_prefix

string

Prefisso Cloud Storage per gli errori di importazione. Deve essere una directory Cloud Storage esistente e vuota. Gli errori di importazione vengono scritti in file suddivisi in questa directory, uno per riga, come messaggio google.rpc.Status con codifica JSON.

ImportIdentityMappingsRequest

Richiesta di messaggi per IdentityMappingStoreService.ImportIdentityMappings

Campi

identity_mapping_store

string

Obbligatorio. Il nome dell'archivio di mappatura delle identità in cui importare le voci di mappatura delle identità. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Campo unione source. L'origine dell'input. source può essere solo uno dei seguenti:

inline_source

InlineSource

L'origine in linea da cui importare le voci di mappatura delle identità.

InlineSource

L'origine in linea da cui importare le voci di mappatura delle identità.

Campi

identity_mapping_entries[]

IdentityMappingEntry

È possibile importare un massimo di 10.000 voci alla volta

ImportIdentityMappingsResponse

Messaggio di risposta per IdentityMappingStoreService.ImportIdentityMappings

Campi

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

ImportSuggestionDenyListEntriesMetadata

Metadati relativi all'avanzamento dell'operazione ImportSuggestionDenyListEntries. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

SuggestionDenyListEntry

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

ImportSuggestionDenyListEntriesRequest

Richiesta di messaggio per il metodo CompletionService.ImportSuggestionDenyListEntries.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa datastore padre per cui importare le voci della denylist. Segue il pattern projects//locations//collections//dataStores/.
Campo unione `source`. L'origine dell'elenco di negazione dei suggerimenti aggiornato. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea per i contenuti di input per le voci dell'elenco di valori non consentiti dei suggerimenti.
`gcs_source`	`GcsSource` Il percorso Cloud Storage per i contenuti di input. È possibile specificare un solo file contenente tutte le voci da importare. Valori supportati `gcs_source.schema` per le importazioni di voci dell'elenco negato dei suggerimenti di completamento automatico: `suggestion_deny_list` (impostazione predefinita): un JSON [SuggestionDenyListEntry] per riga.

InlineSource

L'origine in linea per SuggestionDenyListEntry.

Campi

entries[]

Obbligatorio. Un elenco di tutte le voci della lista bloccata da importare. Massimo 1000 elementi.

ImportSuggestionDenyListEntriesResponse

Messaggio di risposta per il metodo CompletionService.ImportSuggestionDenyListEntries.

Campi

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

imported_entries_count

int64

Conteggio delle voci dell'elenco valori non consentiti importate correttamente.

failed_entries_count

int64

Conteggio delle voci dell'elenco valori non consentiti che non sono state importate.

ImportUserEventsMetadata

Metadati relativi all'avanzamento dell'operazione di importazione. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Conteggio delle voci elaborate correttamente.
`failure_count`	`int64` Conteggio delle voci che hanno riscontrato errori durante l'elaborazione.

ImportUserEventsRequest

Messaggio di richiesta per la richiesta ImportUserEvents.

Campi
`parent`	`string` Obbligatorio. Nome della risorsa DataStore padre, nel formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` La posizione desiderata degli errori riscontrati durante l'importazione. Non può essere impostato per le importazioni in linea di eventi utente.
Campo unione `source`. Obbligatorio: l'origine di input desiderata dei dati degli eventi utente. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea per i contenuti di input per UserEvents.
`gcs_source`	`GcsSource` Il percorso Cloud Storage per i contenuti di input.
`bigquery_source`	`BigQuerySource` Origine di input BigQuery.

InlineSource

L'origine in linea per la configurazione di input per il metodo ImportUserEvents.

Campi

user_events[]

UserEvent

Obbligatorio. Un elenco di eventi utente da importare. Consigliamo un massimo di 10.000 elementi.

ImportUserEventsResponse

Risposta di ImportUserEventsRequest. Se l'operazione a lunga esecuzione ha esito positivo, questo messaggio viene restituito dal campo google.longrunning.Operations.response.

Campi
`error_samples[]`	`Status` Un campione degli errori riscontrati durante l'elaborazione della richiesta.
`error_config`	`ImportErrorConfig` Ripete la destinazione per gli errori completi se questo campo è stato impostato nella richiesta.
`joined_events_count`	`int64` Conteggio degli eventi utente importati con documenti esistenti completi.
`unjoined_events_count`	`int64` Conteggio degli eventi utente importati, ma con le informazioni sul documento non trovate nel ramo esistente.

IndustryVertical

Il verticale di settore associato a DataStore.

Enum
`INDUSTRY_VERTICAL_UNSPECIFIED`	Valore utilizzato quando non è impostato.
`GENERIC`	Il verticale generico per i documenti non specifici di alcun settore verticale.
`MEDIA`	Il verticale del settore multimediale.
`HEALTHCARE_FHIR`	Il verticale FHIR Healthcare.

Intervallo

Un intervallo con rappresentazione in virgola mobile.

Campi

Campo unione min. Il limite inferiore dell'intervallo. Se nessuno dei campi min è impostato, il limite inferiore è infinito negativo.

Questo campo non deve essere maggiore del valore massimo. In caso contrario, viene restituito un errore INVALID_ARGUMENT. min può essere solo uno dei seguenti:

minimum

double

Limite inferiore inclusivo.

exclusive_minimum

double

Limite inferiore esclusivo.

Campo unione max. Il limite superiore dell'intervallo. Se nessuno dei campi max è impostato, il limite superiore è infinito positivo.

Questo campo non deve essere inferiore al valore minimo. In caso contrario, viene restituito un errore INVALID_ARGUMENT. max può essere solo uno dei seguenti:

maximum

double

Limite superiore inclusivo.

exclusive_maximum

double

Limite superiore esclusivo.

LicenseConfig

Informazioni sulle licenze degli utenti.

Campi
`name`	`string` Immutabile. Identificatore. Il nome risorsa completo della configurazione della licenza. Formato: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Obbligatorio. Numero di licenze acquistate.
`subscription_tier`	`SubscriptionTier` Obbligatorio. Informazioni sul livello di abbonamento per la configurazione della licenza.
`state`	`State` Solo output. Lo stato della configurazione della licenza.
`auto_renew`	`bool` Facoltativo. Indica se la configurazione della licenza deve essere rinnovata automaticamente quando raggiunge la data di fine.
`start_date`	`Date` Obbligatorio. La data di inizio.
`end_date`	`Date` Facoltativo. La data di fine pianificata.
`subscription_term`	`SubscriptionTerm` Obbligatorio. Periodicità dell'abbonamento.
`free_trial`	`bool` Facoltativo. Indica se la configurazione della licenza è per la prova gratuita.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Facoltativo. La configurazione della policy di avviso per questa configurazione della licenza.
`gemini_bundle`	`bool` Solo output. Indica se la configurazione della licenza è per il bundle Gemini.

Stato

Enumerazione dello stato della configurazione della licenza.

Enum
`STATE_UNSPECIFIED`	Valore predefinito. La configurazione della licenza non esiste.
`ACTIVE`	La configurazione della licenza è effettiva e in uso.
`EXPIRED`	La configurazione della licenza è scaduta.
`NOT_STARTED`	La configurazione della licenza non è ancora iniziata e la data di inizio è nel futuro.

ListAssistantsRequest

Messaggio di richiesta per il metodo AssistantService.ListAssistants.

Campi

parent

string

Obbligatorio. Il nome della risorsa padre. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Il numero massimo di Assistant da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000; qualsiasi valore superiore verrà forzato a 1000.

page_token

string

Un token di pagina ListAssistantsResponse.next_page_token, ricevuto da una precedente chiamata AssistantService.ListAssistants. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListAssistants devono corrispondere alla chiamata che ha fornito il token di pagina.

ListAssistantsResponse

Messaggio di risposta per il metodo AssistantService.ListAssistants.

Campi

assistants[]

Assistant

Tutti i Assistant del cliente.

next_page_token

string

Un token che può essere inviato come ListAssistantsRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListCmekConfigsRequest

Richiesta di messaggio per il metodo CmekConfigService.ListCmekConfigs.

Campi

parent

string

Obbligatorio. Il nome della risorsa della località padre, ad esempio projects/{project}/locations/{location}.

Se il chiamante non dispone dell'autorizzazione per elencare i CmekConfig in questa località, indipendentemente dall'esistenza o meno di un CmekConfig, viene restituito un errore PERMISSION_DENIED.

ListCmekConfigsResponse

Messaggio di risposta per il metodo CmekConfigService.ListCmekConfigs.

Campi

cmek_configs[]

CmekConfig

Tutti i CmekConfig del cliente.

ListControlsRequest

Richiesta per il metodo ListControls.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa del datastore. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` o `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`page_size`	`int32` Facoltativo. Il numero massimo di risultati da restituire. Se non specificato, il valore predefinito è 50. Il valore massimo consentito è 1000.
`page_token`	`string` Facoltativo. Un token di pagina ricevuto da una precedente chiamata `ListControls`. Forniscilo per recuperare la pagina successiva.
`filter`	`string` Facoltativo. Un filtro da applicare ai risultati dell'elenco. Funzioni supportate: Elenca tutti i prodotti nel ramo principale se `filter` non è impostato. Al momento questo campo non è supportato.

ListControlsResponse

Risposta per il metodo ListControls.

Campi

controls[]

Control

Tutti i controlli per un determinato datastore.

next_page_token

string

Token di paginazione. Se non viene restituito, indica l'ultima pagina.

ListConversationsRequest

Richiesta per il metodo ListConversations.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa del datastore. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Il numero massimo di risultati da restituire. Se non specificato, il valore predefinito è 50. Il valore massimo consentito è 1000.
`page_token`	`string` Un token di pagina ricevuto da una precedente chiamata `ListConversations`. Forniscilo per recuperare la pagina successiva.
`filter`	`string` Un filtro da applicare ai risultati dell'elenco. Le funzionalità supportate sono: user_pseudo_id, state. Esempio: "user_pseudo_id = some_id"
`order_by`	`string` Un elenco separato da virgole di campi in base ai quali ordinare, ordinati in ordine crescente. Utilizza "desc" dopo il nome di un campo per l'ordine decrescente. Campi supportati: * `update_time` * `create_time` * `conversation_name` Esempio: "update_time desc" "create_time"

ListConversationsResponse

Risposta per il metodo ListConversations.

Campi

conversations[]

Tutte le conversazioni per un determinato datastore.

next_page_token

string

Token di paginazione. Se non viene restituito, indica l'ultima pagina.

ListCustomModelsRequest

Richiesta di messaggio per il metodo SearchTuningService.ListCustomModels.

Campi

data_store

string

Obbligatorio. Il nome della risorsa del datastore padre, ad esempio projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Questo campo viene utilizzato per identificare il datastore da cui recuperare i modelli.

ListCustomModelsResponse

Messaggio di risposta per il metodo SearchTuningService.ListCustomModels.

Campi

models[]

CustomTuningModel

Elenco dei modelli ottimizzati personalizzati.

ListDataStoresRequest

Richiesta di messaggio per il metodo DataStoreService.ListDataStores.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa del ramo padre, ad esempio `projects/{project}/locations/{location}/collections/{collection_id}`. Se il chiamante non dispone dell'autorizzazione per elencare i `DataStore` in questa località, indipendentemente dall'esistenza o meno di questo datastore, viene restituito un errore PERMISSION_DENIED.
`page_size`	`int32` Il numero massimo di `DataStore` da restituire. Se non specificato, il valore predefinito è 10. Il valore massimo consentito è 50. I valori superiori a 50 verranno forzati a 50. Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.
`page_token`	`string` Un token di pagina `ListDataStoresResponse.next_page_token`, ricevuto da una precedente chiamata `DataStoreService.ListDataStores`. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a `DataStoreService.ListDataStores` devono corrispondere alla chiamata che ha fornito il token di pagina. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`filter`	`string` Filtra per tipo di soluzione . Ad esempio: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Messaggio di risposta per il metodo DataStoreService.ListDataStores.

Campi

data_stores[]

DataStore

Tutti i DataStore del cliente.

next_page_token

string

Un token che può essere inviato come ListDataStoresRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListDocumentsRequest

Richiesta di messaggio per il metodo DocumentService.ListDocuments.

Campi

parent

string

Obbligatorio. Il nome della risorsa del ramo padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Utilizza default_branch come ID ramo per elencare i documenti nel ramo predefinito.

Se il chiamante non dispone dell'autorizzazione per elencare Document in questo ramo, indipendentemente dall'esistenza o meno di questo ramo, viene restituito un errore PERMISSION_DENIED.

page_size

int32

Il numero massimo di Document da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000. I valori superiori a 1000 vengono impostati su 1000.

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.

page_token

string

Un token di pagina ListDocumentsResponse.next_page_token, ricevuto da una precedente chiamata DocumentService.ListDocuments. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a DocumentService.ListDocuments devono corrispondere alla chiamata che ha fornito il token di pagina. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

ListDocumentsResponse

Messaggio di risposta per il metodo DocumentService.ListDocuments.

Campi

documents[]

Gli anni Document.

next_page_token

string

Un token che può essere inviato come ListDocumentsRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListEnginesRequest

Richiesta di messaggio per il metodo EngineService.ListEngines.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa padre, ad esempio `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Facoltativo. Non supportati.
`page_token`	`string` Facoltativo. Non supportati.
`filter`	`string` Facoltativo. Filtra per tipo di soluzione. Ad esempio: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Messaggio di risposta per il metodo EngineService.ListEngines.

Campi

engines[]

Engine

Tutti i Engine del cliente.

next_page_token

string

Non supportati.

ListIdentityMappingStoresRequest

Richiesta di messaggi per IdentityMappingStoreService.ListIdentityMappingStores

Campi

parent

string

Obbligatorio. L'elemento principale degli Identity Mapping Stores da elencare. Formato: projects/{project}/locations/{location}.

page_size

int32

Numero massimo di IdentityMappingStore da restituire. Se non specificato, il valore predefinito è 100. Il valore massimo consentito è 1000. I valori superiori a 1000 verranno forzati a 1000.

page_token

string

Un token di pagina ricevuto da una precedente chiamata ListIdentityMappingStores. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListIdentityMappingStores devono corrispondere alla chiamata che ha fornito il token di pagina.

ListIdentityMappingStoresResponse

Messaggio di risposta per IdentityMappingStoreService.ListIdentityMappingStores

Campi

identity_mapping_stores[]

IdentityMappingStore

I negozi di mappatura delle identità.

next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListIdentityMappingsRequest

Richiesta di messaggi per IdentityMappingStoreService.ListIdentityMappings

Campi

identity_mapping_store

string

Obbligatorio. Il nome dell'archivio di mappatura delle identità in cui elencare le voci di mappatura delle identità. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Numero massimo di IdentityMapping da restituire. Se non specificato, il valore predefinito è 2000. Il valore massimo consentito è 10.000. I valori superiori a 10.000 verranno forzati a 10.000.

page_token

string

Un token di pagina ricevuto da una precedente chiamata ListIdentityMappings. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListIdentityMappings devono corrispondere alla chiamata che ha fornito il token di pagina.

ListIdentityMappingsResponse

Messaggio di risposta per IdentityMappingStoreService.ListIdentityMappings

Campi

identity_mapping_entries[]

IdentityMappingEntry

Le voci di mappatura delle identità.

next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListSchemasRequest

Richiesta di messaggio per il metodo SchemaService.ListSchemas.

Campi

parent

string

Obbligatorio. Il nome della risorsa dell'archivio dati padre, nel formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

Il numero massimo di Schema da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore.

Se non specificato, vengono restituiti al massimo 100 Schema.

Il valore massimo è 1000; i valori superiori a 1000 vengono impostati su 1000.

page_token

string

Un token di pagina ricevuto da una precedente chiamata SchemaService.ListSchemas. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a SchemaService.ListSchemas devono corrispondere alla chiamata che ha fornito il token di pagina.

ListSchemasResponse

Messaggio di risposta per il metodo SchemaService.ListSchemas.

Campi

schemas[]

Schema

Gli anni Schema.

next_page_token

string

Un token che può essere inviato come ListSchemasRequest.page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

ListSessionsRequest

Richiesta per il metodo ListSessions.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa del datastore. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Il numero massimo di risultati da restituire. Se non specificato, il valore predefinito è 50. Il valore massimo consentito è 1000.
`page_token`	`string` Un token di pagina ricevuto da una precedente chiamata `ListSessions`. Forniscilo per recuperare la pagina successiva.
`filter`	`string` Un elenco di campi separato da virgole in base ai quali filtrare, nella grammatica EBNF. I campi supportati sono: `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` Esempi: `user_pseudo_id = some_id` `display_name = "some_name"` `starred = true` `is_pinned=true AND (NOT labels:hidden)` `create_time > "1970-01-01T12:00:00Z"`
`order_by`	`string` Un elenco separato da virgole di campi in base ai quali ordinare, ordinati in ordine crescente. Utilizza "desc" dopo il nome di un campo per l'ordine decrescente. Campi supportati: `update_time` `create_time` `session_name` `is_pinned` Esempio: `update_time desc` `create_time` `is_pinned desc,update_time desc`: elenca le sessioni prima in base a is_pinned, poi in base a update_time.

ListSessionsResponse

Risposta per il metodo ListSessions.

Campi

sessions[]

Tutte le sessioni per un determinato datastore.

next_page_token

string

Token di paginazione. Se non viene restituito, indica l'ultima pagina.

ListTargetSitesRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.ListTargetSites.

Campi

parent

string

Obbligatorio. Il nome della risorsa del motore di ricerca del sito padre, ad esempio projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Se il chiamante non dispone dell'autorizzazione per elencare TargetSite in questo motore di ricerca del sito, indipendentemente dall'esistenza o meno di questo ramo, viene restituito un errore PERMISSION_DENIED.

page_size

int32

Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.

page_token

string

Un token di pagina ricevuto da una precedente chiamata ListTargetSites. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a ListTargetSites devono corrispondere alla chiamata che ha fornito il token di pagina.

ListTargetSitesResponse

Messaggio di risposta per il metodo SiteSearchEngineService.ListTargetSites.

Campi

target_sites[]

Elenco di TargetSites.

next_page_token

string

Un token che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

total_size

int32

Il numero totale di elementi corrispondenti alla richiesta. Questo campo verrà sempre compilato nella risposta.

ListUserLicensesRequest

Richiesta di messaggio per UserLicenseService.ListUserLicenses.

Campi
`parent`	`string` Obbligatorio. Il nome risorsa [UserStore][] principale, formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Facoltativo. Dimensioni della pagina richiesta. Il server potrebbe restituire un numero di elementi inferiore a quello richiesto. Se non specificato, il valore predefinito è 10. Il valore massimo è 50; i valori superiori a 50 verranno forzati a 50. Se questo campo è negativo, viene restituito un errore INVALID_ARGUMENT.
`page_token`	`string` Facoltativo. Un token di pagina ricevuto da una precedente chiamata `ListUserLicenses`. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a `ListUserLicenses` devono corrispondere alla chiamata che ha fornito il token di pagina.
`filter`	`string` Facoltativo. Filtro per la richiesta di elenco. Campi supportati: `license_assignment_state` Esempi: `license_assignment_state = ASSIGNED` per elencare le licenze utente assegnate. `license_assignment_state = NO_LICENSE` per elencare gli utenti senza licenza. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` per elencare gli utenti che hanno tentato di accedere, ma a cui non è stata assegnata alcuna licenza. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` per filtrare gli utenti che hanno tentato di accedere, ma a cui non è stata assegnata alcuna licenza.

ListUserLicensesResponse

Messaggio di risposta per UserLicenseService.ListUserLicenses.

Campi

user_licenses[]

UserLicense

Tutti i UserLicense del cliente.

next_page_token

string

Un token, che può essere inviato come page_token per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

MediaInfo

Informazioni sugli eventi utente specifici per i contenuti multimediali.

Campi

media_progress_duration

Duration

Il tempo di avanzamento dei contenuti multimediali in secondi, se applicabile. Ad esempio, se l'utente finale ha terminato 90 secondi di un video di riproduzione, MediaInfo.media_progress_duration.seconds deve essere impostato su 90.

media_progress_percentage

float

L'avanzamento dei contenuti multimediali deve essere calcolato utilizzando solo media_progress_duration rispetto alla durata totale dei contenuti multimediali.

Questo valore deve essere compreso tra [0, 1.0] inclusi.

Se non si tratta di una riproduzione o se non è possibile calcolare i progressi (ad es. live streaming in corso), questo campo deve essere deselezionato.

PageInfo

Informazioni dettagliate sulla pagina.

Campi
`pageview_id`	`string` Un ID univoco di una visualizzazione di una pagina web. Questo valore deve rimanere invariato per tutti gli eventi utente attivati dalla stessa visualizzazione di pagina. Ad esempio, una visualizzazione della pagina dei dettagli di un elemento potrebbe attivare più eventi mentre l'utente naviga nella pagina. La proprietà `pageview_id` deve rimanere invariata per tutti questi eventi in modo che possano essere raggruppati correttamente. Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente.
`page_category`	`string` La categoria più specifica associata a una pagina di categoria. Per rappresentare il percorso completo della categoria, utilizza il simbolo ">" per separare le diverse gerarchie. Se ">" fa parte del nome della categoria, sostituiscilo con altri caratteri. Le pagine delle categorie includono pagine speciali come vendite o promozioni. Ad esempio, una pagina di vendita speciale potrebbe avere la gerarchia di categorie: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Obbligatorio per gli eventi `view-category-page`. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`uri`	`string` L'URL completo (window.location.href) della pagina corrente dell'utente. Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente. La lunghezza massima è di 5000 caratteri.
`referrer_uri`	`string` L'URL referrer della pagina corrente. Quando utilizzi i report sugli eventi lato client con il pixel JavaScript e Google Tag Manager, questo valore viene compilato automaticamente. Tuttavia, alcune limitazioni della privacy del browser potrebbero causare la visualizzazione di questo campo vuoto.

PanelInfo

Informazioni dettagliate del pannello associate a un evento utente.

Campi
`panel_id`	`string` Obbligatorio. L'ID del riquadro.
`display_name`	`string` Il nome visualizzato del riquadro.
`documents[]`	`DocumentInfo` Facoltativo. Gli ID documento associati a questo riquadro.
`panel_position`	`int32` La posizione ordinata del pannello, se mostrato all'utente insieme ad altri pannelli. Se impostato, deve essere impostato anche `total_panels`.
`total_panels`	`int32` Il numero totale di riquadri, incluso questo, mostrati all'utente. Deve essere impostato se `panel_position` è impostato.

Entità

Identificatore dell'entità di un utente o di un gruppo.

Campi
Campo unione `principal`. Il campo di unione principale. L'entità può essere un utente o un gruppo. `principal` può essere solo uno dei seguenti:
`user_id`	`string` Identificatore utente. Per l'account utente Google Workspace, user_id deve essere l'email dell'utente Google Workspace. Per l'account utente del provider di identità non Google, user_id è l'identificatore utente mappato configurato durante la configurazione di workforcepool.
`group_id`	`string` Identificatore del gruppo. Per l'account utente Google Workspace, group_id deve essere l'email del gruppo Google Workspace. Per l'account utente del provider di identità non Google, group_id è l'identificatore del gruppo mappato configurato durante la configurazione di workforcepool.
`external_entity_id`	`string` Per le identità delle applicazioni di terze parti che non sono presenti nel provider di identità del cliente.

Progetto

Metadati e configurazioni per un progetto Google Cloud nel servizio.

Campi
`name`	`string` Solo output. Nome completo della risorsa del progetto, ad esempio `projects/{project}`. Tieni presente che, quando effettui richieste, sono accettabili sia l'ID progetto sia il numero di progetto, ma il server risponderà sempre con il numero di progetto.
`create_time`	`Timestamp` Solo output. Il timestamp di creazione del progetto.
`provision_completion_time`	`Timestamp` Solo output. Il timestamp in cui viene eseguito il provisioning di questo progetto. Un valore vuoto indica che il progetto è ancora in fase di provisioning e non è pronto per l'uso.
`service_terms_map`	`map<string, ServiceTerms>` Solo output. Una mappa dei termini di servizio. La chiave è `id` di `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Facoltativo. Configurazioni fornite dal cliente.

CustomerProvidedConfig

Configurazioni fornite dal cliente.

Campi

notebooklm_config

NotebooklmConfig

Facoltativo. Configurazione per le impostazioni di NotebookLM.

NotebooklmConfig

Configurazione per NotebookLM.

Campi

model_armor_config

ModelArmorConfig

Configurazione di Model Armor da utilizzare per la sanitizzazione dei prompt degli utenti e delle risposte LLM.

ModelArmorConfig

Configurazione dei modelli Model Armor definiti dal cliente da utilizzare per la sanitizzazione dei prompt degli utenti e delle risposte LLM.

Campi

user_prompt_template

string

Facoltativo. Il nome risorsa del modello Model Armor per la sanificazione dei prompt dell'utente. Formato: projects/{project}/locations/{location}/templates/{template_id}. Se non specificato, non verrà applicata alcuna sanificazione al prompt dell'utente.

response_template

string

Facoltativo. Il nome risorsa del modello Model Armor per la sanitizzazione delle risposte LLM. Formato: projects/{project}/locations/{location}/templates/{template_id}. Se non specificato, alla risposta del modello LLM non verrà applicata alcuna sanificazione.

ServiceTerms

Metadati relativi ai Termini di servizio.

Campi
`id`	`string` L'identificatore univoco di questi Termini di servizio. Termini disponibili: `GA_DATA_USE_TERMS`: Termini per l'utilizzo dei dati. Se utilizzi questo attributo come `id`, il valore `version` accettabile da fornire è `2022-11-23`.
`version`	`string` La stringa della versione dei Termini di servizio. Per i valori accettabili, vedi i commenti per `id` sopra.
`state`	`State` Indica se il progetto ha accettato/rifiutato i termini di servizio o se l'accettazione è ancora in attesa.
`accept_time`	`Timestamp` L'ultima volta in cui il progetto ha accettato i Termini di servizio.
`decline_time`	`Timestamp` L'ultima volta in cui il progetto ha rifiutato o revocato l'accettazione dei Termini di servizio.

Stato

Il contratto stabilisce questi Termini di servizio.

Enum
`STATE_UNSPECIFIED`	Il valore predefinito dell'enum. Questo valore non viene effettivamente utilizzato.
`TERMS_ACCEPTED`	Il progetto ha dato il consenso ai Termini di servizio.
`TERMS_PENDING`	Il progetto è in attesa di revisione e accettazione dei Termini di servizio.
`TERMS_DECLINED`	Il progetto ha rifiutato o revocato l'accettazione dei Termini di servizio.

ProvisionProjectMetadata

Questo tipo non contiene campi.

Metadati associati a un'operazione di provisioning del progetto.

ProvisionProjectRequest

Richiesta per il metodo ProjectService.ProvisionProject.

Campi
`name`	`string` Obbligatorio. Nome completo della risorsa di un `Project`, ad esempio `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Obbligatorio. Imposta su `true` per specificare che il chiamante ha letto e vuole dare il consenso ai Termini per l'utilizzo dei dati.
`data_use_terms_version`	`string` Obbligatorio. La versione dei Termini per l'utilizzo dei dati che il chiamante ha letto e a cui vuole dare il consenso. La versione accettabile è `2022-11-23` e potrebbe cambiare nel tempo.
`saas_params`	`SaasParams` Facoltativo. Parametri per Agentspace.

SaasParams

Parametri per Agentspace.

Campi

accept_biz_qos

bool

Facoltativo. Imposta su true per specificare che il chiamante ha letto e vuole dare il consenso ai [Termini per la qualità del servizio di Agent Space].

is_biz

bool

Facoltativo. Indica se la richiesta corrente riguarda Biz Edition (= true) o meno (= false).

PurgeCompletionSuggestionsMetadata

Metadati relativi all'avanzamento dell'operazione PurgeCompletionSuggestions. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

PurgeCompletionSuggestionsRequest

Richiesta di messaggio per il metodo CompletionService.PurgeCompletionSuggestions.

Campi

parent

string

Obbligatorio. Il nome della risorsa datastore padre per cui eliminare i suggerimenti per il completamento. Segue il pattern projects/*/locations/*/collections/*/dataStores/*.

PurgeCompletionSuggestionsResponse

Messaggio di risposta per il metodo CompletionService.PurgeCompletionSuggestions.

Campi

purge_succeeded

bool

Indica se i suggerimenti per il completamento sono stati eliminati correttamente.

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

PurgeDocumentsMetadata

Metadati relativi all'avanzamento dell'operazione PurgeDocuments. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Conteggio delle voci eliminate correttamente.
`failure_count`	`int64` Conteggio delle voci che hanno riscontrato errori durante l'elaborazione.
`ignored_count`	`int64` Conteggio delle voci ignorate perché non sono state trovate.

PurgeDocumentsRequest

Richiesta di messaggio per il metodo DocumentService.PurgeDocuments.

Campi
`parent`	`string` Obbligatorio. Il nome della risorsa padre, ad esempio `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Obbligatorio. Filtra i documenti corrispondenti da eliminare. L'unico valore attualmente supportato è `*` (tutti gli articoli).
`error_config`	`PurgeErrorConfig` La posizione desiderata degli errori riscontrati durante l'eliminazione.
`force`	`bool` Esegue effettivamente l'eliminazione. Se `force` è impostato su false, restituisci il numero di eliminazioni previsto senza eliminare alcun documento.
Campo unione `source`. L'origine di input desiderata per l'eliminazione dei documenti in base agli ID documento. `source` può essere solo uno dei seguenti:
`gcs_source`	`GcsSource` Il percorso Cloud Storage per i contenuti di input. `data_schema` supportato: * `document_id`: un `Document.id` valido per riga.
`inline_source`	`InlineSource` Origine in linea per i contenuti di input da eliminare.

InlineSource

L'origine in linea per la configurazione dell'input per il metodo DocumentService.PurgeDocuments.

Campi

documents[]

string

Obbligatorio. Un elenco dei nomi completi delle risorse dei documenti da eliminare. Nel formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Consigliamo un massimo di 100 elementi.

PurgeDocumentsResponse

Messaggio di risposta per il metodo DocumentService.PurgeDocuments. Se l'operazione a lunga esecuzione viene completata correttamente, questo messaggio viene restituito dal campo google.longrunning.Operations.response.

Campi

purge_count

int64

Il conteggio totale dei documenti eliminati a seguito dell'operazione.

purge_sample[]

string

Un campione dei nomi dei documenti che verranno eliminati. Compilato solo se force è impostato su false. Verranno restituiti un massimo di 100 nomi, scelti in modo casuale.

PurgeErrorConfig

Configurazione della destinazione per gli errori correlati all'eliminazione.

Campi

Campo unione destination. Obbligatorio. Destinazione degli errori. destination può essere solo uno dei seguenti:

gcs_prefix

string

Prefisso Cloud Storage per gli errori di eliminazione. Deve essere una directory Cloud Storage esistente e vuota. Gli errori di eliminazione vengono scritti in file suddivisi in questa directory, uno per riga, come messaggio google.rpc.Status con codifica JSON.

PurgeIdentityMappingsRequest

Richiesta di messaggi per IdentityMappingStoreService.PurgeIdentityMappings

Campi
`identity_mapping_store`	`string` Obbligatorio. Il nome dell'archivio di mappatura delle identità da cui eliminare le voci di mappatura delle identità. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Filtra le mappature delle identità corrispondenti da eliminare. Il campo idoneo per il filtro è: * `update_time`: in formato ISO 8601 "zulu". * `external_id` Esempi: Eliminazione di tutte le mappature delle identità aggiornate in un intervallo di tempo: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Eliminazione di tutte le mappature delle identità per un determinato external_id: `external_id = "id1"` Eliminazione di tutte le mappature delle identità all'interno di un archivio di mappature delle identità: `*` Si presume che i campi di filtro abbiano un AND implicito. Non deve essere utilizzato con source. Se vengono forniti entrambi, verrà generato un errore.
Campo unione `source`. L'origine dell'input. `source` può essere solo uno dei seguenti:
`inline_source`	`InlineSource` L'origine in linea da cui eliminare le voci di mappatura delle identità.
`force`	`bool` Esegue effettivamente l'eliminazione. Se `force` è impostato su false, restituisci il numero di eliminazioni previsto senza eliminare alcun mapping delle identità. Questo campo è supportato solo per l'eliminazione con filtro. Per l'origine di input, questo campo viene ignorato e i dati vengono eliminati indipendentemente dal valore di questo campo.

InlineSource

L'origine in linea da cui eliminare le voci di mappatura delle identità.

Campi

identity_mapping_entries[]

IdentityMappingEntry

È possibile eliminare un massimo di 10.000 voci alla volta

PurgeSuggestionDenyListEntriesMetadata

Metadati relativi all'avanzamento dell'operazione PurgeSuggestionDenyListEntries. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

PurgeSuggestionDenyListEntriesRequest

Richiesta di messaggio per il metodo CompletionService.PurgeSuggestionDenyListEntries.

Campi

parent

string

Obbligatorio. Il nome della risorsa datastore padre per cui importare le voci della denylist. Segue il pattern projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Messaggio di risposta per il metodo CompletionService.PurgeSuggestionDenyListEntries.

Campi

purge_count

int64

Numero di voci della lista bloccata dei suggerimenti eliminate definitivamente.

error_samples[]

Un campione degli errori riscontrati durante l'elaborazione della richiesta.

PurgeUserEventsMetadata

Metadati relativi all'avanzamento dell'operazione PurgeUserEvents. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`success_count`	`int64` Conteggio delle voci eliminate correttamente.
`failure_count`	`int64` Conteggio delle voci che hanno riscontrato errori durante l'elaborazione.

PurgeUserEventsRequest

Messaggio di richiesta per il metodo PurgeUserEvents.

Campi

parent

string

Obbligatorio. Il nome della risorsa del catalogo in cui vengono creati gli eventi. Il formato è projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

filter

string

Obbligatorio. La stringa di filtro per specificare gli eventi da eliminare con un limite di 5000 caratteri. I campi idonei per il filtro sono:

eventType: stringa UserEvent.event_type tra virgolette doppie.
eventTime: in formato ISO 8601 "zulu".
userPseudoId: stringa tra virgolette doppie. Se specifichi questa opzione, verranno eliminati tutti gli eventi associati a un visitatore.
userId: stringa tra virgolette doppie. Se specifichi questa opzione, vengono eliminati tutti gli eventi associati a un utente.

Nota: questa API supporta solo l'eliminazione di un intervallo massimo di 30 giorni.

Esempi:

Eliminazione di tutti gli eventi in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Eliminazione di un tipo di evento specifico in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Eliminazione di tutti gli eventi per un visitatore specifico in un intervallo di tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Eliminazione degli eventi degli ultimi 30 giorni all'interno di un DataStore: *

Si presume che i campi di filtro abbiano un AND implicito.

force

bool

Il campo force non è attualmente supportato. Le richieste di eliminazione definitiva degli eventi utente elimineranno definitivamente tutti gli eventi eliminabili. Una volta completato lo sviluppo: se force è impostato su false, il metodo restituirà il numero di eliminazioni previsto senza rimuovere alcun evento utente. Se non incluso nella richiesta, questo campo verrà impostato su false per impostazione predefinita.

PurgeUserEventsResponse

Risposta a PurgeUserEventsRequest. Se l'operazione a lunga esecuzione viene completata correttamente, questo messaggio viene restituito dal campo google.longrunning.Operations.response.

Campi

purge_count

int64

Il conteggio totale degli eventi eliminati a seguito dell'operazione.

Query

Definisce una query inserita dall'utente.

Campi

query_id

string

Solo output. ID univoco della query.

Campo unione content. Contenuti della query. content può essere solo uno dei seguenti:

text

string

Testo normale.

RankRequest

Richiesta di messaggio per il metodo RankService.Rank.

Campi
`ranking_config`	`string` Obbligatorio. Il nome risorsa della configurazione del servizio di ranking, ad esempio `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` L'identificatore del modello da utilizzare. È uno dei seguenti: `semantic-ranker-512@latest`: Modello di ranking semantico con dimensione massima del token di input pari a 512. Se non specificato, il valore predefinito è `semantic-ranker-512@latest`.
`top_n`	`int32` Il numero di risultati da restituire. Se questo valore non è impostato o non è maggiore di zero, vengono restituiti tutti i risultati.
`query`	`string` La query da utilizzare.
`records[]`	`RankingRecord` Obbligatorio. Un elenco di record da classificare.
`ignore_record_details_in_response`	`bool` Se true, la risposta conterrà solo l'ID record e il punteggio. Per impostazione predefinita, è false e la risposta conterrà i dettagli del record.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per ulteriori dettagli, consulta il documento Google Cloud.

RankResponse

Messaggio di risposta per il metodo RankService.Rank.

Campi

records[]

RankingRecord

Un elenco di record ordinati per punteggio decrescente.

RankingRecord

Registra un messaggio per il metodo RankService.Rank.

Campi
`id`	`string` L'ID univoco per rappresentare il record.
`title`	`string` Il titolo del disco. Vuoto per impostazione predefinita. È necessario impostare almeno uno tra `title` o `content`, altrimenti viene generato un errore INVALID_ARGUMENT.
`content`	`string` Il contenuto del record. Vuoto per impostazione predefinita. È necessario impostare almeno uno tra `title` o `content`, altrimenti viene generato un errore INVALID_ARGUMENT.
`score`	`float` Il punteggio di questo record in base alla query fornita e al modello selezionato. Il punteggio verrà arrotondato a due cifre decimali. Se il punteggio è vicino a 0, verrà arrotondato a 0,0001 per evitare di restituire il valore non impostato.

RecommendRequest

Messaggio di richiesta per il metodo Recommend.

Campi
`serving_config`	`string` Obbligatorio. Nome completo della risorsa di un `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/` o `projects//locations/global/collections//dataStores//servingConfigs/` Viene creata una configurazione di pubblicazione predefinita insieme al motore per suggerimenti. L'ID motore viene utilizzato come ID della configurazione di pubblicazione predefinita. Ad esempio, per Engine `projects//locations/global/collections//engines/my-engine`, puoi utilizzare `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` per le richieste `RecommendationService.Recommend`.
`user_event`	`UserEvent` Obbligatorio. Contesto dell'utente, di ciò che sta guardando e dell'azione che ha intrapreso per attivare la richiesta di suggerimento. Tieni presente che questo dettaglio dell'evento utente non verrà importato nei log userEvent. Pertanto, per la registrazione degli eventi è necessaria una richiesta di scrittura userEvent separata. Non impostare `UserEvent.user_pseudo_id` o `UserEvent.user_info.user_id` sullo stesso ID fisso per utenti diversi. Se stai cercando di ricevere consigli non personalizzati (non consigliato, in quanto può influire negativamente sul rendimento del modello), imposta `UserEvent.user_pseudo_id` su un ID univoco casuale e lascia `UserEvent.user_info.user_id` non impostato.
`page_size`	`int32` Il numero massimo di risultati da restituire. Imposta questa proprietà sul numero di risultati dei suggerimenti necessari. Se è zero, il servizio sceglie un valore predefinito ragionevole. Il valore massimo consentito è 100. I valori superiori a 100 vengono impostati su 100.
`filter`	`string` Filtro per limitare i risultati dei suggerimenti con un limite di lunghezza di 5000 caratteri. Al momento sono supportate solo le espressioni di filtro sull'attributo `filter_tags`. Esempi: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` Se `attributeFilteringSyntax` è impostato su true nel campo `params`, sono previste espressioni basate sugli attributi anziché la sintassi basata sui tag descritta sopra. Esempi: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) Se il filtro blocca tutti i risultati, l'API restituisce documenti popolari generici (non filtrati). Se vuoi solo risultati che corrispondano esattamente ai filtri, imposta `strictFiltering` su `true` in `RecommendRequest.params` per ricevere risultati vuoti. Tieni presente che l'API non restituisce mai `Document` con `storageStatus` come `EXPIRED` o `DELETED` indipendentemente dalle scelte di filtro.
`validate_only`	`bool` Utilizza la modalità di sola convalida per questa query di suggerimento. Se impostato su `true`, viene utilizzato un modello fittizio che restituisce ID documento arbitrari. Tieni presente che la modalità di sola convalida deve essere utilizzata solo per testare l'API o se il modello non è pronto.
`params`	`map<string, Value>` Parametri aggiuntivi specifici del dominio per i consigli. Valori consentiti: `returnDocument`: booleano. Se impostato su `true`, l'oggetto Documento associato viene restituito in `RecommendResponse.RecommendationResult.document`. `returnScore`: booleano. Se impostato su true, il punteggio di raccomandazione corrispondente a ogni documento restituito viene impostato in `RecommendResponse.RecommendationResult.metadata`. Il punteggio indicato indica la probabilità di conversione di un documento in base al contesto e alla cronologia dell'utente. `strictFiltering`: booleano. Il valore predefinito è true. Se impostato su `false`, il servizio restituisce documenti popolari generici (non filtrati) anziché vuoti se il filtro blocca tutti i risultati dei consigli. `diversityLevel`: stringa. Il valore predefinito è vuoto. Se è impostato su un valore non vuoto, deve essere uno dei seguenti: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` In questo modo, il controllo viene eseguito a livello di richiesta e i risultati dei suggerimenti vengono modificati in base alla categoria del documento. `attributeFilteringSyntax`: booleano. False per impostazione predefinita. Se impostato su true, il campo `filter` viene interpretato in base alla nuova sintassi basata sugli attributi.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per saperne di più, consulta la sezione Requisiti per le etichette.

RecommendResponse

Messaggio di risposta per il metodo Recommend.

Campi
`results[]`	`RecommendationResult` Un elenco di documenti consigliati. L'ordine rappresenta la classificazione (dal documento più pertinente al meno pertinente).
`attribution_token`	`string` Un token di attribuzione univoco. Queste informazioni devono essere incluse nei log `UserEvent` risultanti da questo consiglio, il che consente un'attribuzione accurata del rendimento del modello di consigli.
`missing_ids[]`	`string` ID dei documenti nella richiesta che non erano presenti nel ramo predefinito associato a ServingConfig richiesto.
`validate_only`	`bool` True se `RecommendRequest.validate_only` è stato impostato.

RecommendationResult

RecommendationResult rappresenta un risultato di suggerimento generico con metadati associati.

Campi

id

string

L'ID risorsa del documento consigliato.

document

MatchHighlightingCondition

Impostato se returnDocument è impostato su true in RecommendRequest.params.

metadata

map<string, Value>

Metadati o annotazioni aggiuntivi del documento.

Valori possibili:

score: Punteggio del suggerimento in valore doppio. È impostato se returnScore è impostato su true in RecommendRequest.params.

RecrawlUrisMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.RecrawlUris. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi
`create_time`	`Timestamp` Ora di creazione dell'operazione.
`update_time`	`Timestamp` Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.
`invalid_uris[]`	`string` URI unici nella richiesta con formato non valido. Il campione è limitato a 1000.
`invalid_uris_count`	`int32` Numero totale di URI unici nella richiesta con formato non valido.
`noindex_uris[]`	`string` URI che non hanno meta tag index. Il campione è limitato a 1000.
`noindex_uris_count`	`int32` Il numero totale di URI che non hanno un meta tag index.
`uris_not_matching_target_sites[]`	`string` URI unici nella richiesta che non corrispondono ad alcun TargetSite nel datastore, corrispondono solo a TargetSite che non sono stati completamente indicizzati o corrispondono a un TargetSite di tipo EXCLUDE. Il campione è limitato a 1000.
`uris_not_matching_target_sites_count`	`int32` Numero totale di URI che non corrispondono a nessun TargetSites.
`valid_uris_count`	`int32` Numero totale di URI unici nella richiesta che non si trovano in invalid_uris.
`success_count`	`int32` Numero totale di URI scansionati finora.
`pending_count`	`int32` Numero totale di URI che devono ancora essere sottoposti a scansione.
`quota_exceeded_count`	`int32` Numero totale di URI rifiutati a causa di risorse di indicizzazione insufficienti.

RecrawlUrisRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.RecrawlUris.

Campi

site_search_engine

string

Obbligatorio. Nome completo della risorsa di SiteSearchEngine, ad esempio projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Obbligatorio. Elenco di URI da scansionare. Sono supportati al massimo 10.000 URI, altrimenti viene generato un errore INVALID_ARGUMENT. Ogni URI deve corrispondere ad almeno un TargetSite in site_search_engine.

site_credential

string

Facoltativo. ID credenziali da utilizzare per la scansione.

RecrawlUrisResponse

Messaggio di risposta per il metodo SiteSearchEngineService.RecrawlUris.

Campi

failure_samples[]

FailureInfo

Dettagli per un campione di massimo 10 failed_uris.

failed_uris[]

string

URI di cui non è stato eseguito il crawling prima della chiusura dell'LRO.

FailureInfo

Dettagli sul motivo per cui non è stato possibile eseguire la scansione di un determinato URI. Ogni FailureInfo contiene un FailureReason per CorpusType.

Campi

uri

string

URI di cui non è stato possibile eseguire la scansione.

failure_reasons[]

FailureReason

Elenco dei motivi di errore per tipo di corpus (ad es. computer, dispositivo mobile).

FailureReason

Dettagli sul motivo per cui la scansione non è riuscita per un determinato CorpusType, ad es. La scansione DESKTOP e MOBILE potrebbe non riuscire per motivi diversi.

Campi

corpus_type

CorpusType

DESKTOP, MOBILE o CORPUS_TYPE_UNSPECIFIED.

error_message

string

Motivo per cui l'URI non è stato sottoposto a scansione.

CorpusType

CorpusType per l'operazione di scansione non riuscita.

Enum
`CORPUS_TYPE_UNSPECIFIED`	Valore predefinito.
`DESKTOP`	Indica un tentativo di scansione della versione desktop di una pagina.
`MOBILE`	Indica un tentativo di scansione della versione mobile di una pagina.

Rispondi

Definisce un messaggio di risposta all'utente.

Campi

summary

Summary

Riepilogo basato sui risultati di ricerca.

SafetyRating

Classificazione di sicurezza corrispondente ai contenuti generati.

Campi
`category`	`HarmCategory` Solo output. Categoria del danno.
`probability`	`HarmProbability` Solo output. Livelli di probabilità di danni nei contenuti.
`probability_score`	`float` Solo output. Punteggio di probabilità di danni.
`severity`	`HarmSeverity` Solo output. Livelli di gravità del danno nei contenuti.
`severity_score`	`float` Solo output. Punteggio di gravità del danno.
`blocked`	`bool` Solo output. Indica se i contenuti sono stati filtrati a causa di questa classificazione.

HarmProbability

Livelli di probabilità di danni nei contenuti.

Enum
`HARM_PROBABILITY_UNSPECIFIED`	Probabilità di danni non specificata.
`NEGLIGIBLE`	Livello di danno trascurabile.
`LOW`	Basso livello di danno.
`MEDIUM`	Danno di impatto medio.
`HIGH`	Alto livello di danno.

HarmSeverity

Livelli di gravità del danno.

Enum
`HARM_SEVERITY_UNSPECIFIED`	Gravità del danno non specificata.
`HARM_SEVERITY_NEGLIGIBLE`	Livello di gravità del danno trascurabile.
`HARM_SEVERITY_LOW`	Basso livello di gravità del danno.
`HARM_SEVERITY_MEDIUM`	Livello medio di gravità del danno.
`HARM_SEVERITY_HIGH`	Elevato livello di gravità del danno.

Schema

Definisce la struttura e il layout di un tipo di dati del documento.

Campi
`name`	`string` Immutabile. Il nome completo della risorsa dello schema, nel formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
Campo unione `schema`. Rappresentazione dello schema. È necessario fornire `struct_schema` o `json_schema`, altrimenti viene generato un errore `INVALID_ARGUMENT`. `schema` può essere solo uno dei seguenti:
`struct_schema`	`Struct` La rappresentazione strutturata dello schema.
`json_schema`	`string` La rappresentazione JSON dello schema.

SearchAddOn

Componente aggiuntivo che fornisce funzionalità aggiuntive per la ricerca.

Enum
`SEARCH_ADD_ON_UNSPECIFIED`	Valore predefinito quando l'enumerazione non è specificata. Questo valore non è valido.
`SEARCH_ADD_ON_LLM`	Componente aggiuntivo del modello linguistico di grandi dimensioni.

SearchInfo

Informazioni dettagliate sulla ricerca.

Campi

search_query

string

La query di ricerca dell'utente.

Per la definizione, vedi SearchRequest.query.

Il valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 5000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

È obbligatorio specificare almeno un valore per search_query o PageInfo.page_category per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

order_by

string

L'ordine in cui vengono restituiti i prodotti, se applicabile.

Consulta SearchRequest.order_by per la definizione e la sintassi.

Il valore deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1000 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Può essere impostato solo per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

offset

int32

Un numero intero che specifica l'offset corrente per la paginazione (la posizione iniziale con indice 0 tra i prodotti ritenuti pertinenti dall'API).

Per la definizione, vedi SearchRequest.offset.

Se questo campo è negativo, viene restituito un INVALID_ARGUMENT.

Può essere impostato solo per gli eventi search. Gli altri tipi di eventi non devono impostare questo campo. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

SearchLinkPromotion

Il proto della promozione include l'URI e altre informazioni utili per visualizzare la promozione.

Campi
`title`	`string` Obbligatorio. Il titolo della promozione. Lunghezza massima: 160 caratteri.
`uri`	`string` Facoltativo. L'URL della pagina che l'utente vuole promuovere. Deve essere impostato per la ricerca sul sito. Per gli altri verticali, questo parametro è facoltativo.
`document`	`string` Facoltativo. Il `Document` che l'utente vuole promuovere. Per la ricerca sul sito, lascia il campo vuoto e compila solo l'URI. Può essere impostato insieme all'URI.
`image_uri`	`string` Facoltativo. L'URL dell'immagine in miniatura della promozione.
`description`	`string` Facoltativo. La descrizione della promozione. Lunghezza massima: 200 caratteri.
`enabled`	`bool` Facoltativo. La promozione attivata verrà restituita per tutte le configurazioni di pubblicazione associate all'elemento principale del controllo a cui è allegata questa promozione. Questo flag viene utilizzato solo per la ricerca di base su sito.

SearchRequest

Richiesta di messaggio per il metodo SearchService.Search.

Campi
`serving_config`	`string` Obbligatorio. Il nome risorsa della configurazione di pubblicazione della ricerca, ad esempio `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` o `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. Questo campo viene utilizzato per identificare il nome della configurazione di pubblicazione, l'insieme di modelli utilizzati per eseguire la ricerca.
`branch`	`string` Il nome della risorsa del ramo, ad esempio `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Utilizza `default_branch` come ID ramo o lascia vuoto questo campo per cercare documenti nel ramo predefinito.
`query`	`string` Query di ricerca non elaborata.
`image_query`	`ImageQuery` Query di immagini RAW.
`page_size`	`int32` Il numero massimo di `Document` da restituire. Il valore massimo consentito dipende dal tipo di dati. I valori superiori al valore massimo vengono forzati al valore massimo. Siti web con indicizzazione di base: Predefinito `10`, Massimo `25`. Siti web con indicizzazione avanzata: Predefinita `25`, Massima `50`. Altro: predefinito `50`, massimo `100`. Se questo campo è negativo, viene restituito un `INVALID_ARGUMENT`.
`page_token`	`string` Un token di pagina ricevuto da una precedente chiamata `SearchService.Search`. Forniscilo per recuperare la pagina successiva. Durante la paginazione, tutti gli altri parametri forniti a `SearchService.Search` devono corrispondere alla chiamata che ha fornito il token di pagina. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`offset`	`int32` Un numero intero con indice 0 che specifica l'offset corrente (ovvero la posizione del risultato iniziale tra i `Document` considerati pertinenti dall'API) nei risultati di ricerca. Questo campo viene preso in considerazione solo se `page_token` non è impostato. Se questo campo è negativo, viene restituito un `INVALID_ARGUMENT`. Un offset elevato potrebbe essere limitato a una soglia ragionevole.
`one_box_page_size`	`int32` Il numero massimo di risultati da restituire per OneBox. Questo si applica a ogni tipo di OneBox singolarmente. Il numero predefinito è 10.
`data_store_specs[]`	`DataStoreSpec` Specifiche che definiscono i `DataStore` specifici da cercare, insieme alle configurazioni per questi datastore. Questo aspetto viene preso in considerazione solo per i `Engine` con più datastore. Per i motori con un unico datastore, devono essere utilizzate le specifiche direttamente sotto `SearchRequest`.
`filter`	`string` La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti da filtrare. L'espressione del filtro è sensibile alle maiuscole. Se questo campo non è riconoscibile, viene restituito un `INVALID_ARGUMENT`. Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente del settore dei media potrebbe avere un campo "nome" nel proprio schema. In questo caso, il filtro sarà simile a questo: filter --> name:'ANY("king kong")' Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.
`canonical_filter`	`string` Il filtro predefinito applicato quando un utente esegue una ricerca senza selezionare alcun filtro nella pagina di ricerca. Il filtro applicato a ogni richiesta di ricerca quando è necessario un miglioramento della qualità, ad esempio l'espansione della query. Nel caso in cui una query non abbia un numero sufficiente di risultati, questo filtro verrà utilizzato per determinare se attivare o meno il flusso di espansione della query. Il filtro originale verrà comunque utilizzato per la ricerca con query estesa. Questo campo è vivamente consigliato per ottenere una qualità di ricerca elevata. Per ulteriori informazioni sulla sintassi dei filtri, consulta `SearchRequest.filter`.
`order_by`	`string` L'ordine in cui vengono restituiti i documenti. I documenti possono essere ordinati in base a un campo in un oggetto `Document`. Lascia il campo vuoto se l'ordine è per pertinenza. L'espressione `order_by` è sensibile alle maiuscole. Per saperne di più sull'ordinamento dei risultati di ricerca sul sito web, vedi Ordinare i risultati di ricerca sul web. Per saperne di più sull'ordinamento dei risultati di ricerca relativi all'assistenza sanitaria, consulta Ordinare i risultati di ricerca relativi all'assistenza sanitaria. Se questo campo non è riconoscibile, viene restituito un `INVALID_ARGUMENT`.
`user_info`	`UserInfo` Informazioni sull'utente finale. Consigliato vivamente per l'analisi e la personalizzazione. `UserInfo.user_agent` viene utilizzato per dedurre `device_type` per l'analisi.
`language_code`	`string` Il codice lingua BCP-47, ad esempio "en-US" o "sr-Latn". Per ulteriori informazioni, vedi Campi standard. Questo campo aiuta a interpretare meglio la query. Se non viene specificato un valore, il codice della lingua della query viene rilevato automaticamente, ma potrebbe non essere preciso.
`facet_specs[]`	`FacetSpec` Specifiche dei facet per la ricerca con facet. Se è vuoto, non vengono restituite sfaccettature. Sono consentiti massimo 100 valori. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`boost_spec`	`BoostSpec` Aumenta la specifica per aumentare la visibilità di determinati documenti. Per ulteriori informazioni sul boosting, consulta la sezione Boosting.
`params`	`map<string, Value>` Parametri di ricerca aggiuntivi. Solo per la ricerca di siti web pubblici, i valori supportati sono: `user_country_code`: stringa. Il valore predefinito è vuoto. Se impostato su un valore non vuoto, i risultati vengono limitati o migliorati in base alla località fornita. Ad esempio, `user_country_code: "au"` Per i codici disponibili, consulta Codici paese. `search_type`: doppio. Il valore predefinito è vuoto. Consente la ricerca di elementi diversi dalle pagine web a seconda del valore. L'unico valore non predefinito valido è 1, che attiva la ricerca di immagini. Ad esempio, `search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` La specifica di espansione delle query che specifica le condizioni in cui si verifica l'espansione delle query.
`spell_correction_spec`	`SpellCorrectionSpec` La specifica di correzione ortografica che specifica la modalità in cui la correzione ortografica ha effetto.
`user_pseudo_id`	`string` Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione può essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore accede o esce dal sito web. Questo campo NON deve avere un valore fisso come `unknown_visitor`. Deve essere lo stesso identificatore di `UserEvent.user_pseudo_id` e `CompleteQueryRequest.user_pseudo_id` Il campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore `INVALID_ARGUMENT`.
`content_search_spec`	`ContentSearchSpec` Una specifica per la configurazione del comportamento della ricerca dei contenuti.
`ranking_expression`	`string` Facoltativo. L'espressione di ranking controlla il ranking personalizzato dei documenti recuperati. Questa azione sostituisce `ServingConfig.ranking_expression`. La sintassi e le funzionalità supportate dipendono dal valore di `ranking_expression_backend`. Se `ranking_expression_backend` non viene fornito, il valore predefinito è `RANK_BY_EMBEDDING`. Se `ranking_expression_backend` non viene fornito o è impostato su `RANK_BY_EMBEDDING`, deve essere una singola funzione o più funzioni unite dal segno "+". ranking_expression = function, { " + ", function }; Funzioni supportate: double * relevance_score double * dotProduct(embedding_field_path) Variabili della funzione: `relevance_score`: parole chiave predefinite, utilizzate per misurare la pertinenza tra query e documento. `embedding_field_path`: il campo di incorporamento del documento utilizzato con il vettore di incorporamento della query. `dotProduct`: funzione di embedding tra `embedding_field_path` e il vettore di embedding della query. Espressione di ranking di esempio: Se il documento ha un campo di incorporamento doc_embedding, l'espressione di ranking potrebbe essere `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. Se `ranking_expression_backend` è impostato su `RANK_BY_FORMULA`, sono supportati i seguenti tipi di espressioni (e le combinazioni di questi concatenati utilizzando gli operatori + o ): `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)`: trasformazione del rango reciproco con il secondo argomento che è una costante del denominatore. `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. `fill_nan(signal1, signal2 \| double)` -- if signal1 is NaN, returns signal2 \| double, else returns signal1. Ecco alcuni esempi di formule di ranking che utilizzano i tipi di espressioni di ranking supportati: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`: classifica in base all'esponente di `semantic_similarity_score`, riempiendo il valore con 0 se è NaN.Aggiungi anche la costante 0,3 al punteggio finale se `semantic_similarity_score` è NaN. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`: per lo più classifica in base al rango reciproco di `keyword_similarity_score` con un leggero aggiustamento del rango reciproco di `semantic_smilarity_score`. Sono supportati i seguenti indicatori: `semantic_similarity_score`: aggiustamento della similarità semantica calcolato utilizzando gli incorporamenti generati da un modello proprietario di Google. Questo punteggio determina la somiglianza semantica di una query di ricerca con un documento. `keyword_similarity_score`: l'aggiustamento della corrispondenza delle parole chiave utilizza la funzione di ranking Best Match 25 (BM25). Questo punteggio viene calcolato utilizzando un modello probabilistico per stimare la probabilità che un documento sia pertinente a una determinata query. `relevance_score`: aggiustamento della pertinenza semantica che utilizza un modello proprietario di Google per determinare il significato e l'intento alla base della query di un utente nel contesto dei contenuti dei documenti. `pctr_rank`: aggiustamento del tasso di conversione previsto come utilizzo del ranking. La percentuale di clic prevista (pCTR) viene utilizzata per valutare la pertinenza e l'attrattività di un risultato di ricerca dal punto di vista dell'utente. Un pCTR più elevato suggerisce che il risultato ha maggiori probabilità di soddisfare la query e l'intenzione dell'utente, il che lo rende un indicatore prezioso per il ranking. `freshness_rank`: aggiustamento dell'aggiornamento come ranking `document_age`: Il tempo in ore trascorso dall'ultimo aggiornamento del documento, un numero in virgola mobile (ad es. 0,25 significa 15 minuti). `topicality_rank`: aggiustamento della topicalità come ranking. Utilizza il modello proprietario di Google per determinare la sovrapposizione basata sulle parole chiave tra la query e il documento. `base_rank`: il ranking predefinito del risultato
`ranking_expression_backend`	`RankingExpressionBackend` Facoltativo. Il backend da utilizzare per la valutazione dell'espressione di ranking.
`safe_search`	`bool` Se attivare SafeSearch. Questa funzionalità è supportata solo per la ricerca sui siti web.
`user_labels`	`map<string, string>` Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti: Ogni risorsa può avere più etichette, fino a un massimo di 64. Ogni etichetta deve essere una coppia chiave-valore. Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale. Per ulteriori dettagli, consulta il documento Google Cloud.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Facoltativo. Configurazione per le funzionalità di comprensione delle query in linguaggio naturale, ad esempio l'estrazione di filtri di campi strutturati dalla query. Per ulteriori informazioni, consulta questa documentazione. Se `naturalLanguageQueryUnderstandingSpec` non è specificato, non verrà eseguita alcuna comprensione aggiuntiva delle query in linguaggio naturale.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Configurazione della ricerca durante la digitazione. Supportato solo per la verticale `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Facoltativo. Configurazione per la funzionalità di visualizzazione, ad esempio l'evidenziazione delle corrispondenze nei risultati di ricerca.
`session`	`string` Il nome della risorsa della sessione. Facoltativo. La sessione consente agli utenti di effettuare chiamate API multi-turn /search o il coordinamento tra chiamate API /search e chiamate API /answer. Esempio 1 (chiamate API multi-turn /search): chiama l'API /search con l'ID sessione generato nella prima chiamata. In questo caso, la query di ricerca precedente viene presa in considerazione nella posizione della query. Ad esempio, se la prima query è "Come è andata Alphabet nel 2022?" e la query attuale è "E il 2023?", la query attuale verrà interpretata come "Come è andata ad Alphabet nel 2023?". Esempio n. 2 (coordinamento tra chiamate API /search e chiamate API /answer): chiama l'API /answer con l'ID sessione generato nella prima chiamata. In questo caso, la generazione della risposta avviene nel contesto dei risultati di ricerca della prima chiamata di ricerca. 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.
`session_spec`	`SessionSpec` Specifica della sessione. Può essere utilizzato solo quando è impostato `session`.
`relevance_threshold`	`RelevanceThreshold` La soglia di pertinenza dei risultati di ricerca. Utilizza la soglia definita da Google, sfruttando un equilibrio tra precisione e richiamo per fornire risultati altamente accurati e una copertura completa delle informazioni pertinenti. Questa funzionalità non è supportata per la ricerca di servizi sanitari.
`relevance_score_spec`	`RelevanceScoreSpec` Facoltativo. La specifica per la restituzione del punteggio di pertinenza.

BoostSpec

Aumenta la specifica per aumentare la visibilità di determinati documenti.

Campi

condition_boost_specs[]

ConditionBoostSpec

Specifiche del potenziamento della condizione. Se un documento corrisponde a più condizioni nelle specifiche, i punteggi di boost di queste specifiche vengono tutti applicati e combinati in modo non lineare. Il numero massimo di specifiche è 20.

ConditionBoostSpec

Il boost si applica ai documenti che corrispondono a una condizione.

Campi

condition

string

Un'espressione che specifica una condizione di aumento. La sintassi e i campi supportati sono gli stessi di un'espressione di filtro. Per la sintassi e le limitazioni dettagliate, consulta la pagina SearchRequest.filter.

Esempi:

Per aumentare il ranking dei documenti con ID documento "doc_1" o "doc_2" e colore "Rosso" o "Blu": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Intensità del boosting della condizione, che deve essere compresa tra -1 e 1. Un boosting negativo indica una retrocessione. Il valore predefinito è 0.0.

Se il boosting viene impostato su 1.0, il documento viene promosso maggiormente. Tuttavia, non significa necessariamente che il documento con boosting sarà sempre il risultato in cima alla prima pagina né che gli altri documenti verranno esclusi. Potrebbero essere visualizzati comunque dei risultati anche se nessun articolo corrisponde alla condizione. Inoltre, i risultati molto più pertinenti alla query di ricerca possono comunque avere la precedenza sui tuoi documenti nettamente preferiti, ma non pertinenti.

Se il valore viene impostato su -1.0, il documento viene declassato in modo significativo. Tuttavia, potrebbero comunque essere mostrati risultati molto pertinenti. Il documento dovrà affrontare una battaglia upstream per ottenere un ranking piuttosto elevato, ma non è completamente bloccato.

Se il valore è impostato su 0,0, non viene applicato alcun boost. La condizione di incremento viene ignorata. È impostata solo una delle combinazioni (condizione, boost) o la specifica boost_control_spec riportata di seguito. Se entrambi sono impostati, il boost globale viene ignorato e viene applicata la specifica più granulare boost_control_spec.

boost_control_spec

BoostControlSpec

Specifica complessa per il ranking personalizzato in base al valore dell'attributo definito dal cliente.

BoostControlSpec

Campi
`field_name`	`string` Il nome del campo il cui valore verrà utilizzato per determinare l'importo dell'aggiustamento.
`attribute_type`	`AttributeType` Il tipo di attributo da utilizzare per determinare l'importo del boost. Il valore dell'attributo può essere derivato dal valore del campo field_name specificato. Nel caso di valori numerici, è semplice, ad esempio attribute_value = numerical_field_value. Nel caso della freschezza, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Il tipo di interpolazione da applicare per collegare i punti di controllo elencati di seguito.
`control_points[]`	`ControlPoint` I punti di controllo utilizzati per definire la curva. La funzione monotona (definita tramite interpolation_type sopra) passa attraverso i punti di controllo elencati qui.

AttributeType

L'attributo(o la funzione) a cui deve essere applicato il ranking personalizzato.

Enum
`ATTRIBUTE_TYPE_UNSPECIFIED`	Tipo di attributo non specificato.
`NUMERICAL`	Il valore del campo numerico verrà utilizzato per aggiornare dinamicamente l'importo dell'incremento. In questo caso, attribute_value (il valore x) del punto di controllo sarà il valore effettivo del campo numerico per cui è specificato boost_amount.
`FRESHNESS`	Per il caso d'uso della freschezza, il valore dell'attributo sarà la durata tra l'ora corrente e la data nel campo datetime specificato. Il valore deve essere formattato come valore XSD `dayTimeDuration` (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: `[nD][T[nH][nM][nS]]`. Ad esempio, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Campi

attribute_value

string

Può corrispondere a uno dei seguenti: 1. Il valore del campo numerico. 2. Specifica della durata per l'aggiornamento: il valore deve essere formattato come valore XSD dayTimeDuration (un sottoinsieme limitato di un valore di durata ISO 8601). Il pattern è: [nD][T[nH][nM][nS]].

boost_amount

float

Il valore compreso tra -1 e 1 in base al quale aumentare il punteggio se attribute_value restituisce il valore specificato sopra.

InterpolationType

Il tipo di interpolazione da applicare. Il valore predefinito sarà lineare (lineare a tratti).

Enum
`INTERPOLATION_TYPE_UNSPECIFIED`	Il tipo di interpolazione non è specificato. In questo caso, il valore predefinito è Lineare.
`LINEAR`	Verrà applicata l'interpolazione lineare a tratti.

ContentSearchSpec

Una specifica per la configurazione del comportamento della ricerca dei contenuti.

Campi
`snippet_spec`	`SnippetSpec` Se `snippetSpec` non è specificato, gli snippet non vengono inclusi nella risposta della ricerca.
`summary_spec`	`SummarySpec` Se `summarySpec` non è specificato, i riepiloghi non vengono inclusi nella risposta della ricerca.
`extractive_content_spec`	`ExtractiveContentSpec` Se non viene fornita alcuna specifica extractive_content_spec, nella risposta di ricerca non sarà presente alcuna risposta estrattiva.
`search_result_mode`	`SearchResultMode` Specifica la modalità dei risultati di ricerca. Se non specificata, la modalità dei risultati di ricerca è impostata su `DOCUMENTS` per impostazione predefinita.
`chunk_spec`	`ChunkSpec` Specifica la specifica del blocco da restituire dalla risposta di ricerca. Disponibile solo se `SearchRequest.ContentSearchSpec.search_result_mode` è impostato su `CHUNKS`

ChunkSpec

Specifica la specifica del blocco da restituire dalla risposta di ricerca. Disponibile solo se SearchRequest.ContentSearchSpec.search_result_mode è impostato su CHUNKS

Campi

num_previous_chunks

int32

Il numero di chunk precedenti da restituire del chunk corrente. Il valore massimo consentito è 3. Se non specificato, non verranno restituiti chunk precedenti.

num_next_chunks

int32

Il numero di blocchi successivi da restituire del blocco corrente. Il valore massimo consentito è 3. Se non specificato, non verranno restituiti chunk successivi.

ExtractiveContentSpec

Una specifica per la configurazione dei contenuti estrattivi in una risposta di ricerca.

Campi
`max_extractive_answer_count`	`int32` Il numero massimo di risposte estrattive restituite in ogni risultato di ricerca. Una risposta estrattiva è una risposta letterale estratta dal documento originale, che fornisce una risposta precisa e pertinente al contesto della query di ricerca. Se il numero di risposte corrispondenti è inferiore a `max_extractive_answer_count`, restituisci tutte le risposte. In caso contrario, restituisci `max_extractive_answer_count`. Per ogni `SearchResult` vengono restituite al massimo cinque risposte.
`max_extractive_segment_count`	`int32` Il numero massimo di segmenti estrattivi restituiti in ogni risultato di ricerca. Viene applicato solo se `DataStore` è impostato su `DataStore.ContentConfig.CONTENT_REQUIRED` o `DataStore.solution_types` è `SOLUTION_TYPE_CHAT`. Un segmento estrattivo è un segmento di testo estratto dal documento originale pertinente alla query di ricerca e, in generale, più dettagliato di una risposta estrattiva. Il segmento potrebbe quindi essere utilizzato come input per gli LLM per generare riepiloghi e risposte. Se il numero di segmenti corrispondenti è inferiore a `max_extractive_segment_count`, restituisci tutti i segmenti. In caso contrario, restituisci `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Specifica se restituire il punteggio di affidabilità dai segmenti estrattivi in ogni risultato di ricerca. Questa funzionalità è disponibile solo per i datastore nuovi o inseriti nella lista consentita. Per inserire il tuo datastore nella lista consentita, contatta il tuo Customer Engineer. Il valore predefinito è `false`.
`num_previous_segments`	`int32` Specifica se includere anche gli adiacenti di ciascuno dei segmenti selezionati. Restituisci al massimo `num_previous_segments` segmenti prima di ogni segmento selezionato.
`num_next_segments`	`int32` Restituisci al massimo `num_next_segments` segmenti dopo ogni segmento selezionato.

SearchResultMode

Specifica la modalità dei risultati di ricerca. Se non specificata, la modalità dei risultati di ricerca è impostata su DOCUMENTS per impostazione predefinita.

Enum
`SEARCH_RESULT_MODE_UNSPECIFIED`	Valore predefinito.
`DOCUMENTS`	Restituisce i documenti nel risultato di ricerca.
`CHUNKS`	Restituisce i segmenti nel risultato di ricerca. Disponibile solo se è specificato `DocumentProcessingConfig.chunking_config`.

SnippetSpec

Una specifica per la configurazione degli snippet in una risposta della ricerca.

Campi

max_snippet_count
(deprecated)

int32

[OBSOLETO] Questo campo è obsoleto. Per controllare la restituzione degli snippet, utilizza il campo return_snippet. Per la compatibilità con le versioni precedenti, restituiremo lo snippet se max_snippet_count > 0.

reference_only
(deprecated)

bool

[DEPRECATO] Questo campo è deprecato e non avrà alcun effetto sullo snippet.

return_snippet

bool

Se true, restituisci lo snippet. Se non è possibile generare uno snippet, viene restituito il messaggio "Nessuno snippet disponibile per questa pagina". Verrà restituito anche un snippet_status con SUCCESS o NO_SNIPPET_AVAILABLE.

SummarySpec

Una specifica per la configurazione di un riepilogo restituito in una risposta di ricerca.

Campi
`summary_result_count`	`int32` Il numero di primi risultati da cui generare il riepilogo. Se il numero di risultati restituiti è inferiore a `summaryResultCount`, il riepilogo viene generato da tutti i risultati. Per generare un riepilogo, è possibile utilizzare al massimo 10 risultati per la modalità Documenti o 50 per la modalità Chunk. La modalità Chunks viene utilizzata quando `SearchRequest.ContentSearchSpec.search_result_mode` è impostato su `CHUNKS`.
`include_citations`	`bool` Specifica se includere le citazioni nel riepilogo. Il valore predefinito è `false`. Quando questo campo è impostato su `true`, i riepiloghi includono i numeri delle citazioni in linea. Esempio di riepilogo con citazioni: BigQuery è il data warehouse aziendale completamente gestito e serverless di Google Cloud [1]. BigQuery supporta tutti i tipi di dati, funziona su cloud diversi ed è dotato di business intelligence e machine learning integrati, il tutto all'interno di una piattaforma unificata [2, 3]. I numeri delle citazioni si riferiscono ai risultati di ricerca restituiti e sono indicizzati a partire da 1. Ad esempio, [1] significa che la frase è attribuita al primo risultato di ricerca. [2, 3] significa che la frase è attribuita sia al secondo che al terzo risultato di ricerca.
`ignore_adversarial_query`	`bool` Specifica se filtrare le query contraddittorie. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query ostili. Non viene restituito alcun riepilogo se la query di ricerca viene classificata come query ostile. Ad esempio, un utente potrebbe porre una domanda relativa a commenti negativi sull'azienda o inviare una query progettata per generare output non sicuri che violano le norme. Se questo campo è impostato su `true`, non generiamo riepiloghi per le query avversative e restituiamo invece messaggi di riserva.
`ignore_non_summary_seeking_query`	`bool` Specifica se filtrare le query che non cercano riepiloghi. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query che cercano riepiloghi. Non viene restituito alcun riepilogo se la query di ricerca viene classificata come query che non richiede un riepilogo. Ad esempio, `why is the sky blue` e `Who is the best soccer player in the world?` sono query che cercano riassunti, mentre `SFO airport` e `world cup 2026` non lo sono. Si tratta molto probabilmente di query di navigazione. Se questo campo è impostato su `true`, saltiamo la generazione di riepiloghi per le query che non cercano riepiloghi e restituiamo invece messaggi di riserva.
`ignore_low_relevant_content`	`bool` Specifica se filtrare le query con scarsa pertinenza. Il valore predefinito è `false`. Se questo campo è impostato su `false`, vengono utilizzati tutti i risultati di ricerca, indipendentemente dalla pertinenza, per generare le risposte. Se impostato su `true`, solo le query con risultati di ricerca di pertinenza elevata genereranno risposte.
`ignore_jail_breaking_query`	`bool` Facoltativo. Specifica se filtrare le query di jailbreaking. Il valore predefinito è `false`. Google utilizza la classificazione delle query di ricerca per rilevare le query di jailbreaking. Non viene restituito alcun riepilogo se la query di ricerca viene classificata come query di evasione. Un utente potrebbe aggiungere istruzioni alla query per modificare il tono, lo stile, la lingua, il contenuto della risposta o chiedere al modello di agire come un'entità diversa, ad esempio "Rispondi con il tono del CEO di un'azienda concorrente". Se questo campo è impostato su `true`, saltiamo la generazione di riepiloghi per le query di jailbreaking e restituiamo invece messaggi di riserva.
`model_prompt_spec`	`ModelPromptSpec` Se specificata, la specifica verrà utilizzata per modificare il prompt fornito all'LLM.
`language_code`	`string` Codice lingua per il riepilogo. Utilizza i tag di lingua definiti da BCP47. Nota: questa è una funzionalità sperimentale.
`model_spec`	`ModelSpec` Se specificata, la specifica verrà utilizzata per modificare la specifica del modello fornita all'LLM.
`use_semantic_chunks`	`bool` Se è true, la risposta verrà generata dai chunk più pertinenti dei primi risultati di ricerca. Questa funzionalità migliorerà la qualità dei riassunti. Tieni presente che, con questa funzionalità attivata, non tutti i primi risultati di ricerca verranno citati e inclusi nell'elenco delle citazioni, pertanto l'indice delle fonti delle citazioni punta solo ai risultati di ricerca elencati nell'elenco delle citazioni.

ModelPromptSpec

Specifica del prompt da utilizzare con il modello.

Campi

preamble

string

Testo all'inizio del prompt che fornisce istruzioni all'assistente. Gli esempi sono disponibili nella guida dell'utente.

ModelSpec

Specifica del modello.

Campi

version

string

La versione del modello utilizzata per generare il riepilogo.

I valori supportati sono:

stable: stringa. Valore predefinito quando non viene specificato alcun valore. Utilizza un modello ottimizzato disponibile a livello generale. Per maggiori informazioni, consulta Versioni e ciclo di vita del modello di generazione delle risposte.
preview: stringa. (Anteprima pubblica) Utilizza un modello di anteprima. Per maggiori informazioni, consulta Versioni e ciclo di vita del modello di generazione delle risposte.

DataStoreSpec

Una struttura per definire i datastore su cui filtrare in una chiamata di ricerca e le configurazioni per questi datastore. In caso contrario, viene restituito un errore INVALID_ARGUMENT.

Campi
`data_store`	`string` Obbligatorio. Nome completo della risorsa di `DataStore`, ad esempio `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Il percorso deve includere il numero di progetto. L'ID progetto non è supportato per questo campo.
`filter`	`string` Facoltativo. Specifica del filtro per filtrare i documenti nel datastore specificato dal campo data_store. Per saperne di più sul filtraggio, consulta Filtro.
`boost_spec`	`BoostSpec` Facoltativo. Aumenta la specifica per aumentare la visibilità di determinati documenti. Per ulteriori informazioni sul boosting, consulta la sezione Boosting.
`custom_search_operators`	`string` Facoltativo. Operatori di ricerca personalizzati che, se specificati, verranno utilizzati per filtrare i risultati dai datastore di workspace. Per ulteriori informazioni sugli operatori di ricerca personalizzati, consulta SearchOperators.

DisplaySpec

Specifica le funzionalità di visualizzazione, come l'evidenziazione delle corrispondenze.

Campi

match_highlighting_condition

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.

FacetSpec

Una specifica del facet per eseguire la ricerca con facet.

Campi
`facet_key`	`FacetKey` Obbligatorio. La specifica della chiave facet.
`limit`	`int32` 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 `INVALID_ARGUMENT`.
`excluded_filter_keys[]`	`string` Elenco delle chiavi da escludere durante la creazione di sfaccettature. Per impostazione predefinita, `FacetKey.key` non viene escluso dal filtro, a meno che non sia elencato in questo campo. 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 `FacetKey.key` restituirebbe per impostazione predefinita solo i documenti "Red" nei risultati di ricerca e restituirebbe anche "Red" con conteggio 100 come unico facet di colore. Sebbene siano disponibili anche documenti blu, "Blu" non verrà visualizzato come valore di sfaccettatura disponibile. 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 `INVALID_ARGUMENT`.
`enable_dynamic_position`	`bool` 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 enable_dynamic_position 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: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false Inoltre, hai attivato i facet dinamici, che generano un facet `gender`. L'ordine finale delle sfaccettature nella risposta può essere ("price", "brands", "rating", "gender") o ("price", "brands", "gender", "rating") a seconda di come l'API ordina le sfaccettature "gender" e "rating". Tuttavia, nota che "price" e "brands" sono sempre classificati in prima e seconda posizione perché enable_dynamic_position è impostato su false.

FacetKey

Specifica come viene calcolata una sfaccettatura.

Campi
`key`	`string` Obbligatorio. Chiavi di sfaccettatura testuali e numeriche supportate nell'oggetto `Document`, in base alle quali vengono calcolati i valori delle sfaccettature. La chiave del facet è sensibile alle maiuscole.
`intervals[]`	`Interval` 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.
`restricted_values[]`	`string` 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 "restricted_values" su "Azione > 2022", la sfaccettatura "category" contiene solo "Azione > 2022". Supportato solo sui campi di testo. Il valore massimo è 10.
`prefixes[]`	`string` 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[]`	`string` 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.
`case_insensitive`	`bool` 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.
`order_by`	`string` L'ordine in cui vengono restituiti i documenti. I valori consentiti sono: "count desc", che significa ordinare per `SearchResponse.Facet.values.count` in ordine decrescente. "value desc", che significa ordinare per `SearchResponse.Facet.values.value` in ordine decrescente. Si applica solo alle sfaccettature testuali. Se non viene impostato, i valori testuali vengono ordinati in ordine naturale; gli intervalli numerici vengono ordinati nell'ordine indicato da `FacetSpec.FacetKey.intervals`.

ImageQuery

Specifica l'input della query di immagini.

Campi

Campo unione image.

image può essere solo uno dei seguenti:

image_bytes

string

Byte dell'immagine con codifica Base64. Formati immagine supportati: JPEG, PNG e BMP.

NaturalLanguageQueryUnderstandingSpec

Specifica per abilitare le funzionalità di comprensione del linguaggio naturale per le richieste di ricerca.

Campi
`filter_extraction_condition`	`FilterExtractionCondition` La condizione in base alla quale deve essere eseguita l'estrazione del filtro. Il comportamento del server è impostato per impostazione predefinita su `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` 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 `ENABLED`. Se questo campo è impostato, sostituisce i nomi dei campi impostati in `ServingConfig.geo_search_query_detection_field_names`.
`extracted_filter_behavior`	`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 è `HARD_FILTER`. Per la ricerca in più datastore, il comportamento predefinito è `SOFT_BOOST`. I filtri basati sulla posizione vengono sempre applicati come filtri rigidi e l'impostazione `SOFT_BOOST` non li influenzerà. Questo campo viene utilizzato solo se [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] è impostato su `FilterExtractionCondition.ENABLED`.
`allowed_field_names[]`	`string` 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 allowed_field_names, 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.

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.

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.

QueryExpansionSpec

Specifica per determinare in quali condizioni deve verificarsi l'espansione della query.

Campi

condition

Condition

La condizione in base alla quale deve verificarsi l'espansione delle query. Il valore predefinito è Condition.DISABLED.

pin_unexpanded_results

bool

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.

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 `RANK_BY_EMBEDDING`. Classificazione in base al modello di incorporamento personalizzato, il modo predefinito per valutare l'espressione di ranking. Opzione di enumerazione legacy, deve essere utilizzata `RANK_BY_EMBEDDING`. Questo elemento è deprecato.
`CLEARBOX`	Deprecato: utilizza `RANK_BY_FORMULA`. Classifica in base alla formula personalizzata. Opzione di enumerazione legacy, deve essere utilizzata `RANK_BY_FORMULA`. Questo elemento è deprecato.
`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.

RelevanceScoreSpec

La specifica per la restituzione del punteggio di pertinenza del documento.

Campi

return_relevance_score

bool

Facoltativo. Indica se restituire il punteggio di pertinenza per i risultati di ricerca. Più alto è il punteggio, più pertinente è il documento rispetto alla query.

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.

SearchAsYouTypeSpec

Specifica per la ricerca durante la digitazione nelle richieste di ricerca.

Campi

condition

Condition

La condizione in base alla quale deve verificarsi la ricerca durante la digitazione. Il valore predefinito è Condition.DISABLED.

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

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.

Campi

query_id

string

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?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }

L'utente può chiamare l'API /search con una richiesta come questa:

session: ".../sessions/xxx" session_spec { query_id: ".../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.

search_result_persistence_count

int32

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 summary_result_count in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Al massimo 10 risultati per la modalità Documenti o 50 per la modalità Chunk.

SpellCorrectionSpec

La specifica per la correzione ortografica delle query.

Campi

mode

Mode

La modalità in cui la correzione ortografica sostituisce la query di ricerca originale. Il valore predefinito è Mode.AUTO.

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.

SearchResponse

Messaggio di risposta per il metodo SearchService.Search.

Campi
`results[]`	`SearchResult` Un elenco di documenti corrispondenti. L'ordine rappresenta il ranking.
`facets[]`	`Facet` Risultati delle sfaccettature richieste dall'utente.
`total_size`	`int32` Il conteggio totale stimato di articoli corrispondenti indipendentemente dalla paginazione. Il conteggio di `results` restituito dalla paginazione potrebbe essere inferiore a `total_size` corrispondenti.
`attribution_token`	`string` Un token di ricerca univoco. Questo valore deve essere incluso nei log `UserEvent` risultanti da questa ricerca, il che consente un'attribuzione accurata del rendimento del modello di ricerca. In questo modo è più facile identificare una richiesta durante gli scenari di assistenza clienti.
`redirect_uri`	`string` L'URI di una pagina di reindirizzamento definita dal cliente. Se viene attivata l'azione di reindirizzamento, non viene eseguita alcuna ricerca e nella risposta vengono impostati solo `redirect_uri` e `attribution_token`.
`next_page_token`	`string` Un token che può essere inviato come `SearchRequest.page_token` per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.
`corrected_query`	`string` Contiene la query con correzione ortografica, se trovata. Se il tipo di correzione ortografica è AUTOMATIC, i risultati di ricerca si basano su corrected_query. In caso contrario, per la ricerca viene utilizzata la query originale.
`summary`	`Summary` Un riepilogo nei risultati di ricerca. Questo campo viene restituito solo se è impostato `SearchRequest.ContentSearchSpec.summary_spec`.
`query_expansion_info`	`QueryExpansionInfo` Informazioni sull'espansione della query per i risultati restituiti.
`session_info`	`SessionInfo` Informazioni sulla sessione. Impostato solo se viene fornito `SearchRequest.session`. Per maggiori dettagli, consulta la descrizione.
`search_link_promotions[]`	`SearchLinkPromotion` Promozioni per la ricerca sul sito.

Un risultato del facet.

Campi

key

string

La chiave per questo aspetto. Ad esempio, "colors" o "price". Corrisponde a SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

I valori delle sfaccettature per questo campo.

dynamic_facet

bool

Indica se il facet viene generato dinamicamente.

FacetValue

Un valore di sfaccettatura che contiene i nomi dei valori e il relativo conteggio.

Campi
`count`	`int64` Numero di elementi che hanno questo valore della sfaccettatura.
Campo unione `facet_value`. Un valore di sfaccettatura che contiene valori. `facet_value` può essere solo uno dei seguenti:
`value`	`string` Valore di testo di un facet, ad esempio "Nero" per il facet "colori".
`interval`	`Interval` Valore dell'intervallo per un facet, ad esempio [10, 20) per il facet "price". Corrisponde a `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Informazioni che descrivono l'espansione della query, incluso se si è verificata.

Campi

expanded_query

bool

Valore booleano che descrive se si è verificata l'espansione della query.

pinned_result_count

int64

Numero di risultati bloccati. Questo campo viene impostato solo quando si verifica l'espansione e SearchRequest.QueryExpansionSpec.pin_unexpanded_results è impostato su true.

SearchResult

Rappresenta i risultati di ricerca.

Campi
`id`	`string` `Document.id` della ricerca `Document`.
`document`	`Document` Lo snippet di dati del documento nella risposta di ricerca. Vengono compilati solo i campi contrassegnati come `retrievable`.
`chunk`	`Chunk` I dati dei blocchi nella risposta di ricerca se `SearchRequest.ContentSearchSpec.search_result_mode` è impostato su `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Solo output. Google ha fornito i punteggi disponibili.
`rank_signals`	`RankSignals` Facoltativo. Un insieme di indicatori di ranking associati al risultato.

RankSignals

Un insieme di indicatori di ranking.

Campi
`default_rank`	`float` Facoltativo. Il ranking predefinito del risultato.
`custom_signals[]`	`CustomSignal` Facoltativo. Un elenco di indicatori clearbox personalizzati.
`keyword_similarity_score`	`float` Facoltativo. Aggiustamento della corrispondenza delle parole chiave.
`relevance_score`	`float` Facoltativo. Aggiustamento della pertinenza semantica.
`semantic_similarity_score`	`float` Facoltativo. Aggiustamento della similarità semantica.
`pctr_rank`	`float` Facoltativo. Aggiustamento del tasso di conversione previsto come ranking.
`topicality_rank`	`float` Facoltativo. Aggiustamento della pertinenza come ranking.
`document_age`	`float` Facoltativo. Età del documento in ore.
`boosting_factor`	`float` Facoltativo. Potenziamenti personalizzati combinati per un documento.

CustomSignal

Indicatore clearbox personalizzato rappresentato da una coppia nome-valore.

Campi

name

string

Facoltativo. Il nome del segnale.

value

float

Facoltativo. Valore float che rappresenta l'indicatore di ranking (ad es. 1,25 per BM25).

SessionInfo

Informazioni sulla sessione.

Campi

name

string

Il nome della sessione. Se viene utilizzata la modalità di sessione automatica (quando SearchRequest.session termina con "-"), questo campo contiene il nome della sessione appena generato.

query_id

string

ID query corrispondente a questa chiamata API di ricerca. Una sessione può avere più turni, ognuno con un ID query univoco.

Se specifichi il nome della sessione e questo ID query nella chiamata API Answer, la generazione della risposta avviene nel contesto dei risultati di ricerca di questa chiamata di ricerca.

Riepilogo

Riepilogo dei primi N risultati di ricerca specificati dalla specifica del riepilogo.

Campi
`summary_text`	`string` Il contenuto del riepilogo.
`summary_skipped_reasons[]`	`SummarySkippedReason` Altri motivi per cui il riepilogo è stato ignorato. Fornisce il motivo dei casi ignorati. Se non viene ignorato nulla, questo campo non viene impostato.
`safety_attributes`	`SafetyAttributes` Una raccolta di categorie di attributi di sicurezza e i relativi punteggi di affidabilità.
`summary_with_metadata`	`SummaryWithMetadata` Riepilogo con informazioni sui metadati.

Citazione

Informazioni sulla citazione per un segmento.

Campi

start_index

int64

L'indice indica l'inizio del segmento, misurato in byte/unicode.

end_index

int64

Fine del segmento attribuito, escluso.

sources[]

CitationSource

Fonti delle citazioni per il segmento attribuito.

CitationMetadata

Metadati delle citazioni.

Campi

citations[]

Citation

Citazioni per i segmenti.

CitationSource

Fonte della citazione.

Campi

reference_index

int64

Indice dei riferimenti del documento da SummaryWithMetadata.references. È indicizzato a 0 e il valore sarà zero se reference_index non è impostato in modo esplicito.

Riferimento

Riferimento al documento.

Campi
`title`	`string` Il titolo del documento.
`document`	`string` Obbligatorio. `Document.name` del documento. Nome completo della risorsa del documento a cui viene fatto riferimento, nel formato `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` URI Cloud Storage o HTTP per il documento.
`chunk_contents[]`	`ChunkContent` Elenco dei contenuti dei chunk citati derivati dai contenuti del documento.

ChunkContent

Dividere i contenuti in blocchi.

Campi

content

string

Dividi i contenuti testuali in blocchi.

page_identifier

string

Identificatore della pagina.

SafetyAttributes

Categorie di attributi di sicurezza e i relativi punteggi di affidabilità.

Campi

categories[]

string

I nomi visualizzati delle categorie di attributi di sicurezza associati ai contenuti generati. L'ordine corrisponde ai punteggi.

scores[]

float

I punteggi di confidenza di ogni categoria. Un valore più alto indica una confidenza maggiore. L'ordine corrisponde alle categorie.

SummarySkippedReason

Un enum per i motivi di riepilogo ignorato.

Enum
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Valore predefinito. Il motivo per cui il riepilogo è stato ignorato non è specificato.
`ADVERSARIAL_QUERY_IGNORED`	La query contraddittoria ignorava la distinzione tra maiuscole e minuscole. Utilizzato solo quando `SummarySpec.ignore_adversarial_query` è impostato su `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	La query di ricerca non riepilogativa non ha tenuto conto della distinzione tra maiuscole e minuscole. Google salta il riepilogo se la query è una chiacchiera. Utilizzato solo quando `SummarySpec.ignore_non_summary_seeking_query` è impostato su `true`.
`OUT_OF_DOMAIN_QUERY_IGNORED`	La query al di fuori del dominio non ha tenuto conto della distinzione tra maiuscole e minuscole. Google salta il riepilogo se non ci sono risultati di ricerca di pertinenza elevata. Ad esempio, il datastore contiene informazioni sull'azienda A, ma la query dell'utente pone domande sull'azienda B.
`POTENTIAL_POLICY_VIOLATION`	Il caso di potenziale violazione delle norme. Google salta il riepilogo se viene rilevata una potenziale violazione delle norme. Sono inclusi contenuti che potrebbero essere violenti o tossici.
`LLM_ADDON_NOT_ENABLED`	Il caso in cui il componente aggiuntivo LLM non è abilitato. Google ignora il riepilogo se il componente aggiuntivo LLM non è abilitato.
`NO_RELEVANT_CONTENT`	Il caso di nessun contenuto pertinente. Google salta il riepilogo se non sono presenti contenuti pertinenti nei risultati di ricerca recuperati.
`JAIL_BREAKING_QUERY_IGNORED`	La query di jailbreaking non fa distinzione tra maiuscole e minuscole. Ad esempio, "Rispondi con il tono del CEO di un'azienda concorrente". Utilizzato solo quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] è impostato su `true`.
`CUSTOMER_POLICY_VIOLATION`	Il caso di violazione delle norme relative ai clienti. Google salta il riepilogo se viene rilevata una violazione delle norme per i clienti. Il criterio è definito dal cliente.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	La query che non cerca risposte ignora le maiuscole/minuscole. Google salta il riepilogo se la query non ha un intento chiaro. Utilizzato solo quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] è impostato su `true`.
`TIME_OUT`	La custodia per il timeout. Google salta il riepilogo se si verifica un timeout.

SummaryWithMetadata

Riepilogo con informazioni sui metadati.

Campi

summary

string

Testo di riepilogo senza informazioni sulla citazione.

citation_metadata

CitationMetadata

Metadati della citazione per il riepilogo fornito.

references[]

Reference

Riferimenti ai documenti.

SearchTier

Livelli delle funzionalità di ricerca. I diversi livelli potrebbero avere prezzi diversi. Per saperne di più, consulta la documentazione sui prezzi.

Enum
`SEARCH_TIER_UNSPECIFIED`	Valore predefinito quando l'enumerazione non è specificata. Questo valore non è valido.
`SEARCH_TIER_STANDARD`	Livello Standard.
`SEARCH_TIER_ENTERPRISE`	Livello Enterprise.

SearchUseCase

Definisce un'ulteriore suddivisione di SolutionType. Si applica in particolare a SOLUTION_TYPE_SEARCH.

Enum
`SEARCH_USE_CASE_UNSPECIFIED`	Valore utilizzato quando non è impostato. Non si verificherà in CSS.
`SEARCH_USE_CASE_SEARCH`	Caso d'uso della ricerca. Prevede che il traffico abbia un `query` non vuoto.
`SEARCH_USE_CASE_BROWSE`	Sfoglia il caso d'uso. Prevede che il traffico abbia un `query` vuoto.

ServingConfig

Configura i metadati utilizzati per generare i risultati del tempo di pubblicazione (ad es. risultati di ricerca o previsioni dei suggerimenti). ServingConfig viene trasmesso nella richiesta di ricerca e previsione e genera risultati.

Campi
`name`	`string` Immutabile. Nome completo `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Obbligatorio. Il nome visualizzato della configurazione di pubblicazione leggibile. Utilizzato nell'interfaccia utente di Discovery. Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`solution_type`	`SolutionType` Obbligatorio. Immutabile. Specifica il tipo di soluzione a cui può essere associata una configurazione di pubblicazione.
`model_id`	`string` L'ID del modello da utilizzare al momento della pubblicazione. Al momento sono supportati solo i modelli di raccomandazione. Può essere modificato, ma solo con un modello compatibile (ad es. CTR di Altri che ti potrebbero piacere con TdC di Altri che ti potrebbero piacere). Obbligatorio quando `SolutionType` è `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` Il livello di diversità da utilizzare nei risultati del modello di suggerimenti, ad esempio `medium-diversity` o `high-diversity`. Valori attualmente supportati: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Se non viene specificato, scegliamo il valore predefinito in base al tipo di modello di raccomandazione. Valore predefinito: `no-diversity`. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_RECOMMENDATION`.
`ranking_expression`	`string` L'espressione di ranking controlla il ranking personalizzato dei documenti recuperati. Per sfruttare questa funzionalità, è necessario incorporare i documenti. L'impostazione dell'espressione di ranking in ServingConfig si applica a tutte le richieste di ricerca gestite dalla configurazione di pubblicazione. Tuttavia, se viene specificato `SearchRequest.ranking_expression`, questo sostituisce l'espressione di ranking ServingConfig. L'espressione di ranking è una singola funzione o più funzioni unite dal segno "+". ranking_expression = function, { " + ", function }; Funzioni supportate: double * relevance_score double * dotProduct(embedding_field_path) Variabili della funzione: `relevance_score`: parole chiave predefinite, utilizzate per misurare la pertinenza tra query e documento. `embedding_field_path`: il campo di incorporamento del documento utilizzato con il vettore di incorporamento della query. `dotProduct`: funzione di embedding tra embedding_field_path e il vettore di embedding della query. Espressione di ranking di esempio: Se il documento ha un campo di incorporamento doc_embedding, l'espressione di ranking potrebbe essere `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
`create_time`	`Timestamp` Solo output. Timestamp di creazione di ServingConfig.
`update_time`	`Timestamp` Solo output. Timestamp dell'aggiornamento di ServingConfig.
`filter_control_ids[]`	`string` Filtra i controlli da utilizzare nel percorso di pubblicazione. Verranno applicati tutti i controlli dei filtri attivati. I controlli dei filtri devono trovarsi nello stesso datastore della configurazione di pubblicazione. Massimo 20 controlli filtro.
`boost_control_ids[]`	`string` Controlli di boost da utilizzare nel percorso di pubblicazione. Verranno applicati tutti i controlli di boost attivati. I controlli di boost devono trovarsi nello stesso datastore della configurazione di pubblicazione. Massimo 20 controlli di potenziamento.
`redirect_control_ids[]`	`string` ID dei controlli reindirizzamento. Viene applicata solo la prima azione di reindirizzamento attivata, anche se ne sono presenti più di una. Il numero massimo di specifiche è 100. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_SEARCH`.
`synonyms_control_ids[]`	`string` Specifiche dei sinonimi delle condizioni. Se corrispondono più condizioni di sinonimi, verranno eseguiti tutti i controlli dei sinonimi corrispondenti nell'elenco. Il numero massimo di specifiche è 100. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_SEARCH`.
`oneway_synonyms_control_ids[]`	`string` Specifiche dei sinonimi unidirezionali della condizione. Se corrispondono più condizioni di sinonimi unidirezionali, vengono eseguiti tutti i controlli di sinonimi unidirezionali corrispondenti nell'elenco. Il numero massimo di specifiche è 100. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_SEARCH`.
`dissociate_control_ids[]`	`string` La condizione non associa le specifiche. Se corrispondono più condizioni di non associazione, verranno eseguiti tutti i controlli di non associazione corrispondenti nell'elenco. L'ordine non è importante. Il numero massimo di specifiche è 100. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_SEARCH`.
`replacement_control_ids[]`	`string` Specifiche di sostituzione della condizione. Applicate in base all'ordine nell'elenco. Un termine sostituito in precedenza non può essere sostituito di nuovo. Il numero massimo di specifiche è 100. Può essere impostato solo se `SolutionType` è `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Ignora le specifiche della condizione. Se corrispondono più condizioni di ignoramento, verranno eseguiti tutti i controlli di ignoramento corrispondenti nell'elenco. L'ordine non è importante. Il numero massimo di specifiche è 100.
`promote_control_ids[]`	`string` Specifiche della promozione con condizione. Il numero massimo di specifiche è 100.
`answer_generation_spec`	`AnswerGenerationSpec` Facoltativo. La specifica per la generazione delle risposte.
Campo unione `vertical_config`. Configurazione specifica per verticale di settore. `vertical_config` può essere solo uno dei seguenti:
`media_config`	`MediaConfig` MediaConfig della configurazione di pubblicazione.
`generic_config`	`GenericConfig` GenericConfig della configurazione di pubblicazione.

GenericConfig

Specifica le configurazioni necessarie per il rilevamento generico.Al momento supportiamo:

content_search_spec: configurazione per la ricerca di contenuti generici.

Campi

content_search_spec

ContentSearchSpec

Specifica il comportamento previsto della ricerca di contenuti. Valido solo per il datastore con ricerca dei contenuti abilitata.

MediaConfig

Specifica le configurazioni necessarie per il rilevamento dei contenuti multimediali. Al momento supportiamo:

demote_content_watched: Soglia per la declassificazione dei contenuti guardati. I clienti possono specificare se utilizzare la retrocessione dei contenuti visualizzati o la pagina dei dettagli visualizzata. Se i clienti specificano che i minuti o la percentuale di contenuti guardati superano la soglia, i contenuti verranno retrocessi nel risultato del suggerimento.
promote_fresh_content: giorni limite per la promozione di nuovi contenuti. I clienti possono specificare se utilizzare la promozione della freschezza dei contenuti. Se i contenuti sono stati pubblicati entro i giorni limite, verranno promossi nel risultato del consiglio. Può essere impostato solo se SolutionType è SOLUTION_TYPE_RECOMMENDATION.

Campi
`demotion_event_type`	`string` Specifica il tipo di evento utilizzato per la retrocessione del risultato del suggerimento. Valori attualmente supportati: `view-item`: Articolo visualizzato. `media-play`: avvia/riprendi la riproduzione di un video, di un brano e così via. `media-complete`: Ha terminato o interrotto a metà un video, un brano e così via. Se il criterio non viene configurato, la retrocessione della cronologia delle visualizzazioni non verrà applicata. La retrocessione della novità dei contenuti verrà comunque applicata.
`demote_content_watched_past_days`	`int32` Facoltativo. Specifica il numero di giorni da prendere in considerazione per la retrocessione dei contenuti guardati. Se è impostato su zero o non è impostato, il valore predefinito è il massimo di 365 giorni.
`content_freshness_cutoff_days`	`int32` Specifica la freschezza dei contenuti utilizzata per il risultato del consiglio. I contenuti verranno retrocessi se sono stati pubblicati da più giorni rispetto al limite di aggiornamento dei contenuti.
Campo unione `demote_content_watched`. Specifica la soglia per la retrocessione dei contenuti visualizzati. La soglia può essere un valore percentuale o in minuti. Questo valore deve essere impostato per il tipo di evento `media-complete`. `demote_content_watched` può essere solo uno dei seguenti:
`content_watched_percentage_threshold`	`float` Specifica la soglia della percentuale di contenuti visualizzati per la retrocessione. Il valore di soglia deve essere compreso tra [0, 1] inclusi.
`content_watched_seconds_threshold`	`float` Specifica la soglia dei minuti di visualizzazione dei contenuti per la retrocessione.

Sessione

Definizione del proto della sessione esterna.

Campi
`name`	`string` Immutabile. Nome completo `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` Facoltativo. Il nome visualizzato della sessione. Questo campo viene utilizzato per identificare la sessione nell'interfaccia utente. Per impostazione predefinita, il nome visualizzato è il testo della prima query del turno nella sessione.
`state`	`State` Lo stato della sessione.
`user_pseudo_id`	`string` Un identificatore univoco per il monitoraggio degli utenti.
`turns[]`	`Turn` Turni.
`labels[]`	`string` Facoltativo. Le etichette della sessione. Può essere impostato come filtro in ListSessionsRequest.
`start_time`	`Timestamp` Solo output. L'ora di inizio della sessione.
`end_time`	`Timestamp` Solo output. L'ora in cui è terminata la sessione.
`is_pinned`	`bool` Facoltativo. Se la sessione è bloccata, verrà visualizzata in cima all'elenco delle sessioni.

Stato

Enumerazione dello stato della sessione.

Enum
`STATE_UNSPECIFIED`	Lo stato non è specificato.
`IN_PROGRESS`	La sessione è attualmente aperta.

Attiva

Rappresenta un turno, inclusa una query dell'utente e una risposta del servizio.

Campi
`query`	`Query` Facoltativo. La query dell'utente. Potrebbe non essere impostato se questo turno sta semplicemente rigenerando una risposta a un turno diverso
`answer`	`string` Facoltativo. Il nome risorsa della risposta alla query dell'utente. Imposta solo se la generazione della risposta (chiamata API /answer) è avvenuta in questo turno.
`assist_answer`	`string` Solo output. Il nome risorsa della risposta dell'assistente alla query dell'utente. Imposta solo se in questo turno è stata effettuata una chiamata di assistenza (chiamata API /assist). Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Per ottenere tutte le risposte di AssistAnswers per una sessione, imposta GetSessionRequest.include_answer_details su true. In alternativa, per ottenere una singola risorsa AssistAnswer, utilizza l'API AssistAnswerService.GetAssistAnswer.
`detailed_answer`	`Answer` Solo output. Nell'API `ConversationalSearchService.GetSession`, se `GetSessionRequest.include_answer_details` è impostato su true, questo campo verrà compilato quando si ottiene la sessione di query di risposta.
`detailed_assist_answer`	`AssistAnswer` Solo output. Nell'API `ConversationalSearchService.GetSession`, se `GetSessionRequest.include_answer_details` è impostato su true, questo campo verrà compilato quando si ottiene la sessione dell'assistente.
`query_config`	`map<string, string>` Facoltativo. Rappresenta i metadati relativi alla configurazione della query, ad esempio il modello LLM e la versione utilizzati, i parametri del modello (temperatura, parametri di grounding e così via). Il prefisso "google." è riservato alla funzionalità sviluppata da Google.

SetUpDataConnectorMetadata

Questo tipo non contiene campi.

Metadati per il metodo DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Richiesta per il metodo DataConnectorService.SetUpDataConnector.

Campi
`parent`	`string` Obbligatorio. Il genitore di `Collection`, nel formato `projects/{project}/locations/{location}`.
`collection_id`	`string` Obbligatorio. L'ID da utilizzare per `Collection`, che diventerà il componente finale del nome della risorsa di `Collection`. Viene creato un nuovo `Collection` nell'ambito della configurazione di `DataConnector`. `DataConnector` è una risorsa singleton in `Collection`, che gestisce tutti i `DataStore` di `Collection`. Questo campo deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
`collection_display_name`	`string` Obbligatorio. Il nome visualizzato di `Collection`. Deve essere leggibile e utilizzato per visualizzare le raccolte nella dashboard di Play Console. Stringa codificata UTF-8 con un limite di 1024 caratteri.
`data_connector`	`DataConnector` Obbligatorio. `DataConnector` da inizializzare nel `Collection` appena creato.

SingleRegionKey

Metadati per le chiavi CMEK monoregionali.

Campi

kms_key

string

Obbligatorio. Nome risorsa della chiave KMS a singola regione che verrà utilizzata per criptare le risorse projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

SiteSearchEngine acquisisce le configurazioni persistenti della ricerca sul sito a livello di DataStore. Si tratta di un valore singleton per datastore.

Campi

name

string

Il nome risorsa completo del motore di ricerca del sito. Formato: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Informazioni sulla verifica per i siti di destinazione nella ricerca avanzata sul sito.

Campi

site_verification_state

SiteVerificationState

Stato di verifica del sito che indica la proprietà e la validità.

verify_time

Data e ora dell'ultima verifica del sito.

SiteVerificationState

Stato della verifica del sito.

Enum
`SITE_VERIFICATION_STATE_UNSPECIFIED`	Il valore predefinito è VERIFIED.
`VERIFIED`	Proprietà del sito verificata.
`UNVERIFIED`	La verifica della proprietà del sito è in attesa o non è riuscita.
`EXEMPTED`	Sito esente dalla verifica, ad esempio un sito web pubblico aperto a tutti.

Sitemap

Una Sitemap per SiteSearchEngine.

Campi
`name`	`string` Solo output. Il nome risorsa completo della sitemap. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` Il suffisso `sitemap_id` viene generato dal sistema.
`create_time`	`Timestamp` Solo output. Data e ora di creazione della Sitemap.
Campo unione `feed`. Origini feed supportate. `feed` può essere solo uno dei seguenti:
`uri`	`string` URI pubblico della Sitemap, ad esempio `www.example.com/sitemap.xml`.

SolutionType

Il tipo di soluzione.

Enum
`SOLUTION_TYPE_UNSPECIFIED`	Valore predefinito.
`SOLUTION_TYPE_RECOMMENDATION`	Utilizzato per Recommendations AI.
`SOLUTION_TYPE_SEARCH`	Utilizzato per la ricerca di Discovery.
`SOLUTION_TYPE_CHAT`	Utilizzato per i casi d'uso relativi all'agente di AI generativa.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Utilizzato per i casi d'uso relativi all'agente di chat generativa. Viene utilizzato solo per il motore di chat generativa e i datastore associati devono essere registrati con la soluzione `SOLUTION_TYPE_CHAT`.

SpannerSource

L'origine Spanner per l'importazione dei dati

Campi
`project_id`	`string` L'ID progetto che contiene l'origine Spanner. Ha un limite di lunghezza di 128 caratteri. Se non specificato, eredita l'ID progetto dalla richiesta principale.
`instance_id`	`string` Obbligatorio. L'ID istanza della tabella Spanner di origine.
`database_id`	`string` Obbligatorio. L'ID database della tabella Spanner di origine.
`table_id`	`string` Obbligatorio. Il nome della tabella del database Spanner da importare.
`enable_data_boost`	`bool` Se applicare Data Boost all'esportazione di Spanner. L'abilitazione di questa opzione comporta costi aggiuntivi. Puoi trovare maggiori informazioni qui.

StreamAssistRequest

Richiesta per il metodo AssistantService.StreamAssist.

Campi
`name`	`string` Obbligatorio. Il nome della risorsa di `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Facoltativo. Query utente corrente. La query vuota è supportata solo se vengono forniti `file_ids`. In questo caso, la risposta verrà generata in base a questi file di contesto.
`session`	`string` Facoltativo. La sessione da utilizzare per la richiesta. Se specificato, l'assistente ha accesso alla cronologia della sessione e la query e la risposta vengono memorizzate. Se `-` viene specificato come ID sessione o viene lasciato vuoto, viene creata una nuova sessione con un ID generato automaticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Facoltativo. Informazioni sull'utente che avvia la query.
`agents_spec`	`AgentsSpec` Facoltativo. Specifica degli agenti utilizzati per gestire la richiesta.
`tools_spec`	`ToolsSpec` Facoltativo. Specifica degli strumenti utilizzati per gestire la richiesta.
`generation_spec`	`GenerationSpec` Facoltativo. Specifica della configurazione di generazione per la richiesta.

AgentsSpec

Specifica degli agenti utilizzati per gestire la richiesta.

Campi

agent_specs[]

AgentSpec

Facoltativo. Specifica degli agenti utilizzati per gestire la richiesta.

AgentSpec

Specifica di un agente.

Campi

agent_id

string

Obbligatorio. ID per identificare la risorsa agente che gestisce la richiesta.

Questo campo deve essere conforme a RFC-1034 con un limite di lunghezza di 63 caratteri.

GenerationSpec

Specifica di generazione dell'assistente per la richiesta. Ciò consente di eseguire l'override della configurazione di generazione predefinita a livello di motore.

Campi

model_id

string

Facoltativo. L'ID modello Vertex AI utilizzato per il modello generativo. Se non impostato, verrà utilizzato il modello dell'assistente predefinito.

ToolsSpec

Specifica degli strumenti utilizzati per gestire la richiesta.

Campi
`vertex_ai_search_spec`	`VertexAiSearchSpec` Facoltativo. Specifica dello strumento Vertex AI Search.
`web_grounding_spec`	`WebGroundingSpec` Facoltativo. Specifica dello strumento di grounding web. Se il campo è presente, abilita il grounding con la ricerca web. Funziona solo se `Assistant.web_grounding_type` è [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] o [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
`image_generation_spec`	`ImageGenerationSpec` Facoltativo. Specifica dello strumento di generazione di immagini.
`video_generation_spec`	`VideoGenerationSpec` Facoltativo. Specifica dello strumento di generazione dei video.

ImageGenerationSpec

Questo tipo non contiene campi.

Specifica dello strumento di generazione di immagini.

VertexAiSearchSpec

Specifica dello strumento Vertex AI Search.

Campi

data_store_specs[]

DataStoreSpec

Facoltativo. Specifiche che definiscono i DataStore su cui filtrare in una chiamata di ricerca e le configurazioni per questi datastore. Questo aspetto viene preso in considerazione solo per i Engine con più datastore.

filter

string

Facoltativo. La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti da filtrare. L'espressione del filtro è sensibile alle maiuscole.

Se questo campo non è riconoscibile, viene restituito un INVALID_ARGUMENT.

Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente del settore dei media potrebbe avere un campo "nome" nel proprio schema. In questo caso, il filtro sarà simile a questo: filter --> name:'ANY("king kong")'

Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.

VideoGenerationSpec

Questo tipo non contiene campi.

Specifica dello strumento di generazione dei video.

WebGroundingSpec

Questo tipo non contiene campi.

Specifica dello strumento di grounding web.

StreamAssistResponse

Risposta per il metodo AssistantService.StreamAssist.

Campi

answer

AssistAnswer

Oggetto risorsa di risposta dell'assistente contenente parti della risposta finale dell'assistente alla query dell'utente.

Non presente se la risposta attuale non aggiunge nulla a AssistAnswer.replies inviato in precedenza.

Osserva AssistAnswer.state per vedere se sono previste altre parti. Mentre lo stato è IN_PROGRESS, il campo AssistAnswer.replies di ogni risposta conterrà le risposte (frammenti di risposta) da aggiungere a quelle ricevute nelle risposte precedenti. AssistAnswer.name non verrà compilato.

Se lo stato è SUCCEEDED, FAILED o SKIPPED, la risposta è l'ultima risposta e AssistAnswer.name avrà un valore.

session_info

SessionInfo

Informazioni sulla sessione. Incluso solo nella risposta StreamAssistResponse finale del flusso di risposte.

assist_token

string

Un ID univoco globale che identifica la coppia corrente di richiesta e flusso di risposte. Utilizzato per feedback e assistenza.

SessionInfo

Informazioni sulla sessione.

Campi

session

string

Nome della sessione appena generata o continuata.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.

SubscriptionTerm

Periodicità dell'abbonamento. LINT.IfChange

Enum
`SUBSCRIPTION_TERM_UNSPECIFIED`	Valore predefinito, non utilizzare.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 mese.
`SUBSCRIPTION_TERM_ONE_YEAR`	1 anno.
`SUBSCRIPTION_TERM_THREE_YEARS`	3 anni.

SubscriptionTier

Informazioni sul livello di abbonamento.

Enum
`SUBSCRIPTION_TIER_UNSPECIFIED`	Valore predefinito.
`SUBSCRIPTION_TIER_SEARCH`	Livello di ricerca. Il livello di ricerca può accedere alle funzionalità di ricerca VAIS e a quelle di NotebookLM.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Livello Ricerca e assistente. Il livello Ricerca + assistente può accedere alle funzionalità di ricerca VAIS, alle funzionalità di NotebookLM e alle funzionalità dell'assistente.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	Livello NotebookLM. NotebookLM è un livello di abbonamento che può accedere solo alle funzionalità di NotebookLM.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Livello del personale a contatto con il pubblico.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Livello Agentspace Starter.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Livello Agentspace Business.
`SUBSCRIPTION_TIER_ENTERPRISE`	Livello Enterprise.
`SUBSCRIPTION_TIER_EDU`	Livello EDU.
`SUBSCRIPTION_TIER_EDU_PRO`	Livello EDU Pro.
`SUBSCRIPTION_TIER_EDU_EMERGING`	Livello del mercato emergente EDU.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Livello del mercato emergente EDU Pro.

SuggestionDenyListEntry

Voce dell'elenco di negazione dei suggerimenti che identifica la frase da bloccare nei suggerimenti e l'operazione applicata alla frase.

Campi

block_phrase

string

Obbligatorio. Frase da bloccare nei suggerimenti visualizzati. Può contenere un massimo di 125 caratteri.

match_operator

MatchOperator

Obbligatorio. L'operatore di corrispondenza da applicare a questa frase. Se bloccare la frase esatta o tutti i suggerimenti che la contengono.

MatchOperator

Operatore per la corrispondenza con i suggerimenti generati.

Enum
`MATCH_OPERATOR_UNSPECIFIED`	Valore predefinito. Non deve essere utilizzato
`EXACT_MATCH`	Se il suggerimento corrisponde esattamente a block_phrase, bloccalo.
`CONTAINS`	Se il suggerimento contiene block_phrase, bloccalo.

TargetSite

Un sito di destinazione per SiteSearchEngine.

Campi
`name`	`string` Solo output. Il nome risorsa completo del sito di destinazione. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` Il `target_site_id` è generato dal sistema.
`provided_uri_pattern`	`string` Obbligatorio. Solo input. Il pattern URI fornito dall'utente da cui viene generato `generated_uri_pattern`.
`type`	`Type` Il tipo di sito di destinazione, ad esempio se il sito deve essere incluso o escluso.
`exact_match`	`bool` Immutabile. Se impostato su false, viene generato un uri_pattern per includere tutte le pagine il cui indirizzo contiene il provided_uri_pattern. Se impostato su true, viene generato un uri_pattern che tenta di corrispondere esattamente al provided_uri_pattern o solo alla pagina specifica se provided_uri_pattern è specifico. provided_uri_pattern viene sempre normalizzato per generare il pattern URI da utilizzare dal motore di ricerca.
`generated_uri_pattern`	`string` Solo output. Questo valore viene generato dal sistema in base a provided_uri_pattern.
`root_domain_uri`	`string` Solo output. Dominio principale di provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Solo output. Stato di verifica della proprietà e della validità del sito.
`indexing_status`	`IndexingStatus` Solo output. Stato dell'indicizzazione.
`update_time`	`Timestamp` Solo output. L'ora dell'ultimo aggiornamento del sito di destinazione.
`failure_reason`	`FailureReason` Solo output. Motivo dell'errore.

FailureReason

Motivi del mancato completamento dell'indicizzazione della ricerca sul sito.

Campi

Campo unione failure. Motivo dell'errore. failure può essere solo uno dei seguenti:

quota_failure

QuotaFailure

Operazione non riuscita a causa di una quota insufficiente.

QuotaFailure

Operazione non riuscita a causa di una quota insufficiente.

Campi

total_required_quota

int64

Questo numero è una stima della quota totale necessaria a questo progetto per completare correttamente l'indicizzazione.

IndexingStatus

Enumerazione dello stato di indicizzazione del sito target.

Enum
`INDEXING_STATUS_UNSPECIFIED`	Il valore predefinito è SUCCEEDED.
`PENDING`	Il sito di destinazione si trova nella coda di aggiornamento e verrà selezionato dalla pipeline di indicizzazione.
`FAILED`	L'indicizzazione del sito di destinazione non riesce.
`SUCCEEDED`	Il sito di destinazione è stato indicizzato.
`DELETING`	Il sito di destinazione precedentemente indicizzato è stato contrassegnato per l'eliminazione. Si tratta di uno stato di transizione che comporterà: 1. l'eliminazione del sito di destinazione se l'annullamento dell'indicizzazione va a buon fine; 2. il ripristino dello stato SUCCEEDED se l'annullamento dell'indicizzazione non va a buon fine.
`CANCELLABLE`	La modifica del sito di destinazione è in attesa, ma può essere annullata.
`CANCELLED`	La modifica del sito di destinazione è stata annullata.

Tipo

Tipi di siti di destinazione possibili.

Enum
`TYPE_UNSPECIFIED`	Questo valore non viene utilizzato. In questo caso, il comportamento del server è impostato su `Type.INCLUDE` per impostazione predefinita.
`INCLUDE`	Includi il sito di destinazione.
`EXCLUDE`	Escludi il sito di destinazione.

Tenant

Informazioni sul tenant per un'origine connettore. Sono incluse alcune delle stesse informazioni memorizzate nel messaggio Credenziali, ma limitate solo a ciò che è necessario per fornire all'utente un elenco di tenant accessibili.

Campi

id

string

L'ID istanza del tenant. Esempi: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

uri

string

L'URI del tenant, se applicabile. Ad esempio, l'URI di un'istanza Jira è https://my-jira-instance.atlassian.net, mentre un tenant Slack non ha un URI.

display_name

string

Nome visualizzato facoltativo per il tenant, ad esempio "Il mio team Slack".

TextInput

Definisce l'input di testo.

Campi

input

string

Inserimento testo.

context

ConversationContext

Il contesto della conversazione dell'input.

TrainCustomModelMetadata

Metadati relativi all'avanzamento dell'operazione TrainCustomModel. Questo valore viene restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

TrainCustomModelRequest

Richiesta di messaggio per il metodo SearchTuningService.TrainCustomModel.

Campi
`data_store`	`string` Obbligatorio. Il nome della risorsa del datastore, ad esempio `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Questo campo viene utilizzato per identificare il datastore in cui addestrare i modelli.
`model_type`	`string` Modello da addestrare. I valori supportati sono: search-tuning: ottimizzazione del sistema di ricerca in base ai dati forniti.
`error_config`	`ImportErrorConfig` La posizione desiderata degli errori riscontrati durante l'importazione e l'addestramento dei dati.
`model_id`	`string` Se non viene fornito, verrà generato un UUID.
Campo unione `training_input`. Input per l'addestramento del modello. `training_input` può essere solo uno dei seguenti:
`gcs_training_input`	`GcsTrainingInput` Input di addestramento di Cloud Storage.

GcsTrainingInput

Input dei dati di addestramento di Cloud Storage.

Campi
`corpus_data_path`	`string` I dati del corpus di Cloud Storage che potrebbero essere associati ai dati di addestramento. Il formato del percorso dei dati è `gs://<bucket_to_data>/<jsonl_file_name>`. Un file jsonl/ndjson delimitato da nuova riga. Per il modello di ottimizzazione della ricerca, ogni riga deve contenere _id, titolo e testo. Esempio: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` I dati delle query GCS che potrebbero essere associati ai dati di addestramento. Il formato del percorso dei dati è `gs://<bucket_to_data>/<jsonl_file_name>`. Un file jsonl/ndjson delimitato da nuova riga. Per il modello di ottimizzazione della ricerca, ogni riga deve contenere _id e testo. Esempio: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Percorso dei dati di addestramento di Cloud Storage il cui formato deve essere `gs://<bucket_to_data>/<tsv_file_name>`. Il file deve essere in formato TSV. Ogni riga deve contenere doc_id, query_id e punteggio (numero). Per il modello di ottimizzazione della ricerca, deve avere query-id corpus-id score come intestazione del file TSV. Il punteggio deve essere un numero compreso in `[0, inf+)`. Più grande è il numero, più pertinente è la coppia. Esempio: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Dati di test di Cloud Storage. Stesso formato di train_data_path. Se non viene fornito, viene eseguita una suddivisione addestramento/test casuale 80/20 su train_data_path.

TrainCustomModelResponse

Risposta di TrainCustomModelRequest. Questo messaggio viene restituito dal campo google.longrunning.Operations.response.

Campi
`error_samples[]`	`Status` Un campione degli errori riscontrati durante l'elaborazione dei dati.
`error_config`	`ImportErrorConfig` Se impostata, ripete la destinazione per gli errori completi nella richiesta.
`model_status`	`string` Lo stato del modello addestrato. I valori possibili sono: bad-data: la qualità dei dati di addestramento è scarsa. no-improvement: la regolazione non ha migliorato le prestazioni. Non verrà eseguito il deployment. in-progress: è in corso la creazione del job di addestramento del modello. training: il modello è in fase di addestramento attivo. Valutazione: il modello sta valutando le metriche addestrate. Indicizzazione: le metriche addestrate del modello vengono indicizzate. Pronto: il modello è pronto per la pubblicazione.
`metrics`	`map<string, double>` Le metriche del modello addestrato.
`model_name`	`string` Nome completo di CustomTuningModel.

TransactionInfo

Una transazione rappresenta l'intera transazione di acquisto.

Campi
`currency`	`string` Obbligatorio. Codice valuta. Utilizza il codice ISO-4217 di tre caratteri.
`transaction_id`	`string` L'ID transazione con un limite di lunghezza di 128 caratteri.
`value`	`float` Obbligatorio. Valore totale diverso da zero associato alla transazione. Questo valore può includere spedizione, tasse o altri aggiustamenti al valore totale da includere.
`tax`	`float` Tutte le imposte associate alla transazione.
`cost`	`float` Tutti i costi associati ai prodotti. Questi possono essere costi di produzione, spese di spedizione non sostenute dall'utente finale o altri costi, in modo che: Profitto = `value` - `tax` - `cost`
`discount_value`	`float` Il valore totale degli sconti applicati a questa transazione. Questa cifra deve essere esclusa da `TransactionInfo.value` Ad esempio, se un utente ha pagato l'importo `TransactionInfo.value`, il valore nominale (pre-sconto) della transazione è la somma di `TransactionInfo.value` e `TransactionInfo.discount_value` Ciò significa che il profitto viene calcolato allo stesso modo, indipendentemente dal valore dello sconto, e che `TransactionInfo.discount_value` può essere maggiore di `TransactionInfo.value`: Profitto = `value` - `tax` - `cost`

UpdateAclConfigRequest

Messaggio di richiesta per il metodo UpdateAclConfig.

Campi
`acl_config`	`AclConfig`

UpdateAssistantRequest

Messaggio di richiesta per il metodo AssistantService.UpdateAssistant.

Campi

assistant

Assistant

Obbligatorio. Assistant da aggiornare.

Il campo name di Assistant viene utilizzato per identificare Assistant da aggiornare. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Se il chiamante non dispone dell'autorizzazione per aggiornare Assistant, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Assistant da aggiornare non esiste, viene restituito un errore NOT_FOUND.

update_mask

L'elenco dei campi da aggiornare.

UpdateCmekConfigMetadata

Metadati relativi all'avanzamento dell'operazione CmekConfigService.UpdateCmekConfig. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

UpdateCmekConfigRequest

Messaggio di richiesta per il metodo UpdateCmekConfig. rpc.

Campi

config

CmekConfig

Obbligatorio. La risorsa CmekConfig.

set_default

bool

Imposta la seguente CmekConfig come predefinita da utilizzare per le risorse secondarie se non ne viene specificata una.

UpdateControlRequest

Richiesta del metodo UpdateControl.

Campi

control

Control

Obbligatorio. Il controllo da aggiornare.

update_mask

Facoltativo. Indica quali campi del Control fornito aggiornare. Non è supportato quanto segue:

Control.name
Control.solution_type

Se non è impostato o è vuoto, vengono aggiornati tutti i campi supportati.

UpdateConversationRequest

Richiesta del metodo UpdateConversation.

Campi

conversation

Obbligatorio. La conversazione da aggiornare.

update_mask

Indica quali campi del Conversation fornito aggiornare. Non è supportato quanto segue:

Conversation.name

Se non è impostato o è vuoto, vengono aggiornati tutti i campi supportati.

UpdateDataConnectorRequest

Richiesta di messaggio per il metodo DataConnectorService.UpdateDataConnector.

Campi

data_connector

DataConnector

Obbligatorio. DataConnector da aggiornare.

Se il chiamante non dispone dell'autorizzazione per aggiornare DataConnector, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se DataConnector non esiste, viene restituito un errore NOT_FOUND.

update_mask

Indica quali campi del DataConnector fornito aggiornare.

I percorsi dei campi supportati includono:

refresh_interval
parametri
auto_run_disabled
action_config
action_config.action_params
action_config.service_name
destination_configs
blocking_reasons
sync_mode
incremental_sync_disabled
incremental_refresh_interval

Nota: il supporto per questi campi può variare a seconda del tipo di connettore. Ad esempio, non tutti i connettori supportano destination_configs.

Se viene fornito un percorso di campo non supportato o sconosciuto, la richiesta restituirà un errore INVALID_ARGUMENT.

UpdateDataStoreRequest

Richiesta di messaggio per il metodo DataStoreService.UpdateDataStore.

Campi

data_store

DataStore

Obbligatorio. DataStore da aggiornare.

Se il chiamante non dispone dell'autorizzazione per aggiornare DataStore, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il DataStore da aggiornare non esiste, viene restituito un errore NOT_FOUND.

update_mask

Indica quali campi del DataStore fornito aggiornare.

Se viene fornito un campo non supportato o sconosciuto, viene restituito un errore INVALID_ARGUMENT.

UpdateDocumentRequest

Richiesta di messaggio per il metodo DocumentService.UpdateDocument.

Campi

document

Obbligatorio. Il documento da aggiornare/creare.

Se il chiamante non dispone dell'autorizzazione per aggiornare Document, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se Document da aggiornare non esiste e allow_missing non è impostato, viene restituito un errore NOT_FOUND.

allow_missing

bool

Se è impostato su true e Document non viene trovato, viene creato un nuovo Document.

update_mask

Indica quali campi del "documento" importato fornito devono essere aggiornati. Se non è impostato, per impostazione predefinita vengono aggiornati tutti i campi.

UpdateEngineRequest

Richiesta di messaggio per il metodo EngineService.UpdateEngine.

Campi

engine

Engine

Obbligatorio. Engine da aggiornare.

Se il chiamante non dispone dell'autorizzazione per aggiornare Engine, indipendentemente dalla sua esistenza, viene restituito un errore PERMISSION_DENIED.

Se il Engine da aggiornare non esiste, viene restituito un errore NOT_FOUND.

update_mask

Indica quali campi del Engine fornito aggiornare.

Se viene fornito un campo non supportato o sconosciuto, viene restituito un errore INVALID_ARGUMENT.

UpdateLicenseConfigRequest

Richiesta di messaggio per il metodo LicenseConfigService.UpdateLicenseConfig.

Campi

license_config

LicenseConfig

Obbligatorio. LicenseConfig da aggiornare.

update_mask

Facoltativo. Indica quali campi del LicenseConfig fornito aggiornare.

Se viene fornito un campo non supportato o sconosciuto, viene restituito un errore INVALID_ARGUMENT.

UpdateSchemaMetadata

Metadati per LRO UpdateSchema.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

UpdateSchemaRequest

Richiesta di messaggio per il metodo SchemaService.UpdateSchema.

Campi

schema

Schema

Obbligatorio. Schema da aggiornare.

allow_missing

bool

Se è impostato su true e Schema non viene trovato, viene creato un nuovo Schema. In questa situazione, update_mask viene ignorato.

UpdateServingConfigRequest

Richiesta per il metodo UpdateServingConfig.

Campi

serving_config

ServingConfig

Obbligatorio. La configurazione di pubblicazione da aggiornare.

update_mask

Indica quali campi del ServingConfig fornito aggiornare. Non è supportato quanto segue:

ServingConfig.name

Se non è impostato, vengono aggiornati tutti i campi supportati.

UpdateSessionRequest

Richiesta per il metodo UpdateSession.

Campi

session

Obbligatorio. La sessione da aggiornare.

update_mask

Indica quali campi del Session fornito aggiornare. Non è supportato quanto segue:

Session.name

Se non è impostato o è vuoto, vengono aggiornati tutti i campi supportati.

UpdateTargetSiteMetadata

Metadati relativi all'avanzamento dell'operazione SiteSearchEngineService.UpdateTargetSite. Questo valore verrà restituito dal campo google.longrunning.Operation.metadata.

Campi

create_time

Ora di creazione dell'operazione.

update_time

Data e ora dell'ultimo aggiornamento dell'operazione. Se l'operazione è stata completata, questo è anche l'orario di fine.

UpdateTargetSiteRequest

Richiesta di messaggio per il metodo SiteSearchEngineService.UpdateTargetSite.

Campi

target_site