Package google.cloud.discoveryengine.v1

QueryClassificationInfo

A hora em que esta pesquisa recente ocorreu.

score

double

A pontuação de cada sugestão. A pontuação está no intervalo [0, 1].

AdvancedSiteSearchConfig

Dados de configuração para a pesquisa no site avançada.

Campos

disable_initial_index

bool

Se for definida como verdadeira, a indexação inicial é desativada para o DataStore.

disable_automatic_refresh

bool

Se for definida como verdadeira, a atualização automática é desativada para o DataStore.

AlertPolicyConfig

A configuração de alerta ao nível do conetor.

Campos

alert_policy_name

string

Imutável. O nome do recurso totalmente qualificado da AlertPolicy.

alert_enrollments[]

AlertEnrollment

Opcional. Os estados de inscrição de cada alerta.

AlertEnrollment

O estado de inscrição do alerta.

Campos

alert_id

string

Imutável. O ID de um alerta.

enroll_state

EnrollStates

Obrigatório. O estado de inscrição de um cliente.

EnrollStates

A enumeração do estado de inscrição para o alerta.

Enumerações
`ENROLL_STATES_UNSPECIFIED`	Valor predefinido. Usado para clientes que não responderam à política de alertas.
`ENROLLED`	O cliente está inscrito nesta política.
`DECLINED`	O cliente recusou esta política.

AlertPolicyResourceConfig

A configuração de alerta ao nível do recurso. Usado em: * UserLicense * EngineUserData. O AlertPolicyConfig no conetor de dados tem a mesma utilização. Não existe uma forma fácil de migrar.

Campos
`alert_policy`	`string` Imutável. O nome do recurso totalmente qualificado da AlertPolicy.
`alert_enrollments[]`	`AlertEnrollment` Opcional. O estado de inscrição de cada alerta.
`contact_details[]`	`ContactDetails` Opcional. Os detalhes de contacto de cada política de alertas.
`language_code`	`string` Opcional. O código do idioma usado para notificações

AlertEnrollment

O estado de inscrição do alerta.

Campos

alert_id

string

Imutável. O ID de um alerta.

enroll_state

EnrollState

Obrigatório. O estado de inscrição de um cliente.

notification_params

map<string, string>

Opcional. Parâmetros usados para instanciar uma notificação. Usado para notificações acionadas quando o dispositivo está registado. Não são armazenadas. * Emails de boas-vindas do Gemini Business. * Emails de convite de utilizadores do Gemini Business.

EnrollState

A enumeração do estado de inscrição para o alerta.

Enumerações
`ENROLL_STATE_UNSPECIFIED`	Valor predefinido. Usado para clientes que não responderam à política de alertas.
`ENROLLED`	O cliente está inscrito nesta política.
`DECLINED`	O cliente recusou esta política.

AlloyDbSource

Origem do AlloyDB a partir da qual importar dados.

Campos
`project_id`	`string` O ID do projeto que contém a origem do AlloyDB. Tem um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`location_id`	`string` Obrigatório. A localização do AlloyDB a partir da qual os dados são copiados, com um limite de comprimento de 256 carateres.
`cluster_id`	`string` Obrigatório. O cluster do AlloyDB a partir do qual copiar os dados, com um limite de comprimento de 256 carateres.
`database_id`	`string` Obrigatório. A base de dados do AlloyDB a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`table_id`	`string` Obrigatório. A tabela do AlloyDB a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`gcs_staging_dir`	`string` Diretório do Cloud Storage intermédio usado para a importação com um limite de comprimento de 2000 carateres. Pode ser especificado se quiser que o AlloyDB seja exportado para um diretório específico do Cloud Storage. Certifique-se de que a conta de serviço do AlloyDB tem as autorizações de administrador do Cloud Storage necessárias para aceder ao diretório do Cloud Storage especificado.

Responder

Define uma resposta.

Campos
`name`	`string` Imutável. Nome totalmente qualificado `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` O estado da geração de respostas.
`answer_text`	`string` A resposta textual.
`citations[]`	`Citation` Citações.
`grounding_supports[]`	`GroundingSupport` Opcional. Suporta a superfície de referência.
`references[]`	`Reference` Referências.
`related_questions[]`	`string` Perguntas relacionadas sugeridas.
`steps[]`	`Step` Passos de geração de respostas.
`query_understanding_info`	`QueryUnderstandingInfo` Informações de compreensão de consultas.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Motivos adicionais para a omissão de respostas. Isto indica o motivo dos casos ignorados. Se nada for ignorado, este campo não é definido.
`create_time`	`Timestamp` Apenas saída. Data/hora de criação da resposta.
`complete_time`	`Timestamp` Apenas saída. Data/hora de conclusão da resposta.
`safety_ratings[]`	`SafetyRating` Opcional. Classificações de segurança.
`grounding_score`	`double` Uma pontuação no intervalo de [0, 1] que descreve o quão fundamentada está a resposta nos fragmentos de referência.

AnswerSkippedReason

Uma enumeração para os motivos pelos quais a resposta foi ignorada.

Enumerações
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Valor predefinido. O motivo pelo qual a resposta foi ignorada não está especificado.
`ADVERSARIAL_QUERY_IGNORED`	A consulta adversária ignorou as maiúsculas e minúsculas.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	A consulta que não procura respostas ignorou as maiúsculas/minúsculas O Google ignora a resposta se a consulta for uma conversa informal.
`OUT_OF_DOMAIN_QUERY_IGNORED`	A consulta fora do domínio ignorou as maiúsculas/minúsculas. O Google ignora a resposta se não existirem resultados da pesquisa de alta relevância.
`POTENTIAL_POLICY_VIOLATION`	O registo de potencial violação de política. O Google ignora a resposta se for detetada uma potencial violação de política. Isto inclui conteúdo que pode ser violento ou tóxico.
`NO_RELEVANT_CONTENT`	O caso de não haver conteúdo relevante. O Google ignora a resposta se não existir conteúdo relevante nos resultados da pesquisa obtidos.
`JAIL_BREAKING_QUERY_IGNORED`	A consulta de desbloqueio ignorou as maiúsculas e minúsculas. Por exemplo, "Responde com o tom do CEO de uma empresa concorrente". O Google ignora a resposta se a consulta for classificada como uma consulta de jailbreak.
`CUSTOMER_POLICY_VIOLATION`	O registo de violação da política do cliente. A Google ignora o resumo se for detetada uma violação da política de clientes. A política é definida pelo cliente.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	A consulta que não procura respostas ignorou as maiúsculas/minúsculas. O Google ignora a resposta se a consulta não tiver uma intenção clara.
`LOW_GROUNDED_ANSWER`	O caso de resposta com base em factos. O Google ignora a resposta se não for possível gerar uma resposta bem fundamentada.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	A classificação de consultas definida pelo utilizador ignorou a capitalização. O Google ignora a resposta se a consulta for classificada como uma classificação de consulta definida pelo utilizador.
`UNHELPFUL_ANSWER`	O caso da resposta inútil. O Google ignora a resposta se esta não for útil. Isto pode dever-se a vários fatores, incluindo, entre outros: a consulta não tem resposta, a resposta não é relevante para a consulta ou a resposta não está bem formatada.

Citação

Informações de citação para um segmento.

Campos

start_index

int64

O índice indica o início do segmento, medido em bytes (Unicode UTF-8). Se existirem carateres de vários bytes,como carateres não ASCII, a medição do índice é superior ao comprimento da string.

end_index

int64

Fim do segmento atribuído, exclusivo. Medido em bytes (Unicode UTF-8). Se existirem carateres de vários bytes,como carateres não ASCII, a medição do índice é superior ao comprimento da string.

sources[]

CitationSource

Origens das citações para o segmento atribuído.

CitationSource

Fonte da citação.

Campos

reference_id

string

ID da origem da citação.

GroundingSupport

Fundamentação do apoio técnico para uma reivindicação em answer_text.

Campos
`start_index`	`int64` Obrigatório. O índice indica o início da reivindicação, medido em bytes (Unicode UTF-8).
`end_index`	`int64` Obrigatório. Fim da reivindicação, exclusivo.
`sources[]`	`CitationSource` Opcional. Origens das citações para a reivindicação.
`grounding_score`	`double` Uma pontuação no intervalo de [0, 1] que descreve o quão fundamentada está uma reivindicação específica pelas referências. Um valor mais elevado significa que a afirmação é mais bem suportada pelos fragmentos de referência.
`grounding_check_required`	`bool` Indica que esta reivindicação exigiu uma verificação de fundamentação. Quando o sistema decidiu que esta reivindicação não exigia uma verificação de atribuição/fundamentação, este campo é definido como falso. Nesse caso, não foi feita nenhuma verificação de fundamentação para a reivindicação e, por isso, `grounding_score`, `sources` não é devolvido.

QueryUnderstandingInfo

Informações de compreensão de consultas.

Campos

query_classification_info[]

Informações de classificação de consultas.

QueryClassificationInfo

Informações de classificação de consultas.

Campos

type

Type

Tipo de classificação de consulta.

positive

bool

Resultado da classificação.

Tipo

Tipos de classificação de consultas.

Enumerações
`TYPE_UNSPECIFIED`	Tipo de classificação de consulta não especificado.
`ADVERSARIAL_QUERY`	Tipo de classificação de consultas adversariais.
`NON_ANSWER_SEEKING_QUERY`	Tipo de classificação de consulta que não procura respostas, para conversas informais.
`JAIL_BREAKING_QUERY`	Tipo de classificação de consultas de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de classificação de consulta que não procura respostas, sem uma intenção clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de classificação de consulta definido pelo utilizador.

Referência

Referência.

Campos
Campo de união `content`. Conteúdo dos resultados da pesquisa. `content` só pode ser uma das seguintes opções:
`unstructured_document_info`	`UnstructuredDocumentInfo` Informações de documentos não estruturadas.
`chunk_info`	`ChunkInfo` Informações de blocos.
`structured_document_info`	`StructuredDocumentInfo` Informações estruturadas sobre documentos.

ChunkInfo

Informações de blocos.

Campos
`chunk`	`string` Nome do recurso do fragmento.
`content`	`string` Dividir o conteúdo textual em partes.
`document_metadata`	`DocumentMetadata` Metadados do documento.
`relevance_score`	`float` A relevância do fragmento para uma determinada consulta. Os valores variam entre 0,0 (completamente irrelevante) e 1,0 (completamente relevante). Este valor destina-se apenas a fins informativos. Pode mudar para a mesma consulta e bloco em qualquer altura devido a uma reciclagem do modelo ou a uma alteração na implementação.

DocumentMetadata

Metadados do documento.

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento.
`title`	`string` Título.
`page_identifier`	`string` Identificador da página.
`struct_data`	`Struct` Os metadados JSON estruturados do documento. É preenchido a partir dos dados estruturados do fragmento no resultado da pesquisa.

StructuredDocumentInfo

Informações de pesquisa estruturadas.

Campos
`document`	`string` Nome do recurso do documento.
`struct_data`	`Struct` Dados de pesquisa estruturados.
`title`	`string` Apenas saída. O título do documento.
`uri`	`string` Apenas saída. O URI do documento.

UnstructuredDocumentInfo

Informações de documentos não estruturadas.

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento.
`title`	`string` Título.
`chunk_contents[]`	`ChunkContent` Lista de conteúdos de fragmentos citados derivados do conteúdo do documento.
`struct_data`	`Struct` Os metadados JSON estruturados do documento. É preenchido a partir dos dados estruturados do fragmento no resultado da pesquisa.

ChunkContent

Dividir o conteúdo em partes.

Campos

content

string

Dividir o conteúdo textual em partes.

page_identifier

string

Identificador da página.

relevance_score

float

A relevância do fragmento para uma determinada consulta. Os valores variam entre 0,0 (completamente irrelevante) e 1,0 (completamente relevante). Este valor destina-se apenas a fins informativos. Pode mudar para a mesma consulta e bloco em qualquer altura devido a uma reciclagem do modelo ou a uma alteração na implementação.

Estado

Enumeração do estado da geração de respostas.

Enumerações
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	A geração de respostas está atualmente em curso.
`FAILED`	A geração de respostas falhou.
`SUCCEEDED`	A geração de respostas foi bem-sucedida.
`STREAMING`	A geração de respostas está atualmente em curso.

Passo

Informações sobre os passos.

Campos
`state`	`State` O estado do passo.
`description`	`string` A descrição do passo.
`thought`	`string` O pensamento do passo.
`actions[]`	`Action` Ações.

Ação

Ação.

Campos

observation

Observation

Observação.

Campo de união action. A ação. action só pode ser uma das seguintes opções:

search_action

SearchAction

Ação de pesquisa.

Observação

Observação.

Campos

search_results[]

SearchResult

Resultados da pesquisa observados pela ação de pesquisa. Podem ser informações de fragmentos ou informações de blocos, consoante o tipo de citação definido pelo utilizador.

SearchResult

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento.
`title`	`string` Título.
`snippet_info[]`	`SnippetInfo` Se citation_type for DOCUMENT_LEVEL_CITATION, preencha os fragmentos ao nível do documento.
`chunk_info[]`	`ChunkInfo` Se citation_type for CHUNK_LEVEL_CITATION e o modo de fragmento estiver ativado, preencha as informações do fragmento.
`struct_data`	`Struct` Representação de dados. Os dados JSON estruturados para o documento. É preenchido a partir dos dados estruturados do documento ou do fragmento no resultado da pesquisa.

ChunkInfo

Informações de blocos.

Campos

chunk

string

Nome do recurso do fragmento.

content

string

Dividir o conteúdo textual em partes.

relevance_score

float

SnippetInfo

Informações do fragmento.

Campos

snippet

string

Conteúdo do fragmento.

snippet_status

string

Estado do fragmento definido pela equipa de pesquisa.

SearchAction

Ação de pesquisa.

Campos

query

string

A consulta a pesquisar.

Estado

Enumeração do estado do passo.

Enumerações
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	O passo está atualmente em curso.
`FAILED`	O passo falhou atualmente.
`SUCCEEDED`	O passo foi concluído com êxito.

AnswerGenerationSpec

A especificação para a geração de respostas.

Campos

user_defined_classifier_spec

UserDefinedClassifierSpec

Opcional. A especificação da especificação do classificador especificada pelo utilizador.

UserDefinedClassifierSpec

A especificação do classificador definido pelo utilizador.

Campos
`enable_user_defined_classifier`	`bool` Opcional. Se deve ou não ativar e incluir o classificador definido pelo utilizador.
`preamble`	`string` Opcional. O preâmbulo a usar para o classificador definido pelo utilizador.
`model_id`	`string` Opcional. O ID do modelo a usar para o classificador definido pelo utilizador.
`task_marker`	`string` Opcional. O marcador de tarefa a usar para o classificador definido pelo utilizador.
`top_p`	`double` Opcional. O valor top-p a usar para o classificador definido pelo utilizador.
`top_k`	`int64` Opcional. O valor top-k a usar para o classificador definido pelo utilizador.
`temperature`	`double` Opcional. O valor de temperatura a usar para o classificador definido pelo utilizador.
`seed`	`int32` Opcional. O valor inicial a usar para o classificador definido pelo utilizador.

AnswerQueryRequest

Mensagem de pedido para o método ConversationalSearchService.AnswerQuery.

Campos
`serving_config`	`string` Obrigatório. O nome do recurso da configuração de publicação de anúncios de pesquisa, como `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` ou `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`. Este campo é usado para identificar o nome da configuração de publicação, o conjunto de modelos usados para fazer a pesquisa.
`query`	`Query` Obrigatório. Consulta do utilizador atual.
`session`	`string` O nome do recurso da sessão. Não é obrigatório. Quando o campo de sessão não está definido, a API está no modo sem sessão. Suportamos o modo de sessão automática: os utilizadores podem usar o símbolo de caráter universal `-` como ID da sessão. É gerado e atribuído automaticamente um novo ID.
`safety_spec`	`SafetySpec` Especificação do modelo.
`related_questions_spec`	`RelatedQuestionsSpec` Especificação de perguntas relacionadas.
`grounding_spec`	`GroundingSpec` Opcional. Especificação de superfície de referência.
`answer_generation_spec`	`AnswerGenerationSpec` Especificação de geração de respostas.
`search_spec`	`SearchSpec` Especificação de pesquisa.
`query_understanding_spec`	`QueryUnderstandingSpec` Especificação de compreensão de consultas.
`asynchronous_mode (deprecated)`	`bool` Este item foi descontinuado! Descontinuado: este campo foi descontinuado. A API Streaming Answer vai ser suportada. Controlo do modo assíncrono. Se estiver ativada, a resposta é devolvida com o nome do recurso de resposta/sessão sem a resposta final. Os utilizadores da API têm de fazer a sondagem para obter o estado mais recente da resposta/sessão chamando o método `ConversationalSearchService.GetAnswer` ou `ConversationalSearchService.GetSession`.
`user_pseudo_id`	`string` Um identificador exclusivo para acompanhar os visitantes. Por exemplo, isto pode ser implementado com um cookie HTTP, que deve ser capaz de identificar de forma exclusiva um visitante num único dispositivo. Este identificador exclusivo não deve ser alterado se o visitante iniciar ou terminar sessão no Website. Este campo NÃO deve ter um valor fixo, como `unknown_visitor`. O campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte o documento do Google Cloud para ver mais detalhes.
`end_user_spec`	`EndUserSpec` Opcional. Especificação do utilizador final.

AnswerGenerationSpec

Especificação de geração de respostas.

Campos
`model_spec`	`ModelSpec` Especificação do modelo de geração de respostas.
`prompt_spec`	`PromptSpec` Especificação do comando de geração de respostas.
`include_citations`	`bool` Especifica se devem ser incluídos metadados de citações na resposta. O valor predefinido é `false`.
`answer_language_code`	`string` Código do idioma para a resposta. Use etiquetas de idioma definidas pela norma BCP47. Nota: esta é uma funcionalidade experimental.
`ignore_adversarial_query`	`bool` Especifica se as consultas adversariais devem ser filtradas. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas adversariais. Não é devolvida nenhuma resposta se a consulta de pesquisa for classificada como uma consulta adversária. Por exemplo, um utilizador pode fazer uma pergunta sobre comentários negativos acerca da empresa ou enviar uma consulta concebida para gerar resultados inseguros que violem as políticas. Se este campo estiver definido como `true`, ignoramos a geração de respostas para consultas adversariais e devolvemos mensagens alternativas.
`ignore_non_answer_seeking_query`	`bool` Especifica se devem ser filtradas as consultas que não procuram respostas. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas que procuram respostas. Não é devolvida nenhuma resposta se a consulta de pesquisa for classificada como uma consulta que não procura respostas. Se este campo estiver definido como `true`, ignoramos a geração de respostas para consultas que não procuram respostas e devolvemos mensagens alternativas.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas de jailbreak. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um utilizador pode adicionar instruções à consulta para alterar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir ao modelo para agir como uma entidade diferente, por exemplo, "Responde no tom do CEO de uma empresa concorrente". Se este campo estiver definido como `true`, ignoramos a geração de resumos para consultas de jailbreak e devolvemos mensagens alternativas.
`ignore_low_relevant_content`	`bool` Especifica se devem ser filtradas consultas com baixa relevância. Se este campo estiver definido como `false`, todos os resultados da pesquisa são usados, independentemente da relevância, para gerar respostas. Se estiver definido como `true` ou não estiver definido, o comportamento é determinado automaticamente pelo serviço.

ModelSpec

Especificação do modelo de geração de respostas.

Campos

model_version

string

Versão do modelo. Se não estiver definido, usa o modelo estável predefinido. Os valores permitidos são: stable, preview.

PromptSpec

Especificação do comando de geração de respostas.

Campos

preamble

string

Preâmbulo personalizado.

EndUserSpec

Especificação do utilizador final.

Campos

end_user_metadata[]

EndUserMetaData

Opcional. Metadados do utilizador final.

EndUserMetaData

Metadados do utilizador final.

Campos

Campo de união content. Conteúdo dos resultados da pesquisa. content só pode ser uma das seguintes opções:

chunk_info

ChunkInfo

Informações de blocos.

ChunkInfo

Informações de blocos.

Campos

content

string

Dividir o conteúdo textual em partes. Tem um limite de 8000 carateres.

document_metadata

QueryClassificationSpec

Metadados do documento do fragmento atual.

DocumentMetadata

Os metadados do documento contêm as informações do documento do fragmento atual.

Campos

title

string

Título do documento.

GroundingSpec

Especificação de superfície de referência.

Campos

include_grounding_supports

bool

Opcional. Especifica se deve incluir grounding_supports na resposta. O valor predefinido é false.

Quando este campo está definido como true, a resposta devolvida tem grounding_score e contém GroundingSupports para cada reivindicação.

filtering_level

FilteringLevel

Opcional. Especifica se a filtragem deve ser ativada com base na pontuação de fundamentação e a que nível.

FilteringLevel

Nível de filtragem com base na fundamentação das respostas.

Enumerações
`FILTERING_LEVEL_UNSPECIFIED`	A predefinição é nenhum filtro
`FILTERING_LEVEL_LOW`	Filtre as respostas com base num limite baixo.
`FILTERING_LEVEL_HIGH`	Filtre as respostas com base num limite elevado.

QueryUnderstandingSpec

Especificação de compreensão de consultas.

Campos

query_classification_spec

Especificação de classificação de consultas.

query_rephraser_spec

QueryRephraserSpec

Especificação do reformulador de consultas.

disable_spell_correction

bool

Opcional. Se pretende desativar a correção ortográfica. O valor predefinido é false.

QueryClassificationSpec

Especificação de classificação de consultas.

Campos

types[]

Type

Tipos de classificação de consultas ativados.

Tipo

Tipos de classificação de consultas.

Enumerações
`TYPE_UNSPECIFIED`	Tipo de classificação de consulta não especificado.
`ADVERSARIAL_QUERY`	Tipo de classificação de consultas adversariais.
`NON_ANSWER_SEEKING_QUERY`	Tipo de classificação de consulta que não procura respostas, para conversas informais.
`JAIL_BREAKING_QUERY`	Tipo de classificação de consultas de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de classificação de consulta que não procura respostas, sem uma intenção clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de classificação de consulta definido pelo utilizador.

QueryRephraserSpec

Especificação do reformulador de consultas.

Campos

disable

bool

Desative a reformulação de consultas.

max_rephrase_steps

int32

Número máximo de passos de reformulação. O número máximo é de 5 passos. Se não for definido ou for definido como < 1, é definido como 1 por predefinição.

model_spec

ModelSpec

Opcional. Especificação do modelo de reformulação de consultas.

ModelSpec

Especificação do modelo de reformulação de consultas.

Campos

model_type

ModelType

Opcional. Tipo de modelo de reformulação de consultas ativado. Se não estiver definido, é usado LARGE por predefinição.

ModelType

Tipos de reformulação de consultas. Atualmente, só suporta seleções de modelos de salto único (max_rephrase_steps = 1). Para vários passos (max_rephrase_steps > 1), existe apenas um modelo predefinido.

Enumerações
`MODEL_TYPE_UNSPECIFIED`	Tipo de modelo não especificado.
`SMALL`	Modelo de reformulação de consultas pequeno. Modelo Gemini 1.0 XS.
`LARGE`	Modelo de reformulação de consultas grande. Modelo Gemini 1.0 Pro.

RelatedQuestionsSpec

Especificação de perguntas relacionadas.

Campos

enable

bool

Ativa a funcionalidade de perguntas relacionadas se for verdadeiro.

SafetySpec

Especificação de segurança. Existem dois exemplos de utilização: 1. Quando apenas safety_spec.enable está definido, o limite BLOCK_LOW_AND_ABOVE é aplicado a todas as categorias. 2. Quando safety_spec.enable está definido e algumas safety_settings estão definidas, apenas as safety_settings especificadas são aplicadas.

Campos

enable

bool

Ative a filtragem de segurança na resposta. É falso por predefinição.

safety_settings[]

SafetySetting

Opcional. Definições de segurança. Estas definições só são eficazes quando safety_spec.enable é verdadeiro.

SafetySetting

Definições de segurança.

Campos

category

HarmCategory

Obrigatório. Categoria de danos.

threshold

HarmBlockThreshold

Obrigatório. O limiar de bloqueio de danos.

HarmBlockThreshold

Níveis de limiares baseados na probabilidade para bloqueio.

Enumerações
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Limite de bloqueio de danos não especificado.
`BLOCK_LOW_AND_ABOVE`	Bloquear limite baixo e superior (ou seja, bloquear mais).
`BLOCK_MEDIUM_AND_ABOVE`	Bloquear limite médio e superior.
`BLOCK_ONLY_HIGH`	Bloquear apenas o limite elevado (ou seja, bloquear menos).
`BLOCK_NONE`	Não bloquear nada.
`OFF`	Desative o filtro de segurança.

SearchSpec

Especificação de pesquisa.

Campos

Campo de união input. Parâmetros de pesquisa para controlar o comportamento da pesquisa. Em alternativa, forneça uma lista de resultados da pesquisa para gerar uma resposta. input só pode ser uma das seguintes opções:

search_params

SearchParams

Parâmetros de pesquisa.

search_result_list

SearchResultList

Lista de resultados da pesquisa.

SearchParams

Parâmetros de pesquisa.

Campos
`max_return_results`	`int32` Número de resultados de pesquisa a devolver. O valor predefinido é 10.
`filter`	`string` A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas. Isto é usado para filtrar os resultados da pesquisa, o que pode afetar a resposta da resposta. Se este campo não for reconhecível, é devolvido um `INVALID_ARGUMENT`. A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "nome" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")' Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar
`boost_spec`	`BoostSpec` Especificação de reforço para reforçar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta à consulta de resposta. Para mais informações sobre o aumento, consulte o artigo Aumentar
`order_by`	`string` A ordem pela qual os documentos são devolvidos. Os documentos podem ser ordenados por um campo num objeto `Document`. Deixe-o não definido se a ordenação for por relevância. A expressão `order_by` é sensível a maiúsculas e minúsculas. Para mais informações sobre como fazer encomendas, consulte o artigo Fazer encomendas Se este campo não for reconhecível, é devolvido um `INVALID_ARGUMENT`.
`search_result_mode`	`SearchResultMode` Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para `DOCUMENTS`. Consulte o artigo Analise e divida documentos em partes
`data_store_specs[]`	`DataStoreSpec` Especificações que definem os dataStores a filtrar numa chamada de pesquisa e as configurações desses dataStores. Isto só é considerado para motores com o exemplo de utilização de várias lojas de dados. Para um único dataStore num motor, devem usar as especificações ao nível superior.

SearchResultList

Lista de resultados da pesquisa.

Campos

search_results[]

SearchResult

Resultados da pesquisa.

SearchResult

Resultado da pesquisa.

Campos

Campo de união content. Conteúdo dos resultados da pesquisa. content só pode ser uma das seguintes opções:

unstructured_document_info

UnstructuredDocumentInfo

Informações de documentos não estruturadas.

chunk_info

ChunkInfo

Informações de blocos.

ChunkInfo

Informações de blocos.

Campos

chunk

string

Nome do recurso do fragmento.

content

string

Dividir o conteúdo textual em partes.

document_metadata

Metadados do documento do fragmento atual.

DocumentMetadata

Os metadados do documento contêm as informações do documento do fragmento atual.

Campos

uri

string

URI do documento.

title

string

Título do documento.

UnstructuredDocumentInfo

Informações de documentos não estruturadas.

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento.
`title`	`string` Título.
`document_contexts[]`	`DocumentContext` Lista de contextos de documentos. O conteúdo vai ser usado para a geração de respostas. Este deve ser o conteúdo principal do documento, que pode ser longo e abrangente.
`extractive_segments[]`	`ExtractiveSegment` Lista de segmentos extrativos.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` Este item foi descontinuado! Obsoleto: este campo está obsoleto e não tem efeito na geração de respostas. Use os campos document_contexts e extractive_segments. Lista de respostas extrativas.

DocumentContext

Contexto do documento.

Campos

page_identifier

string

Identificador da página.

content

string

Conteúdo do documento a usar para a geração de respostas.

ExtractiveAnswer

Resposta extrativa. Guia

Campos

page_identifier

string

Identificador da página.

content

string

Conteúdo de resposta extrativo.

ExtractiveSegment

Segmento extrativo. A geração de respostas do guia só a usa se document_contexts estiver vazio. Estes devem ser fragmentos mais curtos.

Campos

page_identifier

string

Identificador da página.

content

string

Conteúdo de segmentos extrativos.

AnswerQueryResponse

Mensagem de resposta para o método ConversationalSearchService.AnswerQuery.

Campos

answer

Answer

Objeto de recurso de resposta. Se AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps for superior a 1, use Answer.name para obter informações de respostas através da API ConversationalSearchService.GetAnswer.

session

PolicyEnforcementResult

Objeto de recurso de sessão. Só está disponível quando o campo de sessão está definido e é válido no pedido AnswerQueryRequest.

answer_query_token

string

Um ID exclusivo global usado para registo.

AssistAnswer

Recurso AssistAnswer, parte principal de AssistResponse.

Campos
`name`	`string` Imutável. Identificador. Nome do recurso do `AssistAnswer`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
`state`	`State` Estado da geração de respostas.
`replies[]`	`Reply` Respostas do assistente.
`assist_skipped_reasons[]`	`AssistSkippedReason` Motivos para não atender a chamada de assistência.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Opcional. O campo contém informações sobre os resultados das várias verificações de políticas, como as expressões proibidas ou as verificações do Model Armor. Este campo é preenchido apenas se a chamada assistida tiver sido ignorada devido a uma violação de política.

AssistSkippedReason

Possíveis motivos para não atender uma chamada de assistência.

Enumerações
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Valor predefinido. O motivo da omissão não está especificado.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	O assistente ignorou a consulta porque não parecia estar à procura de uma resposta.
`CUSTOMER_POLICY_VIOLATION`	O assistente ignorou a consulta ou recusou-se a responder devido a uma violação da política do cliente (por exemplo, a consulta ou a resposta continham uma expressão proibida).

CustomerPolicyEnforcementResult

Resultados da aplicação da política do cliente. Contém os resultados das várias verificações de políticas, como as expressões proibidas ou as verificações do Model Armor.

Campos

verdict

Verdict

Veredicto final da aplicação da política de clientes. Se apenas uma política tiver bloqueado o processamento, o veredito é BLOCK.

policy_results[]

Resultados da aplicação da política do cliente. Preenchido apenas se a chamada de assistência tiver sido ignorada devido a uma violação de política. Contém resultados desses filtros que bloquearam o processamento da consulta.

BannedPhraseEnforcementResult

Resultado da aplicação da política de clientes para a política de frases proibidas.

Campos

banned_phrases[]

string

As expressões proibidas que foram encontradas na consulta ou na resposta.

ModelArmorEnforcementResult

Resultado da aplicação da política do cliente para a política Model Armor.

Campos

Campo de união result. O resultado da política Model Armor. result só pode ser uma das seguintes opções:

model_armor_violation

string

A violação do Model Armor que foi encontrada.

error

BannedPhraseEnforcementResult

O erro devolvido pelo Model Armor se a aplicação de políticas falhar por algum motivo.

PolicyEnforcementResult

Resultado da aplicação da política do cliente para um único tipo de política.

Campos

Campo de união enforcement_result. O resultado específico do tipo de política. Pode ser um erro ou informações detalhadas sobre o resultado da aplicação de políticas. enforcement_result só pode ser uma das seguintes opções:

banned_phrase_enforcement_result

O resultado da aplicação da política para a política de expressões proibidas.

model_armor_enforcement_result

ModelArmorEnforcementResult

O resultado da aplicação da política Model Armor.

Veredito

O veredito da aplicação da política do cliente.

Enumerações
`UNSPECIFIED`	Valor desconhecido.
`ALLOW`	Não houve violação de política.
`BLOCK`	O processamento foi bloqueado pela política do cliente.

Responder

Uma parte da resposta multipartes da chamada de assistência.

Campos

Campo de união reply. Alternativas para a resposta do assistente. reply só pode ser uma das seguintes opções:

grounded_content

AssistantGroundedContent

Texto ou conteúdo multimédia de resposta possivelmente fundamentado do assistente.

Estado

Estado da geração de respostas.

Enumerações
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	A operação de assistência está atualmente em curso.
`FAILED`	A operação de assistência falhou.
`SUCCEEDED`	A operação de assistência foi bem-sucedida.
`SKIPPED`	A operação de assistência foi ignorada.

AssistRequest

Pedido para o método AssistantService.Assist.

Campos
`name`	`string` Obrigatório. O nome do recurso de `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta do utilizador atual. A consulta vazia só é suportada se forem fornecidos `file_ids`. Neste caso, a resposta é gerada com base nesses ficheiros de contexto.
`session`	`string` Opcional. A sessão a usar para o pedido. Se for especificado, o assistente tem acesso ao histórico da sessão, e a consulta e a resposta são armazenadas aí. Se `-` for especificado como o ID da sessão ou for deixado em branco, é criada uma nova sessão com um ID gerado automaticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` Opcional. Determina os casos em que o assistente não responde à consulta. Se a resposta for ignorada, os motivos são apresentados em `AssistAnswer.assist_skipped_reasons` no prazo de `AssistResponse.answer`.
`file_ids[]`	`string` Opcional. Os IDs dos ficheiros a usar para responder ao pedido. Quando carrega um ficheiro, o respetivo ID é devolvido em `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Opcional. Informações sobre o utilizador que inicia a consulta.

AssistSkippingMode

Comportamentos de ignorar disponíveis para pedidos de assistência.

Enumerações
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Valor predefinido. A resposta pode ser ignorada se a consulta não estiver a pedir assistência.
`REQUEST_ASSIST`	Pedir resposta ao Assistente. A resposta pode continuar a ser ignorada se a consulta falhar nas verificações de políticas.

AssistResponse

Resposta para o método AssistantService.Assist.

Campos

answer

AssistAnswer

O recurso AssistAnswer gerado em resposta à consulta.

session_info

SessionInfo

Informações da sessão.

assist_token

string

Um ID exclusivo global que identifica o par pedido-resposta atual. Usado para feedback e apoio técnico.

SessionInfo

Informações sobre a sessão.

Campos

session

string

Nome da sessão recém-gerada ou continuada.

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

query_id

string

ID da consulta que corresponde a esta chamada API Assist. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e este ID da consulta na chamada da API Assist, o pedido de assistência ocorre no contexto dos resultados da pesquisa desta chamada de pesquisa.

AssistUserMetadata

Metadados do utilizador do pedido.

Campos

time_zone

string

Opcional. Fuso horário da IANA, por exemplo, Europe/Budapest.

preferred_language_code

string

Opcional. Idioma preferido a usar para responder se a deteção de idioma falhar. Também usado como o idioma das mensagens de erro criadas por ações, independentemente dos resultados da deteção de idioma.

Assistente

Recurso do assistente do Discovery Engine.

Campos
`name`	`string` Imutável. Nome do recurso do assistente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` Tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
`display_name`	`string` Obrigatório. O nome a apresentar do assistente. Tem de ser uma string codificada em UTF-8 com um limite de 128 carateres.
`description`	`string` Opcional. Descrição para informações adicionais. Espera-se que seja apresentado na IU de configuração e não aos utilizadores do assistente.
`generation_config`	`GenerationConfig` Opcional. Configuração para a geração da resposta do assistente.
`google_search_grounding_enabled (deprecated)`	`bool` Este item foi descontinuado! Opcional. Descontinuado. Em alternativa, use `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Opcional. O tipo de baseamento na Web a usar.
`enabled_actions (deprecated)`	`map<string, ActionList>` Este item foi descontinuado! Opcional. Descontinuado: vai ser substituído por `enabled_tools`. As ações ativadas neste assistente. As chaves são o nome do conetor, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Os valores consistem em ações ativadas pelo administrador em relação à instância do conetor. O administrador pode ativar seletivamente várias ações em qualquer uma das instâncias do conetor que criou no projeto. Por exemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Opcional. Nota: ainda não implementado. Em alternativa, use `enabled_actions`. As ferramentas ativadas neste assistente. As chaves são o nome do conetor, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector. Os valores consistem em ferramentas ativadas pelo administrador em relação à instância do conetor. O administrador pode ativar seletivamente várias ferramentas em qualquer uma das instâncias do conetor que criou no projeto. Por exemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Opcional. Política do cliente para o assistente.

ActionInfo

Descontinuado: vai ser substituído por ToolInfo. Informações para identificar uma ação.

Campos

action_name

string

O nome da ação, conforme definido por DataConnectorService.QueryAvailableActions.

action_display_name

string

O nome a apresentar da ação.

ActionList

Descontinuado: vai ser substituído por ToolList. As ações ativadas num conetor

Campos

action_info[]

ActionInfo

A lista de ações com as informações de ações correspondentes.

CustomerPolicy

Política definida pelo cliente para o assistente.

Campos

banned_phrases[]

BannedPhrase

Opcional. Lista de expressões proibidas.

model_armor_config

ModelArmorConfig

Opcional. Configuração do Model Armor a ser usada para proteger as instruções do utilizador e as respostas do assistente.

BannedPhrase

Definição de uma expressão proibida definida pelo cliente. Não é permitido que uma expressão proibida apareça na consulta do utilizador ou na resposta do MDG, caso contrário, a resposta é recusada.

Campos

phrase

string

Obrigatório. O conteúdo da string não processada a ser banido.

match_type

BannedPhraseMatchType

Opcional. Tipo de correspondência da expressão proibida.

ignore_diacritics

bool

Opcional. Se for verdadeiro, as marcas diacríticas (por exemplo, acentos, trema) são ignoradas quando são encontradas frases proibidas. Por exemplo, "cafe" corresponderia a "café".

BannedPhraseMatchType

O método de correspondência da expressão proibida.

Enumerações
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	A predefinição é SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	A expressão proibida corresponde se for encontrada em qualquer parte do texto como uma substring exata.
`WORD_BOUNDARY_STRING_MATCH`	A expressão proibida só corresponde se o padrão encontrado no texto estiver rodeado por delimitadores de palavras. A própria expressão pode continuar a conter delimitadores de palavras.

ModelArmorConfig

Configuração de modelos do Model Armor definidos pelo cliente para serem usados na higienização de comandos do utilizador e respostas do assistente.

Campos

user_prompt_template

string

Opcional. O nome do recurso do modelo do Armor para limpar os comandos do utilizador. Formato: projects/{project}/locations/{location}/templates/{template_id}

Se não for especificado, não é aplicada nenhuma higienização ao comando do utilizador.

response_template

string

Opcional. O nome do recurso do modelo Armor para limpar as respostas do assistente. Formato: projects/{project}/locations/{location}/templates/{template_id}

Se não for especificado, não é aplicada nenhuma higienização à resposta do assistente.

failure_mode

FailureMode

Opcional. Define o modo de falha para a higienização do Model Armor.

FailureMode

Determina o comportamento quando o Model Armor não consegue processar um pedido.

Enumerações
`FAILURE_MODE_UNSPECIFIED`	Modo de falha não especificado. O comportamento predefinido é `FAIL_CLOSED`.
`FAIL_OPEN`	Em caso de falha de processamento do Model Armor, o pedido pode prosseguir sem alterações.
`FAIL_CLOSED`	Em caso de falha no processamento do Model Armor, o pedido é rejeitado.

GenerationConfig

Configuração para a geração da resposta do assistente.

Campos

system_instruction

SystemInstruction

Instrução do sistema, também conhecida como preâmbulo do comando para chamadas de MDIs. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

O idioma predefinido a usar para a geração da resposta do assistente. Use um código de idioma ISO 639-1, como en. Se não for especificado, o idioma é detetado automaticamente.

SystemInstruction

Instrução do sistema, também conhecida como preâmbulo do comando para chamadas de MDIs.

Campos

additional_system_instruction

string

Opcional. Instrução adicional do sistema que vai ser adicionada à instrução do sistema predefinida.

ToolInfo

Informações para identificar uma ferramenta.

Campos

tool_name

string

O nome da ferramenta, conforme definido por DataConnectorService.QueryAvailableActions. Nota: está a usar action nas APIs DataConnectorService, mas são iguais a tool aqui.

tool_display_name

string

O nome a apresentar da ferramenta.

ToolList

As ferramentas ativadas num conetor

Campos

tool_info[]

ToolInfo

A lista de ferramentas com as informações correspondentes.

WebGroundingType

O tipo de baseamento na Web a usar.

Enumerações
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Predefinição, definição não especificada. Isto é o mesmo que desativado.
`WEB_GROUNDING_TYPE_DISABLED`	A verificação da Web está desativada.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	A fundamentação com a Pesquisa Google está ativada.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	A fundamentação com a pesquisa Web empresarial está ativada.

AssistantContent

Conteúdo multimodal.

Campos
`role`	`string` O produtor do conteúdo. Pode ser "model" ou "user".
`thought`	`bool` Opcional. Indica se a parte foi gerada pelo modelo.
Campo de união `data`. Dados contidos. `data` só pode ser uma das seguintes opções:
`text`	`string` Texto inline.
`inline_data`	`Blob` Dados binários inline.
`file`	`File` Um ficheiro, por exemplo, um resumo de áudio.
`executable_code`	`ExecutableCode` Código gerado pelo modelo que se destina a ser executado.
`code_execution_result`	`CodeExecutionResult` Resultado da execução de um ExecutableCode.

Blob

Blob inline.

Campos

mime_type

string

Obrigatório. O tipo de suporte (tipo MIME) dos dados gerados.

data

bytes

Obrigatório. Bytes não processados.

CodeExecutionResult

Resultado da execução de ExecutableCode.

Campos

outcome

Outcome

Obrigatório. Resultado da execução do código.

output

string

Opcional. Contém stdout quando a execução do código é bem-sucedida, stderr ou outra descrição caso contrário.

Resultado

Enumeração dos possíveis resultados da execução do código.

Enumerações
`OUTCOME_UNSPECIFIED`	Estado não especificado. Este valor não deve ser usado.
`OUTCOME_OK`	A execução do código foi concluída com êxito.
`OUTCOME_FAILED`	A execução de código foi concluída, mas com uma falha. `stderr` deve conter o motivo.
`OUTCOME_DEADLINE_EXCEEDED`	A execução do código foi executada durante demasiado tempo e foi cancelada. Pode ou não estar presente um resultado parcial.

ExecutableCode

Código gerado pelo modelo que se destina a ser executado pelo modelo.

Campos

code

string

Obrigatório. O conteúdo do código. Atualmente, só é compatível com Python.

Ficheiro

Um ficheiro, por exemplo, um resumo de áudio.

Campos

mime_type

string

Obrigatório. O tipo de suporte (tipo MIME) do ficheiro.

file_id

string

Obrigatório. O ID do ficheiro.

AssistantGroundedContent

Um conteúdo e, possivelmente, as respetivas informações de base.

Nem todo o conteúdo precisa de fundamentação. As expressões como "Claro que sim. Vou pesquisar isso para si." não precisam de fundamentação.

Campos
`content`	`AssistantContent` O conteúdo.
`citation_metadata`	`CitationMetadata` Atribuição da origem do conteúdo gerado. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
`content_metadata`	`ContentMetadata` Opcional. Metadados do conteúdo. Atualmente, só é usado para respostas de assistentes de investigação.
Campo de união `metadata`. Metadados de fundamentação para vários modais. Por agora, só suporta texto. `metadata` só pode ser uma das seguintes opções:
`text_grounding_metadata`	`TextGroundingMetadata` Metadados para fundamentação com base em fontes de texto.

ContentMetadata

Metadados do conteúdo.

Campos

content_kind

ContentKind

Tipo de conteúdo. Mostra a que parte da resposta do assistente de pesquisa este conteúdo pertence.

content_id

string

ID do conteúdo. É usado para associar perguntas de pesquisa a respostas. Por exemplo, as partes da resposta a uma pergunta de investigação têm o mesmo content_id que a pergunta.

ContentKind

Possíveis tipos de conteúdo. Atualmente, só é usado para diferenciar secções na resposta completa de um assistente de investigação.

Enumerações
`CONTENT_KIND_UNSPECIFIED`	Desconhecido.
`RESEARCH_PLAN`	Plano de investigação.
`RESEARCH_QUESTION`	Pergunta de pesquisa.
`RESEARCH_ANSWER`	Pesquisar resposta.
`RESEARCH_REPORT`	Relatório de investigação.
`RESEARCH_AUDIO_SUMMARY`	Resumo do áudio da investigação.

TextGroundingMetadata

Detalhes de fundamentação para fontes de texto.

Campos

segments[]

Segment

Informações de fundamentação para partes do texto.

references[]

Reference

Referências para o texto fundamentado.

Referência

Conteúdo referenciado e metadados de documentos relacionados.

Campos

content

string

Conteúdo de texto referenciado.

document_metadata

Metadados do documento.

DocumentMetadata

Metadados do documento.

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento. Pode conter um URL que redireciona para o Website real.
`title`	`string` Título.
`page_identifier`	`string` Identificador da página.
`domain`	`string` Nome do domínio do URI do documento. Tenha em atenção que o campo `uri` pode conter um URL que redireciona para o Website real. Neste caso, contém o nome do domínio do site de destino.
`mime_type`	`string` O tipo MIME do documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

Segmento

Informações de fundamentação para um segmento do texto.

Campos
`start_index`	`int64` Índice baseado em zero que indica o início do segmento, medido em bytes de uma string UTF-8 (ou seja, os carateres codificados em vários bytes têm um comprimento superior a um).
`end_index`	`int64` Fim do segmento, exclusivo.
`reference_indices[]`	`int32` Referências para o segmento.
`grounding_score`	`float` Pontuação do segmento.
`text`	`string` O próprio segmento de texto.

BAPConfig

A configuração do conetor BAP.

Campos

supported_connector_modes[]

ConnectorMode

Obrigatório. Os modos de conector suportados para a ligação BAP associada.

enabled_actions[]

string

Opcional. As ações ativadas na associação BAP associada.

ConnectorMode

Exemplos de utilização suportados por este conetor BAP.

Enumerações
`CONNECTOR_MODE_UNSPECIFIED`	Modo do conetor não especificado.
`DATA_INGESTION`	Conetor usado para a obtenção de dados.
`ACTIONS`	Conetor usado para ações
`END_USER_AUTHENTICATION`	Conetor usado para a autenticação do utilizador final.

BatchCreateTargetSiteMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.BatchCreateTargetSites. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

CreateTargetSiteRequest

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

BatchCreateTargetSitesRequest

Mensagem de pedido para o método SiteSearchEngineService.BatchCreateTargetSites.

Campos

parent

string

Obrigatório. O recurso principal partilhado por todos os TargetSites que estão a ser criados. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. O campo principal nas mensagens CreateBookRequest tem de estar vazio ou corresponder a este campo.

requests[]

Obrigatório. A mensagem de pedido que especifica os recursos a criar. É possível criar um máximo de 20 TargetSites num lote.

BatchCreateTargetSitesResponse

Mensagem de resposta para o método SiteSearchEngineService.BatchCreateTargetSites.

Campos

target_sites[]

TargetSites created.

BatchGetDocumentsMetadataRequest

Mensagem de pedido para o método DocumentService.BatchGetDocumentsMetadata.

Campos

parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Obrigatório. Matcher para os Documents.

FhirMatcher

Matcher para os Documents por nomes de recursos FHIR.

Campos

fhir_resources[]

string

Obrigatório. Os recursos FHIR a fazer corresponder. Formato: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Encontrar correspondências

Matcher para os Documents. Atualmente, suporta a correspondência por URIs exatos.

Campos

Campo de união matcher. Matcher para os Documents. matcher só pode ser uma das seguintes opções:

uris_matcher

UrisMatcher

Correspondência por URIs exatos.

fhir_matcher

FhirMatcher

Corresponde por nomes de recursos FHIR.

UrisMatcher

Matcher para os Documents por URIs exatos.

Campos

uris[]

string

Os URIs exatos a corresponder.

BatchGetDocumentsMetadataResponse

Mensagem de resposta para o método DocumentService.BatchGetDocumentsMetadata.

Campos

documents_metadata[]

Os metadados dos Documents.

DocumentMetadata

Os metadados de um Document.

Campos
`matcher_value`	`MatcherValue` O valor do motor de correspondência que foi usado para fazer corresponder o `Document`.
`state`	`State` O estado do documento.
`last_refreshed_time`	`Timestamp` A data/hora da última indexação do `Document`.
`data_ingestion_source`	`string` A origem do carregamento de dados do `Document`. Os valores permitidos são: `batch`: dados carregados através da API Batch, por exemplo, ImportDocuments. `streaming` Dados carregados através da API Streaming, por exemplo: Streaming FHIR.

MatcherValue

O valor do motor de correspondência que foi usado para fazer corresponder o Document.

Campos

Campo de união matcher_value. O valor do motor de correspondência que foi usado para fazer corresponder o Document. matcher_value só pode ser uma das seguintes opções:

uri

string

Se a correspondência for por URI, o URI do Document.

fhir_resource

string

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

Estado

O estado do Document.

Enumerações
`STATE_UNSPECIFIED`	Nunca deve ser definido.
`INDEXED`	A `Document` está indexada.
`NOT_IN_TARGET_SITE`	O elemento `Document` não está indexado porque o respetivo URI não está no elemento `TargetSite`.
`NOT_IN_INDEX`	A `Document` não está indexada.

BatchUpdateUserLicensesMetadata

Metadados relacionados com o progresso da operação UserLicenseService.BatchUpdateUserLicenses. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` A contagem de licenças de utilizador foi atualizada com êxito.
`failure_count`	`int64` Número de licenças de utilizador cuja atualização falhou.

BatchUpdateUserLicensesRequest

Mensagem de pedido para o método UserLicenseService.BatchUpdateUserLicenses.

Campos
`parent`	`string` Obrigatório. O nome do recurso [UserStore][] principal, formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Opcional. Se for verdadeiro, se as licenças de utilizador removidas tiverem uma configuração de licença associada, a licença de utilizador é eliminada. Por predefinição, que é falso, a licença do utilizador é atualizada para o estado não atribuído.
Campo de união `source`. Obrigatório. A origem da entrada. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para incorporações de documentos.

InlineSource

A origem inline da configuração de entrada para o método BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

Obrigatório. Uma lista de licenças de utilizador a atualizar. Cada licença de utilizador tem de ter um UserLicense.user_principal válido.

update_mask

Opcional. A lista de campos a atualizar.

BatchUpdateUserLicensesResponse

Mensagem de resposta para o método UserLicenseService.BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

UserLicenses atualizadas com êxito.

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

BatchVerifyTargetSitesMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.BatchVerifyTargetSites. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

BatchVerifyTargetSitesRequest

Mensagem de pedido para o método SiteSearchEngineService.BatchVerifyTargetSites.

Campos

parent

string

Obrigatório. O recurso principal partilhado por todos os TargetSites que estão a ser validados. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Este tipo não tem campos.

Mensagem de resposta para o método SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

Origem do BigQuery a partir da qual importar dados.

Campos
`project_id`	`string` O ID do projeto ou o número do projeto que contém a origem do BigQuery. Tem um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`dataset_id`	`string` Obrigatório. O conjunto de dados do BigQuery a partir do qual copiar os dados,com um limite de comprimento de 1024 carateres.
`table_id`	`string` Obrigatório. A tabela do BigQuery a partir da qual copiar os dados,com um limite de comprimento de 1024 carateres.
`gcs_staging_dir`	`string` Diretório do Cloud Storage intermédio usado para a importação com um limite de comprimento de 2000 carateres. Pode ser especificado se quiser que a exportação do BigQuery seja feita para um diretório específico do Cloud Storage.
`data_schema`	`string` O esquema a usar quando analisar os dados da origem. Valores suportados para importações de eventos de utilizadores: `user_event` (predefinição): um `UserEvent` por linha. Valores suportados para importações de documentos: `document` (predefinição): um formato `Document` por linha. Cada documento tem de ter um `Document.id` válido e um de `Document.json_data` ou `Document.struct_data`. `custom`: um dado personalizado por linha num formato arbitrário que esteja em conformidade com o `Schema` definido da base de dados. Só pode ser usado pelo vertical da loja de dados GENERIC.
Campo de união `partition`. Informações de partição da tabela do BigQuery. Deixe este campo vazio se a tabela do BigQuery não estiver particionada. `partition` só pode ser uma das seguintes opções:
`partition_date`	`Date` _PARTITIONDATE da tabela particionada por tempo do BigQuery no formato AAAA-MM-DD.

BigtableOptions

O objeto Bigtable Options que contém informações para suportar a importação.

Campos

key_field_name

string

O nome do campo usado para guardar o valor da chave da linha no documento. O nome tem de corresponder ao padrão [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map<string, BigtableColumnFamily>

O mapeamento de nomes de famílias para um objeto que contém informações ao nível das famílias de colunas para a família de colunas especificada. Se uma família não estiver presente neste mapa, é ignorada.

BigtableColumn

A coluna do Bigtable.

Campos
`qualifier`	`bytes` Obrigatório. Qualificador da coluna. Se não for possível descodificá-lo com utf-8, use uma string codificada em base-64.
`field_name`	`string` O nome do campo a usar para esta coluna no documento. O nome tem de corresponder ao padrão `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se não estiver definido, é analisado a partir dos bytes do qualificador com base no melhor esforço. No entanto, devido a diferentes padrões de nomenclatura, podem ocorrer colisões de nomes de campos, em que o comportamento de análise é indefinido.
`encoding`	`Encoding` O modo de codificação dos valores quando o tipo não é `STRING`. Os valores de codificação aceitáveis são: `TEXT`: indica que os valores são strings de texto alfanuméricas. `BINARY`: indica que os valores são codificados através da família de funções `HBase Bytes.toBytes`. Pode substituir esta definição para uma coluna específica ao listar essa coluna em `columns` e especificar uma codificação para a mesma.
`type`	`Type` O tipo de valores nesta família de colunas. Espera-se que os valores sejam codificados através da função `HBase Bytes.toBytes` quando o valor de codificação estiver definido como `BINARY`.

BigtableColumnFamily

A família de colunas do Bigtable.

Campos
`field_name`	`string` O nome do campo a usar para esta família de colunas no documento. O nome tem de corresponder ao padrão `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se não estiver definido, é analisado a partir do nome da família com o melhor esforço. No entanto, devido a diferentes padrões de nomenclatura, podem ocorrer colisões de nomes de campos, em que o comportamento de análise é indefinido.
`encoding`	`Encoding` O modo de codificação dos valores quando o tipo não é STRING. Os valores de codificação aceitáveis são: `TEXT`: indica que os valores são strings de texto alfanuméricas. `BINARY`: indica que os valores são codificados através da família de funções `HBase Bytes.toBytes`. Pode substituir esta definição para uma coluna específica ao listar essa coluna em `columns` e especificar uma codificação para a mesma.
`type`	`Type` O tipo de valores nesta família de colunas. Espera-se que os valores sejam codificados através da função `HBase Bytes.toBytes` quando o valor de codificação estiver definido como `BINARY`.
`columns[]`	`BigtableColumn` A lista de objetos que contém informações ao nível da coluna para cada coluna. Se uma coluna não estiver presente nesta lista, é ignorada.

Codificação

O modo de codificação de uma coluna ou de uma família de colunas do Bigtable.

Enumerações
`ENCODING_UNSPECIFIED`	A codificação não está especificada.
`TEXT`	Codificação de texto.
`BINARY`	Codificação binária.

Tipo

O tipo de valores numa coluna ou família de colunas do Bigtable. Espera-se que os valores sejam codificados através da função HBase Bytes.toBytes quando o valor de codificação estiver definido como BINARY.

Enumerações
`TYPE_UNSPECIFIED`	O tipo não foi especificado.
`STRING`	Tipo de string.
`NUMBER`	Tipo numérico.
`INTEGER`	Tipo de número inteiro.
`VAR_INTEGER`	Tipo de número inteiro de comprimento variável.
`BIG_NUMERIC`	Tipo BigDecimal.
`BOOLEAN`	Tipo booleano.
`JSON`	Tipo JSON.

BigtableSource

A origem do Cloud Bigtable para importar dados.

Campos
`project_id`	`string` O ID do projeto que contém a origem do Bigtable. Tem um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`instance_id`	`string` Obrigatório. O ID da instância do Cloud Bigtable que tem de ser importada.
`table_id`	`string` Obrigatório. O ID da tabela do Cloud Bigtable que tem de ser importada.
`bigtable_options`	`BigtableOptions` Obrigatório. Opções do Bigtable que contêm informações necessárias ao analisar dados em estruturas com tipos. Por exemplo, anotações do tipo de coluna.

CheckGroundingRequest

Mensagem de pedido para o método GroundedGenerationService.CheckGrounding.

Campos
`grounding_config`	`string` Obrigatório. O nome do recurso da configuração de fundamentação, como `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Resposta do candidato a verificar. Pode ter um comprimento máximo de 4096 tokens.
`facts[]`	`GroundingFact` Lista de factos para a verificação de fundamentação. Apoiamos até 200 factos.
`grounding_spec`	`CheckGroundingSpec` Configuração da verificação de fundamentação.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte o documento do Google Cloud para ver mais detalhes.

CheckGroundingResponse

Mensagem de resposta para o método GroundedGenerationService.CheckGrounding.

Campos
`cited_chunks[]`	`FactChunk` Lista de factos citados em todas as reivindicações no candidato a resposta. Estes são derivados dos factos fornecidos no pedido.
`cited_facts[]`	`CheckGroundingFactChunk` Lista de factos citados em todas as reivindicações no candidato a resposta. Estes são derivados dos factos fornecidos no pedido.
`claims[]`	`Claim` Reivindicar textos e informações de citações em todas as reivindicações no candidato a resposta.
`support_score`	`float` A pontuação de apoio técnico para o candidato a resposta de entrada. Quanto mais elevada for a pontuação, maior é a fração de afirmações suportadas pelos factos fornecidos. Esta opção é sempre definida quando é devolvida uma resposta.

CheckGroundingFactChunk

Facto para verificação de fundamentação.

Campos

chunk_text

string

Conteúdo de texto do fragmento de factos. Pode ter, no máximo, 10 000 carateres.

Reivindicar

Texto e informações de citação para uma afirmação na resposta candidata.

Campos
`claim_text`	`string` Texto da afirmação no candidato a resposta. São sempre fornecidas, independentemente de serem encontradas citações ou anticitações.
`citation_indices[]`	`int32` Uma lista de índices (em "cited_chunks") que especifica as citações associadas à reivindicação. Por exemplo, [1,3,4] significa que cited_chunks[1], cited_chunks[3], cited_chunks[4] são os factos citados que apoiam a afirmação. Uma citação de um facto indica que a afirmação é suportada pelo facto.
`start_pos`	`int32` Posição que indica o início da reivindicação no candidato a resposta, medida em bytes. Tenha em atenção que isto não é medido em carateres e, por isso, tem de ser renderizado na interface do utilizador, tendo em atenção que alguns carateres podem ocupar mais do que um byte. Por exemplo, se o texto da reivindicação contiver carateres não ASCII, as posições inicial e final variam quando medidas em carateres (dependente da linguagem de programação) e quando medidas em bytes (independente da linguagem de programação).
`end_pos`	`int32` Posição que indica o fim da reivindicação no candidato de resposta, exclusiva, em bytes. Tenha em atenção que isto não é medido em carateres e, por isso, tem de ser renderizado como tal. Por exemplo, se o texto da reivindicação contiver carateres não ASCII, as posições inicial e final variam quando medidas em carateres (dependente da linguagem de programação) e quando medidas em bytes (independente da linguagem de programação).
`grounding_check_required`	`bool` Indica que esta reivindicação exigiu uma verificação de fundamentação. Quando o sistema decide que esta reivindicação não requer uma verificação de atribuição/fundamentação, este campo é definido como falso. Nesse caso, não foi feita nenhuma verificação de fundamentação para a reivindicação e, por isso, `citation_indices` não deve ser devolvido.
`score`	`double` Pontuação de confiança para a reivindicação no candidato a resposta, no intervalo de [0, 1]. Esta opção só é definida quando `CheckGroundingRequest.grounding_spec.enable_claim_level_score` é verdadeira.

CheckGroundingSpec

Especificação para a verificação de fundamentação.

Campos

citation_threshold

double

O limite (em [0,1]) usado para determinar se um facto tem de ser citado para uma afirmação no candidato a resposta. A escolha de um limite superior resulta em menos citações, mas muito fortes, enquanto a escolha de um limite inferior pode resultar em mais citações, mas um pouco mais fracas. Se não estiver definido, o limite tem a predefinição de 0,6.

enable_claim_level_score

bool

A flag de controlo que ativa a pontuação de fundamentação ao nível da reivindicação na resposta.

Chunk

O modo de fragmentação captura todas as informações de metadados não processados de itens a serem recomendados ou pesquisados no modo de fragmentação.

Campos
`name`	`string` O nome de recurso completo do fragmento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
`id`	`string` ID exclusivo do fragmento atual.
`content`	`string` O conteúdo é uma string de um documento (conteúdo analisado).
`document_metadata`	`DocumentMetadata` Metadados do documento do fragmento atual.
`derived_struct_data`	`Struct` Apenas saída. Este campo é OUTPUT_ONLY. Contém dados derivados que não estão no documento de entrada original.
`page_span`	`PageSpan` Intervalo de páginas do fragmento.
`chunk_metadata`	`ChunkMetadata` Apenas saída. Metadados do fragmento atual.
`data_urls[]`	`string` Apenas saída. URLs de dados de imagens se o fragmento atual contiver imagens. Os URLs de dados são compostos por quatro partes: um prefixo (data:), um tipo MIME que indica o tipo de dados, um token base64 opcional se não for textual e os próprios dados: data:[][;base64],
`annotation_contents[]`	`string` Apenas saída. Conteúdos das anotações, se o fragmento atual contiver anotações.
`annotation_metadata[]`	`AnnotationMetadata` Apenas saída. Os metadados de anotação incluem conteúdo estruturado no fragmento atual.
`relevance_score`	`double` Apenas saída. Representa a pontuação de relevância com base na semelhança. Uma pontuação mais elevada indica uma maior relevância do fragmento. A pontuação está no intervalo [-1,0, 1,0]. Preenchido apenas no `SearchResponse`.

AnnotationMetadata

Os metadados de anotação incluem conteúdo estruturado no fragmento atual.

Campos

structured_content

StructuredContent

Apenas saída. As informações de conteúdo estruturado.

image_id

string

Apenas saída. O ID da imagem é fornecido se o conteúdo estruturado se basear numa imagem.

ChunkMetadata

Metadados do fragmento atual. Este campo só é preenchido na API SearchService.Search.

Campos

previous_chunks[]

Chunk

Os fragmentos anteriores do fragmento atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Este campo só é preenchido na API SearchService.Search.

next_chunks[]

Chunk

Os próximos fragmentos do fragmento atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Este campo só é preenchido na API SearchService.Search.

DocumentMetadata

Os metadados do documento contêm as informações do documento do fragmento atual.

Campos
`uri`	`string` URI do documento.
`title`	`string` Título do documento.
`mime_type`	`string` O tipo MIME do documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
`struct_data`	`Struct` Representação de dados. Os dados JSON estruturados para o documento. Deve estar em conformidade com o `Schema` registado ou é gerado um erro `INVALID_ARGUMENT`.

PageSpan

Intervalo de páginas do fragmento.

Campos

page_start

int32

A página inicial do fragmento.

page_end

int32

A página final do fragmento.

StructureType

Define os tipos de conteúdo estruturado que podem ser extraídos.

Enumerações
`STRUCTURE_TYPE_UNSPECIFIED`	Valor predefinido.
`SHAREHOLDER_STRUCTURE`	Estrutura acionista.
`SIGNATURE_STRUCTURE`	Estrutura da assinatura.
`CHECKBOX_STRUCTURE`	Estrutura da caixa de verificação.

StructuredContent

As informações de conteúdo estruturado.

Campos

structure_type

StructureType

Apenas saída. O tipo de estrutura do conteúdo estruturado.

content

string

Apenas saída. O conteúdo do conteúdo estruturado.

Citação

Atribuições de fontes para conteúdo.

Campos
`start_index`	`int32` Apenas saída. Índice de início no conteúdo.
`end_index`	`int32` Apenas saída. Índice final no conteúdo.
`uri`	`string` Apenas saída. Referência do URL da atribuição.
`title`	`string` Apenas saída. Título da atribuição.
`license`	`string` Apenas saída. Licença da atribuição.
`publication_date`	`Date` Apenas saída. Data de publicação da atribuição.

CitationMetadata

Uma coleção de atribuições de fontes para um conteúdo.

Campos

citations[]

Citation

Apenas saída. Lista de citações.

CloudSqlSource

Origem do Cloud SQL a partir da qual importar dados.

Campos
`project_id`	`string` O ID do projeto que contém a origem do Cloud SQL. Tem um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`instance_id`	`string` Obrigatório. A instância do Cloud SQL a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`database_id`	`string` Obrigatório. A base de dados do Cloud SQL a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`table_id`	`string` Obrigatório. A tabela do Cloud SQL a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`gcs_staging_dir`	`string` Diretório do Cloud Storage intermédio usado para a importação com um limite de comprimento de 2000 carateres. Pode ser especificado se quiser que a exportação do Cloud SQL seja feita para um diretório específico do Cloud Storage. Certifique-se de que a conta de serviço do Cloud SQL tem as autorizações de administrador do Cloud Storage necessárias para aceder ao diretório do Cloud Storage especificado.
`offload`	`bool` Opção de exportação sem servidor. A ativação desta opção acarreta um custo adicional. Pode encontrar mais informações aqui.

CmekConfig

Configurações usadas para ativar a encriptação de dados CMEK com chaves do Cloud KMS.

Campos
`name`	`string` Obrigatório. O nome do CmekConfig do formulário `projects/{project}/locations/{location}/cmekConfig` ou `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Obrigatório. Nome do recurso da chave do KMS que vai ser usado para encriptar recursos `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
`kms_key_version`	`string` Apenas saída. Nome do recurso da versão da chave do KMS que vai ser usado para encriptar recursos `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Apenas saída. Os estados de CmekConfig.
`is_default`	`bool` Apenas saída. O CmekConfig predefinido para o cliente.
`last_rotation_timestamp_micros`	`int64` Apenas saída. A data/hora da última alteração da chave.
`single_region_keys[]`	`SingleRegionKey` Opcional. CMEKs de região única que são necessárias para algumas funcionalidades do VAIS.
`notebooklm_state`	`NotebookLMState` Apenas saída. Se o corpus do NotebookLM está pronto a ser usado.

NotebookLMState

Estados do NotebookLM.

Enumerações
`NOTEBOOK_LM_STATE_UNSPECIFIED`	O estado do NotebookLM é desconhecido.
`NOTEBOOK_LM_NOT_READY`	O NotebookLM não está pronto.
`NOTEBOOK_LM_READY`	O NotebookLM está pronto a ser usado.
`NOTEBOOK_LM_NOT_ENABLED`	O NotebookLM não está ativado.

Estado

Estados de CmekConfig.

Enumerações
`STATE_UNSPECIFIED`	O estado de CmekConfig é desconhecido.
`CREATING`	O CmekConfig está a ser criado.
`ACTIVE`	O CmekConfig pode ser usado com DataStores.
`KEY_ISSUE`	O CmekConfig está indisponível, provavelmente porque a chave do KMS foi revogada.
`DELETING`	O CmekConfig está a ser eliminado.
`DELETE_FAILED`	O processo de eliminação de CmekConfig falhou.
`UNUSABLE`	O CmekConfig não é utilizável, provavelmente devido a um problema interno.
`ACTIVE_ROTATING`	A versão da chave do KMS está a ser alternada.
`DELETED`	A chave do KMS é eliminada de forma reversível. Eventualmente, será aplicada alguma política de limpeza.
`EXPIRED`	A chave do KMS expirou, o que significa que a chave foi desativada há mais de 30 dias. O cliente pode chamar DeleteCmekConfig para alterar o estado para DELETED.

CollectUserEventRequest

Mensagem de pedido para o método CollectUserEvent.

Campos
`parent`	`string` Obrigatório. O nome do recurso principal. Se a ação de evento do utilizador de recolha for aplicada ao nível `DataStore`, o formato é: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Se a ação de recolha de eventos do utilizador for aplicada ao nível `Location`, por exemplo, o evento com `Document` em vários `DataStore`, o formato é: `projects/{project}/locations/{location}`.
`user_event`	`string` Obrigatório. URL codificado UserEvent proto com um limite de comprimento de 2 000 000 de carateres.
`uri`	`string` O URL, incluindo parâmetros cgi, mas excluindo o fragmento de hash, com um limite de comprimento de 5000 carateres. Isto é frequentemente mais útil do que o URL de referência, porque muitos navegadores apenas enviam o domínio para pedidos de terceiros.
`ets`	`int64` A data/hora do evento em milissegundos. Isto impede a colocação em cache do navegador de pedidos GET idênticos. O nome é abreviado para reduzir os bytes do payload.

Coleção

A coleção é um contentor para configurar recursos e o acesso a um conjunto de arquivos de dados.

Campos

name

string

Imutável. O nome do recurso completo da coleção. Formato: projects/{project}/locations/{location}/collections/{collection_id}.

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

display_name

string

Obrigatório. O nome a apresentar da coleção.

Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

create_time

Apenas saída. Data/hora de criação do Collection.

CompleteQueryRequest

Mensagem de pedido para o método CompletionService.CompleteQuery.

Campos
`data_store`	`string` Obrigatório. O nome do recurso da loja de dados principal para o qual a conclusão é realizada, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Obrigatório. A entrada de preenchimento automático usada para obter sugestões. O comprimento máximo é de 128 carateres.
`query_model`	`string` Especifica o modelo de dados de preenchimento automático. Isto substitui qualquer modelo especificado na secção Configuração > Preenchimento automático da Cloud Console. Valores atualmente suportados: `document` – Usando sugestões geradas a partir de documentos importados pelo utilizador. `search-history` - Usando sugestões geradas a partir do histórico anterior de chamadas da API `SearchService.Search`. Não a use quando não houver tráfego para a API Search. `user-event` – Usando sugestões geradas a partir de eventos de pesquisa importados pelo utilizador. `document-completable` – Usando sugestões retiradas diretamente dos campos de documentos importados pelos utilizadores marcados como preenchíveis. Valores predefinidos: `document` é o modelo predefinido para dataStores normais. `search-history` é o modelo predefinido para os dataStores de pesquisa no site.
`user_pseudo_id`	`string` Um identificador exclusivo para acompanhar os visitantes. Por exemplo, isto pode ser implementado com um cookie HTTP, que deve ser capaz de identificar de forma exclusiva um visitante num único dispositivo. Este identificador exclusivo não deve ser alterado se o visitante iniciar ou terminar sessão no Website. Este campo NÃO deve ter um valor fixo, como `unknown_visitor`. Este deve ser o mesmo identificador que `UserEvent.user_pseudo_id` e `SearchRequest.user_pseudo_id`. O campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`include_tail_suggestions`	`bool` Indica se devem ser devolvidas sugestões finais se não existirem sugestões que correspondam à consulta completa. Mesmo que esteja definido como verdadeiro, se existirem sugestões que correspondam à consulta completa, estas são devolvidas e não são devolvidas sugestões finais.

CompleteQueryResponse

Mensagem de resposta para o método CompletionService.CompleteQuery.

Campos

query_suggestions[]

QuerySuggestion

Resultados das sugestões de consultas correspondentes. A lista de resultados está ordenada e o primeiro resultado é uma sugestão principal.

tail_match_triggered

bool

Verdadeiro se as sugestões devolvidas forem todas sugestões finais.

Para que a correspondência final seja acionada, o parâmetro include_tail_suggestions no pedido tem de ser verdadeiro e não pode haver sugestões que correspondam à consulta completa.

QuerySuggestion

Sugestões como consultas de pesquisa.

Campos

suggestion

string

A sugestão para a consulta.

completable_field_paths[]

string

Os caminhos de campos de documentos únicos que servem como origem desta sugestão, se tiver sido gerada a partir de campos preenchíveis.

Este campo só é preenchido para o modelo de preenchimento de documentos.

CompletionInfo

Informações de conclusão detalhadas, incluindo o token de atribuição de conclusão e as informações de conclusão clicadas.

Campos

selected_suggestion

string

Utilizador final selecionado CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posição CompleteQueryResponse.QuerySuggestion.suggestion selecionada pelo utilizador final, a partir de 0.

CompletionSuggestion

Sugestões de preenchimento automático importadas do cliente.

Campos
`suggestion`	`string` Obrigatório. O texto da sugestão.
`language_code`	`string` Código de idioma BCP-47 desta sugestão.
`group_id`	`string` Se duas sugestões tiverem o mesmo groupId, não são devolvidas em conjunto. Em alternativa, é devolvido o que tiver uma classificação mais elevada. Pode ser usado para remover sugestões semanticamente idênticas.
`group_score`	`double` A pontuação desta sugestão no respetivo grupo.
`alternative_phrases[]`	`string` Expressões alternativas correspondentes para esta sugestão.
Campo de união `ranking_info`. Métricas de classificação desta sugestão. `ranking_info` só pode ser uma das seguintes opções:
`global_score`	`double` Classificação global desta sugestão. Controlar a forma como esta sugestão seria pontuada / classificada.
`frequency`	`int64` Frequência desta sugestão. É usado para classificar sugestões quando a pontuação não está disponível.

Condição

Define as circunstâncias a verificar antes de permitir um comportamento

Campos

query_terms[]

QueryTerm

Pesquise apenas uma lista de termos para fazer corresponder à consulta. Não pode ser definido quando Condition.query_regex está definido.

Máximo de 10 termos de consulta.

active_time_range[]

TimeRange

Intervalo de tempo que especifica quando a condição está ativa.

Máximo de 10 intervalos de tempo.

query_regex

string

Opcional. Expressão regular de consulta para corresponder a toda a consulta de pesquisa. Não pode ser definido quando Condition.query_terms está definido. Apenas suportado para controlos de publicação de promoções da pesquisa no site básica.

QueryTerm

Matcher para a consulta de pedido de pesquisa

Campos

value

string

O valor de consulta específico com o qual estabelecer correspondência

Tem de estar em minúsculas e ter a codificação UTF-8. Pode ter, no máximo, 3 termos separados por espaços se full_match for verdadeiro. Não pode ser uma string vazia. Comprimento máximo de 5000 carateres.

full_match

bool

Se a consulta de pesquisa tem de corresponder exatamente ao termo de consulta.

TimeRange

Usado para condições dependentes do tempo.

Campos

start_time

Início do intervalo de tempo.

O intervalo é inclusivo.

end_time

Fim do intervalo de tempo.

O intervalo é inclusivo. Tem de ser no futuro.

ConnectorType

O tipo de conetor.

Enumerações
`CONNECTOR_TYPE_UNSPECIFIED`	Valor predefinido.
`THIRD_PARTY`	Conector de terceiros para aplicação de terceiros.
`GCP_FHIR`	O conector de dados estabelece a ligação entre o FHIR store e o VAIS datastore.
`BIG_QUERY`	Conetor do BigQuery.
`GCS`	Conetor do Google Cloud Storage.
`GOOGLE_MAIL`	Conector do Gmail.
`GOOGLE_CALENDAR`	Conetor do Calendário Google.
`GOOGLE_DRIVE`	Conector do Google Drive.
`NATIVE_CLOUD_IDENTITY`	Conetor nativo do Cloud Identity para a pesquisa de pessoas com tecnologia da API People.
`THIRD_PARTY_FEDERATED`	Conetor federado: é um conetor de terceiros que não carrega dados, e a pesquisa é alimentada pela API da aplicação de terceiros.
`THIRD_PARTY_EUA`	Conetor usado para funcionalidades de autenticação do utilizador final.
`GCNV`	Conetor do Google Cloud NetApp Volumes.

ContactDetails

As informações de contacto armazenadas ao nível do recurso. Se o nível do projeto e o nível do recurso estiverem preenchidos, as informações de contacto ao nível do recurso substituem as informações de contacto ao nível do projeto.

Campos

email_address

string

Opcional. O endereço de email do contacto.

Controlo

Define um comportamento condicionado a usar durante a publicação. Tem de estar associado a um ServingConfig para ser considerado no momento da publicação. Ações permitidas dependentes de SolutionType.

Campos
`name`	`string` Imutável. Nome totalmente qualificado `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Obrigatório. Nome legível. O identificador usado nas visualizações da IU. Tem de ser uma string codificada em UTF-8. O limite de comprimento é de 128 carateres. Caso contrário, é gerado um erro INVALID ARGUMENT.
`associated_serving_config_ids[]`	`string` Apenas saída. Lista de todos os IDs de `ServingConfig` aos quais este controlo está anexado. A atualização pode demorar até 10 minutos após as alterações.
`solution_type`	`SolutionType` Obrigatório. Imutável. A que solução pertence o controlo. Tem de ser compatível com o vertical do recurso. Caso contrário, é gerado um erro INVALID ARGUMENT.
`use_cases[]`	`SearchUseCase` Especifica o exemplo de utilização do controlo. Afeta os campos de condições que podem ser definidos. Aplica-se apenas a `SOLUTION_TYPE_SEARCH`. Atualmente, só é permitido um exemplo de utilização por controlo. Tem de ser definido quando solution_type é `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Determina quando a ação associada é acionada. Omita para aplicar sempre a ação. Atualmente, só é possível especificar uma condição. Caso contrário, é gerado um erro INVALID ARGUMENT.
Campo de união `action`. As ações estão restritas por vertical e solução Obrigatório. `action` só pode ser uma das seguintes opções:
`boost_action`	`BoostAction` Define um controlo do tipo aumento
`filter_action`	`FilterAction` Define um controlo do tipo de filtro. Atualmente, não é suportado pela recomendação
`redirect_action`	`RedirectAction` Define um controlo do tipo redirecionamento.
`synonyms_action`	`SynonymsAction` Trata um grupo de termos como sinónimos entre si.
`promote_action`	`PromoteAction` Promova determinados links com base em consultas de acionamento predefinidas.

BoostAction

Ajusta a ordem dos produtos na lista devolvida.

Campos
`boost (deprecated)`	`float` Este item foi descontinuado! Intensidade do aumento, que deve estar no intervalo [-1, 1]. Um aumento negativo significa uma despromoção. A predefinição é 0,0 (No-op).
`filter`	`string` Obrigatório. Especifica a que produtos aplicar o aumento. Se não for fornecido nenhum filtro, todos os produtos são otimizados (No-op). Documentação da sintaxe: https://cloud.google.com/retail/docs/filter-and-order. O comprimento máximo é de 5000 carateres. Caso contrário, é gerado um erro INVALID ARGUMENT.
`data_store`	`string` Obrigatório. Especifica os documentos do arquivo de dados que podem ser otimizados por este controlo. Nome completo da loja de dados, por exemplo, projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo de união `boost_spec`. Especificações de aumento de valor constante ou de classificação personalizada baseada em aumentos. `boost_spec` só pode ser uma das seguintes opções:
`fixed_boost`	`float` Opcional. Intensidade do aumento, que deve estar no intervalo [-1, 1]. Um aumento negativo significa uma despromoção. A predefinição é 0,0 (No-op).
`interpolation_boost_spec`	`InterpolationBoostSpec` Opcional. Especificação complexa para a classificação personalizada com base no valor do atributo definido pelo cliente.

InterpolationBoostSpec

Especificação para a classificação personalizada com base no valor do atributo especificado pelo cliente. Oferece mais controlos para a classificação personalizada do que a combinação simples (condição, aumento) acima.

Campos
`field_name`	`string` Opcional. O nome do campo cujo valor vai ser usado para determinar o valor do aumento.
`attribute_type`	`AttributeType` Opcional. O tipo de atributo a usar para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples, ou seja, attribute_value = numerical_field_value. No entanto, no caso da atualidade, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Opcional. O tipo de interpolação a aplicar para ligar os pontos de controlo indicados abaixo.
`control_points[]`	`ControlPoint` Opcional. Os pontos de controlo usados para definir a curva. A função monótona (definida através de interpolation_type acima) passa pelos pontos de controlo indicados aqui.

AttributeType

O atributo(ou a função) ao qual a classificação personalizada deve ser aplicada.

Enumerações
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType não especificado.
`NUMERICAL`	O valor do campo numérico é usado para atualizar dinamicamente o valor do aumento. Neste caso, o attribute_value (o valor x) do ponto de controlo é o valor real do campo numérico para o qual o boost_amount é especificado.
`FRESHNESS`	Para o exemplo de utilização da atualidade, o valor do atributo é a duração entre a hora atual e a data no campo de data/hora especificado. O valor tem de ser formatado como um valor XSD `dayTimeDuration` (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: `[nD][T[nH][nM][nS]]`. Por exemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Os pontos de controlo usados para definir a curva. A curva definida através destes pontos de controlo só pode ser monotonicamente crescente ou decrescente(os valores constantes são aceitáveis).

Campos

attribute_value

string

Opcional. Pode ser um dos seguintes: 1. O valor do campo numérico. 2. A especificação de duração para a atualização: o valor tem de ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: [nD][T[nH][nM][nS]].

boost_amount

float

Opcional. O valor entre -1 e 1 pelo qual aumentar a pontuação se o attribute_value for avaliado como o valor especificado acima.

InterpolationType

O tipo de interpolação a aplicar. A predefinição é linear (linear por partes).

Enumerações
`INTERPOLATION_TYPE_UNSPECIFIED`	O tipo de interpolação não foi especificado. Neste caso, a predefinição é Linear.
`LINEAR`	É aplicada a interpolação linear por partes.

FilterAction

Especificou que produtos podem ser incluídos nos resultados. Usa o mesmo filtro que o aumento.

Campos

filter

string

Obrigatório. Um filtro a aplicar aos resultados da condição correspondente.

Documentação da sintaxe obrigatória: https://cloud.google.com/retail/docs/filter-and-order. O comprimento máximo é de 5000 carateres. Caso contrário, é gerado um erro INVALID ARGUMENT.

data_store

string

Obrigatório. Especifica os documentos do arquivo de dados que podem ser filtrados por este controlo. Nome completo da loja de dados, por exemplo, projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

Promover determinados links com base em algumas consultas de acionadores.

Exemplo: promova o link da loja de calçado quando pesquisar a palavra-chave shoe. A associação pode estar fora do arquivo de dados associado.

Campos

data_store

string

Obrigatório. Armazenamento de dados ao qual esta promoção está anexada.

search_link_promotion

SearchLinkPromotion

Obrigatório. Promoção associada a esta ação.

RedirectAction

Redireciona um comprador para o URI fornecido.

Campos

redirect_uri

string

Obrigatório. O URI para o qual o comprador vai ser redirecionado.

Obrigatório. O URI tem de ter um comprimento igual ou inferior a 2000 carateres. Caso contrário, é gerado um erro INVALID ARGUMENT.

SynonymsAction

Cria um conjunto de termos que atuam como sinónimos uns dos outros.

Exemplo: "feliz" também é considerado "contente", e "contente" também é considerado "feliz".

Campos

synonyms[]

string

Define um conjunto de sinónimos. Pode especificar até 100 sinónimos. Tem de especificar, pelo menos, 2 sinónimos. Caso contrário, é gerado um erro INVALID ARGUMENT.

Conversa

Definição do proto de conversa externa.

Campos
`name`	`string` Imutável. Nome totalmente qualificado `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` ou `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` O estado da conversa.
`user_pseudo_id`	`string` Um identificador exclusivo para acompanhar os utilizadores.
`messages[]`	`ConversationMessage` Mensagens de conversas.
`start_time`	`Timestamp` Apenas saída. A hora em que a conversa foi iniciada.
`end_time`	`Timestamp` Apenas saída. A hora em que a conversa terminou.

Estado

Enumeração do estado da conversa.

Enumerações
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	A conversa está aberta.
`COMPLETED`	A conversa foi concluída.

ConversationContext

Define o contexto da conversa

Campos

context_documents[]

string

A lista atual de documentos que o utilizador está a ver. Contém as referências de recursos de documentos.

active_document

string

O documento ativo atual que o utilizador abriu. Contém a referência do recurso do documento.

ConversationMessage

Define uma mensagem de conversa.

Campos
`create_time`	`Timestamp` Apenas saída. Data/hora de criação da mensagem.
Campo de união `message`. `message` só pode ser uma das seguintes opções:
`user_input`	`TextInput` Introdução de texto do utilizador.
`reply`	`Reply` Pesquisar resposta.

ConverseConversationRequest

Mensagem de pedido para o método ConversationalSearchService.ConverseConversation.

Campos
`name`	`string` Obrigatório. O nome do recurso da conversa a obter. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` para ativar o modo de sessão automática, que cria automaticamente uma nova conversa numa sessão ConverseConversation.
`query`	`TextInput` Obrigatório. Introdução do utilizador atual.
`serving_config`	`string` O nome do recurso da configuração de publicação a usar. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` Se não estiver definido, é usada a configuração de publicação predefinida.
`conversation`	`Conversation` A conversa a ser usada apenas pela sessão automática. O campo de nome é ignorado, uma vez que atribuímos automaticamente um novo nome à conversa na sessão automática.
`safe_search`	`bool` Se deve ativar a pesquisa segura.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte o documento do Google Cloud para ver mais detalhes.
`summary_spec`	`SummarySpec` Uma especificação para configurar o resumo devolvido na resposta.
`filter`	`string` A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas. Isto é usado para filtrar os resultados da pesquisa, o que pode afetar a resposta de resumo. Se este campo não for reconhecível, é devolvido um `INVALID_ARGUMENT`. A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "name" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")' Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar
`boost_spec`	`BoostSpec` Especificação de reforço para reforçar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta de conversa. Para mais informações sobre o aumento, consulte o artigo Aumentar

ConverseConversationResponse

Mensagem de resposta para o método ConversationalSearchService.ConverseConversation.

Campos

reply

Reply

Responder à consulta atual.

conversation

Conversa atualizada, incluindo a resposta.

search_results[]

SearchResult

Resultados da pesquisa.

CreateAssistantRequest

Pedido para o método AssistantService.CreateAssistant.

Campos

parent

string

Obrigatório. O nome do recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Obrigatório. O Assistant a criar.

assistant_id

string

Obrigatório. O ID a usar para o Assistant, que se torna o componente final do nome do recurso do Assistant.

Este campo tem de estar em conformidade com o RFC-1034 com um limite de comprimento de 63 carateres.

CreateControlRequest

Pedido do método CreateControl.

Campos

parent

string

Obrigatório. Nome completo do recurso do armazenamento de dados principal. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} ou projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control

Control

Obrigatório. O controlo para criar.

control_id

string

Obrigatório. O ID a usar para o controlo, que se torna o componente final do nome do recurso do controlo.

Este valor tem de ter entre 1 e 63 carateres. Os carateres válidos são /[a-z][0-9]-_/.

CreateConversationRequest

Pedido para o método CreateConversation.

Campos

parent

string

Obrigatório. Nome completo do recurso do armazenamento de dados principal. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Obrigatório. A conversa a criar.

CreateDataStoreMetadata

Metadados relacionados com o progresso da operação DataStoreService.CreateDataStore. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

CreateDataStoreRequest

Pedido para o método DataStoreService.CreateDataStore.

Campos
`parent`	`string` Obrigatório. O nome do recurso principal, como `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Obrigatório. O `DataStore` a criar.
`data_store_id`	`string` Obrigatório. O ID a usar para o `DataStore`, que se torna o componente final do nome do recurso do `DataStore`. Este campo tem de estar em conformidade com a norma RFC-1034, com um limite de comprimento de 63 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`create_advanced_site_search`	`bool` Uma sinalização booleana que indica se o utilizador quer criar diretamente um arquivo de dados avançado para a pesquisa no site. Se o armazenamento de dados não estiver configurado como pesquisa no site (vertical GENÉRICA e content_config PUBLIC_WEBSITE), esta flag é ignorada.
`skip_default_schema_creation`	`bool` Uma sinalização booleana que indica se deve ignorar a criação do esquema predefinido para o repositório de dados. Ative esta flag apenas se tiver a certeza de que o esquema predefinido é incompatível com o seu exemplo de utilização. Se estiver definida como verdadeira, tem de criar manualmente um esquema para o repositório de dados antes de poderem ser carregados documentos. Não é possível especificar este sinalizador se `data_store.starting_schema` estiver especificado.
Campo de união `cmek_options`. Opções de CMEK para o DataStore. A definição deste campo substitui o CmekConfig predefinido, se existir um definido para o projeto. `cmek_options` só pode ser uma das seguintes opções:
`cmek_config_name`	`string` Nome do recurso do CmekConfig a usar para proteger este DataStore.
`disable_cmek`	`bool` DataStore sem proteções CMEK. Se for definido um CmekConfig predefinido para o projeto, a definição deste campo também substitui o CmekConfig predefinido.

CreateDocumentRequest

Mensagem de pedido para o método DocumentService.CreateDocument.

Campos

parent

string

Obrigatório. O nome do recurso principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Obrigatório. O Document a criar.

document_id

string

Obrigatório. O ID a usar para o Document, que se torna o componente final do Document.name.

Se o autor da chamada não tiver autorização para criar o Document, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Este campo tem de ser exclusivo entre todos os Documents com o mesmo parent. Caso contrário, é devolvido um erro ALREADY_EXISTS.

Este campo tem de estar em conformidade com a norma RFC-1034, com um limite de comprimento de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

CreateEngineMetadata

Metadados relacionados com o progresso da operação EngineService.CreateEngine. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

CreateEngineRequest

Pedido para o método EngineService.CreateEngine.

Campos

parent

string

Obrigatório. O nome do recurso principal, como projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Obrigatório. O Engine a criar.

engine_id

string

Obrigatório. O ID a usar para o Engine, que se torna o componente final do nome do recurso do Engine.

Este campo tem de estar em conformidade com a norma RFC-1034, com um limite de comprimento de 63 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

CreateIdentityMappingStoreRequest

Pedido de mensagem para IdentityMappingStoreService.CreateIdentityMappingStore

Campos
`parent`	`string` Obrigatório. O nome do recurso da coleção principal, como `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Obrigatório. O ID do armazenamento de mapeamento de identidades a criar. O ID tem de conter apenas letras (a-z, A-Z), números (0-9), sublinhados (_) e hífenes (-). O comprimento máximo é de 63 carateres.
`identity_mapping_store`	`IdentityMappingStore` Obrigatório. A loja de mapeamento de identidade a criar.
Campo de união `cmek_options`. Opções de CMEK para o armazenamento de mapeamento de identidades. A definição deste campo substitui o CmekConfig predefinido, se existir um definido para o projeto. `cmek_options` só pode ser uma das seguintes opções:
`cmek_config_name`	`string` Nome do recurso do CmekConfig a usar para proteger esta loja de mapeamento de identidades.
`disable_cmek`	`bool` Armazenamento de mapeamento de identidades sem proteções de CMEK. Se for definido um CmekConfig predefinido para o projeto, a definição deste campo também substitui o CmekConfig predefinido.

CreateLicenseConfigRequest

Mensagem de pedido para o método LicenseConfigService.CreateLicenseConfig.

Campos

parent

string

Obrigatório. O nome do recurso principal, como projects/{project}/locations/{location}.

license_config

LicenseConfig

Obrigatório. O LicenseConfig a criar.

license_config_id

string

Opcional. O ID a usar para o LicenseConfig, que se torna o componente final do nome do recurso do LicenseConfig. Estamos a usar o nome do nível (edição do produto) como o ID de configuração da licença, como search ou search_and_assistant.

CreateSchemaMetadata

Metadados para o LRO do esquema de criação.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

CreateSchemaRequest

Mensagem de pedido para o método SchemaService.CreateSchema.

Campos

parent

string

Obrigatório. O nome do recurso da loja de dados principal, no formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Obrigatório. O Schema a criar.

schema_id

string

Obrigatório. O ID a usar para o Schema, que se torna o componente final do Schema.name.

Este campo deve estar em conformidade com a norma RFC-1034 com um limite de comprimento de 63 carateres.

CreateSessionRequest

Pedido do método CreateSession.

Campos

parent

string

Obrigatório. Nome completo do recurso do armazenamento de dados principal. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Obrigatório. A sessão a criar.

CreateSitemapMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.CreateSitemap. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

CreateSitemapRequest

Mensagem de pedido para o método SiteSearchEngineService.CreateSitemap.

Campos

parent

string

Obrigatório. Nome do recurso principal de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Obrigatório. O Sitemap a criar.

CreateTargetSiteMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.CreateTargetSite. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

CreateTargetSiteRequest

Mensagem de pedido para o método SiteSearchEngineService.CreateTargetSite.

Campos

parent

string

Obrigatório. Nome do recurso principal de TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Obrigatório. O TargetSite a criar.

CustomAttribute

Um atributo personalizado que não é modelado explicitamente num recurso, por exemplo, UserEvent.

Campos

text[]

string

Os valores textuais deste atributo personalizado. Por exemplo, ["yellow", "green"] quando a chave é "cor".

Não é permitida uma string vazia. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Tem de definir exatamente uma das propriedades CustomAttribute.text ou CustomAttribute.numbers. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

numbers[]

double

Os valores numéricos deste atributo personalizado. Por exemplo, [2.3, 15.4] quando a chave é "lengths_cm".

Tem de definir exatamente uma das propriedades CustomAttribute.text ou CustomAttribute.numbers. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

CustomTuningModel

Metadados que descrevem um modelo ajustado personalizado.

Campos
`name`	`string` Obrigatório. O nome do recurso totalmente qualificado do modelo. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. O modelo tem de ser uma string alfanumérica com um limite de 40 carateres.
`display_name`	`string` O nome a apresentar do modelo.
`model_version`	`int64` A versão do modelo.
`model_state`	`ModelState` O estado em que o modelo se encontra (por exemplo,`TRAINING` ou `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Este item foi descontinuado! Descontinuado: data/hora de criação do modelo.
`training_start_time`	`Timestamp` Indicação de tempo em que a preparação do modelo foi iniciada.
`metrics`	`map<string, double>` As métricas do modelo preparado.
`error_message`	`string` Atualmente, este campo só é preenchido se o estado do modelo for `INPUT_VALIDATION_FAILED`.

ModelState

O estado do modelo.

Enumerações
`MODEL_STATE_UNSPECIFIED`	Valor predefinido.
`TRAINING_PAUSED`	O modelo está num estado de preparação pausado.
`TRAINING`	O modelo está atualmente a ser preparado.
`TRAINING_COMPLETE`	O modelo concluiu a preparação com êxito.
`READY_FOR_SERVING`	O modelo está pronto para publicação.
`TRAINING_FAILED`	Falha na preparação do modelo.
`NO_IMPROVEMENT`	A preparação do modelo foi concluída com êxito, mas as métricas não melhoraram.
`INPUT_VALIDATION_FAILED`	A validação dos dados de entrada falhou. A preparação do modelo não foi iniciada.

DataConnector

Gerencia a ligação a origens de dados externas para todos os arquivos de dados agrupados num Collection. É um recurso singleton de Collection. A inicialização só é suportada através do método DataConnectorService.SetUpDataConnector, que cria um novo Collection e inicializa o respetivo DataConnector.

Campos
`name`	`string` Apenas saída. O nome completo do recurso do conetor de dados. Formato: `projects//locations//collections/*/dataConnector`.
`state`	`State` Apenas saída. Estado do conetor.
`data_source`	`string` Obrigatório. O nome da origem de dados. Valores suportados: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Opcional. Especifica as chaves a remover do campo "params". Esta opção só está ativa quando "params" está incluído em "update_mask" num UpdateDataConnectorRequest. A eliminação tem precedência se uma chave estiver em "remove_param_keys" e presente no campo "params" do pedido.
`refresh_interval`	`Duration` Obrigatório. O intervalo de atualização para a sincronização de dados. Se a duração for definida como 0, os dados são sincronizados em tempo real. A funcionalidade de streaming ainda não é suportada. O mínimo é de 30 minutos e o máximo é de 7 dias. Quando o intervalo de atualização é definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada.
`next_sync_time`	`DateTime` Define a hora agendada para a próxima sincronização de dados. Este campo requer a hora, os minutos e o fuso horário da base de dados de fusos horários da IANA. Esta opção é usada quando o conetor de dados tem um intervalo de atualização superior a 1 dia. Quando as horas ou os minutos não são especificados, assumimos uma hora de sincronização de 0:00. O utilizador tem de indicar um fuso horário para evitar ambiguidades.
`entities[]`	`SourceEntity` Lista de entidades da origem de dados associada a carregar.
`create_time`	`Timestamp` Apenas saída. Data/hora de criação do `DataConnector`.
`latest_pause_time`	`Timestamp` Apenas saída. A data/hora mais recente em que este `DataConnector` foi pausado, o que afeta todas as funcionalidades, como a sincronização de dados. A pausa de um conetor tem os seguintes efeitos: - Todas as funcionalidades, incluindo a sincronização de dados, são interrompidas. – Todas as tarefas de sincronização de dados em curso são canceladas. – Não são agendadas nem podem ser acionadas execuções de sincronização de dados futuras.
`last_sync_time`	`Timestamp` Apenas saída. Apenas para conetores periódicos, a última vez que foi concluída uma sincronização de dados.
`update_time`	`Timestamp` Apenas saída. Data/hora da última atualização do `DataConnector`.
`errors[]`	`Status` Apenas saída. Os erros da inicialização ou da execução mais recente do conetor.
`sync_mode`	`SyncMode` O modo de sincronização de dados suportado pelo conetor de dados.
`kms_key_name`	`string` Apenas entrada. A chave do KMS a usar para proteger os arquivos de dados geridos por este conetor. Tem de ser definido para pedidos que têm de estar em conformidade com as proteções da política organizacional da CMEK. Se este campo for definido e processado com êxito, os arquivos de dados criados por este conetor são protegidos pela chave do KMS.
`destination_configs[]`	`DestinationConfig` Opcional. Quaisquer destinos usados para estabelecer ligação a serviços de terceiros.
`action_state`	`State` Apenas saída. Estado do conetor de ações. Isto reflete se o conetor de ações está a ser inicializado, está ativo ou encontrou erros.
`action_config`	`ActionConfig` Opcional. Configurações de ações para que o conetor suporte ações.
`end_user_config`	`EndUserConfig` Opcional. Quaisquer parâmetros e credenciais usados especificamente para conetores da EUA.
`federated_config`	`FederatedConfig` Opcional. Quaisquer parâmetros e credenciais usados especificamente para conectores híbridos que suportam o modo FEDERATED. Este campo só deve ser definido se o conetor for um conetor híbrido e quisermos ativar o modo FEDERATED.
`connector_modes[]`	`ConnectorMode` Opcional. Os modos ativados para este conetor. O estado predefinido é CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Opcional. Indica se o cliente ativou endereços IP estáticos para este conector.
`static_ip_addresses[]`	`string` Apenas saída. Os endereços IP estáticos usados por este conetor.
`blocking_reasons[]`	`BlockingReason` Apenas saída. Ações do utilizador que têm de ser concluídas antes de o conector poder começar a sincronizar dados.
`identity_refresh_interval (deprecated)`	`Duration` Este item foi descontinuado! O intervalo de atualização para sincronizar as informações da lista de controlo de acesso dos documentos carregados por este conector. Se não for definida, a lista de controlo de acesso é atualizada no intervalo predefinido de 30 minutos. O intervalo de atualização da identidade pode ser de, pelo menos, 30 minutos e, no máximo, 7 dias.
`identity_schedule_config`	`IdentityScheduleConfig` A configuração das execuções de sincronização de dados de identidade. Contém o intervalo de atualização para sincronizar as informações da lista de controlo de acesso dos documentos carregados por este conector.
`private_connectivity_project_id`	`string` Apenas saída. O ID do projeto de inquilino associado aos conetores de conetividade privada. Este projeto tem de constar da lista de autorizações para que o conetor funcione.
`bap_config`	`BAPConfig` Opcional. A configuração para estabelecer uma ligação BAP.
`connector_type`	`ConnectorType` Apenas saída. O tipo de conetor. Cada origem só pode ser mapeada para um tipo. Por exemplo, o Salesforce, o Confluence e o Jira têm o tipo de conetor THIRD_PARTY. Não é mutável depois de ser definido pelo sistema.
`realtime_state`	`State` Apenas saída. Estado de sincronização em tempo real
`alert_policy_configs[]`	`AlertPolicyConfig` Opcional. A configuração de alerta ao nível do conetor.
`realtime_sync_config`	`RealtimeSyncConfig` Opcional. A configuração para a sincronização em tempo real.
`acl_enabled`	`bool` Opcional. Se o conetor vai ser criado com uma configuração de ACL. Atualmente, este campo só afeta os conetores do Cloud Storage e do BigQuery.
`create_eua_saas`	`bool` Opcional. Se o conetor END USER AUTHENTICATION é criado no SaaS.
`auto_run_disabled`	`bool` Opcional. Indica se o conetor está desativado para execução automática. Pode ser usado para pausar a sincronização periódica e em tempo real. Atualização: com a introdução de incremental_sync_disabled, auto_run_disabled é usado para pausar/desativar apenas sincronizações completas
`incremental_sync_disabled`	`bool` Opcional. Indica se as sincronizações incrementais estão pausadas para este conetor. Isto é independente de auto_run_disabled. Aplicável apenas a conetores de terceiros. Quando o intervalo de atualização está definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada, ou seja, definida como verdadeira.
`incremental_refresh_interval`	`Duration` Opcional. O intervalo de atualização especificamente para sincronizações de dados incrementais. Se não estiver definida, as sincronizações incrementais usam o valor predefinido do ambiente, definido como 3 horas. O mínimo é de 30 minutos e o máximo é de 7 dias. Aplicável apenas a conetores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor que o intervalo de atualização incremental, a sincronização incremental é desativada.
`hybrid_ingestion_disabled`	`bool` Opcional. Se o conetor for um conetor híbrido, determina se o carregamento está ativado e se os recursos adequados são aprovisionados durante a criação do conetor. Se o conetor não for um conetor híbrido, este campo é ignorado.
Campo de união `data_connector_params`. Parâmetros necessários para aceder à origem no formato de pares (chave, valor). Os valores de string com o formato `projects//[locations//]secrets//versions/` são lidos a partir do Secret Manager. Parâmetros obrigatórios para todas as origens de dados: Tecla: `instance_uri` Valor: tipo STRING. O URI para aceder à origem de dados. Parâmetros obrigatórios para origens que suportam o OAUTH, ou seja, `salesforce`: Tecla: `client_id` Valor: tipo STRING. O ID de cliente do fornecedor de serviços externo para identificar a sua aplicação. Tecla: `client_secret` Value:type STRING. O segredo do cliente gerado pelo servidor de autorização de terceiros. Tecla: `access_token` Valor: tipo STRING. Token OAuth para o UCS aceder ao recurso protegido. Tecla: `refresh_token` Valor: tipo STRING. Token de atualização do OAuth para o UCS obter um novo token de acesso sem interação do utilizador. Parâmetros obrigatórios para origens que suportam a autorização básica de chaves da API, ou seja, `jira` e `confluence`: Tecla: `user_account` Valor: tipo STRING. O nome de utilizador ou o email com a origem. Tecla: `api_token` Valor: tipo STRING. O token da API gerado para a conta de origem, que é usado para autenticação em qualquer lugar onde teria usado uma palavra-passe. Exemplo: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` Parâmetro opcional para especificar o tipo de autorização a usar para suporte de vários tipos de autorização: Tecla: `auth_type` Valor: tipo STRING. O tipo de autorização da origem de dados. Valores suportados: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN` e `FEDERATED_CREDENTIAL`. `data_connector_params` só pode ser uma das seguintes opções:
`params`	`Struct` Parâmetros do conetor de dados obrigatórios no formato JSON estruturado.
`json_params`	`string` Parâmetros do conetor de dados obrigatórios no formato de string JSON.

BlockingReason

Ações do utilizador que têm de ser concluídas antes de o conector poder começar a sincronizar dados.

Enumerações
`BLOCKING_REASON_UNSPECIFIED`	Valor predefinido.
`ALLOWLIST_STATIC_IP`	O conector requer que o cliente adicione IPs estáticos à lista de autorizações.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	O conector requer que o cliente inclua o nosso projeto na lista de autorizações da respetiva associação de serviço.
`ALLOWLIST_SERVICE_ACCOUNT`	O conector requer que o cliente inclua a conta de serviço na lista de autorizações do respetivo projeto.

ConnectorMode

Os modos ativados para este conetor. INGESTION, ACTIONS, FEDERATED OU EUA

Enumerações
`CONNECTOR_MODE_UNSPECIFIED`	Modo do conetor não especificado.
`DATA_INGESTION`	Conetor usado para a obtenção de dados.
`ACTIONS`	Conetor usado para ações.
`FEDERATED`	Conetor usado para a pesquisa federada.
`EUA`	Conetor usado para a autenticação do utilizador final.
`FEDERATED_AND_EUA`	Conetor híbrido usado para a pesquisa federada e a autenticação do utilizador final.

EndUserConfig

Quaisquer parâmetros e credenciais usados especificamente para conetores da EUA.

Campos
`additional_params`	`Struct` Opcional. Quaisquer parâmetros adicionais necessários para a EUA.
`tenant`	`Tenant` Opcional. O projeto de inquilino ao qual o conector está associado.
Campo de união `auth_config`. Configuração de autenticação para conetores de EUA. `auth_config` só pode ser uma das seguintes opções:
`auth_params`	`Struct` Opcional. Quaisquer parâmetros de autenticação específicos dos conetores de EUA.
`json_auth_params`	`string` Opcional. Quaisquer parâmetros de autenticação específicos dos conetores de EUA no formato de string JSON.

FederatedConfig

Quaisquer parâmetros e credenciais usados especificamente para conectores híbridos que suportam o modo FEDERATED.

Campos
`additional_params`	`Struct` Opcional. Quaisquer parâmetros adicionais necessários para FEDERATED.
Campo de união `auth_config`. Configuração de autenticação para conetores FEDERATED. `auth_config` só pode ser uma das seguintes opções:
`auth_params`	`Struct` Opcional. Quaisquer parâmetros de autenticação específicos dos conetores FEDERATED.
`json_auth_params`	`string` Opcional. Quaisquer parâmetros de autenticação específicos dos conetores FEDERATED no formato de string JSON.

RealtimeSyncConfig

A configuração para a sincronização em tempo real para armazenar parâmetros adicionais para a sincronização em tempo real.

Campos

webhook_uri

string

Opcional. URL do webhook para o conetor especificar parâmetros adicionais para a sincronização em tempo real.

realtime_sync_secret

string

Opcional. O ID do Secret do Secret Manager usado para o segredo do webhook.

streaming_error

StreamingError

Opcional. Detalhes do erro de streaming.

StreamingError

Detalhes do erro de streaming.

Campos

streaming_error_reason

StreamingErrorReason

Opcional. Erro de streaming.

error

Opcional. Detalhes do erro.

StreamingErrorReason

Tipos gerais de erros de streaming.

Enumerações
`STREAMING_ERROR_REASON_UNSPECIFIED`	Motivo do erro de streaming não especificado.
`STREAMING_SETUP_ERROR`	Ocorreu um erro ao configurar os recursos para a sincronização em tempo real.
`STREAMING_SYNC_ERROR`	Ocorreu um erro ao executar a sincronização em tempo real para o conetor.
`INGRESS_ENDPOINT_REQUIRED`	O ponto final de entrada é obrigatório quando configura a sincronização em tempo real na conetividade privada.

SourceEntity

Representa uma entidade na origem de dados. Por exemplo, o objeto Account no Salesforce.

Campos
`entity_name`	`string` O nome da entidade. Valores suportados por origem de dados: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract` e `Campaign` Jira: `Issue` Confluência: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Atributos para indexação. Chave: nome do campo. Valor: a propriedade chave para mapear um campo, como `title` e `description`. Propriedades de chave suportadas: `title`: o título do registo de dados. Esta informação seria apresentada nos resultados da pesquisa. `description`: a descrição do registo de dados. Esta informação é apresentada nos resultados da pesquisa.
`data_store`	`string` Apenas saída. O nome do recurso completo do arquivo de dados associado para a entidade de origem. Formato: `projects//locations//collections//dataStores/`. Quando o conector é inicializado pelo método `DataConnectorService.SetUpDataConnector`, é criado automaticamente um `DataStore` para cada entidade de origem.
`starting_schema`	`Schema` Opcional. O esquema de início a usar para o `DataStore` criado a partir deste SourceEntity. Se não estiver definida, é usado um esquema especializado vertical predefinido. Este campo só é usado pela API [SetUpDataConnector][] e é ignorado se for usado noutras APIs. Este campo é omitido de todas as respostas da API, incluindo a API [GetDataConnector][]. Para obter um esquema de um `DataStore`, use a API `SchemaService.GetSchema`. O esquema fornecido é validado em função de determinadas regras no esquema. Saiba mais neste documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Configuração para o vertical `HEALTHCARE_FHIR`.
Campo de união `entity_params`. Os parâmetros da entidade para facilitar a obtenção de dados. Por exemplo, para conetores do BigQuery: Tecla: `document_id_column` Valor: tipo STRING. O valor do ID da coluna. `entity_params` só pode ser uma das seguintes opções:
`params`	`Struct` Os parâmetros da entidade para facilitar o carregamento de dados no formato JSON estruturado.
`json_params`	`string` Os parâmetros da entidade para facilitar a carregamento de dados no formato de string JSON.

Estado

O estado do conetor.

Enumerações
`STATE_UNSPECIFIED`	Valor predefinido.
`CREATING`	O conetor está a ser configurado.
`ACTIVE`	O conetor está configurado com êxito e a aguardar a próxima execução da sincronização.
`FAILED`	O conetor está com erros. Pode encontrar os detalhes do erro em `DataConnector.errors`. Se o erro não for corrigível, o `DataConnector` pode ser eliminado através da API [CollectionService.DeleteCollection].
`RUNNING`	O conetor está a sincronizar ativamente registos da origem de dados.
`WARNING`	O conetor concluiu uma execução de sincronização, mas encontrou erros não fatais.
`INITIALIZATION_FAILED`	Falha na inicialização do conetor. As potenciais causas incluem erros de tempo de execução ou problemas no pipeline assíncrono, o que impede que o pedido chegue aos serviços a jusante (exceto para alguns tipos de conetores).
`UPDATING`	O conetor está em processo de atualização.

SyncMode

Define o modo de sincronização de dados suportado pelo conetor de dados.

Enumerações
`PERIODIC`	O conetor sincroniza os dados periodicamente com base no refresh_interval. Use-o com auto_run_disabled para pausar a sincronização periódica ou indicar uma sincronização única.
`STREAMING`	Os dados são sincronizados em tempo real.
`UNSPECIFIED`	O conetor que não carrega dados tem este valor

DataStore

O DataStore captura definições e configurações globais ao nível do DataStore.

Campos
`name`	`string` Imutável. Identificador. O nome completo do recurso do armazenamento de dados. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
`display_name`	`string` Obrigatório. O nome a apresentar da loja de dados. Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`industry_vertical`	`IndustryVertical` Imutável. A vertical do setor que a base de dados regista.
`solution_types[]`	`SolutionType` As soluções que o arquivo de dados inscreve. Soluções disponíveis para cada `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` e `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` está inscrito automaticamente. Não é possível inscrever outras soluções.
`default_schema_id`	`string` Apenas saída. O ID do `Schema` predefinido associado a este arquivo de dados.
`content_config`	`ContentConfig` Imutável. A configuração de conteúdo do arquivo de dados. Se este campo não for definido, o comportamento do servidor é predefinido para `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Apenas saída. Data/hora de criação do `DataStore`.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Opcional. Configuração para a pesquisa no site avançada.
`kms_key_name`	`string` Apenas entrada. A chave do KMS a usar para proteger este DataStore no momento da criação. Tem de ser definido para pedidos que têm de estar em conformidade com as proteções da política organizacional da CMEK. Se este campo estiver definido e for processado com êxito, o DataStore é protegido pela chave do KMS, conforme indicado no campo cmek_config.
`cmek_config`	`CmekConfig` Apenas saída. Informações relacionadas com a CMEK para o DataStore.
`billing_estimation`	`BillingEstimation` Apenas saída. Estimativa do tamanho dos dados para faturação.
`acl_enabled`	`bool` Imutável. Se os dados no ficheiro `DataStore` têm informações da LCA. Se estiver definido como `true`, os dados de origem têm de ter uma ACL. A ACL é carregada quando os dados são carregados através de métodos `DocumentService.ImportDocuments`. Quando a ACL está ativada para o elemento `DataStore`, não é possível aceder ao elemento `Document` chamando `DocumentService.GetDocument` ou `DocumentService.ListDocuments`. Atualmente, a ACL só é suportada no setor vertical `GENERIC` com uma configuração de conteúdo não `PUBLIC_WEBSITE`.
`workspace_config`	`WorkspaceConfig` Configuração para armazenar a configuração do tipo de armazenamento de dados para dados do Workspace. Tem de ser definido quando `DataStore.content_config` está definido como `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Configuração para a interpretação e o enriquecimento de documentos.
`starting_schema`	`Schema` O esquema de início a usar para este `DataStore` quando o aprovisionar. Se não estiver definida, é usado um esquema especializado vertical predefinido. Este campo só é usado pela API `CreateDataStore` e é ignorado se for usado noutras APIs. Este campo é omitido de todas as respostas da API, incluindo a API `CreateDataStore`. Para obter um esquema de um `DataStore`, use a API `SchemaService.GetSchema`. O esquema fornecido é validado em função de determinadas regras no esquema. Saiba mais neste documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Configuração para o vertical `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Opcional. Armazena a configuração de publicação ao nível do DataStore.
`identity_mapping_store`	`string` Imutável. O nome do recurso totalmente qualificado do `IdentityMappingStore` associado. Este campo só pode ser definido para DataStores com acl_enabled com o IdP `THIRD_PARTY` ou `GSUITE`. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Opcional. Se estiver definido, este DataStore é um DataStore de Perguntas frequentes do Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Opcional. Configuração para uma abordagem de faturação configurável. Consulte

BillingEstimation

Estimativa do tamanho dos dados por arquivo de dados.

Campos
`structured_data_size`	`int64` Tamanho dos dados para dados estruturados em bytes.
`unstructured_data_size`	`int64` Tamanho dos dados não estruturados em bytes.
`website_data_size`	`int64` Tamanho dos dados para Websites em bytes.
`structured_data_update_time`	`Timestamp` Data/hora da última atualização dos dados estruturados.
`unstructured_data_update_time`	`Timestamp` Data/hora da última atualização dos dados não estruturados.
`website_data_update_time`	`Timestamp` Data/hora da última atualização para Websites.

ConfigurableBillingApproach

Configuração para uma abordagem de faturação configurável.

Enumerações
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predefinido. Para o Spark e a abordagem de faturação não configurável não Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Use a base de subscrição + a faturação de excesso para a indexação do núcleo para armazenamento sem incorporação.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Use a faturação de consumo pré-paga para incorporar o suplemento de armazenamento.

ContentConfig

Configuração do conteúdo do arquivo de dados.

Enumerações
`CONTENT_CONFIG_UNSPECIFIED`	Valor predefinido.
`NO_CONTENT`	Contém apenas documentos sem `Document.content`.
`CONTENT_REQUIRED`	Contém apenas documentos com `Document.content`.
`PUBLIC_WEBSITE`	O armazenamento de dados é usado para a pesquisa pública de Websites.
`GOOGLE_WORKSPACE`	O armazenamento de dados é usado para a pesquisa do espaço de trabalho. Os detalhes do arquivo de dados do espaço de trabalho são especificados no `WorkspaceConfig`.

ServingConfigDataStore

Armazena informações relativas às configurações de publicação ao nível do DataStore.

Campos

disabled_for_serving

bool

Opcional. Se for definido como verdadeiro, o DataStore não vai estar disponível para publicar pedidos de pesquisa.

DeleteAssistantRequest

Mensagem de pedido para o método AssistantService.DeleteAssistant.

Campos

name

string

Obrigatório. Nome do recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Se o autor da chamada não tiver autorização para eliminar o Assistant, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Assistant a eliminar não existir, é devolvido um erro NOT_FOUND.

DeleteCmekConfigMetadata

Metadados relacionados com o progresso da operação CmekConfigService.DeleteCmekConfig. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteCmekConfigRequest

Mensagem de pedido para o método CmekConfigService.DeleteCmekConfig.

Campos

name

string

Obrigatório. O nome do recurso do CmekConfig a eliminar, como projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Metadados relacionados com o progresso da operação [CollectionService.UpdateCollection][]. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteCollectionRequest

Mensagem de pedido para o método CollectionService.DeleteCollection.

Campos

name

string

Obrigatório. O nome completo do recurso da coleção, no formato projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Pedido do método DeleteControl.

Campos

name

string

Obrigatório. O nome do recurso do controlo a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Pedido do método DeleteConversation.

Campos

name

string

Obrigatório. O nome do recurso da conversa a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadados relacionados com o progresso da operação DataStoreService.DeleteDataStore. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteDataStoreRequest

Mensagem de pedido para o método DataStoreService.DeleteDataStore.

Campos

name

string

Obrigatório. Nome completo do recurso de DataStore, como projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Se o autor da chamada não tiver autorização para eliminar o DataStore, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o DataStore a eliminar não existir, é devolvido um erro NOT_FOUND.

DeleteDocumentRequest

Mensagem de pedido para o método DocumentService.DeleteDocument.

Campos

name

string

Obrigatório. Nome completo do recurso de Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Se o autor da chamada não tiver autorização para eliminar o Document, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Document a eliminar não existir, é devolvido um erro NOT_FOUND.

DeleteEngineMetadata

Metadados relacionados com o progresso da operação EngineService.DeleteEngine. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteEngineRequest

Mensagem de pedido para o método EngineService.DeleteEngine.

Campos

name

string

Obrigatório. Nome completo do recurso de Engine, como projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Se o autor da chamada não tiver autorização para eliminar o Engine, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Engine a eliminar não existir, é devolvido um erro NOT_FOUND.

DeleteIdentityMappingStoreMetadata

Metadados relacionados com o progresso da operação IdentityMappingStoreService.DeleteIdentityMappingStore. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteIdentityMappingStoreRequest

Pedido de mensagem para IdentityMappingStoreService.DeleteIdentityMappingStore

Campos

name

string

Obrigatório. O nome da loja de mapeamento de identidades a eliminar. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadados para o LRO DeleteSchema.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteSchemaRequest

Mensagem de pedido para o método SchemaService.DeleteSchema.

Campos

name

string

Obrigatório. O nome completo do recurso do esquema, no formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteSessionRequest

Pedido do método DeleteSession.

Campos

name

string

Obrigatório. O nome do recurso da sessão a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.DeleteSitemap. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteSitemapRequest

Mensagem de pedido para o método SiteSearchEngineService.DeleteSitemap.

Campos

name

string

Obrigatório. Nome completo do recurso de Sitemap, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

Se o autor da chamada não tiver autorização para aceder ao Sitemap, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Sitemap pedido não existir, é devolvido um erro NOT_FOUND.

DeleteTargetSiteMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.DeleteTargetSite. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DeleteTargetSiteRequest

Mensagem de pedido para o método SiteSearchEngineService.DeleteTargetSite.

Campos

name

string

Obrigatório. Nome completo do recurso de TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Se o autor da chamada não tiver autorização para aceder ao TargetSite, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o TargetSite pedido não existir, é devolvido um erro NOT_FOUND.

DestinationConfig

Define os pontos finais de destino usados para estabelecer ligação a fontes externas.

Campos
`key`	`string` Opcional. Identificador de destino exclusivo suportado pelo conector.
`destinations[]`	`Destination` Opcional. Os destinos da chave correspondente.
Campo de união `destination_config_params`. Parâmetros adicionais para esta configuração de destino. `destination_config_params` só pode ser uma das seguintes opções:
`params`	`Struct` Opcional. Parâmetros adicionais para esta configuração de destino no formato JSON estruturado.
`json_params`	`string` Parâmetros adicionais para esta configuração de destino no formato de string JSON.

Destino

Define um ponto final de destino

Campos

port

int32

Opcional. Número da porta de destino aceite pelo destino.

Campo de união destination. O destino do ponto final. destination só pode ser uma das seguintes opções:

host

string

Anfitrião encaminhável publicamente.

DisableAdvancedSiteSearchMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.DisableAdvancedSiteSearch. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

DisableAdvancedSiteSearchRequest

Mensagem de pedido para o método SiteSearchEngineService.DisableAdvancedSiteSearch.

Campos

site_search_engine

string

Obrigatório. Nome completo do recurso SiteSearchEngine, como projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

Este tipo não tem campos.

Mensagem de resposta para o método SiteSearchEngineService.DisableAdvancedSiteSearch.

Documento

O documento capta todas as informações de metadados não processados dos itens a recomendar ou pesquisar.

Campos
`name`	`string` Imutável. O nome de recurso completo do documento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
`id`	`string` Imutável. O identificador do documento. O ID deve estar em conformidade com a norma RFC-1034 com um limite de 128 carateres.
`schema_id`	`string` O identificador do esquema localizado no mesmo repositório de dados.
`content`	`Content` Os dados não estruturados associados a este documento. O conteúdo só pode ser definido e tem de ser definido se este documento estiver num arquivo de dados `CONTENT_REQUIRED`.
`parent_document_id`	`string` O identificador do documento principal. Atualmente, suporta uma hierarquia de documentos de, no máximo, dois níveis. O ID deve estar em conformidade com a norma RFC-1034 com um limite de comprimento de 63 carateres.
`derived_struct_data`	`Struct` Apenas saída. Este campo é OUTPUT_ONLY. Contém dados derivados que não estão no documento de entrada original.
`acl_info`	`AclInfo` Informações de controlo de acesso para o documento.
`index_time`	`Timestamp` Apenas saída. A última vez que o documento foi indexado. Se este campo estiver definido, o documento pode ser devolvido nos resultados da pesquisa. Este campo é OUTPUT_ONLY. Se este campo não estiver preenchido, significa que o documento nunca foi indexado.
`index_status`	`IndexStatus` Apenas saída. O estado do índice do documento. Se o documento for indexado com êxito, o campo index_time é preenchido. Caso contrário, se o documento não estiver indexado devido a erros, o campo error_samples é preenchido. Caso contrário, se a indexação do documento estiver em curso, o campo pending_message é preenchido.
Campo de união `data`. Representação de dados. Deve ser fornecida uma das propriedades `struct_data` ou `json_data`. Caso contrário, é gerado um erro `INVALID_ARGUMENT`. `data` só pode ser uma das seguintes opções:
`struct_data`	`Struct` Os dados JSON estruturados para o documento. Deve estar em conformidade com o `Schema` registado ou é gerado um erro `INVALID_ARGUMENT`.
`json_data`	`string` A representação de string JSON do documento. Deve estar em conformidade com o `Schema` registado ou é gerado um erro `INVALID_ARGUMENT`.

AclInfo

Informações da ACL do documento.

Campos

readers[]

AccessRestriction

Leitores do documento.

AccessRestriction

AclRestriction para modelar restrições de herança complexas.

Exemplo: modelagem de uma herança "Ambos permitir", em que, para aceder a um documento secundário, o utilizador tem de ter acesso ao documento principal.

Hierarquia de documentos: Space_S --> Page_P.

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

Restrição da 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" } ], } ] } }

Campos

principals[]

Principal

Lista de diretores.

idp_wide

bool

Todos os utilizadores no fornecedor de identidade.

Conteúdo

Dados não estruturados associados a este documento.

Campos
`mime_type`	`string` O tipo MIME do conteúdo. Tipos suportados: `application/pdf` (PDF, apenas são suportados PDFs nativos de momento) `text/html` (HTML) `text/plain` (TXT) `application/xml` ou `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) Os seguintes tipos só são suportados se o analisador de esquemas estiver ativado no arquivo de dados: `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) Consulte https://www.iana.org/assignments/media-types/media-types.xhtml.
Campo de união `content`. O conteúdo do documento não estruturado. `content` só pode ser uma das seguintes opções:
`raw_bytes`	`bytes` O conteúdo representado como uma stream de bytes. O comprimento máximo é de 1 000 000 bytes (1 MB / ~0,95 MiB). Nota: tal como acontece com todos os campos `bytes`, este campo é representado como binário puro em buffers de protocolo e como uma string codificada em base64 em JSON. Por exemplo, `abc123!?$*&()'-=@~` deve ser representado como `YWJjMTIzIT8kKiYoKSctPUB+` em JSON. Consulte https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` O URI do conteúdo. Apenas são suportados URIs do Cloud Storage (por exemplo, `gs://bucket-name/path/to/file`). O tamanho máximo do ficheiro é de 2, 5 MB para formatos baseados em texto e de 200 MB para outros formatos.

IndexStatus

Estado de indexação do documento.

Campos

index_time

A hora em que o documento foi indexado. Se este campo estiver preenchido, significa que o documento foi indexado.

error_samples[]

LayoutBasedChunkingConfig

Um exemplo dos erros encontrados durante a indexação do documento. Se este campo estiver preenchido, o documento não é indexado devido a erros.

pending_message

string

Imutável. A mensagem indica que a indexação de documentos está em curso. Se este campo estiver preenchido, o índice do documento está pendente.

DocumentInfo

Informações detalhadas do documento associadas a um evento do utilizador.

Campos
`promotion_ids[]`	`string` Os IDs das promoções associadas a este documento. Atualmente, este campo está restrito a, no máximo, um ID.
`joined`	`bool` Apenas saída. Se é possível encontrar o documento referenciado no repositório de dados.
Campo de união `document_descriptor`. Um descritor obrigatório do `Document` associado. Se `id` for especificado, os valores predefinidos de `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` são usados ao anotar com o documento armazenado. Se `name` for especificado, os valores fornecidos (valores predefinidos permitidos) para `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` são usados ao anotar com o documento armazenado. `document_descriptor` só pode ser uma das seguintes opções:
`id`	`string` O ID do recurso `Document`.
`name`	`string` O nome completo do recurso `Document`, no formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` O URI `Document` só é permitido para armazenamentos de dados de Websites.
`quantity`	`int32` Quantidade do documento associado ao evento do utilizador. A predefinição é 1. Por exemplo, este campo é 2 se estiverem envolvidas duas quantidades do mesmo documento num evento `add-to-cart`. Obrigatório para eventos dos seguintes tipos de eventos: `add-to-cart` `purchase`
`conversion_value`	`float` Opcional. O valor de conversão associado a este documento. Tem de ser definido se `UserEvent.event_type` for "conversion". Por exemplo, um valor de 1000 significa que foram gastos 1000 segundos a ver um documento para o tipo de conversão `watch`.

DocumentProcessingConfig

Um recurso singleton de DataStore. Se estiver vazio quando DataStore é criado e DataStore estiver definido como DataStore.ContentConfig.CONTENT_REQUIRED, o analisador predefinido é o analisador digital.

Campos
`name`	`string` O nome completo do recurso da configuração de processamento de documentos. Formato: `projects//locations//collections//dataStores//documentProcessingConfig`.
`chunking_config`	`ChunkingConfig` Se o modo de divisão em partes está ativado.
`default_parsing_config`	`ParsingConfig` Configurações para o analisador de documentos predefinido. Se não for especificado, vamos configurá-lo como DigitalParsingConfig predefinido, e a configuração de análise predefinida será aplicada a todos os tipos de ficheiros para a análise de documentos.
`parsing_config_overrides`	`map<string, ParsingConfig>` Mapeie do tipo de ficheiro para substituir a configuração de análise predefinida com base no tipo de ficheiro. Chaves suportadas: `pdf`: substitui a configuração de análise para ficheiros PDF. É suportada a análise digital, a análise OCR ou a análise de esquemas. `html`: Substitua a configuração de análise para ficheiros HTML. Apenas a análise digital e a análise de esquemas são suportadas. `docx`: substitui a configuração de análise para ficheiros DOCX. Apenas são suportadas a análise digital e a análise de esquemas. `pptx`: substitui a configuração de análise para ficheiros PPTX. Apenas são suportadas a análise digital e a análise de esquemas. `xlsm`: substitui a configuração de análise para ficheiros XLSM. Apenas são suportadas a análise digital e a análise de esquemas. `xlsx`: substitui a configuração de análise para ficheiros XLSX. Apenas são suportadas a análise digital e a análise de esquemas.

ChunkingConfig

Configuração da configuração de divisão em partes.

Campos

Campo de união chunk_mode. Configurações adicionais que definem o comportamento da divisão em blocos. chunk_mode só pode ser uma das seguintes opções:

layout_based_chunking_config

Configuração para a divisão em partes com base no esquema.

LayoutBasedChunkingConfig

Configuração para a divisão em partes com base no esquema.

Campos

chunk_size

int32

O limite de tamanho dos tokens para cada fragmento.

Valores suportados: 100 a 500 (inclusive). Valor predefinido: 500.

include_ancestor_headings

bool

Se deve incluir a anexação de diferentes níveis de títulos a blocos do meio do documento para evitar a perda de contexto.

Valor predefinido: False.

ParsingConfig

Configurações relacionadas aplicadas a um tipo específico de analisador de documentos.

Campos
Campo de união `type_dedicated_config`. Configurações para tipos de processamento de documentos. `type_dedicated_config` só pode ser uma das seguintes opções:
`digital_parsing_config`	`DigitalParsingConfig` Configurações aplicadas ao analisador digital.
`ocr_parsing_config`	`OcrParsingConfig` Configurações aplicadas ao analisador de OCR. Atualmente, aplica-se apenas a PDFs.
`layout_parsing_config`	`LayoutParsingConfig` Configurações aplicadas ao analisador de esquemas.

DigitalParsingConfig

Este tipo não tem campos.

As configurações de análise digital para documentos.

LayoutParsingConfig

As configurações de análise de esquemas para documentos.

Campos
`enable_table_annotation`	`bool` Opcional. Se for verdadeiro, a anotação baseada no MDG é adicionada à tabela durante a análise.
`enable_image_annotation`	`bool` Opcional. Se for verdadeiro, a anotação baseada no MDG é adicionada à imagem durante a análise.
`structured_content_types[]`	`string` Opcional. Contém os tipos de estruturas necessários para extrair do documento. Valores suportados: `shareholder-structure`
`exclude_html_elements[]`	`string` Opcional. Lista de elementos HTML a excluir do conteúdo analisado.
`exclude_html_classes[]`	`string` Opcional. Lista de classes HTML a excluir do conteúdo analisado.
`exclude_html_ids[]`	`string` Opcional. Lista de IDs HTML a excluir do conteúdo analisado.
`enable_get_processed_document`	`bool` Opcional. Se for verdadeiro, o documento processado é disponibilizado para a API GetProcessedDocument.

OcrParsingConfig

As configurações de análise de OCR para documentos.

Campos

enhanced_document_elements[]
(deprecated)

string

[DEPRECATED] Este campo foi descontinuado. Para usar o processamento de elementos de documentos melhorados adicionais, mude para layout_parsing_config.

use_native_text

bool

Se for verdadeiro, usa texto nativo em vez de texto OCR em páginas que contenham texto nativo.

DoubleList

Lista dupla.

Campos

values[]

double

Valores duplos.

EnableAdvancedSiteSearchMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.EnableAdvancedSiteSearch. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

RecommendedForYouFeatureConfig

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

EnableAdvancedSiteSearchRequest

Mensagem de pedido para o método SiteSearchEngineService.EnableAdvancedSiteSearch.

Campos

site_search_engine

string

Obrigatório. Nome completo do recurso SiteSearchEngine, como projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

Este tipo não tem campos.

Mensagem de resposta para o método SiteSearchEngineService.EnableAdvancedSiteSearch.

Motor

Metadados que descrevem os parâmetros de preparação e publicação de um Engine.

Campos
`name`	`string` Imutável. Identificador. O nome do recurso totalmente qualificado do motor. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres. Formato: o `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` do motor deve ter entre 1 e 63 carateres, e os carateres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`display_name`	`string` Obrigatório. O nome a apresentar do motor. Deve ser legível. String codificada em UTF-8 com um limite de 1024 carateres.
`create_time`	`Timestamp` Apenas saída. Data/hora de criação do motor de recomendações.
`update_time`	`Timestamp` Apenas saída. Data/hora da última atualização do motor de recomendações.
`data_store_ids[]`	`string` Opcional. Os arquivos de dados associados a este motor. Para os tipos de motores `SOLUTION_TYPE_SEARCH` e `SOLUTION_TYPE_RECOMMENDATION`, só podem ser associados a, no máximo, um arquivo de dados. Se `solution_type` for `SOLUTION_TYPE_CHAT`, é possível associar vários `DataStore`s no mesmo `Collection` aqui. Tenha em atenção que, quando usado em `CreateEngineRequest`, tem de ser fornecido um ID do DataStore, uma vez que o sistema o usa para as inicializações necessárias.
`solution_type`	`SolutionType` Obrigatório. As soluções do motor.
`industry_vertical`	`IndustryVertical` Opcional. O vertical da indústria em que o motor se regista. A restrição do vertical da indústria de motores baseia-se no seguinte: o vertical no motor tem de corresponder ao vertical do arquivo de dados associado ao motor.`DataStore`
`common_config`	`CommonConfig` Especificação de configuração comum que especifica os metadados do motor.
`app_type`	`AppType` Opcional. Imutável. Este é o tipo de aplicação que este recurso do motor representa. NOTA: este é um novo conceito independente do vertical da indústria ou do tipo de solução existentes.
`disable_analytics`	`bool` Opcional. Se as estatísticas devem ser desativadas para as pesquisas realizadas neste motor.
`features`	`map<string, FeatureState>` Opcional. Configuração de funcionalidades para o motor ativar ou desativar funcionalidades. Chaves suportadas: `*`: todas as funcionalidades, se estiver presente, todas as outras definições de estado das funcionalidades são ignoradas. `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` Opcional. Configuração para uma abordagem de faturação configurável.
Campo de união `engine_config`. Especificações de configuração adicionais que definem o comportamento do motor. `engine_config` só pode ser uma das seguintes opções:
`chat_engine_config`	`ChatEngineConfig` Configurações do motor do Chat. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Configurações do motor de pesquisa. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Configurações do motor de multimédia. Aplicável apenas nas lojas de dados com o setor vertical `solution_type` `SOLUTION_TYPE_RECOMMENDATION` e `IndustryVertical.MEDIA`.
Campo de união `engine_metadata`. Metadados do motor para monitorizar o estado do motor. `engine_metadata` só pode ser uma das seguintes opções:
`chat_engine_metadata`	`ChatEngineMetadata` Apenas saída. Informações adicionais do motor de chat. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_CHAT`.

AppType

A app do motor.

Enumerações
`APP_TYPE_UNSPECIFIED`	Todas as apps não especificadas.
`APP_TYPE_INTRANET`	Tipo de app para a pesquisa de intranet e o Agentspace.

ChatEngineConfig

Configurações para um motor de chat.

Campos

agent_creation_config

AgentCreationConfig

A configuração para gerar o agente do Dialogflow associado a este motor.

Tenha em atenção que estas configurações são consumidas uma vez e transmitidas ao serviço Dialogflow. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor.

dialogflow_agent_to_link

string

O nome do recurso de um agente do Dialogflow existente para associar a este motor do Chat. Os clientes podem fornecer agent_creation_config para criar um agente ou fornecer um nome de agente que associe o agente ao motor de chat.

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

Tenha em atenção que os dialogflow_agent_to_link são consumidos uma vez e transmitidos ao serviço Dialogflow. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor. Use ChatEngineMetadata.dialogflow_agent para a associação real de agentes após a criação do motor.

allow_cross_region

bool

Opcional. Se a flag estiver definida como verdadeira, permitimos que o agente e o motor estejam em localizações diferentes. Caso contrário, o agente e o motor têm de estar na mesma localização. A sinalização está predefinida como false.

Tenha em atenção que os allow_cross_region são consumidos uma vez e transmitidos ao EngineService.CreateEngine. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor.

AgentCreationConfig

Configurações para gerar um agente do Dialogflow.

Campos
`business`	`string` Nome da empresa, organização ou outra entidade que o agente representa. Usado para o comando do GML do conetor de conhecimentos e para a pesquisa de conhecimentos.
`default_language_code`	`string` Obrigatório. O idioma predefinido do agente como uma etiqueta de idioma. Consulte o artigo Suporte de idiomas para ver uma lista dos códigos de idiomas atualmente suportados.
`time_zone`	`string` Obrigatório. O fuso horário do agente da base de dados de fusos horários, por exemplo: America/New_York, Europe/Paris.
`location`	`string` Localização do agente para a criação de agentes. Valores suportados: global/us/eu. Se não for fornecido, o motor us cria o agente usando us-central-1 por predefinição; o motor eu cria o agente usando eu-west-1 por predefinição.

ChatEngineMetadata

Informações adicionais de um motor de chat. Os campos nesta mensagem são apenas de saída.

Campos

dialogflow_agent

string

O nome do recurso de um agente do Dialogflow ao qual este motor do Chat se refere.

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

CommonConfig

Configurações comuns para um motor.

Campos

company_name

string

O nome da empresa, da empresa ou da entidade associada ao motor. A definição desta opção pode ajudar a melhorar as funcionalidades relacionadas com o MDG.

ConfigurableBillingApproach

Configuração para uma abordagem de faturação configurável.

Enumerações
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predefinido. Para o Spark e a abordagem de faturação não configurável não Spark. Modelo de preços geral.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	A abordagem de faturação segue as configurações especificadas pelo cliente.

FeatureState

O estado da funcionalidade para o motor.

Enumerações
`FEATURE_STATE_UNSPECIFIED`	O estado da funcionalidade não está especificado.
`FEATURE_STATE_ON`	A funcionalidade está ativada para ser acessível.
`FEATURE_STATE_OFF`	A funcionalidade está desativada para ficar inacessível.

MediaRecommendationEngineConfig

Especificações de configuração adicionais para um motor de recomendações de conteúdo multimédia.

Campos
`type`	`string` Obrigatório. O tipo de motor. Por exemplo: `recommended-for-you`. Este campo, juntamente com `optimization_objective`, descreve os metadados do motor a usar para controlar a preparação e a publicação do motor. Valores atualmente suportados: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
`optimization_objective`	`string` O objetivo de otimização. Por exemplo: `cvr`. Este campo, juntamente com `optimization_objective`, descreve os metadados do motor a usar para controlar a preparação e a publicação do motor. Valores atualmente suportados: `ctr`, `cvr`. Se não for especificado, escolhemos o valor predefinido com base no tipo de motor. A predefinição depende do tipo de recomendação: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` Nome e valor do limite personalizado para o objetivo de otimização cvr. Para target_field `watch-time`, target_field_value tem de ser um valor inteiro que indique o tempo de progresso do conteúdo multimédia em segundos entre (0, 86400] (exclui 0, inclui 86400) (por exemplo, 90). Para target_field `watch-percentage`, o target_field_value tem de ser um valor flutuante válido entre (0, 1.0] (exclui 0, inclui 1.0) (por exemplo, 0,5).
`training_state`	`TrainingState` O estado de preparação em que o motor se encontra (por exemplo, `TRAINING` ou `PAUSED`). Uma vez que parte do custo de execução do serviço é a frequência do treino, isto pode ser usado para determinar quando treinar o motor de modo a controlar o custo. Se não for especificado: o valor predefinido para o método `CreateEngine` é `TRAINING`. O valor predefinido do método `UpdateEngine` é manter o estado igual ao anterior.
`engine_features_config`	`EngineFeaturesConfig` Opcional. Configuração de funcionalidades adicionais do motor

EngineFeaturesConfig

Mais configurações de funcionalidades do tipo de motor selecionado.

Campos

Campo de união type_dedicated_config. Configurações relacionadas com funcionalidades aplicadas a um tipo específico de motores de recomendações de multimédia. type_dedicated_config só pode ser uma das seguintes opções:

recommended_for_you_config

Recomendado para a configuração de funcionalidades do motor.

most_popular_config

MostPopularFeatureConfig

Configuração da funcionalidade do motor mais popular.

MostPopularFeatureConfig

Configurações de funcionalidades necessárias para criar um motor Mais popular.

Campos

time_window_days

int64

O período durante o qual o motor é consultado no momento da preparação e da previsão. Apenas números inteiros positivos. O valor é traduzido para os últimos X dias de eventos. Atualmente, é necessário para o motor most-popular-items.

OptimizationObjectiveConfig

Limite personalizado para o optimization_objective cvr.

Campos

target_field

string

Obrigatório. O nome do campo a segmentar. Valores atualmente suportados: watch-percentage, watch-time.

target_field_value_float

float

Obrigatório. O limite a aplicar ao alvo (por exemplo, 0,5).

RecommendedForYouFeatureConfig

Configurações de funcionalidades adicionais para criar um motor do tipo recommended-for-you.

Campos

context_event_type

string

O tipo de evento com o qual o motor é consultado no momento da previsão. Se estiver definido como generic, apenas view-item, media-play e media-complete são usados como context-event na preparação do motor. Se estiver definido como view-home-page, view-home-page também é usado como context-events, além de view-item, media-play e media-complete. Atualmente, suportado para o motor recommended-for-you. Valores atualmente suportados: view-home-page, generic.

TrainingState

O estado de preparação do motor.

Enumerações
`TRAINING_STATE_UNSPECIFIED`	Estado de preparação não especificado.
`PAUSED`	A preparação do motor está pausada.
`TRAINING`	O motor está a ser preparado.

SearchEngineConfig

Configurações de um motor de pesquisa.

Campos

search_tier

SearchTier

O nível da funcionalidade de pesquisa deste motor.

Os diferentes níveis podem ter preços diferentes. Para saber mais, consulte a documentação de preços.

A predefinição é SearchTier.SEARCH_TIER_STANDARD se não for especificado.

search_add_ons[]

SearchAddOn

O suplemento que este motor de pesquisa ativa.

FactChunk

Fact Chunk.

Campos
`chunk_text`	`string` Conteúdo de texto do fragmento de factos. Pode ter, no máximo, 10 000 carateres.
`source`	`string` Origem a partir da qual este fragmento de facto foi obtido. Se foi obtido a partir dos GroundingFacts fornecidos no pedido, este campo contém o índice do facto específico a partir do qual este fragmento foi obtido.
`index`	`int32` O índice deste fragmento. Atualmente, apenas usado para o modo de streaming.
`source_metadata`	`map<string, string>` Informações mais detalhadas para a referência da fonte.
`uri`	`string` O URI da origem.
`title`	`string` O título da fonte.
`domain`	`string` O domínio da origem.

FetchDomainVerificationStatusRequest

Mensagem de pedido para o método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

site_search_engine

string

Obrigatório. O recurso do motor de pesquisa do site no qual obtemos todo o estado de validação do domínio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Tamanho da página solicitado. O servidor pode devolver menos itens do que o pedido. Se não for especificado, o servidor escolhe uma predefinição adequada. O valor máximo é 1000. Os valores superiores a 1000 são convertidos para 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.

page_token

string

Um token de página, recebido de uma chamada FetchDomainVerificationStatus anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a FetchDomainVerificationStatus têm de corresponder à chamada que forneceu o token da página.

FetchDomainVerificationStatusResponse

Mensagem de resposta para o método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

target_sites[]

Lista de TargetSites que contêm o estado de validação do site.

next_page_token

string

Um token que pode ser enviado como page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

total_size

int32

O número total de itens que correspondem ao pedido. Este campo é sempre preenchido na resposta.

FetchSitemapsRequest

Mensagem de pedido para o método SiteSearchEngineService.FetchSitemaps.

Campos

parent

string

Obrigatório. Nome do recurso principal de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Opcional. Se especificado, obtém os Sitemaps correspondentes. Se não for especificado, obtém todos os Sitemaps no DataStore.

Encontrar correspondências

Matcher para os Sitemaps. Atualmente, só é compatível com o matcher de URIs.

Campos

Campo de união matcher. Matcher para os Sitemaps. matcher só pode ser uma das seguintes opções:

uris_matcher

UrisMatcher

Matcher por URIs do mapa do site.

UrisMatcher

Matcher para os Sitemaps pelos respetivos URIs.

Campos

uris[]

string

Os URIs Sitemap.

FetchSitemapsResponse

Mensagem de resposta para o método SiteSearchEngineService.FetchSitemaps.

Campos

sitemaps_metadata[]

SitemapMetadata

Lista de Sitemaps obtidos.

SitemapMetadata

Contém um Sitemap e os respetivos metadados.

Campos

sitemap

Sitemap

O Sitemap.

FhirStoreSource

Cloud FhirStore source import data from.

Campos
`fhir_store`	`string` Obrigatório. O nome completo do recurso da loja FHIR a partir da qual quer importar dados, no formato `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Diretório do Cloud Storage intermédio usado para a importação com um limite de comprimento de 2000 carateres. Pode ser especificado se quiser que o FhirStore seja exportado para um diretório específico do Cloud Storage.
`resource_types[]`	`string` Os tipos de recursos FHIR a importar. Os tipos de recursos devem ser um subconjunto de todos os tipos de recursos FHIR suportados. Por predefinição, todos os tipos de recursos FHIR suportados, se estiver vazio.
`update_from_latest_predefined_schema`	`bool` Opcional. Se deve atualizar o esquema do DataStore para o esquema predefinido mais recente. Se for verdadeiro, o esquema do DataStore é atualizado para incluir quaisquer campos FHIR ou tipos de recursos que tenham sido adicionados desde a última importação, e os recursos FHIR correspondentes são importados da loja FHIR. Tenha em atenção que este campo não pode ser usado em conjunto com `resource_types`. Deve ser usado após a importação inicial.

FirestoreSource

Origem do Firestore a partir da qual importar dados.

Campos
`project_id`	`string` O ID do projeto em que a origem do Cloud SQL se encontra, com um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`database_id`	`string` Obrigatório. A base de dados do Firestore a partir da qual copiar os dados, com um limite de comprimento de 256 carateres.
`collection_id`	`string` Obrigatório. A coleção (ou entidade) do Firestore a partir da qual copiar os dados,com um limite de comprimento de 1500 carateres.
`gcs_staging_dir`	`string` Diretório do Cloud Storage intermédio usado para a importação com um limite de comprimento de 2000 carateres. Pode ser especificado se quiser que a exportação do Firestore seja feita para um diretório específico do Cloud Storage. Certifique-se de que a conta de serviço do Firestore tem as autorizações de administrador do Cloud Storage necessárias para aceder ao diretório do Cloud Storage especificado.

GcsSource

Localização do Cloud Storage para conteúdo de entrada.

Campos

input_uris[]

string

Obrigatório. URIs do Cloud Storage para introduzir ficheiros. Cada URI pode ter até 2000 carateres. Os URIs podem corresponder ao caminho completo do objeto (por exemplo, gs://bucket/directory/object.json) ou a um padrão que corresponda a um ou mais ficheiros, como gs://bucket/directory/*.json.

Uma solicitação pode conter, no máximo, 100 ficheiros (ou 100 000 ficheiros se data_schema for content). Cada ficheiro pode ter até 2 GB (ou 100 MB se data_schema for content).

data_schema

string

O esquema a usar quando analisar os dados da origem.

Valores suportados para importações de documentos:

document (predefinição): um JSON Document por linha. Cada documento tem de ter um Document.id válido.
content: dados não estruturados (por exemplo, PDF, HTML). Cada ficheiro correspondente a input_uris torna-se um documento, com o ID definido como os primeiros 128 bits de SHA256(URI) codificados como uma string hexadecimal.
custom: um JSON de dados personalizado por linha num formato arbitrário que esteja em conformidade com o Schema definido do armazenamento de dados. Só pode ser usado pelo vertical da loja de dados GENERIC.
csv: um ficheiro CSV com um cabeçalho em conformidade com o Schema definido da loja de dados. Cada entrada após o cabeçalho é importada como um documento. Só pode ser usado pela vertical GENERIC Data Store.

Valores suportados para importações de eventos de utilizadores:

user_event (predefinição): um JSON UserEvent por linha.

GetAclConfigRequest

Mensagem de pedido para o método GetAclConfigRequest.

Campos

name

string

Obrigatório. Nome do recurso de AclConfig, como projects/*/locations/*/aclConfig.

Se o autor da chamada não tiver autorização para aceder ao AclConfig, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

GetAnswerRequest

Pedido para o método GetAnswer.

Campos

name

string

Obrigatório. O nome do recurso da resposta a obter. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Mensagem de pedido para o método AssistAnswerService.GetAssistAnswer.

Campos

name

string

Obrigatório. Nome do recurso do AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Mensagem de pedido para o método AssistantService.GetAssistant.

Campos

name

string

Obrigatório. Nome do recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

Mensagem de pedido para o método GetCmekConfigRequest.

Campos

name

string

Obrigatório. Nome do recurso de CmekConfig, como projects/*/locations/*/cmekConfig ou projects/*/locations/*/cmekConfigs/*.

Se o autor da chamada não tiver autorização para aceder ao CmekConfig, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

GetControlRequest

Pedido do método GetControl.

Campos

name

string

Obrigatório. O nome do recurso do controlo a obter. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Pedido para o método GetConversation.

Campos

name

string

Obrigatório. O nome do recurso da conversa a obter. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Pedido para o método DataConnectorService.GetDataConnector.

Campos

name

string

Obrigatório. Nome completo do recurso de DataConnector, como projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

Se o autor da chamada não tiver autorização para aceder ao DataConnector, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o DataConnector pedido não existir, é devolvido um erro NOT_FOUND.

GetDataStoreRequest

Mensagem de pedido para o método DataStoreService.GetDataStore.

Campos

name

string

Obrigatório. Nome completo do recurso de DataStore, como projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Se o autor da chamada não tiver autorização para aceder ao DataStore, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o DataStore pedido não existir, é devolvido um erro NOT_FOUND.

GetDocumentRequest

Mensagem de pedido para o método DocumentService.GetDocument.

Campos

name

string

Obrigatório. Nome completo do recurso de Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Se o autor da chamada não tiver autorização para aceder ao Document, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Document pedido não existir, é devolvido um erro NOT_FOUND.

GetEngineRequest

Mensagem de pedido para o método EngineService.GetEngine.

Campos

name

string

Obrigatório. Nome completo do recurso de Engine, como projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetIdentityMappingStoreRequest

Pedido de mensagem para IdentityMappingStoreService.GetIdentityMappingStore

Campos

name

string

Obrigatório. O nome da loja de mapeamento de identidades a obter. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Mensagem de pedido para o método LicenseConfigService.GetLicenseConfig.

Campos

name

string

Obrigatório. Nome completo do recurso de LicenseConfig, como projects/{project}/locations/{location}/licenseConfigs/*.

Se o autor da chamada não tiver autorização para aceder ao LicenseConfig, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o LicenseConfig pedido não existir, é devolvido um erro NOT_FOUND.

GetSchemaRequest

Mensagem de pedido para o método SchemaService.GetSchema.

Campos

name

string

Obrigatório. O nome completo do recurso do esquema, no formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSessionRequest

Pedido para o método GetSession.

Campos

name

string

Obrigatório. O nome do recurso da sessão a obter. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Opcional. Se for definida como verdadeira, é devolvida a sessão completa, incluindo todos os detalhes das respostas.

GetSiteSearchEngineRequest

Mensagem de pedido para o método SiteSearchEngineService.GetSiteSearchEngine.

Campos

name

string

Obrigatório. Nome do recurso de SiteSearchEngine, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Se o autor da chamada não tiver autorização para aceder ao [SiteSearchEngine], independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

GetTargetSiteRequest

Mensagem de pedido para o método SiteSearchEngineService.GetTargetSite.

Campos

name

string

Obrigatório. Nome completo do recurso de TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Se o autor da chamada não tiver autorização para aceder ao TargetSite, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o TargetSite pedido não existir, é devolvido um erro NOT_FOUND.

GroundingFact

Facto de fundamentação.

Campos

fact_text

string

Conteúdo de texto do facto. Pode ter, no máximo, 10 000 carateres.

attributes

map<string, string>

Atributos associados ao facto. Os atributos comuns incluem source (que indica a origem do facto), author (que indica o autor do facto) e assim sucessivamente.

HarmCategory

Categorias de danos que bloqueiam o conteúdo.

Enumerações
`HARM_CATEGORY_UNSPECIFIED`	A categoria de danos não está especificada.
`HARM_CATEGORY_HATE_SPEECH`	A categoria de conteúdo prejudicial é incitamento ao ódio.
`HARM_CATEGORY_DANGEROUS_CONTENT`	A categoria de danos é conteúdo perigoso.
`HARM_CATEGORY_HARASSMENT`	A categoria de danos é assédio.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	A categoria de danos é conteúdo sexualmente explícito.
`HARM_CATEGORY_CIVIC_INTEGRITY`	A categoria de danos é integridade cívica.

HealthcareFhirConfig

Configuração para o armazenamento de dados para a vertical HEALTHCARE_FHIR.

Campos

enable_configurable_schema

bool

Se deve ativar o esquema configurável para o vertical HEALTHCARE_FHIR.

Se estiver definido como true, o esquema FHIR de cuidados de saúde predefinido pode ser expandido para uma pesquisa e uma filtragem mais personalizadas.

enable_static_indexing_for_batch_ingestion

bool

Se deve ativar a indexação estática para o carregamento em lote HEALTHCARE_FHIR.

Se estiver definido como true, o carregamento em lote é processado num modo de indexação estático, que é mais lento, mas mais capaz de processar um volume maior.

IdentityMappingEntry

Entrada de mapeamento de identidade que mapeia uma identidade externa para uma identidade interna.

Campos
`external_identity`	`string` Obrigatório. Identidade fora do fornecedor de identidade do cliente. O limite de comprimento da identidade externa é de 100 carateres.
Campo de união `identity_provider_id`. Campo de união identity_provider_id. O ID do fornecedor de identidade pode ser um utilizador ou um grupo. `identity_provider_id` só pode ser uma das seguintes opções:
`user_id`	`string` Identificador do utilizador. Para uma conta de utilizador do Google Workspace, o user_id deve ser o email do utilizador do Google Workspace. Para um fornecedor de identidade que não seja da Google, user_id é o identificador do utilizador mapeado configurado durante a configuração do workforcepool.
`group_id`	`string` Identificador do grupo. Para uma conta de utilizador do Google Workspace, group_id deve ser o email do grupo do Google Workspace. Para um fornecedor de identidade não Google, group_id é o identificador do grupo mapeado configurado durante a configuração do workforcepool.

IdentityMappingEntryOperationMetadata

Metadados IdentityMappingEntry LongRunningOperation para IdentityMappingStoreService.ImportIdentityMappings e IdentityMappingStoreService.PurgeIdentityMappings

Campos

success_count

int64

O número de IdentityMappingEntries que foram processados com êxito.

failure_count

int64

O número de IdentityMappingEntries que não foi possível processar.

total_count

int64

O número total de IdentityMappingEntries que foram processados.

IdentityMappingStore

Armazenamento do mapeamento de identidades que contém entradas de mapeamento de identidades.

Campos

name

string

Imutável. O nome completo do recurso da loja de mapeamento de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

kms_key_name

string

Apenas entrada. A chave do KMS a usar para proteger este arquivo de mapeamento de identidades no momento da criação.

Tem de ser definido para pedidos que têm de estar em conformidade com as proteções da política organizacional da CMEK.

Se este campo estiver definido e for processado com êxito, o armazenamento de mapeamento de identidades é protegido pela chave do KMS, conforme indicado no campo cmek_config.

cmek_config

CmekConfig

Apenas saída. Informações relacionadas com a CMEK para o arquivo de mapeamentos de identidades.

IdentityScheduleConfig

A configuração das execuções de sincronização de dados de identidade.

Campos

refresh_interval

Duration

Opcional. O intervalo de atualização para sincronizar as informações da lista de controlo de acesso dos documentos carregados por este conector. Se não for definida, a lista de controlo de acesso é atualizada no intervalo predefinido de 30 minutos. O intervalo de atualização da identidade pode ser de, pelo menos, 30 minutos e, no máximo, 7 dias.

next_sync_time

DateTime

Opcional. A hora UTC em que se espera que a próxima sincronização de dados seja iniciada para o conetor de dados. Os clientes só podem especificar a hora e os minutos para agendar a sincronização de dados. Esta opção é usada quando o conetor de dados tem um intervalo de atualização superior a 1 dia.

IdpConfig

Configuração do Fornecedor de identidade

Campos

idp_type

IdpType

Tipo de Fornecedor de identidade configurado.

external_idp_config

ExternalIdpConfig

Configuração do Fornecedor de identidade externo.

ExternalIdpConfig

Configuração do IdP de terceiros.

Campos

workforce_pool_name

string

Nome do conjunto de trabalhadores. Exemplo: "locations/global/workforcePools/pool_id"

IdpType

Tipo de fornecedor de identidade.

Enumerações
`IDP_TYPE_UNSPECIFIED`	Valor predefinido. A pesquisa de LCA não está ativada.
`GSUITE`	Fornecedor original da Google.
`THIRD_PARTY`	Fornecedor externo.

ImportCompletionSuggestionsMetadata

Metadados relacionados com o progresso da operação ImportCompletionSuggestions. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` Número de `CompletionSuggestion`s importados com êxito.
`failure_count`	`int64` Número de `CompletionSuggestion`s que não foram importados.

ImportCompletionSuggestionsRequest

Mensagem de pedido para o método CompletionService.ImportCompletionSuggestions.

Campos
`parent`	`string` Obrigatório. O nome do recurso da loja de dados principal para o qual importar sugestões de preenchimento automático de clientes. Segue o padrão `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` A localização desejada dos erros incorridos durante a importação.
Campo de união `source`. A origem das sugestões de preenchimento automático. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem inline das entradas de sugestões.
`gcs_source`	`GcsSource` Localização do Cloud Storage para o conteúdo de entrada.
`bigquery_source`	`BigQuerySource` Origem de entrada do BigQuery.

InlineSource

A origem inline para CompletionSuggestions.

Campos

suggestions[]

CompletionSuggestion

Obrigatório. Uma lista de todas as entradas da lista de negações a importar. Máximo de 1000 itens.

ImportCompletionSuggestionsResponse

Resposta do método CompletionService.ImportCompletionSuggestions. Se a operação de longa duração estiver concluída, esta mensagem é devolvida pelo campo google.longrunning.Operations.response se a operação for bem-sucedida.

Campos

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

error_config

ImportErrorConfig

A localização desejada dos erros incorridos durante a importação.

ImportDocumentsMetadata

Metadados relacionados com o progresso da operação ImportDocuments. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` Contagem de entradas que foram processadas com êxito.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.
`total_count`	`int64` Contagem total de entradas processadas.

ImportDocumentsRequest

Mensagem de pedido para métodos de importação.

Campos
`parent`	`string` Obrigatório. O nome do recurso da ramificação principal, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requer autorização para criar/atualizar.
`error_config`	`ImportErrorConfig` A localização desejada dos erros incorridos durante a importação.
`reconciliation_mode`	`ReconciliationMode` O modo de conciliação entre os documentos existentes e os documentos a importar. A predefinição é `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indica os campos nos documentos importados fornecidos a atualizar. Se não for definido, a predefinição é atualizar todos os campos.
`auto_generate_ids`	`bool` Se devem ser gerados automaticamente IDs para os documentos, caso não existam. Se estiver definido como `true`, os `Document.id`s são gerados automaticamente com base no hash da carga útil, em que os IDs podem não ser consistentes durante várias importações. Nesse caso, é altamente recomendável usar `ReconciliationMode.FULL` para evitar conteúdos duplicados. Se não estiver definida ou estiver definida como `false`, os `Document.id`s têm de ser especificados através de `id_field`. Caso contrário, a importação dos documentos sem IDs falha. Origens de dados suportadas: `GcsSource`. `GcsSource.data_schema` tem de ser `custom` ou `csv`. Caso contrário, é gerado um erro INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` tem de ser `custom` ou `csv`. Caso contrário, é gerado um erro INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` O campo indica o campo ou a coluna de ID a usar como IDs únicos dos documentos. Para `GcsSource`, é a chave do campo JSON. Por exemplo, `my_id` para JSON `{"my_id": "some_uuid"}`. Para outros, pode ser o nome da coluna da tabela onde os IDs únicos estão armazenados. Os valores do campo JSON ou da coluna da tabela são usados como os `Document.id`s. O campo JSON ou a coluna da tabela tem de ser do tipo string e os valores têm de ser definidos como strings válidas em conformidade com a RFC-1034 com 1 a 63 carateres. Caso contrário, os documentos sem IDs válidos não são importados. Defina este campo apenas quando `auto_generate_ids` não estiver definido ou estiver definido como `false`. Caso contrário, é gerado um erro INVALID_ARGUMENT. Se não estiver definido, é usado um valor predefinido `_id` quando a importação é feita a partir das origens de dados permitidas. Origens de dados suportadas: `GcsSource`. `GcsSource.data_schema` tem de ser `custom` ou `csv`. Caso contrário, é gerado um erro INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` tem de ser `custom` ou `csv`. Caso contrário, é gerado um erro INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `BigtableSource`.
`force_refresh_content`	`bool` Opcional. Se deve forçar a atualização do conteúdo não estruturado dos documentos. Se estiver definido como `true`, a parte de conteúdo dos documentos é atualizada independentemente do estado de atualização do conteúdo de referência.
Campo de união `source`. Obrigatório. A origem da entrada. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para documentos.
`gcs_source`	`GcsSource` Localização do Cloud Storage para o conteúdo de entrada.
`bigquery_source`	`BigQuerySource` Origem de entrada do BigQuery.
`fhir_store_source`	`FhirStoreSource` Origem de entrada FhirStore.
`spanner_source`	`SpannerSource` Origem de entrada do Spanner.
`cloud_sql_source`	`CloudSqlSource` Origem de entrada do Cloud SQL.
`firestore_source`	`FirestoreSource` Origem de entrada do Firestore.
`alloy_db_source`	`AlloyDbSource` Origem de entrada do AlloyDB.
`bigtable_source`	`BigtableSource` Origem de entrada do Cloud Bigtable.

InlineSource

A origem inline da configuração de entrada para o método ImportDocuments.

Campos

documents[]

Obrigatório. Uma lista de documentos a atualizar/criar. Cada documento tem de ter um Document.id válido. Máximo recomendado de 100 itens.

ReconciliationMode

Indica como os documentos importados são reconciliados com os documentos existentes criados ou importados anteriormente.

Enumerações
`RECONCILIATION_MODE_UNSPECIFIED`	A predefinição é `INCREMENTAL`.
`INCREMENTAL`	Insere novos documentos ou atualiza documentos existentes.
`FULL`	Calcula a diferença e substitui o conjunto de dados do documento inteiro. Os documentos existentes podem ser eliminados se não estiverem presentes na localização de origem. Quando usar este modo, não haverá tempo de inatividade no conjunto de dados segmentado. Qualquer documento que deva permanecer inalterado ou que deva ser atualizado continua a ser publicado enquanto a operação estiver em execução.

ImportDocumentsResponse

Resposta do ImportDocumentsRequest. Se a operação de longa duração estiver concluída, esta mensagem é devolvida pelo campo google.longrunning.Operations.response se a operação tiver sido bem-sucedida.

Campos

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

error_config

ImportErrorConfig

Reflete o destino dos erros completos no pedido, se definido.

ImportErrorConfig

Configuração do destino para erros relacionados com a importação.

Campos

Campo de união destination. Obrigatório. Destino de erros. destination só pode ser uma das seguintes opções:

gcs_prefix

string

Prefixo do Cloud Storage para erros de importação. Tem de ser um diretório do Cloud Storage existente e vazio. Os erros de importação são escritos em ficheiros divididos neste diretório, um por linha, como uma mensagem google.rpc.Status codificada em JSON.

ImportIdentityMappingsRequest

Pedido de mensagem para IdentityMappingStoreService.ImportIdentityMappings

Campos

identity_mapping_store

string

Obrigatório. O nome da loja de mapeamento de identidades para a qual importar entradas de mapeamento de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Campo de união source. A origem da entrada. source só pode ser uma das seguintes opções:

inline_source

InlineSource

A origem inline a partir da qual importar as entradas de mapeamento de identidade.

InlineSource

A origem inline a partir da qual importar as entradas de mapeamento de identidade.

Campos

identity_mapping_entries[]

IdentityMappingEntry

Pode importar um máximo de 10 000 entradas de uma vez

ImportIdentityMappingsResponse

Mensagem de resposta para IdentityMappingStoreService.ImportIdentityMappings

Campos

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

ImportSuggestionDenyListEntriesMetadata

Metadados relacionados com o progresso da operação ImportSuggestionDenyListEntries. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

SuggestionDenyListEntry

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

ImportSuggestionDenyListEntriesRequest

Mensagem de pedido para o método CompletionService.ImportSuggestionDenyListEntries.

Campos
`parent`	`string` Obrigatório. O nome do recurso da loja de dados principal para o qual importar entradas da lista de recusa. Segue o padrão projects//locations//collections//dataStores/.
Campo de união `source`. A origem da SuggestionDenyList atualizada. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem Inline do conteúdo de entrada para entradas da lista de rejeição de sugestões.
`gcs_source`	`GcsSource` Localização do Cloud Storage para o conteúdo de entrada. Só pode especificar 1 ficheiro que contenha todas as entradas a importar. Valores suportados `gcs_source.schema` para importações de entradas da lista de recusa de sugestões de preenchimento automático: `suggestion_deny_list` (predefinição): um [SuggestionDenyListEntry] JSON por linha.

InlineSource

A origem inline de SuggestionDenyListEntry.

Campos

entries[]

Obrigatório. Uma lista de todas as entradas da lista de negações a importar. Máximo de 1000 itens.

ImportSuggestionDenyListEntriesResponse

Mensagem de resposta para o método CompletionService.ImportSuggestionDenyListEntries.

Campos

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

imported_entries_count

int64

Contagem de entradas da lista de recusa importadas com êxito.

failed_entries_count

int64

Contagem de entradas da lista de recusa que não foram importadas.

ImportUserEventsMetadata

Metadados relacionados com o progresso da operação de importação. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` Contagem de entradas que foram processadas com êxito.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.

ImportUserEventsRequest

Mensagem de pedido para o pedido ImportUserEvents.

Campos
`parent`	`string` Obrigatório. Nome do recurso DataStore principal, no formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` A localização desejada dos erros incorridos durante a importação. Não pode ser definido para importações de eventos de utilizadores inline.
Campo de união `source`. Obrigatório: a origem de entrada pretendida dos dados de eventos do utilizador. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para UserEvents.
`gcs_source`	`GcsSource` Localização do Cloud Storage para o conteúdo de entrada.
`bigquery_source`	`BigQuerySource` Origem de entrada do BigQuery.

InlineSource

A origem inline da configuração de entrada para o método ImportUserEvents.

Campos

user_events[]

UserEvent

Obrigatório. Uma lista de eventos do utilizador a importar. Máximo recomendado de 10 000 itens.

ImportUserEventsResponse

Resposta do ImportUserEventsRequest. Se a operação de longa duração tiver sido bem-sucedida, esta mensagem é devolvida pelo campo google.longrunning.Operations.response se a operação tiver sido bem-sucedida.

Campos
`error_samples[]`	`Status` Uma amostra dos erros encontrados durante o processamento do pedido.
`error_config`	`ImportErrorConfig` Reflete o destino dos erros completos se este campo tiver sido definido no pedido.
`joined_events_count`	`int64` Contagem de eventos de utilizadores importados com documentos existentes completos.
`unjoined_events_count`	`int64` Quantidade de eventos de utilizadores importados, mas com informações do documento não encontradas no ramo existente.

IndustryVertical

O vertical da indústria associado ao DataStore.

Enumerações
`INDUSTRY_VERTICAL_UNSPECIFIED`	Valor usado quando não está definido.
`GENERIC`	O vertical genérico para documentos que não são específicos de nenhum vertical da indústria.
`MEDIA`	A vertical da indústria de multimédia.
`HEALTHCARE_FHIR`	A vertical FHIR de cuidados de saúde.

Intervalo

Um intervalo de vírgula flutuante.

Campos

Campo de união min. O limite inferior do intervalo. Se nenhum dos campos min estiver definido, o limite inferior é o infinito negativo.

Este campo não pode ser superior ao valor máximo. Caso contrário, é devolvido um erro INVALID_ARGUMENT. min só pode ser uma das seguintes opções:

minimum

double

Limite inferior inclusivo.

exclusive_minimum

double

Limite inferior exclusivo.

Campo de união max. O limite superior do intervalo. Se nenhum dos campos max estiver definido, o limite superior é o infinito positivo.

Este campo não pode ser inferior ao valor mínimo. Caso contrário, é devolvido um erro INVALID_ARGUMENT. max só pode ser uma das seguintes opções:

maximum

double

Limite superior inclusivo.

exclusive_maximum

double

Limite superior exclusivo.

LicenseConfig

Informações acerca das licenças dos utilizadores.

Campos
`name`	`string` Imutável. Identificador. O nome do recurso totalmente qualificado da configuração da licença. Formato: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Obrigatório. Número de licenças compradas.
`subscription_tier`	`SubscriptionTier` Obrigatório. Informações do nível de subscrição para a configuração da licença.
`state`	`State` Apenas saída. O estado da configuração da licença.
`auto_renew`	`bool` Opcional. Se a configuração da licença deve ser renovada automaticamente quando atingir a data de fim.
`start_date`	`Date` Obrigatório. A data de início.
`end_date`	`Date` Opcional. A data de fim planeada.
`subscription_term`	`SubscriptionTerm` Obrigatório. Prazo da subscrição.
`free_trial`	`bool` Opcional. Se a configuração da licença é para uma avaliação gratuita.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Opcional. A configuração da política de alerta para esta configuração de licença.
`gemini_bundle`	`bool` Apenas saída. Se a configuração da licença é para o pacote do Gemini.

Estado

Enumeração do estado da configuração da licença.

Enumerações
`STATE_UNSPECIFIED`	Valor predefinido. A configuração da licença não existe.
`ACTIVE`	A configuração da licença está em vigor e a ser usada.
`EXPIRED`	A configuração da licença expirou.
`NOT_STARTED`	A configuração da licença ainda não começou e a respetiva data de início está no futuro.

ListAssistantsRequest

Mensagem de pedido para o método AssistantService.ListAssistants.

Campos

parent

string

Obrigatório. O nome do recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Número máximo de Assistants a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Qualquer valor acima deste é forçado a ser 1000.

page_token

string

Um token de página ListAssistantsResponse.next_page_token, recebido de uma chamada AssistantService.ListAssistants anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a ListAssistants têm de corresponder à chamada que forneceu o token da página.

ListAssistantsResponse

Mensagem de resposta para o método AssistantService.ListAssistants.

Campos

assistants[]

Assistant

Todos os Assistants do cliente.

next_page_token

string

Um token que pode ser enviado como ListAssistantsRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListCmekConfigsRequest

Mensagem de pedido para o método CmekConfigService.ListCmekConfigs.

Campos

parent

string

Obrigatório. O nome do recurso de localização principal, como projects/{project}/locations/{location}.

Se o autor da chamada não tiver autorização para listar CmekConfigs nesta localização, independentemente de existir ou não um CmekConfig, é devolvido um erro PERMISSION_DENIED.

ListCmekConfigsResponse

Mensagem de resposta para o método CmekConfigService.ListCmekConfigs.

Campos

cmek_configs[]

CmekConfig

Todos os CmekConfigs do cliente.

ListControlsRequest

Pedido do método ListControls.

Campos
`parent`	`string` Obrigatório. O nome do recurso da loja de dados. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` ou `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`page_size`	`int32` Opcional. Número máximo de resultados a devolver. Se não for especificado, a predefinição é 50. O valor máximo permitido é 1000.
`page_token`	`string` Opcional. Um token de página, recebido de uma chamada `ListControls` anterior. Faculte este valor para obter a página seguinte.
`filter`	`string` Opcional. Um filtro a aplicar nos resultados da lista. Funcionalidades suportadas: Apresenta todos os produtos no ramo principal se `filter` não estiver definido. Atualmente, este campo não é suportado.

ListControlsResponse

Resposta para o método ListControls.

Campos

controls[]

Control

Todos os controlos de um determinado armazenamento de dados.

next_page_token

string

O token de paginação, se não for devolvido, indica a última página.

ListConversationsRequest

Pedido do método ListConversations.

Campos
`parent`	`string` Obrigatório. O nome do recurso da loja de dados. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados a devolver. Se não for especificado, a predefinição é 50. O valor máximo permitido é 1000.
`page_token`	`string` Um token de página, recebido de uma chamada `ListConversations` anterior. Faculte este valor para obter a página seguinte.
`filter`	`string` Um filtro a aplicar nos resultados da lista. As funcionalidades suportadas são: user_pseudo_id e state. Exemplo: "user_pseudo_id = some_id"
`order_by`	`string` Uma lista separada por vírgulas de campos pelos quais ordenar, ordenada por ordem ascendente. Use "desc" após um nome de campo para ordem descendente. Campos suportados: * `update_time` * `create_time` * `conversation_name` Exemplo: "update_time desc" "create_time"

ListConversationsResponse

Resposta para o método ListConversations.

Campos

conversations[]

Todas as conversas para um determinado armazenamento de dados.

next_page_token

string

O token de paginação, se não for devolvido, indica a última página.

ListCustomModelsRequest

Mensagem de pedido para o método SearchTuningService.ListCustomModels.

Campos

data_store

string

Obrigatório. O nome do recurso da loja de dados principal, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo é usado para identificar o armazenamento de dados a partir do qual os modelos devem ser obtidos.

ListCustomModelsResponse

Mensagem de resposta para o método SearchTuningService.ListCustomModels.

Campos

models[]

CustomTuningModel

Lista de modelos de ajuste personalizado.

ListDataStoresRequest

Mensagem de pedido para o método DataStoreService.ListDataStores.

Campos
`parent`	`string` Obrigatório. O nome do recurso da ramificação principal, como `projects/{project}/locations/{location}/collections/{collection_id}`. Se o autor da chamada não tiver autorização para listar `DataStore`s nesta localização, independentemente de este arquivo de dados existir ou não, é devolvido um erro PERMISSION_DENIED.
`page_size`	`int32` Número máximo de `DataStore`s a devolver. Se não for especificado, a predefinição é 10. O valor máximo permitido é 50. Os valores acima de 50 são forçados a 50. Se este campo for negativo, é devolvido um INVALID_ARGUMENT.
`page_token`	`string` Um token de página `ListDataStoresResponse.next_page_token`, recebido de uma chamada `DataStoreService.ListDataStores` anterior. Faculte este valor para obter a página seguinte. Quando paginar, todos os outros parâmetros fornecidos a `DataStoreService.ListDataStores` têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`filter`	`string` Filtre por tipo de solução . Por exemplo: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Mensagem de resposta para o método DataStoreService.ListDataStores.

Campos

data_stores[]

DataStore

Todos os DataStores do cliente.

next_page_token

string

Um token que pode ser enviado como ListDataStoresRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListDocumentsRequest

Mensagem de pedido para o método DocumentService.ListDocuments.

Campos

parent

string

Obrigatório. O nome do recurso da ramificação principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch como ID da filial para listar documentos na filial predefinida.

Se o autor da chamada não tiver autorização para listar Documents nesta ramificação, independentemente de esta ramificação existir ou não, é devolvido um erro PERMISSION_DENIED.

page_size

int32

Número máximo de Documents a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Os valores superiores a 1000 são definidos como 1000.

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.

page_token

string

Um token de página ListDocumentsResponse.next_page_token, recebido de uma chamada DocumentService.ListDocuments anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a DocumentService.ListDocuments têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

ListDocumentsResponse

Mensagem de resposta para o método DocumentService.ListDocuments.

Campos

documents[]

Os anos Document.

next_page_token

string

Um token que pode ser enviado como ListDocumentsRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListEnginesRequest

Mensagem de pedido para o método EngineService.ListEngines.

Campos
`parent`	`string` Obrigatório. O nome do recurso principal, como `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Opcional. Não suportado.
`page_token`	`string` Opcional. Não suportado.
`filter`	`string` Opcional. Filtre por tipo de solução. Por exemplo: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Mensagem de resposta para o método EngineService.ListEngines.

Campos

engines[]

Engine

Todos os Engines do cliente.

next_page_token

string

Não suportado.

ListIdentityMappingStoresRequest

Pedido de mensagem para IdentityMappingStoreService.ListIdentityMappingStores

Campos

parent

string

Obrigatório. O elemento principal das lojas de mapeamento de identidades a apresentar. Formato: projects/{project}/locations/{location}.

page_size

int32

Número máximo de IdentityMappingStores a devolver. Se não for especificado, a predefinição é 100. O valor máximo permitido é 1000. Os valores acima de 1000 são forçados a 1000.

page_token

string

Um token de página, recebido de uma chamada ListIdentityMappingStores anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a ListIdentityMappingStores têm de corresponder à chamada que forneceu o token da página.

ListIdentityMappingStoresResponse

Mensagem de resposta para IdentityMappingStoreService.ListIdentityMappingStores

Campos

identity_mapping_stores[]

IdentityMappingStore

As lojas de mapeamento da identidade.

next_page_token

string

Um token que pode ser enviado como page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListIdentityMappingsRequest

Pedido de mensagem para IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_store

string

Obrigatório. O nome da loja de mapeamento de identidades para listar as entradas de mapeamento de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Número máximo de IdentityMappings a devolver. Se não for especificado, o valor predefinido é 2000. O valor máximo permitido é 10 000. Os valores acima de 10 000 são forçados a 10 000.

page_token

string

Um token de página, recebido de uma chamada ListIdentityMappings anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a ListIdentityMappings têm de corresponder à chamada que forneceu o token da página.

ListIdentityMappingsResponse

Mensagem de resposta para IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_entries[]

IdentityMappingEntry

As entradas de mapeamento da identidade.

next_page_token

string

Um token que pode ser enviado como page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListSchemasRequest

Mensagem de pedido para o método SchemaService.ListSchemas.

Campos

parent

string

Obrigatório. O nome do recurso da loja de dados principal, no formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

O número máximo de Schemas a devolver. O serviço pode devolver um número inferior a este valor.

Se não for especificado, são devolvidos, no máximo, 100 Schemas.

O valor máximo é 1000. Os valores acima de 1000 são definidos como 1000.

page_token

string

Um token de página, recebido de uma chamada SchemaService.ListSchemas anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a SchemaService.ListSchemas têm de corresponder à chamada que forneceu o token da página.

ListSchemasResponse

Mensagem de resposta para o método SchemaService.ListSchemas.

Campos

schemas[]

Schema

Os anos Schema.

next_page_token

string

Um token que pode ser enviado como ListSchemasRequest.page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

ListSessionsRequest

Pedido do método ListSessions.

Campos
`parent`	`string` Obrigatório. O nome do recurso da loja de dados. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados a devolver. Se não for especificado, a predefinição é 50. O valor máximo permitido é 1000.
`page_token`	`string` Um token de página, recebido de uma chamada `ListSessions` anterior. Faculte este valor para obter a página seguinte.
`filter`	`string` Uma lista de campos separados por vírgulas para filtrar, na gramática EBNF. Os campos suportados são: `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` Exemplos: `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` Uma lista separada por vírgulas de campos pelos quais ordenar, ordenada por ordem ascendente. Use "desc" após um nome de campo para ordem descendente. Campos suportados: `update_time` `create_time` `session_name` `is_pinned` Exemplo: `update_time desc` `create_time` `is_pinned desc,update_time desc`: liste as sessões por is_pinned primeiro e, em seguida, por update_time.

ListSessionsResponse

Resposta para o método ListSessions.

Campos

sessions[]

Todas as sessões de um determinado armazenamento de dados.

next_page_token

string

O token de paginação, se não for devolvido, indica a última página.

ListTargetSitesRequest

Mensagem de pedido para o método SiteSearchEngineService.ListTargetSites.

Campos

parent

string

Obrigatório. O nome do recurso do motor de pesquisa do site principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Se o autor da chamada não tiver autorização para listar TargetSites neste motor de pesquisa do site, independentemente de este ramo existir ou não, é devolvido um erro PERMISSION_DENIED.

page_size

int32

Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.

page_token

string

Um token de página, recebido de uma chamada ListTargetSites anterior. Faculte este valor para obter a página seguinte.

Quando paginar, todos os outros parâmetros fornecidos a ListTargetSites têm de corresponder à chamada que forneceu o token da página.

ListTargetSitesResponse

Mensagem de resposta para o método SiteSearchEngineService.ListTargetSites.

Campos

target_sites[]

Lista de TargetSites.

next_page_token

string

Um token que pode ser enviado como page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

total_size

int32

O número total de itens que correspondem ao pedido. Este campo é sempre preenchido na resposta.

ListUserLicensesRequest

Pedir mensagem para UserLicenseService.ListUserLicenses.

Campos
`parent`	`string` Obrigatório. O nome do recurso [UserStore][] principal, formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Opcional. Tamanho da página solicitado. O servidor pode devolver menos itens do que o pedido. Se não for especificado, a predefinição é 10. O valor máximo é 50. Os valores superiores a 50 são convertidos para 50. Se este campo for negativo, é devolvido um erro INVALID_ARGUMENT.
`page_token`	`string` Opcional. Um token de página, recebido de uma chamada `ListUserLicenses` anterior. Faculte este valor para obter a página seguinte. Quando paginar, todos os outros parâmetros fornecidos a `ListUserLicenses` têm de corresponder à chamada que forneceu o token da página.
`filter`	`string` Opcional. Filtro para o pedido da lista. Campos suportados: `license_assignment_state` Exemplos: `license_assignment_state = ASSIGNED` para listar as licenças de utilizador atribuídas. `license_assignment_state = NO_LICENSE` para listar os utilizadores sem licença. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` para listar os utilizadores que tentaram iniciar sessão, mas não têm uma licença atribuída. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` para filtrar os utilizadores que tentaram iniciar sessão, mas não têm uma licença atribuída.

ListUserLicensesResponse

Mensagem de resposta para UserLicenseService.ListUserLicenses.

Campos

user_licenses[]

UserLicense

Todos os UserLicenses do cliente.

next_page_token

string

Um token que pode ser enviado como page_token para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.

MediaInfo

Informações de eventos do utilizador específicas de multimédia.

Campos

media_progress_duration

Duration

O tempo de progresso do conteúdo multimédia em segundos, se aplicável. Por exemplo, se o utilizador final tiver terminado 90 segundos de um vídeo de reprodução, MediaInfo.media_progress_duration.seconds deve ser definido como 90.

media_progress_percentage

float

O progresso dos conteúdos multimédia deve ser calculado apenas com base no media_progress_duration em relação à duração total dos conteúdos multimédia.

Este valor tem de estar entre [0, 1.0] inclusive.

Se não se tratar de uma reprodução ou não for possível calcular o progresso (por exemplo, uma stream em direto em curso), este campo deve ser anulado.

PageInfo

Informações detalhadas da página.

Campos
`pageview_id`	`string` Um ID exclusivo de uma visualização de página Web. Este valor deve ser mantido igual para todos os eventos de utilizador acionados a partir da mesma visualização de página. Por exemplo, uma visualização da página de detalhes de um artigo pode acionar vários eventos à medida que o utilizador navega na página. A propriedade `pageview_id` deve ser mantida igual para todos estes eventos, para que possam ser agrupados corretamente. Quando usa os relatórios de eventos do lado do cliente com o píxel de JavaScript e o Gestor de Etiquetas da Google, este valor é preenchido automaticamente.
`page_category`	`string` A categoria mais específica associada a uma página de categoria. Para representar o caminho completo da categoria, use o sinal ">" para separar as diferentes hierarquias. Se ">" fizer parte do nome da categoria, substitua-o por outros carateres. As páginas de categorias incluem páginas especiais, como saldos ou promoções. Por exemplo, uma página de promoção especial pode ter a seguinte hierarquia de categorias: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Obrigatório para eventos `view-category-page`. Outros tipos de eventos não devem definir este campo. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`uri`	`string` URL completo (window.location.href) da página atual do utilizador. Quando usa os relatórios de eventos do lado do cliente com o píxel de JavaScript e o Gestor de Etiquetas da Google, este valor é preenchido automaticamente. Comprimento máximo: 5000 carateres.
`referrer_uri`	`string` O URL de referência da página atual. Quando usa os relatórios de eventos do lado do cliente com o píxel de JavaScript e o Gestor de Etiquetas da Google, este valor é preenchido automaticamente. No entanto, algumas restrições de privacidade do navegador podem fazer com que este campo fique vazio.

PanelInfo

Informações detalhadas do painel associadas a um evento do utilizador.

Campos
`panel_id`	`string` Obrigatório. O ID do painel.
`display_name`	`string` O nome a apresentar do painel.
`documents[]`	`DocumentInfo` Opcional. Os IDs dos documentos associados a este painel.
`panel_position`	`int32` A posição ordenada do painel, se for apresentado ao utilizador com outros painéis. Se estiver definido, `total_panels` também tem de estar definido.
`total_panels`	`int32` O número total de painéis, incluindo este, apresentados ao utilizador. Tem de ser definido se `panel_position` estiver definido.

Em dívida

Identificador principal de um utilizador ou um grupo.

Campos
Campo de união `principal`. Principal do campo de união. O principal pode ser um utilizador ou um grupo. `principal` só pode ser uma das seguintes opções:
`user_id`	`string` Identificador do utilizador. Para uma conta de utilizador do Google Workspace, o user_id deve ser o email do utilizador do Google Workspace. Para a conta de utilizador do fornecedor de identidade não pertencente à Google, o user_id é o identificador de utilizador mapeado configurado durante a configuração do workforcepool.
`group_id`	`string` Identificador do grupo. Para uma conta de utilizador do Google Workspace, group_id deve ser o email do grupo do Google Workspace. Para a conta de utilizador do fornecedor de identidade não pertencente à Google, group_id é o identificador do grupo mapeado configurado durante a configuração do workforcepool.
`external_entity_id`	`string` Para identidades de aplicações de terceiros que não estão presentes no fornecedor de identidade do cliente.

Projeto

Metadados e configurações de um projeto do Google Cloud no serviço.

Campos
`name`	`string` Apenas saída. O nome completo do recurso do projeto, por exemplo, `projects/{project}`. Tenha em atenção que, ao fazer pedidos, o número do projeto e o ID do projeto são aceitáveis, mas o servidor responde sempre com o número do projeto.
`create_time`	`Timestamp` Apenas saída. A data/hora em que este projeto foi criado.
`provision_completion_time`	`Timestamp` Apenas saída. A data/hora em que este projeto foi aprovisionado com êxito. Um valor vazio significa que este projeto ainda está a ser aprovisionado e não está pronto para utilização.
`service_terms_map`	`map<string, ServiceTerms>` Apenas saída. Um mapa dos Termos de Utilização. A chave é o `id` de `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Opcional. Configurações fornecidas pelo cliente.

CustomerProvidedConfig

Configurações fornecidas pelo cliente.

Campos

notebooklm_config

NotebooklmConfig

Opcional. Configuração das definições do NotebookLM.

NotebooklmConfig

Configuração do NotebookLM.

Campos

model_armor_config

ModelArmorConfig

Configuração do Model Armor a ser usada para limpar comandos do utilizador e respostas do GML.

ModelArmorConfig

Configuração de modelos do Model Armor definidos pelo cliente a serem usados para limpar comandos do utilizador e respostas do GML.

Campos

user_prompt_template

string

Opcional. O nome do recurso do modelo Armor para limpar comandos do utilizador. Formato: projects/{project}/locations/{location}/templates/{template_id} Se não for especificado, não é aplicada nenhuma limpeza ao comando do utilizador.

response_template

string

Opcional. O nome do recurso do modelo de proteção do modelo para limpar as respostas do MDG. Formato: projects/{project}/locations/{location}/templates/{template_id} Se não for especificado, não é aplicada nenhuma higienização à resposta do MDG.

ServiceTerms

Metadados acerca dos Termos de Utilização.

Campos
`id`	`string` O identificador exclusivo destes Termos de Utilização. Termos disponíveis: `GA_DATA_USE_TERMS`: termos de utilização de dados. Quando usar isto como `id`, o `version` aceitável a indicar é `2022-11-23`.
`version`	`string` A string da versão dos Termos de Utilização. Para ver os valores aceitáveis, consulte os comentários para `id` acima.
`state`	`State` Se o projeto aceitou/rejeitou os termos de serviço ou se ainda está pendente.
`accept_time`	`Timestamp` A última vez que o projeto aceitou os Termos de Utilização.
`decline_time`	`Timestamp` A última vez em que o projeto recusou ou revogou o contrato de termos de utilização.

Estado

O contrato indica estes termos de utilização.

Enumerações
`STATE_UNSPECIFIED`	O valor predefinido da enumeração. Este valor não é usado.
`TERMS_ACCEPTED`	O projeto deu o consentimento para os Termos de Utilização.
`TERMS_PENDING`	O projeto está pendente de revisão e aceitação dos Termos de Utilização.
`TERMS_DECLINED`	O projeto recusou ou revogou o contrato dos termos de utilização.

ProvisionProjectMetadata

Este tipo não tem campos.

Metadados associados a uma operação de aprovisionamento de projetos.

ProvisionProjectRequest

Pedido para o método ProjectService.ProvisionProject.

Campos
`name`	`string` Obrigatório. Nome completo do recurso de um `Project`, como `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Obrigatório. Definido como `true` para especificar que o autor da chamada leu e quer dar o seu consentimento aos Termos de utilização de dados.
`data_use_terms_version`	`string` Obrigatório. A versão dos Termos de utilização de dados que o autor da chamada leu e para os quais quer dar o seu consentimento. A versão aceitável é `2022-11-23`, e isto pode mudar ao longo do tempo.
`saas_params`	`SaasParams` Opcional. Parâmetros para o Agentspace.

SaasParams

Parâmetros para o Agentspace.

Campos

accept_biz_qos

bool

Opcional. Definido como true para especificar que o autor da chamada leu e quer dar o seu consentimento aos [Termos de qualidade de serviço do espaço do agente].

is_biz

bool

Opcional. Indica se o pedido atual é para a edição Biz (= verdadeiro) ou não (= falso).

PurgeCompletionSuggestionsMetadata

Metadados relacionados com o progresso da operação PurgeCompletionSuggestions. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

PurgeCompletionSuggestionsRequest

Mensagem de pedido para o método CompletionService.PurgeCompletionSuggestions.

Campos

parent

string

Obrigatório. O nome do recurso da loja de dados principal para o qual limpar sugestões de conclusão. Segue o padrão projects/*/locations/*/collections/*/dataStores/*.

PurgeCompletionSuggestionsResponse

Mensagem de resposta para o método CompletionService.PurgeCompletionSuggestions.

Campos

purge_succeeded

bool

Se as sugestões de conclusão foram eliminadas com êxito.

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

PurgeDocumentsMetadata

Metadados relacionados com o progresso da operação PurgeDocuments. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` Contagem de entradas que foram eliminadas com êxito.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.
`ignored_count`	`int64` A contagem de entradas que foram ignoradas porque não foram encontradas entradas.

PurgeDocumentsRequest

Mensagem de pedido para o método DocumentService.PurgeDocuments.

Campos
`parent`	`string` Obrigatório. O nome do recurso principal, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Obrigatório. Filtrar documentos correspondentes para expurgar. O único valor atualmente suportado é `*` (todos os itens).
`error_config`	`PurgeErrorConfig` A localização desejada dos erros incorridos durante a eliminação.
`force`	`bool` Executa efetivamente a eliminação. Se `force` estiver definido como falso, devolve a contagem de eliminação esperada sem eliminar documentos.
Campo de união `source`. A origem de entrada pretendida para a eliminação dos documentos com base nos IDs dos documentos. `source` só pode ser uma das seguintes opções:
`gcs_source`	`GcsSource` Localização do Cloud Storage para o conteúdo de entrada. Suportado `data_schema`: * `document_id`: um `Document.id` válido por linha.
`inline_source`	`InlineSource` Origem inline do conteúdo de entrada para eliminação.

InlineSource

A origem inline da configuração de entrada para o método DocumentService.PurgeDocuments.

Campos

documents[]

string

Obrigatório. Uma lista do nome completo do recurso dos documentos a anular. No formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Máximo recomendado de 100 itens.

PurgeDocumentsResponse

Mensagem de resposta para o método DocumentService.PurgeDocuments. Se a operação de longa duração for concluída com êxito, esta mensagem é devolvida pelo campo google.longrunning.Operations.response.

Campos

purge_count

int64

A contagem total de documentos anulados como resultado da operação.

purge_sample[]

string

Um exemplo dos nomes dos documentos que vão ser eliminados. Apenas preenchido se force estiver definido como falso. É devolvido um máximo de 100 nomes, e os nomes são escolhidos aleatoriamente.

PurgeErrorConfig

Configuração do destino para erros relacionados com a eliminação.

Campos

Campo de união destination. Obrigatório. Destino de erros. destination só pode ser uma das seguintes opções:

gcs_prefix

string

Prefixo do Cloud Storage para erros de eliminação. Tem de ser um diretório do Cloud Storage existente e vazio. Os erros de limpeza são escritos em ficheiros divididos neste diretório, um por linha, como uma mensagem google.rpc.Status codificada em JSON.

PurgeIdentityMappingsRequest

Pedido de mensagem para IdentityMappingStoreService.PurgeIdentityMappings

Campos
`identity_mapping_store`	`string` Obrigatório. O nome da loja de mapeamento de identidades a partir da qual as entradas de mapeamento de identidades vão ser anuladas. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Filtre os mapeamentos de identidade correspondentes para os expurgar. O campo elegível para filtragem é: * `update_time`: no formato "zulu" ISO 8601. * `external_id` Exemplos: Eliminar todos os mapeamentos da identidade atualizados num intervalo de tempo: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Eliminar todos os mapeamentos da identidade para um determinado external_id: `external_id = "id1"` Eliminar todos os mapeamentos da identidade num arquivo de mapeamento da identidade: `*` Assume-se que os campos de filtragem têm um AND implícito. Não deve ser usado com a origem. Se ambos forem fornecidos, é gerado um erro.
Campo de união `source`. A origem da entrada. `source` só pode ser uma das seguintes opções:
`inline_source`	`InlineSource` A origem inline a partir da qual as entradas de mapeamento de identidade devem ser anuladas.
`force`	`bool` Executa efetivamente a eliminação. Se `force` estiver definido como falso, devolva a contagem de eliminação esperada sem eliminar mapeamentos de identidade. Este campo só é suportado para a eliminação com filtro. Para a origem de entrada, este campo é ignorado e os dados são eliminados independentemente do valor deste campo.

InlineSource

A origem inline a partir da qual as entradas de mapeamento de identidade devem ser anuladas.

Campos

identity_mapping_entries[]

IdentityMappingEntry

É possível expurgar um máximo de 10 000 entradas de uma vez

PurgeSuggestionDenyListEntriesMetadata

Metadados relacionados com o progresso da operação PurgeSuggestionDenyListEntries. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

PurgeSuggestionDenyListEntriesRequest

Mensagem de pedido para o método CompletionService.PurgeSuggestionDenyListEntries.

Campos

parent

string

Obrigatório. O nome do recurso da loja de dados principal para o qual importar entradas da lista de recusa. Segue o padrão projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Mensagem de resposta para o método CompletionService.PurgeSuggestionDenyListEntries.

Campos

purge_count

int64

Número de entradas da lista de recusa de sugestões eliminadas.

error_samples[]

Uma amostra dos erros encontrados durante o processamento do pedido.

PurgeUserEventsMetadata

Metadados relacionados com o progresso da operação PurgeUserEvents. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`success_count`	`int64` Contagem de entradas que foram eliminadas com êxito.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.

PurgeUserEventsRequest

Mensagem de pedido para o método PurgeUserEvents.

Campos

parent

string

Obrigatório. O nome do recurso do catálogo no qual os eventos são criados. O formato é projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

filter

string

Obrigatório. A string de filtro para especificar os eventos a eliminar com um limite de comprimento de 5000 carateres. Os campos elegíveis para filtragem são:

eventType: String UserEvent.event_type entre aspas duplas.
eventTime: no formato "zulu" da norma ISO 8601.
userPseudoId: string entre aspas duplas. Se especificar esta opção, elimina todos os eventos associados a um visitante.
userId: string entre aspas duplas. Se especificar esta opção, elimina todos os eventos associados a um utilizador.

Nota: esta API só suporta a eliminação de um intervalo máximo de 30 dias.

Exemplos:

Eliminar todos os eventos num intervalo de tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Eliminar eventType específico num intervalo de tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Eliminar todos os eventos de um visitante específico num intervalo de tempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Eliminar os eventos dos últimos 30 dias num DataStore: *

Assume-se que os campos de filtragem têm um AND implícito.

force

bool

O campo force não é atualmente suportado. Os pedidos de remoção completa de eventos do utilizador eliminam permanentemente todos os eventos removíveis. Quando o desenvolvimento estiver concluído: se force estiver definido como falso, o método devolve a quantidade de eliminação esperada sem eliminar eventos do utilizador. Este campo reverte para a predefinição false se não for incluído no pedido.

PurgeUserEventsResponse

Resposta do PurgeUserEventsRequest. Se a operação de longa duração for concluída com êxito, esta mensagem é devolvida pelo campo google.longrunning.Operations.response.

Campos

purge_count

int64

A contagem total de eventos anulados como resultado da operação.

Consulta

Define uma consulta introduzida pelo utilizador.

Campos

query_id

string

Apenas saída. ID exclusivo da consulta.

Campo de união content. Consultar conteúdo. content só pode ser uma das seguintes opções:

text

string

Texto simples.

RankRequest

Mensagem de pedido para o método RankService.Rank.

Campos
`ranking_config`	`string` Obrigatório. O nome do recurso da configuração do serviço de classificação, como `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` O identificador do modelo a usar. É uma das seguintes opções: `semantic-ranker-512@latest`: modelo de classificação semântica com um tamanho máximo de tokens de entrada de 512. Por predefinição, está definido como `semantic-ranker-512@latest` se não for especificado.
`top_n`	`int32` O número de resultados a devolver. Se esta opção não estiver definida ou não for superior a zero, devolve todos os resultados.
`query`	`string` A consulta a usar.
`records[]`	`RankingRecord` Obrigatório. Uma lista de registos a classificar.
`ignore_record_details_in_response`	`bool` Se for verdadeiro, a resposta contém apenas o ID do registo e a pontuação. Por predefinição, é falso e a resposta contém detalhes do registo.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte o documento do Google Cloud para ver mais detalhes.

RankResponse

Mensagem de resposta para o método RankService.Rank.

Campos

records[]

RankingRecord

Uma lista de registos ordenada por pontuação descendente.

RankingRecord

Método de gravação de mensagens para RankService.Rank.

Campos
`id`	`string` O ID exclusivo para representar o registo.
`title`	`string` O título do registo. Vazio por predefinição. Tem de definir, pelo menos, um dos elementos `title` ou `content`. Caso contrário, é gerado um erro INVALID_ARGUMENT.
`content`	`string` O conteúdo do registo. Vazio por predefinição. Tem de definir, pelo menos, um dos elementos `title` ou `content`. Caso contrário, é gerado um erro INVALID_ARGUMENT.
`score`	`float` A pontuação deste registo com base na consulta fornecida e no modelo selecionado. A pontuação é arredondada às 2 casas decimais. Se a pontuação estiver perto de 0, é arredondada para 0,0001 para evitar a devolução de valores não definidos.

RecommendRequest

Mensagem de pedido para o método Recommend.

Campos
`serving_config`	`string` Obrigatório. Nome completo do recurso de um `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/` ou `projects//locations/global/collections//dataStores//servingConfigs/` É criada uma configuração de publicação predefinida juntamente com a criação do motor de recomendações. O ID do motor é usado como o ID da configuração de publicação predefinida. Por exemplo, para o motor `projects//locations/global/collections//engines/my-engine`, pode usar `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` para os seus pedidos `RecommendationService.Recommend`.
`user_event`	`UserEvent` Obrigatório. Contexto sobre o utilizador, o que está a ver e que ação tomou para acionar o pedido Recommend. Tenha em atenção que este detalhe do evento do utilizador não é carregado para os registos userEvent. Assim, é necessária uma solicitação de gravação userEvent separada para o registo de eventos. Não defina `UserEvent.user_pseudo_id` ou `UserEvent.user_info.user_id` para o mesmo ID fixo para diferentes utilizadores. Se estiver a tentar receber recomendações não personalizadas (não recomendado; isto pode afetar negativamente o desempenho do modelo), defina `UserEvent.user_pseudo_id` como um ID único aleatório e deixe `UserEvent.user_info.user_id` não definido.
`page_size`	`int32` Número máximo de resultados a devolver. Defina esta propriedade para o número de resultados de recomendações necessários. Se for zero, o serviço escolhe uma predefinição razoável. O valor máximo permitido é 100. Os valores acima de 100 são definidos como 100.
`filter`	`string` Filtro para restringir os resultados de recomendações com um limite de 5000 carateres. Atualmente, apenas são suportadas expressões de filtro no atributo `filter_tags`. Exemplos: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` Se `attributeFilteringSyntax` estiver definido como verdadeiro no campo `params`, são esperadas expressões baseadas em atributos em vez da sintaxe baseada em etiquetas descrita acima. Exemplos: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) Se o filtro bloquear todos os resultados, a API devolve documentos populares genéricos (não filtrados). Se quiser apenas resultados que correspondam estritamente aos filtros, defina `strictFiltering` como `true` em `RecommendRequest.params` para receber resultados vazios. Tenha em atenção que a API nunca devolve `Document`s com `storageStatus` como `EXPIRED` ou `DELETED`, independentemente das escolhas de filtros.
`validate_only`	`bool` Use o modo de validação apenas para esta consulta de recomendação. Se estiver definido como `true`, é usado um modelo falso que devolve IDs de documentos arbitrários. Tenha em atenção que o modo de validação apenas deve ser usado para testar a API ou se o modelo não estiver pronto.
`params`	`map<string, Value>` Parâmetros adicionais específicos do domínio para as recomendações. Valores permitidos: `returnDocument`: booleano. Se estiver definido como `true`, o objeto Document associado é devolvido em `RecommendResponse.RecommendationResult.document`. `returnScore`: booleano. Se estiver definido como verdadeiro, a pontuação de recomendação correspondente a cada documento devolvido é definida em `RecommendResponse.RecommendationResult.metadata`. A pontuação fornecida indica a probabilidade de uma conversão de documentos, dado o contexto e o histórico do utilizador. `strictFiltering`: booleano. O valor predefinido é True. Se estiver definido como `false`, o serviço devolve documentos populares genéricos (não filtrados) em vez de vazios se o filtro bloquear todos os resultados de recomendações. `diversityLevel`: String. Predefinição vazia. Se estiver definido como não vazio, tem de ser um dos seguintes: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Isto dá controlo ao nível do pedido e ajusta os resultados das recomendações com base na categoria do documento. `attributeFilteringSyntax`: booleano. O valor predefinido é False. Se for definido como verdadeiro, o campo `filter` é interpretado de acordo com a nova sintaxe baseada em atributos.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte os requisitos para etiquetas para mais detalhes.

RecommendResponse

Mensagem de resposta para o método Recommend.

Campos
`results[]`	`RecommendationResult` Uma lista de documentos recomendados. A ordem representa a classificação (do documento mais relevante para o menos relevante).
`attribution_token`	`string` Um token de atribuição único. Isto deve ser incluído nos registos `UserEvent` resultantes desta recomendação, o que permite uma atribuição precisa do desempenho do modelo de recomendação.
`missing_ids[]`	`string` IDs dos documentos no pedido que estavam em falta no ramo predefinido associado ao ServingConfig pedido.
`validate_only`	`bool` Verdadeiro se `RecommendRequest.validate_only` tiver sido definido.

RecommendationResult

RecommendationResult representa um resultado de recomendação genérico com metadados associados.

Campos

id

string

ID do recurso do documento recomendado.

document

MatchHighlightingCondition

Definido se returnDocument estiver definido como verdadeiro em RecommendRequest.params.

metadata

map<string, Value>

Metadados ou anotações de documentos adicionais.

Valores possíveis:

score: pontuação de recomendação em valor duplo. É definido se returnScore for definido como verdadeiro em RecommendRequest.params.

RecrawlUrisMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.RecrawlUris. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de criação da operação.
`update_time`	`Timestamp` Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.
`invalid_uris[]`	`string` URIs únicos no pedido com um formato inválido. Exemplo limitado a 1000.
`invalid_uris_count`	`int32` Número total de URIs únicos no pedido que têm um formato inválido.
`noindex_uris[]`	`string` URIs que não têm uma metatag noindex. Exemplo limitado a 1000.
`noindex_uris_count`	`int32` O número total de URIs que não têm uma metatag no índice.
`uris_not_matching_target_sites[]`	`string` Os URIs únicos no pedido que não correspondem a nenhum TargetSite no DataStore, correspondem apenas a TargetSites que não foram totalmente indexados ou correspondem a um TargetSite do tipo EXCLUDE. Exemplo limitado a 1000.
`uris_not_matching_target_sites_count`	`int32` Número total de URIs que não correspondem a nenhum TargetSites.
`valid_uris_count`	`int32` Número total de URIs únicos no pedido que não estão em invalid_uris.
`success_count`	`int32` Número total de URIs rastreados até agora.
`pending_count`	`int32` O número total de URIs que ainda não foram rastreados.
`quota_exceeded_count`	`int32` Número total de URIs que foram rejeitados devido a recursos de indexação insuficientes.

RecrawlUrisRequest

Mensagem de pedido para o método SiteSearchEngineService.RecrawlUris.

Campos

site_search_engine

string

Obrigatório. Nome completo do recurso SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Obrigatório. Lista de URIs a rastrear. São suportados, no máximo, 10 000 URIs. Caso contrário, é gerado um erro INVALID_ARGUMENT. Cada URI deve corresponder, pelo menos, a um TargetSite em site_search_engine.

site_credential

string

Opcional. ID da credencial a usar para a indexação.

RecrawlUrisResponse

Mensagem de resposta para o método SiteSearchEngineService.RecrawlUris.

Campos

failure_samples[]

FailureInfo

Detalhes de uma amostra de até 10 failed_uris.

failed_uris[]

string

URIs que não foram rastreados antes da LRO terminar.

FailureInfo

Detalhes sobre o motivo pelo qual não foi possível rastrear um URI específico. Cada FailureInfo contém um FailureReason por CorpusType.

Campos

uri

string

URI que não foi rastreado.

failure_reasons[]

FailureReason

Lista de motivos de falha por tipo de corpus (por exemplo, computador, dispositivo móvel).

FailureReason

Detalhes sobre o motivo pelo qual a indexação falhou para um CorpusType específico, por exemplo: A indexação nos computadores e nos dispositivos móveis pode falhar por diferentes motivos.

Campos

corpus_type

CorpusType

DESKTOP, MOBILE ou CORPUS_TYPE_UNSPECIFIED.

error_message

string

Motivo pelo qual o URI não foi rastreado.

CorpusType

CorpusType para a operação de rastreio com falha.

Enumerações
`CORPUS_TYPE_UNSPECIFIED`	Valor predefinido.
`DESKTOP`	Denota uma tentativa de rastreio da versão para computador de uma página.
`MOBILE`	Denota uma tentativa de rastreio da versão para dispositivos móveis de uma página.

Responder

Define uma mensagem de resposta ao utilizador.

Campos

summary

Summary

Resumo com base nos resultados da pesquisa.

SafetyRating

Classificação de segurança correspondente ao conteúdo gerado.

Campos
`category`	`HarmCategory` Apenas saída. Categoria de danos.
`probability`	`HarmProbability` Apenas saída. Níveis de probabilidade de danos no conteúdo.
`probability_score`	`float` Apenas saída. Pontuação de probabilidade de danos.
`severity`	`HarmSeverity` Apenas saída. Níveis de gravidade dos danos no conteúdo.
`severity_score`	`float` Apenas saída. Gravidade do dano.
`blocked`	`bool` Apenas saída. Indica se o conteúdo foi filtrado devido a esta classificação.

HarmProbability

Níveis de probabilidade de danos no conteúdo.

Enumerações
`HARM_PROBABILITY_UNSPECIFIED`	Probabilidade de danos não especificada.
`NEGLIGIBLE`	Nível de dano insignificante.
`LOW`	Nível de dano baixo.
`MEDIUM`	Nível de dano moderado.
`HIGH`	Nível elevado de danos.

HarmSeverity

Níveis de gravidade dos danos.

Enumerações
`HARM_SEVERITY_UNSPECIFIED`	Gravidade dos danos não especificada.
`HARM_SEVERITY_NEGLIGIBLE`	Nível de gravidade dos danos insignificante.
`HARM_SEVERITY_LOW`	Nível de gravidade de danos baixo.
`HARM_SEVERITY_MEDIUM`	Nível médio de gravidade dos danos.
`HARM_SEVERITY_HIGH`	Nível elevado de gravidade de danos.

Esquema

Define a estrutura e o esquema de um tipo de dados de documentos.

Campos
`name`	`string` Imutável. O nome completo do recurso do esquema, no formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.
Campo de união `schema`. Representação do esquema. Deve ser fornecida uma das propriedades `struct_schema` ou `json_schema`. Caso contrário, é gerado um erro `INVALID_ARGUMENT`. `schema` só pode ser uma das seguintes opções:
`struct_schema`	`Struct` A representação estruturada do esquema.
`json_schema`	`string` A representação JSON do esquema.

SearchAddOn

Suplemento que oferece funcionalidades adicionais para a pesquisa.

Enumerações
`SEARCH_ADD_ON_UNSPECIFIED`	Valor predefinido quando o enum não está especificado. Esta opção é inválida para utilização.
`SEARCH_ADD_ON_LLM`	Suplemento de modelo de linguagem (conteúdo extenso).

SearchInfo

Informações de pesquisa detalhadas.

Campos

search_query

string

A consulta de pesquisa do utilizador.

Consulte SearchRequest.query para ver a definição.

O valor tem de ser uma string codificada em UTF-8 com um limite de 5000 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

É necessário, pelo menos, um de search_query ou PageInfo.page_category para eventos search. Outros tipos de eventos não devem definir este campo. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

order_by

string

A ordem em que os produtos são devolvidos, se aplicável.

Consulte SearchRequest.order_by para ver a definição e a sintaxe.

O valor tem de ser uma string codificada em UTF-8 com um limite de 1000 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Esta opção só pode ser definida para eventos search. Outros tipos de eventos não devem definir este campo. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

offset

int32

Um número inteiro que especifica o desvio atual para a paginação (a localização inicial com índice 0, entre os produtos considerados relevantes pela API).

Consulte SearchRequest.offset para ver a definição.

Se este campo for negativo, é devolvido um INVALID_ARGUMENT.

Esta opção só pode ser definida para eventos search. Outros tipos de eventos não devem definir este campo. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

SearchLinkPromotion

O proto de promoção inclui o URI e outras informações úteis para apresentar a promoção.

Campos
`title`	`string` Obrigatório. O título da promoção. Comprimento máximo: 160 carateres.
`uri`	`string` Opcional. O URL da página que o utilizador quer promover. Tem de ser definido para a pesquisa no site. Para outros verticais, esta ação é opcional.
`document`	`string` Opcional. O `Document` que o utilizador quer promover. Para a pesquisa de sites, deixe a opção não definida e preencha apenas o URI. Pode ser definido juntamente com o URI.
`image_uri`	`string` Opcional. O URL da imagem em miniatura da promoção.
`description`	`string` Opcional. A descrição da promoção. Comprimento máximo: 200 carateres.
`enabled`	`bool` Opcional. A promoção ativada é devolvida para todas as configurações de publicação associadas ao elemento principal do controlo ao qual esta promoção está anexada. Esta flag é usada apenas para a pesquisa no site básica.

SearchRequest

Mensagem de pedido para o método SearchService.Search.

Campos
`serving_config`	`string` Obrigatório. O nome do recurso da configuração de publicação de anúncios de pesquisa, como `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` ou `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. Este campo é usado para identificar o nome da configuração de publicação, o conjunto de modelos usados para fazer a pesquisa.
`branch`	`string` O nome do recurso da ramificação, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` como o ID do ramo ou deixe este campo vazio para pesquisar documentos no ramo predefinido.
`query`	`string` Consulta de pesquisa não processada.
`image_query`	`ImageQuery` Consulta de imagem RAW.
`page_size`	`int32` Número máximo de `Document`s a devolver. O valor máximo permitido depende do tipo de dados. Os valores acima do valor máximo são convertidos para o valor máximo. Websites com indexação básica: predefinição `10`, máximo `25`. Websites com indexação avançada: predefinição `25`, máximo `50`. Outro: predefinição `50`, máximo `100`. Se este campo for negativo, é devolvido um `INVALID_ARGUMENT`.
`page_token`	`string` Um token de página recebido de uma chamada `SearchService.Search` anterior. Faculte este valor para obter a página seguinte. Quando paginar, todos os outros parâmetros fornecidos a `SearchService.Search` têm de corresponder à chamada que forneceu o token da página. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`offset`	`int32` Um número inteiro com índice 0 que especifica o deslocamento atual (ou seja, a localização do resultado inicial, entre os `Document`s considerados relevantes pela API) nos resultados da pesquisa. Este campo só é considerado se `page_token` não estiver definido. Se este campo for negativo, é devolvido um `INVALID_ARGUMENT`. Um desvio grande pode ser limitado a um limite razoável.
`one_box_page_size`	`int32` O número máximo de resultados a devolver para o OneBox. Isto aplica-se a cada tipo de OneBox individualmente. O número predefinido é 10.
`data_store_specs[]`	`DataStoreSpec` Especificações que definem os `DataStore`s específicos a serem pesquisados, juntamente com as configurações desses repositórios de dados. Isto só é considerado para `Engine`s com várias lojas de dados. Para motores com um único armazenamento de dados, devem ser usadas as especificações diretamente abaixo de `SearchRequest`.
`filter`	`string` A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas. Se este campo não for reconhecível, é devolvido um `INVALID_ARGUMENT`. A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "name" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")' Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar
`canonical_filter`	`string` O filtro predefinido que é aplicado quando um utilizador faz uma pesquisa sem selecionar filtros na página de pesquisa. O filtro aplicado a cada pedido de pesquisa quando é necessário um melhoramento da qualidade, como a expansão de consultas. No caso de uma consulta não ter uma quantidade suficiente de resultados, este filtro é usado para determinar se o fluxo de expansão de consultas deve ou não ser ativado. O filtro original continua a ser usado para a pesquisa expandida da consulta. Este campo é vivamente recomendado para alcançar uma elevada qualidade de pesquisa. Para mais informações sobre a sintaxe de filtros, consulte `SearchRequest.filter`.
`order_by`	`string` A ordem pela qual os documentos são devolvidos. Os documentos podem ser ordenados por um campo num objeto `Document`. Deixe-o não definido se a ordenação for por relevância. A expressão `order_by` é sensível a maiúsculas e minúsculas. Para mais informações sobre a ordenação dos resultados da pesquisa de Websites, consulte o artigo Ordene os resultados da pesquisa na Web. Para mais informações sobre a ordenação dos resultados da pesquisa de cuidados de saúde, consulte o artigo Ordene os resultados da pesquisa de cuidados de saúde. Se este campo não for reconhecível, é devolvido um `INVALID_ARGUMENT`.
`user_info`	`UserInfo` Informações sobre o utilizador final. Altamente recomendado para estatísticas e personalização. `UserInfo.user_agent` é usado para deduzir `device_type` para estatísticas.
`language_code`	`string` O código de idioma BCP-47, como "en-US" ou "sr-Latn". Para mais informações, consulte o artigo Campos padrão. Este campo ajuda a interpretar melhor a consulta. Se não for especificado um valor, o código do idioma da consulta é detetado automaticamente, o que pode não ser preciso.
`facet_specs[]`	`FacetSpec` Especificações de facetas para a pesquisa com filtros. Se estiver vazio, não são devolvidas facetas. São permitidos, no máximo, 100 valores. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`boost_spec`	`BoostSpec` Especificação de aumento para aumentar determinados documentos. Para mais informações sobre o aumento, consulte o artigo Aumentar
`params`	`map<string, Value>` Parâmetros de pesquisa adicionais. Para a pesquisa de Websites públicos apenas, os valores suportados são: `user_country_code`: string. Predefinição vazia. Se for definido como não vazio, os resultados são restritos ou melhorados com base na localização fornecida. Por exemplo, `user_country_code: "au"` Para ver os códigos disponíveis, consulte Códigos dos países `search_type`: duplo. Predefinição vazia. Ativa a pesquisa de conteúdo que não seja de páginas Web, consoante o valor. O único valor não predefinido válido é 1, que ativa a pesquisa de imagens. Por exemplo, `search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` A especificação de expansão de consultas que especifica as condições em que a expansão de consultas ocorre.
`spell_correction_spec`	`SpellCorrectionSpec` A especificação de correção ortográfica que especifica o modo em que a correção ortográfica entra em vigor.
`user_pseudo_id`	`string` Um identificador exclusivo para acompanhar os visitantes. Por exemplo, isto pode ser implementado com um cookie HTTP, que deve ser capaz de identificar de forma exclusiva um visitante num único dispositivo. Este identificador exclusivo não deve ser alterado se o visitante iniciar ou terminar sessão no Website. Este campo NÃO deve ter um valor fixo, como `unknown_visitor`. Este deve ser o mesmo identificador que `UserEvent.user_pseudo_id` e `CompleteQueryRequest.user_pseudo_id` O campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`content_search_spec`	`ContentSearchSpec` Uma especificação para configurar o comportamento da pesquisa de conteúdo.
`ranking_expression`	`string` Opcional. A expressão de classificação controla a classificação personalizada nos documentos de obtenção. Esta opção substitui `ServingConfig.ranking_expression`. A sintaxe e as funcionalidades suportadas dependem do valor de `ranking_expression_backend`. Se `ranking_expression_backend` não for fornecido, a predefinição é `RANK_BY_EMBEDDING`. Se `ranking_expression_backend` não for fornecido ou for definido como `RANK_BY_EMBEDDING`, deve ser uma única função ou várias funções unidas por "+". ranking_expression = function, { " + ", function }; Funções suportadas: double * relevance_score double * dotProduct(embedding_field_path) Variáveis de função: `relevance_score`: palavras-chave predefinidas, usadas para medir a relevância entre a consulta e o documento. `embedding_field_path`: o campo de incorporação de documentos usado com o vetor de incorporação de consultas. `dotProduct`: função de incorporação entre `embedding_field_path` e o vetor de incorporação de consultas. Exemplo de expressão de classificação: Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação pode ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. Se `ranking_expression_backend` estiver definido como `RANK_BY_FORMULA`, são suportados os seguintes tipos de expressões (e combinações destes encadeados com operadores + ou ): `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)` -- transformação de classificação recíproca com o segundo argumento a ser uma constante do denominador. `is_nan(signal)` -- devolve 0 se o sinal for NaN e 1 caso contrário. `fill_nan(signal1, signal2 \| double)` -- se signal1 for NaN, devolve signal2 \| double; caso contrário, devolve signal1. Seguem-se alguns exemplos de fórmulas de classificação que usam os tipos de expressões de classificação suportados: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- a classificação baseia-se principalmente no logaritmo de `keyword_similarity_score` com um ligeiro ajuste de `semantic_smilarity_score`. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- classificar pelo expoente de `semantic_similarity_score` preenchendo o valor com 0 se for NaN, também adicionar o ajuste constante de 0,3 à pontuação final se `semantic_similarity_score` for NaN. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`: principalmente, a classificação é feita pela classificação recíproca de `keyword_similarity_score` com um ligeiro ajuste da classificação recíproca de `semantic_smilarity_score`. Os seguintes sinais são suportados: `semantic_similarity_score`: ajuste de semelhança semântica calculado através das incorporações geradas por um modelo proprietário da Google. Esta pontuação determina a semelhança semântica entre uma consulta de pesquisa e um documento. `keyword_similarity_score`: o ajuste de correspondência de palavras-chave usa a função de classificação Best Match 25 (BM25). Esta pontuação é calculada através de um modelo probabilístico para estimar a probabilidade de um documento ser relevante para uma determinada consulta. `relevance_score`: ajuste da relevância semântica que usa um modelo proprietário da Google para determinar o significado e a intenção por detrás da consulta de um utilizador no contexto do conteúdo dos documentos. `pctr_rank`: ajuste da taxa de conversão prevista como utilização de classificação. A taxa de cliques prevista (pCTR) é usada para avaliar a relevância e a atratividade de um resultado da pesquisa na perspetiva do utilizador. Uma pCTR mais elevada sugere que o resultado tem maior probabilidade de satisfazer a consulta e a intenção do utilizador, o que o torna um sinal valioso para a classificação. `freshness_rank`: ajuste de atualização como classificação `document_age`: o tempo em horas decorrido desde a última atualização do documento, um número de vírgula flutuante (por exemplo, 0,25 significa 15 minutos). `topicality_rank`: ajuste de topicalidade como classificação. Usa o modelo proprietário da Google para determinar a sobreposição baseada em palavras-chave entre a consulta e o documento. `base_rank`: a classificação predefinida do resultado
`ranking_expression_backend`	`RankingExpressionBackend` Opcional. O back-end a usar para a avaliação da expressão de classificação.
`safe_search`	`bool` Se deve ativar a pesquisa segura. Esta funcionalidade só é compatível com a pesquisa em Websites.
`user_labels`	`map<string, string>` As etiquetas de utilizador aplicadas a um recurso têm de cumprir os seguintes requisitos: Cada recurso pode ter várias etiquetas, até um máximo de 64. Cada etiqueta tem de ser um par chave-valor. As chaves têm um comprimento mínimo de 1 carater e um comprimento máximo de 63 carateres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 carateres. As chaves e os valores só podem conter letras minúsculas, carateres numéricos, sublinhados e travessões. Todos os carateres têm de usar a codificação UTF-8, e são permitidos carateres internacionais. A parte da chave de uma etiqueta tem de ser exclusiva. No entanto, pode usar a mesma chave com vários recursos. As chaves têm de começar com uma letra minúscula ou um caráter internacional. Consulte o documento do Google Cloud para ver mais detalhes.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Opcional. Configuração para capacidades de compreensão de consultas de linguagem natural, como a extração de filtros de campos estruturados da consulta. Consulte esta documentação para mais informações. Se `naturalLanguageQueryUnderstandingSpec` não for especificado, não é feita nenhuma compreensão adicional de consultas de linguagem natural.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Configuração de pesquisa à medida que escreve. Apenas suportado para a vertical `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Opcional. Configuração para a funcionalidade de apresentação, como o realce de correspondências nos resultados da pesquisa.
`session`	`string` O nome do recurso da sessão. Opcional. A sessão permite que os utilizadores façam chamadas API de várias interações/pesquisa ou coordenação entre chamadas API de pesquisa e chamadas API de resposta. Exemplo n.º 1 (várias interações/chamadas da API /search): chame a API /search com o ID da sessão gerado na primeira chamada. Aqui, a consulta de pesquisa anterior é considerada na posição da consulta. Ou seja, se a primeira consulta for "Como se saiu a Alphabet em 2022?" e a consulta atual for "E em 2023?", a consulta atual vai ser interpretada como "Qual foi o desempenho da Alphabet em 2023?". Exemplo n.º 2 (coordenação entre chamadas da API /search e chamadas da API /answer): chame a API /answer com o ID da sessão gerado na primeira chamada. Aqui, a geração de respostas ocorre no contexto dos resultados da pesquisa da primeira chamada de pesquisa. A funcionalidade de pesquisa com várias interações está atualmente na fase de GA privada. Use a versão v1alpha ou v1beta antes de lançarmos esta funcionalidade para a disponibilidade geral pública. Em alternativa, peça a inclusão na lista de autorizações através da equipa de apoio técnico da Google.
`session_spec`	`SessionSpec` Especificação da sessão. Só pode ser usado quando `session` está definido.
`relevance_threshold`	`RelevanceThreshold` O limite de relevância dos resultados da pesquisa. Usar o limite definido pela Google, tirando partido de um equilíbrio entre a precisão e a capacidade de memorização para apresentar resultados altamente precisos e uma cobertura abrangente de informações relevantes. Esta funcionalidade não é compatível com a pesquisa de cuidados de saúde.
`relevance_score_spec`	`RelevanceScoreSpec` Opcional. A especificação para devolver a pontuação de relevância.

BoostSpec

Especificação de aumento para aumentar determinados documentos.

Campos

condition_boost_specs[]

ConditionBoostSpec

Especificações do aumento de condição. Se um documento corresponder a várias condições nas especificações, as pontuações de aumento destas especificações são todas aplicadas e combinadas de forma não linear. O número máximo de especificações é 20.

ConditionBoostSpec

O aumento aplica-se a documentos que correspondem a uma condição.

Campos

condition

string

Uma expressão que especifica uma condição de aumento. A sintaxe e os campos suportados são os mesmos que os de uma expressão de filtro. Consulte SearchRequest.filter para ver a sintaxe detalhada e as limitações.

Exemplos:

Para aumentar a relevância dos documentos com o ID do documento "doc_1" ou "doc_2" e a cor "Vermelho" ou "Azul": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Intensidade do aumento da condição, que deve estar no intervalo [-1, 1]. Um aumento negativo significa uma despromoção. A predefinição é 0,0.

Se definir o valor como 1,0, o documento recebe uma grande promoção. No entanto, não significa necessariamente que o documento otimizado seja sempre o resultado principal, nem que outros documentos sejam excluídos. Os resultados podem continuar a ser apresentados mesmo quando nenhum deles corresponde à condição. Além disso, os resultados significativamente mais relevantes para a consulta de pesquisa podem continuar a superar os seus documentos muito favorecidos, mas irrelevantes.

Se definir o valor como -1,0, o documento é significativamente despromovido. No entanto, os resultados profundamente relevantes podem continuar a ser apresentados. O documento vai ter uma batalha a montante para conseguir uma classificação razoavelmente elevada, mas não está completamente bloqueado.

A definição de 0,0 significa que não é aplicado nenhum aumento. A condição de aumento é ignorada. Apenas uma das combinações (condição, aumento) ou a boost_control_spec abaixo está definida. Se ambos estiverem definidos, o aumento global é ignorado e é aplicada a especificação boost_control_spec mais detalhada.

boost_control_spec

BoostControlSpec

Especificação complexa para a classificação personalizada com base no valor do atributo definido pelo cliente.

BoostControlSpec

Campos
`field_name`	`string` O nome do campo cujo valor vai ser usado para determinar o valor do aumento.
`attribute_type`	`AttributeType` O tipo de atributo a usar para determinar o valor do aumento. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples, ou seja, attribute_value = numerical_field_value. No entanto, no caso da atualidade, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` O tipo de interpolação a aplicar para ligar os pontos de controlo indicados abaixo.
`control_points[]`	`ControlPoint` Os pontos de controlo usados para definir a curva. A função monótona (definida através de interpolation_type acima) passa pelos pontos de controlo indicados aqui.

AttributeType

O atributo(ou a função) ao qual a classificação personalizada deve ser aplicada.

Enumerações
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType não especificado.
`NUMERICAL`	O valor do campo numérico é usado para atualizar dinamicamente o valor do aumento. Neste caso, o attribute_value (o valor x) do ponto de controlo é o valor real do campo numérico para o qual o boost_amount é especificado.
`FRESHNESS`	Para o exemplo de utilização da atualidade, o valor do atributo é a duração entre a hora atual e a data no campo de data/hora especificado. O valor tem de ser formatado como um valor XSD `dayTimeDuration` (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: `[nD][T[nH][nM][nS]]`. Por exemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Os pontos de controlo usados para definir a curva. A curva definida através destes pontos de controlo só pode ser monotonicamente crescente ou decrescente(os valores constantes são aceitáveis).

Campos

attribute_value

string

Pode ser um dos seguintes: 1. O valor do campo numérico. 2. A especificação de duração para a atualização: o valor tem de ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão para isto é: [nD][T[nH][nM][nS]].

boost_amount

float

O valor entre -1 e 1 pelo qual aumentar a pontuação se o attribute_value for avaliado como o valor especificado acima.

InterpolationType

O tipo de interpolação a aplicar. A predefinição é linear (linear por partes).

Enumerações
`INTERPOLATION_TYPE_UNSPECIFIED`	O tipo de interpolação não foi especificado. Neste caso, a predefinição é Linear.
`LINEAR`	É aplicada a interpolação linear por partes.

ContentSearchSpec

Uma especificação para configurar o comportamento da pesquisa de conteúdo.

Campos
`snippet_spec`	`SnippetSpec` Se `snippetSpec` não for especificado, os fragmentos não são incluídos na resposta de pesquisa.
`summary_spec`	`SummarySpec` Se `summarySpec` não for especificado, os resumos não são incluídos na resposta de pesquisa.
`extractive_content_spec`	`ExtractiveContentSpec` Se não for fornecido nenhum extractive_content_spec, não haverá nenhuma resposta extrativa na resposta de pesquisa.
`search_result_mode`	`SearchResultMode` Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para `DOCUMENTS`.
`chunk_spec`	`ChunkSpec` Especifica a especificação do fragmento a ser devolvida da resposta de pesquisa. Disponível apenas se o `SearchRequest.ContentSearchSpec.search_result_mode` estiver definido como `CHUNKS`

ChunkSpec

Especifica a especificação do fragmento a ser devolvida da resposta de pesquisa. Disponível apenas se o SearchRequest.ContentSearchSpec.search_result_mode estiver definido como CHUNKS

Campos

num_previous_chunks

int32

O número de fragmentos anteriores a devolver do fragmento atual. O valor máximo permitido é 3. Se não for especificado, não são devolvidos fragmentos anteriores.

num_next_chunks

int32

O número de fragmentos seguintes a devolver do fragmento atual. O valor máximo permitido é 3. Se não for especificado, não são devolvidos mais fragmentos.

ExtractiveContentSpec

Uma especificação para configurar o conteúdo extrativo numa resposta de pesquisa.

Campos
`max_extractive_answer_count`	`int32` O número máximo de respostas extrativas devolvidas em cada resultado da pesquisa. Uma resposta extrativa é uma resposta literal extraída do documento original, que fornece uma resposta precisa e contextualmente relevante à consulta de pesquisa. Se o número de respostas correspondentes for inferior a `max_extractive_answer_count`, devolva todas as respostas. Caso contrário, devolve `max_extractive_answer_count`. São devolvidas, no máximo, cinco respostas para cada `SearchResult`.
`max_extractive_segment_count`	`int32` O número máximo de segmentos extrativos devolvidos em cada resultado da pesquisa. Só é aplicado se `DataStore` estiver definido como `DataStore.ContentConfig.CONTENT_REQUIRED` ou `DataStore.solution_types` for `SOLUTION_TYPE_CHAT`. Um segmento extrativo é um segmento de texto extraído do documento original que é relevante para a consulta de pesquisa e, em geral, mais detalhado do que uma resposta extrativa. Em seguida, o segmento pode ser usado como entrada para os GMLs gerarem resumos e respostas. Se o número de segmentos correspondentes for inferior a `max_extractive_segment_count`, devolve todos os segmentos. Caso contrário, devolve `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Especifica se deve devolver a pontuação de confiança dos segmentos extrativos em cada resultado da pesquisa. Esta funcionalidade só está disponível para novas ou permitidas lojas de dados. Para adicionar a sua base de dados à lista de autorizações, contacte o seu engenheiro de clientes. O valor predefinido é `false`.
`num_previous_segments`	`int32` Especifica se também devem ser incluídos os adjacentes de cada um dos segmentos selecionados. Devolva, no máximo, `num_previous_segments` segmentos antes de cada segmento selecionado.
`num_next_segments`	`int32` Devolve, no máximo, `num_next_segments` segmentos após cada segmento selecionado.

SearchResultMode

Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa é predefinido para DOCUMENTS.

Enumerações
`SEARCH_RESULT_MODE_UNSPECIFIED`	Valor predefinido.
`DOCUMENTS`	Devolve documentos no resultado da pesquisa.
`CHUNKS`	Devolve fragmentos no resultado da pesquisa. Só está disponível se o elemento `DocumentProcessingConfig.chunking_config` estiver especificado.

SnippetSpec

Uma especificação para configurar fragmentos numa resposta de pesquisa.

Campos

max_snippet_count
(deprecated)

int32

[DEPRECATED] Este campo foi descontinuado. Para controlar o retorno de fragmentos, use o campo return_snippet. Para compatibilidade com versões anteriores, devolvemos o fragmento se max_snippet_count > 0.

reference_only
(deprecated)

bool

[DESCONTINUADO] Este campo está descontinuado e não tem efeito no fragmento.

return_snippet

bool

Se true, devolva o fragmento. Se não for possível gerar um fragmento, devolvemos "Não está disponível nenhum fragmento para esta página". Também é devolvido um snippet_status com SUCCESS ou NO_SNIPPET_AVAILABLE.

SummarySpec

Uma especificação para configurar um resumo devolvido numa resposta de pesquisa.

Campos
`summary_result_count`	`int32` O número de principais resultados a partir dos quais gerar o resumo. Se o número de resultados devolvidos for inferior a `summaryResultCount`, o resumo é gerado a partir de todos os resultados. Podem ser usados, no máximo, 10 resultados para o modo de documentos ou 50 para o modo de fragmentos para gerar um resumo. O modo de fragmentos é usado quando `SearchRequest.ContentSearchSpec.search_result_mode` está definido como `CHUNKS`.
`include_citations`	`bool` Especifica se devem ser incluídas citações no resumo. O valor predefinido é `false`. Quando este campo está definido como `true`, os resumos incluem números de citações inline. Exemplo de resumo com citações: O BigQuery é o armazém de dados empresarial totalmente gerido e completamente sem servidor da Google Cloud [1]. O BigQuery suporta todos os tipos de dados, funciona em várias nuvens e tem aprendizagem automática e Business Intelligence incorporadas, tudo numa plataforma unificada [2, 3]. Os números das citações referem-se aos resultados da pesquisa devolvidos e são indexados a 1. Por exemplo, [1] significa que a frase é atribuída ao primeiro resultado da pesquisa. [2, 3] significa que a frase é atribuída ao segundo e terceiro resultados da pesquisa.
`ignore_adversarial_query`	`bool` Especifica se as consultas adversariais devem ser filtradas. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas adversariais. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta adversária. Por exemplo, um utilizador pode fazer uma pergunta sobre comentários negativos acerca da empresa ou enviar uma consulta concebida para gerar resultados inseguros que violem as políticas. Se este campo estiver definido como `true`, ignoramos a geração de resumos para consultas adversariais e devolvemos mensagens alternativas.
`ignore_non_summary_seeking_query`	`bool` Especifica se devem ser filtradas consultas que não procuram resumos. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas que procuram resumos. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta que não procura resumos. Por exemplo, `why is the sky blue` e `Who is the best soccer player in the world?` são consultas que procuram resumos, mas `SFO airport` e `world cup 2026` não. São, muito provavelmente, consultas de navegação. Se este campo estiver definido como `true`, ignoramos a geração de resumos para consultas que não procuram resumos e devolvemos mensagens alternativas.
`ignore_low_relevant_content`	`bool` Especifica se devem ser filtradas consultas com baixa relevância. O valor predefinido é `false`. Se este campo estiver definido como `false`, todos os resultados da pesquisa são usados, independentemente da relevância, para gerar respostas. Se estiver definido como `true`, apenas as consultas com resultados da pesquisa de alta relevância geram respostas.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor predefinido é `false`. A Google usa a classificação de consultas de pesquisa para detetar consultas de jailbreak. Não é devolvido nenhum resumo se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um utilizador pode adicionar instruções à consulta para alterar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir ao modelo para agir como uma entidade diferente, por exemplo, "Responde no tom do CEO de uma empresa concorrente". Se este campo estiver definido como `true`, ignoramos a geração de resumos para consultas de jailbreak e devolvemos mensagens alternativas.
`model_prompt_spec`	`ModelPromptSpec` Se for especificado, a especificação é usada para modificar o comando fornecido ao MDG.
`language_code`	`string` Código do idioma para o resumo. Use etiquetas de idioma definidas pela norma BCP47. Nota: esta é uma funcionalidade experimental.
`model_spec`	`ModelSpec` Se for especificado, a especificação é usada para modificar a especificação do modelo fornecida ao MDG.
`use_semantic_chunks`	`bool` Se for verdadeiro, a resposta é gerada a partir dos fragmentos mais relevantes dos principais resultados da pesquisa. Esta funcionalidade melhora a qualidade dos resumos. Tenha em atenção que, com esta funcionalidade ativada, nem todos os principais resultados da pesquisa são referenciados e incluídos na lista de referências. Por isso, o índice da fonte de citação aponta apenas para os resultados da pesquisa apresentados na lista de referências.

ModelPromptSpec

Especificação do comando a usar com o modelo.

Campos

preamble

string

Texto no início do comando que dá instruções ao assistente. Estão disponíveis exemplos no guia do utilizador.

ModelSpec

Especificação do modelo.

Campos

version

string

A versão do modelo usada para gerar o resumo.

Os valores suportados são:

stable: string. Valor predefinido quando não é especificado nenhum valor. Usa um modelo ajustado disponível de forma geral. Para mais informações, consulte o artigo Ciclo de vida e versões do modelo de geração de respostas.
preview: string. (Pré-visualização pública) Usa um modelo de pré-visualização. Para mais informações, consulte o artigo Versões e ciclo de vida do modelo de geração de respostas.

DataStoreSpec

Uma struct para definir arquivos de dados a filtrar numa chamada de pesquisa e configurações para esses arquivos de dados. Caso contrário, é devolvido um erro INVALID_ARGUMENT.

Campos
`data_store`	`string` Obrigatório. Nome completo do recurso de `DataStore`, como `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. O caminho tem de incluir o número do projeto. O ID do projeto não é suportado para este campo.
`filter`	`string` Opcional. Especificação de filtro para filtrar documentos no arquivo de dados especificado pelo campo data_store. Para mais informações sobre a filtragem, consulte o artigo Filtragem
`boost_spec`	`BoostSpec` Opcional. Especificação de aumento para aumentar determinados documentos. Para mais informações sobre o aumento, consulte o artigo Aumentar
`custom_search_operators`	`string` Opcional. Operadores de pesquisa personalizados que, se especificados, são usados para filtrar os resultados das bases de dados de dados do espaço de trabalho. Para mais informações sobre os operadores de pesquisa personalizados, consulte SearchOperators.

DisplaySpec

Especifica funcionalidades para apresentação, como o realce de correspondências.

Campos

match_highlighting_condition

A condição em que o realce de correspondências deve ocorrer.

MatchHighlightingCondition

Enum que descreve em que condição deve ocorrer o realce de correspondências.

Enumerações
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	O comportamento do servidor é o mesmo que `MATCH_HIGHLIGHTING_DISABLED`.
`MATCH_HIGHLIGHTING_DISABLED`	Desativa o realce de correspondências em todos os documentos.
`MATCH_HIGHLIGHTING_ENABLED`	Ativa o realce de correspondências em todos os documentos.

FacetSpec

Uma especificação de faceta para realizar uma pesquisa com filtros.

Campos
`facet_key`	`FacetKey` Obrigatório. A especificação da chave de faceta.
`limit`	`int32` Valores máximos de facetas devolvidos para esta faceta. Se não for especificado, a predefinição é 20. O valor máximo permitido é 300. Os valores acima de 300 são forçados a 300. Para a agregação na pesquisa de cuidados de saúde, quando [FacetKey.key] é "healthcare_aggregation_key", o limite é substituído internamente por 10 000, independentemente do valor definido aqui. Se este campo for negativo, é devolvido um `INVALID_ARGUMENT`.
`excluded_filter_keys[]`	`string` Lista de chaves a excluir ao usar a segmentação detalhada. Por predefinição, `FacetKey.key` não é excluído do filtro, a menos que esteja listado neste campo. A inclusão de uma chave de atributo neste campo permite que os respetivos valores apareçam como resultados de atributos, mesmo quando são filtrados dos resultados da pesquisa. A utilização deste campo não afeta os resultados da pesquisa devolvidos. Por exemplo, suponhamos que existem 100 documentos com a faceta de cor "Vermelho" e 200 documentos com a faceta de cor "Azul". Uma consulta que contenha o filtro "color:ANY("Red")" e que tenha "color" como `FacetKey.key` devolve, por predefinição, apenas documentos "Red" nos resultados da pesquisa e também devolve "Red" com a contagem 100 como a única faceta de cor. Embora também estejam disponíveis documentos azuis, "Azul" não seria apresentado como um valor de faceta disponível. Se "color" estiver listado em "excludedFilterKeys", a consulta devolve os valores da faceta "Red" com a contagem 100 e "Blue" com a contagem 200, porque a chave "color" está agora excluída do filtro. Uma vez que este campo não afeta os resultados da pesquisa, os resultados da pesquisa continuam a ser filtrados corretamente para devolver apenas documentos "Vermelho". São permitidos, no máximo, 100 valores. Caso contrário, é devolvido um erro `INVALID_ARGUMENT`.
`enable_dynamic_position`	`bool` Ativa a posição dinâmica para esta faceta. Se estiver definido como verdadeiro, a posição deste aspeto entre todos os aspetos na resposta é determinada automaticamente. Se as facetas dinâmicas estiverem ativadas, são ordenadas em conjunto. Se for definido como falso, a posição deste aspeto na resposta é a mesma que no pedido, e é classificado antes dos aspetos com a posição dinâmica ativada e de todos os aspetos dinâmicos. Por exemplo, pode querer sempre que a faceta de classificação seja devolvida na resposta, mas não é necessariamente para apresentar sempre a faceta de classificação na parte superior. Nesse caso, pode definir enable_dynamic_position como verdadeiro para que a posição do aspeto de classificação na resposta seja determinada automaticamente. Outro exemplo, partindo do princípio de que tem as seguintes facetas no pedido: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false Além disso, tem facetas dinâmicas ativadas, o que gera uma faceta `gender`. Em seguida, a ordem final das facetas na resposta pode ser ("price", "brands", "rating", "gender") ou ("price", "brands", "gender", "rating"), dependendo da forma como a API ordena as facetas "gender" e "rating". No entanto, repare que "price" e "brands" estão sempre classificados na primeira e segunda posição, respetivamente, porque o enable_dynamic_position é falso.

FacetKey

Especifica como é calculado um aspeto.

Campos
`key`	`string` Obrigatório. Chaves de facetas textuais e numéricas suportadas no objeto `Document`, sobre as quais os valores das facetas são calculados. A chave de faceta é sensível a maiúsculas e minúsculas.
`intervals[]`	`Interval` Defina apenas se os valores devem ser agrupados em intervalos. Tem de ser definido para facetas com valores numéricos. Não pode ser definido para uma faceta com valores de texto. O número máximo de intervalos é 30.
`restricted_values[]`	`string` Apenas recebe a faceta para os valores restritos especificados. Só é suportado em campos de texto. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "restricted_values" como "Ação > 2022", a faceta "category" só contém "Ação > 2022". Só é suportado em campos de texto. O máximo é 10.
`prefixes[]`	`string` Apenas recebe valores de facetas que começam com o prefixo de string fornecido. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "prefixes" como "Action", o detalhe "category" contém apenas "Action > 2022" e "Action > 2021". Só é suportado em campos de texto. O máximo é 10.
`contains[]`	`string` Obtenha apenas valores de facetas que contenham as strings indicadas. Por exemplo, suponhamos que "categoria" tem três valores: "Ação > 2022", "Ação > 2021" e "Ciência ficção > 2022". Se definir "contém" como "2022", a faceta "categoria" só contém "Ação > 2022" e "Ciência ficção > 2022". Só é suportado em campos de texto. O máximo é 10.
`case_insensitive`	`bool` Verdadeiro para tornar as chaves de faceta insensíveis a maiúsculas e minúsculas quando obtém valores de facetas com prefixos ou contém; caso contrário, falso.
`order_by`	`string` A ordem pela qual os documentos são devolvidos. Os valores permitidos são: "count desc", que significa ordenar por `SearchResponse.Facet.values.count` por ordem descendente. "value desc", que significa ordenar por `SearchResponse.Facet.values.value` de forma descendente. Aplica-se apenas a facetas textuais. Se não estiver definido, os valores textuais são ordenados por ordem natural; os intervalos numéricos são ordenados pela ordem indicada por `FacetSpec.FacetKey.intervals`.

ImageQuery

Especifica a entrada de consulta de imagem.

Campos

Campo de união image.

image só pode ser uma das seguintes opções:

image_bytes

string

Bytes de imagem codificados em Base64. Formatos de imagem suportados: JPEG, PNG e BMP.

NaturalLanguageQueryUnderstandingSpec

Especificação para ativar as capacidades de compreensão de linguagem natural para pedidos de pesquisa.

Campos
`filter_extraction_condition`	`FilterExtractionCondition` A condição em que a extração de filtros deve ocorrer. O comportamento do servidor é predefinido para `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` Nomes de campos usados para a filtragem baseada na localização, onde os filtros de geolocalização são detetados em consultas de pesquisa em linguagem natural. Só é válido quando FilterExtractionCondition está definido como `ENABLED`. Se este campo estiver definido, substitui os nomes dos campos definidos em `ServingConfig.geo_search_query_detection_field_names`.
`extracted_filter_behavior`	`ExtractedFilterBehavior` Opcional. Controla o comportamento da forma como os filtros extraídos são aplicados à pesquisa. O comportamento predefinido depende do pedido. Para a pesquisa estruturada de um único arquivo de dados, a predefinição é `HARD_FILTER`. Para a pesquisa em vários arquivos de dados, o comportamento predefinido é `SOFT_BOOST`. Os filtros baseados na localização são sempre aplicados como filtros rígidos, e a definição `SOFT_BOOST` não os afeta. Este campo só é usado se [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] estiver definido como `FilterExtractionCondition.ENABLED`.
`allowed_field_names[]`	`string` Opcional. Lista de autorizações de campos que podem ser usados para a extração de filtros de linguagem natural. Por predefinição, se não for especificado, todos os campos indexáveis são elegíveis para a extração de filtros de linguagem natural (mas não é garantido que sejam usados). Se forem especificados campos em allowed_field_names, apenas os campos marcados como indexáveis no esquema e especificados na lista de autorizações são elegíveis para a extração de filtros de linguagem natural. Nota: para a pesquisa em vários arquivos de dados, esta opção ainda não é suportada e será ignorada.

ExtractedFilterBehavior

Enum que descreve como os filtros extraídos são aplicados à pesquisa.

Enumerações
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` vai usar o comportamento predefinido para os filtros extraídos. Para a pesquisa de um único arquivo de dados, a predefinição é aplicar como filtros rígidos. Para a pesquisa em vários arquivos de dados, a predefinição é aplicar como aumentos suaves.
`HARD_FILTER`	Aplica todos os filtros extraídos como filtros rígidos nos resultados. Os resultados que não passarem nos filtros extraídos não são devolvidos no conjunto de resultados.
`SOFT_BOOST`	Aplica todos os filtros extraídos como aumentos ligeiros. Os resultados que passam nos filtros são otimizados para classificações mais elevadas no conjunto de resultados.

FilterExtractionCondition

Enum que descreve em que condição deve ocorrer a extração de filtros.

Enumerações
`CONDITION_UNSPECIFIED`	O comportamento do servidor é predefinido para `DISABLED`.
`DISABLED`	Desativa a extração de filtros de NL.
`ENABLED`	Ativa a extração de filtros de NL.

QueryExpansionSpec

Especificação para determinar em que condições deve ocorrer a expansão de consultas.

Campos

condition

Condition

A condição em que a expansão de consultas deve ocorrer. Predefinição para Condition.DISABLED.

pin_unexpanded_results

bool

Se os resultados não expandidos devem ser fixados. Se este campo for definido como verdadeiro, os produtos não expandidos estão sempre na parte superior dos resultados da pesquisa, seguidos pelos resultados expandidos.

Condição

Enum que descreve em que condição deve ocorrer a expansão de consultas.

Enumerações
`CONDITION_UNSPECIFIED`	Condição de expansão da consulta não especificada. Neste caso, o comportamento do servidor é predefinido para `Condition.DISABLED`.
`DISABLED`	Expansão de consultas desativada. Apenas é usada a consulta de pesquisa exata, mesmo que `SearchResponse.total_size` seja zero.
`AUTO`	Expansão automática de consultas criada pela API Search.

RankingExpressionBackend

O back-end a usar para a avaliação da expressão de classificação.

Enumerações
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Opção predefinida para valores não especificados/desconhecidos.
`BYOE`	Descontinuado: em alternativa, use `RANK_BY_EMBEDDING`. Classificação pelo modelo de incorporação personalizado, a forma predefinida de avaliar a expressão de classificação. Opção de enumeração antiga. Em alternativa, deve usar-se `RANK_BY_EMBEDDING`. Este item foi descontinuado!
`CLEARBOX`	Descontinuado: em alternativa, use `RANK_BY_FORMULA`. Classificação por fórmula personalizada. Opção de enumeração antiga. Em alternativa, deve usar-se `RANK_BY_FORMULA`. Este item foi descontinuado!
`RANK_BY_EMBEDDING`	Classificação pelo modelo de incorporação personalizado, a forma predefinida de avaliar a expressão de classificação.
`RANK_BY_FORMULA`	Classificação por fórmula personalizada.

RelevanceScoreSpec

A especificação para devolver a pontuação de relevância do documento.

Campos

return_relevance_score

bool

Opcional. Se deve devolver a pontuação de relevância para os resultados da pesquisa. Quanto mais elevada for a pontuação, mais relevante é o documento para a consulta.

RelevanceThreshold

O limite de relevância dos resultados da pesquisa. Quanto mais elevado for o limite de relevância, mais resultados relevantes são apresentados e menor é o número de resultados devolvidos.

Enumerações
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Valor predefinido. Neste caso, o comportamento do servidor assume a predefinição do limite definido pela Google.
`LOWEST`	Limite de relevância mais baixo.
`LOW`	Limite de relevância baixo.
`MEDIUM`	Requisito de relevância médio.
`HIGH`	Limiar de relevância elevado.

SearchAsYouTypeSpec

Especificação para a pesquisa à medida que escreve em pedidos de pesquisa.

Campos

condition

Condition

A condição em que a pesquisa à medida que escreve deve ocorrer. Predefinição para Condition.DISABLED.

Condição

Enum que descreve em que condição deve ocorrer a pesquisa à medida que escreve.

Enumerações
`CONDITION_UNSPECIFIED`	O comportamento do servidor é predefinido para `Condition.DISABLED`.
`DISABLED`	Desativa a pesquisa à medida que escreve.
`ENABLED`	Ativa a pesquisa à medida que escreve.
`AUTO`	Alternância automática entre os modos de pesquisa à medida que escreve e de pesquisa padrão, ideal para implementações de API única (por exemplo, eliminação de repetições).

SessionSpec

Especificação da sessão.

A funcionalidade de pesquisa com várias interações está atualmente na fase de GA privada. Use a versão v1alpha ou v1beta antes de lançarmos esta funcionalidade para a disponibilidade geral pública. Em alternativa, peça a inclusão na lista de autorizações através da equipa de apoio técnico da Google.

Campos

query_id

string

Se estiver definido, o resultado da pesquisa é armazenado no "turno" especificado por este ID de consulta.

Exemplo: suponhamos que a sessão tem o seguinte aspeto: session { name: ".../sessions/xxx" turns { query { text: "O que é foo?" query_id: ".../questions/yyy" } answer: "Foo é ..." } turns { query { text: "E bar?" query_id: ".../questions/zzz" } } }

O utilizador pode chamar a API /search com um pedido como este:

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

Em seguida, a API armazena o resultado da pesquisa, associado à última interação. O resultado da pesquisa armazenado pode ser usado por uma chamada de API /answer subsequente (com o ID da sessão e o ID da consulta especificados). Além disso, é possível chamar /search e /answer em paralelo com o mesmo ID da sessão e ID da consulta.

search_result_persistence_count

int32

O número de principais resultados da pesquisa a manter. Os resultados da pesquisa persistentes podem ser usados para a chamada da API /answer subsequente.

Este campo é semelhante ao campo summary_result_count em SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

No máximo, 10 resultados para o modo de documentos ou 50 para o modo de fragmentos.

SpellCorrectionSpec

A especificação para a correção ortográfica de consultas.

Campos

mode

Mode

O modo no qual a correção ortográfica substitui a consulta de pesquisa original. A predefinição é Mode.AUTO.

Modo

Enum que descreve em que modo deve ocorrer a correção ortográfica.

Enumerações
`MODE_UNSPECIFIED`	Modo de correção ortográfica não especificado. Neste caso, o comportamento do servidor é predefinido para `Mode.AUTO`.
`SUGGESTION_ONLY`	A API Search tenta encontrar uma sugestão ortográfica. Se for encontrada uma sugestão, esta é colocada no `SearchResponse.corrected_query`. A sugestão ortográfica não é usada como consulta de pesquisa.
`AUTO`	Correção ortográfica automática criada pela API Search. A pesquisa baseia-se na consulta corrigida, se for encontrada.

SearchResponse

Mensagem de resposta para o método SearchService.Search.

Campos
`results[]`	`SearchResult` Uma lista de documentos correspondentes. A ordem representa a classificação.
`facets[]`	`Facet` Resultados das facetas pedidas pelo utilizador.
`total_size`	`int32` A contagem total estimada de itens correspondentes, independentemente da paginação. A quantidade de `results` devolvida pela paginação pode ser inferior à quantidade de `total_size` que corresponde.
`attribution_token`	`string` Um token de pesquisa único. Isto deve ser incluído nos registos `UserEvent` resultantes desta pesquisa, o que permite uma atribuição precisa do desempenho do modelo de pesquisa. Isto também ajuda a identificar um pedido durante os cenários de apoio técnico ao cliente.
`redirect_uri`	`string` O URI de uma página de redirecionamento definida pelo cliente. Se a ação de redirecionamento for acionada, não é realizada nenhuma pesquisa e apenas `redirect_uri` e `attribution_token` são definidos na resposta.
`next_page_token`	`string` Um token que pode ser enviado como `SearchRequest.page_token` para obter a página seguinte. Se este campo for omitido, não existem páginas subsequentes.
`corrected_query`	`string` Contém a consulta com a ortografia corrigida, se for encontrada. Se o tipo de correção ortográfica for AUTOMATIC, os resultados da pesquisa baseiam-se em corrected_query. Caso contrário, a consulta original é usada para a pesquisa.
`summary`	`Summary` Um resumo como parte dos resultados da pesquisa. Este campo só é devolvido se `SearchRequest.ContentSearchSpec.summary_spec` estiver definido.
`query_expansion_info`	`QueryExpansionInfo` Informações de expansão da consulta para os resultados devolvidos.
`session_info`	`SessionInfo` Informações da sessão. Só é definido se for fornecido o elemento `SearchRequest.session`. Consulte a respetiva descrição para ver mais detalhes.
`search_link_promotions[]`	`SearchLinkPromotion` Promoções para a pesquisa no site.

Um resultado de atributo.

Campos

key

string

A chave desta faceta. Por exemplo, "colors" ou "price". Corresponde a SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Os valores da faceta para este campo.

dynamic_facet

bool

Se o aspeto é gerado dinamicamente.

FacetValue

Um valor de faceta que contém nomes de valores e a respetiva contagem.

Campos
`count`	`int64` Número de artigos que têm este valor de faceta.
Campo de união `facet_value`. Um valor de faceta que contém valores. `facet_value` só pode ser uma das seguintes opções:
`value`	`string` Valor de texto de uma faceta, como "Preto" para a faceta "cores".
`interval`	`Interval` Valor do intervalo para uma faceta, como [10, 20) para a faceta "price". Corresponde a `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Informações que descrevem a expansão de consultas, incluindo se a expansão ocorreu.

Campos

expanded_query

bool

Valor booleano que descreve se ocorreu a expansão da consulta.

pinned_result_count

int64

Número de resultados fixados. Este campo só é definido quando ocorre a expansão e SearchRequest.QueryExpansionSpec.pin_unexpanded_results está definido como verdadeiro.

SearchResult

Representa os resultados da pesquisa.

Campos
`id`	`string` `Document.id` do `Document` pesquisado.
`document`	`Document` O fragmento de dados do documento na resposta de pesquisa. Apenas os campos marcados como `retrievable` são preenchidos.
`chunk`	`Chunk` Os dados de blocos na resposta de pesquisa se o valor de `SearchRequest.ContentSearchSpec.search_result_mode` for `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Apenas saída. O Google forneceu pontuações disponíveis.
`rank_signals`	`RankSignals` Opcional. Um conjunto de sinais de classificação associados ao resultado.

RankSignals

Um conjunto de sinais de classificação.

Campos
`default_rank`	`float` Opcional. A classificação predefinida do resultado.
`custom_signals[]`	`CustomSignal` Opcional. Uma lista de sinais de caixa transparente personalizados.
`keyword_similarity_score`	`float` Opcional. Ajuste da correspondência de palavras-chave.
`relevance_score`	`float` Opcional. Ajuste de relevância semântica.
`semantic_similarity_score`	`float` Opcional. Ajuste de semelhança semântica.
`pctr_rank`	`float` Opcional. Ajuste da taxa de conversão previsto como uma classificação.
`topicality_rank`	`float` Opcional. Ajuste de topicalidade como classificação.
`document_age`	`float` Opcional. Idade do documento em horas.
`boosting_factor`	`float` Opcional. Potenciações personalizadas combinadas para um documento.

CustomSignal

Sinal de caixa transparente personalizado representado por um par de nome e valor.

Campos

name

string

Opcional. Nome do sinal.

value

float

Opcional. Valor de ponto flutuante que representa o sinal de classificação (por exemplo, 1,25 para BM25).

SessionInfo

Informações sobre a sessão.

Campos

name

string

Nome da sessão. Se for usado o modo de sessão automática (quando SearchRequest.session termina com "-"), este campo contém o nome da sessão recém-gerado.

query_id

string

ID da consulta que corresponde a esta chamada API de pesquisa. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e este ID da consulta na chamada da API Answer, a geração de respostas ocorre no contexto dos resultados da pesquisa desta chamada de pesquisa.

Resumo

Resumo dos N principais resultados da pesquisa especificados pela especificação do resumo.

Campos
`summary_text`	`string` O conteúdo do resumo.
`summary_skipped_reasons[]`	`SummarySkippedReason` Outros motivos de omissão do resumo. Isto indica o motivo dos casos ignorados. Se nada for ignorado, este campo não é definido.
`safety_attributes`	`SafetyAttributes` Uma coleção de categorias de atributos de segurança e as respetivas classificações de confiança associadas.
`summary_with_metadata`	`SummaryWithMetadata` Resumo com informações de metadados.

Citação

Informações de citação para um segmento.

Campos

start_index

int64

O índice indica o início do segmento, medido em bytes/Unicode.

end_index

int64

Fim do segmento atribuído, exclusivo.

sources[]

CitationSource

Origens das citações para o segmento atribuído.

CitationMetadata

Metadados de citações.

Campos

citations[]

Citation

Citações para segmentos.

CitationSource

Fonte da citação.

Campos

reference_index

int64

Índice de referência do documento de SummaryWithMetadata.references. É indexado a 0 e o valor é zero se o reference_index não estiver definido explicitamente.

Referência

Referência do documento.

Campos
`title`	`string` Título do documento.
`document`	`string` Obrigatório. `Document.name` do documento. Nome completo do recurso do documento referenciado, no formato `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` URI do Cloud Storage ou HTTP para o documento.
`chunk_contents[]`	`ChunkContent` Lista de conteúdos de fragmentos citados derivados do conteúdo do documento.

ChunkContent

Dividir o conteúdo em partes.

Campos

content

string

Dividir o conteúdo textual em partes.

page_identifier

string

Identificador da página.

SafetyAttributes

Categorias de atributos de segurança e respetivas classificações de confiança associadas.

Campos

categories[]

string

Os nomes a apresentar das categorias de atributos de segurança associadas ao conteúdo gerado. A ordem corresponde às pontuações.

scores[]

float

As pontuações de confiança de cada categoria. Um valor mais elevado significa uma confiança mais elevada. A ordem corresponde às categorias.

SummarySkippedReason

Uma enumeração para os motivos de omissão do resumo.

Enumerações
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Valor predefinido. O motivo pelo qual o resumo foi ignorado não está especificado.
`ADVERSARIAL_QUERY_IGNORED`	A consulta adversária ignorou as maiúsculas e minúsculas. Usado apenas quando `SummarySpec.ignore_adversarial_query` está definido como `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	A consulta que não procura resumos ignorou as maiúsculas/minúsculas. O Google ignora o resumo se a consulta for uma conversa informal. Usado apenas quando `SummarySpec.ignore_non_summary_seeking_query` está definido como `true`.
`OUT_OF_DOMAIN_QUERY_IGNORED`	A consulta fora do domínio ignorou as maiúsculas/minúsculas. O Google ignora o resumo se não existirem resultados da pesquisa de alta relevância. Por exemplo, o repositório de dados contém factos sobre a empresa A, mas a consulta do utilizador está a fazer perguntas sobre a empresa B.
`POTENTIAL_POLICY_VIOLATION`	O registo de potencial violação de política. A Google ignora o resumo se for detetada uma potencial violação de política. Isto inclui conteúdo que pode ser violento ou tóxico.
`LLM_ADDON_NOT_ENABLED`	O caso em que o suplemento do MDG não está ativado. O Google ignora o resumo se o suplemento do MDG não estiver ativado.
`NO_RELEVANT_CONTENT`	O caso de não haver conteúdo relevante. O Google ignora o resumo se não existir conteúdo relevante nos resultados da pesquisa obtidos.
`JAIL_BREAKING_QUERY_IGNORED`	A consulta de desbloqueio ignorou as maiúsculas e minúsculas. Por exemplo, "Responde com o tom do CEO de uma empresa concorrente". Usado apenas quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] está definido como `true`.
`CUSTOMER_POLICY_VIOLATION`	O registo de violação da política do cliente. A Google ignora o resumo se for detetada uma violação da política de clientes. A política é definida pelo cliente.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	A consulta que não procura respostas ignorou as maiúsculas/minúsculas. O Google ignora o resumo se a consulta não tiver uma intenção clara. Usado apenas quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] está definido como `true`.
`TIME_OUT`	A capa que evita que o telemóvel se desligue. O Google ignora o resumo se o tempo limite for excedido.

SummaryWithMetadata

Resumo com informações de metadados.

Campos

summary

string

Texto de resumo sem informações de citação.

citation_metadata

CitationMetadata

Metadados de citações para o resumo fornecido.

references[]

Reference

Referências de documentos.

SearchTier

Níveis de funcionalidades de pesquisa. Os diferentes níveis podem ter preços diferentes. Para saber mais, consulte a documentação de preços.

Enumerações
`SEARCH_TIER_UNSPECIFIED`	Valor predefinido quando o enum não está especificado. Esta opção é inválida para utilização.
`SEARCH_TIER_STANDARD`	Nível Standard.
`SEARCH_TIER_ENTERPRISE`	Nível Enterprise.

SearchUseCase

Define uma subdivisão adicional de SolutionType. Aplica-se especificamente a SOLUTION_TYPE_SEARCH.

Enumerações
`SEARCH_USE_CASE_UNSPECIFIED`	Valor usado quando não está definido. Não ocorre no CSS.
`SEARCH_USE_CASE_SEARCH`	Exemplo de utilização da Pesquisa. Espera que o tráfego tenha um `query` não vazio.
`SEARCH_USE_CASE_BROWSE`	Exemplo de utilização de navegação. Espera que o tráfego tenha um `query` vazio.

ServingConfig

Configura metadados que são usados para gerar resultados no momento da publicação (por exemplo, resultados da pesquisa ou previsões de recomendações). O ServingConfig é transmitido no pedido de pesquisa e previsão, e gera resultados.

Campos
`name`	`string` Imutável. Nome totalmente qualificado `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Obrigatório. O nome a apresentar da configuração de publicação legível. Usado na IU do Discovery. Este campo tem de ser uma string codificada em UTF-8 com um limite de 128 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`solution_type`	`SolutionType` Obrigatório. Imutável. Especifica o tipo de solução ao qual uma configuração de publicação pode ser associada.
`model_id`	`string` O ID do modelo a usar no momento da publicação. Atualmente, apenas são suportados RecommendationModels. Pode ser alterado, mas apenas para um modelo compatível (por exemplo, CTR de outros utilizadores que podem gostar para CVR de outros utilizadores que podem gostar). Obrigatório quando `SolutionType` é `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` A diversidade a usar nos resultados do modelo de recomendação, por exemplo, `medium-diversity` ou `high-diversity`. Valores atualmente suportados: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Se não for especificado, escolhemos a predefinição com base no tipo de modelo de recomendação. Valor predefinido: `no-diversity`. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_RECOMMENDATION`.
`ranking_expression`	`string` A expressão de classificação controla a classificação personalizada nos documentos de obtenção. Para tirar partido desta funcionalidade, é necessária a incorporação de documentos. A definição da expressão de classificação em ServingConfig aplica-se a todos os pedidos de pesquisa publicados pela configuração de publicação. No entanto, se `SearchRequest.ranking_expression` for especificado, substitui a expressão de classificação ServingConfig. A expressão de classificação é uma única função ou várias funções unidas por "+". ranking_expression = function, { " + ", function }; Funções suportadas: double * relevance_score double * dotProduct(embedding_field_path) Variáveis de função: `relevance_score`: palavras-chave predefinidas, usadas para medir a relevância entre a consulta e o documento. `embedding_field_path`: o campo de incorporação de documentos usado com o vetor de incorporação de consultas. `dotProduct`: função de incorporação entre embedding_field_path e o vetor de incorporação de consultas. Exemplo de expressão de classificação: Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação pode ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
`create_time`	`Timestamp` Apenas saída. Data/hora de criação de ServingConfig.
`update_time`	`Timestamp` Apenas saída. Data/hora da atualização de ServingConfig.
`filter_control_ids[]`	`string` Controlos de filtros a usar no caminho de publicação. Todos os controlos de filtros acionados são aplicados. Os controlos de filtros têm de estar no mesmo arquivo de dados que a configuração de publicação. Máximo de 20 controlos de filtros.
`boost_control_ids[]`	`string` Controlos de aumento a usar no caminho de publicação. Todos os controlos de aumento acionados são aplicados. Os controlos de aumento têm de estar no mesmo repositório de dados que a configuração de publicação. Máximo de 20 controlos de aumento.
`redirect_control_ids[]`	`string` IDs dos controlos de redirecionamento. Apenas é aplicada a primeira ação de redirecionamento acionada, mesmo que existam várias. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`synonyms_control_ids[]`	`string` Especificações de sinónimos de condições. Se existirem várias condições de sinónimos correspondentes, todos os controlos de sinónimos correspondentes na lista são executados. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`oneway_synonyms_control_ids[]`	`string` Especificações de sinónimos unidirecionais de condições. Se existirem várias condições de sinónimos unidirecionais correspondentes, todos os controlos de sinónimos unidirecionais correspondentes na lista são executados. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`dissociate_control_ids[]`	`string` A condição não associa especificações. Se várias condições de não associação corresponderem, todos os controlos de não associação correspondentes na lista são executados. A ordem não é importante. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`replacement_control_ids[]`	`string` Especificações de substituição de condições. Aplicadas de acordo com a ordem na lista. Não é possível substituir novamente um termo substituído anteriormente. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Especificações de ignorar condições. Se existirem várias condições de ignorar correspondentes, todos os controlos de ignorar correspondentes na lista são executados. A ordem não é importante. O número máximo de especificações é 100.
`promote_control_ids[]`	`string` Condição de promoção de especificações. O número máximo de especificações é 100.
`answer_generation_spec`	`AnswerGenerationSpec` Opcional. A especificação para a geração de respostas.
Campo de união `vertical_config`. Configuração específica da vertical da indústria. `vertical_config` só pode ser uma das seguintes opções:
`media_config`	`MediaConfig` O MediaConfig da configuração de publicação.
`generic_config`	`GenericConfig` O GenericConfig da configuração de publicação.

GenericConfig

Especifica as configurações necessárias para a descoberta genérica.Atualmente, suportamos:

content_search_spec: configuração para a pesquisa de conteúdo genérico.

Campos

content_search_spec

ContentSearchSpec

Especifica o comportamento esperado da pesquisa de conteúdo. Só é válido para um arquivo de dados com a pesquisa de conteúdo ativada.

MediaConfig

Especifica as configurações necessárias para a descoberta de conteúdo multimédia. Atualmente, suportamos:

demote_content_watched: limite para a despromoção de conteúdo visto. Os clientes podem especificar se usam a despromoção de conteúdo visto ou a página de detalhes vista. Com a despromoção de conteúdo visto, os clientes têm de especificar os minutos vistos ou a percentagem que excede o limite. Se o conteúdo exceder o limite, é despromovido no resultado da recomendação.
promote_fresh_content: dias de corte para a promoção de conteúdo novo. Os clientes podem especificar se estão a usar a promoção de atualidade do conteúdo. Se o conteúdo tiver sido publicado dentro do período limite, é promovido no resultado da recomendação. Só pode ser definido se SolutionType for SOLUTION_TYPE_RECOMMENDATION.

Campos
`demotion_event_type`	`string` Especifica o tipo de evento usado para despromover o resultado da recomendação. Valores atualmente suportados: `view-item`: artigo visto. `media-play`: iniciar/retomar a visualização de um vídeo, a reprodução de uma música, etc. `media-complete`: terminou ou parou a meio de um vídeo, uma música, etc. Se não estiver definida, a despromoção do histórico de visualizações não é aplicada. A despromoção da atualidade do conteúdo continua a ser aplicada.
`demote_content_watched_past_days`	`int32` Opcional. Especifica o número de dias a considerar para despromover conteúdo visto. Se for definido como zero ou não estiver definido, a predefinição é o máximo de 365 dias.
`content_freshness_cutoff_days`	`int32` Especifica a atualização do conteúdo usado para o resultado da recomendação. O conteúdo é despromovido se tiver sido publicado há mais dias do que o limite de atualização do conteúdo.
Campo de união `demote_content_watched`. Especifique o limite para despromover conteúdo visto. O limite pode ser uma percentagem ou um valor em minutos. Tem de ser definido para o tipo de evento `media-complete`. `demote_content_watched` só pode ser uma das seguintes opções:
`content_watched_percentage_threshold`	`float` Especifica o limite percentual de conteúdo visto para a despromoção. O valor do limite tem de estar entre [0 e 1,0], inclusive.
`content_watched_seconds_threshold`	`float` Especifica o limite de minutos de conteúdo visto para a despromoção.

Sessão

Definição do proto de sessão externa.

Campos
`name`	`string` Imutável. Nome totalmente qualificado `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` Opcional. O nome a apresentar da sessão. Este campo é usado para identificar a sessão na IU. Por predefinição, o nome a apresentar é o texto da primeira consulta na sessão.
`state`	`State` O estado da sessão.
`user_pseudo_id`	`string` Um identificador exclusivo para acompanhar os utilizadores.
`turns[]`	`Turn` Viragens.
`labels[]`	`string` Opcional. As etiquetas da sessão. Pode ser definido como filtro em ListSessionsRequest.
`start_time`	`Timestamp` Apenas saída. A hora em que a sessão começou.
`end_time`	`Timestamp` Apenas saída. A hora em que a sessão terminou.
`is_pinned`	`bool` Opcional. Se a sessão está fixada, a sessão fixada é apresentada na parte superior da lista de sessões.

Estado

Enumeração do estado da sessão.

Enumerações
`STATE_UNSPECIFIED`	O estado não está especificado.
`IN_PROGRESS`	A sessão está atualmente aberta.

Ative ou desative

Representa uma interação, incluindo uma consulta do utilizador e uma resposta do serviço.

Campos
`query`	`Query` Opcional. A consulta do utilizador. Pode não ser definido se esta interação estiver apenas a regenerar uma resposta a uma interação diferente
`answer`	`string` Opcional. O nome do recurso da resposta à consulta do utilizador. Só é definido se a geração de respostas (chamada API /answer) tiver ocorrido neste turno.
`assist_answer`	`string` Apenas saída. O nome do recurso da resposta do Assistente à consulta do utilizador. Apenas definido se tiver ocorrido uma chamada de assistência (chamada da API /assist) neste turno. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Para receber todas as respostas do Assistente para uma sessão, defina GetSessionRequest.include_answer_details como verdadeiro. Em alternativa, para obter um recurso AssistAnswer individual, use a API AssistAnswerService.GetAssistAnswer.
`detailed_answer`	`Answer` Apenas saída. Na API `ConversationalSearchService.GetSession`, se `GetSessionRequest.include_answer_details` estiver definido como verdadeiro, este campo é preenchido quando obtém a sessão de consulta de respostas.
`detailed_assist_answer`	`AssistAnswer` Apenas saída. Na API `ConversationalSearchService.GetSession`, se `GetSessionRequest.include_answer_details` estiver definido como verdadeiro, este campo é preenchido quando obtém a sessão do assistente.
`query_config`	`map<string, string>` Opcional. Representa metadados relacionados com a configuração da consulta, por exemplo, o modelo e a versão do MDG usados, os parâmetros do modelo (temperatura, parâmetros de fundamentação, etc.). O prefixo "google." está reservado para funcionalidades desenvolvidas pela Google.

SetUpDataConnectorMetadata

Este tipo não tem campos.

Metadados para o método DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Pedido para o método DataConnectorService.SetUpDataConnector.

Campos
`parent`	`string` Obrigatório. O pai ou a mãe de `Collection`, no formato de `projects/{project}/locations/{location}`.
`collection_id`	`string` Obrigatório. O ID a usar para o `Collection`, que se torna o componente final do nome do recurso do `Collection`. É criado um novo `Collection` como parte da configuração do `DataConnector`. `DataConnector` é um recurso único em `Collection`, que gere todos os `DataStore`s do `Collection`. Este campo tem de estar em conformidade com a norma RFC-1034, com um limite de comprimento de 63 carateres. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
`collection_display_name`	`string` Obrigatório. O nome a apresentar do `Collection`. Deve ser legível, usado para apresentar coleções no painel de controlo da Play Console. String codificada em UTF-8 com um limite de 1024 carateres.
`data_connector`	`DataConnector` Obrigatório. O `DataConnector` a inicializar no `Collection` recém-criado.

SingleRegionKey

Metadados para CMEKs de região única.

Campos

kms_key

string

Obrigatório. Nome do recurso da chave do KMS de região única que vai ser usado para encriptar recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

O SiteSearchEngine captura as configurações persistentes de pesquisa no site ao nível do DataStore. É um valor único por arquivo de dados.

Campos

name

string

O nome do recurso totalmente qualificado do motor de pesquisa do site. Formato: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Informações de validação para sites de destino na pesquisa de sites avançada.

Campos

site_verification_state

SiteVerificationState

Estado de validação do site que indica a propriedade e a validade.

verify_time

Hora da validação do site mais recente.

SiteVerificationState

Estado da validação do site.

Enumerações
`SITE_VERIFICATION_STATE_UNSPECIFIED`	A predefinição é VERIFIED.
`VERIFIED`	Propriedade do site validada.
`UNVERIFIED`	A validação da propriedade do site está pendente ou falhou.
`EXEMPTED`	Site isento de validação, por exemplo, um Website público que está aberto a todos.

Campos
`name`	`string` Apenas saída. O nome do recurso totalmente qualificado do mapa do site. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` O sufixo `sitemap_id` é gerado pelo sistema.
`create_time`	`Timestamp` Apenas saída. A hora de criação do mapa do site.
Campo de união `feed`. Origens de feeds suportadas. `feed` só pode ser uma das seguintes opções:
`uri`	`string` URI público do mapa do site, por exemplo, `www.example.com/sitemap.xml`.

SolutionType

O tipo de solução.

Enumerações
`SOLUTION_TYPE_UNSPECIFIED`	Valor predefinido.
`SOLUTION_TYPE_RECOMMENDATION`	Usado para a IA de recomendações.
`SOLUTION_TYPE_SEARCH`	Usado para a pesquisa Discovery.
`SOLUTION_TYPE_CHAT`	Usado para exemplos de utilização relacionados com o agente de IA generativa.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Usado para exemplos de utilização relacionados com o agente de chat generativo. É usado apenas para o motor de chat generativo. Os arquivos de dados associados têm de estar inscritos na solução `SOLUTION_TYPE_CHAT`.

SpannerSource

A origem do Spanner para importar dados

Campos
`project_id`	`string` O ID do projeto que contém a origem do Spanner. Tem um limite de 128 carateres. Se não for especificado, herda o ID do projeto do pedido principal.
`instance_id`	`string` Obrigatório. O ID da instância da tabela do Spanner de origem.
`database_id`	`string` Obrigatório. O ID da base de dados da tabela do Spanner de origem.
`table_id`	`string` Obrigatório. O nome da tabela da base de dados do Spanner que tem de ser importada.
`enable_data_boost`	`bool` Se deve aplicar o aumento de dados na exportação do Spanner. A ativação desta opção acarreta um custo adicional. Pode encontrar mais informações aqui.

StreamAssistRequest

Pedido para o método AssistantService.StreamAssist.

Campos
`name`	`string` Obrigatório. O nome do recurso de `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta do utilizador atual. A consulta vazia só é suportada se forem fornecidos `file_ids`. Neste caso, a resposta é gerada com base nesses ficheiros de contexto.
`session`	`string` Opcional. A sessão a usar para o pedido. Se for especificado, o assistente tem acesso ao histórico da sessão, e a consulta e a resposta são armazenadas aí. Se `-` for especificado como o ID da sessão ou for deixado em branco, é criada uma nova sessão com um ID gerado automaticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Opcional. Informações sobre o utilizador que inicia a consulta.
`agents_spec`	`AgentsSpec` Opcional. Especificação dos agentes usados para publicar o pedido.
`tools_spec`	`ToolsSpec` Opcional. Especificação das ferramentas usadas para publicar o pedido.
`generation_spec`	`GenerationSpec` Opcional. Especificação da configuração de geração para o pedido.

AgentsSpec

Especificação dos agentes usados para publicar o pedido.

Campos

agent_specs[]

AgentSpec

Opcional. Especificação dos agentes usados para publicar o pedido.

AgentSpec

Especificação de um agente.

Campos

agent_id

string

Obrigatório. ID para identificar o recurso do agente que publica o pedido.

Este campo tem de estar em conformidade com o RFC-1034 com um limite de comprimento de 63 carateres.

GenerationSpec

Especificação de geração do Assistente para o pedido. Isto permite substituir a configuração de geração predefinida ao nível do motor.

Campos

model_id

string

Opcional. O model_id do Vertex AI usado para o modelo generativo. Se não estiver definido, é usado o modelo do Assistente predefinido.

ToolsSpec

Especificação das ferramentas usadas para publicar o pedido.

Campos
`vertex_ai_search_spec`	`VertexAiSearchSpec` Opcional. Especificação da ferramenta Vertex AI Search.
`web_grounding_spec`	`WebGroundingSpec` Opcional. Especificação da ferramenta de fundamentação Web. Se o campo estiver presente, ativa o fundamento com a pesquisa Web. Só funciona se `Assistant.web_grounding_type` for [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] ou [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
`image_generation_spec`	`ImageGenerationSpec` Opcional. Especificação da ferramenta de geração de imagens.
`video_generation_spec`	`VideoGenerationSpec` Opcional. Especificação da ferramenta de geração de vídeos.

ImageGenerationSpec

Este tipo não tem campos.

Especificação da ferramenta de geração de imagens.

VertexAiSearchSpec

Especificação da ferramenta Vertex AI Search.

Campos

data_store_specs[]

DataStoreSpec

Opcional. Especificações que definem DataStores para filtrar numa chamada de pesquisa e configurações para esses armazenamentos de dados. Isto só é considerado para Engines com várias lojas de dados.

filter

string

Opcional. A sintaxe do filtro consiste numa linguagem de expressão para criar um predicado a partir de um ou mais campos dos documentos que estão a ser filtrados. A expressão de filtro é sensível a maiúsculas e minúsculas.

Se este campo não for reconhecível, é devolvido um INVALID_ARGUMENT.

A filtragem na Vertex AI Search é feita através do mapeamento da chave do filtro do lado esquerdo para uma propriedade de chave definida no back-end da Vertex AI Search. Este mapeamento é definido pelo cliente no respetivo esquema. Por exemplo, um cliente de multimédia pode ter um campo "name" no respetivo esquema. Neste caso, o filtro teria o seguinte aspeto: filter --> name:'ANY("king kong")'

Para mais informações sobre a filtragem, incluindo a sintaxe e os operadores de filtro, consulte o artigo Filtrar

VideoGenerationSpec

Este tipo não tem campos.

Especificação da ferramenta de geração de vídeos.

WebGroundingSpec

Este tipo não tem campos.

Especificação da ferramenta de fundamentação Web.

StreamAssistResponse

Resposta para o método AssistantService.StreamAssist.

Campos

answer

AssistAnswer

Objeto de recurso de resposta do Assist que contém partes da resposta final do assistente à consulta do utilizador.

Não está presente se a resposta atual não adicionar nada ao AssistAnswer.replies enviado anteriormente.

Observe AssistAnswer.state para ver se são esperadas mais peças. Enquanto o estado for IN_PROGRESS, o campo AssistAnswer.replies em cada resposta vai conter respostas (fragmentos de respostas) a serem anexadas às recebidas em respostas anteriores. AssistAnswer.name não vai ser preenchido.

Se o estado for SUCCEEDED, FAILED ou SKIPPED, a resposta é a última resposta e AssistAnswer.name tem um valor.

session_info

SessionInfo

Informações da sessão. Apenas incluído no StreamAssistResponse final da stream de resposta.

assist_token

string

Um ID exclusivo global que identifica o par atual de pedido e stream de respostas. Usado para feedback e apoio técnico.

SessionInfo

Informações sobre a sessão.

Campos

session

string

Nome da sessão recém-gerada ou continuada.

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

SubscriptionTerm

Prazo da subscrição. LINT.IfChange

Enumerações
`SUBSCRIPTION_TERM_UNSPECIFIED`	Valor predefinido, não usar.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 mês.
`SUBSCRIPTION_TERM_ONE_YEAR`	1 ano.
`SUBSCRIPTION_TERM_THREE_YEARS`	3 anos.

SubscriptionTier

Informações do nível de subscrição.

Enumerações
`SUBSCRIPTION_TIER_UNSPECIFIED`	Valor predefinido.
`SUBSCRIPTION_TIER_SEARCH`	Nível de pesquisa. O nível de pesquisa pode aceder às funcionalidades de pesquisa do VAIS e às funcionalidades do NotebookLM.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Nível de pesquisa + assistente. O nível de pesquisa + assistente pode aceder às funcionalidades de pesquisa do VAIS, às funcionalidades do NotebookLM e às funcionalidades do assistente.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	Nível do NotebookLM. O NotebookLM é um nível de subscrição que só pode aceder às funcionalidades do NotebookLM.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Nível de trabalhador da linha da frente.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Nível Agentspace Starter.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Nível Agentspace Business.
`SUBSCRIPTION_TIER_ENTERPRISE`	Nível Enterprise.
`SUBSCRIPTION_TIER_EDU`	Nível EDU.
`SUBSCRIPTION_TIER_EDU_PRO`	Nível EDU Pro.
`SUBSCRIPTION_TIER_EDU_EMERGING`	Nível de mercado emergente para EDU.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Nível de mercado emergente do EDU Pro.

SuggestionDenyListEntry

Entrada da lista de recusa de sugestões que identifica a expressão a bloquear das sugestões e a operação aplicada à expressão.

Campos

block_phrase

string

Obrigatório. Expressão a bloquear nas sugestões apresentadas. Pode ter um máximo de 125 carateres.

match_operator

MatchOperator

Obrigatório. O operador de correspondência a aplicar a esta expressão. Se deve bloquear a expressão exata ou bloquear todas as sugestões que contenham esta expressão.

MatchOperator

Operador para correspondência com as sugestões geradas.

Enumerações
`MATCH_OPERATOR_UNSPECIFIED`	Valor predefinido. Não deve ser usado
`EXACT_MATCH`	Se a sugestão for uma correspondência exata da block_phrase, bloqueie-a.
`CONTAINS`	Se a sugestão contiver a block_phrase, bloqueie-a.

TargetSite

Um site de destino para o SiteSearchEngine.

Campos
`name`	`string` Apenas saída. O nome do recurso totalmente qualificado do site de destino. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` O `target_site_id` é gerado pelo sistema.
`provided_uri_pattern`	`string` Obrigatório. Apenas entrada. O padrão de URI fornecido pelo utilizador a partir do qual o `generated_uri_pattern` é gerado.
`type`	`Type` O tipo do site de destino, por exemplo, se o site deve ser incluído ou excluído.
`exact_match`	`bool` Imutável. Se for definido como falso, é gerado um uri_pattern para incluir todas as páginas cujo endereço contém o provided_uri_pattern. Se estiver definido como verdadeiro, é gerado um uri_pattern para tentar ser uma correspondência exata do provided_uri_pattern ou apenas da página específica se o provided_uri_pattern for específico. O provided_uri_pattern é sempre normalizado para gerar o padrão de URI a ser usado pelo motor de pesquisa.
`generated_uri_pattern`	`string` Apenas saída. Este é gerado pelo sistema com base no provided_uri_pattern.
`root_domain_uri`	`string` Apenas saída. Domínio raiz do provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Apenas saída. Estado da validação da propriedade e da validade do site.
`indexing_status`	`IndexingStatus` Apenas saída. Estado da indexação.
`update_time`	`Timestamp` Apenas saída. A hora da última atualização do site de destino.
`failure_reason`	`FailureReason` Apenas saída. Motivo da falha.

FailureReason

Motivos da falha na indexação da pesquisa no site.

Campos

Campo de união failure. Motivo da falha. failure só pode ser uma das seguintes opções:

quota_failure

QuotaFailure

Falha devido a quota insuficiente.

QuotaFailure

Falha devido a quota insuficiente.

Campos

total_required_quota

int64

Este número é uma estimativa da quota total de que este projeto precisa para concluir a indexação com êxito.

IndexingStatus

Enumeração do estado de indexação do site de destino.

Enumerações
`INDEXING_STATUS_UNSPECIFIED`	A predefinição é SUCCEEDED.
`PENDING`	O site de destino está na fila de atualizações e vai ser processado pelo pipeline de indexação.
`FAILED`	O site de destino não é indexado.
`SUCCEEDED`	O site de destino foi indexado.
`DELETING`	O site de destino indexado anteriormente foi marcado para eliminação. Este é um estado de transição que resulta numa das seguintes situações: 1. O site de destino é eliminado se a anulação da indexação for bem-sucedida; 2. O estado reverte para SUCCEEDED se a anulação da indexação falhar.
`CANCELLABLE`	A alteração do site de destino está pendente, mas pode ser cancelada.
`CANCELLED`	A alteração do site de destino foi cancelada.

Tipo

Tipos de sites de destino possíveis.

Enumerações
`TYPE_UNSPECIFIED`	Este valor não é usado. Neste caso, o comportamento do servidor é predefinido para `Type.INCLUDE`.
`INCLUDE`	Inclua o site de destino.
`EXCLUDE`	Exclua o site de destino.

Inquilino

Informações do inquilino para uma origem de conetor. Isto inclui algumas das mesmas informações armazenadas na mensagem Credential, mas limita-se apenas ao que é necessário para fornecer uma lista de inquilinos acessíveis ao utilizador.

Campos

id

string

O ID da instância do inquilino. Exemplos: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

uri

string

O URI do inquilino, se aplicável. Por exemplo, o URI de uma instância do Jira é https://my-jira-instance.atlassian.net e um inquilino do Slack não tem um URI.

display_name

string

Nome a apresentar opcional para o inquilino, por exemplo, "A minha equipa do Slack".

TextInput

Define a introdução de texto.

Campos

input

string

Entrada de texto.

context

ConversationContext

Contexto da conversa da entrada.

TrainCustomModelMetadata

Metadados relacionados com o progresso da operação TrainCustomModel. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

TrainCustomModelRequest

Mensagem de pedido para o método SearchTuningService.TrainCustomModel.

Campos
`data_store`	`string` Obrigatório. O nome do recurso da loja de dados, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Este campo é usado para identificar o armazenamento de dados onde preparar os modelos.
`model_type`	`string` Modelo a ser preparado. Os valores suportados são: search-tuning: otimização do sistema de pesquisa com base nos dados fornecidos.
`error_config`	`ImportErrorConfig` A localização desejada dos erros incorridos durante o carregamento e a preparação dos dados.
`model_id`	`string` Se não for fornecido, é gerado um UUID.
Campo de união `training_input`. Entrada de preparação do modelo. `training_input` só pode ser uma das seguintes opções:
`gcs_training_input`	`GcsTrainingInput` Entrada de preparação do Cloud Storage.

GcsTrainingInput

Entrada de dados de preparação do Cloud Storage.

Campos
`corpus_data_path`	`string` Os dados do corpus do Cloud Storage que podem ser associados aos dados de preparação. O formato do caminho dos dados é `gs://<bucket_to_data>/<jsonl_file_name>`. Um ficheiro jsonl/ndjson delimitado por newline. Para o modelo de ajuste de pesquisa, cada linha deve ter o _id, o título e o texto. Exemplo: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` Os dados de consulta do GCS que podem ser associados aos dados de preparação. O formato do caminho dos dados é `gs://<bucket_to_data>/<jsonl_file_name>`. Um ficheiro jsonl/ndjson delimitado por newline. Para o modelo de ajuste de pesquisa, cada linha deve ter o _id e o texto. Exemplo: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Caminho dos dados de preparação do Cloud Storage cujo formato deve ser `gs://<bucket_to_data>/<tsv_file_name>`. O ficheiro deve estar no formato TSV. Cada linha deve ter o doc_id, o query_id e a pontuação (número). Para o modelo de otimização da pesquisa, deve ter o ID da consulta, o ID do corpus e a pontuação como cabeçalho do ficheiro TSV. A pontuação deve ser um número em `[0, inf+)`. Quanto maior for o número, mais relevante é o par. Exemplo: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Dados de teste do Cloud Storage. O mesmo formato que train_data_path. Se não for fornecido, é feita uma divisão aleatória de 80/20 entre dados de treino e de teste em train_data_path.

TrainCustomModelResponse

Resposta do TrainCustomModelRequest. Esta mensagem é devolvida pelo campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Um exemplo de erros encontrados durante o processamento dos dados.
`error_config`	`ImportErrorConfig` Reflete o destino dos erros completos no pedido, se definido.
`model_status`	`string` O estado do modelo preparado. Os valores possíveis são os seguintes: bad-data: a qualidade dos dados de preparação é má. no-improvement: a otimização não melhorou o desempenho. Não é possível implementar. in-progress: a criação da tarefa de preparação do modelo está em curso. training: o modelo está a ser preparado ativamente. Avaliação: o modelo está a avaliar as métricas preparadas. indexação: as métricas preparadas do modelo estão a ser indexadas. pronto: o modelo está pronto para publicação.
`metrics`	`map<string, double>` As métricas do modelo preparado.
`model_name`	`string` Nome totalmente qualificado do CustomTuningModel.

TransactionInfo

Uma transação representa toda a transação de compra.

Campos
`currency`	`string` Obrigatório. Código da moeda. Use o código ISO-4217 de três carateres.
`transaction_id`	`string` O ID da transação com um limite de comprimento de 128 carateres.
`value`	`float` Obrigatório. Valor total não nulo associado à transação. Este valor pode incluir o envio, impostos ou outros ajustes ao valor total que quer incluir.
`tax`	`float` Todos os impostos associados à transação.
`cost`	`float` Todos os custos associados aos produtos. Estes podem ser custos de fabrico, despesas de envio não suportadas pelo utilizador final ou quaisquer outros custos, de modo que: Lucro = `value` - `tax` - `cost`
`discount_value`	`float` O valor total dos descontos aplicados a esta transação. Esta figura deve ser excluída de `TransactionInfo.value` Por exemplo, se um utilizador pagou o montante `TransactionInfo.value`, o valor nominal (antes do desconto) da transação é a soma de `TransactionInfo.value` e `TransactionInfo.discount_value` Isto significa que o lucro é calculado da mesma forma, independentemente do valor do desconto, e que `TransactionInfo.discount_value` pode ser superior a `TransactionInfo.value`: Lucro = `value` - `tax` - `cost`

UpdateAclConfigRequest

Mensagem de pedido para o método UpdateAclConfig.

Campos
`acl_config`	`AclConfig`

UpdateAssistantRequest

Mensagem de pedido para o método AssistantService.UpdateAssistant.

Campos

assistant

Assistant

Obrigatório. A app Assistant para atualizar.

O campo name de Assistant é usado para identificar o Assistant a atualizar. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Se o autor da chamada não tiver autorização para atualizar o Assistant, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Assistant a atualizar não existir, é devolvido um erro NOT_FOUND.

update_mask

A lista de campos a atualizar.

UpdateCmekConfigMetadata

Metadados relacionados com o progresso da operação CmekConfigService.UpdateCmekConfig. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

UpdateCmekConfigRequest

Mensagem de pedido para o método UpdateCmekConfig. rpc.

Campos

config

CmekConfig

Obrigatório. O recurso CmekConfig.

set_default

bool

Defina o seguinte CmekConfig como o predefinido a usar para recursos subordinados se não for especificado nenhum.

UpdateControlRequest

Pedido do método UpdateControl.

Campos

control

Control

Obrigatório. O controlo para atualizar.

update_mask

Opcional. Indica os campos no Control fornecido a atualizar. As seguintes funcionalidades NÃO são suportadas:

Control.name
Control.solution_type

Se não for definido ou estiver vazio, todos os campos suportados são atualizados.

UpdateConversationRequest

Pedido do método UpdateConversation.

Campos

conversation

Obrigatório. A conversa a atualizar.

update_mask

Indica os campos no Conversation fornecido a atualizar. As seguintes funcionalidades NÃO são suportadas:

Conversation.name

Se não for definido ou estiver vazio, todos os campos suportados são atualizados.

UpdateDataConnectorRequest

Mensagem de pedido para o método DataConnectorService.UpdateDataConnector.

Campos

data_connector

DataConnector

Obrigatório. A app DataConnector para atualizar.

Se o autor da chamada não tiver autorização para atualizar o DataConnector, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o DataConnector não existir, é devolvido um erro NOT_FOUND.

update_mask

Indica os campos no DataConnector fornecido a atualizar.

Os caminhos de campos suportados incluem:

refresh_interval
params
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: o suporte destes campos pode variar consoante o tipo de conetor. Por exemplo, nem todos os conectores suportam destination_configs.

Se for fornecido um caminho de campo desconhecido ou não suportado, o pedido devolve um erro INVALID_ARGUMENT.

UpdateDataStoreRequest

Mensagem de pedido para o método DataStoreService.UpdateDataStore.

Campos

data_store

DataStore

Obrigatório. A app DataStore para atualizar.

Se o autor da chamada não tiver autorização para atualizar o DataStore, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o DataStore a atualizar não existir, é devolvido um erro NOT_FOUND.

update_mask

Indica os campos no DataStore fornecido a atualizar.

Se for fornecido um campo não suportado ou desconhecido, é devolvido um erro INVALID_ARGUMENT.

UpdateDocumentRequest

Mensagem de pedido para o método DocumentService.UpdateDocument.

Campos

document

Obrigatório. O documento a atualizar/criar.

Se o autor da chamada não tiver autorização para atualizar o Document, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Document a atualizar não existir e allow_missing não estiver definido, é devolvido um erro NOT_FOUND.

allow_missing

bool

Se estiver definido como true e o Document não for encontrado, é criado um novo Document.

update_mask

Indica que campos no "documento" importado fornecido devem ser atualizados. Se não for definido, atualiza todos os campos por predefinição.

UpdateEngineRequest

Mensagem de pedido para o método EngineService.UpdateEngine.

Campos

engine

Engine

Obrigatório. A app Engine para atualizar.

Se o autor da chamada não tiver autorização para atualizar o Engine, independentemente de existir ou não, é devolvido um erro PERMISSION_DENIED.

Se o Engine a atualizar não existir, é devolvido um erro NOT_FOUND.

update_mask

Indica os campos no Engine fornecido a atualizar.

Se for fornecido um campo não suportado ou desconhecido, é devolvido um erro INVALID_ARGUMENT.

UpdateLicenseConfigRequest

Mensagem de pedido para o método LicenseConfigService.UpdateLicenseConfig.

Campos

license_config

LicenseConfig

Obrigatório. A app LicenseConfig para atualizar.

update_mask

Opcional. Indica os campos no LicenseConfig fornecido a atualizar.

Se for fornecido um campo não suportado ou desconhecido, é devolvido um erro INVALID_ARGUMENT.

UpdateSchemaMetadata

Metadados para o LRO UpdateSchema.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

UpdateSchemaRequest

Mensagem de pedido para o método SchemaService.UpdateSchema.

Campos

schema

Schema

Obrigatório. A app Schema para atualizar.

allow_missing

bool

Se for definida como verdadeira e o Schema não for encontrado, é criado um novo Schema. Nesta situação, a política update_mask é ignorada.

UpdateServingConfigRequest

Pedido para o método UpdateServingConfig.

Campos

serving_config

ServingConfig

Obrigatório. O ServingConfig a atualizar.

update_mask

Indica os campos no ServingConfig fornecido a atualizar. As seguintes funcionalidades NÃO são suportadas:

ServingConfig.name

Se não estiver definido, todos os campos suportados são atualizados.

UpdateSessionRequest

Pedido do método UpdateSession.

Campos

session

Obrigatório. A sessão a atualizar.

update_mask

Indica os campos no Session fornecido a atualizar. As seguintes funcionalidades NÃO são suportadas:

Session.name

Se não for definido ou estiver vazio, todos os campos suportados são atualizados.

UpdateTargetSiteMetadata

Metadados relacionados com o progresso da operação SiteSearchEngineService.UpdateTargetSite. Este valor é devolvido pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de criação da operação.

update_time

Hora da última atualização da operação. Se a operação estiver concluída, esta é também a hora de conclusão.

UpdateTargetSiteRequest

Mensagem de pedido para o método SiteSearchEngineService.UpdateTargetSite.

Campos

target_site