Package google.cloud.discoveryengine.v1

QueryClassificationInfo

O horário em que essa pesquisa recente foi feita.

score

double

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

AdvancedSiteSearchConfig

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

Campos

disable_initial_index

bool

Se definido como verdadeiro, a indexação inicial será desativada para o DataStore.

disable_automatic_refresh

bool

Se definido como verdadeiro, a atualização automática será desativada para o DataStore.

AlertPolicyConfig

A configuração de alerta no nível do conector.

Campos

alert_policy_name

string

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

alert_enrollments[]

AlertEnrollment

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

AlertEnrollment

O status de inscrição do alerta.

Campos

alert_id

string

Imutável. O ID de um alerta.

enroll_state

EnrollStates

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

EnrollStates

A enumeração do status de inscrição do alerta.

Tipos enumerados
`ENROLL_STATES_UNSPECIFIED`	Valor padrão. Usado para clientes que não responderam à política de alertas.
`ENROLLED`	O cliente está inscrito nessa política.
`DECLINED`	O cliente recusou esta política.

AlertPolicyResourceConfig

A configuração de alerta no nível do recurso. Usado em: * UserLicense * EngineUserData O AlertPolicyConfig no conector de dados tem o mesmo uso. Não há uma maneira fácil de migrar.

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

AlertEnrollment

O status de inscrição do alerta.

Campos

alert_id

string

Imutável. O ID de um alerta.

enroll_state

EnrollState

Obrigatório. O status 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 registradas. Não armazenado. * E-mails de boas-vindas do Gemini Business. * E-mails de convite para usuários do Gemini Business.

EnrollState

A enumeração do status de inscrição do alerta.

Tipos enumerados
`ENROLL_STATE_UNSPECIFIED`	Valor padrão. Usado para clientes que não responderam à política de alertas.
`ENROLLED`	O cliente está inscrito nessa política.
`DECLINED`	O cliente recusou esta política.

AlloyDbSource

Origem de importação de dados do AlloyDB.

Campos
`project_id`	`string` O ID do projeto que contém a origem do AlloyDB. Tem um limite de 128 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`location_id`	`string` Obrigatório. O local do AlloyDB de onde os dados serão copiados, com um limite de 256 caracteres.
`cluster_id`	`string` Obrigatório. O cluster do AlloyDB de onde os dados serão copiados, com um limite de 256 caracteres.
`database_id`	`string` Obrigatório. O banco de dados do AlloyDB de onde os dados serão copiados, com um limite de 256 caracteres.
`table_id`	`string` Obrigatório. A tabela do AlloyDB de onde os dados serão copiados, com um limite de 256 caracteres.
`gcs_staging_dir`	`string` Diretório intermediário do Cloud Storage usado para importação com um limite de 2.000 caracteres. Pode ser especificado se você quiser que o AlloyDB exporte para um diretório específico do Cloud Storage. Confira se a conta de serviço do AlloyDB tem as permissões de administrador do Cloud Storage necessárias para acessar o diretório especificado do Cloud Storage.

Resposta

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. O embasamento é compatível.
`references[]`	`Reference` Referências.
`related_questions[]`	`string` Perguntas relacionadas sugeridas.
`steps[]`	`Step` Etapas de geração de respostas.
`query_understanding_info`	`QueryUnderstandingInfo` Informações sobre a compreensão de consultas.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Outros motivos para pular respostas. Isso informa o motivo dos casos ignorados. Se nada for ignorado, esse campo não será definido.
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora da criação da resposta.
`complete_time`	`Timestamp` Apenas saída. Carimbo de data/hora da conclusão da resposta.
`safety_ratings[]`	`SafetyRating` Opcional. Classificações de segurança.
`grounding_score`	`double` Uma pontuação no intervalo [0, 1] que descreve o quanto a resposta é embasada pelos trechos de referência.

AnswerSkippedReason

Uma enumeração para motivos de respostas ignoradas.

Tipos enumerados
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Valor padrão. O motivo para pular a resposta não foi especificado.
`ADVERSARIAL_QUERY_IGNORED`	A consulta adversária ignorou o caso.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	A consulta que não busca respostas ignorou o caso O Google pula a resposta se a consulta for uma conversa informal.
`OUT_OF_DOMAIN_QUERY_IGNORED`	A consulta fora do domínio ignorou o caso. O Google pula a resposta se não houver resultados de pesquisa de alta relevância.
`POTENTIAL_POLICY_VIOLATION`	O possível caso de violação da política. O Google pula a resposta se detectar uma possível violação da política. Isso inclui conteúdo violento ou tóxico.
`NO_RELEVANT_CONTENT`	O caso de conteúdo irrelevante. O Google pula a resposta se não houver conteúdo relevante nos resultados da pesquisa recuperados.
`JAIL_BREAKING_QUERY_IGNORED`	A consulta de jailbreak não diferenciava maiúsculas de minúsculas. Por exemplo, "Responda no tom de um CEO de uma empresa concorrente". O Google pula a resposta se a consulta for classificada como uma consulta de jailbreak.
`CUSTOMER_POLICY_VIOLATION`	O caso de violação da política do cliente. O Google pula o resumo se uma violação da política do cliente for detectada. A política é definida pelo cliente.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	A consulta que não busca respostas ignorou o caso. O Google pula a resposta se a consulta não tiver um objetivo claro.
`LOW_GROUNDED_ANSWER`	O caso de resposta com pouca fundamentação. O Google pula a resposta se não for possível gerar uma resposta com embasamento.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	A classificação de consulta definida pelo usuário ignorou o caso. O Google pula a resposta se a consulta for classificada como uma classificação de consulta definida pelo usuário.
`UNHELPFUL_ANSWER`	O caso de resposta inútil. O Google pula a resposta se ela não for útil. Isso pode acontecer por vários motivos, incluindo, sem limitação: a consulta não pode ser respondida, 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 houver caracteres de vários bytes,como caracteres não ASCII, a medição do índice será maior do que o comprimento da string.

end_index

int64

Fim do segmento atribuído, exclusivo. Medido em bytes (Unicode UTF-8). Se houver caracteres de vários bytes,como caracteres não ASCII, a medição do índice será maior do que o comprimento da string.

sources[]

CitationSource

Fontes de citação do segmento atribuído.

CitationSource

Fonte da citação.

Campos

reference_id

string

ID da fonte de citação.

GroundingSupport

Fundamentação de uma declaração em answer_text.

Campos
`start_index`	`int64` Obrigatório. O índice indica o início da declaração, medido em bytes (Unicode UTF-8).
`end_index`	`int64` Obrigatório. Fim da reivindicação, exclusivo.
`sources[]`	`CitationSource` Opcional. Fontes de citação para a declaração.
`grounding_score`	`double` Uma pontuação no intervalo [0, 1] que descreve o quanto uma declaração específica é fundamentada pelas referências. Um valor mais alto significa que a declaração é mais bem fundamentada pelos trechos de referência.
`grounding_check_required`	`bool` Indica que essa declaração exigiu uma verificação de embasamento. Quando o sistema decide que essa declaração não exige uma verificação de atribuição/fundamentação, esse campo é definido como "false". Nesse caso, nenhuma verificação de embasamento foi feita para a declaração e, portanto, `grounding_score`, `sources` não é retornado.

QueryUnderstandingInfo

Informações sobre a compreensão de consultas.

Campos

query_classification_info[]

Informações de classificação da consulta.

QueryClassificationInfo

Informações de classificação da consulta.

Campos

type

Type

Tipo de classificação de consulta.

positive

bool

Saída da classificação.

Tipo

Tipos de classificação de consulta.

Tipos enumerados
`TYPE_UNSPECIFIED`	Tipo de classificação de consulta não especificado.
`ADVERSARIAL_QUERY`	Tipo de classificação de consulta adversária.
`NON_ANSWER_SEEKING_QUERY`	Tipo de classificação de consulta que não busca respostas, para conversa informal.
`JAIL_BREAKING_QUERY`	Tipo de classificação de consulta de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de classificação de consulta que não busca respostas, sem objetivo claro.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de classificação de consulta definida pelo usuário.

Referência

Referência.

Campos
Campo de união `content`. Conteúdo dos resultados da pesquisa. `content` pode ser apenas de um dos tipos a seguir:
`unstructured_document_info`	`UnstructuredDocumentInfo` Informações de documentos não estruturados.
`chunk_info`	`ChunkInfo` Informações do trecho.
`structured_document_info`	`StructuredDocumentInfo` Informações estruturadas do documento.

ChunkInfo

Informações do trecho.

Campos
`chunk`	`string` Nome do recurso de bloco.
`content`	`string` Conteúdo textual do bloco.
`document_metadata`	`DocumentMetadata` Metadados do documento.
`relevance_score`	`float` A relevância do trecho para uma determinada consulta. Os valores variam de 0,0 (completamente irrelevante) a 1,0 (completamente relevante). Esse valor é apenas para fins informativos. Ele pode mudar para a mesma consulta e trecho a qualquer momento devido a um novo treinamento do modelo ou 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. Ele é preenchido com os dados da struct do trecho no resultado da pesquisa.

StructuredDocumentInfo

Informações de pesquisa estruturadas.

Campos
`document`	`string` Nome do recurso do documento.
`struct_data`	`Struct` Dados estruturados de pesquisa.
`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 estruturados.

Campos
`document`	`string` Nome do recurso do documento.
`uri`	`string` URI do documento.
`title`	`string` Título.
`chunk_contents[]`	`ChunkContent` Lista de conteúdo de trechos citados derivados do conteúdo do documento.
`struct_data`	`Struct` Os metadados JSON estruturados do documento. Ele é preenchido com os dados da struct do trecho no resultado da pesquisa.

ChunkContent

Conteúdo em partes.

Campos

content

string

Conteúdo textual do bloco.

page_identifier

string

Identificador da página.

relevance_score

float

A relevância do trecho para uma determinada consulta. Os valores variam de 0,0 (completamente irrelevante) a 1,0 (completamente relevante). Esse valor é apenas para fins informativos. Ele pode mudar para a mesma consulta e trecho a qualquer momento devido a um novo treinamento do modelo ou alteração na implementação.

Estado

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

Tipos enumerados
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	A geração de respostas está em andamento.
`FAILED`	A geração de respostas falhou no momento.
`SUCCEEDED`	A geração de respostas foi concluída.
`STREAMING`	A geração de respostas está em andamento.

Etapa

Informações da etapa.

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

Ação

Ação.

Campos

observation

Observation

Observação.

Campo de união action. A ação. action pode ser apenas de um dos tipos a seguir:

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 snippets ou de blocos, dependendo do tipo de citação definido pelo usuário.

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 snippets no nível do documento.
`chunk_info[]`	`ChunkInfo` Se "citation_type" for "CHUNK_LEVEL_CITATION" e o modo de trecho estiver ativado, preencha as informações do trecho.
`struct_data`	`Struct` Representação de dados. Os dados JSON estruturados do documento. Ele é preenchido com os dados da estrutura do documento ou do trecho no resultado da pesquisa.

ChunkInfo

Informações do trecho.

Campos

chunk

string

Nome do recurso de bloco.

content

string

Conteúdo textual do bloco.

relevance_score

float

SnippetInfo

Informações do snippet.

Campos

snippet

string

Conteúdo do snippet.

snippet_status

string

Status do snippet definido pela equipe de pesquisa.

SearchAction

Ação de pesquisa.

Campos

query

string

A consulta a ser pesquisada.

Estado

Enumeração do estado da etapa.

Tipos enumerados
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	A etapa está em andamento.
`FAILED`	A etapa falhou.
`SUCCEEDED`	A etapa foi concluída.

AnswerGenerationSpec

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

Campos

user_defined_classifier_spec

UserDefinedClassifierSpec

Opcional. A especificação para a especificação do classificador especificado pelo usuário.

UserDefinedClassifierSpec

A especificação do classificador definido pelo usuário.

Campos
`enable_user_defined_classifier`	`bool` Opcional. Indica se o classificador definido pelo usuário será ativado e incluído.
`preamble`	`string` Opcional. O preâmbulo a ser usado para o classificador definido pelo usuário.
`model_id`	`string` Opcional. O ID do modelo a ser usado para o classificador definido pelo usuário.
`task_marker`	`string` Opcional. O marcador de tarefa a ser usado para o classificador definido pelo usuário.
`top_p`	`double` Opcional. O valor de top-p a ser usado para o classificador definido pelo usuário.
`top_k`	`int64` Opcional. O valor k principal a ser usado para o classificador definido pelo usuário.
`temperature`	`double` Opcional. O valor de temperatura a ser usado para o classificador definido pelo usuário.
`seed`	`int32` Opcional. O valor de semente a ser usado para o classificador definido pelo usuário.

AnswerQueryRequest

Solicite uma mensagem para o método ConversationalSearchService.AnswerQuery.

Campos
`serving_config`	`string` Obrigatório. O nome do recurso da configuração de exibição da 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`. Esse campo é usado para identificar o nome da configuração de veiculação, o conjunto de modelos usados para fazer a pesquisa.
`query`	`Query` Obrigatório. Consulta do usuário 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. Oferecemos suporte ao modo de sessão automática: os usuários podem usar o símbolo curinga `-` como ID de sessão. Um novo ID será gerado e atribuído automaticamente.
`safety_spec`	`SafetySpec` Especificação do modelo.
`related_questions_spec`	`RelatedQuestionsSpec` Especificação de perguntas relacionadas.
`grounding_spec`	`GroundingSpec` Opcional. Especificação de embasamento.
`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: o uso deste campo foi descontinuado. A API Streaming Answer será compatível. Controle do modo assíncrono. Se ativada, a resposta será retornada com o nome do recurso de resposta/sessão sem a resposta final. Os usuários da API precisam fazer a pesquisa para receber o status mais recente da resposta/sessão chamando o método `ConversationalSearchService.GetAnswer` ou `ConversationalSearchService.GetSession`.
`user_pseudo_id`	`string` Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que deve ser capaz de identificar um visitante de maneira exclusiva em um único dispositivo. Esse identificador exclusivo não deve mudar se o visitante fizer login ou logout no site. Esse campo NÃO pode ter um valor fixo, como `unknown_visitor`. O campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte o documento do Google Cloud para mais detalhes.
`end_user_spec`	`EndUserSpec` Opcional. Especificação do usuário 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 os metadados de citação serão incluídos na resposta. O valor padrão é `false`.
`answer_language_code`	`string` Código do idioma da resposta. Use tags de idioma definidas pelo BCP47 (em inglês). Observação: este é um recurso experimental.
`ignore_adversarial_query`	`bool` Especifica se as consultas adversárias devem ser filtradas. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas adversárias. Nenhuma resposta é retornada se a consulta de pesquisa for classificada como adversária. Por exemplo, um usuário pode fazer uma pergunta sobre comentários negativos sobre a empresa ou enviar uma consulta projetada para gerar uma saída não segura que viola a política. Se esse campo for definido como `true`, vamos pular a geração de respostas para consultas adversárias e retornar mensagens alternativas.
`ignore_non_answer_seeking_query`	`bool` Especifica se as consultas que não buscam respostas devem ser filtradas. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas que buscam respostas. Nenhuma resposta é retornada se a consulta de pesquisa for classificada como uma consulta que não busca respostas. Se este campo estiver definido como `true`, vamos pular a geração de respostas para consultas que não buscam respostas e retornar mensagens alternativas.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas de jailbreak. Nenhum resumo é retornado se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um usuário pode adicionar instruções à consulta para mudar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir que o modelo aja como uma entidade diferente, por exemplo, "Responda no tom de um CEO de uma empresa concorrente". Se esse campo for definido como `true`, vamos pular a geração de resumos para consultas de jailbreak e retornar mensagens alternativas.
`ignore_low_relevant_content`	`bool` Especifica se as consultas de baixa relevância devem ser filtradas. Se esse campo for definido como `false`, todos os resultados da pesquisa serão usados, independente da relevância, para gerar respostas. Se definido como `true` ou não definido, o comportamento será 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 for definido, ele usará o modelo estável padrão. Os valores permitidos são: "stable" e "preview".

PromptSpec

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

Campos

preamble

string

Preâmbulo personalizado.

EndUserSpec

Especificação do usuário final.

Campos

end_user_metadata[]

EndUserMetaData

Opcional. Metadados do usuário final.

EndUserMetaData

Metadados do usuário final.

Campos

Campo de união content. Conteúdo dos resultados da pesquisa. content pode ser apenas de um dos tipos a seguir:

chunk_info

ChunkInfo

Informações do trecho.

ChunkInfo

Informações do trecho.

Campos

content

string

Conteúdo textual do bloco. Ele é limitado a 8.000 caracteres.

document_metadata

QueryClassificationSpec

Metadados do documento do bloco atual.

DocumentMetadata

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

Campos

title

string

Título do documento.

GroundingSpec

Especificação de embasamento.

Campos

include_grounding_supports

bool

Opcional. Especifica se é necessário incluir grounding_supports na resposta. O valor padrão é false.

Quando esse campo é definido como true, a resposta retornada tem grounding_score e contém GroundingSupports para cada declaração.

filtering_level

FilteringLevel

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

FilteringLevel

Nível para filtrar com base na fundamentação da resposta.

Tipos enumerados
`FILTERING_LEVEL_UNSPECIFIED`	O padrão é nenhum filtro
`FILTERING_LEVEL_LOW`	Filtrar respostas com base em um limite baixo.
`FILTERING_LEVEL_HIGH`	Filtrar respostas com base em um limite alto.

QueryUnderstandingSpec

Especificação de compreensão de consultas.

Campos

query_classification_spec

Especificação de classificação de consulta.

query_rephraser_spec

QueryRephraserSpec

Especificação do reformulador de consultas.

disable_spell_correction

bool

Opcional. Se a correção ortográfica será desativada. O valor padrão é false.

QueryClassificationSpec

Especificação de classificação de consulta.

Campos

types[]

Type

Tipos de classificação de consulta ativados.

Tipo

Tipos de classificação de consulta.

Tipos enumerados
`TYPE_UNSPECIFIED`	Tipo de classificação de consulta não especificado.
`ADVERSARIAL_QUERY`	Tipo de classificação de consulta adversária.
`NON_ANSWER_SEEKING_QUERY`	Tipo de classificação de consulta que não busca respostas, para conversa informal.
`JAIL_BREAKING_QUERY`	Tipo de classificação de consulta de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de classificação de consulta que não busca respostas, sem objetivo claro.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de classificação de consulta definida pelo usuário.

QueryRephraserSpec

Especificação do reformulador de consultas.

Campos

disable

bool

Desativa o reformulador de consultas.

max_rephrase_steps

int32

Número máximo de etapas de reformulação. O número máximo é de cinco etapas. Se não for definido ou for definido como < 1, o padrão será 1.

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 consulta ativado. Se não for definido, o padrão será "LARGE".

ModelType

Tipos de reformulação de consultas. No momento, só há suporte para seleções de modelo de salto único (max_rephrase_steps = 1). Para várias etapas (max_rephrase_steps > 1), há apenas um modelo padrão.

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

RelatedQuestionsSpec

Especificação de perguntas relacionadas.

Campos

enable

bool

Ativa o recurso de perguntas relacionadas se for verdadeiro.

SafetySpec

Especificação de segurança. Há dois casos de uso: 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. O valor padrão é "false".

safety_settings[]

SafetySetting

Opcional. Configurações de segurança. Essas configurações só são válidas quando "safety_spec.enable" é verdadeiro.

SafetySetting

Configurações de segurança.

Campos

category

HarmCategory

Obrigatório. Categoria de dano.

threshold

HarmBlockThreshold

Obrigatório. O limite do bloqueio de danos.

HarmBlockThreshold

Níveis de limites baseados em probabilidade para bloqueio.

Tipos enumerados
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Limite de bloqueio de danos não especificado.
`BLOCK_LOW_AND_ABOVE`	Bloquear o limite inferior e superior (ou seja, bloquear mais).
`BLOCK_MEDIUM_AND_ABOVE`	Bloquear o limite médio e acima.
`BLOCK_ONLY_HIGH`	Bloquear apenas o limite superior (ou seja, bloquear menos).
`BLOCK_NONE`	Bloquear nenhum
`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. Ou forneça uma lista de resultados da pesquisa para gerar uma resposta. input pode ser apenas de um dos tipos a seguir:

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 da pesquisa a serem retornados. O valor padrão é 10.
`filter`	`string` A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas. Isso será usado para filtrar os resultados da pesquisa, o que pode afetar a resposta. Se esse campo não for reconhecido, um `INVALID_ARGUMENT` será retornado. A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")' Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.
`boost_spec`	`BoostSpec` Aumentar a especificação para impulsionar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta da consulta. Para mais informações sobre o aumento, consulte Aumento.
`order_by`	`string` A ordem em que os documentos são retornados. Os documentos podem ser ordenados por um campo em um objeto `Document`. Deixe em branco se a ordenação for por relevância. A expressão `order_by` diferencia maiúsculas de minúsculas. Para mais informações sobre a ordem, consulte Ordem. Se esse campo não for reconhecido, um `INVALID_ARGUMENT` será retornado.
`search_result_mode`	`SearchResultMode` Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa será `DOCUMENTS` por padrão. Consulte analisar e dividir documentos
`data_store_specs[]`	`DataStoreSpec` Especificações que definem dataStores para filtrar em uma chamada de pesquisa e configurações para esses dataStores. Isso só é considerado para mecanismos com caso de uso de vários dataStores. Para um único DataStore em um mecanismo, use as especificações no 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 pode ser apenas de um dos tipos a seguir:

unstructured_document_info

UnstructuredDocumentInfo

Informações de documentos não estruturados.

chunk_info

ChunkInfo

Informações do trecho.

ChunkInfo

Informações do trecho.

Campos

chunk

string

Nome do recurso de bloco.

content

string

Conteúdo textual do bloco.

document_metadata

Metadados do documento do bloco atual.

DocumentMetadata

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

Campos

uri

string

URI do documento.

title

string

Título do documento.

UnstructuredDocumentInfo

Informações de documentos não estruturados.

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 será usado para geração de respostas. Este é 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. Descontinuado: esse campo está descontinuado e não terá 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 ser usado para geração de respostas.

ExtractiveAnswer

Resposta extrativa. Guia

Campos

page_identifier

string

Identificador da página.

content

string

Conteúdo da resposta extrativa.

ExtractiveSegment

Trecho extraído. Guia: a geração de respostas só vai usar esse campo se "document_contexts" estiver vazio. Esses trechos devem ser mais curtos.

Campos

page_identifier

string

Identificador da página.

content

string

Conteúdo do segmento extrativo.

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 maior que 1, use Answer.name para buscar informações de resposta usando a API ConversationalSearchService.GetAnswer.

session

PolicyEnforcementResult

Objeto de recurso de sessão. Ele só vai estar disponível quando o campo de sessão estiver definido e for válido na solicitação AnswerQueryRequest.

answer_query_token

string

Um ID global exclusivo usado para geração de registros.

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 precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
`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ítica, como frases proibidas ou verificações do Model Armor. Esse campo só é preenchido se a chamada de assistência foi ignorada devido a uma violação da política.

AssistSkippedReason

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

Tipos enumerados
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Valor padrão. O motivo para pular não foi especificado.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	O Google Assistente ignorou a consulta porque ela não parecia estar buscando uma resposta.
`CUSTOMER_POLICY_VIOLATION`	O assistente ignorou a consulta ou se recusou a responder devido a uma violação da política do cliente (por exemplo, a consulta ou a resposta continha uma frase proibida).

CustomerPolicyEnforcementResult

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

Campos

verdict

Verdict

Veredicto final da aplicação da política do cliente. Se apenas uma política bloquear o processamento, o veredito será BLOCK.

policy_results[]

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

BannedPhraseEnforcementResult

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

Campos

banned_phrases[]

string

As frases proibidas encontradas na consulta ou na resposta.

ModelArmorEnforcementResult

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

Campos

Campo de união result. O resultado da política do Model Armor. result pode ser apenas de um dos tipos a seguir:

model_armor_violation

string

A violação do Model Armor encontrada.

error

BannedPhraseEnforcementResult

O erro retornado pelo Model Armor se a aplicação da política 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 restrição da política. enforcement_result pode ser apenas de um dos tipos a seguir:

banned_phrase_enforcement_result

O resultado da aplicação da política de frases proibidas.

model_armor_enforcement_result

ModelArmorEnforcementResult

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

Veredito

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

Tipos enumerados
`UNSPECIFIED`	Valor desconhecido.
`ALLOW`	Não houve violação da política.
`BLOCK`	O processamento foi bloqueado pela política do cliente.

Responder

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

Campos

Campo de união reply. Alternativas para a resposta do assistente. reply pode ser apenas de um dos tipos a seguir:

grounded_content

AssistantGroundedContent

Possível texto ou mídia fundamentada da resposta do assistente.

Estado

Estado da geração de respostas.

Tipos enumerados
`STATE_UNSPECIFIED`	Desconhecido.
`IN_PROGRESS`	Uma operação de assistência está em andamento.
`FAILED`	A operação de assistência falhou.
`SUCCEEDED`	A operação de assistência foi concluída.
`SKIPPED`	A operação de assistência foi ignorada.

AssistRequest

Solicitação para o método AssistantService.Assist.

Campos
`name`	`string` Obrigatório. O nome do recurso do `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta do usuário atual. Uma consulta vazia só é aceita se `file_ids` forem fornecidos. Nesse caso, a resposta será gerada com base nesses arquivos de contexto.
`session`	`string` Opcional. A sessão a ser usada na solicitação. Se especificado, o assistente terá acesso ao histórico da sessão, e a consulta e a resposta serão armazenadas lá. Se `-` for especificado como o ID da sessão ou ficar em branco, uma nova sessão será criada 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 vai responder à consulta. Se a resposta for ignorada, os motivos serão listados em `AssistAnswer.assist_skipped_reasons` dentro de `AssistResponse.answer`.
`file_ids[]`	`string` Opcional. Os IDs dos arquivos a serem usados para responder à solicitação. Ao fazer upload de um arquivo, o ID dele é retornado em `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Opcional. Informações sobre o usuário que iniciou a consulta.

AssistSkippingMode

Comportamentos de pular disponíveis para solicitações de assistência.

Tipos enumerados
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Valor padrão. A resposta pode ser ignorada se a consulta não estiver buscando ajuda.
`REQUEST_ASSIST`	Pedir resposta do Google Assistente. A resposta ainda pode ser ignorada se a consulta não passar nas verificações de política.

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 global exclusivo que identifica o par solicitação-resposta atual. Usado para feedback e suporte.

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 de API de assistência. Uma sessão pode ter vários turnos, cada um com um ID de consulta exclusivo.

Ao especificar o nome da sessão e o ID da consulta na chamada da API Assist, a solicitação de assistência acontece no contexto dos resultados da pesquisa dessa chamada.

AssistUserMetadata

Metadados do usuário da solicitação.

Campos

time_zone

string

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

preferred_language_code

string

Opcional. Idioma preferido a ser usado para responder se a detecção de idioma falhar. Também usado como o idioma das mensagens de erro criadas por ações, independente dos resultados da detecçã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}` Precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
`display_name`	`string` Obrigatório. O nome de exibição do assistente. Precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres.
`description`	`string` Opcional. Descrição para mais informações. É esperado que seja mostrado na UI de configuração, não para os usuários 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. Obsoleto. Use `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Opcional. O tipo de embasamento da Web a ser usado.
`enabled_actions (deprecated)`	`map<string, ActionList>` Este item foi descontinuado. Opcional. Descontinuado: será substituído por `enabled_tools`. As ações ativadas neste assistente. As chaves são o nome do conector, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Os valores consistem em ações ativadas pelo administrador na instância do conector. O administrador pode ativar seletivamente várias ações em qualquer uma das instâncias de conector criadas no projeto. Por exemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Opcional. Observação: ainda não foi implementado. Use `enabled_actions`. As ferramentas ativadas neste assistente. As chaves são o nome do conector, por exemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Os valores consistem em ferramentas ativadas pelo administrador para a instância do conector. O administrador pode ativar seletivamente várias ferramentas em qualquer uma das instâncias de conector criadas no projeto. Por exemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Opcional. Política de clientes para o assistente.

ActionInfo

Descontinuado: 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 de exibição da ação.

ActionList

Descontinuado: será substituído por ToolList. As ações ativadas em um conector

Campos

action_info[]

ActionInfo

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

CustomerPolicy

Política definida pelo cliente para o assistente.

Campos

banned_phrases[]

BannedPhrase

Opcional. Lista de frases proibidas.

model_armor_config

ModelArmorConfig

Opcional. Configuração do Model Armor a ser usada para higienizar comandos do usuário e respostas do assistente.

BannedPhrase

Definição de uma frase proibida definida pelo cliente. Uma frase proibida não pode aparecer na consulta do usuário nem na resposta do LLM. Caso contrário, a resposta será recusada.

Campos

phrase

string

Obrigatório. O conteúdo da string bruta a ser proibido.

match_type

BannedPhraseMatchType

Opcional. Tipo de correspondência da frase proibida.

ignore_diacritics

bool

Opcional. Se for "true", os sinais diacríticos (por exemplo, acentos, trema) serão ignorados ao corresponder a frases proibidas. Por exemplo, "cafe" corresponde a "café".

BannedPhraseMatchType

O método de correspondência para a frase proibida.

Tipos enumerados
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	O padrão é SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	A frase proibida corresponde se for encontrada em qualquer lugar do texto como uma substring exata.
`WORD_BOUNDARY_STRING_MATCH`	A frase proibida só corresponde se o padrão encontrado no texto estiver cercado por delimitadores de palavras. A frase em si ainda pode conter delimitadores de palavras.

ModelArmorConfig

Configuração para modelos do Model Armor definidos pelo cliente a serem usados para higienizar comandos do usuário e respostas do assistente.

Campos

user_prompt_template

string

Opcional. O nome do recurso do modelo do Model Armor para higienizar comandos do usuário. Formato: projects/{project}/locations/{location}/templates/{template_id}

Se não for especificado, nenhuma limpeza será aplicada ao comando do usuário.

response_template

string

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

Se não for especificado, nenhuma limpeza será aplicada à resposta do assistente.

failure_mode

FailureMode

Opcional. Define o modo de falha para a limpeza do Model Armor.

FailureMode

Determina o comportamento quando o Model Armor não consegue processar uma solicitação.

Tipos enumerados
`FAILURE_MODE_UNSPECIFIED`	Modo de falha não especificado. O comportamento padrão é `FAIL_CLOSED`.
`FAIL_OPEN`	Em caso de falha no processamento do Model Armor, a solicitação pode prosseguir sem alterações.
`FAIL_CLOSED`	Em caso de falha no processamento do Model Armor, a solicitação é rejeitada.

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 de comandos para chamadas de LLM. Consulte também https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

O idioma padrão usado para gerar a resposta do assistente. Use um código de idioma ISO 639-1, como en. Se não for especificado, o idioma será detectado automaticamente.

SystemInstruction

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

Campos

additional_system_instruction

string

Opcional. Instrução adicional do sistema que será adicionada à instrução padrão.

ToolInfo

Informações para identificar uma ferramenta.

Campos

tool_name

string

O nome da ferramenta, conforme definido por "DataConnectorService.QueryAvailableActions". Observação: ele usa action nas APIs DataConnectorService, mas elas são as mesmas que tool aqui.

tool_display_name

string

O nome de exibição da ferramenta.

ToolList

As ferramentas ativadas em um conector

Campos

tool_info[]

ToolInfo

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

WebGroundingType

O tipo de embasamento da Web a ser usado.

Tipos enumerados
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Configuração padrão não especificada. É o mesmo que desativado.
`WEB_GROUNDING_TYPE_DISABLED`	O embasamento da Web está desativado.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	O embasamento com a Pesquisa Google está ativado.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	O embasamento com a Pesquisa na Web corporativa está ativado.

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` pode ser apenas de um dos tipos a seguir:
`text`	`string` Texto inline.
`inline_data`	`Blob` Dados binários inline.
`file`	`File` Um arquivo, por exemplo, um resumo de áudio.
`executable_code`	`ExecutableCode` Código gerado pelo modelo que deve 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 mídia (tipo MIME) dos dados gerados.

data

bytes

Obrigatório. Bytes brutos.

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.

Resultado

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

Tipos enumerados
`OUTCOME_UNSPECIFIED`	Status não especificado. Esse valor não deve ser usado.
`OUTCOME_OK`	A execução do código foi concluída.
`OUTCOME_FAILED`	A execução do código foi concluída, mas com uma falha. `stderr` precisa conter o motivo.
`OUTCOME_DEADLINE_EXCEEDED`	A execução do código durou muito tempo e foi cancelada. Pode haver ou não uma saída parcial.

ExecutableCode

Código gerado pelo modelo para ser executado por ele.

Campos

code

string

Obrigatório. O conteúdo do código. No momento, só há suporte para Python.

Arquivo

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

Campos

mime_type

string

Obrigatório. O tipo de mídia (tipo MIME) do arquivo.

file_id

string

Obrigatório. O ID do arquivo.

AssistantGroundedContent

Um conteúdo e possivelmente as informações de embasamento dele.

Nem todo conteúdo precisa de embasamento. Frases como "Claro, vou pesquisar para você" não precisam de embasamento.

Campos
`content`	`AssistantContent` O conteúdo.
`citation_metadata`	`CitationMetadata` Atribuição da fonte 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. No momento, usado apenas para respostas de assistentes de pesquisa.
Campo de união `metadata`. Metadados de embasamento para vários modais. No momento, ele só aceita texto. `metadata` pode ser apenas de um dos tipos a seguir:
`text_grounding_metadata`	`TextGroundingMetadata` Metadados para embasamento com base em fontes de texto.

ContentMetadata

Metadados do conteúdo.

Campos

content_kind

ContentKind

Tipo do conteúdo. Mostra a qual parte da resposta do assistente de pesquisa esse conteúdo pertence.

content_id

string

ID do conteúdo. Ele é usado para conectar perguntas de pesquisa com as respostas. Por exemplo, as partes da resposta a uma pergunta de pesquisa terão o mesmo content_id da pergunta.

ContentKind

Possíveis tipos de conteúdo. No momento, usado apenas para diferenciar seções na resposta completa de um assistente de pesquisa.

Tipos enumerados
`CONTENT_KIND_UNSPECIFIED`	Desconhecido.
`RESEARCH_PLAN`	Plano de pesquisa.
`RESEARCH_QUESTION`	Pergunta da pesquisa.
`RESEARCH_ANSWER`	Resposta da pesquisa.
`RESEARCH_REPORT`	Research report.
`RESEARCH_AUDIO_SUMMARY`	Resumo da pesquisa em áudio.

TextGroundingMetadata

Detalhes de embasamento para fontes de texto.

Campos

segments[]

Segment

Informações de embasamento para partes do texto.

references[]

Reference

Referências para o texto embasado.

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. Ele pode conter um URL que redireciona para o site real.
`title`	`string` Título.
`page_identifier`	`string` Identificador da página.
`domain`	`string` Nome de domínio do URI do documento. O campo `uri` pode conter um URL que redireciona para o site real. Nesse caso, ele vai conter o nome de 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 embasamento para um segmento do texto.

Campos
`start_index`	`int64` Índice de base zero que indica o início do segmento, medido em bytes de uma string UTF-8. Ou seja, caracteres codificados em vários bytes têm um comprimento maior que 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 conector BAP.

Campos

supported_connector_modes[]

ConnectorMode

Obrigatório. Os modos de conector compatíveis com a conexão BAP associada.

enabled_actions[]

string

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

ConnectorMode

Casos de uso compatíveis com esse conector BAP.

Tipos enumerados
`CONNECTOR_MODE_UNSPECIFIED`	Modo de conector não especificado.
`DATA_INGESTION`	Conector usado para ingestão de dados.
`ACTIONS`	Conector usado para ações
`END_USER_AUTHENTICATION`	Conector usado para autenticação de usuário final.

BatchCreateTargetSiteMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.BatchCreateTargetSites. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

CreateTargetSiteRequest

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

BatchCreateTargetSitesRequest

Solicite uma mensagem para o método SiteSearchEngineService.BatchCreateTargetSites.

Campos

parent

string

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

requests[]

Obrigatório. A mensagem de solicitação que especifica os recursos a serem criados. É possível criar no máximo 20 TargetSites em um lote.

BatchCreateTargetSitesResponse

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

Campos

target_sites[]

TargetSites criados.

BatchGetDocumentsMetadataRequest

Solicite uma mensagem 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

Corresponde aos Documents por nomes de recursos FHIR.

Campos

fhir_resources[]

string

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

Matcher

Matcher para os Documents. No momento, a correspondência é feita por URIs exatos.

Campos

Campo de união matcher. Matcher para os Documents. matcher pode ser apenas de um dos tipos a seguir:

uris_matcher

UrisMatcher

Matcher por URIs exatos.

fhir_matcher

FhirMatcher

Matcher por nomes de recursos FHIR.

UrisMatcher

Correspondedor para os Documents por URIs exatos.

Campos

uris[]

string

Os URIs exatos a serem correspondidos.

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 comparador usado para corresponder ao `Document`.
`state`	`State` O estado do documento.
`last_refreshed_time`	`Timestamp` O carimbo de data/hora da última indexação do `Document`.
`data_ingestion_source`	`string` A origem da ingestão de dados do `Document`. Os valores permitidos são: `batch`: dados ingeridos pela API em lote, por exemplo, ImportDocuments. `streaming` Dados ingeridos pela API Streaming, por exemplo: Streaming FHIR.

MatcherValue

O valor do comparador usado para corresponder ao Document.

Campos

Campo de união matcher_value. O valor do comparador usado para corresponder ao Document. matcher_value pode ser apenas de um dos tipos a seguir:

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.

Tipos enumerados
`STATE_UNSPECIFIED`	Nunca deve ser definido.
`INDEXED`	O `Document` está indexado.
`NOT_IN_TARGET_SITE`	O `Document` não é indexado porque o URI dele não está no `TargetSite`.
`NOT_IN_INDEX`	O `Document` não está indexado.

BatchUpdateUserLicensesMetadata

Metadados relacionados ao progresso da operação UserLicenseService.BatchUpdateUserLicenses. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Número de licenças de usuário atualizadas com sucesso.
`failure_count`	`int64` Contagem de licenças de usuário que não foram atualizadas.

BatchUpdateUserLicensesRequest

Solicite uma mensagem 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 "true", a licença do usuário será excluída se as licenças do usuário removerem a configuração de licença associada. Por padrão, que é "false", a licença do usuário será atualizada para o estado "não atribuída".
Campo de união `source`. Obrigatório. A origem da entrada. `source` pode ser apenas de um dos tipos a seguir:
`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 usuário a serem atualizadas. Cada licença de usuário precisa ter um UserLicense.user_principal válido.

update_mask

Opcional. Lista de campos a serem atualizados.

BatchUpdateUserLicensesResponse

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

Campos

user_licenses[]

UserLicense

UserLicenses atualizadas.

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

BatchVerifyTargetSitesMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.BatchVerifyTargetSites. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

BatchVerifyTargetSitesRequest

Solicite uma mensagem para o método SiteSearchEngineService.BatchVerifyTargetSites.

Campos

parent

string

Obrigatório. O recurso principal compartilhado por todos os TargetSites que estão sendo verificados. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Esse tipo não tem campos.

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

BigQuerySource

Origem do BigQuery de onde os dados serão importados.

Campos
`project_id`	`string` O ID ou o número do projeto que contém a origem do BigQuery. Tem um limite de 128 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`dataset_id`	`string` Obrigatório. O conjunto de dados do BigQuery de onde os dados serão copiados,com um limite de 1.024 caracteres.
`table_id`	`string` Obrigatório. A tabela do BigQuery de onde os dados serão copiados,com um limite de 1.024 caracteres.
`gcs_staging_dir`	`string` Diretório intermediário do Cloud Storage usado para importação com um limite de 2.000 caracteres. Pode ser especificado se você quiser que o BigQuery exporte para um diretório específico do Cloud Storage.
`data_schema`	`string` O esquema a ser usado ao analisar os dados da origem. Valores aceitos para importações de eventos do usuário: `user_event` (padrão): um `UserEvent` por linha. Valores aceitos para importações de documentos: `document` (padrão): um formato `Document` por linha. Cada documento precisa ter um `Document.id` válido e um de `Document.json_data` ou `Document.struct_data`. `custom`: um dado personalizado por linha em formato arbitrário que esteja de acordo com o `Schema` definido do repositório de dados. Só pode ser usado pela vertical GENERIC do repositório de dados.
Campo de união `partition`. Informações de particionamento da tabela do BigQuery. Deixe em branco se a tabela não for particionada. `partition` pode ser apenas de um dos tipos a seguir:
`partition_date`	`Date` _PARTITIONDATE da tabela particionada por tempo do BigQuery no formato AAAA-MM-DD.

BigtableOptions

O objeto de opções do Bigtable que contém informações para oferecer suporte à importação.

Campos

key_field_name

string

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

families

map<string, BigtableColumnFamily>

O mapeamento de nomes de família para um objeto que contém informações no nível do grupo de colunas para o grupo de colunas especificado. Se uma família não estiver presente nesse mapa, ela será ignorada.

BigtableColumn

A coluna do Bigtable.

Campos
`qualifier`	`bytes` Obrigatório. Qualificador da coluna. Se não for possível decodificar com utf-8, use uma string codificada em base-64.
`field_name`	`string` O nome do campo a ser usado para essa coluna no documento. O nome precisa corresponder ao padrão `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se não for definido, ele será analisado dos bytes do qualificador 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 usando a família de funções `HBase Bytes.toBytes`. Isso pode ser substituído para uma coluna específica listando-a em `columns` e especificando uma codificação para ela.
`type`	`Type` O tipo de valores nesta família de colunas. Os valores precisam ser codificados usando a função `HBase Bytes.toBytes` quando o valor de codificação é definido como `BINARY`.

BigtableColumnFamily

O grupo de colunas do Bigtable.

Campos
`field_name`	`string` O nome do campo a ser usado para essa família de colunas no documento. O nome precisa corresponder ao padrão `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Se não for definido, ele será analisado 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 usando a família de funções `HBase Bytes.toBytes`. Isso pode ser substituído para uma coluna específica listando-a em `columns` e especificando uma codificação para ela.
`type`	`Type` O tipo de valores nesta família de colunas. Os valores precisam ser codificados usando a função `HBase Bytes.toBytes` quando o valor de codificação é definido como `BINARY`.
`columns[]`	`BigtableColumn` A lista de objetos que contém informações no nível da coluna para cada uma delas. Se uma coluna não estiver nessa lista, ela será ignorada.

Codificação

O modo de codificação de uma coluna ou grupo de colunas do Bigtable.

Tipos enumerados
`ENCODING_UNSPECIFIED`	A codificação não foi especificada.
`TEXT`	Codificação de texto.
`BINARY`	Codificação binária.

Tipo

O tipo de valores em uma coluna ou grupo de colunas do Bigtable. Os valores precisam ser codificados usando a função HBase Bytes.toBytes quando o valor de codificação é definido como BINARY.

Tipos enumerados
`TYPE_UNSPECIFIED`	O tipo não está especificado.
`STRING`	Tipo de string.
`NUMBER`	Tipo numérico.
`INTEGER`	Tipo inteiro.
`VAR_INTEGER`	Tipo 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 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`instance_id`	`string` Obrigatório. O ID da instância do Cloud Bigtable que precisa ser importada.
`table_id`	`string` Obrigatório. O ID da tabela do Cloud Bigtable que precisa ser importada.
`bigtable_options`	`BigtableOptions` Obrigatório. Opções do Bigtable que contêm informações necessárias ao analisar dados em estruturas tipadas. Por exemplo, anotações de tipo de coluna.

CheckGroundingRequest

Solicite uma mensagem para o método GroundedGenerationService.CheckGrounding.

Campos
`grounding_config`	`string` Obrigatório. O nome do recurso da configuração de embasamento, como `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Resposta candidata a ser verificada. Ele pode ter um tamanho máximo de 4.096 tokens.
`facts[]`	`GroundingFact` Lista de fatos para a verificação de embasamento. Oferecemos suporte a até 200 fatos.
`grounding_spec`	`CheckGroundingSpec` Configuração da verificação de embasamento.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte o documento do Google Cloud para mais detalhes.

CheckGroundingResponse

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

Campos
`cited_chunks[]`	`FactChunk` Lista de fatos citados em todas as declarações na resposta candidata. Eles são derivados dos fatos fornecidos na solicitação.
`cited_facts[]`	`CheckGroundingFactChunk` Lista de fatos citados em todas as declarações na resposta candidata. Eles são derivados dos fatos fornecidos na solicitação.
`claims[]`	`Claim` Textos de reivindicação e informações de citação em todas as reivindicações na resposta candidata.
`support_score`	`float` A pontuação de suporte para a resposta candidata de entrada. Quanto maior a pontuação, maior a fração de declarações que são apoiadas pelos fatos fornecidos. Sempre é definido quando uma resposta é retornada.

CheckGroundingFactChunk

Parte do fato para verificação de embasamento.

Campos

chunk_text

string

Conteúdo de texto do trecho de fato. Pode ter no máximo 10 mil caracteres.

Reivindicação

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

Campos
`claim_text`	`string` Texto da declaração no candidato a resposta. Sempre fornecido, independente de citações ou anticitações serem encontradas.
`citation_indices[]`	`int32` Uma lista de índices (em "cited_chunks") que especificam as citações associadas à declaração. Por exemplo, [1,3,4] significa que cited_chunks[1], cited_chunks[3] e cited_chunks[4] são os fatos citados que apoiam a declaração. Uma citação de um fato indica que a declaração é fundamentada nele.
`start_pos`	`int32` Posição que indica o início da declaração no candidato a resposta, medida em bytes. Isso não é medido em caracteres e, portanto, precisa ser renderizado na interface do usuário considerando que alguns caracteres podem ocupar mais de um byte. Por exemplo, se o texto da declaração contiver caracteres não ASCII, as posições inicial e final vão variar quando medidas em caracteres (dependente da linguagem de programação) e em bytes (independente da linguagem de programação).
`end_pos`	`int32` Posição que indica o fim da declaração no candidato a resposta, exclusiva, em bytes. Isso não é medido em caracteres e, portanto, precisa ser renderizado como tal. Por exemplo, se o texto da declaração contiver caracteres não ASCII, as posições inicial e final vão variar quando medidas em caracteres (dependente da linguagem de programação) e em bytes (independente da linguagem de programação).
`grounding_check_required`	`bool` Indica que essa declaração exigiu uma verificação de embasamento. Quando o sistema decidir que essa declaração não exige uma verificação de atribuição/fundamentação, esse campo será definido como "false". Nesse caso, nenhuma verificação de embasamento foi feita para a declaração e, portanto, `citation_indices` não deve ser retornado.
`score`	`double` Pontuação de confiança para a declaração na resposta candidata, no intervalo [0, 1]. Isso só é definido quando `CheckGroundingRequest.grounding_spec.enable_claim_level_score` é verdadeiro.

CheckGroundingSpec

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

Campos

citation_threshold

double

O limite (em [0,1]) usado para determinar se um fato precisa ser citado para uma declaração na resposta candidata. Escolher um limite mais alto vai resultar em menos citações, mas muito fortes, enquanto escolher um limite mais baixo pode resultar em mais citações, mas um pouco mais fracas. Se não for definido, o padrão será 0,6.

enable_claim_level_score

bool

A flag de controle que ativa a pontuação de embasamento no nível da declaração na resposta.

Chunk

O bloco captura todas as informações de metadados brutos dos itens a serem recomendados ou pesquisados no modo de bloco.

Campos
`name`	`string` O nome completo do recurso do fragmento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
`id`	`string` ID exclusivo do bloco atual.
`content`	`string` O conteúdo é uma string de um documento (conteúdo analisado).
`document_metadata`	`DocumentMetadata` Metadados do documento do bloco atual.
`derived_struct_data`	`Struct` Apenas saída. Este campo é OUTPUT_ONLY. Ele contém dados derivados que não estão no documento de entrada original.
`page_span`	`PageSpan` Intervalo de páginas do trecho.
`chunk_metadata`	`ChunkMetadata` Apenas saída. Metadados do bloco atual.
`data_urls[]`	`string` Apenas saída. URLs de dados de imagem se o bloco atual contiver imagens. Os URLs de dados são compostos de 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 dados em si: data:[][;base64],
`annotation_contents[]`	`string` Apenas saída. Conteúdo da anotação se o bloco atual contiver anotações.
`annotation_metadata[]`	`AnnotationMetadata` Apenas saída. Os metadados da anotação incluem conteúdo estruturado no trecho atual.
`relevance_score`	`double` Apenas saída. Representa a pontuação de relevância com base na similaridade. Uma pontuação mais alta indica maior relevância do trecho. A pontuação está no intervalo [-1.0, 1.0]. Preenchido apenas em `SearchResponse`.

AnnotationMetadata

Os metadados da anotação incluem conteúdo estruturado no trecho 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 for baseado em uma imagem.

ChunkMetadata

Metadados do bloco atual. Esse campo é preenchido apenas na API SearchService.Search.

Campos

previous_chunks[]

Chunk

Os trechos anteriores do trecho atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Esse campo é preenchido apenas na API SearchService.Search.

next_chunks[]

Chunk

Os próximos trechos do trecho atual. O número é controlado por SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Esse campo é preenchido apenas na API SearchService.Search.

DocumentMetadata

Os metadados do documento contêm as informações do documento do bloco 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 do documento. Ele precisa estar de acordo com o `Schema` registrado ou um erro `INVALID_ARGUMENT` será gerado.

PageSpan

Intervalo de páginas do trecho.

Campos

page_start

int32

A página inicial do bloco.

page_end

int32

A página final do trecho.

StructureType

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

Tipos enumerados
`STRUCTURE_TYPE_UNSPECIFIED`	Valor padrão.
`SHAREHOLDER_STRUCTURE`	Estrutura de acionistas.
`SIGNATURE_STRUCTURE`	Estrutura da assinatura.
`CHECKBOX_STRUCTURE`	Estrutura da caixa de seleçã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 origem para conteúdo.

Campos
`start_index`	`int32` Apenas saída. Índice inicial do conteúdo.
`end_index`	`int32` Apenas saída. Índice final no conteúdo.
`uri`	`string` Apenas saída. Referência de 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 origem para um conteúdo.

Campos

citations[]

Citation

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

CloudSqlSource

Origem dos dados de importação do Cloud SQL.

Campos
`project_id`	`string` O ID do projeto que contém a origem do Cloud SQL. Tem um limite de 128 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`instance_id`	`string` Obrigatório. A instância do Cloud SQL de onde os dados serão copiados, com um limite de 256 caracteres.
`database_id`	`string` Obrigatório. O banco de dados do Cloud SQL de onde os dados serão copiados, com um limite de 256 caracteres.
`table_id`	`string` Obrigatório. A tabela do Cloud SQL de onde os dados serão copiados, com um limite de 256 caracteres.
`gcs_staging_dir`	`string` Diretório intermediário do Cloud Storage usado para importação com um limite de 2.000 caracteres. Pode ser especificado se você quiser que o Cloud SQL exporte para um diretório específico do Cloud Storage. Verifique se a conta de serviço do Cloud SQL tem as permissões de administrador do Cloud Storage necessárias para acessar o diretório especificado do Cloud Storage.
`offload`	`bool` Opção para exportação sem servidor. A ativação dessa opção gera custos extras. Confira mais informações neste link.

CmekConfig

Configurações usadas para ativar a criptografia de dados da CMEK com chaves do Cloud KMS.

Campos
`name`	`string` Obrigatório. O nome do CmekConfig no formato `projects/{project}/locations/{location}/cmekConfig` ou `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Obrigatório. Nome do recurso da chave KMS que será usado para criptografar os 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 será usado para criptografar os recursos `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Apenas saída. Os estados do CmekConfig.
`is_default`	`bool` Apenas saída. O CmekConfig padrão para o cliente.
`last_rotation_timestamp_micros`	`int64` Apenas saída. O carimbo de data/hora da última rotação de chaves.
`single_region_keys[]`	`SingleRegionKey` Opcional. CMEKs de região única necessárias para alguns recursos do VAIS.
`notebooklm_state`	`NotebookLMState` Apenas saída. Indica se o corpus do NotebookLM está pronto para uso.

NotebookLMState

Estados do NotebookLM.

Tipos enumerados
`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 para uso.
`NOTEBOOK_LM_NOT_ENABLED`	O NotebookLM não está ativado.

Estado

Estados do CmekConfig.

Tipos enumerados
`STATE_UNSPECIFIED`	O estado do CmekConfig é desconhecido.
`CREATING`	O CmekConfig está sendo 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á sendo excluído.
`DELETE_FAILED`	Falha no processo de exclusão de CmekConfig.
`UNUSABLE`	O CmekConfig não pode ser usado, provavelmente devido a algum problema interno.
`ACTIVE_ROTATING`	A versão da chave do KMS está sendo rotacionada.
`DELETED`	A chave do KMS é excluída de forma temporária. Alguma política de limpeza será aplicada.
`EXPIRED`	A chave do KMS expirou, ou seja, ela foi desativada há mais de 30 dias. O cliente pode chamar DeleteCmekConfig para mudar o estado para DELETED.

CollectUserEventRequest

Mensagem de solicitação para o método "CollectUserEvent".

Campos
`parent`	`string` Obrigatório. O nome do recurso pai. Se a ação de coleta de eventos do usuário for aplicada no nível `DataStore`, o formato será: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Se a ação de coleta de eventos do usuário for aplicada no nível `Location`, por exemplo, o evento com `Document` em vários `DataStore`, o formato será: `projects/{project}/locations/{location}`.
`user_event`	`string` Obrigatório. Proto UserEvent codificado por URL com um limite de 2.000.000 caracteres.
`uri`	`string` O URL, incluindo parâmetros CGI, mas excluindo o fragmento de hash, com um limite de 5.000 caracteres. Isso geralmente é mais útil do que o URL referenciador, porque muitos navegadores enviam apenas o domínio para solicitações de terceiros.
`ets`	`int64` O carimbo de data/hora do evento em milissegundos. Isso evita o armazenamento em cache do navegador de solicitações GET idênticas. O nome é abreviado para reduzir os bytes do payload.

Coleção

Uma coleção é um contêiner para configurar recursos e acesso a um conjunto de DataStores.

Campos

name

string

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

Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

display_name

string

Obrigatório. O nome de exibição da coleção.

Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

create_time

Apenas saída. Carimbo de data/hora em que o Collection foi criado.

CompleteQueryRequest

Solicite uma mensagem para o método CompletionService.CompleteQuery.

Campos
`data_store`	`string` Obrigatório. O nome do recurso do repositório 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 typeahead usada para buscar sugestões. O tamanho máximo é de 128 caracteres.
`query_model`	`string` Especifica o modelo de dados de preenchimento automático. Isso substitui qualquer modelo especificado na seção "Configuração" > "Preenchimento automático" do console do Cloud. Valores aceitos no momento: `document`: usando sugestões geradas com base em documentos importados pelo usuário. `search-history`: usando sugestões geradas com base no histórico de chamadas da API `SearchService.Search`. Não use quando não houver tráfego para a API Search. `user-event`: usando sugestões geradas com base em eventos de pesquisa importados pelo usuário. `document-completable`: usando sugestões extraídas diretamente dos campos de documentos importados pelo usuário marcados como completáveis. Valores padrão: `document` é o modelo padrão para dataStores regulares. `search-history` é o modelo padrão para dataStores de pesquisa no site.
`user_pseudo_id`	`string` Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que deve ser capaz de identificar um visitante de maneira exclusiva em um único dispositivo. Esse identificador exclusivo não deve mudar se o visitante fizer login ou logout no site. Esse campo NÃO pode ter um valor fixo, como `unknown_visitor`. Precisa ser o mesmo identificador de `UserEvent.user_pseudo_id` e `SearchRequest.user_pseudo_id`. O campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`include_tail_suggestions`	`bool` Indica se as sugestões de cauda devem ser retornadas se não houver sugestões que correspondam à consulta completa. Mesmo que seja definido como "true", se houver sugestões que correspondam à consulta completa, elas serão retornadas, e nenhuma sugestão de cauda será retornada.

CompleteQueryResponse

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

Campos

query_suggestions[]

QuerySuggestion

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

tail_match_triggered

bool

True se todas as sugestões retornadas forem de cauda longa.

Para que a correspondência de cauda seja acionada, "include_tail_suggestions" na solicitação precisa ser "true", 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 exclusivos dos campos de documento que servem como origem desta sugestão, se ela foi gerada de campos completáveis.

Esse campo só é preenchido para o modelo de conclusão de documentos.

CompletionInfo

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

Campos

selected_suggestion

string

O usuário final selecionou CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posição CompleteQueryResponse.QuerySuggestion.suggestion selecionada pelo usuário final, começando em 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, elas não serão retornadas juntas. Em vez disso, o que tiver uma classificação mais alta será retornado. Isso pode ser usado para eliminar sugestões semanticamente idênticas.
`group_score`	`double` A pontuação desta sugestão no grupo dela.
`alternative_phrases[]`	`string` Frases alternativas correspondentes para esta sugestão.
Campo de união `ranking_info`. Métricas de classificação desta sugestão. `ranking_info` pode ser apenas de um dos tipos a seguir:
`global_score`	`double` Pontuação global desta sugestão. Controlar como essa sugestão seria pontuada / classificada.
`frequency`	`int64` Frequência desta sugestão. Será usado para classificar sugestões quando a pontuação não estiver disponível.

Condição

Define circunstâncias a serem verificadas antes de permitir um comportamento.

Campos

query_terms[]

QueryTerm

Pesquise apenas uma lista de termos para 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 períodos.

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. Só é compatível com os controles de veiculação de promoções da pesquisa básica no site.

QueryTerm

Matcher para consulta de solicitação de pesquisa

Campos

value

string

O valor de consulta específico a ser correspondido

Precisa estar em minúsculas e em UTF-8. Pode ter no máximo três termos separados por espaço se "full_match" for verdadeiro. Não pode ser uma string vazia. O tamanho máximo é de 5.000 caracteres.

full_match

bool

Se a consulta de pesquisa precisa corresponder exatamente ao termo.

TimeRange

Usado para condições dependentes do tempo.

Campos

start_time

Início do período.

O intervalo é inclusivo.

end_time

Fim do período.

O intervalo é inclusivo. Precisa estar no futuro.

ConnectorType

O tipo de conector.

Tipos enumerados
`CONNECTOR_TYPE_UNSPECIFIED`	Valor padrão.
`THIRD_PARTY`	Conector de terceiros para aplicativo de terceiros.
`GCP_FHIR`	O conector de dados conecta o armazenamento FHIR e o repositório de dados do VAIS.
`BIG_QUERY`	Conector do BigQuery.
`GCS`	Conector do Google Cloud Storage.
`GOOGLE_MAIL`	Conector do Gmail.
`GOOGLE_CALENDAR`	Conector do Google Agenda.
`GOOGLE_DRIVE`	Conector do Google Drive.
`NATIVE_CLOUD_IDENTITY`	Conector nativo do Cloud Identity para pesquisa de pessoas com tecnologia da API People.
`THIRD_PARTY_FEDERATED`	Conector federado, que é um conector de terceiros que não ingere dados, e a pesquisa é feita pela API do aplicativo de terceiros.
`THIRD_PARTY_EUA`	Conector usado para recursos de autenticação de usuário final.
`GCNV`	Conector do Google Cloud NetApp Volumes.

ContactDetails

As informações de contato armazenadas no nível do recurso. Se os níveis do projeto e do recurso forem preenchidos, as informações de contato do recurso vão substituir as do projeto.

Campos

email_address

string

Opcional. O endereço de e-mail do contato.

Controle

Define um comportamento condicionado a ser usado durante a veiculação. Precisa estar anexado a um ServingConfig para ser considerado no momento da veiculação. Ações permitidas dependem 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 UI. Precisa ser uma string codificada em UTF-8. O limite de tamanho é de 128 caracteres. Caso contrário, um erro INVALID ARGUMENT será gerado.
`associated_serving_config_ids[]`	`string` Apenas saída. Lista de todos os IDs `ServingConfig` a que esse controle está anexado. Pode levar até 10 minutos para atualizar após as mudanças.
`solution_type`	`SolutionType` Obrigatório. Imutável. A qual solução o controle pertence. Precisa ser compatível com a categoria do recurso. Caso contrário, um erro INVALID ARGUMENT será gerado.
`use_cases[]`	`SearchUseCase` Especifica o caso de uso do controle. Afeta quais campos de condição podem ser definidos. Válido apenas para `SOLUTION_TYPE_SEARCH`. No momento, só é permitido um caso de uso por controle. Precisa ser definido quando "solution_type" é `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Determina quando a ação associada será acionada. Omita para sempre aplicar a ação. No momento, só é possível especificar uma condição. Caso contrário, um erro INVALID ARGUMENT será gerado.
Campo de união `action`. As ações são restritas por setor e solução Obrigatório. `action` pode ser apenas de um dos tipos a seguir:
`boost_action`	`BoostAction` Define um controle do tipo boost.
`filter_action`	`FilterAction` Define um controle de tipo de filtro. No momento, não é compatível com a recomendação.
`redirect_action`	`RedirectAction` Define um controle do tipo redirecionamento.
`synonyms_action`	`SynonymsAction` Trata um grupo de termos como sinônimos.
`promote_action`	`PromoteAction` Promover determinados links com base em consultas de acionamento predefinidas.

BoostAction

Ajusta a ordem dos produtos na lista retornada.

Campos
`boost (deprecated)`	`float` Este item foi descontinuado. Intensidade da otimização, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0,0 (sem operação).
`filter`	`string` Obrigatório. Especifica a quais produtos aplicar o reforço. Se nenhum filtro for fornecido, todos os produtos serão promovidos (sem operação). Documentação da sintaxe: https://cloud.google.com/retail/docs/filter-and-order. O tamanho máximo é de 5.000 caracteres. Caso contrário, um erro INVALID ARGUMENT será gerado.
`data_store`	`string` Obrigatório. Especifica quais documentos do repositório de dados podem ser otimizados por este controle. Nome completo do repositório de dados, por exemplo, projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo de união `boost_spec`. Otimização de valor constante ou especificações de otimização com base em classificação personalizada. `boost_spec` pode ser apenas de um dos tipos a seguir:
`fixed_boost`	`float` Opcional. Intensidade da otimização, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0,0 (sem operação).
`interpolation_boost_spec`	`InterpolationBoostSpec` Opcional. Especificação complexa para classificação personalizada com base no valor do atributo definido pelo cliente.

InterpolationBoostSpec

Especificação para classificação personalizada com base no valor do atributo especificado pelo cliente. Ela oferece mais controles para classificação personalizada do que a combinação simples (condição, reforço) acima.

Campos
`field_name`	`string` Opcional. O nome do campo cujo valor será usado para determinar o valor do reforço.
`attribute_type`	`AttributeType` Opcional. O tipo de atributo a ser usado para determinar o valor do reforço. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples: attribute_value = numerical_field_value. No caso da atualização, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Opcional. O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo.
`control_points[]`	`ControlPoint` Opcional. Os pontos de controle usados para definir a curva. A função monotônica (definida pelo interpolation_type acima) passa pelos pontos de controle listados aqui.

AttributeType

O atributo(ou função) a que o ranking personalizado será aplicado.

Tipos enumerados
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType não especificado.
`NUMERICAL`	O valor do campo numérico será usado para atualizar dinamicamente o valor do reforço. Nesse caso, o attribute_value (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boost_amount é especificado.
`FRESHNESS`	Para o caso de uso de atualização, o valor do atributo será a duração entre a hora atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor `dayTimeDuration` XSD (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: `[nD][T[nH][nM][nS]]`. Por exemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Os pontos de controle usados para definir a curva. A curva definida por esses pontos de controle só pode ser monotonicamente crescente ou decrescente(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 atualização. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]].

boost_amount

float

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

InterpolationType

O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).

Tipos enumerados
`INTERPOLATION_TYPE_UNSPECIFIED`	O tipo de interpolação não foi especificado. Nesse caso, o padrão é "Linear".
`LINEAR`	A interpolação linear por partes será aplicada.

FilterAction

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

Campos

filter

string

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

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

data_store

string

Obrigatório. Especifica quais documentos do repositório de dados podem ser filtrados por este controle. Nome completo do repositório 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 acionamento.

Exemplo: promova o link da loja de calçados ao pesquisar a palavra-chave shoe. O link pode estar fora do repositório de dados associado.

Campos

data_store

string

Obrigatório. Repositório de dados a que esta promoção está anexada.

search_link_promotion

SearchLinkPromotion

Obrigatório. Promoção anexada 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 será redirecionado.

Obrigatório. O URI precisa ter até 2 mil caracteres. Caso contrário, um erro INVALID ARGUMENT será gerado.

SynonymsAction

Cria um conjunto de termos que vão funcionar como sinônimos entre si.

Por exemplo, "feliz" também será considerado como "alegre", e "alegre" também será considerado como "feliz".

Campos

synonyms[]

string

Define um conjunto de sinônimos. É possível especificar até 100 sinônimos. É preciso especificar pelo menos dois sinônimos. Caso contrário, um erro INVALID ARGUMENT será gerado.

Conversa

Definição de 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 rastrear usuários.
`messages[]`	`ConversationMessage` Mensagens de conversa.
`start_time`	`Timestamp` Apenas saída. O horário em que a conversa começou.
`end_time`	`Timestamp` Apenas saída. O horário em que a conversa terminou.

Estado

Enumeração do estado da conversa.

Tipos enumerados
`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 usuário está vendo. Ele contém as referências de recursos de documentos.

active_document

string

O documento ativo aberto pelo usuário. Ele contém a referência do recurso de documento.

ConversationMessage

Define uma mensagem de conversa.

Campos
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora da criação da mensagem.
Campo de união `message`. `message` pode ser apenas de um dos tipos a seguir:
`user_input`	`TextInput` Entrada de texto do usuário.
`reply`	`Reply` Resposta da pesquisa.

ConverseConversationRequest

Solicite uma mensagem para o método ConversationalSearchService.ConverseConversation.

Campos
`name`	`string` Obrigatório. O nome do recurso da conversa a ser recebida. 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 em uma sessão ConverseConversation.
`query`	`TextInput` Obrigatório. Entrada do usuário atual.
`serving_config`	`string` O nome do recurso da configuração de exibição a ser usada. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`. Se não for definido, a configuração de veiculação padrão será usada.
`conversation`	`Conversation` A conversa a ser usada apenas pela sessão automática. O campo de nome será ignorado, já que atribuímos automaticamente um novo nome para a conversa na sessão automática.
`safe_search`	`bool` Se o safe search deve ser ativado.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte o documento do Google Cloud para mais detalhes.
`summary_spec`	`SummarySpec` Uma especificação para configurar o resumo retornado na resposta.
`filter`	`string` A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas. Isso será usado para filtrar os resultados da pesquisa, o que pode afetar a resposta do resumo. Se esse campo não for reconhecido, um `INVALID_ARGUMENT` será retornado. A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")' Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.
`boost_spec`	`BoostSpec` Aumentar a especificação para impulsionar determinados documentos nos resultados da pesquisa, o que pode afetar a resposta inversa. Para mais informações sobre o aumento, consulte Aumento.

ConverseConversationResponse

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

Campos

reply

Reply

Resposta à consulta atual.

conversation

Conversa atualizada, incluindo a resposta.

search_results[]

SearchResult

Resultados da pesquisa.

CreateAssistantRequest

Solicitação para o método AssistantService.CreateAssistant.

Campos

parent

string

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

assistant

Assistant

Obrigatório. O Assistant a ser criado.

assistant_id

string

Obrigatório. O ID a ser usado para o Assistant, que se tornará o componente final do nome do recurso do Assistant.

Esse campo precisa estar em conformidade com a RFC-1034 e ter um limite de 63 caracteres.

CreateControlRequest

Solicitação para o método "CreateControl".

Campos

parent

string

Obrigatório. Nome completo do recurso do repositório de dados pai. 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 controle a ser criado.

control_id

string

Obrigatório. O ID a ser usado no controle, que se tornará o componente final do nome do recurso do controle.

Esse valor precisa ter entre 1 e 63 caracteres. Os caracteres válidos são /[a-z][0-9]-_/.

CreateConversationRequest

Solicitação para o método "CreateConversation".

Campos

parent

string

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

conversation

Obrigatório. A conversa a ser criada.

CreateDataStoreMetadata

Metadados relacionados ao progresso da operação DataStoreService.CreateDataStore. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

CreateDataStoreRequest

Solicitação para o método DataStoreService.CreateDataStore.

Campos
`parent`	`string` Obrigatório. O nome do recurso pai, como `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Obrigatório. O `DataStore` a ser criado.
`data_store_id`	`string` Obrigatório. O ID a ser usado para o `DataStore`, que se tornará o componente final do nome do recurso do `DataStore`. Esse campo precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 63 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`create_advanced_site_search`	`bool` Uma flag booleana que indica se o usuário quer criar diretamente um repositório de dados avançado para a pesquisa no site. Se o repositório de dados não estiver configurado como pesquisa no site (setor GENERIC e content_config PUBLIC_WEBSITE), essa flag será ignorada.
`skip_default_schema_creation`	`bool` Uma flag booleana que indica se a criação do esquema padrão para o repositório de dados deve ser ignorada. Ative essa flag apenas se tiver certeza de que o esquema padrão é incompatível com seu caso de uso. Se definido como "true", você precisará criar manualmente um esquema para o repositório de dados antes que qualquer documento possa ser ingerido. Essa flag não pode ser especificada se `data_store.starting_schema` for especificado.
Campo de união `cmek_options`. Opções de CMEK para o DataStore. Definir esse campo vai substituir o CmekConfig padrão, se um estiver definido para o projeto. `cmek_options` pode ser apenas de um dos tipos a seguir:
`cmek_config_name`	`string` Nome do recurso do CmekConfig a ser usado para proteger este DataStore.
`disable_cmek`	`bool` DataStore sem proteções de CMEK. Se uma CmekConfig padrão estiver definida para o projeto, a definição desse campo também vai substituir a CmekConfig padrão.

CreateDocumentRequest

Solicite uma mensagem para o método DocumentService.CreateDocument.

Campos

parent

string

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

document

Obrigatório. O Document a ser criado.

document_id

string

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

Se o autor da chamada não tiver permissão para criar o Document, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Esse campo precisa ser exclusivo entre todos os Documents com o mesmo parent. Caso contrário, é retornado um erro ALREADY_EXISTS.

Esse campo precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

CreateEngineMetadata

Metadados relacionados ao progresso da operação EngineService.CreateEngine. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

CreateEngineRequest

Solicitação para o método EngineService.CreateEngine.

Campos

parent

string

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

engine

Engine

Obrigatório. O Engine a ser criado.

engine_id

string

Obrigatório. O ID a ser usado para o Engine, que se tornará o componente final do nome do recurso do Engine.

Esse campo precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 63 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

CreateIdentityMappingStoreRequest

Mensagem de solicitação 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 IdentityMappingStore a ser criado. O ID precisa conter apenas letras (a-z, A-Z), números (0-9), sublinhados (_) e hifens (-). O tamanho máximo é de 63 caracteres.
`identity_mapping_store`	`IdentityMappingStore` Obrigatório. O IdentityMappingStore a ser criado.
Campo de união `cmek_options`. Opções de CMEK para o Identity Mapping Store. Definir esse campo vai substituir o CmekConfig padrão, se um estiver definido para o projeto. `cmek_options` pode ser apenas de um dos tipos a seguir:
`cmek_config_name`	`string` Nome do recurso da CmekConfig a ser usada para proteger este Identity Mapping Store.
`disable_cmek`	`bool` Repositório de mapeamento de identidades sem proteções da CMEK. Se uma CmekConfig padrão estiver definida para o projeto, a definição desse campo também vai substituir a CmekConfig padrão.

CreateLicenseConfigRequest

Solicite uma mensagem para o método LicenseConfigService.CreateLicenseConfig.

Campos

parent

string

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

license_config

LicenseConfig

Obrigatório. O LicenseConfig a ser criado.

license_config_id

string

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

CreateSchemaMetadata

Metadados para LRO de criação de esquema.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

CreateSchemaRequest

Solicite uma mensagem para o método SchemaService.CreateSchema.

Campos

parent

string

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

schema

Schema

Obrigatório. O Schema a ser criado.

schema_id

string

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

Esse campo precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 63 caracteres.

CreateSessionRequest

Solicitação para o método CreateSession.

Campos

parent

string

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

session

Obrigatório. A sessão a ser criada.

CreateSitemapMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.CreateSitemap. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

CreateSitemapRequest

Solicite uma mensagem para o método SiteSearchEngineService.CreateSitemap.

Campos

parent

string

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

sitemap

Sitemap

Obrigatório. O Sitemap a ser criado.

CreateTargetSiteMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.CreateTargetSite. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

CreateTargetSiteRequest

Solicite uma mensagem para o método SiteSearchEngineService.CreateTargetSite.

Campos

parent

string

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

target_site

Obrigatório. O TargetSite a ser criado.

CustomAttribute

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

Campos

text[]

string

Os valores de texto desse atributo personalizado. Por exemplo, ["yellow", "green"] quando a chave é "color".

Não é permitido usar uma string vazia. Caso contrário, um erro INVALID_ARGUMENT será retornado.

É necessário definir exatamente um CustomAttribute.text ou CustomAttribute.numbers. Caso contrário, é retornado um erro INVALID_ARGUMENT.

numbers[]

double

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

É necessário definir exatamente um CustomAttribute.text ou CustomAttribute.numbers. Caso contrário, é retornado um erro INVALID_ARGUMENT.

CustomTuningModel

Metadados que descrevem um modelo ajustado personalizado.

Campos
`name`	`string` Obrigatório. O nome totalmente qualificado do recurso do modelo. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. O modelo precisa ser uma string alfanumérica com limite de 40 caracteres.
`display_name`	`string` O nome de exibição do modelo.
`model_version`	`int64` A versão do modelo.
`model_state`	`ModelState` O estado em que o modelo está (por exemplo, `TRAINING` ou `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Este item foi descontinuado. Descontinuado: carimbo de data/hora em que o modelo foi criado.
`training_start_time`	`Timestamp` Carimbo de data/hora em que o treinamento de modelo foi iniciado.
`metrics`	`map<string, double>` As métricas do modelo treinado.
`error_message`	`string` No momento, isso só é preenchido se o estado do modelo for `INPUT_VALIDATION_FAILED`.

ModelState

O estado do modelo.

Tipos enumerados
`MODEL_STATE_UNSPECIFIED`	Valor padrão.
`TRAINING_PAUSED`	O modelo está em um estado de treinamento pausado.
`TRAINING`	O modelo está em treinamento.
`TRAINING_COMPLETE`	O treinamento do modelo foi concluído.
`READY_FOR_SERVING`	O modelo está pronto para veiculação.
`TRAINING_FAILED`	O treinamento de modelo falhou.
`NO_IMPROVEMENT`	O treinamento de modelo foi concluído, mas as métricas não melhoraram.
`INPUT_VALIDATION_FAILED`	Falha na validação dos dados de entrada. O treinamento do modelo não foi iniciado.

DataConnector

Gerencia a conexão com fontes de dados externas para todos os repositórios de dados agrupados em um Collection. É um recurso singleton de Collection. A inicialização só é compatível com o método DataConnectorService.SetUpDataConnector, que cria um novo Collection e inicializa o DataConnector dele.

Campos
`name`	`string` Apenas saída. O nome completo do recurso do conector de dados. Formato: `projects//locations//collections/*/dataConnector`.
`state`	`State` Apenas saída. Estado do conector.
`data_source`	`string` Obrigatório. O nome da fonte de dados. Valores aceitos: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Opcional. Especifica as chaves a serem removidas do campo "params". Isso só fica ativo quando "params" está incluído na "update_mask" em um UpdateDataConnectorRequest. A exclusão tem precedência se uma chave estiver em "remove_param_keys" e presente no campo "params" da solicitação.
`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 serão sincronizados em tempo real. O recurso de streaming ainda não está disponível. O mínimo é de 30 minutos e o máximo é de 7 dias. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada.
`next_sync_time`	`DateTime` Define o horário programado para a próxima sincronização de dados. Esse campo exige hora, minuto e fuso horário do banco de dados de fuso horário da IANA. Isso é usado quando o conector de dados tem um intervalo de atualização maior que um dia. Quando as horas ou os minutos não são especificados, presumimos um horário de sincronização de 0:00. O usuário precisa informar um fuso horário para evitar ambiguidade.
`entities[]`	`SourceEntity` Lista de entidades da fonte de dados conectada a serem ingeridas.
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora em que o `DataConnector` foi criado.
`latest_pause_time`	`Timestamp` Apenas saída. O carimbo de data/hora mais recente em que este `DataConnector` foi pausado, afetando todas as funcionalidades, como a sincronização de dados. Pausar um conector tem os seguintes efeitos: - Todas as funcionalidades, incluindo a sincronização de dados, são interrompidas. - Todos os jobs de sincronização de dados em andamento serão cancelados. - Nenhuma sincronização de dados futura será programada ou poderá ser acionada.
`last_sync_time`	`Timestamp` Apenas saída. Somente para conectores periódicos, a última vez que uma sincronização de dados foi concluída.
`update_time`	`Timestamp` Apenas saída. Carimbo de 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 conector.
`sync_mode`	`SyncMode` O modo de sincronização de dados compatível com o conector de dados.
`kms_key_name`	`string` Somente entrada. A chave do KMS a ser usada para proteger os DataStores gerenciados por este conector. Precisa ser definido para solicitações que precisam obedecer às proteções da política da organização da CMEK. Se esse campo for definido e processado com sucesso, os DataStores criados por esse conector serão protegidos pela chave do KMS.
`destination_configs[]`	`DestinationConfig` Opcional. Qualquer destino usado para se conectar a serviços de terceiros.
`action_state`	`State` Apenas saída. Estado do conector de ação. Isso reflete se o conector de ação está sendo inicializado, ativo ou encontrou erros.
`action_config`	`ActionConfig` Opcional. Configurações de ação para que o conector ofereça suporte a ações.
`end_user_config`	`EndUserConfig` Opcional. Parâmetros e credenciais usados especificamente para conectores da UEA.
`federated_config`	`FederatedConfig` Opcional. Todos os parâmetros e credenciais usados especificamente para conectores híbridos que oferecem suporte ao modo FEDERATED. Esse campo só deve ser definido se o conector for híbrido e quisermos ativar o modo FEDERATED.
`connector_modes[]`	`ConnectorMode` Opcional. Os modos ativados para este conector. O estado padrão é 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 esse conector.
`blocking_reasons[]`	`BlockingReason` Apenas saída. Ações do usuário que precisam ser concluídas antes que o conector possa 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 controle de acesso dos documentos ingeridos por esse conector. Se não for definida, a lista de controle de acesso será atualizada no intervalo padrão de 30 minutos. O intervalo de atualização da identidade pode ser de no mínimo 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 controle de acesso dos documentos ingeridos por esse conector.
`private_connectivity_project_id`	`string` Apenas saída. O ID do projeto do locatário associado aos conectores de conectividade particular. Esse projeto precisa estar na lista de permissões para que o conector funcione.
`bap_config`	`BAPConfig` Opcional. A configuração para estabelecer uma conexão BAP.
`connector_type`	`ConnectorType` Apenas saída. O tipo de conector. Cada origem só pode ser mapeada para um tipo. Por exemplo, o Salesforce, o Confluence e o Jira têm o tipo de conector THIRD_PARTY. Ele não pode ser mudado depois de definido pelo sistema.
`realtime_state`	`State` Apenas saída. Estado da sincronização em tempo real
`alert_policy_configs[]`	`AlertPolicyConfig` Opcional. A configuração de alerta no nível do conector.
`realtime_sync_config`	`RealtimeSyncConfig` Opcional. A configuração para sincronização em tempo real.
`acl_enabled`	`bool` Opcional. Se o conector será criado com uma configuração de ACL. No momento, esse campo só afeta os conectores do Cloud Storage e do BigQuery.
`create_eua_saas`	`bool` Opcional. Se o conector END USER AUTHENTICATION foi criado no SaaS.
`auto_run_disabled`	`bool` Opcional. Indica se o conector está desativado para execução automática. Ele 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 esse conector. Isso é independente de "auto_run_disabled". Aplicável apenas a conectores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada, ou seja, definida como "true".
`incremental_refresh_interval`	`Duration` Opcional. O intervalo de atualização específico para sincronizações de dados incrementais. Se não for definido, as sincronizações incrementais usarão o padrão do ambiente, definido como 3 horas. O mínimo é de 30 minutos e o máximo é de 7 dias. Aplicável apenas a conectores de terceiros. Quando o intervalo de atualização é definido com o mesmo valor do intervalo de atualização incremental, a sincronização incremental é desativada.
`hybrid_ingestion_disabled`	`bool` Opcional. Se o conector for híbrido, determina se a ingestão está ativada e se os recursos adequados são provisionados durante a criação do conector. Se o conector não for híbrido, esse campo será ignorado.
Campo de união `data_connector_params`. Parâmetros necessários para acessar a origem no formato de pares (chave, valor). Os valores de string com o formato `projects//[locations//]secrets//versions/` serão lidos do Secret Manager. Parâmetros obrigatórios para todas as fontes de dados: Chave: `instance_uri` Valor: tipo STRING. O URI para acessar a fonte de dados. Parâmetros obrigatórios para fontes que aceitam OAUTH, ou seja, `salesforce`: Chave: `client_id` Valor: tipo STRING. O ID do cliente do provedor de serviços terceirizado para identificar seu aplicativo. Chave: `client_secret` Valor:tipo STRING. A chave secreta do cliente gerada pelo servidor de autorização de terceiros. Chave: `access_token` Valor: tipo STRING. Token OAuth para o UCS acessar o recurso protegido. Chave: `refresh_token` Valor: tipo STRING. Token de atualização do OAuth para que o UCS receba um novo token de acesso sem interação do usuário. Parâmetros obrigatórios para fontes que aceitam autenticação básica de token de API, ou seja, `jira` e `confluence`: Chave: `user_account` Valor: tipo STRING. O nome de usuário ou e-mail com a fonte. Chave: `api_token` Valor: tipo STRING. O token de API gerado para a conta de origem, usado para autenticação em qualquer lugar em que você usaria uma senha. 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 ser usado para suporte a vários tipos de autorização: Chave: `auth_type` Valor: tipo STRING. O tipo de autorização da fonte de dados. Valores aceitos: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. `data_connector_params` pode ser apenas um dos seguintes:
`params`	`Struct` Parâmetros obrigatórios do conector de dados no formato JSON estruturado.
`json_params`	`string` Parâmetros obrigatórios do conector de dados no formato de string JSON.

BlockingReason

Ações do usuário que precisam ser concluídas antes que o conector possa começar a sincronizar dados.

Tipos enumerados
`BLOCKING_REASON_UNSPECIFIED`	Valor padrão.
`ALLOWLIST_STATIC_IP`	O conector exige que o cliente coloque IPs estáticos na lista de permissões.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	O conector exige que o cliente adicione nosso projeto à lista de permissões no anexo de serviço.
`ALLOWLIST_SERVICE_ACCOUNT`	O conector exige que o cliente coloque a conta de serviço na lista de permissões do projeto.

ConnectorMode

Os modos ativados para este conector. INGESTION, ACTIONS, FEDERATED, OR EUA

Tipos enumerados
`CONNECTOR_MODE_UNSPECIFIED`	Modo de conector não especificado.
`DATA_INGESTION`	Conector usado para ingestão de dados.
`ACTIONS`	Conector usado para ações.
`FEDERATED`	Conector usado para pesquisa federada.
`EUA`	Conector usado para autenticação de usuário final.
`FEDERATED_AND_EUA`	Conector híbrido usado para pesquisa federada e autenticação de usuário final.

EndUserConfig

Parâmetros e credenciais usados especificamente para conectores da UEA.

Campos
`additional_params`	`Struct` Opcional. Outros parâmetros necessários para os EUA.
`tenant`	`Tenant` Opcional. O projeto de locatário a que o conector está conectado.
Campo de união `auth_config`. Configuração de autenticação para conectores da EUA. `auth_config` pode ser apenas de um dos tipos a seguir:
`auth_params`	`Struct` Opcional. Parâmetros de autenticação específicos para conectores da EUA.
`json_auth_params`	`string` Opcional. Parâmetros de autenticação específicos para conectores da EUA no formato de string JSON.

FederatedConfig

Todos os parâmetros e credenciais usados especificamente para conectores híbridos que oferecem suporte ao modo FEDERATED.

Campos
`additional_params`	`Struct` Opcional. Todos os parâmetros adicionais necessários para FEDERATED.
Campo de união `auth_config`. Configuração de autenticação para conectores FEDERADOS. `auth_config` pode ser apenas de um dos tipos a seguir:
`auth_params`	`Struct` Opcional. Parâmetros de autenticação específicos para conectores FEDERATED.
`json_auth_params`	`string` Opcional. Parâmetros de autenticação específicos para conectores FEDERATED no formato de string JSON.

RealtimeSyncConfig

A configuração para sincronização em tempo real que armazena parâmetros adicionais para esse tipo de sincronização.

Campos

webhook_uri

string

Opcional. URL do webhook para o conector 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 secret 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.

Tipos enumerados
`STREAMING_ERROR_REASON_UNSPECIFIED`	Motivo do erro de transmissão não especificado.
`STREAMING_SETUP_ERROR`	Ocorreu um erro ao configurar recursos para a sincronização em tempo real.
`STREAMING_SYNC_ERROR`	Ocorreu um erro ao executar a sincronização em tempo real para o conector.
`INGRESS_ENDPOINT_REQUIRED`	O endpoint de entrada é obrigatório ao configurar a sincronização em tempo real na conectividade particular.

SourceEntity

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

Campos
`entity_name`	`string` É o nome da entidade. Valores compatíveis por fonte de dados: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Atributos para indexação. Chave: nome do campo. Valor: a propriedade principal para mapear um campo, como `title` e `description`. Propriedades de chave compatíveis: `title`: o título do registro de dados. Isso seria exibido nos resultados da pesquisa. `description`: a descrição do registro de dados. Isso seria exibido nos resultados da pesquisa.
`data_store`	`string` Apenas saída. O nome completo do recurso do repositório de dados associado à entidade de origem. Formato: `projects//locations//collections//dataStores/`. Quando o conector é inicializado pelo método `DataConnectorService.SetUpDataConnector`, um `DataStore` é criado automaticamente para cada entidade de origem.
`starting_schema`	`Schema` Opcional. O esquema inicial a ser usado para o `DataStore` criado com base neste SourceEntity. Se não for definido, um esquema vertical especializado padrão será usado. Esse campo é usado apenas pela API [SetUpDataConnector][] e será ignorado se usado em outras APIs. Esse campo será omitido de todas as respostas da API, incluindo a API [GetDataConnector][]. Para recuperar um esquema de um `DataStore`, use a API `SchemaService.GetSchema`. O esquema fornecido será validado de acordo com determinadas regras. Saiba mais neste documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Configuração para a categoria `HEALTHCARE_FHIR`.
Campo de união `entity_params`. Os parâmetros da entidade para facilitar a ingestão de dados. Por exemplo, para conectores do BigQuery: Chave: `document_id_column` Valor: tipo STRING. O valor do ID da coluna. `entity_params` pode ser apenas de um dos tipos a seguir:
`params`	`Struct` Os parâmetros da entidade para facilitar a ingestão de dados no formato JSON estruturado.
`json_params`	`string` Os parâmetros da entidade para facilitar a ingestão de dados no formato de string JSON.

Estado

O estado do conector.

Tipos enumerados
`STATE_UNSPECIFIED`	Valor padrão.
`CREATING`	O conector está sendo configurado.
`ACTIVE`	O conector foi configurado e está aguardando a próxima execução de sincronização.
`FAILED`	O conector está com erro. Os detalhes do erro podem ser encontrados em `DataConnector.errors`. Se o erro não puder ser corrigido, o `DataConnector` poderá ser excluído pela API [CollectionService.DeleteCollection].
`RUNNING`	O conector está sincronizando ativamente os registros da fonte de dados.
`WARNING`	O conector concluiu uma execução de sincronização, mas encontrou erros não fatais.
`INITIALIZATION_FAILED`	Falha na inicialização do conector. As possíveis causas incluem erros de tempo de execução ou problemas no pipeline assíncrono, impedindo que a solicitação chegue aos serviços downstream (exceto alguns tipos de conector).
`UPDATING`	O conector está em processo de atualização.

SyncMode

Define o modo de sincronização de dados compatível com o conector de dados.

Tipos enumerados
`PERIODIC`	O conector vai sincronizar os dados periodicamente com base no refresh_interval. Use com auto_run_disabled para pausar a sincronização periódica ou indicar uma sincronização única.
`STREAMING`	Os dados serão sincronizados em tempo real.
`UNSPECIFIED`	Conectores que não ingerem dados terão esse valor

DataStore

O DataStore captura configurações globais no nível do DataStore.

Campos
`name`	`string` Imutável. Identificador. O nome completo do recurso do repositório de dados. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
`display_name`	`string` Obrigatório. O nome de exibição do repositório de dados. Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`industry_vertical`	`IndustryVertical` Imutável. O setor em que o repositório de dados está registrado.
`solution_types[]`	`SolutionType` As soluções registradas pelo repositório de dados. Soluções disponíveis para cada `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` e `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` é inscrito automaticamente. Não é possível inscrever outras soluções.
`default_schema_id`	`string` Apenas saída. O ID do `Schema` padrão associado a este repositório de dados.
`content_config`	`ContentConfig` Imutável. A configuração de conteúdo do repositório de dados. Se esse campo não for definido, o comportamento padrão do servidor será `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora em que o `DataStore` foi criado.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Opcional. Configuração para pesquisa avançada no site.
`kms_key_name`	`string` Somente entrada. A chave do KMS a ser usada para proteger este DataStore no momento da criação. Precisa ser definido para solicitações que precisam obedecer às proteções da política da organização da CMEK. Se esse campo for definido e processado com sucesso, o DataStore será protegido pela chave do KMS, conforme indicado no campo "cmek_config".
`cmek_config`	`CmekConfig` Apenas saída. Informações relacionadas à CMEK para o DataStore.
`billing_estimation`	`BillingEstimation` Apenas saída. Estimativa do tamanho dos dados para faturamento.
`acl_enabled`	`bool` Imutável. Se os dados em `DataStore` têm informações de ACL. Se definido como `true`, os dados de origem precisam ter ACL. A ACL será ingerida quando os dados forem ingeridos pelos métodos `DocumentService.ImportDocuments`. Quando a ACL está ativada para o `DataStore`, não é possível acessar `Document` chamando `DocumentService.GetDocument` ou `DocumentService.ListDocuments`. No momento, as ACLs são aceitas apenas na categoria `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 repositório de dados para dados do espaço de trabalho. Isso precisa ser definido quando `DataStore.content_config` é definido como `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Configuração para entendimento e enriquecimento de documentos.
`starting_schema`	`Schema` O esquema inicial a ser usado para este `DataStore` ao provisioná-lo. Se não for definido, um esquema vertical especializado padrão será usado. Esse campo é usado apenas pela API `CreateDataStore` e será ignorado se usado em outras APIs. Esse campo será omitido de todas as respostas da API, incluindo a API `CreateDataStore`. Para recuperar um esquema de um `DataStore`, use a API `SchemaService.GetSchema`. O esquema fornecido será validado de acordo com determinadas regras. Saiba mais neste documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Configuração para a categoria `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Opcional. Armazena a configuração de veiculação no nível do DataStore.
`identity_mapping_store`	`string` Imutável. O nome totalmente qualificado do recurso do `IdentityMappingStore` associado. Esse campo só pode ser definido para DataStores acl_enabled com IdP `THIRD_PARTY` ou `GSUITE`. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Opcional. Se definido, esse DataStore será um DataStore de perguntas frequentes do Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Opcional. Configuração para uma abordagem de faturamento configurável. Ver

BillingEstimation

Estimativa do tamanho dos dados por repositório de dados.

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

ConfigurableBillingApproach

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

Tipos enumerados
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor padrão. Para o Spark e a abordagem de faturamento não configurável que não é do Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Use o faturamento de base + excedente da assinatura para indexação principal para armazenamento sem incorporação.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Use o faturamento de pagamento por uso para o complemento de armazenamento de incorporação.

ContentConfig

Configuração de conteúdo do repositório de dados.

Tipos enumerados
`CONTENT_CONFIG_UNSPECIFIED`	Valor padrão.
`NO_CONTENT`	Contém apenas documentos sem `Document.content`.
`CONTENT_REQUIRED`	Contém apenas documentos com `Document.content`.
`PUBLIC_WEBSITE`	O repositório de dados é usado para pesquisa pública de sites.
`GOOGLE_WORKSPACE`	O repositório de dados é usado para a pesquisa no espaço de trabalho. Os detalhes do repositório de dados do espaço de trabalho são especificados no `WorkspaceConfig`.

ServingConfigDataStore

Armazena informações sobre as configurações de exibição no nível do DataStore.

Campos

disabled_for_serving

bool

Opcional. Se definido como verdadeiro, o DataStore não estará disponível para atender a solicitações de pesquisa.

DeleteAssistantRequest

Mensagem de solicitação 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 permissão para excluir o Assistant, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Assistant a ser excluído não existir, um erro NOT_FOUND será retornado.

DeleteCmekConfigMetadata

Metadados relacionados ao progresso da operação CmekConfigService.DeleteCmekConfig. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteCmekConfigRequest

Solicite uma mensagem para o método CmekConfigService.DeleteCmekConfig.

Campos

name

string

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

DeleteCollectionMetadata

Metadados relacionados ao progresso da operação [CollectionService.UpdateCollection][]. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteCollectionRequest

Solicite uma mensagem 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

Solicitação para o método "DeleteControl".

Campos

name

string

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

DeleteConversationRequest

Solicitação para o método "DeleteConversation".

Campos

name

string

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

DeleteDataStoreMetadata

Metadados relacionados ao progresso da operação DataStoreService.DeleteDataStore. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteDataStoreRequest

Solicite uma mensagem 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 permissão para excluir o DataStore, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o DataStore a ser excluído não existir, um erro NOT_FOUND será retornado.

DeleteDocumentRequest

Solicite uma mensagem 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 permissão para excluir o Document, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Document a ser excluído não existir, um erro NOT_FOUND será retornado.

DeleteEngineMetadata

Metadados relacionados ao progresso da operação EngineService.DeleteEngine. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteEngineRequest

Solicite uma mensagem 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 permissão para excluir o Engine, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Engine a ser excluído não existir, um erro NOT_FOUND será retornado.

DeleteIdentityMappingStoreMetadata

Metadados relacionados ao progresso da operação IdentityMappingStoreService.DeleteIdentityMappingStore. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteIdentityMappingStoreRequest

Mensagem de solicitação para IdentityMappingStoreService.DeleteIdentityMappingStore

Campos

name

string

Obrigatório. O nome do armazenamento de mapeamento de identidade a ser excluído. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadados para LRO de DeleteSchema.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteSchemaRequest

Solicite uma mensagem 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

Solicitação para o método DeleteSession.

Campos

name

string

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

DeleteSitemapMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.DeleteSitemap. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteSitemapRequest

Solicite uma mensagem 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 permissão para acessar o Sitemap, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Sitemap solicitado não existir, um erro NOT_FOUND será retornado.

DeleteTargetSiteMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.DeleteTargetSite. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DeleteTargetSiteRequest

Solicite uma mensagem 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 permissão para acessar o TargetSite, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o TargetSite solicitado não existir, um erro NOT_FOUND será retornado.

DestinationConfig

Define endpoints de destino usados para se conectar a fontes de terceiros.

Campos
`key`	`string` Opcional. Identificador exclusivo do destino compatível com o conector.
`destinations[]`	`Destination` Opcional. Os destinos da chave correspondente.
Campo de união `destination_config_params`. Parâmetros adicionais para essa configuração de destino. `destination_config_params` pode ser apenas de um dos tipos a seguir:
`params`	`Struct` Opcional. Parâmetros adicionais para essa configuração de destino no formato JSON estruturado.
`json_params`	`string` Parâmetros adicionais para essa configuração de destino no formato de string JSON.

Destino

Define um endpoint de destino.

Campos

port

int32

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

Campo de união destination. O destino do endpoint. destination pode ser apenas de um dos tipos a seguir:

host

string

Host roteável publicamente.

DisableAdvancedSiteSearchMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.DisableAdvancedSiteSearch. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

DisableAdvancedSiteSearchRequest

Solicite uma mensagem para o método SiteSearchEngineService.DisableAdvancedSiteSearch.

Campos

site_search_engine

string

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

DisableAdvancedSiteSearchResponse

Esse tipo não tem campos.

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

Documento

O documento captura todas as informações de metadados brutos dos itens a serem recomendados ou pesquisados.

Campos
`name`	`string` Imutável. O nome completo do recurso do documento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
`id`	`string` Imutável. O identificador do documento. O ID precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 128 caracteres.
`schema_id`	`string` O identificador do esquema localizado no mesmo repositório de dados.
`content`	`Content` Os dados não estruturados vinculados a este documento. O conteúdo só pode ser definido e precisa ser definido se este documento estiver em um repositório de dados `CONTENT_REQUIRED`.
`parent_document_id`	`string` O identificador do documento principal. Atualmente, é compatível com no máximo dois níveis de hierarquia de documentos. O ID precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 63 caracteres.
`derived_struct_data`	`Struct` Apenas saída. Este campo é OUTPUT_ONLY. Ele contém dados derivados que não estão no documento de entrada original.
`acl_info`	`AclInfo` Informações de controle de acesso do documento.
`index_time`	`Timestamp` Apenas saída. A última vez que o documento foi indexado. Se esse campo estiver definido, o documento poderá ser retornado nos resultados da pesquisa. Este campo é OUTPUT_ONLY. Se esse campo não for preenchido, significa que o documento nunca foi indexado.
`index_status`	`IndexStatus` Apenas saída. O status de indexação do documento. Se o documento for indexado, o campo "index_time" será preenchido. Caso contrário, se o documento não for indexado devido a erros, o campo error_samples será preenchido. Caso contrário, se o índice do documento estiver em andamento, o campo "pending_message" será preenchido.
Campo de união `data`. Representação de dados. É necessário fornecer `struct_data` ou `json_data`. Caso contrário, um erro `INVALID_ARGUMENT` será gerado. `data` pode ser apenas um dos seguintes:
`struct_data`	`Struct` Os dados JSON estruturados do documento. Ele precisa estar de acordo com o `Schema` registrado ou um erro `INVALID_ARGUMENT` será gerado.
`json_data`	`string` A representação de string JSON do documento. Ele precisa estar de acordo com o `Schema` registrado ou um erro `INVALID_ARGUMENT` será gerado.

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 "Ambas as permissões", em que, para acessar um documento filho, o usuário precisa ter acesso ao documento pai.

Hierarquia de documentos: Space_S --> Page_P.

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

Restrição de ACL do Space_S - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Restrição de 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 principais.

idp_wide

bool

Todos os usuários no provedor de identidade.

Conteúdo

Dados não estruturados vinculados a este documento.

Campos
`mime_type`	`string` O tipo MIME do conteúdo. Tipos compatíveis: `application/pdf` (PDF, por enquanto, apenas PDFs nativos são aceitos) `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ão compatíveis apenas se o analisador de layout estiver ativado no repositório 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` pode ser apenas de um dos tipos a seguir:
`raw_bytes`	`bytes` O conteúdo representado como um stream de bytes. O comprimento máximo é de 1.000.000 bytes (1 MB / ~0,95 MiB). Observação: assim como acontece com todos os campos `bytes`, esse 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. Somente URIs do Cloud Storage (por exemplo, `gs://bucket-name/path/to/file`) são aceitos. O tamanho máximo do arquivo é de 2, 5 MB para formatos baseados em texto e de 200 MB para outros formatos.

IndexStatus

Status de indexação do documento.

Campos

index_time

O horário em que o documento foi indexado. Se esse campo for preenchido, significa que o documento foi indexado.

error_samples[]

LayoutBasedChunkingConfig

Uma amostra de erros encontrados ao indexar o documento. Se esse campo for preenchido, o documento não será indexado devido a erros.

pending_message

string

Imutável. A mensagem indica que o índice de documentos está em andamento. Se esse campo for preenchido, o índice do documento estará pendente.

DocumentInfo

Informações detalhadas do documento associadas a um evento do usuário.

Campos
`promotion_ids[]`	`string` Os IDs de promoção associados a este documento. No momento, esse campo é restrito a no máximo um ID.
`joined`	`bool` Apenas saída. Se o documento referenciado pode ser encontrado no repositório de dados.
Campo de união `document_descriptor`. Um descritor obrigatório do `Document` associado. Se `id` for especificado, os valores padrão de `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` serão usados ao fazer anotações com o documento armazenado. Se `name` for especificado, os valores fornecidos (valores padrão permitidos) para `{location}`, `{collection_id}`, `{data_store_id}` e `{branch_id}` serão usados ao fazer anotações com o documento armazenado. `document_descriptor` pode ser apenas de um dos tipos a seguir:
`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`, que só é permitido para repositórios de dados de sites.
`quantity`	`int32` Quantidade do documento associado ao evento do usuário. O padrão é 1. Por exemplo, esse campo é 2 se duas quantidades do mesmo documento estiverem envolvidas em um evento `add-to-cart`. Obrigatório para eventos dos seguintes tipos: `add-to-cart` `purchase`
`conversion_value`	`float` Opcional. O valor de conversão associado a este documento. Precisa ser definido se `UserEvent.event_type` for "conversion". Por exemplo, um valor de 1.000 significa que 1.000 segundos foram gastos visualizando um documento para o tipo de conversão `watch`.

DocumentProcessingConfig

Um recurso singleton de DataStore. Se ele estiver vazio quando DataStore for criado e DataStore estiver definido como DataStore.ContentConfig.CONTENT_REQUIRED, o analisador padrão será definido como 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 padrão. Se não for especificado, vamos configurá-lo como DigitalParsingConfig padrão, e a configuração de análise padrão será aplicada a todos os tipos de arquivo para análise de documentos.
`parsing_config_overrides`	`map<string, ParsingConfig>` Mapeamento do tipo de arquivo para substituir a configuração de análise padrão com base no tipo de arquivo. Chaves compatíveis: `pdf`: substitui a configuração de análise para arquivos PDF. A análise digital, de OCR ou de layout é compatível. `html`: substitui a configuração de análise para arquivos HTML. Somente a análise digital e de layout são aceitas. `docx`: substitua a configuração de análise para arquivos DOCX. Somente a análise digital e de layout são compatíveis. `pptx`: substitui a configuração de análise para arquivos PPTX. Somente a análise digital e de layout são compatíveis. `xlsm`: substitui a configuração de análise de arquivos XLSM. Somente a análise digital e de layout são compatíveis. `xlsx`: substitui a configuração de análise para arquivos XLSX. Somente a análise digital e de layout são compatíveis.

ChunkingConfig

Configuração para a configuração de divisão.

Campos

Campo de união chunk_mode. Configurações adicionais que definem o comportamento do chunking. chunk_mode pode ser apenas de um dos tipos a seguir:

layout_based_chunking_config

Configuração para o chunking baseado em layout.

LayoutBasedChunkingConfig

Configuração para o chunking baseado em layout.

Campos

chunk_size

int32

O limite de tamanho de token para cada bloco.

Valores aceitos: de 100 a 500 (inclusive). Valor padrão: 500.

include_ancestor_headings

bool

Se é necessário incluir diferentes níveis de títulos em blocos do meio do documento para evitar a perda de contexto.

Valor padrão: 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` pode ser apenas de um dos tipos a seguir:
`digital_parsing_config`	`DigitalParsingConfig` Configurações aplicadas ao analisador digital.
`ocr_parsing_config`	`OcrParsingConfig` Configurações aplicadas ao analisador de OCR. No momento, isso só se aplica a PDFs.
`layout_parsing_config`	`LayoutParsingConfig` Configurações aplicadas ao analisador de layout.

DigitalParsingConfig

Esse tipo não tem campos.

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

LayoutParsingConfig

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

Campos
`enable_table_annotation`	`bool` Opcional. Se for verdadeiro, a anotação baseada em LLM será adicionada à tabela durante a análise.
`enable_image_annotation`	`bool` Opcional. Se for verdadeiro, a anotação baseada em LLM será adicionada à imagem durante a análise.
`structured_content_types[]`	`string` Opcional. Contém os tipos de estrutura necessários para extrair do documento. Valores aceitos: `shareholder-structure`
`exclude_html_elements[]`	`string` Opcional. Lista de elementos HTML a serem excluídos do conteúdo analisado.
`exclude_html_classes[]`	`string` Opcional. Lista de classes HTML a serem excluídas do conteúdo analisado.
`exclude_html_ids[]`	`string` Opcional. Lista de IDs HTML a serem excluídos do conteúdo analisado.
`enable_get_processed_document`	`bool` Opcional. Se for "true", o documento processado será disponibilizado para a API GetProcessedDocument.

OcrParsingConfig

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

Campos

enhanced_document_elements[]
(deprecated)

string

[DESCONTINUADO] O uso deste campo foi descontinuado. Para usar o processamento adicional de elementos de documentos otimizado, mude para layout_parsing_config.

use_native_text

bool

Se for verdadeiro, vai usar texto nativo em vez de texto de OCR em páginas que contêm texto nativo.

DoubleList

Lista dupla.

Campos

values[]

double

Valores duplos.

EnableAdvancedSiteSearchMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.EnableAdvancedSiteSearch. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

RecommendedForYouFeatureConfig

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

EnableAdvancedSiteSearchRequest

Solicite uma mensagem para o método SiteSearchEngineService.EnableAdvancedSiteSearch.

Campos

site_search_engine

string

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

EnableAdvancedSiteSearchResponse

Esse tipo não tem campos.

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

Mecanismo

Metadados que descrevem os parâmetros de treinamento e disponibilização de um Engine.

Campos
`name`	`string` Imutável. Identificador. O nome totalmente qualificado do recurso do mecanismo. Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres. Formato: o mecanismo `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` precisa ter de 1 a 63 caracteres, e os caracteres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`display_name`	`string` Obrigatório. O nome de exibição do mecanismo. Precisa ser legível. String codificada em UTF-8 com limite de 1.024 caracteres.
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora em que o Recommendation Engine foi criado.
`update_time`	`Timestamp` Apenas saída. Carimbo de data/hora da última atualização do Recommendation Engine.
`data_store_ids[]`	`string` Opcional. Os repositórios de dados associados a esse mecanismo. Para mecanismos do tipo `SOLUTION_TYPE_SEARCH` e `SOLUTION_TYPE_RECOMMENDATION`, é possível associar apenas um repositório de dados. Se `solution_type` for `SOLUTION_TYPE_CHAT`, vários `DataStore`s no mesmo `Collection` poderão ser associados aqui. Quando usado em `CreateEngineRequest`, um ID do DataStore precisa ser fornecido, já que o sistema o usa para inicializações necessárias.
`solution_type`	`SolutionType` Obrigatório. As soluções do mecanismo.
`industry_vertical`	`IndustryVertical` Opcional. O segmento do setor que o mecanismo registra. A restrição do segmento do setor de mecanismos é baseada em `DataStore`: o segmento do setor no mecanismo precisa corresponder ao segmento do setor do DataStore vinculado a ele.
`common_config`	`CommonConfig` Especificação de configuração comum que especifica os metadados do mecanismo.
`app_type`	`AppType` Opcional. Imutável. Este é o tipo de aplicativo que esse recurso do mecanismo representa. OBSERVAÇÃO: esse é um novo conceito independente do setor vertical ou tipo de solução atual.
`disable_analytics`	`bool` Opcional. Se a análise de pesquisas feitas nesse mecanismo deve ser desativada.
`features`	`map<string, FeatureState>` Opcional. Configuração de recursos para o mecanismo ativar ou desativar recursos. Chaves compatíveis: `*`: todos os recursos. Se estiver presente, todas as outras configurações de estado do recurso serã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 faturamento configurável.
Campo de união `engine_config`. Especificações de configuração adicionais que definem o comportamento do mecanismo. `engine_config` pode ser apenas de um dos tipos a seguir:
`chat_engine_config`	`ChatEngineConfig` Configurações do Chat Engine. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Configurações do mecanismo de pesquisa. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Configurações para o Media Engine. Aplicável apenas aos repositórios de dados com as categorias `solution_type` `SOLUTION_TYPE_RECOMMENDATION` e `IndustryVertical.MEDIA`.
Campo de união `engine_metadata`. Metadados do mecanismo para monitorar o status dele. `engine_metadata` pode ser apenas de um dos tipos a seguir:
`chat_engine_metadata`	`ChatEngineMetadata` Apenas saída. Outras informações sobre o Chat Engine. Aplicável apenas se `solution_type` for `SOLUTION_TYPE_CHAT`.

AppType

O app do mecanismo.

Tipos enumerados
`APP_TYPE_UNSPECIFIED`	Todos os apps não especificados.
`APP_TYPE_INTRANET`	Tipo de app para pesquisa na intranet e Agentspace.

ChatEngineConfig

Configurações para um mecanismo de chat.

Campos

agent_creation_config

AgentCreationConfig

A configuração para gerar o agente do Dialogflow associado a esse mecanismo.

Essas configurações são consumidas e transmitidas ao serviço do Dialogflow apenas uma vez. Isso significa que eles não podem ser recuperados usando a API EngineService.GetEngine ou EngineService.ListEngines após a criação do mecanismo.

dialogflow_agent_to_link

string

O nome do recurso de um agente do Dialogflow que será vinculado a este Chat Engine. Os clientes podem fornecer agent_creation_config para criar um agente ou um nome que o vincule ao mecanismo de chat.

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

Os dialogflow_agent_to_link são consumidos uma única vez e transmitidos ao serviço do Dialogflow. Isso significa que eles não podem ser recuperados usando a API EngineService.GetEngine ou EngineService.ListEngines após a criação do mecanismo. Use ChatEngineMetadata.dialogflow_agent para a associação real do agente depois que o mecanismo for criado.

allow_cross_region

bool

Opcional. Se a flag estiver definida como "true", o agente e o mecanismo poderão estar em locais diferentes. Caso contrário, eles precisam estar no mesmo local. Por padrão, a flag é definida como "false".

Observe que os allow_cross_region são consumidos uma única vez e transmitidos para EngineService.CreateEngine. Isso significa que eles não podem ser recuperados usando a API EngineService.GetEngine ou EngineService.ListEngines após a criação do mecanismo.

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 LLM do conector de conhecimento e para a pesquisa de conhecimento.
`default_language_code`	`string` Obrigatório. O idioma padrão do agente como uma tag de idioma. Para uma lista dos códigos de idioma compatíveis atualmente, consulte o Suporte de idioma.
`time_zone`	`string` Obrigatório. O fuso horário do agente do banco de dados de fuso horário, por exemplo, América/Nova_York, Europa/Paris.
`location`	`string` Local do agente para criação de agentes. Valores aceitos: global/us/eu. Se não for fornecido, o mecanismo dos EUA vai criar o agente usando "us-central-1" por padrão, e o mecanismo da UE vai criar o agente usando "eu-west-1" por padrão.

ChatEngineMetadata

Informações adicionais de um Chat Engine. Os campos nesta mensagem são somente saída.

Campos

dialogflow_agent

string

O nome do recurso de um agente do Dialogflow a que o Chat Engine se refere.

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

CommonConfig

Configurações comuns para um Engine.

Campos

company_name

string

O nome da empresa, do negócio ou da entidade associada ao mecanismo. Definir isso pode ajudar a melhorar os recursos relacionados ao LLM.

ConfigurableBillingApproach

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

Tipos enumerados
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor padrão. Para o Spark e a abordagem de faturamento não configurável que não é do Spark. Modelo de preços geral.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	A abordagem de faturamento segue as configurações especificadas pelo cliente.

FeatureState

O estado do recurso para o mecanismo.

Tipos enumerados
`FEATURE_STATE_UNSPECIFIED`	O estado do recurso não foi especificado.
`FEATURE_STATE_ON`	O recurso está ativado para ser acessível.
`FEATURE_STATE_OFF`	O recurso é desativado para ficar inacessível.

MediaRecommendationEngineConfig

Especificações de configuração adicionais para um mecanismo de recomendação de mídia.

Campos
`type`	`string` Obrigatório. O tipo de motor. Por exemplo, `recommended-for-you`. Esse campo, junto com `optimization_objective`, descreve os metadados do mecanismo a serem usados para controlar o treinamento e a veiculação do mecanismo. Valores aceitos no momento: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
`optimization_objective`	`string` O objetivo da otimização, por exemplo, `cvr`. Esse campo, junto com `optimization_objective`, descreve os metadados do mecanismo a serem usados para controlar o treinamento e a veiculação do mecanismo. Valores aceitos no momento: `ctr`, `cvr`. Se não for especificado, vamos escolher o padrão com base no tipo de mecanismo. O padrã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 cvr optimization_objective. Para target_field `watch-time`, target_field_value precisa ser um número inteiro que indica o tempo de progresso da mídia em segundos entre (0, 86400] (exclui 0, inclui 86400). Por exemplo, 90). Para target_field `watch-percentage`, o target_field_value precisa ser um valor de ponto flutuante válido entre (0, 1,0] (exclui 0, inclui 1,0) (por exemplo, 0,5).
`training_state`	`TrainingState` O estado de treinamento em que o mecanismo está (por exemplo, `TRAINING` ou `PAUSED`). Como parte do custo de execução do serviço é a frequência do treinamento, isso pode ser usado para determinar quando treinar o mecanismo e controlar o custo. Se não for especificado, o valor padrão para o método `CreateEngine` será `TRAINING`. O valor padrão do método `UpdateEngine` é manter o estado igual ao anterior.
`engine_features_config`	`EngineFeaturesConfig` Opcional. Configuração de recursos adicionais do mecanismo.

EngineFeaturesConfig

Mais configurações de recursos do tipo de mecanismo selecionado.

Campos

Campo de união type_dedicated_config. Configurações relacionadas a recursos aplicadas a um tipo específico de mecanismos de recomendação de mídia. type_dedicated_config pode ser apenas de um dos tipos a seguir:

recommended_for_you_config

Recomendado para a configuração de recursos do mecanismo.

most_popular_config

MostPopularFeatureConfig

Configuração do recurso de mecanismo mais popular.

MostPopularFeatureConfig

Configurações de recursos necessárias para criar um mecanismo "Mais populares".

Campos

time_window_days

int64

O período em que o mecanismo é consultado durante o treinamento e a previsão. Apenas números inteiros positivos. O valor corresponde aos eventos dos últimos X dias. Atualmente obrigatório para o mecanismo most-popular-items.

OptimizationObjectiveConfig

Limite personalizado para cvr optimization_objective.

Campos

target_field

string

Obrigatório. O nome do campo de destino. Valores aceitos no momento: watch-percentage, watch-time.

target_field_value_float

float

Obrigatório. O limite a ser aplicado à meta (por exemplo, 0,5).

RecommendedForYouFeatureConfig

Configurações de recursos adicionais para criar um mecanismo recommended-for-you.

Campos

context_event_type

string

O tipo de evento com que o mecanismo é consultado no momento da previsão. Se definido como generic, apenas view-item, media-play e media-complete serão usados como context-event no treinamento do mecanismo. Se definido como view-home-page, view-home-page também será usado como context-events, além de view-item, media-play e media-complete. No momento, compatível com o mecanismo recommended-for-you. Valores aceitos no momento: view-home-page, generic.

TrainingState

O estado de treinamento do mecanismo.

Tipos enumerados
`TRAINING_STATE_UNSPECIFIED`	Estado de treinamento não especificado.
`PAUSED`	O treinamento do mecanismo está pausado.
`TRAINING`	O mecanismo está em treinamento.

SearchEngineConfig

Configurações para um mecanismo de pesquisa.

Campos

search_tier

SearchTier

O nível do recurso de pesquisa deste mecanismo.

Os preços podem variar de acordo com o nível. Para saber mais, consulte a documentação de preços.

O padrão é SearchTier.SEARCH_TIER_STANDARD se não for especificado.

search_add_ons[]

SearchAddOn

O complemento que esse mecanismo de pesquisa ativa.

FactChunk

Bloco de fatos.

Campos
`chunk_text`	`string` Conteúdo de texto do trecho de fato. Pode ter no máximo 10 mil caracteres.
`source`	`string` Origem de onde este trecho de fato foi extraído. Se ele foi extraído das GroundingFacts fornecidas na solicitação, esse campo vai conter o índice do fato específico de onde o trecho foi extraído.
`index`	`int32` O índice deste trecho. No momento, usado apenas 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

Solicite uma mensagem para o método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

site_search_engine

string

Obrigatório. O recurso do mecanismo de pesquisa do site em que buscamos todo o status de verificação do domínio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Tamanho da página solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o servidor escolherá um padrão apropriado. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.

page_token

string

Um token de página recebido de uma chamada FetchDomainVerificationStatus anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para FetchDomainVerificationStatus precisam 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 status da verificação do site.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

total_size

int32

O número total de itens que correspondem à solicitação. Isso sempre será preenchido na resposta.

FetchSitemapsRequest

Solicite uma mensagem para o método SiteSearchEngineService.FetchSitemaps.

Campos

parent

string

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

matcher

Matcher

Opcional. Se especificado, busca os Sitemaps correspondentes. Se não for especificado, vai buscar todos os Sitemaps no DataStore.

Matcher

Matcher para os Sitemaps. No momento, só há suporte para o matcher de URIs.

Campos

Campo de união matcher. Matcher para os Sitemaps. matcher pode ser apenas de um dos tipos a seguir:

uris_matcher

UrisMatcher

Matcher por URIs de sitemap.

UrisMatcher

Matcher para os Sitemaps pelas URIs.

Campos

uris[]

string

Os URIs do Sitemap.

FetchSitemapsResponse

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

Campos

sitemaps_metadata[]

SitemapMetadata

Lista de Sitemaps buscados.

SitemapMetadata

Contém um Sitemap e os metadados dele.

Campos

sitemap

Sitemap

O Sitemap.

FhirStoreSource

De onde os dados de importação de origem do Cloud FhirStore vêm.

Campos
`fhir_store`	`string` Obrigatório. O nome completo do recurso do armazenamento de FHIR de onde os dados serão importados, no formato `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Diretório intermediário do Cloud Storage usado para importação com um limite de 2.000 caracteres. Pode ser especificado se você quiser que o FhirStore exporte para um diretório específico do Cloud Storage.
`resource_types[]`	`string` Os tipos de recursos FHIR a serem importados. Os tipos de recursos precisam ser um subconjunto de todos os tipos de recursos FHIR compatíveis. O padrão é todos os tipos de recursos FHIR compatíveis se estiver vazio.
`update_from_latest_predefined_schema`	`bool` Opcional. Se o esquema do DataStore será atualizado para o esquema predefinido mais recente. Se for "true", o esquema do DataStore será atualizado para incluir todos os campos ou tipos de recursos FHIR adicionados desde a última importação, e os recursos FHIR correspondentes serão importados do armazenamento FHIR. Não é possível usar esse campo com `resource_types`. Ele deve ser usado após a importação inicial.

FirestoreSource

Origem do Firestore de onde os dados serão importados.

Campos
`project_id`	`string` O ID do projeto em que a origem do Cloud SQL está, com um limite de 128 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`database_id`	`string` Obrigatório. O banco de dados do Firestore de onde os dados serão copiados, com um limite de 256 caracteres.
`collection_id`	`string` Obrigatório. A coleção (ou entidade) do Firestore de onde os dados serão copiados,com um limite de 1.500 caracteres.
`gcs_staging_dir`	`string` Diretório intermediário do Cloud Storage usado para importação com um limite de 2.000 caracteres. Pode ser especificado se você quiser que o Firestore exporte para um diretório específico do Cloud Storage. Verifique se a conta de serviço do Firestore tem as permissões de administrador do Cloud Storage necessárias para acessar o diretório especificado do Cloud Storage.

GcsSource

Local do Cloud Storage para o conteúdo de entrada.

Campos

input_uris[]

string

Obrigatório. URIs do Cloud Storage para arquivos de entrada. Cada URI pode ter até 2.000 caracteres. 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 arquivos, como gs://bucket/directory/*.json.

Uma solicitação pode conter no máximo 100 arquivos (ou 100.000 arquivos se data_schema for content). Cada arquivo pode ter até 2 GB (ou 100 MB se data_schema for content).

data_schema

string

O esquema a ser usado ao analisar os dados da origem.

Valores aceitos para importações de documentos:

document (padrão): um Document JSON por linha. Cada documento precisa ter um Document.id válido.
content: dados não estruturados (por exemplo, PDF, HTML). Cada arquivo correspondente a input_uris se torna um documento, com o ID definido como os primeiros 128 bits de SHA256(URI) codificados como uma string hexadecimal.
custom: um JSON de dados personalizados por linha em formato arbitrário que está de acordo com o Schema definido do repositório de dados. Só pode ser usado pela vertical GENERIC do repositório de dados.
csv: um arquivo CSV com cabeçalho de acordo com o Schema definido do repositório de dados. Cada entrada após o cabeçalho é importada como um documento. Só pode ser usado pela categoria GENERIC do repositório de dados.

Valores aceitos para importações de eventos do usuário:

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

GetAclConfigRequest

Mensagem de solicitação 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 permissão para acessar o AclConfig, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

GetAnswerRequest

Solicitação para o método GetAnswer.

Campos

name

string

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

GetAssistAnswerRequest

Mensagem de solicitação 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 solicitação 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 solicitação 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 permissão para acessar o CmekConfig, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

GetControlRequest

Solicitação para o método "GetControl".

Campos

name

string

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

GetConversationRequest

Solicitação para o método "GetConversation".

Campos

name

string

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

GetDataConnectorRequest

Solicitação 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 permissão para acessar o DataConnector, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o DataConnector solicitado não existir, um erro NOT_FOUND será retornado.

GetDataStoreRequest

Solicite uma mensagem 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 permissão para acessar o DataStore, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o DataStore solicitado não existir, um erro NOT_FOUND será retornado.

GetDocumentRequest

Solicite uma mensagem 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 permissão para acessar o Document, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Document solicitado não existir, um erro NOT_FOUND será retornado.

GetEngineRequest

Solicite uma mensagem 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

Mensagem de solicitação para IdentityMappingStoreService.GetIdentityMappingStore

Campos

name

string

Obrigatório. O nome do Identity Mapping Store a ser recebido. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Solicite uma mensagem 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 permissão para acessar o LicenseConfig, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o LicenseConfig solicitado não existir, um erro NOT_FOUND será retornado.

GetSchemaRequest

Solicite uma mensagem 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

Solicitação para o método "GetSession".

Campos

name

string

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

include_answer_details

bool

Opcional. Se definido como verdadeiro, a sessão completa, incluindo todos os detalhes da resposta, será retornada.

GetSiteSearchEngineRequest

Solicite uma mensagem 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 usuário não tiver permissão para acessar o [SiteSearchEngine], independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

GetTargetSiteRequest

Solicite uma mensagem 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 permissão para acessar o TargetSite, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o TargetSite solicitado não existir, um erro NOT_FOUND será retornado.

GroundingFact

Fato.

Campos

fact_text

string

Conteúdo de texto do fato. Pode ter no máximo 10 mil caracteres.

attributes

map<string, string>

Atributos associados ao fato. Os atributos comuns incluem source (indicando de onde o fato foi extraído), author (indicando o autor do fato) e assim por diante.

HarmCategory

Categorias de danos que bloqueiam o conteúdo.

Tipos enumerados
`HARM_CATEGORY_UNSPECIFIED`	A categoria de danos não foi especificada.
`HARM_CATEGORY_HATE_SPEECH`	A categoria de danos é discurso de ódio.
`HARM_CATEGORY_DANGEROUS_CONTENT`	A categoria de danos é um conteúdo perigoso.
`HARM_CATEGORY_HARASSMENT`	A categoria de dano é assédio.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	A categoria de dano é conteúdo sexualmente explícito.
`HARM_CATEGORY_CIVIC_INTEGRITY`	A categoria de dano é integridade cívica.

HealthcareFhirConfig

Configuração para repositório de dados da categoria HEALTHCARE_FHIR.

Campos

enable_configurable_schema

bool

Se o esquema configurável para a vertical HEALTHCARE_FHIR está ativado.

Se definido como true, o esquema FHIR de saúde predefinido poderá ser estendido para uma pesquisa e filtragem mais personalizadas.

enable_static_indexing_for_batch_ingestion

bool

Define se a indexação estática para a ingestão em lote de HEALTHCARE_FHIR será ativada.

Se definido como true, a ingestão em lote será processada em um modo de indexação estática, que é mais lento, mas mais capaz de lidar com volumes maiores.

IdentityMappingEntry

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

Campos
`external_identity`	`string` Obrigatório. Identidade fora do provedor de identidade do cliente. O limite de comprimento da identidade externa é de 100 caracteres.
Campo de união `identity_provider_id`. Campo de união identity_provider_id. O ID do provedor de identidade pode ser um usuário ou um grupo. `identity_provider_id` pode ser apenas de um dos tipos a seguir:
`user_id`	`string` Identificador do usuário. Para contas de usuário do Google Workspace, o user_id precisa ser o e-mail do usuário do Google Workspace. Para provedores de identidade que não são do Google, o user_id é o identificador de usuário mapeado configurado durante a configuração do pool de colaboradores.
`group_id`	`string` Identificador do grupo. Para contas de usuário do Google Workspace, group_id precisa ser o e-mail do grupo do Google Workspace. Para provedores de identidade que não são do Google, "group_id" é o identificador de grupo mapeado configurado durante a configuração do pool de colaboradores.

IdentityMappingEntryOperationMetadata

Metadados de IdentityMappingEntry LongRunningOperation para IdentityMappingStoreService.ImportIdentityMappings e IdentityMappingStoreService.PurgeIdentityMappings

Campos

success_count

int64

O número de IdentityMappingEntries processados com sucesso.

failure_count

int64

O número de IdentityMappingEntries que não foram processados.

total_count

int64

O número total de IdentityMappingEntries processados.

IdentityMappingStore

Armazenamento de mapeamento de identidade que contém entradas de mapeamento de identidade.

Campos

name

string

Imutável. O nome completo do recurso do armazenamento de mapeamento de identidade. Formato: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Este campo precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.

kms_key_name

string

Somente entrada. A chave do KMS a ser usada para proteger esse repositório de mapeamento de identidade no momento da criação.

Precisa ser definido para solicitações que precisam obedecer às proteções da política da organização da CMEK.

Se esse campo for definido e processado com sucesso, o armazenamento de mapeamento de identidade será protegido pela chave do KMS, conforme indicado no campo "cmek_config".

cmek_config

CmekConfig

Apenas saída. Informações relacionadas à CMEK para o Identity Mapping Store.

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 controle de acesso dos documentos ingeridos por esse conector. Se não for definida, a lista de controle de acesso será atualizada no intervalo padrão de 30 minutos. O intervalo de atualização da identidade pode ser de no mínimo 30 minutos e no máximo 7 dias.

next_sync_time

DateTime

Opcional. O horário UTC em que a próxima sincronização de dados deve começar para o conector de dados. Os clientes só podem especificar a hora e o minuto para programar a sincronização de dados. Isso é usado quando o conector de dados tem um intervalo de atualização maior que um dia.

IdpConfig

Configuração do provedor de identidade.

Campos

idp_type

IdpType

Tipo de provedor de identidade configurado.

external_idp_config

ExternalIdpConfig

Configuração do provedor de identidade externo.

ExternalIdpConfig

Configuração de IdP de terceiros.

Campos

workforce_pool_name

string

Nome do pool de força de trabalho. Exemplo: "locations/global/workforcePools/pool_id"

IdpType

Tipo de provedor de identidade.

Tipos enumerados
`IDP_TYPE_UNSPECIFIED`	Valor padrão. A pesquisa de ACL não está ativada.
`GSUITE`	Provedor de dados próprios do Google.
`THIRD_PARTY`	Provedor terceirizado.

ImportCompletionSuggestionsMetadata

Metadados relacionados ao progresso da operação "ImportCompletionSuggestions". Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Contagem de `CompletionSuggestion`s importados com sucesso.
`failure_count`	`int64` Contagem de `CompletionSuggestion`s que não foram importados.

ImportCompletionSuggestionsRequest

Solicite uma mensagem para o método CompletionService.ImportCompletionSuggestions.

Campos
`parent`	`string` Obrigatório. O nome do recurso do repositório de dados principal para importar sugestões de preenchimento automático de clientes. Segue o padrão `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` O local desejado dos erros ocorridos durante a importação.
Campo de união `source`. A origem das sugestões de preenchimento automático. `source` pode ser apenas de um dos tipos a seguir:
`inline_source`	`InlineSource` A origem inline para entradas de sugestão.
`gcs_source`	`GcsSource` Local 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 bloqueio a serem importadas. Máximo de 1.000 itens.

ImportCompletionSuggestionsResponse

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

Campos

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

error_config

ImportErrorConfig

O local desejado dos erros ocorridos durante a importação.

ImportDocumentsMetadata

Metadados relacionados ao progresso da operação "ImportDocuments". Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Contagem de entradas processadas com sucesso.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.
`total_count`	`int64` Contagem total de entradas processadas.

ImportDocumentsRequest

Mensagem de solicitação 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 permissão de criação/atualização.
`error_config`	`ImportErrorConfig` O local desejado dos erros ocorridos durante a importação.
`reconciliation_mode`	`ReconciliationMode` O modo de conciliação entre os documentos atuais e os que serão importados. O valor padrão é `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indica quais campos dos documentos importados fornecidos precisam ser atualizados. Se não for definido, o padrão será atualizar todos os campos.
`auto_generate_ids`	`bool` Se os IDs dos documentos serão gerados automaticamente se estiverem ausentes. Se definido como `true`, os `Document.id`s serão gerados automaticamente com base no hash da carga útil, e os IDs poderão não ser consistentes durante várias importações. Nesse caso, é altamente recomendável usar `ReconciliationMode.FULL` para evitar conteúdo duplicado. Se não for definido ou for definido como `false`, os `Document.id`s precisarão ser especificados usando `id_field`. Caso contrário, os documentos sem IDs não serão importados. Fontes de dados compatíveis: `GcsSource`. `GcsSource.data_schema` precisa ser `custom` ou `csv`. Caso contrário, um erro INVALID_ARGUMENT será gerado. `BigQuerySource`. `BigQuerySource.data_schema` precisa ser `custom` ou `csv`. Caso contrário, um erro INVALID_ARGUMENT será gerado. `SpannerSource`. `CloudSqlSource` `FirestoreSource` `BigtableSource`.
`id_field`	`string` O campo indica o campo ou a coluna de ID a ser usada como IDs exclusivos 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 em que os IDs exclusivos são armazenados. Os valores do campo JSON ou da coluna da tabela são usados como `Document.id`s. O campo JSON ou a coluna da tabela precisa ser do tipo string, e os valores precisam ser definidos como strings válidas de acordo com a RFC-1034 com 1 a 63 caracteres. Caso contrário, os documentos sem IDs válidos não serão importados. Defina este campo apenas quando `auto_generate_ids` não estiver definido ou estiver definido como `false`. Caso contrário, um erro INVALID_ARGUMENT será gerado. Se não estiver definido, um valor padrão `_id` será usado ao importar das fontes de dados permitidas. Fontes de dados compatíveis: `GcsSource`. `GcsSource.data_schema` precisa ser `custom` ou `csv`. Caso contrário, um erro INVALID_ARGUMENT será gerado. `BigQuerySource`. `BigQuerySource.data_schema` precisa ser `custom` ou `csv`. Caso contrário, um erro INVALID_ARGUMENT será gerado. `SpannerSource`. `CloudSqlSource` `BigtableSource`.
`force_refresh_content`	`bool` Opcional. Define se o conteúdo não estruturado dos documentos será atualizado à força. Se definido como `true`, a parte de conteúdo dos documentos será atualizada, independente do status de atualização do conteúdo referenciado.
Campo de união `source`. Obrigatório. A origem da entrada. `source` pode ser apenas de um dos tipos a seguir:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para documentos.
`gcs_source`	`GcsSource` Local do Cloud Storage para o conteúdo de entrada.
`bigquery_source`	`BigQuerySource` Origem de entrada do BigQuery.
`fhir_store_source`	`FhirStoreSource` Origem da 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 para atualizar/criar. Cada documento precisa ter um Document.id válido. Máximo recomendado de 100 itens.

ReconciliationMode

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

Tipos enumerados
`RECONCILIATION_MODE_UNSPECIFIED`	O valor padrão é `INCREMENTAL`.
`INCREMENTAL`	Insere novos documentos ou atualiza os existentes.
`FULL`	Calcula a diferença e substitui todo o conjunto de dados de documentos. Os documentos atuais podem ser excluídos se não estiverem no local de origem. Ao usar esse modo, não haverá tempo de inatividade no conjunto de dados segmentado. Qualquer documento que deva permanecer inalterado ou que precise ser atualizado vai continuar sendo veiculado enquanto a operação estiver em execução.

ImportDocumentsResponse

Resposta do ImportDocumentsRequest. Se a operação de longa duração for concluída, essa mensagem será retornada pelo campo google.longrunning.Operations.response se a operação for bem-sucedida.

Campos

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

error_config

ImportErrorConfig

Reflete o destino dos erros completos na solicitação, se definido.

ImportErrorConfig

Configuração do destino para erros relacionados à importação.

Campos

Campo de união destination. Obrigatório. Destino de erros. destination pode ser apenas de um dos tipos a seguir:

gcs_prefix

string

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

ImportIdentityMappingsRequest

Mensagem de solicitação para IdentityMappingStoreService.ImportIdentityMappings

Campos

identity_mapping_store

string

Obrigatório. O nome do armazenamento de mapeamento de identidade para importar entradas de mapeamento de identidade. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Campo de união source. A origem da entrada. source pode ser apenas de um dos tipos a seguir:

inline_source

InlineSource

A fonte in-line de onde as entradas de mapeamento de identidade serão importadas.

InlineSource

A fonte in-line de onde as entradas de mapeamento de identidade serão importadas.

Campos

identity_mapping_entries[]

IdentityMappingEntry

É possível importar até 10.000 entradas por vez

ImportIdentityMappingsResponse

Mensagem de resposta para IdentityMappingStoreService.ImportIdentityMappings.

Campos

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

ImportSuggestionDenyListEntriesMetadata

Metadados relacionados ao progresso da operação "ImportSuggestionDenyListEntries". Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

SuggestionDenyListEntry

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

ImportSuggestionDenyListEntriesRequest

Solicite uma mensagem para o método CompletionService.ImportSuggestionDenyListEntries.

Campos
`parent`	`string` Obrigatório. O nome do recurso de repositório de dados pai para importar entradas da lista de bloqueio. Segue o padrão projects//locations//collections//dataStores/.
Campo de união `source`. A origem da SuggestionDenyList atualizada. `source` pode ser apenas de um dos tipos a seguir:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para entradas da lista de bloqueio de sugestões.
`gcs_source`	`GcsSource` Local do Cloud Storage para o conteúdo de entrada. Só é possível especificar um arquivo que contenha todas as entradas a serem importadas. Valores compatíveis `gcs_source.schema` para importações de entradas da lista de bloqueio de sugestões de preenchimento automático: `suggestion_deny_list` (padrão): um [SuggestionDenyListEntry] JSON por linha.

InlineSource

A origem in-line para SuggestionDenyListEntry.

Campos

entries[]

Obrigatório. Uma lista de todas as entradas da lista de bloqueio a serem importadas. Máximo de 1.000 itens.

ImportSuggestionDenyListEntriesResponse

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

Campos

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

imported_entries_count

int64

Contagem de entradas da lista de bloqueio importadas com sucesso.

failed_entries_count

int64

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

ImportUserEventsMetadata

Metadados relacionados ao progresso da operação de importação. Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Contagem de entradas processadas com sucesso.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.

ImportUserEventsRequest

Mensagem de solicitação para o pedido "ImportUserEvents".

Campos
`parent`	`string` Obrigatório. Nome do recurso pai do DataStore, no formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` O local desejado dos erros ocorridos durante a importação. Não pode ser definido para importações in-line de eventos de usuário.
Campo de união `source`. Obrigatório: a origem de entrada desejada dos dados de eventos do usuário. `source` pode ser apenas de um dos tipos a seguir:
`inline_source`	`InlineSource` A origem inline do conteúdo de entrada para UserEvents.
`gcs_source`	`GcsSource` Local do Cloud Storage para o conteúdo de entrada.
`bigquery_source`	`BigQuerySource` Origem de entrada do BigQuery.

InlineSource

A origem inline para a configuração de entrada do método "ImportUserEvents".

Campos

user_events[]

UserEvent

Obrigatório. Uma lista de eventos do usuário para importar. Máximo recomendado de 10 mil itens.

ImportUserEventsResponse

Resposta do ImportUserEventsRequest. Se a operação de longa duração for bem-sucedida, essa mensagem será retornada pelo campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Uma amostra de erros encontrados ao processar a solicitação.
`error_config`	`ImportErrorConfig` Reflete o destino dos erros completos se esse campo foi definido na solicitação.
`joined_events_count`	`int64` Contagem de eventos de usuário importados com documentos completos.
`unjoined_events_count`	`int64` Contagem de eventos de usuário importados, mas com informações de documento não encontradas na ramificação atual.

IndustryVertical

O segmento do setor associado ao DataStore.

Tipos enumerados
`INDUSTRY_VERTICAL_UNSPECIFIED`	Valor usado quando não definido.
`GENERIC`	O segmento genérico para documentos que não são específicos de nenhum segmento do setor.
`MEDIA`	O segmento do setor de mídia.
`HEALTHCARE_FHIR`	O setor de FHIR da área da saúde.

Intervalo

Um intervalo de ponto flutuante.

Campos

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

Caso contrário, um erro INVALID_ARGUMENT será retornado. min pode ser apenas de um dos tipos a seguir:

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 de máximo for definido, o limite superior será infinito positivo.

Esse campo não pode ser menor que o valor mínimo. Caso contrário, um erro INVALID_ARGUMENT será retornado. max pode ser apenas de um dos tipos a seguir:

maximum

double

Limite superior inclusivo.

exclusive_maximum

double

Limite superior exclusivo.

LicenseConfig

Informações sobre as licenças dos usuários.

Campos
`name`	`string` Imutável. Identificador. O nome totalmente qualificado do recurso da configuração de 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 assinatura para a configuração de licença.
`state`	`State` Apenas saída. O estado da configuração de licença.
`auto_renew`	`bool` Opcional. Indica se a configuração de licença deve ser renovada automaticamente quando atingir a data de término.
`start_date`	`Date` Obrigatório. A data de início.
`end_date`	`Date` Opcional. A data de término planejada.
`subscription_term`	`SubscriptionTerm` Obrigatório. Vigência da assinatura.
`free_trial`	`bool` Opcional. Indica se a configuração de licença é para um teste sem custos financeiros.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Opcional. A configuração da política de alertas para esta configuração de licença.
`gemini_bundle`	`bool` Apenas saída. Se a configuração de licença é para o pacote do Gemini.

Estado

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

Tipos enumerados
`STATE_UNSPECIFIED`	Valor padrão. A configuração de licença não existe.
`ACTIVE`	A configuração da licença está em vigor e sendo usada.
`EXPIRED`	A configuração da licença expirou.
`NOT_STARTED`	A configuração de licença ainda não começou, e a data de início é no futuro.

ListAssistantsRequest

Mensagem de solicitação para o método AssistantService.ListAssistants.

Campos

parent

string

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

page_size

int32

Número máximo de Assistants a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores maiores serão convertidos para 1.000.

page_token

string

Um token de página ListAssistantsResponse.next_page_token recebido de uma chamada AssistantService.ListAssistants anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListAssistants precisam 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 recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListCmekConfigsRequest

Solicite uma mensagem para o método CmekConfigService.ListCmekConfigs.

Campos

parent

string

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

Se o autor da chamada não tiver permissão para listar CmekConfigs nesse local, independente de existir ou não um CmekConfig, um erro PERMISSION_DENIED será retornado.

ListCmekConfigsResponse

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

Campos

cmek_configs[]

CmekConfig

Todos os CmekConfigs do cliente.

ListControlsRequest

Solicitação para o método "ListControls".

Campos
`parent`	`string` Obrigatório. O nome do recurso do repositório 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 serem retornados. Se não for especificado, o padrão será 50. O valor máximo permitido é 1000.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada `ListControls` anterior. Forneça isso para recuperar a página subsequente.
`filter`	`string` Opcional. Um filtro a ser aplicado nos resultados da lista. Recursos compatíveis: Liste todos os produtos na ramificação principal se `filter` não estiver definido. No momento, esse campo não é compatível.

ListControlsResponse

Resposta para o método "ListControls".

Campos

controls[]

Control

Todos os controles de um determinado repositório de dados.

next_page_token

string

Token de paginação. Se não for retornado, indica a última página.

ListConversationsRequest

Solicitação para o método "ListConversations".

Campos
`parent`	`string` Obrigatório. O nome do recurso do repositório de dados. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados a serem retornados. Se não for especificado, o padrão será 50. O valor máximo permitido é 1000.
`page_token`	`string` Um token de página recebido de uma chamada `ListConversations` anterior. Forneça isso para recuperar a página subsequente.
`filter`	`string` Um filtro a ser aplicado nos resultados da lista. Os recursos compatíveis são: user_pseudo_id, state. Exemplo: "user_pseudo_id = some_id"
`order_by`	`string` Uma lista separada por vírgulas de campos para ordenar, classificados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente. Campos aceitos: * `update_time` * `create_time` * `conversation_name` Exemplo: "update_time desc" "create_time"

ListConversationsResponse

Resposta para o método "ListConversations".

Campos

conversations[]

Todas as conversas de um determinado repositório de dados.

next_page_token

string

Token de paginação. Se não for retornado, indica a última página.

ListCustomModelsRequest

Solicite uma mensagem para o método SearchTuningService.ListCustomModels.

Campos

data_store

string

Obrigatório. O nome do recurso do repositório de dados pai, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Esse campo é usado para identificar o repositório de dados de onde os modelos serão extraídos.

ListCustomModelsResponse

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

Campos

models[]

CustomTuningModel

Lista de modelos personalizados.

ListDataStoresRequest

Solicite uma mensagem 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 permissão para listar `DataStore`s nesse local, independente de o repositório de dados existir ou não, um erro PERMISSION_DENIED será retornado.
`page_size`	`int32` Número máximo de `DataStore`s a serem retornados. Se não for especificado, o padrão será 10. O valor máximo permitido é 50. Valores acima de 50 serão convertidos para 50. Se esse campo for negativo, um INVALID_ARGUMENT será retornado.
`page_token`	`string` Um token de página `ListDataStoresResponse.next_page_token` recebido de uma chamada `DataStoreService.ListDataStores` anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para `DataStoreService.ListDataStores` precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`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 recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListDocumentsRequest

Solicite uma mensagem 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 o ID da ramificação para listar documentos na ramificação padrão.

Se o autor da chamada não tiver permissão para listar Documents nessa ramificação, independente de ela existir ou não, um erro PERMISSION_DENIED será retornado.

page_size

int32

Número máximo de Documents a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima de 1.000 são definidos como 1.000.

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.

page_token

string

Um token de página ListDocumentsResponse.next_page_token recebido de uma chamada DocumentService.ListDocuments anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para DocumentService.ListDocuments precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.

ListDocumentsResponse

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

Campos

documents[]

Os Documents.

next_page_token

string

Um token que pode ser enviado como ListDocumentsRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListEnginesRequest

Solicite uma mensagem para o método EngineService.ListEngines.

Campos
`parent`	`string` Obrigatório. O nome do recurso pai, como `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Opcional. Incompatível.
`page_token`	`string` Opcional. Incompatível.
`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

Incompatível.

ListIdentityMappingStoresRequest

Mensagem de solicitação para IdentityMappingStoreService.ListIdentityMappingStores

Campos

parent

string

Obrigatório. O pai dos repositórios de mapeamento de identidades a serem listados. Formato: projects/{project}/locations/{location}.

page_size

int32

Número máximo de IdentityMappingStores a serem retornados. Se não for especificado, o padrão será 100. O valor máximo permitido é 1.000. Valores acima de 1.000 serão convertidos para 1.000.

page_token

string

Um token de página recebido de uma chamada ListIdentityMappingStores anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListIdentityMappingStores precisam corresponder à chamada que forneceu o token da página.

ListIdentityMappingStoresResponse

Mensagem de resposta para IdentityMappingStoreService.ListIdentityMappingStores.

Campos

identity_mapping_stores[]

IdentityMappingStore

Os repositórios de mapeamento de identidade.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListIdentityMappingsRequest

Mensagem de solicitação para IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_store

string

Obrigatório. O nome do armazenamento de mapeamento de identidade em que as entradas de mapeamento de identidade serão listadas. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Número máximo de IdentityMappings a serem retornados. Se não for especificado, o padrão será 2.000. O valor máximo permitido é 10.000. Valores acima de 10.000 serão convertidos para 10.000.

page_token

string

Um token de página recebido de uma chamada ListIdentityMappings anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListIdentityMappings precisam 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 de identidade.

next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSchemasRequest

Solicite uma mensagem para o método SchemaService.ListSchemas.

Campos

parent

string

Obrigatório. O nome do recurso da repositório 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 serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo 100 Schemas serão retornados.

O valor máximo é 1.000. Valores acima de 1.000 são definidos como 1.000.

page_token

string

Um token de página recebido de uma chamada SchemaService.ListSchemas anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para SchemaService.ListSchemas precisam corresponder à chamada que forneceu o token da página.

ListSchemasResponse

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

Campos

schemas[]

Schema

Os Schemas.

next_page_token

string

Um token que pode ser enviado como ListSchemasRequest.page_token para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

ListSessionsRequest

Solicitação para o método "ListSessions".

Campos
`parent`	`string` Obrigatório. O nome do recurso do repositório de dados. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados a serem retornados. Se não for especificado, o padrão será 50. O valor máximo permitido é 1000.
`page_token`	`string` Um token de página recebido de uma chamada `ListSessions` anterior. Forneça isso para recuperar a página subsequente.
`filter`	`string` Uma lista separada por vírgulas de campos para filtrar, na gramática EBNF. Os campos aceitos 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 para ordenar, classificados em ordem crescente. Use "desc" depois de um nome de campo para ordem decrescente. Campos compatíveis: `update_time` `create_time` `session_name` `is_pinned` Exemplo: `update_time desc` `create_time` `is_pinned desc,update_time desc`: lista as sessões primeiro por is_pinned e depois por update_time.

ListSessionsResponse

Resposta para o método ListSessions.

Campos

sessions[]

Todas as sessões de um determinado repositório de dados.

next_page_token

string

Token de paginação. Se não for retornado, indica a última página.

ListTargetSitesRequest

Solicite uma mensagem para o método SiteSearchEngineService.ListTargetSites.

Campos

parent

string

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

Se o autor da chamada não tiver permissão para listar TargetSites nesse mecanismo de pesquisa do site, independente de a ramificação existir ou não, um erro PERMISSION_DENIED será retornado.

page_size

int32

Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.

page_token

string

Um token de página recebido de uma chamada ListTargetSites anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para ListTargetSites precisam 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 recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

total_size

int32

O número total de itens que correspondem à solicitação. Isso sempre será preenchido na resposta.

ListUserLicensesRequest

Mensagem de solicitação 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 solicitada. O servidor pode retornar menos resultados do que o solicitado. Se não for especificado, o padrão será 10. O valor máximo é 50. Valores acima disso serão convertidos para 50. Se esse campo for negativo, um erro INVALID_ARGUMENT será retornado.
`page_token`	`string` Opcional. Um token de página recebido de uma chamada `ListUserLicenses` anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para `ListUserLicenses` precisam corresponder à chamada que forneceu o token da página.
`filter`	`string` Opcional. Filtro para a solicitação de lista. Campos compatíveis: `license_assignment_state` Exemplos: `license_assignment_state = ASSIGNED` para listar as licenças de usuário atribuídas. `license_assignment_state = NO_LICENSE` para listar usuários sem licença. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` para listar usuários que tentaram fazer login, mas não têm uma licença atribuída. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` para filtrar usuários que tentaram fazer login, 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 recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

MediaInfo

Informações de eventos do usuário específicas da mídia.

Campos

media_progress_duration

Duration

O tempo de progresso da mídia em segundos, se aplicável. Por exemplo, se o usuário final tiver terminado 90 segundos de um vídeo de reprodução, MediaInfo.media_progress_duration.seconds deverá ser definido como 90.

media_progress_percentage

float

O progresso da mídia deve ser calculado usando apenas o media_progress_duration em relação à duração total da mídia.

Esse valor precisa estar entre [0, 1.0], inclusive.

Se não for uma reprodução ou se o progresso não puder ser calculado (por exemplo, uma transmissão ao vivo em andamento), esse campo não deve ser definido.

PageInfo

Informações detalhadas da página.

Campos
`pageview_id`	`string` Um ID exclusivo de uma visualização de página da Web. Isso precisa ser mantido igual para todos os eventos de usuário acionados na mesma visualização de página. Por exemplo, uma visualização de página de detalhes do item pode acionar vários eventos enquanto o usuário navega pela página. A propriedade `pageview_id` precisa ser mantida a mesma para todos esses eventos, de modo que eles possam ser agrupados corretamente. Ao usar a geração de relatórios de eventos do lado do cliente com o pixel JavaScript e o Gerenciador de tags do Google, esse 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 diferentes hierarquias. Se ">" fizer parte do nome da categoria, substitua por outros caracteres. As páginas de categoria incluem páginas especiais, como vendas ou promoções. Por exemplo, uma página de promoção especial pode ter a hierarquia de categorias: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Obrigatório para eventos `view-category-page`. Outros tipos de eventos não devem definir esse campo. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`uri`	`string` URL completo (window.location.href) da página atual do usuário. Ao usar a geração de relatórios de eventos do lado do cliente com o pixel JavaScript e o Gerenciador de tags do Google, esse valor é preenchido automaticamente. O tamanho máximo é de 5.000 caracteres.
`referrer_uri`	`string` O URL de indicação da página atual. Ao usar a geração de relatórios de eventos do lado do cliente com o pixel JavaScript e o Gerenciador de tags do Google, esse valor é preenchido automaticamente. No entanto, algumas restrições de privacidade do navegador podem fazer com que esse campo fique vazio.

PanelInfo

Informações detalhadas do painel associadas a um evento do usuário.

Campos
`panel_id`	`string` Obrigatório. O ID do painel.
`display_name`	`string` O nome de exibição do painel.
`documents[]`	`DocumentInfo` Opcional. Os IDs de documento associados a este painel.
`panel_position`	`int32` A posição ordenada do painel, se ele for mostrado ao usuário com outros painéis. Se definido, `total_panels` também precisa ser definido.
`total_panels`	`int32` O número total de painéis, incluindo este, mostrados ao usuário. Precisa ser definido se `panel_position` estiver definido.

Principal

Identificador principal de um usuário ou grupo.

Campos
Campo de união `principal`. Campo principal da união. O principal pode ser um usuário ou um grupo. `principal` pode ser apenas de um dos tipos a seguir:
`user_id`	`string` Identificador do usuário. Para contas de usuário do Google Workspace, o user_id precisa ser o e-mail do usuário do Google Workspace. Para contas de usuário de provedores de identidade que não são do Google, o user_id é o identificador de usuário mapeado configurado durante a configuração do pool de colaboradores.
`group_id`	`string` Identificador do grupo. Para contas de usuário do Google Workspace, group_id precisa ser o e-mail do grupo do Google Workspace. Para contas de usuário de provedores de identidade que não são do Google, o group_id é o identificador de grupo mapeado configurado durante a configuração do workforcepool.
`external_entity_id`	`string` Para identidades de aplicativos de terceiros que não estão presentes no provedor de identidade do cliente.

Projeto

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

Campos
`name`	`string` Apenas saída. Nome completo do recurso do projeto, por exemplo, `projects/{project}`. Ao fazer solicitações, o número e o ID do projeto são aceitos, mas o servidor sempre responde com o número do projeto.
`create_time`	`Timestamp` Apenas saída. O carimbo de data/hora em que o projeto foi criado.
`provision_completion_time`	`Timestamp` Apenas saída. O carimbo de data/hora em que o projeto foi provisionado. Um valor vazio significa que o projeto ainda está sendo provisionado e não está pronto para uso.
`service_terms_map`	`map<string, ServiceTerms>` Apenas saída. Um mapa de Termos de Serviç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 para as configurações do NotebookLM.

NotebooklmConfig

Configuração do NotebookLM.

Campos

model_armor_config

ModelArmorConfig

Configuração do Model Armor a ser usada para higienizar comandos do usuário e respostas do LLM.

ModelArmorConfig

Configuração para modelos do Model Armor definidos pelo cliente que serão usados para higienizar comandos do usuário e respostas do LLM.

Campos

user_prompt_template

string

Opcional. O nome do recurso do modelo do Model Armor para higienizar comandos do usuário. Formato: projects/{project}/locations/{location}/templates/{template_id}. Se não for especificado, nenhuma limpeza será aplicada ao comando do usuário.

response_template

string

Opcional. O nome do recurso do modelo do Model Armor para higienização de respostas do LLM. Formato: projects/{project}/locations/{location}/templates/{template_id}. Se não for especificado, nenhuma limpeza será aplicada à resposta do LLM.

ServiceTerms

Metadados sobre os Termos de Serviço.

Campos
`id`	`string` O identificador exclusivo destes Termos de Serviço. Termos disponíveis: `GA_DATA_USE_TERMS`: Termos de uso de dados. Ao usar isso como `id`, o `version` aceitável a ser fornecido é `2022-11-23`.
`version`	`string` A string da versão dos Termos de Serviço. Para valores aceitáveis, consulte os comentários de `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 em que o projeto concordou com os Termos de Serviço.
`decline_time`	`Timestamp` A última vez em que o projeto recusou ou revogou o contrato de termos de serviço.

Estado

O contrato afirma estes Termos de Serviço.

Tipos enumerados
`STATE_UNSPECIFIED`	O valor padrão do enum. Esse valor não é usado.
`TERMS_ACCEPTED`	O projeto deu consentimento aos Termos de Serviço.
`TERMS_PENDING`	O projeto está pendente de revisão e aceitação dos Termos de Serviço.
`TERMS_DECLINED`	O projeto recusou ou revogou o contrato dos Termos de Serviço.

ProvisionProjectMetadata

Esse tipo não tem campos.

Metadados associados a uma operação de provisionamento de projeto.

ProvisionProjectRequest

Solicitação 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. Defina como `true` para especificar que o caller leu e quer dar consentimento aos Termos de uso de dados.
`data_use_terms_version`	`string` Obrigatório. A versão dos Termos de uso de dados que o autor da chamada leu e quer consentir. A versão aceita é `2022-11-23`, e isso pode mudar com o tempo.
`saas_params`	`SaasParams` Opcional. Parâmetros do Agentspace.

SaasParams

Parâmetros do Agentspace.

Campos

accept_biz_qos

bool

Opcional. Definido como true para especificar que o usuário leu e quer dar consentimento aos [Termos de qualidade de serviço do Agent Space].

is_biz

bool

Opcional. Indica se a solicitação atual é para a edição Biz (= true) ou não (= false).

PurgeCompletionSuggestionsMetadata

Metadados relacionados ao progresso da operação "PurgeCompletionSuggestions". Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

PurgeCompletionSuggestionsRequest

Solicite uma mensagem para o método CompletionService.PurgeCompletionSuggestions.

Campos

parent

string

Obrigatório. O nome do recurso do repositório de dados principal para limpar as 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 excluídas.

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

PurgeDocumentsMetadata

Metadados relacionados ao progresso da operação "PurgeDocuments". Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Contagem de entradas excluídas.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.
`ignored_count`	`int64` Contagem de entradas ignoradas porque não foram encontradas.

PurgeDocumentsRequest

Solicite uma mensagem para o método DocumentService.PurgeDocuments.

Campos
`parent`	`string` Obrigatório. O nome do recurso pai, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Obrigatório. Filtre os documentos correspondentes para excluir permanentemente. O único valor aceito no momento é `*` (todos os itens).
`error_config`	`PurgeErrorConfig` O local desejado dos erros ocorridos durante a limpeza.
`force`	`bool` Realiza a limpeza. Se `force` for definido como "false", retorne a contagem de limpeza esperada sem excluir documentos.
Campo de união `source`. A origem de entrada desejada para a exclusão de documentos com base nos IDs. `source` pode ser apenas de um dos tipos a seguir:
`gcs_source`	`GcsSource` Local do Cloud Storage para o conteúdo de entrada. `data_schema` compatíveis: * `document_id`: um `Document.id` válido por linha.
`inline_source`	`InlineSource` Origem inline do conteúdo de entrada para remoção.

InlineSource

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

Campos

documents[]

string

Obrigatório. Uma lista de nomes completos de recursos de documentos a serem excluídos. 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, essa mensagem será retornada pelo campo google.longrunning.Operations.response.

Campos

purge_count

int64

A contagem total de documentos excluídos como resultado da operação.

purge_sample[]

string

Uma amostra dos nomes de documentos que serão excluídos. Preenchido apenas se force estiver definido como "false". No máximo, 100 nomes serão retornados e escolhidos aleatoriamente.

PurgeErrorConfig

Configuração do destino para erros relacionados à exclusão.

Campos

Campo de união destination. Obrigatório. Destino de erros. destination pode ser apenas de um dos tipos a seguir:

gcs_prefix

string

Prefixo do Cloud Storage para erros de remoção. Precisa ser um diretório do Cloud Storage vazio e existente. Os erros de exclusão são gravados em arquivos fragmentados neste diretório, um por linha, como uma mensagem google.rpc.Status codificada em JSON.

PurgeIdentityMappingsRequest

Mensagem de solicitação para IdentityMappingStoreService.PurgeIdentityMappings

Campos
`identity_mapping_store`	`string` Obrigatório. O nome do armazenamento de mapeamento de identidade de onde as entradas de mapeamento de identidade serão excluídas. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Filtre os mapeamentos de identidade correspondentes a serem excluídos. O campo qualificado para filtragem é: * `update_time`: no formato ISO 8601 "zulu". * `external_id` Exemplos: Excluir todos os mapeamentos de identidade atualizados em um período: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Excluir todos os mapeamentos de identidade para um determinado external_id: `external_id = "id1"` Excluir todos os mapeamentos de identidade em um armazenamento de mapeamento de identidade: `*` Os campos de filtragem têm um AND implícito. Não pode ser usado com a origem. Um erro será gerado se ambos forem fornecidos.
Campo de união `source`. A origem da entrada. `source` pode ser apenas de um dos tipos a seguir:
`inline_source`	`InlineSource` A origem in-line de onde as entradas de mapeamento de identidade serão excluídas.
`force`	`bool` Realiza a limpeza. Se `force` for definido como "false", retorne a contagem de limpeza esperada sem excluir nenhum mapeamento de identidade. Esse campo só é compatível com a exclusão permanente com filtro. Para a origem de entrada, esse campo é ignorado, e os dados são excluídos independente do valor dele.

InlineSource

A origem in-line de onde as entradas de mapeamento de identidade serão excluídas.

Campos

identity_mapping_entries[]

IdentityMappingEntry

É possível excluir no máximo 10.000 entradas por vez.

PurgeSuggestionDenyListEntriesMetadata

Metadados relacionados ao progresso da operação "PurgeSuggestionDenyListEntries". Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

PurgeSuggestionDenyListEntriesRequest

Solicite uma mensagem para o método CompletionService.PurgeSuggestionDenyListEntries.

Campos

parent

string

Obrigatório. O nome do recurso de repositório de dados pai para importar entradas da lista de bloqueio. 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 bloqueio de sugestões limpas.

error_samples[]

Uma amostra de erros encontrados ao processar a solicitação.

PurgeUserEventsMetadata

Metadados relacionados ao progresso da operação "PurgeUserEvents". Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`success_count`	`int64` Contagem de entradas excluídas.
`failure_count`	`int64` Contagem de entradas que encontraram erros durante o processamento.

PurgeUserEventsRequest

Mensagem de solicitação para o método "PurgeUserEvents".

Campos

parent

string

Obrigatório. O nome do recurso do catálogo em que 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 serem excluídos com um limite de 5.000 caracteres. Os campos qualificados para filtragem são:

eventType: string UserEvent.event_type entre aspas duplas.
eventTime: no formato "zulu" ISO 8601.
userPseudoId: string entre aspas duplas. Especificar essa opção exclui todos os eventos associados a um visitante.
userId: string entre aspas duplas. Especificar essa opção exclui todos os eventos associados a um usuário.

Observação: essa API só permite limpar um período máximo de 30 dias.

Exemplos:

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

Os campos de filtragem têm um AND implícito.

force

bool

No momento, o campo force não é compatível. As solicitações de limpeza de eventos de usuário excluem permanentemente todos os eventos que podem ser limpos. Depois que o desenvolvimento for concluído: se force estiver definido como "false", o método vai retornar a contagem de limpeza esperada sem excluir eventos de usuário. O padrão desse campo é "false" se ele não for incluído na solicitação.

PurgeUserEventsResponse

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

Campos

purge_count

int64

A contagem total de eventos excluídos como resultado da operação.

Consulta

Define uma consulta inserida pelo usuário.

Campos

query_id

string

Apenas saída. ID exclusivo da consulta.

Campo de união content. Conteúdo da consulta. content pode ser apenas de um dos tipos a seguir:

text

string

Texto simples.

RankRequest

Solicite uma mensagem 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 ser usado. É uma destas opções: `semantic-ranker-512@latest`: modelo de classificação semântica com tamanho máximo de token de entrada de 512. Se não for especificado, o padrão será `semantic-ranker-512@latest`.
`top_n`	`int32` O número de resultados a serem mostrados. Se não for definido ou for menor ou igual a zero, todos os resultados serão retornados.
`query`	`string` A consulta a ser usada.
`records[]`	`RankingRecord` Obrigatório. Uma lista de registros a serem classificados.
`ignore_record_details_in_response`	`bool` Se for "true", a resposta vai conter apenas o ID do registro e a pontuação. Por padrão, é "false", e a resposta contém detalhes do registro.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte o documento do Google Cloud para mais detalhes.

RankResponse

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

Campos

records[]

RankingRecord

Uma lista de registros classificados por pontuação decrescente.

RankingRecord

Grave uma mensagem para o método RankService.Rank.

Campos
`id`	`string` O ID exclusivo para representar o registro.
`title`	`string` O título do registro. Vazio por padrão. Pelo menos uma das propriedades `title` ou `content` precisa ser definida. Caso contrário, um erro INVALID_ARGUMENT será gerado.
`content`	`string` O conteúdo do registro. Vazio por padrão. Pelo menos uma das propriedades `title` ou `content` precisa ser definida. Caso contrário, um erro INVALID_ARGUMENT será gerado.
`score`	`float` A pontuação deste registro com base na consulta e no modelo selecionados. A pontuação será arredondada para duas casas decimais. Se a pontuação estiver próxima de 0, ela será arredondada para 0,0001 para evitar o retorno de "não definido".

RecommendRequest

Mensagem de solicitação 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/` Uma configuração de exibição padrão é criada junto com o mecanismo de recomendação. O ID do mecanismo é usado como o ID da configuração de veiculação padrão. Por exemplo, para o Engine `projects//locations/global/collections//engines/my-engine`, é possível usar `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` nas solicitações `RecommendationService.Recommend`.
`user_event`	`UserEvent` Obrigatório. Contexto sobre o usuário, o que ele está olhando e qual ação ele realizou para acionar a solicitação de recomendação. Esses detalhes não serão ingeridos nos registros de userEvent. Portanto, é necessário fazer uma solicitação de gravação userEvent separada para o registro de eventos. Não defina `UserEvent.user_pseudo_id` ou `UserEvent.user_info.user_id` com o mesmo ID fixo para usuários diferentes. Se você estiver tentando receber recomendações não personalizadas (não recomendado, isso pode afetar negativamente a performance do modelo), defina `UserEvent.user_pseudo_id` como um ID exclusivo aleatório e deixe `UserEvent.user_info.user_id` sem definição.
`page_size`	`int32` Número máximo de resultados a serem retornados. Defina essa propriedade como o número de resultados de recomendação necessários. Se for zero, o serviço vai escolher um padrão razoável. O valor máximo permitido é 100. Valores acima de 100 são definidos como 100.
`filter`	`string` Filtro para restringir os resultados de recomendação com um limite de 5.000 caracteres. No momento, só há suporte para 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 "true" no campo `params`, serão esperadas expressões baseadas em atributos em vez da sintaxe baseada em tag 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 vai retornar documentos populares genéricos (sem filtro). Se você quiser apenas resultados que correspondam estritamente aos filtros, defina `strictFiltering` como `true` em `RecommendRequest.params` para receber resultados vazios. A API nunca retorna `Document`s com `storageStatus` como `EXPIRED` ou `DELETED`, independente das opções de filtro.
`validate_only`	`bool` Use o modo "validar apenas" para esta consulta de recomendação. Se definido como `true`, um modelo simulado será usado e vai retornar IDs de documentos arbitrários. O modo "validate only" só deve ser usado para testar a API ou se o modelo não estiver pronto.
`params`	`map<string, Value>` Outros parâmetros específicos do domínio para as recomendações. Valores permitidos: `returnDocument`: booleano. Se definido como `true`, o objeto Document associado será retornado em `RecommendResponse.RecommendationResult.document`. `returnScore`: booleano. Se definido como "true", a pontuação de recomendação correspondente a cada documento retornado será definida em `RecommendResponse.RecommendationResult.metadata`. A pontuação indica a probabilidade de uma conversão de documento, considerando o contexto e o histórico do usuário. `strictFiltering`: booleano. "True" por padrão. Se definido como `false`, o serviço vai retornar documentos genéricos (não filtrados) em vez de vazios se o filtro bloquear todos os resultados de recomendação. `diversityLevel`: string. O padrão é vazio. Se não estiver vazio, ele precisará ser um destes valores: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Isso oferece controle no nível da solicitação e ajusta os resultados da recomendação com base na categoria do documento. `attributeFilteringSyntax`: booleano. O padrão é "falso". Se definido como "true", o campo `filter` será interpretado de acordo com a nova sintaxe baseada em atributos.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte Requisitos para rótulos 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 exclusivo. Isso precisa ser incluído nos registros `UserEvent` resultantes dessa recomendação, o que permite uma atribuição precisa da performance do modelo de recomendação.
`missing_ids[]`	`string` IDs de documentos na solicitação que estavam ausentes da ramificação padrão associada ao ServingConfig solicitado.
`validate_only`	`bool` Verdadeiro se `RecommendRequest.validate_only` foi 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 "true" em RecommendRequest.params.

metadata

map<string, Value>

Metadados ou anotações adicionais do documento.

Valores possíveis:

score: pontuação da recomendação em valor duplo. É definido se returnScore estiver definido como "true" em RecommendRequest.params.

RecrawlUrisMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.RecrawlUris. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Horário de criação da operação.
`update_time`	`Timestamp` Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.
`invalid_uris[]`	`string` URIs exclusivos na solicitação com formato inválido. Amostra limitada a 1.000.
`invalid_uris_count`	`int32` Número total de URIs exclusivos na solicitação que têm formato inválido.
`noindex_uris[]`	`string` URIs que não têm uma metatag de indexação. Amostra limitada a 1.000.
`noindex_uris_count`	`int32` Número total de URIs que não têm uma metatag de índice.
`uris_not_matching_target_sites[]`	`string` URIs únicos na solicitação que não correspondem a nenhum TargetSite no DataStore, correspondem apenas a TargetSites que não foram totalmente indexados ou correspondem a um TargetSite com o tipo EXCLUDE. Amostra limitada a 1.000.
`uris_not_matching_target_sites_count`	`int32` Número total de URIs que não correspondem a nenhum TargetSite.
`valid_uris_count`	`int32` Número total de URIs únicos na solicitação que não estão em "invalid_uris".
`success_count`	`int32` Número total de URIs rastreados até o momento.
`pending_count`	`int32` Número total de URIs que ainda não foram rastreados.
`quota_exceeded_count`	`int32` Número total de URIs rejeitados por recursos de indexação insuficientes.

RecrawlUrisRequest

Solicite uma mensagem para o método SiteSearchEngineService.RecrawlUris.

Campos

site_search_engine

string

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

uris[]

string

Obrigatório. Lista de URIs a serem rastreados. No máximo, 10 mil URIs são aceitas. Caso contrário, um erro INVALID_ARGUMENT será gerado. Cada URI precisa corresponder a pelo menos um TargetSite em site_search_engine.

site_credential

string

Opcional. ID da credencial a ser usada para rastreamento.

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 do término da LRO.

FailureInfo

Detalhes sobre o motivo da falha na rastreamento de 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 da falha na rastreamento para um CorpusType específico, por exemplo, O rastreamento em DESKTOP e MOBILE pode falhar por motivos diferentes.

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 rastreamento com falha.

Tipos enumerados
`CORPUS_TYPE_UNSPECIFIED`	Valor padrão.
`DESKTOP`	Denota uma tentativa de rastreamento da versão para computador de uma página.
`MOBILE`	Denota uma tentativa de rastreamento da versão para dispositivos móveis de uma página.

Responder

Define uma mensagem de resposta para o usuário.

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 dano.
`probability`	`HarmProbability` Apenas saída. Os 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 de danos no conteúdo.
`severity_score`	`float` Apenas saída. Pontuação de gravidade do dano.
`blocked`	`bool` Apenas saída. Indica se o conteúdo foi filtrado devido a essa classificação.

HarmProbability

Os níveis de probabilidade de danos no conteúdo.

Tipos enumerados
`HARM_PROBABILITY_UNSPECIFIED`	Probabilidade de danos não especificada.
`NEGLIGIBLE`	Nível de dano insignificante.
`LOW`	Baixo nível de dano.
`MEDIUM`	Nível médio de dano.
`HIGH`	Alto nível de dano.

HarmSeverity

Níveis de gravidade de danos.

Tipos enumerados
`HARM_SEVERITY_UNSPECIFIED`	Gravidade do dano não especificada.
`HARM_SEVERITY_NEGLIGIBLE`	Nível insignificante de gravidade do dano.
`HARM_SEVERITY_LOW`	Baixo nível de gravidade do dano.
`HARM_SEVERITY_MEDIUM`	Nível médio de gravidade do dano.
`HARM_SEVERITY_HIGH`	Alto nível de gravidade do dano.

Esquema

Define a estrutura e o layout de um tipo de dados de documento.

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 precisa ser uma string codificada em UTF-8 com um limite de 1.024 caracteres.
Campo de união `schema`. Representação do esquema. É necessário fornecer `struct_schema` ou `json_schema`. Caso contrário, um erro `INVALID_ARGUMENT` será gerado. `schema` pode ser apenas um dos seguintes:
`struct_schema`	`Struct` A representação estruturada do esquema.
`json_schema`	`string` A representação JSON do esquema.

SearchAddOn

Complemento que oferece mais funcionalidades para a pesquisa.

Tipos enumerados
`SEARCH_ADD_ON_UNSPECIFIED`	Valor padrão quando a enumeração não é especificada. Isso é inválido para uso.
`SEARCH_ADD_ON_LLM`	Complemento de modelo de linguagem grande.

SearchInfo

Informações detalhadas da pesquisa.

Campos

search_query

string

A consulta de pesquisa do usuário.

Consulte SearchRequest.query para ver a definição.

O valor precisa ser uma string codificada em UTF-8 com um limite de 5.000 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

É necessário incluir pelo menos uma das seguintes propriedades: search_query ou PageInfo.page_category para eventos search. Outros tipos de eventos não devem definir esse campo. Caso contrário, um erro INVALID_ARGUMENT será retornado.

order_by

string

A ordem em que os produtos são retornados, se aplicável.

Consulte SearchRequest.order_by para definição e sintaxe.

O valor precisa ser uma string codificada em UTF-8 com um limite de 1.000 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.

Isso só pode ser definido para eventos search. Outros tipos de eventos não devem definir esse campo. Caso contrário, um erro INVALID_ARGUMENT será retornado.

offset

int32

Um número inteiro que especifica o deslocamento atual para paginação (o local inicial indexado em 0, entre os produtos considerados relevantes pela API).

Consulte SearchRequest.offset para ver a definição.

Se esse campo for negativo, um INVALID_ARGUMENT será retornado.

Isso só pode ser definido para eventos search. Outros tipos de eventos não devem definir esse campo. Caso contrário, um erro INVALID_ARGUMENT será retornado.

SearchLinkPromotion

O proto de promoção inclui URI e outras informações úteis para mostrar a promoção.

Campos
`title`	`string` Obrigatório. O título da promoção. Comprimento máximo: 160 caracteres.
`uri`	`string` Opcional. O URL da página que o usuário quer promover. Precisa ser definido para a pesquisa no site. Para outras categorias, isso é opcional.
`document`	`string` Opcional. O `Document` que o usuário quer promover. Para a pesquisa no site, deixe em branco e preencha apenas o URI. Pode ser definido 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 caracteres.
`enabled`	`bool` Opcional. A promoção ativada será retornada para todas as configurações de veiculação associadas ao pai do controle a que ela está anexada. Essa flag é usada apenas para a pesquisa básica no site.

SearchRequest

Solicite uma mensagem para o método SearchService.Search.

Campos
`serving_config`	`string` Obrigatório. O nome do recurso da configuração de exibição da 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`. Esse campo é usado para identificar o nome da configuração de veiculaçã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 da ramificação ou deixe esse campo vazio para pesquisar documentos na ramificação padrão.
`query`	`string` Consulta de pesquisa bruta.
`image_query`	`ImageQuery` Consulta de imagem bruta.
`page_size`	`int32` Número máximo de `Document`s a serem retornados. O valor máximo permitido depende do tipo de dados. Valores acima do máximo são convertidos para o máximo. Sites com indexação básica: padrão `10`, máximo `25`. Sites com indexação avançada: padrão `25`, máximo `50`. Outro: padrão `50`, máximo `100`. Se esse campo for negativo, um `INVALID_ARGUMENT` será retornado.
`page_token`	`string` Um token de página recebido de uma chamada `SearchService.Search` anterior. Forneça isso para recuperar a página subsequente. Ao paginar, todos os outros parâmetros fornecidos para `SearchService.Search` precisam corresponder à chamada que forneceu o token da página. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`offset`	`int32` Um número inteiro com índice zero que especifica o deslocamento atual (ou seja, o local do resultado inicial, entre os `Document`s considerados relevantes pela API) nos resultados da pesquisa. Este campo só é considerado quando `page_token` não está definido. Se esse campo for negativo, um `INVALID_ARGUMENT` será retornado. Um grande valor de ajuste pode ser limitado a um limite razoável.
`one_box_page_size`	`int32` O número máximo de resultados a serem retornados para a OneBox. Isso se aplica a cada tipo de OneBox individualmente. O número padrão é 10.
`data_store_specs[]`	`DataStoreSpec` Especificações que definem os `DataStore`s específicos a serem pesquisados, além das configurações desses armazenamentos de dados. Isso só é considerado para `Engine`s com vários repositórios de dados. Para mecanismos com um único repositório de dados, use as especificações diretamente em `SearchRequest`.
`filter`	`string` A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas. Se esse campo não for reconhecido, um `INVALID_ARGUMENT` será retornado. A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")' Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.
`canonical_filter`	`string` O filtro padrão aplicado quando um usuário faz uma pesquisa sem marcar nenhum filtro na página de pesquisa. O filtro aplicado a cada solicitação de pesquisa quando é necessário melhorar a qualidade, como a expansão de consultas. Se uma consulta não tiver resultados suficientes, esse filtro será usado para determinar se o fluxo de expansão de consulta será ativado ou não. O filtro original ainda será usado na pesquisa expandida da consulta. Recomendamos usar esse campo para alcançar uma alta qualidade da pesquisa. Para mais informações sobre a sintaxe de filtro, consulte `SearchRequest.filter`.
`order_by`	`string` A ordem em que os documentos são retornados. Os documentos podem ser ordenados por um campo em um objeto `Document`. Deixe em branco se a ordenação for por relevância. A expressão `order_by` diferencia maiúsculas de minúsculas. Para mais informações sobre como ordenar os resultados da pesquisa no site, consulte Ordenar resultados da pesquisa na Web. Para mais informações sobre como ordenar os resultados da pesquisa de saúde, consulte Ordenar resultados da pesquisa de saúde. Se esse campo não for reconhecido, um `INVALID_ARGUMENT` será retornado.
`user_info`	`UserInfo` Informações sobre o usuário final. Altamente recomendado para análises e personalização. `UserInfo.user_agent` é usado para deduzir `device_type` para análise.
`language_code`	`string` O código de idioma BCP-47, como pt-BR ou en-US. Para mais informações, consulte Campos padrão. Esse campo ajuda a interpretar melhor a consulta. Se um valor não for especificado, o código do idioma da consulta será detectado automaticamente, o que pode não ser preciso.
`facet_specs[]`	`FacetSpec` Especificações de atributos para pesquisa de atributos. Se estiver vazio, nenhum atributo será retornado. São permitidos no máximo 100 valores. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`boost_spec`	`BoostSpec` Aumente a especificação para impulsionar determinados documentos. Para mais informações sobre o aumento, consulte Aumento.
`params`	`map<string, Value>` Parâmetros de pesquisa adicionais. Para pesquisa de sites públicos, os valores aceitos são: `user_country_code`: string. O padrão é vazio. Se definido como não vazio, os resultados serão restritos ou promovidos com base no local fornecido. Por exemplo, `user_country_code: "au"` Para ver os códigos disponíveis, consulte Códigos de país. `search_type`: double. O padrão é vazio. Ativa a pesquisa de conteúdo que não seja de páginas da Web, dependendo do valor. O único valor válido que não é o padrão é 1, que ativa a pesquisa de imagens. Por exemplo, `search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` A especificação de expansão de consulta que especifica as condições em que ela ocorre.
`spell_correction_spec`	`SpellCorrectionSpec` A especificação de correção ortográfica que especifica o modo em que ela entra em vigor.
`user_pseudo_id`	`string` Um identificador exclusivo para rastrear visitantes. Por exemplo, isso pode ser implementado com um cookie HTTP, que deve ser capaz de identificar um visitante de maneira exclusiva em um único dispositivo. Esse identificador exclusivo não deve mudar se o visitante fizer login ou logout no site. Esse campo NÃO pode ter um valor fixo, como `unknown_visitor`. Precisa ser o mesmo identificador de `UserEvent.user_pseudo_id` e `CompleteQueryRequest.user_pseudo_id`. O campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`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 recuperação. Isso substitui `ServingConfig.ranking_expression`. A sintaxe e os recursos compatíveis dependem do valor de `ranking_expression_backend`. Se `ranking_expression_backend` não for fornecido, o padrão será `RANK_BY_EMBEDDING`. Se `ranking_expression_backend` não for fornecido ou for definido como `RANK_BY_EMBEDDING`, ele deverá ser uma única função ou várias funções unidas por "+". ranking_expression = function, { " + ", function }; Funções compatíveis: 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 embedding de documento usado com o vetor de embedding de consulta. `dotProduct`: função de embedding entre `embedding_field_path` e o vetor de embedding de consulta. Exemplo de expressão de classificação: Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação poderá ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. Se `ranking_expression_backend` for definido como `RANK_BY_FORMULA`, os seguintes tipos de expressão (e combinações deles encadeados usando operadores + ou ) serão compatíveis: `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)`: transformação de classificação recíproca com o segundo argumento sendo uma constante de denominador. `is_nan(signal)`: retorna 0 se o indicador for NaN e 1 caso contrário. `fill_nan(signal1, signal2 \| double)`: se signal1 for NaN, retorna signal2 \| double. Caso contrário, retorna signal1. Confira alguns exemplos de fórmulas de classificação que usam os tipos de expressões de classificação aceitos: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)`: principalmente classificação pelo logaritmo de `keyword_similarity_score` com um pequeno ajuste de `semantic_smilarity_score`. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`: classifica pelo expoente de `semantic_similarity_score`, preenchendo o valor com 0 se for NaN.Também adiciona um 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 classificação pela posição recíproca de `keyword_similarity_score` com um pequeno ajuste da posição recíproca de `semantic_smilarity_score`. Há suporte para os seguintes indicadores: `semantic_similarity_score`: ajuste de similaridade semântica calculado usando os embeddings gerados por um modelo proprietário do Google. Essa pontuação determina o grau de semelhança semântica entre uma consulta de pesquisa e um documento. `keyword_similarity_score`: o ajuste de correspondência de palavra-chave usa a função de classificação Best Match 25 (BM25). Essa pontuação é calculada usando um modelo probabilístico para estimar a probabilidade de um documento ser relevante para uma determinada consulta. `relevance_score`: ajuste de relevância semântica que usa um modelo proprietário do Google para determinar o significado e a intenção por trás da consulta de um usuário no contexto do conteúdo dos documentos. `pctr_rank`: ajuste previsto da taxa de conversão como um uso de classificação. A taxa de cliques prevista (pCTR) é usada para avaliar a relevância e o atrativo de um resultado da pesquisa do ponto de vista do usuário. Uma pCTR mais alta sugere que o resultado tem mais chances de satisfazer a consulta e a intenção do usuário, o que o torna um indicador valioso para a classificação. `freshness_rank`: ajuste de atualização como uma classificação `document_age`: o tempo em horas decorrido desde a última atualização do documento, um número de ponto flutuante (por exemplo, 0,25 significa 15 minutos. `topicality_rank`: ajuste de relevância como uma classificação. Usa um modelo proprietário do Google para determinar a sobreposição baseada em palavras-chave entre a consulta e o documento. `base_rank`: a classificação padrão do resultado
`ranking_expression_backend`	`RankingExpressionBackend` Opcional. O back-end a ser usado para a avaliação da expressão de classificação.
`safe_search`	`bool` Se o safe search deve ser ativado. Esse recurso só está disponível para a pesquisa de sites.
`user_labels`	`map<string, string>` Os rótulos de usuário aplicados a um recurso precisam atender aos seguintes requisitos: Cada recurso pode ter vários rótulos, até um máximo de 64. Cada rótulo precisa ser um par de chave-valor. As chaves têm comprimento mínimo de um caractere e comprimento máximo de 63 caracteres, e não podem estar vazias. Os valores podem estar vazios e ter um comprimento máximo de 63 caracteres. As chaves e os valores podem conter apenas letras minúsculas, caracteres numéricos, sublinhados e traços. Todos os caracteres precisam usar a codificação UTF-8, e os caracteres internacionais são permitidos. A parte da chave de um rótulo precisa ser única. No entanto, é possível usar a mesma chave com vários recursos. As chaves precisam começar com uma letra minúscula ou um caractere internacional. Consulte o documento do Google Cloud para mais detalhes.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Opcional. Configuração para recursos de compreensão de consultas em linguagem natural, como extrair filtros de campos estruturados da consulta. Consulte esta documentação para mais informações. Se `naturalLanguageQueryUnderstandingSpec` não for especificado, não será feita nenhuma compreensão adicional de consultas em linguagem natural.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Configuração de pesquisa enquanto você digita. Compatível apenas com a categoria `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Opcional. Configuração para recursos de exibição, como o destaque de correspondências nos resultados da pesquisa.
`session`	`string` O nome do recurso da sessão. Opcional. A sessão permite que os usuários façam chamadas de API /search de várias rodadas ou a coordenação entre chamadas de API /search e /answer. Exemplo 1 (chamadas de API /search com várias interações): 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. Por exemplo, se a primeira consulta for "Como foi o desempenho da Alphabet em 2022?" e a consulta atual for "E 2023?", ela será interpretada como "Como foi o desempenho da Alphabet em 2023?". Exemplo 2 (coordenação entre chamadas de API /search e /answer): chame a API /answer com o ID da sessão gerado na primeira chamada. Aqui, a geração de respostas acontece no contexto dos resultados da pesquisa da primeira chamada. No momento, o recurso de pesquisa com várias interações está na fase de GA particular. Use a versão v1alpha ou v1beta antes de lançarmos esse recurso para disponibilidade geral pública ou peça a inclusão na lista de permissões para a equipe de suporte do 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. Use o limite definido pelo Google, aproveitando um equilíbrio entre precisão e recall para fornecer resultados altamente precisos e cobertura abrangente de informações relevantes. Esse recurso não é compatível com a pesquisa de saúde.
`relevance_score_spec`	`RelevanceScoreSpec` Opcional. A especificação para retornar a pontuação de relevância.

BoostSpec

Aumente a especificação para impulsionar determinados documentos.

Campos

condition_boost_specs[]

ConditionBoostSpec

Especificações de otimização de condição. Se um documento corresponder a várias condições nas especificações, as pontuações de reforço dessas especificações serão aplicadas e combinadas de maneira não linear. O número máximo de especificações é 20.

ConditionBoostSpec

O reforço é aplicado a documentos que correspondem a uma condição.

Campos

condition

string

Uma expressão que especifica uma condição de reforço. A sintaxe e os campos aceitos são os mesmos de uma expressão de filtro. Consulte SearchRequest.filter para ver a sintaxe e as limitações detalhadas.

Exemplos:

Para aumentar a relevância de documentos com o ID "doc_1" ou "doc_2" e a cor "Red" ou "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Intensidade da otimização da condição, que precisa estar em [-1, 1]. Reforço negativo significa rebaixamento. O padrão é 0,0.

Definir como 1.0 oferece uma boa promoção ao documento. No entanto, isso não significa necessariamente que o documento otimizado será o resultado principal em todos os momentos, nem que os outros documentos serão excluídos. É possível que sejam mostrados resultados mesmo que nenhum deles corresponda à condição. Além disso, os resultados mais relevantes para a consulta de pesquisa ainda podem superar os documentos mais favorecidos, mas irrelevantes.

Definir como -1,0 rebaixa muito o documento. No entanto, os resultados altamente relevantes ainda poderão ser mostrados. O documento terá uma disputa upstream para conseguir uma classificação razoavelmente alta, mas não será completamente bloqueado.

Definir como 0,0 significa que não há otimização aplicada. A condição de reforço é ignorada. Apenas uma das combinações (condição, reforço) ou o boost_control_spec abaixo está definido. Se ambos estiverem definidos, o reforço global será ignorado e o boost_control_spec mais refinado será aplicado.

boost_control_spec

BoostControlSpec

Especificação complexa para classificação personalizada com base no valor do atributo definido pelo cliente.

BoostControlSpec

Campos
`field_name`	`string` O nome do campo cujo valor será usado para determinar o valor do reforço.
`attribute_type`	`AttributeType` O tipo de atributo a ser usado para determinar o valor do reforço. O valor do atributo pode ser derivado do valor do campo do field_name especificado. No caso de valores numéricos, é simples: attribute_value = numerical_field_value. No caso da atualização, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` O tipo de interpolação a ser aplicado para conectar os pontos de controle listados abaixo.
`control_points[]`	`ControlPoint` Os pontos de controle usados para definir a curva. A função monotônica (definida pelo interpolation_type acima) passa pelos pontos de controle listados aqui.

AttributeType

O atributo(ou função) a que o ranking personalizado será aplicado.

Tipos enumerados
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType não especificado.
`NUMERICAL`	O valor do campo numérico será usado para atualizar dinamicamente o valor do reforço. Nesse caso, o attribute_value (o valor x) do ponto de controle será o valor real do campo numérico para o qual o boost_amount é especificado.
`FRESHNESS`	Para o caso de uso de atualização, o valor do atributo será a duração entre a hora atual e a data no campo de data e hora especificado. O valor precisa ser formatado como um valor `dayTimeDuration` XSD (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: `[nD][T[nH][nM][nS]]`. Por exemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Os pontos de controle usados para definir a curva. A curva definida por esses pontos de controle só pode ser monotonicamente crescente ou decrescente(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 atualização. O valor precisa ser formatado como um valor XSD dayTimeDuration (um subconjunto restrito de um valor de duração ISO 8601). O padrão é: [nD][T[nH][nM][nS]].

boost_amount

float

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

InterpolationType

O tipo de interpolação a ser aplicado. O padrão é linear (linear por partes).

Tipos enumerados
`INTERPOLATION_TYPE_UNSPECIFIED`	O tipo de interpolação não foi especificado. Nesse caso, o padrão é "Linear".
`LINEAR`	A interpolação linear por partes será aplicada.

ContentSearchSpec

Uma especificação para configurar o comportamento da pesquisa de conteúdo.

Campos
`snippet_spec`	`SnippetSpec` Se `snippetSpec` não for especificado, os snippets não serão incluídos na resposta da pesquisa.
`summary_spec`	`SummarySpec` Se `summarySpec` não for especificado, os resumos não serão incluídos na resposta da pesquisa.
`extractive_content_spec`	`ExtractiveContentSpec` Se não houver um extractive_content_spec, não haverá uma resposta extraída na resposta da pesquisa.
`search_result_mode`	`SearchResultMode` Especifica o modo de resultado da pesquisa. Se não for especificado, o modo de resultado da pesquisa será `DOCUMENTS` por padrão.
`chunk_spec`	`ChunkSpec` Especifica a especificação do bloco a ser retornada da resposta da pesquisa. Disponível apenas se `SearchRequest.ContentSearchSpec.search_result_mode` estiver definido como `CHUNKS`

ChunkSpec

Especifica a especificação do bloco a ser retornada da resposta da pesquisa. Disponível apenas se SearchRequest.ContentSearchSpec.search_result_mode estiver definido como CHUNKS

Campos

num_previous_chunks

int32

O número de partes anteriores a serem retornadas da parte atual. O valor máximo permitido é 3. Se não for especificado, nenhum trecho anterior será retornado.

num_next_chunks

int32

O número de próximos trechos a serem retornados do trecho atual. O valor máximo permitido é 3. Se não for especificado, nenhum próximo bloco será retornado.

ExtractiveContentSpec

Uma especificação para configurar o conteúdo extrativo em uma resposta de pesquisa.

Campos
`max_extractive_answer_count`	`int32` O número máximo de respostas extraídas retornadas em cada resultado da pesquisa. Uma resposta extrativa é uma resposta literal extraída do documento original, que fornece uma resposta precisa e contextualmente relevante para a consulta de pesquisa. Se o número de respostas correspondentes for menor que `max_extractive_answer_count`, retorne todas as respostas. Caso contrário, retorne o `max_extractive_answer_count`. No máximo, cinco respostas são retornadas para cada `SearchResult`.
`max_extractive_segment_count`	`int32` O número máximo de segmentos extrativos retornados em cada resultado da pesquisa. Só é aplicado se o `DataStore` estiver definido como `DataStore.ContentConfig.CONTENT_REQUIRED` ou se `DataStore.solution_types` for `SOLUTION_TYPE_CHAT`. Um segmento extrativo é um trecho de texto extraído do documento original que é relevante para a consulta de pesquisa e, em geral, mais detalhado do que uma resposta extrativa. O segmento pode ser usado como entrada para LLMs gerarem resumos e respostas. Se o número de segmentos correspondentes for menor que `max_extractive_segment_count`, retorne todos os segmentos. Caso contrário, retorne o `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Especifica se é necessário retornar a pontuação de confiança dos segmentos extrativos em cada resultado da pesquisa. Esse recurso está disponível apenas para repositórios de dados novos ou na lista de permissões. Para autorizar seu repositório de dados, entre em contato com seu engenheiro de clientes. O valor padrão é `false`.
`num_previous_segments`	`int32` Especifica se também é necessário incluir o adjacente de cada segmento selecionado. Retorne no máximo `num_previous_segments` segmentos antes de cada segmento selecionado.
`num_next_segments`	`int32` Retorne 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 será DOCUMENTS por padrão.

Tipos enumerados
`SEARCH_RESULT_MODE_UNSPECIFIED`	Valor padrão.
`DOCUMENTS`	Retorna documentos no resultado da pesquisa.
`CHUNKS`	Retorna partes no resultado da pesquisa. Disponível apenas se o `DocumentProcessingConfig.chunking_config` for especificado.

SnippetSpec

Uma especificação para configurar snippets em uma resposta de pesquisa.

Campos

max_snippet_count
(deprecated)

int32

[DESCONTINUADO] O uso deste campo foi descontinuado. Para controlar o retorno de snippets, use o campo return_snippet. Para compatibilidade com versões anteriores, vamos retornar o snippet se max_snippet_count > 0.

reference_only
(deprecated)

bool

[DESCONTINUADO] Este campo está descontinuado e não vai afetar o snippet.

return_snippet

bool

Se true, retorne o snippet. Se não for possível gerar um trecho, vamos retornar "Nenhum trecho disponível para esta página". Um snippet_status com SUCCESS ou NO_SNIPPET_AVAILABLE também será retornado.

SummarySpec

Uma especificação para configurar um resumo retornado em uma resposta de pesquisa.

Campos
`summary_result_count`	`int32` O número dos principais resultados para gerar o resumo. Se o número de resultados retornados for menor que `summaryResultCount`, o resumo será gerado com base em todos os resultados. É possível usar no máximo 10 resultados no modo de documentos ou 50 no modo de partes para gerar um resumo. O modo de partes é usado quando `SearchRequest.ContentSearchSpec.search_result_mode` é definido como `CHUNKS`.
`include_citations`	`bool` Especifica se as citações devem ser incluídas no resumo. O valor padrão é `false`. Quando esse campo é definido como `true`, os resumos incluem números de citação inline. Exemplo de resumo com citações: O BigQuery é o data warehouse corporativo totalmente gerenciado e sem servidor do Google Cloud [1]. O BigQuery oferece suporte a todos os tipos de dados, funciona em diferentes nuvens e tem machine learning e Business Intelligence integrados, tudo em uma plataforma unificada [2, 3]. Os números de citação se referem aos resultados da pesquisa retornados e são indexados de 1 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 ao terceiro resultados da pesquisa.
`ignore_adversarial_query`	`bool` Especifica se as consultas adversárias devem ser filtradas. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas adversárias. Nenhum resumo é retornado se a consulta de pesquisa for classificada como adversária. Por exemplo, um usuário pode fazer uma pergunta sobre comentários negativos sobre a empresa ou enviar uma consulta projetada para gerar uma saída não segura que viola a política. Se esse campo for definido como `true`, vamos pular a geração de resumos para consultas adversárias e retornar mensagens alternativas.
`ignore_non_summary_seeking_query`	`bool` Especifica se é necessário filtrar consultas que não buscam um resumo. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas que buscam resumos. Nenhum resumo é retornado se a consulta de pesquisa for classificada como uma consulta que não busca resumos. Por exemplo, `why is the sky blue` e `Who is the best soccer player in the world?` são consultas que buscam um resumo, mas `SFO airport` e `world cup 2026` não são. Provavelmente são consultas de navegação. Se este campo estiver definido como `true`, vamos pular a geração de resumos para consultas que não buscam resumos e retornar mensagens alternativas.
`ignore_low_relevant_content`	`bool` Especifica se as consultas de baixa relevância devem ser filtradas. O valor padrão é `false`. Se esse campo for definido como `false`, todos os resultados da pesquisa serão usados, independente da relevância, para gerar respostas. Se definido como `true`, apenas consultas com resultados de pesquisa de alta relevância vão gerar respostas.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica se as consultas de jailbreak devem ser filtradas. O valor padrão é `false`. O Google usa a classificação de consultas de pesquisa para detectar consultas de jailbreak. Nenhum resumo é retornado se a consulta de pesquisa for classificada como uma consulta de jailbreak. Um usuário pode adicionar instruções à consulta para mudar o tom, o estilo, o idioma, o conteúdo da resposta ou pedir que o modelo aja como uma entidade diferente, por exemplo, "Responda no tom de um CEO de uma empresa concorrente". Se esse campo for definido como `true`, vamos pular a geração de resumos para consultas de jailbreak e retornar mensagens alternativas.
`model_prompt_spec`	`ModelPromptSpec` Se especificado, a especificação será usada para modificar o comando fornecido ao LLM.
`language_code`	`string` Código do idioma do resumo. Use tags de idioma definidas pelo BCP47 (em inglês). Observação: este é um recurso experimental.
`model_spec`	`ModelSpec` Se especificado, ele será usado para modificar a especificação do modelo fornecida ao LLM.
`use_semantic_chunks`	`bool` Se for "true", a resposta será gerada com base nos trechos mais relevantes dos principais resultados da pesquisa. Esse recurso vai melhorar a qualidade do resumo. Com esse recurso ativado, nem todos os principais resultados da pesquisa serão referenciados e incluídos na lista de referências. Portanto, o índice de origem da citação aponta apenas para os resultados da pesquisa listados na lista de referências.

ModelPromptSpec

Especificação do comando a ser usado com o modelo.

Campos

preamble

string

Texto no início do comando que instrui o assistente. Exemplos estão disponíveis no guia do usuário.

ModelSpec

Especificação do modelo.

Campos

version

string

A versão do modelo usada para gerar o resumo.

Os valores aceitos são:

stable: string. Valor padrão quando nenhum valor é especificado. Usa um modelo ajustado e disponível para todos. Para mais informações, consulte Versões e ciclo de vida do modelo de geração de respostas.
preview: string. (Pré-lançamento público) Usa um modelo de prévia. Para mais informações, consulte Versões e ciclo de vida do modelo de geração de respostas.

DataStoreSpec

Uma struct para definir os repositórios de dados a serem filtrados em uma chamada de pesquisa e as configurações desses repositórios. Caso contrário, um erro INVALID_ARGUMENT será retornado.

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 precisa incluir o número do projeto. O ID do projeto não é aceito nesse campo.
`filter`	`string` Opcional. Especificação de filtro para filtrar documentos no repositório de dados especificado pelo campo "data_store". Para mais informações sobre filtragem, consulte Filtragem.
`boost_spec`	`BoostSpec` Opcional. Aumente a especificação para impulsionar determinados documentos. Para mais informações sobre o aumento, consulte Aumento.
`custom_search_operators`	`string` Opcional. Operadores de pesquisa personalizados que, se especificados, serão usados para filtrar resultados dos repositórios de dados do espaço de trabalho. Para mais informações sobre operadores de pesquisa personalizados, consulte SearchOperators.

DisplaySpec

Especifica recursos para exibição, como o destaque de correspondências.

Campos

match_highlighting_condition

A condição em que o destaque de correspondência deve ocorrer.

MatchHighlightingCondition

Enumeração que descreve em qual condição o destaque de correspondência deve ocorrer.

Tipos enumerados
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	O comportamento do servidor é o mesmo que `MATCH_HIGHLIGHTING_DISABLED`.
`MATCH_HIGHLIGHTING_DISABLED`	Desativa o destaque de correspondências em todos os documentos.
`MATCH_HIGHLIGHTING_ENABLED`	Ativa o destaque de correspondências em todos os documentos.

FacetSpec

Uma especificação de atributo para realizar uma pesquisa facetada.

Campos
`facet_key`	`FacetKey` Obrigatório. A especificação da chave de faceta.
`limit`	`int32` Número máximo de valores de atributo retornados para este atributo. Se não for especificado, o padrão será 20. O valor máximo permitido é 300. Valores acima de 300 são convertidos para 300. Para agregação na pesquisa de saúde, quando o [FacetKey.key] é "healthcare_aggregation_key", o limite é substituído por 10.000 internamente, independente do valor definido aqui. Se esse campo for negativo, um `INVALID_ARGUMENT` será retornado.
`excluded_filter_keys[]`	`string` Lista de chaves a serem excluídas ao criar facetas. Por padrão, `FacetKey.key` não é excluído do filtro, a menos que esteja listado neste campo. Listar uma chave de atributo nesse campo permite que os valores dela apareçam como resultados de atributos, mesmo quando são filtrados dos resultados da pesquisa. O uso desse campo não afeta os resultados da pesquisa retornados. Por exemplo, suponha que haja 100 documentos com o atributo "Vermelho" e 200 documentos com o atributo "Azul". Uma consulta que contenha o filtro "color:ANY("Red")" e tenha "color" como `FacetKey.key` vai retornar por padrão apenas documentos "Red" nos resultados da pesquisa, além de "Red" com a contagem 100 como o único atributo de cor. Embora também haja documentos azuis disponíveis, "Azul" não seria mostrado como um valor de refinamento disponível. Se "color" estiver listado em "excludedFilterKeys", a consulta vai retornar os valores de faceta "Red" com a contagem 100 e "Blue" com a contagem 200, porque a chave "color" agora está excluída do filtro. Como esse campo não afeta os resultados da pesquisa, eles ainda são filtrados corretamente para retornar apenas documentos "Vermelho". São permitidos no máximo 100 valores. Caso contrário, um erro `INVALID_ARGUMENT` será retornado.
`enable_dynamic_position`	`bool` Ativa a posição dinâmica para esse atributo. Se definido como "true", a posição dessa faceta entre todas as facetas na resposta será determinada automaticamente. Se os atributos dinâmicos estiverem ativados, eles serão ordenados juntos. Se definido como "false", a posição desse atributo na resposta será a mesma da solicitação, e ele será classificado antes dos atributos com posição dinâmica ativada e de todos os atributos dinâmicos. Por exemplo, talvez você queira que o aspecto de classificação sempre seja retornado na resposta, mas não necessariamente que ele seja exibido na parte superior. Nesse caso, defina "enable_dynamic_position" como "true" para que a posição da faceta de classificação na resposta seja determinada automaticamente. Outro exemplo, supondo que você tenha as seguintes facetas na solicitação: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false Além disso, você tem atributos dinâmicos ativados, o que gera um atributo `gender`. Então, a ordem final das facetas na resposta pode ser ("price", "brands", "rating", "gender") ou ("price", "brands", "gender", "rating") dependendo de como a API ordena as facetas "gender" e "rating". No entanto, observe que "price" e "brands" sempre são classificados na primeira e na segunda posição porque o enable_dynamic_position é falso.

FacetKey

Especifica como uma faceta é calculada.

Campos
`key`	`string` Obrigatório. Chaves de atributos textuais e numéricos aceitas no objeto `Document`, em que os valores de atributo são calculados. A chave de refinamento diferencia maiúsculas de minúsculas.
`intervals[]`	`Interval` Definido apenas se os valores forem agrupados em intervalos. Precisa ser definido para facetas com valores numéricos. Não pode ser definido para facetas com valores de texto. O número máximo de intervalos é 30.
`restricted_values[]`	`string` Recebe apenas o aspecto para os valores restritos especificados. Disponível apenas em campos de texto. Por exemplo, suponha que "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se você definir "restricted_values" como "Action > 2022", a faceta "category" vai conter apenas "Action > 2022". Disponível apenas em campos de texto. O máximo é 10.
`prefixes[]`	`string` Recebe apenas valores de faceta que começam com o prefixo de string especificado. Por exemplo, suponha que "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se você definir "prefixes" como "Action", a faceta "category" vai conter apenas "Action > 2022" e "Action > 2021". Disponível apenas em campos de texto. O máximo é 10.
`contains[]`	`string` Recebe apenas valores de faceta que contêm as strings especificadas. Por exemplo, suponha que "category" tenha três valores: "Action > 2022", "Action > 2021" e "Sci-Fi > 2022". Se o valor "contém" for definido como "2022", a faceta "categoria" vai conter apenas "Ação > 2022" e "Ficção científica > 2022". Disponível apenas em campos de texto. O máximo é 10.
`case_insensitive`	`bool` Verdadeiro para tornar as chaves de refinamento insensíveis a maiúsculas e minúsculas ao receber valores de refinamento com prefixos ou contém. Caso contrário, será falso.
`order_by`	`string` A ordem em que os documentos são retornados. Os valores permitidos são: "count desc", que significa ordenar por `SearchResponse.Facet.values.count` em ordem decrescente. "value desc", que significa ordenar por `SearchResponse.Facet.values.value` em ordem decrescente. Aplica-se apenas a refinamentos textuais. Se não for definido, os valores textuais serão classificados em ordem natural, e os intervalos numéricos serão classificados na ordem fornecida por `FacetSpec.FacetKey.intervals`.

ImageQuery

Especifica a entrada da consulta de imagem.

Campos

Campo de união image.

image pode ser apenas de um dos tipos a seguir:

image_bytes

string

Bytes de imagem codificados em Base64. Formatos de imagem compatíveis: JPEG, PNG e BMP.

NaturalLanguageQueryUnderstandingSpec

Especificação para ativar recursos de compreensão de linguagem natural para solicitações de pesquisa.

Campos
`filter_extraction_condition`	`FilterExtractionCondition` A condição em que a extração de filtro deve ocorrer. O comportamento padrão do servidor é `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` Nomes de campos usados para filtragem com base na localização, em que filtros de geolocalização são detectados em consultas de pesquisa em linguagem natural. Só é válido quando "FilterExtractionCondition" está definido como `ENABLED`. Se esse campo for definido, ele vai substituir os nomes de campo definidos em `ServingConfig.geo_search_query_detection_field_names`.
`extracted_filter_behavior`	`ExtractedFilterBehavior` Opcional. Controla o comportamento de como os filtros extraídos são aplicados à pesquisa. O comportamento padrão depende da solicitação. Para uma única pesquisa estruturada no armazenamento de dados, o padrão é `HARD_FILTER`. Para a pesquisa em vários armazenamentos de dados, o comportamento padrão é `SOFT_BOOST`. Os filtros com base em local são sempre aplicados como filtros rígidos, e a configuração `SOFT_BOOST` não os afeta. Esse 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 permissões de campos que podem ser usados para extração de filtros de linguagem natural. Por padrão, se não for especificado, todos os campos indexáveis estarão qualificados para extração de filtro de linguagem natural, mas não há garantia de que serão usados. Se algum campo for especificado em "allowed_field_names", apenas os campos marcados como indexáveis no esquema e especificados na lista de permissões estarão qualificados para extração de filtro de linguagem natural. Observação: para pesquisa em vários armazenamentos de dados, isso ainda não é compatível e será ignorado.

ExtractedFilterBehavior

Enumeração que descreve como os filtros extraídos são aplicados à pesquisa.

Tipos enumerados
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	O `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` vai usar o comportamento padrão para filtros extraídos. Para uma única pesquisa do Datastore, o padrão é aplicar como filtros rígidos. Para a pesquisa em vários repositórios de dados, o padrão é aplicar como reforços leves.
`HARD_FILTER`	Aplica todos os filtros extraídos como filtros fixos nos resultados. Os resultados que não passarem nos filtros extraídos não serão retornados no conjunto de resultados.
`SOFT_BOOST`	Aplica todos os filtros extraídos como aumentos leves. Os resultados que passarem pelos filtros serão promovidos para posições mais altas no conjunto de resultados.

FilterExtractionCondition

Enumeração que descreve em qual condição a extração de filtro deve ocorrer.

Tipos enumerados
`CONDITION_UNSPECIFIED`	O comportamento padrão do servidor é `DISABLED`.
`DISABLED`	Desativa a extração de filtros de linguagem natural.
`ENABLED`	Ativa a extração de filtros de linguagem natural.

QueryExpansionSpec

Especificação para determinar em quais condições a expansão da consulta deve ocorrer.

Campos

condition

Condition

A condição em que a expansão de consulta deve ocorrer. O padrão é Condition.DISABLED.

pin_unexpanded_results

bool

Se os resultados não expandidos devem ser fixados. Se esse campo for definido como verdadeiro, os produtos não expandidos sempre vão aparecer na parte de cima dos resultados da pesquisa, seguidos pelos resultados expandidos.

Condição

Enumeração que descreve em qual condição a expansão da consulta deve ocorrer.

Tipos enumerados
`CONDITION_UNSPECIFIED`	Condição de expansão de consulta não especificada. Nesse caso, o comportamento padrão do servidor é `Condition.DISABLED`.
`DISABLED`	A expansão de consulta foi desativada. Somente a consulta de pesquisa exata é usada, mesmo que `SearchResponse.total_size` seja zero.
`AUTO`	Expansão automática de consulta criada pela API Search.

RankingExpressionBackend

O back-end a ser usado para a avaliação da expressão de classificação.

Tipos enumerados
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Opção padrão para valores não especificados/desconhecidos.
`BYOE`	Descontinuado: use `RANK_BY_EMBEDDING`. Classificação por modelo de incorporação personalizada, a maneira padrão de avaliar a expressão de classificação. Opção de enumeração legada. Use `RANK_BY_EMBEDDING`. Este item foi descontinuado.
`CLEARBOX`	Descontinuado: use `RANK_BY_FORMULA`. Classificação por fórmula personalizada. Opção de enumeração legada. Use `RANK_BY_FORMULA`. Este item foi descontinuado.
`RANK_BY_EMBEDDING`	Classificação por modelo de incorporação personalizada, a maneira padrão de avaliar a expressão de classificação.
`RANK_BY_FORMULA`	Classificação por fórmula personalizada.

RelevanceScoreSpec

A especificação para retornar a pontuação de relevância do documento.

Campos

return_relevance_score

bool

Opcional. Define se a pontuação de relevância será retornada para os resultados da pesquisa. Quanto maior a pontuação, mais relevante é o documento para a consulta.

RelevanceThreshold

O limite de relevância dos resultados da pesquisa. Quanto maior o limite de relevância, mais resultados relevantes são mostrados e menos resultados são retornados.

Tipos enumerados
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Valor padrão. Nesse caso, o comportamento padrão do servidor é o limite definido pelo Google.
`LOWEST`	Limite de relevância mais baixo.
`LOW`	Limite de relevância baixo.
`MEDIUM`	Limite de relevância média.
`HIGH`	Limite de alta relevância.

SearchAsYouTypeSpec

Especificação para pesquisa conforme você digita em solicitações de pesquisa.

Campos

condition

Condition

A condição em que a pesquisa conforme você digita deve ocorrer. O padrão é Condition.DISABLED.

Condição

Enumeração que descreve em qual condição a pesquisa conforme você digita deve ocorrer.

Tipos enumerados
`CONDITION_UNSPECIFIED`	O comportamento padrão do servidor é `Condition.DISABLED`.
`DISABLED`	Desativa o recurso "Pesquisar enquanto você digita".
`ENABLED`	Ativa o recurso "Pesquisar enquanto você digita".
`AUTO`	Alternância automática entre os modos de pesquisa instantânea e padrão, ideal para implementações de API única (por exemplo, remoção de repetições).

SessionSpec

Especificação da sessão.

No momento, o recurso de pesquisa com várias interações está na fase de GA particular. Use a versão v1alpha ou v1beta antes de lançarmos esse recurso para disponibilidade geral pública ou peça a inclusão na lista de permissões para a equipe de suporte do Google.

Campos

query_id

string

Se definido, o resultado da pesquisa será armazenado na "rodada" especificada por esse ID de consulta.

Exemplo: digamos que a sessão seja assim: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } }

O usuário pode chamar a API /search com uma solicitação como esta:

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). Também é possível chamar /search e /answer em paralelo com o mesmo ID de sessão e ID de consulta.

search_result_persistence_count

int32

O número dos principais resultados da pesquisa a serem mantidos. Os resultados da pesquisa persistentes podem ser usados na próxima chamada de API /answer.

Esse 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 partes.

SpellCorrectionSpec

A especificação para correção ortográfica de consultas.

Campos

mode

Mode

O modo em que a correção ortográfica substitui a consulta de pesquisa original. O valor padrão é Mode.AUTO.

Modo

Enumeração que descreve em qual modo a correção ortográfica deve ocorrer.

Tipos enumerados
`MODE_UNSPECIFIED`	Modo de correção ortográfica não especificado. Nesse caso, o comportamento padrão do servidor é `Mode.AUTO`.
`SUGGESTION_ONLY`	A API Search tenta encontrar uma sugestão de ortografia. Se uma sugestão for encontrada, ela será colocada no `SearchResponse.corrected_query`. A sugestão de ortografia não será usada como consulta de pesquisa.
`AUTO`	Correção ortográfica automática criada pela API Search. A pesquisa será baseada na consulta corrigida, se 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 solicitadas pelo usuário.
`total_size`	`int32` A contagem total estimada de itens correspondentes, independentemente da paginação. A contagem de `results` retornada pela paginação pode ser menor que a `total_size` correspondente.
`attribution_token`	`string` Um token de pesquisa exclusivo. Isso precisa ser incluído nos registros `UserEvent` resultantes dessa pesquisa, o que permite a atribuição precisa da performance do modelo de pesquisa. Isso também ajuda a identificar uma solicitação durante os cenários de suporte ao cliente.
`redirect_uri`	`string` O URI de uma página de redirecionamento definida pelo cliente. Se a ação de redirecionamento for acionada, nenhuma pesquisa será realizada, e apenas `redirect_uri` e `attribution_token` serão definidos na resposta.
`next_page_token`	`string` Um token que pode ser enviado como `SearchRequest.page_token` para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
`corrected_query`	`string` Contém a consulta com grafia corrigida, se encontrada. Se o tipo de correção ortográfica for AUTOMATIC, os resultados da pesquisa serão baseados em corrected_query. Caso contrário, a consulta original será usada para a pesquisa.
`summary`	`Summary` Um resumo como parte dos resultados da pesquisa. Esse campo só será retornado se `SearchRequest.ContentSearchSpec.summary_spec` estiver definido.
`query_expansion_info`	`QueryExpansionInfo` Informações de expansão de consulta para os resultados retornados.
`session_info`	`SessionInfo` Informações da sessão. Só é definido se `SearchRequest.session` for fornecido. Consulte a descrição para mais detalhes.
`search_link_promotions[]`	`SearchLinkPromotion` Promoções para pesquisa no site.

Um resultado de atributo.

Campos

key

string

A chave desse atributo. Por exemplo, "colors" ou "price". Ele corresponde a SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Os valores de atributo para este campo.

dynamic_facet

bool

Indica se o refinamento é gerado dinamicamente.

FacetValue

Um valor de faceta que contém nomes de valores e a contagem deles.

Campos
`count`	`int64` Número de itens que têm esse valor de atributo.
Campo de união `facet_value`. Um valor de faceta que contém valores. `facet_value` pode ser apenas de um dos tipos a seguir:
`value`	`string` Valor de texto de um atributo, como "Preto" para o atributo "cores".
`interval`	`Interval` Valor do intervalo para um atributo, como [10, 20) para o atributo "price". Ele corresponde a `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Informações que descrevem a expansão de consulta, incluindo se ela ocorreu.

Campos

expanded_query

bool

Booleano que descreve se a expansão de consulta ocorreu.

pinned_result_count

int64

Número de resultados fixados. Esse campo só será definido quando a expansão ocorrer e SearchRequest.QueryExpansionSpec.pin_unexpanded_results estiver definido como "true".

SearchResult

Representa os resultados da pesquisa.

Campos
`id`	`string` `Document.id` do `Document` pesquisado.
`document`	`Document` O snippet de dados do documento na resposta da pesquisa. Somente os campos marcados como `retrievable` são preenchidos.
`chunk`	`Chunk` Os dados de bloco na resposta da pesquisa se `SearchRequest.ContentSearchSpec.search_result_mode` estiver definido como `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Apenas saída. O Google forneceu as pontuações disponíveis.
`rank_signals`	`RankSignals` Opcional. Um conjunto de indicadores de classificação associados ao resultado.

RankSignals

Um conjunto de indicadores de classificação.

Campos
`default_rank`	`float` Opcional. A classificação padrão do resultado.
`custom_signals[]`	`CustomSignal` Opcional. Uma lista de indicadores personalizados de caixa transparente.
`keyword_similarity_score`	`float` Opcional. Ajuste de correspondência de palavra-chave.
`relevance_score`	`float` Opcional. Ajuste de relevância semântica.
`semantic_similarity_score`	`float` Opcional. Ajuste de similaridade semântica.
`pctr_rank`	`float` Opcional. Ajuste da taxa de conversão prevista como uma classificação.
`topicality_rank`	`float` Opcional. Ajuste de relevância como uma classificação.
`document_age`	`float` Opcional. Idade do documento em horas.
`boosting_factor`	`float` Opcional. Aumentos personalizados combinados para um documento.

CustomSignal

Indicador clearbox personalizado representado por um par nome-valor.

Campos

name

string

Opcional. Nome do indicador.

value

float

Opcional. Valor de ponto flutuante que representa o indicador de classificação (por exemplo, 1,25 para BM25).

SessionInfo

Informações sobre a sessão.

Campos

name

string

Nome da sessão. Se o modo de sessão automática for usado (quando SearchRequest.session termina com "-"), esse campo vai conter o nome da sessão recém-gerada.

query_id

string

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

Ao especificar o nome da sessão e esse ID de consulta na chamada da API Answer, a geração de respostas acontece no contexto dos resultados da pesquisa dessa chamada.

Resumo

Resumo dos N principais resultados da pesquisa especificados pela especificação de resumo.

Campos
`summary_text`	`string` O conteúdo do resumo.
`summary_skipped_reasons[]`	`SummarySkippedReason` Outros motivos para o resumo ser ignorado. Isso informa o motivo dos casos ignorados. Se nada for ignorado, esse campo não será definido.
`safety_attributes`	`SafetyAttributes` Uma coleção de categorias de atributo de segurança e as pontuações de confiança associadas a elas.
`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

Fontes de citação do segmento atribuído.

CitationMetadata

Metadados da citação.

Campos

citations[]

Citation

Citações para segmentos.

CitationSource

Fonte da citação.

Campos

reference_index

int64

Índice de referência de documento de SummaryWithMetadata.references. Ele é indexado em zero, e o valor será zero se o "reference_index" não for 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údo de trechos citados derivados do conteúdo do documento.

ChunkContent

Conteúdo em partes.

Campos

content

string

Conteúdo textual do bloco.

page_identifier

string

Identificador da página.

SafetyAttributes

Categorias de atributo de segurança e as pontuações de confiança associadas a elas.

Campos

categories[]

string

Os nomes de exibição das categorias de atributo 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, maior valor significa maior confiança. A ordem corresponde às categorias.

SummarySkippedReason

Uma enumeração para motivos de resumo ignorados.

Tipos enumerados
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Valor padrão. O motivo para o resumo ter sido ignorado não foi especificado.
`ADVERSARIAL_QUERY_IGNORED`	A consulta adversária ignorou o caso. Usado apenas quando `SummarySpec.ignore_adversarial_query` está definido como `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	A consulta que não busca um resumo ignorou o caso. O Google pula 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 o caso. O Google pula o resumo se não houver resultados de pesquisa de alta relevância. Por exemplo, o repositório de dados contém fatos sobre a empresa A, mas a consulta do usuário faz perguntas sobre a empresa B.
`POTENTIAL_POLICY_VIOLATION`	O possível caso de violação da política. O Google pula o resumo se detectar uma possível violação da política. Isso inclui conteúdo violento ou tóxico.
`LLM_ADDON_NOT_ENABLED`	O caso em que o complemento de LLM não está ativado. O Google pula o resumo se o complemento de LLM não estiver ativado.
`NO_RELEVANT_CONTENT`	O caso de conteúdo irrelevante. O Google pula o resumo se não houver conteúdo relevante nos resultados da pesquisa recuperados.
`JAIL_BREAKING_QUERY_IGNORED`	A consulta de jailbreak não diferenciava maiúsculas de minúsculas. Por exemplo, "Responda no tom de um CEO de uma empresa concorrente". Usado somente quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] está definido como `true`.
`CUSTOMER_POLICY_VIOLATION`	O caso de violação da política do cliente. O Google pula o resumo se uma violação da política do cliente for detectada. A política é definida pelo cliente.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	A consulta que não busca respostas ignorou o caso. O Google pula o resumo se a consulta não tiver um objetivo claro. Usado somente quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] está definido como `true`.
`TIME_OUT`	O caso de tempo limite. O Google pula o resumo se o tempo expirar.

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ção para o resumo fornecido.

references[]

Reference

Referências de documentos.

SearchTier

Níveis de recursos de pesquisa. Os preços podem variar de acordo com o nível. Para saber mais, consulte a documentação de preços.

Tipos enumerados
`SEARCH_TIER_UNSPECIFIED`	Valor padrão quando a enumeração não é especificada. Isso é inválido para uso.
`SEARCH_TIER_STANDARD`	Nível Standard.
`SEARCH_TIER_ENTERPRISE`	Nível Enterprise.

SearchUseCase

Define uma subdivisão adicional de SolutionType. Especificamente para SOLUTION_TYPE_SEARCH.

Tipos enumerados
`SEARCH_USE_CASE_UNSPECIFIED`	Valor usado quando não definido. Não vai ocorrer no CSS.
`SEARCH_USE_CASE_SEARCH`	Caso de uso de pesquisa. Espera que o tráfego tenha um `query` não vazio.
`SEARCH_USE_CASE_BROWSE`	Navegar pelo caso de uso. Espera que o tráfego tenha um `query` vazio.

ServingConfig

Configura metadados usados para gerar resultados no momento da exibição (por exemplo, resultados da pesquisa ou previsões de recomendação). O ServingConfig é transmitido na solicitação 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 de exibição legível da configuração de exibição. Usado na interface do usuário do Discovery. Esse campo precisa ser uma string codificada em UTF-8 com um limite de 128 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`solution_type`	`SolutionType` Obrigatório. Imutável. Especifica o tipo de solução a que uma configuração de exibição pode ser associada.
`model_id`	`string` O ID do modelo a ser usado no momento da disponibilização. No momento, apenas RecommendationModels são aceitos. Pode ser mudado, mas apenas para um modelo compatível (por exemplo, CTR de "Outras categorias que você pode gostar" para CVR de "Outras categorias que você pode gostar"). Obrigatório quando `SolutionType` é `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` A quantidade de diversidade a ser usada nos resultados do modelo de recomendação, por exemplo, `medium-diversity` ou `high-diversity`. Valores aceitos no momento: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Se não for especificado, vamos escolher o padrão com base no tipo de modelo de recomendação. Valor padrão: `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 recuperação. Para aproveitar isso, é necessário incorporar documentos. A configuração de expressão de classificação em ServingConfig se aplica a todas as solicitações de pesquisa atendidas pela configuração de veiculação. No entanto, se `SearchRequest.ranking_expression` for especificado, ele vai substituir a expressão de classificação da ServingConfig. A expressão de classificação é uma única função ou várias funções unidas por "+". ranking_expression = function, { " + ", function }; Funções compatíveis: 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 embedding de documento usado com o vetor de embedding de consulta. `dotProduct`: função de embedding entre embedding_field_path e vetor de embedding de consulta. Exemplo de expressão de classificação: Se o documento tiver um campo de incorporação doc_embedding, a expressão de classificação poderá ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
`create_time`	`Timestamp` Apenas saída. Carimbo de data/hora da criação de ServingConfig.
`update_time`	`Timestamp` Apenas saída. Carimbo de data/hora da atualização de ServingConfig.
`filter_control_ids[]`	`string` Controles de filtro para usar no caminho de veiculação. Todos os controles de filtro acionados serão aplicados. Os controles de filtro precisam estar no mesmo repositório de dados que a configuração de exibição. Máximo de 20 controles de filtros.
`boost_control_ids[]`	`string` Controles de reforço para usar no caminho de veiculação. Todos os controles de reforço acionados serão aplicados. Os controles de reforço precisam estar no mesmo repositório de dados que a configuração de exibição. Máximo de 20 controles de otimização.
`redirect_control_ids[]`	`string` IDs dos controles de redirecionamento. Apenas a primeira ação de redirecionamento acionada é aplicada, mesmo que várias sejam válidas. 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ção. Se várias condições de sinônimos corresponderem, todos os controles de sinônimos correspondentes na lista serã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ção. Se várias condições de sinônimos unidirecionais forem correspondentes, todos os controles de sinônimos unidirecionais correspondentes na lista serã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 forem correspondentes, todos os controles de não associação correspondentes na lista serão executados. A ordem não importa. 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ção. Aplicados de acordo com a ordem na lista. Um termo substituído anteriormente não pode ser substituído novamente. O número máximo de especificações é 100. Só pode ser definido se `SolutionType` for `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Condição para ignorar especificações. Se várias condições de ignorar forem correspondentes, todos os controles de ignorar correspondentes na lista serão executados. A ordem não importa. O número máximo de especificações é 100.
`promote_control_ids[]`	`string` Especificações de promoção condicional. 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 do segmento do setor. `vertical_config` pode ser apenas de um dos tipos a seguir:
`media_config`	`MediaConfig` O MediaConfig da configuração de exibição.
`generic_config`	`GenericConfig` O GenericConfig da configuração de exibição.

GenericConfig

Especifica as configurações necessárias para a descoberta genérica.No momento, oferecemos suporte a:

content_search_spec: configuração para pesquisa de conteúdo genérico.

Campos

content_search_spec

ContentSearchSpec

Especifica o comportamento esperado da pesquisa de conteúdo. Válido apenas para repositório de dados com pesquisa de conteúdo ativada.

MediaConfig

Especifica as configurações necessárias para a descoberta de mídia. No momento, oferecemos suporte a:

demote_content_watched: limite para a redução de conteúdo assistido. Os clientes podem especificar se querem usar o rebaixamento de conteúdo assistido ou a página de detalhes visualizada. Ao usar a redução de classificação de conteúdo assistido, os clientes precisam especificar os minutos ou a porcentagem assistida que excedem o limite. Assim, o conteúdo será rebaixado 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 usando a promoção de atualização de conteúdo. Se o conteúdo foi publicado dentro do período de corte, ele será 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 reduzir o resultado da recomendação. Valores aceitos no momento: `view-item`: item visualizado. `media-play`: comece/retome a exibição de um vídeo, a reprodução de uma música etc. `media-complete`: terminou ou parou no meio de um vídeo, música etc. Se não for definida, a redução do histórico de exibição não será aplicada. A redução de classificação por atualização de conteúdo ainda será aplicada.
`demote_content_watched_past_days`	`int32` Opcional. Especifica o número de dias a serem considerados para rebaixar o conteúdo assistido. Se for definido como zero ou não definido, o padrão será o máximo de 365 dias.
`content_freshness_cutoff_days`	`int32` Especifica a atualização de conteúdo usada para o resultado da recomendação. O conteúdo será rebaixado se tiver sido publicado há mais tempo do que os dias de corte de atualização de conteúdo.
Campo de união `demote_content_watched`. Especifique o limite para rebaixar o conteúdo assistido. Ele pode ser uma porcentagem ou um valor em minutos. Isso precisa ser definido para o tipo de evento `media-complete`. `demote_content_watched` pode ser apenas de um dos tipos a seguir:
`content_watched_percentage_threshold`	`float` Especifica o limite de porcentagem de conteúdo assistido para rebaixamento. O valor do limite precisa estar entre [0, 1,0], inclusive.
`content_watched_seconds_threshold`	`float` Especifica o limite de minutos assistidos para rebaixamento.

Sessão

Definição de 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 de exibição da sessão. Esse campo é usado para identificar a sessão na UI. Por padrão, o nome de exibição é o primeiro texto de consulta do turno na sessão.
`state`	`State` O estado da sessão.
`user_pseudo_id`	`string` Um identificador exclusivo para rastrear usuários.
`turns[]`	`Turn` Gira.
`labels[]`	`string` Opcional. Os rótulos da sessão. Pode ser definido como filtro em "ListSessionsRequest".
`start_time`	`Timestamp` Apenas saída. O horário em que a sessão começou.
`end_time`	`Timestamp` Apenas saída. O horário em que a sessão terminou.
`is_pinned`	`bool` Opcional. Se a sessão estiver fixada, ela vai aparecer na parte de cima da lista.

Estado

Enumeração do estado da sessão.

Tipos enumerados
`STATE_UNSPECIFIED`	Estado não especificado.
`IN_PROGRESS`	A sessão está aberta no momento.

Turn

Representa uma interação, incluindo uma consulta do usuário e uma resposta do serviço.

Campos
`query`	`Query` Opcional. A consulta do usuário. Não pode ser definido se esta vez estiver apenas regenerando uma resposta para uma vez diferente.
`answer`	`string` Opcional. O nome do recurso da resposta à consulta do usuário. Definido somente se a geração de respostas (chamada da API /answer) ocorreu nesta vez.
`assist_answer`	`string` Apenas saída. O nome do recurso da resposta do Google Assistente à consulta do usuário. Definido apenas se uma chamada de assistência (chamada de API /assist) ocorreu nesta rodada. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Para receber todas as AssistAnswers de uma sessão, defina GetSessionRequest.include_answer_details como "true". Como alternativa, para receber 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 "true", esse campo será preenchido ao receber a sessão de consulta de resposta.
`detailed_assist_answer`	`AssistAnswer` Apenas saída. Na API `ConversationalSearchService.GetSession`, se `GetSessionRequest.include_answer_details` estiver definido como "true", esse campo será preenchido ao receber a sessão do assistente.
`query_config`	`map<string, string>` Opcional. Representa metadados relacionados à configuração da consulta, por exemplo, modelo e versão de LLM usados, parâmetros do modelo (temperatura, parâmetros de embasamento etc.). O prefixo "google." é reservado para funcionalidades desenvolvidas pelo Google.

SetUpDataConnectorMetadata

Esse tipo não tem campos.

Metadados para o método DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Solicitação para o método DataConnectorService.SetUpDataConnector.

Campos
`parent`	`string` Obrigatório. O pai de `Collection`, no formato de `projects/{project}/locations/{location}`.
`collection_id`	`string` Obrigatório. O ID a ser usado para o `Collection`, que se tornará o componente final do nome do recurso do `Collection`. Um novo `Collection` é criado como parte da configuração do `DataConnector`. `DataConnector` é um recurso singleton em `Collection`, gerenciando todos os `DataStore`s do `Collection`. Esse campo precisa estar em conformidade com o padrão RFC-1034 e ter um limite de 63 caracteres. Caso contrário, um erro INVALID_ARGUMENT será retornado.
`collection_display_name`	`string` Obrigatório. `Collection`: o nome de exibição do . Precisa ser legível e usado para mostrar coleções no painel do console. String codificada em UTF-8 com limite de 1.024 caracteres.
`data_connector`	`DataConnector` Obrigatório. O `DataConnector` a ser inicializado no `Collection` recém-criado.

SingleRegionKey

Metadados para CMEKs de região única.

Campos

kms_key

string

Obrigatório. Nome do recurso de chave do KMS de região única que será usado para criptografar recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

O SiteSearchEngine captura configurações persistentes de pesquisa no site no nível do DataStore. É um valor único por repositório de dados.

Campos

name

string

O nome totalmente qualificado do recurso do mecanismo de pesquisa do site. Formato: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Informações de verificação para sites de destino na pesquisa avançada no site.

Campos

site_verification_state

SiteVerificationState

Estado da verificação do site que indica a propriedade e a validade.

verify_time

Hora da última verificação do site.

SiteVerificationState

Estado da verificação do site.

Tipos enumerados
`SITE_VERIFICATION_STATE_UNSPECIFIED`	O padrão é VERIFIED.
`VERIFIED`	A propriedade do site foi verificada.
`UNVERIFIED`	A verificação da propriedade do site está pendente ou falhou.
`EXEMPTED`	Site isento de verificação, por exemplo, um site público aberto a todos.

Sitemap

Um sitemap para o SiteSearchEngine.

Campos
`name`	`string` Apenas saída. O nome totalmente qualificado do recurso do sitemap. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` O sufixo `sitemap_id` é gerado pelo sistema.
`create_time`	`Timestamp` Apenas saída. O horário de criação do sitemap.
Campo de união `feed`. Fontes de feed compatíveis. `feed` pode ser apenas de um dos tipos a seguir:
`uri`	`string` URI público do sitemap, por exemplo, `www.example.com/sitemap.xml`.

SolutionType

O tipo de solução.

Tipos enumerados
`SOLUTION_TYPE_UNSPECIFIED`	Valor padrão.
`SOLUTION_TYPE_RECOMMENDATION`	Usado para a Recommendations AI.
`SOLUTION_TYPE_SEARCH`	Usado para a pesquisa de descoberta.
`SOLUTION_TYPE_CHAT`	Usado para casos de uso relacionados ao agente de IA generativa.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Usado para casos de uso relacionados ao agente do chat generativo. Ele é usado apenas para o mecanismo de chat generativo, e os repositórios de dados associados precisam estar registrados 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 caracteres. Se não for especificado, herda o ID do projeto da solicitação principal.
`instance_id`	`string` Obrigatório. O ID da instância da tabela de origem do Spanner.
`database_id`	`string` Obrigatório. O ID do banco de dados da tabela de origem do Spanner.
`table_id`	`string` Obrigatório. O nome da tabela do banco de dados do Spanner que precisa ser importada.
`enable_data_boost`	`bool` Se o Data Boost será aplicado na exportação do Spanner. A ativação dessa opção gera custos extras. Confira mais informações neste link.

StreamAssistRequest

Solicitação para o método AssistantService.StreamAssist.

Campos
`name`	`string` Obrigatório. O nome do recurso do `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta do usuário atual. Uma consulta vazia só é aceita se `file_ids` forem fornecidos. Nesse caso, a resposta será gerada com base nesses arquivos de contexto.
`session`	`string` Opcional. A sessão a ser usada na solicitação. Se especificado, o assistente terá acesso ao histórico da sessão, e a consulta e a resposta serão armazenadas lá. Se `-` for especificado como o ID da sessão ou ficar em branco, uma nova sessão será criada com um ID gerado automaticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Opcional. Informações sobre o usuário que iniciou a consulta.
`agents_spec`	`AgentsSpec` Opcional. Especificação dos agentes usados para atender à solicitação.
`tools_spec`	`ToolsSpec` Opcional. Especificação das ferramentas usadas para atender à solicitação.
`generation_spec`	`GenerationSpec` Opcional. Especificação da configuração de geração para a solicitação.

AgentsSpec

Especificação dos agentes usados para atender à solicitação.

Campos

agent_specs[]

AgentSpec

Opcional. Especificação dos agentes usados para atender à solicitação.

AgentSpec

Especificação de um agente.

Campos

agent_id

string

Obrigatório. ID para identificar o recurso do agente que atende à solicitação.

Esse campo precisa estar em conformidade com a RFC-1034 e ter um limite de 63 caracteres.

GenerationSpec

Especificação de geração do assistente para a solicitação. Isso permite substituir a configuração de geração padrão no nível do mecanismo.

Campos

model_id

string

Opcional. O model_id da Vertex AI usado para o modelo generativo. Se não for definido, o modelo padrão do Google Assistente será usado.

ToolsSpec

Especificação das ferramentas usadas para atender à solicitação.

Campos
`vertex_ai_search_spec`	`VertexAiSearchSpec` Opcional. Especificação da ferramenta Vertex AI para Pesquisa.
`web_grounding_spec`	`WebGroundingSpec` Opcional. Especificação da ferramenta de embasamento da Web. Se o campo estiver presente, ativa o embasamento com a pesquisa na Web. Funciona apenas 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ídeo.

ImageGenerationSpec

Esse tipo não tem campos.

Especificação da ferramenta de geração de imagens.

VertexAiSearchSpec

Especificação da ferramenta Vertex AI para Pesquisa.

Campos

data_store_specs[]

DataStoreSpec

Opcional. Especificações que definem DataStores para filtrar em uma chamada de pesquisa e configurações para esses repositórios de dados. Isso só é considerado para Engines com vários repositórios de dados.

filter

string

Opcional. A sintaxe do filtro consiste em uma linguagem de expressão para construir um predicado a partir de um ou mais campos dos documentos que estão sendo filtrados. A expressão de filtro diferencia maiúsculas de minúsculas.

Se esse campo não for reconhecido, um INVALID_ARGUMENT será retornado.

A filtragem na Vertex AI para Pesquisa é feita mapeando a chave de filtro do lado esquerdo (LHS, na sigla em inglês) para uma propriedade de chave definida no back-end da Vertex AI para Pesquisa. Esse mapeamento é definido pelo cliente no esquema dele. Por exemplo, um cliente de mídia pode ter um campo "name" no esquema. Nesse caso, o filtro ficaria assim: filter --> name:'ANY("king kong")'

Para mais informações sobre filtragem, incluindo sintaxe e operadores de filtro, consulte Filtrar.

VideoGenerationSpec

Esse tipo não tem campos.

Especificação da ferramenta de geração de vídeo.

WebGroundingSpec

Esse tipo não tem campos.

Especificação da ferramenta de embasamento da Web.

StreamAssistResponse

Resposta para o método AssistantService.StreamAssist.

Campos

answer

AssistAnswer

Objeto de recurso de resposta do Assistente que contém partes da resposta final do assistente para a consulta do usuário.

Não está presente se a resposta atual não adicionar nada ao AssistAnswer.replies enviado anteriormente.

Observe AssistAnswer.state para ver se mais partes são esperadas. 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 será preenchido.

Se o estado for SUCCEEDED, FAILED ou SKIPPED, a resposta será a última, e AssistAnswer.name terá um valor.

session_info

SessionInfo

Informações da sessão. Incluído apenas no StreamAssistResponse final do fluxo de resposta.

assist_token

string

Um ID global exclusivo que identifica o par atual de solicitação e fluxo de respostas. Usado para feedback e suporte.

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

Vigência da assinatura. LINT.IfChange

Tipos enumerados
`SUBSCRIPTION_TERM_UNSPECIFIED`	Valor padrão. 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 sobre o nível da assinatura.

Tipos enumerados
`SUBSCRIPTION_TIER_UNSPECIFIED`	Valor padrão.
`SUBSCRIPTION_TIER_SEARCH`	Nível de pesquisa. O nível de pesquisa pode acessar os recursos de pesquisa do VAIS e do NotebookLM.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Nível Pesquisa + Assistente. O nível Pesquisa + Assistente pode acessar os recursos de pesquisa do VAIS, do NotebookLM e do Google Assistente.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	Nível do NotebookLM. O NotebookLM é um nível de assinatura que só pode acessar os recursos do NotebookLM.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Nível para profissionais na linha de frente.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Nível Starter do Agentspace.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Nível do 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 do EDU.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Nível de mercado emergente do EDU Pro.

SuggestionDenyListEntry

Entrada da lista de bloqueio de sugestões que identifica a frase a ser bloqueada das sugestões e a operação aplicada a ela.

Campos

block_phrase

string

Obrigatório. Frase a ser bloqueada das sugestões veiculadas. Pode ter no máximo 125 caracteres.

match_operator

MatchOperator

Obrigatório. O operador de correspondência a ser aplicado a essa frase. Se você quer bloquear a frase exata ou qualquer sugestão que a contenha.

MatchOperator

Operador para correspondência com as sugestões geradas.

Tipos enumerados
`MATCH_OPERATOR_UNSPECIFIED`	Valor padrão. Não pode ser usado
`EXACT_MATCH`	Se a sugestão for uma correspondência exata de block_phrase, bloqueie-a.
`CONTAINS`	Se a sugestão contiver a frase bloqueada, 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. Somente entrada. O padrão de URI fornecido pelo usuário de que o `generated_uri_pattern` é gerado.
`type`	`Type` O tipo do site de destino, por exemplo, se ele deve ser incluído ou excluído.
`exact_match`	`bool` Imutável. Se for definido como "false", um uri_pattern será gerado para incluir todas as páginas cujo endereço contenha o provided_uri_pattern. Se definido como "true", um uri_pattern será gerado 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 mecanismo de pesquisa.
`generated_uri_pattern`	`string` Apenas saída. 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. Status da verificação da propriedade e validade do site.
`indexing_status`	`IndexingStatus` Apenas saída. Status da indexação.
`update_time`	`Timestamp` Apenas saída. O horário da última atualização do site de destino.
`failure_reason`	`FailureReason` Apenas saída. Motivo da falha.

FailureReason

Motivos de falha na indexação da pesquisa no site.

Campos

Campo de união failure. Motivo da falha. failure pode ser apenas de um dos tipos a seguir:

quota_failure

QuotaFailure

Falha devido à cota insuficiente.

QuotaFailure

Falha devido à cota insuficiente.

Campos

total_required_quota

int64

Esse número é uma estimativa de quanta cota total o projeto precisa para concluir a indexação.

IndexingStatus

Enumeração do status de indexação do site de destino.

Tipos enumerados
`INDEXING_STATUS_UNSPECIFIED`	O padrão é SUCCEEDED.
`PENDING`	O site de destino está na fila de atualização e será selecionado 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 exclusão. Esse é um estado de transição que resulta em: 1. exclusão do site de destino se a remoção do índice for bem-sucedida; 2. reversão do estado para "SUCCEEDED" se a remoção do índice falhar.
`CANCELLABLE`	A mudança de site de destino está pendente, mas pode ser cancelada.
`CANCELLED`	A mudança de site de destino é cancelada.

Tipo

Tipos de site de destino possíveis.

Tipos enumerados
`TYPE_UNSPECIFIED`	Esse valor não é usado. Nesse caso, o comportamento padrão do servidor é `Type.INCLUDE`.
`INCLUDE`	Inclua o site de destino.
`EXCLUDE`	Exclua o site de destino.

Locatário

Informações do locatário para uma origem de conector. Isso inclui algumas das mesmas informações armazenadas na mensagem de credencial, mas se limita apenas ao que é necessário para fornecer uma lista de locatários acessíveis ao usuário.

Campos

id

string

O ID da instância do locatário. Exemplos: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").

uri

string

O URI do locatário, se aplicável. Por exemplo, o URI de uma instância do Jira é https://my-jira-instance.atlassian.net, e um locatário do Slack não tem um URI.

display_name

string

Nome de exibição opcional para o locatário, por exemplo, "Minha equipe do Slack".

TextInput

Define a entrada de texto.

Campos

input

string

Entrada de texto.

context

ConversationContext

Contexto da conversa da entrada.

TrainCustomModelMetadata

Metadados relacionados ao progresso da operação TrainCustomModel. Isso é retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

TrainCustomModelRequest

Solicite uma mensagem para o método SearchTuningService.TrainCustomModel.

Campos
`data_store`	`string` Obrigatório. O nome do recurso do repositório de dados, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Esse campo é usado para identificar o repositório de dados em que os modelos serão treinados.
`model_type`	`string` Modelo a ser treinado. Os valores aceitos são: search-tuning: ajuste fino do sistema de pesquisa com base nos dados fornecidos.
`error_config`	`ImportErrorConfig` O local desejado dos erros ocorridos durante a ingestão e o treinamento de dados.
`model_id`	`string` Se não for fornecido, um UUID será gerado.
Campo de união `training_input`. Entrada de treinamento do modelo. `training_input` pode ser apenas de um dos tipos a seguir:
`gcs_training_input`	`GcsTrainingInput` Entrada de treinamento do Cloud Storage.

GcsTrainingInput

Entrada de dados de treinamento do Cloud Storage.

Campos
`corpus_data_path`	`string` Os dados do corpus do Cloud Storage que podem ser associados aos dados de treinamento. O formato do caminho de dados é `gs://<bucket_to_data>/<jsonl_file_name>`. Um arquivo jsonl/ndjson delimitado por nova linha. Para o modelo de ajuste de pesquisa, cada linha precisa ter _id, título e 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 treinamento. O formato do caminho de dados é `gs://<bucket_to_data>/<jsonl_file_name>`. Um arquivo jsonl/ndjson delimitado por nova linha. Para o modelo de ajuste de pesquisa, cada linha precisa ter _id e texto. Exemplo: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Caminho dos dados de treinamento do Cloud Storage cujo formato deve ser `gs://<bucket_to_data>/<tsv_file_name>`. O arquivo precisa estar no formato TSV. Cada linha precisa ter o doc_id, o query_id e a pontuação (número). Para o modelo de ajuste de pesquisa, ele precisa ter a consulta-id corpus-id score como cabeçalho do arquivo TSV. A pontuação precisa ser um número em `[0, inf+)`. Quanto maior 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. Mesmo formato de "train_data_path". Se não for fornecido, uma divisão aleatória de treinamento/teste de 80/20 será realizada em "train_data_path".

TrainCustomModelResponse

Resposta do TrainCustomModelRequest. Essa mensagem é retornada pelo campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Uma amostra de erros encontrados ao processar os dados.
`error_config`	`ImportErrorConfig` Reflete o destino dos erros completos na solicitação, se definido.
`model_status`	`string` O status do modelo treinado. Os valores possíveis são: bad-data: a qualidade dos dados de treinamento é ruim. no-improvement: o ajuste não melhorou a performance. Não será implantado. em andamento: a criação do job de treinamento do modelo está em andamento. training: o modelo está sendo treinado. avaliando: o modelo está avaliando métricas treinadas. Indexação: as métricas do modelo treinado estão sendo indexadas. pronto: o modelo está pronto para veiculação.
`metrics`	`map<string, double>` As métricas do modelo treinado.
`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 caracteres.
`transaction_id`	`string` O ID da transação com um limite de 128 caracteres.
`value`	`float` Obrigatório. Valor total diferente de zero associado à transação. Esse valor pode incluir frete, tributos ou outros ajustes no valor total que você quer incluir.
`tax`	`float` Todos os tributos associados à transação.
`cost`	`float` Todos os custos associados aos produtos. Podem ser custos de fabricação, despesas de frete não pagas pelo usuário final ou outros custos, de modo que: Lucro = `value` - `tax` - `cost`
`discount_value`	`float` O valor total dos descontos aplicados a esta transação. Esse valor precisa ser excluído de `TransactionInfo.value` Por exemplo, se um usuário pagou o valor `TransactionInfo.value`, o valor nominal (antes do desconto) da transação é a soma de `TransactionInfo.value` e `TransactionInfo.discount_value`. Isso significa que o lucro é calculado da mesma forma, independente do valor do desconto, e que `TransactionInfo.discount_value` pode ser maior que `TransactionInfo.value`: Lucro = `value` - `tax` - `cost`

UpdateAclConfigRequest

Mensagem de solicitação para o método UpdateAclConfig.

Campos
`acl_config`	`AclConfig`

UpdateAssistantRequest

Mensagem de solicitação para o método AssistantService.UpdateAssistant.

Campos

assistant

Assistant

Obrigatório. O Assistant a ser atualizado.

O campo name do Assistant é usado para identificar o Assistant a ser atualizado. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Se o usuário não tiver permissão para atualizar o Assistant, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Assistant a ser atualizado não existir, um erro NOT_FOUND será retornado.

update_mask

Lista de campos a serem atualizados.

UpdateCmekConfigMetadata

Metadados relacionados ao progresso da operação CmekConfigService.UpdateCmekConfig. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

UpdateCmekConfigRequest

Mensagem de solicitação para o método "UpdateCmekConfig". rpc.

Campos

config

CmekConfig

Obrigatório. O recurso CmekConfig.

set_default

bool

Defina o seguinte CmekConfig como o padrão a ser usado para recursos filhos se um não for especificado.

UpdateControlRequest

Solicitação para o método "UpdateControl".

Campos

control

Control

Obrigatório. O controle a ser atualizado.

update_mask

Opcional. Indica quais campos no Control fornecido serão atualizados. Não há suporte para o seguinte:

Control.name
Control.solution_type

Se não estiver definido ou vazio, todos os campos com suporte serão atualizados.

UpdateConversationRequest

Solicitação para o método "UpdateConversation".

Campos

conversation

Obrigatório. A conversa a ser atualizada.

update_mask

Indica quais campos no Conversation fornecido serão atualizados. Não há suporte para o seguinte:

Conversation.name

Se não estiver definido ou vazio, todos os campos com suporte serão atualizados.

UpdateDataConnectorRequest

Solicite uma mensagem para o método DataConnectorService.UpdateDataConnector.

Campos

data_connector

DataConnector

Obrigatório. O DataConnector a ser atualizado.

Se o usuário não tiver permissão para atualizar o DataConnector, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o DataConnector não existir, um erro NOT_FOUND será retornado.

update_mask

Indica quais campos no DataConnector fornecido serão atualizados.

Os caminhos de campo aceitos 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

Observação: a compatibilidade com esses campos pode variar de acordo com o tipo de conector. Por exemplo, nem todos os conectores são compatíveis com destination_configs.

Se um caminho de campo sem suporte ou desconhecido for fornecido, a solicitação vai retornar um erro INVALID_ARGUMENT.

UpdateDataStoreRequest

Solicite uma mensagem para o método DataStoreService.UpdateDataStore.

Campos

data_store

DataStore

Obrigatório. O DataStore a ser atualizado.

Se o usuário não tiver permissão para atualizar o DataStore, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o DataStore a ser atualizado não existir, um erro NOT_FOUND será retornado.

update_mask

Indica quais campos no DataStore fornecido serão atualizados.

Caso seja fornecido um campo sem suporte ou desconhecido, será retornado um erro INVALID_ARGUMENT.

UpdateDocumentRequest

Solicite uma mensagem para o método DocumentService.UpdateDocument.

Campos

document

Obrigatório. O documento a ser atualizado/criado.

Se o autor da chamada não tiver permissão para atualizar o Document, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Document a ser atualizado não existir e allow_missing não estiver definido, um erro NOT_FOUND será retornado.

allow_missing

bool

Se definido como true e o Document não for encontrado, um novo Document será criado.

update_mask

Indica quais campos do "documento" importado fornecido precisam ser atualizados. Se não for definido, todos os campos serão atualizados por padrão.

UpdateEngineRequest

Solicite uma mensagem para o método EngineService.UpdateEngine.

Campos

engine

Engine

Obrigatório. O Engine a ser atualizado.

Se o usuário não tiver permissão para atualizar o Engine, independente de ele existir ou não, um erro PERMISSION_DENIED será retornado.

Se o Engine a ser atualizado não existir, um erro NOT_FOUND será retornado.

update_mask

Indica quais campos no Engine fornecido serão atualizados.

Caso seja fornecido um campo sem suporte ou desconhecido, será retornado um erro INVALID_ARGUMENT.

UpdateLicenseConfigRequest

Solicite uma mensagem para o método LicenseConfigService.UpdateLicenseConfig.

Campos

license_config

LicenseConfig

Obrigatório. O LicenseConfig a ser atualizado.

update_mask

Opcional. Indica quais campos no LicenseConfig fornecido serão atualizados.

Caso seja fornecido um campo sem suporte ou desconhecido, será retornado um erro INVALID_ARGUMENT.

UpdateSchemaMetadata

Metadados para LRO UpdateSchema.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

UpdateSchemaRequest

Solicite uma mensagem para o método SchemaService.UpdateSchema.

Campos

schema

Schema

Obrigatório. O Schema a ser atualizado.

allow_missing

bool

Se definido como verdadeiro e o Schema não for encontrado, um novo Schema será criado. Nesse caso, update_mask é ignorado.

UpdateServingConfigRequest

Solicitação para o método "UpdateServingConfig".

Campos

serving_config

ServingConfig

Obrigatório. O ServingConfig a ser atualizado.

update_mask

Indica quais campos no ServingConfig fornecido serão atualizados. Não há suporte para o seguinte:

ServingConfig.name

Se não for definido, todos os campos com suporte serão atualizados.

UpdateSessionRequest

Solicitação para o método UpdateSession.

Campos

session

Obrigatório. A sessão a ser atualizada.

update_mask

Indica quais campos no Session fornecido serão atualizados. Não há suporte para o seguinte:

Session.name

Se não estiver definido ou vazio, todos os campos com suporte serão atualizados.

UpdateTargetSiteMetadata

Metadados relacionados ao progresso da operação SiteSearchEngineService.UpdateTargetSite. Isso será retornado pelo campo google.longrunning.Operation.metadata.

Campos

create_time

Horário de criação da operação.

update_time

Horário da última atualização da operação. Se a operação for concluída, esse também será o horário de término.

UpdateTargetSiteRequest

Solicite uma mensagem para o método SiteSearchEngineService.UpdateTargetSite.

Campos

target_site