Package google.cloud.discoveryengine.v1

QueryClassificationInfo

Es la fecha y hora en que se produjo la búsqueda reciente.

score

double

Es la puntuación de cada sugerencia. La puntuación está en el rango [0, 1].

AdvancedSiteSearchConfig

Son los datos de configuración de la búsqueda avanzada en el sitio.

Campos

disable_initial_index

bool

Si se establece como verdadero, se inhabilita la indexación inicial para DataStore.

disable_automatic_refresh

bool

Si se establece como verdadero, se inhabilita la actualización automática para DataStore.

AlertPolicyConfig

Es la configuración de alerta a nivel del conector.

Campos

alert_policy_name

string

Inmutable. Es el nombre del recurso AlertPolicy completamente calificado.

alert_enrollments[]

AlertEnrollment

Opcional. Son los estados de inscripción de cada alerta.

AlertEnrollment

Es el estado de inscripción de la alerta.

Campos

alert_id

string

Inmutable. Es el ID de una alerta.

enroll_state

EnrollStates

Obligatorio. Es el estado de inscripción de un cliente.

EnrollStates

Es la enumeración del estado de inscripción de la alerta.

Enums
`ENROLL_STATES_UNSPECIFIED`	Valor predeterminado. Se usa para los clientes que no respondieron a la política de alertas.
`ENROLLED`	El cliente está inscrito en esta política.
`DECLINED`	El cliente rechazó esta política.

AlertPolicyResourceConfig

Es la configuración de alerta a nivel del recurso. Se usa en: * UserLicense * EngineUserData El AlertPolicyConfig en el conector de datos tiene el mismo uso. No hay una forma sencilla de migrar.

Campos
`alert_policy`	`string` Inmutable. Es el nombre del recurso AlertPolicy completamente calificado.
`alert_enrollments[]`	`AlertEnrollment` Opcional. Es el estado de inscripción de cada alerta.
`contact_details[]`	`ContactDetails` Opcional. Son los detalles de contacto de cada política de alertas.
`language_code`	`string` Opcional. Código de idioma que se usa para las notificaciones

AlertEnrollment

Es el estado de inscripción de la alerta.

Campos

alert_id

string

Inmutable. Es el ID de una alerta.

enroll_state

EnrollState

Obligatorio. Es el estado de inscripción de un cliente.

notification_params

map<string, string>

Opcional. Son los parámetros que se usan para crear una instancia de una notificación. Se usa para las notificaciones que se activan cuando se registra. No se almacena. * Correos electrónicos de bienvenida a Gemini Business * Correos electrónicos de invitación para usuarios de Gemini Business

EnrollState

Es la enumeración del estado de inscripción de la alerta.

Enums
`ENROLL_STATE_UNSPECIFIED`	Valor predeterminado. Se usa para los clientes que no respondieron a la política de alertas.
`ENROLLED`	El cliente está inscrito en esta política.
`DECLINED`	El cliente rechazó esta política.

AlloyDbSource

Es la fuente de la que se importan los datos de AlloyDB.

Campos
`project_id`	`string` Es el ID del proyecto que contiene la fuente de AlloyDB. Tiene un límite de longitud de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`location_id`	`string` Obligatorio. Ubicación de AlloyDB desde la que se copiarán los datos, con un límite de 256 caracteres.
`cluster_id`	`string` Obligatorio. Es el clúster de AlloyDB desde el que se copiarán los datos, con un límite de 256 caracteres.
`database_id`	`string` Obligatorio. Es la base de datos de AlloyDB desde la que se copiarán los datos, con un límite de 256 caracteres.
`table_id`	`string` Obligatorio. Es la tabla de AlloyDB desde la que se copiarán los datos, con un límite de 256 caracteres.
`gcs_staging_dir`	`string` Es el directorio intermedio de Cloud Storage que se usa para la importación, con un límite de 2,000 caracteres. Se puede especificar si se desea que AlloyDB exporte a un directorio específico de Cloud Storage. Asegúrate de que la cuenta de servicio de AlloyDB tenga los permisos de administrador de Cloud Storage necesarios para acceder al directorio de Cloud Storage especificado.

Respuesta

Define una respuesta.

Campos
`name`	`string` Inmutable. Nombre completamente calificado `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` Es el estado de la generación de respuestas.
`answer_text`	`string` Es la respuesta textual.
`citations[]`	`Citation` Citas.
`grounding_supports[]`	`GroundingSupport` Opcional. Compatibilidad con la fundamentación.
`references[]`	`Reference` Referencias
`related_questions[]`	`string` Preguntas relacionadas sugeridas
`steps[]`	`Step` Pasos de generación de respuestas.
`query_understanding_info`	`QueryUnderstandingInfo` Es información sobre la comprensión de la búsqueda.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Se agregaron motivos adicionales por los que se omitió la respuesta. Esto proporciona el motivo por el que se ignoraron los casos. Si no se omite nada, este campo no se establece.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo de creación de la respuesta.
`complete_time`	`Timestamp` Solo salida. Es la marca de tiempo de la respuesta completada.
`safety_ratings[]`	`SafetyRating` Opcional. Calificaciones de seguridad
`grounding_score`	`double` Es una puntuación en el rango de [0, 1] que describe qué tan fundamentada está la respuesta en los fragmentos de referencia.

AnswerSkippedReason

Es una enumeración de los motivos por los que se omitió la respuesta.

Enums
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se especificó el motivo por el que se omitió la respuesta.
`ADVERSARIAL_QUERY_IGNORED`	Es la consulta adversaria que se ignoró.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	La búsqueda que no busca respuestas (ignorar mayúsculas y minúsculas) Google omite la respuesta si la búsqueda es una conversación trivial.
`OUT_OF_DOMAIN_QUERY_IGNORED`	Es la búsqueda fuera del dominio que ignoró las mayúsculas y minúsculas. Google omite la respuesta si no hay resultados de la búsqueda de alta relevancia.
`POTENTIAL_POLICY_VIOLATION`	Es el caso de posible incumplimiento de política. Google omite la respuesta si se detecta un posible incumplimiento de política. Esto incluye contenido que puede ser violento o tóxico.
`NO_RELEVANT_CONTENT`	Es el caso en el que no hay contenido relevante. Google omite la respuesta si no hay contenido relevante en los resultados de la búsqueda recuperados.
`JAIL_BREAKING_QUERY_IGNORED`	La búsqueda de jailbreak ignoró las mayúsculas y minúsculas. Por ejemplo, "Responde con el tono del director ejecutivo de una empresa de la competencia". Google omite la respuesta si la búsqueda se clasifica como una búsqueda de evasión.
`CUSTOMER_POLICY_VIOLATION`	Es el caso de incumplimiento de política del cliente. Google omite el resumen si se detecta un incumplimiento de la política del cliente. El cliente define la política.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	Es la búsqueda que no busca respuestas y que ignora las mayúsculas y minúsculas. Google omite la respuesta si la búsqueda no tiene una intención clara.
`LOW_GROUNDED_ANSWER`	Es el caso de respuesta con base baja. Google omite la respuesta si no se pudo generar una respuesta fundamentada.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	Es la clasificación de la búsqueda definida por el usuario que ignora las mayúsculas y minúsculas. Google omite la respuesta si la búsqueda se clasifica como una clasificación de búsqueda definida por el usuario.
`UNHELPFUL_ANSWER`	Es el caso de respuesta no útil. Google omite la respuesta si no es útil. Esto puede deberse a varios factores, incluidos, sin limitaciones, los siguientes: la búsqueda no tiene respuesta, la respuesta no es pertinente para la búsqueda o la respuesta no está bien formateada.

Cita

Es la información de la cita de un segmento.

Campos

start_index

int64

El índice indica el inicio del segmento, medido en bytes (Unicode UTF-8). Si hay caracteres multibyte,como caracteres no ASCII, la medición del índice es mayor que la longitud de la cadena.

end_index

int64

Es el final del segmento atribuido, exclusivo. Se mide en bytes (Unicode UTF-8). Si hay caracteres multibyte,como caracteres no ASCII, la medición del índice es mayor que la longitud de la cadena.

sources[]

CitationSource

Son las fuentes de citas del segmento atribuido.

CitationSource

Es la fuente de la cita.

Campos

reference_id

string

Es el ID de la fuente de la cita.

GroundingSupport

Es la fundamentación de una afirmación en answer_text.

Campos
`start_index`	`int64` Obligatorio. El índice indica el inicio del reclamo, medido en bytes (Unicode UTF-8).
`end_index`	`int64` Obligatorio. Es el final del reclamo, sin incluirlo.
`sources[]`	`CitationSource` Opcional. Son las fuentes de la cita de la afirmación.
`grounding_score`	`double` Es una puntuación en el rango de [0, 1] que describe qué tan fundamentada está una afirmación específica en las referencias. Un valor más alto significa que la referencia respalda mejor el reclamo.
`grounding_check_required`	`bool` Indica que esta afirmación requirió una verificación de fundamentación. Cuando el sistema decidió que esta afirmación no requería una verificación de atribución o fundamentación, este campo se establece como falso. En ese caso, no se realizó ninguna verificación de fundamentación para la afirmación y, por lo tanto, no se devolvieron `grounding_score` ni `sources`.

QueryUnderstandingInfo

Es información sobre la comprensión de la búsqueda.

Campos

query_classification_info[]

Es información de clasificación de la búsqueda.

QueryClassificationInfo

Es información de clasificación de la búsqueda.

Campos

type

Type

Es el tipo de clasificación de la búsqueda.

positive

bool

Es el resultado de la clasificación.

Tipo

Son los tipos de clasificación de búsquedas.

Enums
`TYPE_UNSPECIFIED`	Es el tipo de clasificación de la búsqueda sin especificar.
`ADVERSARIAL_QUERY`	Es el tipo de clasificación de consultas adversariales.
`NON_ANSWER_SEEKING_QUERY`	Es el tipo de clasificación de búsqueda que no busca respuestas, sino que es de conversación.
`JAIL_BREAKING_QUERY`	Es el tipo de clasificación de consultas para evitar la restricción.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de clasificación de búsqueda que no busca respuestas, para cuando no hay una intención clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Es el tipo de clasificación de la búsqueda definido por el usuario.

Reference

Referencia.

Campos
Campo de unión `content`. Contenido del resultado de la búsqueda. `content` puede ser solo uno de los siguientes:
`unstructured_document_info`	`UnstructuredDocumentInfo` Es información de documentos no estructurados.
`chunk_info`	`ChunkInfo` Es información sobre el fragmento.
`structured_document_info`	`StructuredDocumentInfo` Es información estructurada del documento.

ChunkInfo

Es información sobre el fragmento.

Campos
`chunk`	`string` Nombre del recurso de fragmento.
`content`	`string` Fragmenta el contenido textual.
`document_metadata`	`DocumentMetadata` Son los metadatos del documento.
`relevance_score`	`float` Es la relevancia del fragmento para una búsqueda determinada. Los valores varían de 0.0 (completamente irrelevante) a 1.0 (completamente relevante). Este valor es solo para fines informativos. Puede cambiar para la misma búsqueda y fragmento en cualquier momento debido a un nuevo entrenamiento del modelo o a un cambio en la implementación.

DocumentMetadata

Son los metadatos del documento.

Campos
`document`	`string` Nombre del recurso del documento.
`uri`	`string` Es el URI del documento.
`title`	`string` y "title".
`page_identifier`	`string` Es el identificador de la página.
`struct_data`	`Struct` Son los metadatos JSON estructurados del documento. Se completa con los datos de struct del fragmento en el resultado de la búsqueda.

StructuredDocumentInfo

Es información de búsqueda estructurada.

Campos
`document`	`string` Nombre del recurso del documento.
`struct_data`	`Struct` Datos de búsqueda estructurados.
`title`	`string` Solo salida. Es el título del documento.
`uri`	`string` Solo salida. Es el URI del documento.

UnstructuredDocumentInfo

Es información de documentos no estructurados.

Campos
`document`	`string` Nombre del recurso del documento.
`uri`	`string` Es el URI del documento.
`title`	`string` y "title".
`chunk_contents[]`	`ChunkContent` Es la lista de contenido de fragmentos citados que se deriva del contenido del documento.
`struct_data`	`Struct` Son los metadatos JSON estructurados del documento. Se completa con los datos de struct del fragmento en el resultado de la búsqueda.

ChunkContent

Divide el contenido en fragmentos.

Campos

content

string

Fragmenta el contenido textual.

page_identifier

string

Es el identificador de la página.

relevance_score

float

Es la relevancia del fragmento para una búsqueda determinada. Los valores varían de 0.0 (completamente irrelevante) a 1.0 (completamente relevante). Este valor es solo para fines informativos. Puede cambiar para la misma búsqueda y fragmento en cualquier momento debido a un nuevo entrenamiento del modelo o a un cambio en la implementación.

Estado

Es una enumeración del estado de la generación de respuestas.

Enums
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	En este momento, se está generando la respuesta.
`FAILED`	Actualmente, no se pudo generar la respuesta.
`SUCCEEDED`	Se generó la respuesta correctamente.
`STREAMING`	En este momento, se está generando la respuesta.

Paso

Es la información del paso.

Campos
`state`	`State` Es el estado del paso.
`description`	`string` Es la descripción del paso.
`thought`	`string` Es la idea del paso.
`actions[]`	`Action` Acciones.

Acción

Acción.

Campos

observation

Observation

Observación.

Campo de unión action. Es la acción. action puede ser solo uno de los siguientes:

search_action

SearchAction

Acción de búsqueda.

Observación

Observación.

Campos

search_results[]

SearchResult

Son los resultados de la búsqueda que se observan en la acción de búsqueda. Pueden ser información de fragmentos o información de fragmentos, según el tipo de cita que establezca el usuario.

SearchResult

Campos
`document`	`string` Nombre del recurso del documento.
`uri`	`string` Es el URI del documento.
`title`	`string` y "title".
`snippet_info[]`	`SnippetInfo` Si citation_type es DOCUMENT_LEVEL_CITATION, completa los resúmenes a nivel del documento.
`chunk_info[]`	`ChunkInfo` Si citation_type es CHUNK_LEVEL_CITATION y el modo de fragmentos está activado, se debe propagar la información del fragmento.
`struct_data`	`Struct` Representación de datos Son los datos estructurados en formato JSON del documento. Se completa con los datos de struct del documento o del fragmento en el resultado de la búsqueda.

ChunkInfo

Es información sobre el fragmento.

Campos

chunk

string

Nombre del recurso de fragmento.

content

string

Fragmenta el contenido textual.

relevance_score

float

SnippetInfo

Es la información del fragmento.

Campos

snippet

string

Contenido del fragmento.

snippet_status

string

Es el estado del fragmento definido por el equipo de Búsqueda.

SearchAction

Acción de búsqueda.

Campos

query

string

Es la búsqueda.

Estado

Es una enumeración del estado del paso.

Enums
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	El paso está en curso.
`FAILED`	El paso falló.
`SUCCEEDED`	El paso se completó correctamente.

AnswerGenerationSpec

Es la especificación para la generación de respuestas.

Campos

user_defined_classifier_spec

UserDefinedClassifierSpec

Opcional. Es la especificación del clasificador especificado por el usuario.

UserDefinedClassifierSpec

Es la especificación del clasificador definido por el usuario.

Campos
`enable_user_defined_classifier`	`bool` Opcional. Indica si se debe habilitar e incluir el clasificador definido por el usuario.
`preamble`	`string` Opcional. Es el preámbulo que se usará para el clasificador definido por el usuario.
`model_id`	`string` Opcional. Es el ID del modelo que se usará para el clasificador definido por el usuario.
`task_marker`	`string` Opcional. Es el marcador de tarea que se usará para el clasificador definido por el usuario.
`top_p`	`double` Opcional. Es el valor de top-p que se usará para el clasificador definido por el usuario.
`top_k`	`int64` Opcional. Es el valor de los k elementos principales que se usará para el clasificador definido por el usuario.
`temperature`	`double` Opcional. Es el valor de temperatura que se usará para el clasificador definido por el usuario.
`seed`	`int32` Opcional. Es el valor de semilla que se usará para el clasificador definido por el usuario.

AnswerQueryRequest

Mensaje de solicitud para el método ConversationalSearchService.AnswerQuery.

Campos
`serving_config`	`string` Obligatorio. Es el nombre del recurso de la configuración de entrega de la Búsqueda, como `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` o `projects//locations/global/collections/default_collection/dataStores//servingConfigs/default_serving_config`. Este campo se usa para identificar el nombre de la configuración de entrega, el conjunto de modelos que se usan para realizar la búsqueda.
`query`	`Query` Obligatorio. Es la consulta del usuario actual.
`session`	`string` Es el nombre del recurso de sesión. No requerido. Cuando no se configura el campo de sesión, la API se encuentra en modo sin sesión. Admitimos el modo de sesión automática: Los usuarios pueden usar el símbolo comodín `-` como ID de sesión. Se generará y asignará automáticamente un nuevo ID.
`safety_spec`	`SafetySpec` Especificación del modelo
`related_questions_spec`	`RelatedQuestionsSpec` Es la especificación de preguntas relacionadas.
`grounding_spec`	`GroundingSpec` Opcional. Es la especificación de fundamentación.
`answer_generation_spec`	`AnswerGenerationSpec` Es la especificación de generación de respuestas.
`search_spec`	`SearchSpec` Es la especificación de la búsqueda.
`query_understanding_spec`	`QueryUnderstandingSpec` Es la especificación de comprensión de la búsqueda.
`asynchronous_mode (deprecated)`	`bool` Este elemento está obsoleto. Obsoleto: Este campo ya no está disponible. Se admitirá la API de Streaming Answer. Control del modo asíncrono. Si está habilitado, la respuesta se devolverá con el nombre del recurso de respuesta o sesión sin la respuesta final. Los usuarios de la API deben realizar el sondeo para obtener el estado más reciente de la respuesta o la sesión llamando al método `ConversationalSearchService.GetAnswer` o `ConversationalSearchService.GetSession`.
`user_pseudo_id`	`string` Es un identificador único para hacer un seguimiento de los visitantes. Por ejemplo, esto se podría implementar con una cookie HTTP, que debería poder identificar de forma única a un visitante en un solo dispositivo. Este identificador único no debe cambiar si el visitante accede al sitio web o sale de él. Este campo NO debe tener un valor fijo, como `unknown_visitor`. El campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Google Cloud Document para obtener más detalles.
`end_user_spec`	`EndUserSpec` Opcional. Especificación del usuario final.

AnswerGenerationSpec

Es la especificación de generación de respuestas.

Campos
`model_spec`	`ModelSpec` Es la especificación del modelo de generación de respuestas.
`prompt_spec`	`PromptSpec` Es la especificación de la instrucción de generación de respuestas.
`include_citations`	`bool` Especifica si se deben incluir metadatos de citas en la respuesta. El valor predeterminado es `false`.
`answer_language_code`	`string` Es el código de idioma de la respuesta. Usa las etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental.
`ignore_adversarial_query`	`bool` Especifica si se deben filtrar las búsquedas adversarias. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas adversarias. No se devuelve ninguna respuesta si la búsqueda se clasifica como adversarial. Por ejemplo, un usuario puede hacer una pregunta sobre comentarios negativos sobre la empresa o enviar una búsqueda diseñada para generar resultados inseguros que incumplan las políticas. Si este campo se establece en `true`, omitimos la generación de respuestas para las búsquedas adversariales y, en su lugar, devolvemos mensajes de resguardo.
`ignore_non_answer_seeking_query`	`bool` Especifica si se deben filtrar las búsquedas que no buscan respuestas. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas que buscan respuestas. No se devuelve ninguna respuesta si la búsqueda se clasifica como una búsqueda que no busca respuestas. Si este campo se establece en `true`, omitimos la generación de respuestas para las búsquedas que no son de respuesta y, en su lugar, devolvemos mensajes de resguardo.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica si se deben filtrar las preguntas que intentan evadir las restricciones. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas que intentan eludir las restricciones. No se devuelve ningún resumen si la búsqueda se clasifica como una búsqueda de evasión de restricciones. Un usuario puede agregar instrucciones a la búsqueda para cambiar el tono, el estilo, el idioma o el contenido de la respuesta, o bien pedirle al modelo que actúe como una entidad diferente, p.ej., "Responde con el tono del CEO de una empresa de la competencia". Si este campo se establece en `true`, omitimos la generación de resúmenes para las búsquedas de evasión de restricciones y, en su lugar, devolvemos mensajes de resguardo.
`ignore_low_relevant_content`	`bool` Especifica si se deben filtrar las búsquedas que tienen baja relevancia. Si este campo se establece en `false`, se usarán todos los resultados de la búsqueda, independientemente de su relevancia, para generar respuestas. Si se configura como `true` o no se establece, el servicio determinará el comportamiento automáticamente.

ModelSpec

Es la especificación del modelo de generación de respuestas.

Campos

model_version

string

Versión del modelo. Si no se configura, se usará el modelo estable predeterminado. Los valores permitidos son stable y preview.

PromptSpec

Es la especificación de la instrucción de generación de respuestas.

Campos

preamble

string

Preámbulo personalizado

EndUserSpec

Especificación del usuario final.

Campos

end_user_metadata[]

EndUserMetaData

Opcional. Son los metadatos del usuario final.

EndUserMetaData

Son los metadatos del usuario final.

Campos

Campo de unión content. Contenido del resultado de la búsqueda. content puede ser solo uno de los siguientes:

chunk_info

ChunkInfo

Es información sobre el fragmento.

ChunkInfo

Es información sobre el fragmento.

Campos

content

string

Fragmenta el contenido textual. Tiene un límite de 8,000 caracteres.

document_metadata

QueryClassificationSpec

Son los metadatos del documento del fragmento actual.

DocumentMetadata

Los metadatos del documento contienen la información del documento del fragmento actual.

Campos

title

string

Es el título del documento.

GroundingSpec

Es la especificación de fundamentación.

Campos

include_grounding_supports

bool

Opcional. Especifica si se deben incluir grounding_supports en la respuesta. El valor predeterminado es false.

Cuando este campo se establece en true, la respuesta que se devuelve tendrá grounding_score y contendrá GroundingSupports para cada afirmación.

filtering_level

FilteringLevel

Opcional. Especifica si se debe habilitar el filtrado según la puntuación de fundamentación y en qué nivel.

FilteringLevel

Es el nivel para filtrar según la fundamentación de la respuesta.

Enums
`FILTERING_LEVEL_UNSPECIFIED`	El valor predeterminado es sin filtro.
`FILTERING_LEVEL_LOW`	Filtra las respuestas según un umbral bajo.
`FILTERING_LEVEL_HIGH`	Filtra las respuestas según un umbral alto.

QueryUnderstandingSpec

Es la especificación de comprensión de la búsqueda.

Campos

query_classification_spec

Es la especificación de clasificación de la búsqueda.

query_rephraser_spec

QueryRephraserSpec

Es la especificación del reformulador de consultas.

disable_spell_correction

bool

Opcional. Indica si se debe inhabilitar la corrección ortográfica. El valor predeterminado es false.

QueryClassificationSpec

Es la especificación de clasificación de la búsqueda.

Campos

types[]

Type

Son los tipos de clasificación de búsquedas habilitados.

Tipo

Son los tipos de clasificación de búsquedas.

Enums
`TYPE_UNSPECIFIED`	Es el tipo de clasificación de la búsqueda sin especificar.
`ADVERSARIAL_QUERY`	Es el tipo de clasificación de consultas adversariales.
`NON_ANSWER_SEEKING_QUERY`	Es el tipo de clasificación de búsqueda que no busca respuestas, sino que es de conversación.
`JAIL_BREAKING_QUERY`	Es el tipo de clasificación de consultas para evitar la restricción.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de clasificación de búsqueda que no busca respuestas, para cuando no hay una intención clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Es el tipo de clasificación de la búsqueda definido por el usuario.

QueryRephraserSpec

Es la especificación del reformulador de consultas.

Campos

disable

bool

Inhabilita el reformulador de consultas.

max_rephrase_steps

int32

Cantidad máxima de pasos de reformulación. La cantidad máxima es de 5 pasos. Si no se establece o se establece en un valor inferior a 1, se establecerá en 1 de forma predeterminada.

model_spec

ModelSpec

Opcional. Es la especificación del modelo de Reformulación de la búsqueda.

ModelSpec

Es la especificación del modelo de Reformulación de la búsqueda.

Campos

model_type

ModelType

Opcional. Es el tipo de modelo de reformulación de la búsqueda habilitado. Si no se configura, se usará LARGE de forma predeterminada.

ModelType

Son los tipos de reformulación de la búsqueda. Actualmente, solo se admiten selecciones de modelos de un solo salto (max_rephrase_steps = 1). Para el parafraseo de varios saltos (max_rephrase_steps > 1), solo hay un modelo predeterminado.

Enums
`MODEL_TYPE_UNSPECIFIED`	Tipo de modelo sin especificar.
`SMALL`	Modelo pequeño de reformulación de búsquedas. Modelo Gemini 1.0 XS.
`LARGE`	Modelo de reformulación de búsquedas grandes. Modelo Gemini 1.0 Pro.

RelatedQuestionsSpec

Es la especificación de preguntas relacionadas.

Campos

enable

bool

Habilita la función de preguntas relacionadas si es verdadero.

SafetySpec

Especificación de seguridad. Hay dos casos de uso: 1. Cuando solo se establece safety_spec.enable, se aplicará el umbral BLOCK_LOW_AND_ABOVE para todas las categorías. 2. Cuando se establece safety_spec.enable y algunos safety_settings, solo se aplican los safety_settings especificados.

Campos

enable

bool

Habilita el filtrado de seguridad en la respuesta. El valor predeterminado es falso.

safety_settings[]

SafetySetting

Opcional. Configuración de seguridad. Esta configuración solo es efectiva cuando safety_spec.enable es verdadero.

SafetySetting

Configuración de seguridad.

Campos

category

HarmCategory

Obligatorio. Es la categoría de daño.

threshold

HarmBlockThreshold

Obligatorio. El umbral de bloqueo de daño.

HarmBlockThreshold

Niveles de umbral basados en la probabilidad para el bloqueo.

Enums
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Umbral de bloqueo de daño no especificado.
`BLOCK_LOW_AND_ABOVE`	Bloquea el umbral bajo y superior (es decir, bloquea más).
`BLOCK_MEDIUM_AND_ABOVE`	Bloquea el umbral medio y superior.
`BLOCK_ONLY_HIGH`	Bloquea solo el umbral alto (es decir, bloquea menos).
`BLOCK_NONE`	No bloquear.
`OFF`	Desactiva el filtro de seguridad.

SearchSpec

Es la especificación de la búsqueda.

Campos

Campo de unión input. Son los parámetros de búsqueda que controlan el comportamiento de la búsqueda. O bien, proporciona una lista de resultados de la búsqueda para generar la respuesta. input puede ser solo uno de los siguientes:

search_params

SearchParams

Son los parámetros de búsqueda.

search_result_list

SearchResultList

Lista de resultados de la búsqueda.

SearchParams

Son los parámetros de búsqueda.

Campos
`max_return_results`	`int32` Cantidad de resultados de la búsqueda que se devolverán. El valor predeterminado es 10.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los documentos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas. Se usará para filtrar los resultados de la búsqueda, lo que puede afectar la respuesta de la Respuesta. Si este campo no se puede reconocer, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave del filtro del LHD a una propiedad clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, los clientes de medios pueden tener un campo "nombre" en su esquema. En este caso, el filtro se vería de la siguiente manera: filter --> name:'ANY("king kong")' Para obtener más información sobre los filtros, incluidos los operadores y la sintaxis de filtros, consulta Filtro.
`boost_spec`	`BoostSpec` Es la especificación de refuerzo para reforzar ciertos documentos en los resultados de la búsqueda, lo que puede afectar la respuesta a la consulta de respuesta. Para obtener más información sobre el aumento, consulta Aumento.
`order_by`	`string` Es el orden en que se muestran los documentos. Los documentos se pueden ordenar por un campo en un objeto `Document`. Déjalo sin configurar si se ordena por relevancia. La expresión `order_by` distingue mayúsculas de minúsculas. Para obtener más información sobre el ordenamiento, consulta Ordenamiento. Si este campo no se puede reconocer, se devuelve un `INVALID_ARGUMENT`.
`search_result_mode`	`SearchResultMode` Especifica el modo de resultado de la búsqueda. Si no se especifica, el modo de resultado de la búsqueda se establece de forma predeterminada como `DOCUMENTS`. Consulta cómo analizar y fragmentar documentos
`data_store_specs[]`	`DataStoreSpec` Son especificaciones que definen los almacenes de datos para filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se considera para los motores con casos de uso de varios dataStores. Para un solo DataStore dentro de un motor, se deben usar las especificaciones en el nivel superior.

SearchResultList

Lista de resultados de la búsqueda.

Campos

search_results[]

SearchResult

Resultados de la búsqueda.

SearchResult

Resultado de la búsqueda.

Campos

Campo de unión content. Contenido del resultado de la búsqueda. content puede ser solo uno de los siguientes:

unstructured_document_info

UnstructuredDocumentInfo

Es información de documentos no estructurados.

chunk_info

ChunkInfo

Es información sobre el fragmento.

ChunkInfo

Es información sobre el fragmento.

Campos

chunk

string

Nombre del recurso de fragmento.

content

string

Fragmenta el contenido textual.

document_metadata

Son los metadatos del documento del fragmento actual.

DocumentMetadata

Los metadatos del documento contienen la información del documento del fragmento actual.

Campos

uri

string

Es el URI del documento.

title

string

Es el título del documento.

UnstructuredDocumentInfo

Es información de documentos no estructurados.

Campos
`document`	`string` Nombre del recurso del documento.
`uri`	`string` Es el URI del documento.
`title`	`string` y "title".
`document_contexts[]`	`DocumentContext` Es una lista de contextos del documento. El contenido se usará para la generación de respuestas. Se supone que este es el contenido principal del documento, que puede ser extenso y completo.
`extractive_segments[]`	`ExtractiveSegment` Es la lista de segmentos extractivos.
`extractive_answers[] (deprecated)`	`ExtractiveAnswer` Este elemento está obsoleto. Obsoleto: Este campo está obsoleto y no tendrá ningún efecto en la generación de respuestas. Usa los campos document_contexts y extractive_segments. Es la lista de respuestas extractivas.

DocumentContext

Es el contexto del documento.

Campos

page_identifier

string

Es el identificador de la página.

content

string

Es el contenido del documento que se usará para generar respuestas.

ExtractiveAnswer

Respuesta extractiva. Guía

Campos

page_identifier

string

Es el identificador de la página.

content

string

Es el contenido de la respuesta extractiva.

ExtractiveSegment

Es un segmento extractivo. La guía de generación de respuestas solo se usará si document_contexts está vacío. Se supone que son fragmentos más cortos.

Campos

page_identifier

string

Es el identificador de la página.

content

string

Contenido de segmentos extractivos.

AnswerQueryResponse

Mensaje de respuesta para el método ConversationalSearchService.AnswerQuery.

Campos

answer

Answer

Es el objeto del recurso de respuesta. Si AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps es mayor que 1, usa Answer.name para recuperar información de la respuesta con la API de ConversationalSearchService.GetAnswer.

session

PolicyEnforcementResult

Objeto de recurso de sesión. Solo estará disponible cuando el campo de sesión esté configurado y sea válido en la solicitud de AnswerQueryRequest.

answer_query_token

string

Es un ID único global que se usa para el registro.

AssistAnswer

Es el recurso de AssistAnswer, que es la parte principal de AssistResponse.

Campos
`name`	`string` Inmutable. Es el identificador. Es el nombre del recurso `AssistAnswer`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}` Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
`state`	`State` Es el estado de la generación de respuestas.
`replies[]`	`Reply` Son las respuestas del asistente.
`assist_skipped_reasons[]`	`AssistSkippedReason` Son los motivos por los que no se responde la llamada de asistencia.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Opcional. El campo contiene información sobre los resultados de las distintas verificaciones de políticas, como las frases prohibidas o las verificaciones de Model Armor. Este campo solo se completa si se omitió la llamada de asistencia debido a un incumplimiento de política.

AssistSkippedReason

Posibles motivos por los que no se responde una llamada de asistencia.

Enums
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se especificó el motivo de omisión.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	El asistente ignoró la búsqueda porque no parecía que se buscara una respuesta.
`CUSTOMER_POLICY_VIOLATION`	El asistente ignoró la búsqueda o se negó a responder debido a un incumplimiento de la política del cliente (p.ej., la búsqueda o la respuesta contenían una frase prohibida).

CustomerPolicyEnforcementResult

Son los resultados de la aplicación de políticas para el cliente. Contiene los resultados de las distintas verificaciones de políticas, como las frases prohibidas o las verificaciones de Model Armor.

Campos

verdict

Verdict

Es el veredicto final sobre la aplicación de la política para el cliente. Si solo una política bloqueó el procesamiento, el veredicto es BLOCK.

policy_results[]

Son los resultados de la aplicación de políticas para el cliente. Se propaga solo si se omitió la llamada de asistencia debido a un incumplimiento de política. Contiene los resultados de los filtros que bloquearon el procesamiento de la búsqueda.

BannedPhraseEnforcementResult

Es el resultado de la aplicación de la política para clientes sobre la política de frases prohibidas.

Campos

banned_phrases[]

string

Son las frases prohibidas que se encontraron en la búsqueda o la respuesta.

ModelArmorEnforcementResult

Es el resultado de la aplicación de la política para el cliente en relación con la política de Model Armor.

Campos

Campo de unión result. Es el resultado de la política de Model Armor. result puede ser solo uno de los siguientes:

model_armor_violation

string

Es el incumplimiento de Model Armor que se encontró.

error

BannedPhraseEnforcementResult

Es el error que devuelve Model Armor si la aplicación de la política falló por algún motivo.

PolicyEnforcementResult

Es el resultado de la aplicación de la política del cliente para un solo tipo de política.

Campos

Campo de unión enforcement_result. Es el resultado específico del tipo de política. Puede ser un error o información detallada sobre el resultado de la aplicación de políticas. enforcement_result puede ser solo uno de los siguientes:

banned_phrase_enforcement_result

Es el resultado de la aplicación de la política sobre frases prohibidas.

model_armor_enforcement_result

ModelArmorEnforcementResult

Es el resultado de la aplicación de la política de Model Armor.

Veredicto

Es el veredicto de la aplicación de la política para clientes.

Enums
`UNSPECIFIED`	Valor desconocido.
`ALLOW`	No hubo incumplimiento de política.
`BLOCK`	La política del cliente bloqueó el procesamiento.

Responder

Es una parte de la respuesta de varias partes de la llamada de asistencia.

Campos

Campo de unión reply. Son las alternativas para la respuesta del asistente. reply puede ser solo uno de los siguientes:

grounded_content

AssistantGroundedContent

Es posible que se trate de texto o contenido multimedia fundamentado de la respuesta del asistente.

Estado

Es el estado de la generación de respuestas.

Enums
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	La operación de asistencia está en curso.
`FAILED`	No se pudo realizar la operación de asistencia.
`SUCCEEDED`	La operación de asistencia se realizó correctamente.
`SKIPPED`	Se omitió la operación de asistencia.

AssistRequest

Es la solicitud para el método AssistantService.Assist.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Es la consulta del usuario actual. Solo se admite la búsqueda vacía si se proporciona `file_ids`. En este caso, la respuesta se generará en función de esos archivos de contexto.
`session`	`string` Opcional. Es la sesión que se usará para la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la búsqueda y la respuesta se almacenan allí. Si se especifica `-` como el ID de sesión o se deja vacío, se crea una sesión nueva con un ID generado automáticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`assist_skipping_mode`	`AssistSkippingMode` Opcional. Determina los casos en los que el asistente no responderá la búsqueda. Si se omite la respuesta, los motivos se incluirán en `AssistAnswer.assist_skipped_reasons` dentro de `AssistResponse.answer`.
`file_ids[]`	`string` Opcional. Son los IDs de los archivos que se usarán para responder la solicitud. Cuando se sube un archivo, su ID se muestra en `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Opcional. Es información sobre el usuario que inicia la búsqueda.

AssistSkippingMode

Son los comportamientos de omisión disponibles para las solicitudes de asistencia.

Enums
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Valor predeterminado. Se puede omitir la respuesta si la búsqueda no requiere asistencia.
`REQUEST_ASSIST`	Solicita la respuesta del asistente. Aun así, es posible que se omita la respuesta si la búsqueda no supera las verificaciones de políticas.

AssistResponse

Respuesta del método AssistantService.Assist.

Campos

answer

AssistAnswer

Es el recurso AssistAnswer que se genera en respuesta a la búsqueda.

session_info

SessionInfo

Es la información de la sesión.

assist_token

string

Es un ID único global que identifica el par solicitud-respuesta actual. Se usa para brindar comentarios y asistencia.

SessionInfo

Es información sobre la sesión.

Campos

session

string

Nombre de la sesión recién generada o continuada.

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

query_id

string

Es el ID de la búsqueda que corresponde a esta llamada a la API de asistencia. Una sesión puede tener varios turnos, cada uno con un ID de búsqueda único.

Si especificas el nombre de la sesión y este ID de búsqueda en la llamada a la API de Assist, la solicitud de asistencia se realizará en el contexto de los resultados de la búsqueda de esta llamada de búsqueda.

AssistUserMetadata

Son los metadatos del usuario de la solicitud.

Campos

time_zone

string

Opcional. Zona horaria de IANA, p.ej., Europe/Budapest.

preferred_language_code

string

Opcional. Idioma preferido que se usará para responder si falla la detección de idioma. También se usa como el idioma de los mensajes de error creados por las acciones, independientemente de los resultados de la detección de idioma.

Asistente

Es el recurso del asistente de Discovery Engine.

Campos
`name`	`string` Inmutable. Nombre del recurso del asistente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` Debe ser una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
`display_name`	`string` Obligatorio. Es el nombre visible del asistente. Debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres.
`description`	`string` Opcional. Descripción para obtener información adicional. Se espera que se muestre en la IU de configuración, no a los usuarios del asistente.
`generation_config`	`GenerationConfig` Opcional. Es la configuración para la generación de la respuesta del asistente.
`google_search_grounding_enabled (deprecated)`	`bool` Este elemento está obsoleto. Opcional. Obsoleto. Utiliza `web_grounding_type` en lugar de esta función.
`web_grounding_type`	`WebGroundingType` Opcional. Es el tipo de fundamentación web que se usará.
`enabled_actions (deprecated)`	`map<string, ActionList>` Este elemento está obsoleto. Opcional. Obsoleto: Se reemplazará por `enabled_tools`. Son las acciones habilitadas en este asistente. Las claves son el nombre del conector, por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Los valores consisten en acciones habilitadas por el administrador hacia la instancia del conector. El administrador puede habilitar de forma selectiva varias acciones en cualquiera de las instancias del conector que creó en el proyecto. Por ejemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Opcional. Nota: Aún no se implementó. Utiliza `enabled_actions` en lugar de esta función. Son las herramientas habilitadas en este asistente. Las claves son el nombre del conector, por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector". Los valores constan de herramientas habilitadas por el administrador para la instancia del conector. El administrador puede habilitar de forma selectiva varias herramientas en cualquiera de las instancias del conector que creó en el proyecto. Por ejemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Opcional. Política de clientes para el asistente.

ActionInfo

Obsoleto: Se reemplazará por ToolInfo. Es información para identificar una acción.

Campos

action_name

string

Nombre de la acción tal como la define DataConnectorService.QueryAvailableActions.

action_display_name

string

Es el nombre visible de la acción.

ActionList

Obsoleto: Se reemplazará por ToolList. Son las acciones habilitadas en un conector.

Campos

action_info[]

ActionInfo

Es la lista de acciones con la información correspondiente.

CustomerPolicy

Es la política definida por el cliente para el asistente.

Campos

banned_phrases[]

BannedPhrase

Opcional. Es la lista de frases prohibidas.

model_armor_config

ModelArmorConfig

Opcional. Es la configuración de Model Armor que se usará para limpiar las instrucciones del usuario y las respuestas del asistente.

BannedPhrase

Es la definición de una frase prohibida definida por el cliente. No se permite que aparezca una frase prohibida en la búsqueda del usuario ni en la respuesta del LLM. De lo contrario, se rechazará la respuesta.

Campos

phrase

string

Obligatorio. Es el contenido de la cadena sin procesar que se prohibirá.

match_type

BannedPhraseMatchType

Opcional. Es el tipo de concordancia de la frase prohibida.

ignore_diacritics

bool

Opcional. Si es verdadero, se ignoran las marcas diacríticas (p.ej., acentos, diéresis) cuando se buscan coincidencias con frases prohibidas. Por ejemplo, "cafe" coincidiría con "café".

BannedPhraseMatchType

Es el método de coincidencia de la frase prohibida.

Enums
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	La configuración predeterminada es SIMPLE_STRING_MATCH.
`SIMPLE_STRING_MATCH`	La frase prohibida coincide si se encuentra en cualquier parte del texto como una subcadena exacta.
`WORD_BOUNDARY_STRING_MATCH`	La frase prohibida solo coincide si el patrón que se encuentra en el texto está rodeado de delimitadores de palabras. La frase en sí puede contener delimitadores de palabras.

ModelArmorConfig

Es la configuración de las plantillas de Model Armor definidas por el cliente que se usarán para sanear las instrucciones del usuario y las respuestas del asistente.

Campos

user_prompt_template

string

Opcional. Es el nombre del recurso de la plantilla de Model Armor para sanear las instrucciones del usuario. Formato: projects/{project}/locations/{location}/templates/{template_id}

Si no se especifica, no se aplicará ninguna limpieza a la instrucción del usuario.

response_template

string

Opcional. Es el nombre del recurso de la plantilla de Model Armor para sanear las respuestas del asistente. Formato: projects/{project}/locations/{location}/templates/{template_id}

Si no se especifica, no se aplicará ninguna limpieza a la respuesta del asistente.

failure_mode

FailureMode

Opcional. Define el modo de falla para el saneamiento de Model Armor.

FailureMode

Determina el comportamiento cuando Model Armor no puede procesar una solicitud.

Enums
`FAILURE_MODE_UNSPECIFIED`	Modo de falla no especificado. El comportamiento predeterminado es `FAIL_CLOSED`.
`FAIL_OPEN`	En caso de que falle el procesamiento de Model Armor, se permite que la solicitud continúe sin cambios.
`FAIL_CLOSED`	En caso de que falle el procesamiento de Model Armor, se rechaza la solicitud.

GenerationConfig

Es la configuración para la generación de la respuesta del asistente.

Campos

system_instruction

SystemInstruction

Es una instrucción del sistema, también conocida como preámbulo del prompt para las llamadas al LLM. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

default_language

string

Es el idioma predeterminado que se usará para generar la respuesta del asistente. Usa un código de idioma ISO 639-1, como en. Si no se especifica, el idioma se detectará automáticamente.

SystemInstruction

Es una instrucción del sistema, también conocida como preámbulo del prompt para las llamadas al LLM.

Campos

additional_system_instruction

string

Opcional. Es una instrucción adicional del sistema que se agregará a la instrucción predeterminada del sistema.

ToolInfo

Es la información para identificar una herramienta.

Campos

tool_name

string

Es el nombre de la herramienta tal como lo define DataConnectorService.QueryAvailableActions. Nota: Se usa action en las APIs de DataConnectorService, pero son las mismas que tool aquí.

tool_display_name

string

Es el nombre visible de la herramienta.

ToolList

Las herramientas habilitadas en un conector

Campos

tool_info[]

ToolInfo

Es la lista de herramientas con la información correspondiente.

WebGroundingType

Es el tipo de fundamentación web que se usará.

Enums
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Es el parámetro de configuración predeterminado y sin especificar. Es lo mismo que inhabilitado.
`WEB_GROUNDING_TYPE_DISABLED`	La fundamentación web está inhabilitada.
`WEB_GROUNDING_TYPE_GOOGLE_SEARCH`	La fundamentación con la Búsqueda de Google está habilitada.
`WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`	La fundamentación con la Búsqueda web empresarial está habilitada.

AssistantContent

Contenido multimodal

Campos
`role`	`string` Es el productor del contenido. Puede ser "model" o "user".
`thought`	`bool` Opcional. Indica si el modelo generó la parte.
Campo de unión `data`. Datos contenidos `data` puede ser solo uno de los siguientes:
`text`	`string` Texto intercalado.
`inline_data`	`Blob` Son datos binarios intercalados.
`file`	`File` Es un archivo, p.ej., un resumen de audio.
`executable_code`	`ExecutableCode` Es el código generado por el modelo que se debe ejecutar.
`code_execution_result`	`CodeExecutionResult` Es el resultado de ejecutar un ExecutableCode.

BLOB

Es un BLOB intercalado.

Campos

mime_type

string

Obligatorio. Es el tipo de medio (tipo de MIME) de los datos generados.

data

bytes

Obligatorio. Bytes sin procesar.

CodeExecutionResult

Es el resultado de ejecutar ExecutableCode.

Campos

outcome

Outcome

Obligatorio. Es el resultado de la ejecución del código.

output

string

Opcional. Contiene stdout cuando la ejecución del código es exitosa; de lo contrario, contiene stderr o alguna otra descripción.

Resultado

Es la enumeración de los posibles resultados de la ejecución del código.

Enums
`OUTCOME_UNSPECIFIED`	Indica que no se especificó el estado. No se debe usar este valor.
`OUTCOME_OK`	La ejecución del código se completó correctamente.
`OUTCOME_FAILED`	La ejecución del código finalizó, pero con un error. `stderr` debe contener el motivo.
`OUTCOME_DEADLINE_EXCEEDED`	La ejecución del código tardó demasiado y se canceló. Puede haber o no un resultado parcial presente.

ExecutableCode

Es el código que genera el modelo y que está diseñado para que el modelo lo ejecute.

Campos

code

string

Obligatorio. Es el contenido del código. Actualmente, solo admite Python.

Archivo

Es un archivo, p.ej., un resumen de audio.

Campos

mime_type

string

Obligatorio. Es el tipo de medio (tipo de MIME) del archivo.

file_id

string

Obligatorio. Es el ID del archivo.

AssistantGroundedContent

Es un fragmento de contenido y, posiblemente, su información de fundamentación.

No todo el contenido necesita fundamentación. Las frases como "Por supuesto, con gusto lo buscaré por ti" no necesitan fundamentación.

Campos
`content`	`AssistantContent` Es el contenido.
`citation_metadata`	`CitationMetadata` Es la atribución de la fuente del contenido generado. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
`content_metadata`	`ContentMetadata` Opcional. Son los metadatos del contenido. Actualmente, solo se usa para las respuestas de los asistentes de investigación.
Campo de unión `metadata`. Son los metadatos de fundamentación para varios cuadros de diálogo. Por el momento, solo admite texto. `metadata` puede ser solo uno de los siguientes:
`text_grounding_metadata`	`TextGroundingMetadata` Son los metadatos para la fundamentación basados en fuentes de texto.

ContentMetadata

Son los metadatos del contenido.

Campos

content_kind

ContentKind

Es el tipo de contenido. Muestra a qué parte de la respuesta del asistente de investigación pertenece este contenido.

content_id

string

Es el ID del contenido. Se usa para conectar las preguntas de investigación con sus respuestas. Por ejemplo, las partes de la respuesta a una pregunta de investigación tendrán el mismo content_id que la pregunta.

ContentKind

Son los tipos de contenido posibles. Actualmente, solo se usa para diferenciar secciones en la respuesta completa de un asistente de investigación.

Enums
`CONTENT_KIND_UNSPECIFIED`	Desconocido.
`RESEARCH_PLAN`	Plan de investigación
`RESEARCH_QUESTION`	Pregunta de investigación.
`RESEARCH_ANSWER`	Respuesta de investigación.
`RESEARCH_REPORT`	Research report.
`RESEARCH_AUDIO_SUMMARY`	Resumen de audio de la investigación.

TextGroundingMetadata

Son los detalles de fundamentación para las fuentes de texto.

Campos

segments[]

Segment

Es la información de fundamentación para partes del texto.

references[]

Reference

Referencias para el texto fundamentado.

Reference

Contenido al que se hace referencia y metadatos del documento relacionado

Campos

content

string

Contenido de texto al que se hace referencia.

document_metadata

Son los metadatos del documento.

DocumentMetadata

Son los metadatos del documento.

Campos
`document`	`string` Nombre del recurso del documento.
`uri`	`string` Es el URI del documento. Puede contener una URL que redirecciona al sitio web real.
`title`	`string` y "title".
`page_identifier`	`string` Es el identificador de la página.
`domain`	`string` Nombre de dominio del URI del documento. Ten en cuenta que el campo `uri` puede contener una URL que redirecciona al sitio web real, en cuyo caso contendrá el nombre de dominio del sitio de destino.
`mime_type`	`string` Es el tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

Segmento

Es la información de fundamentación de un segmento del texto.

Campos
`start_index`	`int64` Índice basado en cero que indica el inicio del segmento, medido en bytes de una cadena UTF-8 (es decir, los caracteres codificados en varios bytes tienen una longitud de más de uno).
`end_index`	`int64` Es el final del segmento, exclusivo.
`reference_indices[]`	`int32` Son las referencias del segmento.
`grounding_score`	`float` Es la puntuación del segmento.
`text`	`string` Es el segmento de texto en sí.

BAPConfig

Es la configuración del conector de BAP.

Campos

supported_connector_modes[]

ConnectorMode

Obligatorio. Son los modos de conector admitidos para la conexión BAP asociada.

enabled_actions[]

string

Opcional. Son las acciones habilitadas en la conexión de la BAP asociada.

ConnectorMode

Son los casos de uso que admite este conector de la BAP.

Enums
`CONNECTOR_MODE_UNSPECIFIED`	No se especificó el modo del conector.
`DATA_INGESTION`	Es el conector que se utiliza para la transferencia de datos.
`ACTIONS`	Conector utilizado para las acciones
`END_USER_AUTHENTICATION`	Es el conector que se utiliza para la autenticación del usuario final.

BatchCreateTargetSiteMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.BatchCreateTargetSites. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

CreateTargetSiteRequest

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

BatchCreateTargetSitesRequest

Mensaje de solicitud para el método SiteSearchEngineService.BatchCreateTargetSites.

Campos

parent

string

Obligatorio. Es el recurso principal que comparten todos los TargetSites que se crean. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine El campo principal de los mensajes de CreateBookRequest debe estar vacío o coincidir con este campo.

requests[]

Obligatorio. Es el mensaje de solicitud que especifica los recursos que se crearán. Se puede crear un máximo de 20 TargetSites en un lote.

BatchCreateTargetSitesResponse

Mensaje de respuesta para el método SiteSearchEngineService.BatchCreateTargetSites.

Campos

target_sites[]

Se crearon los TargetSites.

BatchGetDocumentsMetadataRequest

Mensaje de solicitud para el método DocumentService.BatchGetDocumentsMetadata.

Campos

parent

string

Obligatorio. Es el nombre del recurso de la rama principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Obligatorio. Es el comparador de los Document.

FhirMatcher

Es un comparador para los Documents por nombres de recursos de FHIR.

Campos

fhir_resources[]

string

Obligatorio. Son los recursos de FHIR por los que se realizará la coincidencia. Formato: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Matcher

Es el comparador de los Document. Actualmente, admite la coincidencia por URIs exactos.

Campos

Campo de unión matcher. Es el comparador de los Document. matcher puede ser solo uno de los siguientes:

uris_matcher

UrisMatcher

Es un comparador por URIs exactos.

fhir_matcher

FhirMatcher

Es un comparador por nombres de recursos de FHIR.

UrisMatcher

Es un comparador de los Documents por URIs exactos.

Campos

uris[]

string

Son los URIs exactos con los que se debe establecer la coincidencia.

BatchGetDocumentsMetadataResponse

Mensaje de respuesta para el método DocumentService.BatchGetDocumentsMetadata.

Campos

documents_metadata[]

Son los metadatos de los Document.

DocumentMetadata

Son los metadatos de un Document.

Campos
`matcher_value`	`MatcherValue` Es el valor del comparador que se usó para hacer coincidir el `Document`.
`state`	`State` Es el estado del documento.
`last_refreshed_time`	`Timestamp` Es la marca de tiempo de la última vez que se indexó el `Document`.
`data_ingestion_source`	`string` Es la fuente de transferencia de datos del `Document`. Los valores permitidos son los siguientes: `batch`: Datos transferidos a través de la API de Batch, p.ej., ImportDocuments. `streaming` Datos transferidos a través de la API de transmisión, p.ej., Transmisión de FHIR

MatcherValue

Es el valor del comparador que se usó para hacer coincidir el Document.

Campos

Campo de unión matcher_value. Es el valor del comparador que se usó para hacer coincidir el Document. matcher_value puede ser solo uno de los siguientes:

uri

string

Si la coincidencia es por URI, es el URI del Document.

fhir_resource

string

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

Estado

Es el estado del Document.

Enums
`STATE_UNSPECIFIED`	Nunca se debe establecer.
`INDEXED`	El `Document` está indexado.
`NOT_IN_TARGET_SITE`	El `Document` no está indexado porque su URI no está en el `TargetSite`.
`NOT_IN_INDEX`	No se indexa `Document`.

BatchUpdateUserLicensesMetadata

Son metadatos relacionados con el progreso de la operación UserLicenseService.BatchUpdateUserLicenses. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es el recuento de las licencias de usuario que se actualizaron correctamente.
`failure_count`	`int64` Es el recuento de las licencias de usuario que no se pudieron actualizar.

BatchUpdateUserLicensesRequest

Mensaje de solicitud para el método UserLicenseService.BatchUpdateUserLicenses.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso [UserStore][] principal, con el formato `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Opcional. Si es verdadero, si el usuario quita las licencias, se borrará la configuración de licencias asociada. De forma predeterminada, que es falso, la licencia de usuario se actualizará al estado sin asignar.
Campo de unión `source`. Obligatorio. Es la fuente de la entrada. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada del contenido de entrada para las incorporaciones de documentos.

InlineSource

Es la fuente intercalada de la configuración de entrada para el método BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

Obligatorio. Es una lista de licencias de usuario que se actualizarán. Cada licencia de usuario debe tener un UserLicense.user_principal válido.

update_mask

Opcional. La lista de campos que se deben actualizar.

BatchUpdateUserLicensesResponse

Mensaje de respuesta para el método UserLicenseService.BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

Se actualizaron correctamente las UserLicenses.

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

BatchVerifyTargetSitesMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.BatchVerifyTargetSites. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

BatchVerifyTargetSitesRequest

Mensaje de solicitud para el método SiteSearchEngineService.BatchVerifyTargetSites.

Campos

parent

string

Obligatorio. Es el recurso principal que comparten todos los TargetSites que se verifican. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine

BatchVerifyTargetSitesResponse

Este tipo no tiene campos.

Mensaje de respuesta para el método SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

Es la fuente de BigQuery desde la que se importan los datos.

Campos
`project_id`	`string` Es el ID o el número del proyecto que contiene la fuente de BigQuery. Tiene un límite de longitud de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`dataset_id`	`string` Obligatorio. Es el conjunto de datos de BigQuery desde el que se copiarán los datos, con un límite de 1,024 caracteres.
`table_id`	`string` Obligatorio. Tabla de BigQuery desde la que se copiarán los datos, con un límite de longitud de 1,024 caracteres.
`gcs_staging_dir`	`string` Es el directorio intermedio de Cloud Storage que se usa para la importación, con un límite de 2,000 caracteres. Se puede especificar si se desea que BigQuery exporte a un directorio específico de Cloud Storage.
`data_schema`	`string` Es el esquema que se usará cuando se analicen los datos de la fuente. Valores admitidos para las importaciones de eventos de usuario: `user_event` (predeterminado): Un `UserEvent` por fila. Valores admitidos para las importaciones de documentos: `document` (predeterminado): Un formato `Document` por fila. Cada documento debe tener un `Document.id` válido y uno de los siguientes campos: `Document.json_data` o `Document.struct_data`. `custom`: Son datos personalizados por fila en formato arbitrario que se ajustan al `Schema` definido del almacén de datos. Solo puede usarlo la vertical de almacén de datos GENÉRICO.
Campo de unión `partition`. Es la información de la partición de la tabla de BigQuery. Deja este campo vacío si la tabla de BigQuery no está particionada. `partition` puede ser solo uno de los siguientes:
`partition_date`	`Date` _PARTITIONDATE de la tabla particionada por tiempo de BigQuery en formato AAAA-MM-DD.

BigtableOptions

Es el objeto Bigtable Options que contiene información para admitir la importación.

Campos

key_field_name

string

Nombre del campo que se usa para guardar el valor de la clave de fila en el documento. El nombre debe coincidir con el patrón [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map<string, BigtableColumnFamily>

Es la asignación de nombres de familias a un objeto que contiene información a nivel de las familias de columnas para la familia de columnas determinada. Si una familia no está presente en este mapa, se ignorará.

BigtableColumn

Es la columna de Bigtable.

Campos
`qualifier`	`bytes` Obligatorio. Es el calificador de la columna. Si no se puede decodificar con UTF-8, usa una cadena codificada en base64.
`field_name`	`string` Nombre del campo que se usará para esta columna en el documento. El nombre debe coincidir con el patrón `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Si no se configura, se analiza a partir de los bytes del calificador con el mayor esfuerzo posible. Sin embargo, debido a los diferentes patrones de nomenclatura, podrían producirse colisiones de nombres de campos, en las que el comportamiento del análisis no está definido.
`encoding`	`Encoding` Es el modo de codificación de los valores cuando el tipo no es `STRING`. Los valores de codificación aceptables son los siguientes: `TEXT`: Indica que los valores son cadenas de texto alfanuméricas. `BINARY`: Indica que los valores se codifican con la familia de funciones `HBase Bytes.toBytes`. Esto se puede anular para una columna específica si se incluye esa columna en `columns` y se especifica una codificación para ella.
`type`	`Type` Es el tipo de valores de esta familia de columnas. Se espera que los valores se codifiquen con la función `HBase Bytes.toBytes` cuando el valor de codificación se establezca en `BINARY`.

BigtableColumnFamily

Es la familia de columnas de Bigtable.

Campos
`field_name`	`string` Nombre del campo que se usará para esta familia de columnas en el documento. El nombre debe coincidir con el patrón `[a-zA-Z0-9][a-zA-Z0-9-_]*`. Si no se configura, se analiza a partir del nombre de la familia con el mayor esfuerzo posible. Sin embargo, debido a los diferentes patrones de nomenclatura, podrían producirse colisiones de nombres de campos, en las que el comportamiento del análisis no está definido.
`encoding`	`Encoding` Es el modo de codificación de los valores cuando el tipo no es STRING. Los valores de codificación aceptables son los siguientes: `TEXT`: Indica que los valores son cadenas de texto alfanuméricas. `BINARY`: Indica que los valores se codifican con la familia de funciones `HBase Bytes.toBytes`. Esto se puede anular para una columna específica si se incluye esa columna en `columns` y se especifica una codificación para ella.
`type`	`Type` Es el tipo de valores de esta familia de columnas. Se espera que los valores se codifiquen con la función `HBase Bytes.toBytes` cuando el valor de codificación se establezca en `BINARY`.
`columns[]`	`BigtableColumn` Es la lista de objetos que contiene información a nivel de la columna para cada columna. Si una columna no está presente en esta lista, se ignorará.

Codificación

Es el modo de codificación de una columna o familia de columnas de Bigtable.

Enums
`ENCODING_UNSPECIFIED`	La codificación no está especificada.
`TEXT`	Es la codificación de texto.
`BINARY`	Es la codificación binaria.

Tipo

Es el tipo de valores en una columna o familia de columnas de Bigtable. Se espera que los valores se codifiquen con la función Bytes.toBytes de HBase cuando el valor de codificación se establece en BINARY.

Enums
`TYPE_UNSPECIFIED`	No se especificó el tipo.
`STRING`	Tipo de cadena.
`NUMBER`	Es de tipo numérico.
`INTEGER`	Es de tipo entero.
`VAR_INTEGER`	Es un tipo de número entero de longitud variable.
`BIG_NUMERIC`	Es el tipo BigDecimal.
`BOOLEAN`	Tipo booleano.
`JSON`	Es el tipo de JSON.

BigtableSource

Es la fuente de Cloud Bigtable para importar datos.

Campos
`project_id`	`string` Es el ID del proyecto que contiene la fuente de Bigtable. Tiene un límite de longitud de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`instance_id`	`string` Obligatorio. ID de la instancia de Cloud Bigtable que se debe importar.
`table_id`	`string` Obligatorio. Es el ID de la tabla de Cloud Bigtable que se debe importar.
`bigtable_options`	`BigtableOptions` Obligatorio. Opciones de Bigtable que contienen la información necesaria para analizar los datos en estructuras escritas. Por ejemplo, las anotaciones de tipo de columna.

CheckGroundingRequest

Mensaje de solicitud para el método GroundedGenerationService.CheckGrounding.

Campos
`grounding_config`	`string` Obligatorio. Es el nombre del recurso de la configuración de fundamentación, como `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Es la respuesta candidata que se debe verificar. Puede tener una longitud máxima de 4,096 tokens.
`facts[]`	`GroundingFact` Es la lista de hechos para la verificación de fundamentación. Admitimos hasta 200 hechos.
`grounding_spec`	`CheckGroundingSpec` Es la configuración de la verificación de fundamentación.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Google Cloud Document para obtener más detalles.

CheckGroundingResponse

Mensaje de respuesta para el método GroundedGenerationService.CheckGrounding.

Campos
`cited_chunks[]`	`FactChunk` Lista de hechos citados en todas las afirmaciones del candidato a respuesta. Se derivan de los hechos proporcionados en la solicitud.
`cited_facts[]`	`CheckGroundingFactChunk` Lista de hechos citados en todas las afirmaciones del candidato a respuesta. Se derivan de los hechos proporcionados en la solicitud.
`claims[]`	`Claim` Textos de reclamos y la información de citas en todos los reclamos del candidato a respuesta.
`support_score`	`float` Es la puntuación de asistencia para la respuesta candidata de entrada. Cuanto más alta sea la puntuación, mayor será la fracción de reclamos respaldados por los hechos proporcionados. Siempre se establece cuando se devuelve una respuesta.

CheckGroundingFactChunk

Es un fragmento de hecho para la verificación de fundamentación.

Campos

chunk_text

string

Es el contenido de texto del fragmento de hecho. Puede tener hasta 10,000 caracteres.

Reclamación

Es el texto y la información de la cita de un reclamo en la respuesta candidata.

Campos
`claim_text`	`string` Es el texto de la afirmación en la respuesta candidata. Siempre se proporciona, independientemente de si se encuentran citas o anticitas.
`citation_indices[]`	`int32` Es una lista de índices (en "cited_chunks") que especifican las citas asociadas con la afirmación. Por ejemplo, [1,3,4] significa que cited_chunks[1], cited_chunks[3] y cited_chunks[4] son los hechos citados que respaldan la afirmación. Una cita a un hecho indica que la afirmación se basa en ese hecho.
`start_pos`	`int32` Posición que indica el inicio de la afirmación en el candidato a respuesta, medida en bytes. Ten en cuenta que esto no se mide en caracteres y, por lo tanto, se debe renderizar en la interfaz de usuario teniendo en cuenta que algunos caracteres pueden ocupar más de un byte. Por ejemplo, si el texto del reclamo contiene caracteres que no son ASCII, las posiciones de inicio y finalización varían cuando se miden en caracteres (dependiente del lenguaje de programación) y cuando se miden en bytes (independiente del lenguaje de programación).
`end_pos`	`int32` Posición que indica el final del reclamo en el candidato a respuesta, exclusiva, en bytes. Ten en cuenta que esto no se mide en caracteres y, por lo tanto, debe renderizarse como tal. Por ejemplo, si el texto del reclamo contiene caracteres que no son ASCII, las posiciones de inicio y finalización varían cuando se miden en caracteres (dependiente del lenguaje de programación) y cuando se miden en bytes (independiente del lenguaje de programación).
`grounding_check_required`	`bool` Indica que esta afirmación requirió una verificación de fundamentación. Cuando el sistema decida que esta afirmación no requiere una verificación de atribución o fundamentación, este campo se establecerá como falso. En ese caso, no se realizó ninguna verificación de fundamentación para la afirmación y, por lo tanto, no se debe devolver `citation_indices`.
`score`	`double` Es la puntuación de confianza para la afirmación en la respuesta candidata, en el rango de [0, 1]. Este parámetro solo se establece cuando `CheckGroundingRequest.grounding_spec.enable_claim_level_score` es verdadero.

CheckGroundingSpec

Es la especificación para la verificación de fundamentación.

Campos

citation_threshold

double

Es el umbral (en [0,1]) que se usa para determinar si se debe citar un hecho para una afirmación en el candidato a respuesta. Elegir un umbral más alto generará menos citas, pero muy sólidas, mientras que elegir un umbral más bajo puede generar más citas, pero algo más débiles. Si no se establece, el umbral se establecerá de forma predeterminada en 0.6.

enable_claim_level_score

bool

Es la marca de control que habilita la puntuación de fundamentación a nivel del reclamo en la respuesta.

Fragmento

El fragmento captura toda la información de metadatos sin procesar de los elementos que se recomendarán o buscarán en el modo de fragmento.

Campos
`name`	`string` Es el nombre completo del recurso del fragmento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
`id`	`string` Es el ID único del fragmento actual.
`content`	`string` El contenido es una cadena de un documento (contenido analizado).
`document_metadata`	`DocumentMetadata` Son los metadatos del documento del fragmento actual.
`derived_struct_data`	`Struct` Solo salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no se encuentran en el documento de entrada original.
`page_span`	`PageSpan` Es el intervalo de páginas del fragmento.
`chunk_metadata`	`ChunkMetadata` Solo salida. Son los metadatos del fragmento actual.
`data_urls[]`	`string` Solo salida. Son las URLs de los datos de la imagen si el fragmento actual contiene imágenes. Las URLs de datos se componen de cuatro partes: un prefijo (data:), un tipo de MIME que indica el tipo de datos, un token base64 opcional si no es textual y los datos en sí: data:[][;base64],
`annotation_contents[]`	`string` Solo salida. Contenido de la anotación si el fragmento actual contiene anotaciones.
`annotation_metadata[]`	`AnnotationMetadata` Solo salida. Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.
`relevance_score`	`double` Solo salida. Representa la puntuación de relevancia basada en la similitud. Una puntuación más alta indica una mayor relevancia del fragmento. La puntuación está en el rango [-1.0, 1.0]. Solo se propaga en `SearchResponse`.

AnnotationMetadata

Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.

Campos

structured_content

StructuredContent

Solo salida. Es la información del contenido estructurado.

image_id

string

Solo salida. Se proporciona el ID de la imagen si el contenido estructurado se basa en una imagen.

ChunkMetadata

Son los metadatos del fragmento actual. Este campo solo se completa en la API de SearchService.Search.

Campos

previous_chunks[]

Chunk

Son los fragmentos anteriores del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks controla el número. Este campo solo se completa en la API de SearchService.Search.

next_chunks[]

Chunk

Son los próximos fragmentos del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks controla el número. Este campo solo se completa en la API de SearchService.Search.

DocumentMetadata

Los metadatos del documento contienen la información del documento del fragmento actual.

Campos
`uri`	`string` Es el URI del documento.
`title`	`string` Es el título del documento.
`mime_type`	`string` Es el tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.
`struct_data`	`Struct` Representación de datos Son los datos estructurados en formato JSON del documento. Debe cumplir con el `Schema` registrado o se arroja un error `INVALID_ARGUMENT`.

PageSpan

Es el intervalo de páginas del fragmento.

Campos

page_start

int32

Es la página de inicio del fragmento.

page_end

int32

Es la página final del fragmento.

StructureType

Define los tipos de contenido estructurado que se pueden extraer.

Enums
`STRUCTURE_TYPE_UNSPECIFIED`	Valor predeterminado.
`SHAREHOLDER_STRUCTURE`	Estructura de accionistas
`SIGNATURE_STRUCTURE`	Estructura de la firma.
`CHECKBOX_STRUCTURE`	Estructura de la casilla de verificación.

StructuredContent

Es la información del contenido estructurado.

Campos

structure_type

StructureType

Solo salida. Es el tipo de estructura del contenido estructurado.

content

string

Solo salida. Es el contenido del contenido estructurado.

Cita

Son las atribuciones de la fuente del contenido.

Campos
`start_index`	`int32` Solo salida. Índice de inicio en el contenido.
`end_index`	`int32` Solo salida. Índice final del contenido.
`uri`	`string` Solo salida. Es la referencia de URL de la atribución.
`title`	`string` Solo salida. Es el título de la atribución.
`license`	`string` Solo salida. Es la licencia de la atribución.
`publication_date`	`Date` Solo salida. Fecha de publicación de la atribución.

CitationMetadata

Es una colección de atribuciones de fuentes para un fragmento de contenido.

Campos

citations[]

Citation

Solo salida. Lista de citas.

CloudSqlSource

Es la fuente de la que se importan los datos de Cloud SQL.

Campos
`project_id`	`string` Es el ID del proyecto que contiene la fuente de Cloud SQL. Tiene un límite de longitud de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`instance_id`	`string` Obligatorio. Instancia de Cloud SQL desde la que se copiarán los datos, con un límite de longitud de 256 caracteres.
`database_id`	`string` Obligatorio. Es la base de datos de Cloud SQL desde la que se copiarán los datos, con un límite de longitud de 256 caracteres.
`table_id`	`string` Obligatorio. Tabla de Cloud SQL desde la que se copiarán los datos, con un límite de longitud de 256 caracteres.
`gcs_staging_dir`	`string` Es el directorio intermedio de Cloud Storage que se usa para la importación, con un límite de 2,000 caracteres. Se puede especificar si se desea que Cloud SQL exporte a un directorio específico de Cloud Storage. Asegúrate de que la cuenta de servicio de Cloud SQL tenga los permisos de administrador de Cloud Storage necesarios para acceder al directorio de Cloud Storage especificado.
`offload`	`bool` Opción para la exportación sin servidores. Habilitar esta opción generará costos adicionales. Obtén más información aquí.

CmekConfig

Son las configuraciones que se usan para habilitar la encriptación de datos con CMEK y claves de Cloud KMS.

Campos
`name`	`string` Obligatorio. Nombre del CmekConfig con el formato `projects/{project}/locations/{location}/cmekConfig` o `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Obligatorio. Es el nombre del recurso de la clave de KMS que se usará para encriptar los recursos `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
`kms_key_version`	`string` Solo salida. Nombre del recurso de la versión de la clave de KMS que se usará para encriptar los recursos `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Solo salida. Son los estados de CmekConfig.
`is_default`	`bool` Solo salida. Es la configuración predeterminada de CmekConfig para el cliente.
`last_rotation_timestamp_micros`	`int64` Solo salida. Es la marca de tiempo de la última rotación de claves.
`single_region_keys[]`	`SingleRegionKey` Opcional. Son CMEK regionales únicas que se requieren para algunas funciones de VAIS.
`notebooklm_state`	`NotebookLMState` Solo salida. Indica si el corpus de NotebookLM está listo para usarse.

NotebookLMState

Estados de NotebookLM.

Enums
`NOTEBOOK_LM_STATE_UNSPECIFIED`	Se desconoce el estado de NotebookLM.
`NOTEBOOK_LM_NOT_READY`	NotebookLM no está listo.
`NOTEBOOK_LM_READY`	NotebookLM ya está listo para usarse.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM no está habilitado.

Estado

Son los estados de CmekConfig.

Enums
`STATE_UNSPECIFIED`	Se desconoce el estado de CmekConfig.
`CREATING`	Se está creando el CmekConfig.
`ACTIVE`	CmekConfig se puede usar con DataStores.
`KEY_ISSUE`	CmekConfig no está disponible, probablemente porque se revocó la clave de KMS.
`DELETING`	Se está borrando el CmekConfig.
`DELETE_FAILED`	Se produjo un error en el proceso de eliminación de CmekConfig.
`UNUSABLE`	El CmekConfig no se puede usar, probablemente debido a algún problema interno.
`ACTIVE_ROTATING`	Se está rotando la versión de la clave de KMS.
`DELETED`	La clave de KMS se borró de forma parcial. Con el tiempo, se aplicará alguna política de limpieza.
`EXPIRED`	La clave de KMS venció, lo que significa que se inhabilitó hace más de 30 días. El cliente puede llamar a DeleteCmekConfig para cambiar el estado a DELETED.

CollectUserEventRequest

Es el mensaje de solicitud para el método CollectUserEvent.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso principal. Si la acción de recopilación de eventos del usuario se aplica a nivel de `DataStore`, el formato es `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Si la acción de recopilación de eventos del usuario se aplica a nivel de `Location`, por ejemplo, el evento con `Document` en varios `DataStore`, el formato es `projects/{project}/locations/{location}`.
`user_event`	`string` Obligatorio. Es un .proto de UserEvent codificado como URL con un límite de longitud de 2,000,000 de caracteres.
`uri`	`string` Es la URL que incluye parámetros CGI, pero excluye el fragmento hash, con un límite de 5,000 caracteres. A menudo, esto es más útil que la URL de referencia, ya que muchos navegadores solo envían el dominio para las solicitudes de terceros.
`ets`	`int64` Es la marca de tiempo del evento en milisegundos. Esto evita que el navegador almacene en caché las solicitudes GET que, de otro modo, serían idénticas. El nombre se abrevia para reducir los bytes de la carga útil.

Colección

Una colección es un contenedor para configurar recursos y el acceso a un conjunto de DataStores.

Campos

name

string

Inmutable. Es el nombre completo del recurso de la colección. Formato: projects/{project}/locations/{location}/collections/{collection_id}.

Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.

display_name

string

Obligatorio. Es el nombre visible de la colección.

Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.

create_time

Solo salida. Es la marca de tiempo en la que se creó el objeto Collection.

CompleteQueryRequest

Mensaje de solicitud para el método CompletionService.CompleteQuery.

Campos
`data_store`	`string` Obligatorio. Es el nombre del recurso del almacén de datos principal para el que se realiza la finalización, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Obligatorio. Es la entrada de escritura anticipada que se usa para recuperar sugerencias. La longitud máxima es de 128 caracteres.
`query_model`	`string` Especifica el modelo de datos de autocompletado. Esto anula cualquier modelo especificado en la sección Configuración > Autocompletar de la consola de Cloud. Valores admitidos actualmente: `document`: Usar sugerencias generadas a partir de documentos importados por el usuario `search-history`: Se usan sugerencias generadas a partir del historial de llamadas a la API de `SearchService.Search`. No lo uses cuando no haya tráfico para la API de Search. `user-event`: Se usan sugerencias generadas a partir de eventos de búsqueda importados por el usuario. `document-completable`: Se usan sugerencias tomadas directamente de los campos de documentos importados por el usuario y marcados como completables. Valores predeterminados: `document` es el modelo predeterminado para los almacenes de datos normales. `search-history` es el modelo predeterminado para los almacenes de datos de la búsqueda en sitios.
`user_pseudo_id`	`string` Es un identificador único para hacer un seguimiento de los visitantes. Por ejemplo, esto se podría implementar con una cookie HTTP, que debería poder identificar de forma única a un visitante en un solo dispositivo. Este identificador único no debe cambiar si el visitante accede al sitio web o sale de él. Este campo NO debe tener un valor fijo, como `unknown_visitor`. Debe ser el mismo identificador que `UserEvent.user_pseudo_id` y `SearchRequest.user_pseudo_id`. El campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`include_tail_suggestions`	`bool` Indica si se deben devolver sugerencias de cola si no hay sugerencias que coincidan con la búsqueda completa. Incluso si se establece como verdadero, si hay sugerencias que coinciden con la búsqueda completa, se muestran esas sugerencias y no se muestran sugerencias de cola.

CompleteQueryResponse

Mensaje de respuesta para el método CompletionService.CompleteQuery.

Campos

query_suggestions[]

QuerySuggestion

Son los resultados de las sugerencias de búsqueda coincidentes. La lista de resultados está ordenada, y el primer resultado es una sugerencia principal.

tail_match_triggered

bool

Es verdadero si todas las sugerencias devueltas son sugerencias de cola.

Para que se activen las coincidencias de cola, include_tail_suggestions en la solicitud debe ser verdadero y no debe haber sugerencias que coincidan con la búsqueda completa.

QuerySuggestion

Sugerencias como búsquedas.

Campos

suggestion

string

La sugerencia para la consulta.

completable_field_paths[]

string

Son las rutas de campos de documentos únicos que sirven como fuente de esta sugerencia si se generó a partir de campos completables.

Este campo solo se propaga para el modelo que puede completar documentos.

CompletionInfo

Es información detallada sobre la finalización, incluido el token de atribución de finalización y la información de finalización en la que se hizo clic.

Campos

selected_suggestion

string

El usuario final seleccionó CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posición CompleteQueryResponse.QuerySuggestion.suggestion seleccionada por el usuario final, a partir de 0.

CompletionSuggestion

Sugerencias de autocompletar que se importan del cliente.

Campos
`suggestion`	`string` Obligatorio. Es el texto de la sugerencia.
`language_code`	`string` Es el código de idioma BCP-47 de esta sugerencia.
`group_id`	`string` Si dos sugerencias tienen el mismo groupId, no se devolverán juntas. En su lugar, se devolverá el que tenga una clasificación más alta. Se puede usar para anular las sugerencias duplicadas semánticamente idénticas.
`group_score`	`double` Es la puntuación de esta sugerencia dentro de su grupo.
`alternative_phrases[]`	`string` Son frases alternativas que coinciden con esta sugerencia.
Campo de unión `ranking_info`. Son las métricas de clasificación de esta sugerencia. `ranking_info` puede ser solo uno de los siguientes:
`global_score`	`double` Es la puntuación global de esta sugerencia. Controla cómo se calificaría o clasificaría esta sugerencia.
`frequency`	`int64` Frecuencia de esta sugerencia. Se usará para clasificar las sugerencias cuando no haya una puntuación disponible.

Condición

Define las circunstancias que se deben verificar antes de permitir un comportamiento.

Campos

query_terms[]

QueryTerm

Solo búsqueda: Es una lista de términos con los que se debe hacer coincidir la búsqueda. No se puede establecer cuando se configura Condition.query_regex.

Máximo de 10 términos de búsqueda.

active_time_range[]

TimeRange

Es el período que especifica cuándo está activa la condición.

Máximo de 10 períodos

query_regex

string

Opcional. Es la expresión regular de la búsqueda que coincide con toda la consulta de búsqueda. No se puede establecer cuando se configura Condition.query_terms. Solo se admite para los controles de publicación de promociones de la Búsqueda básica en el sitio.

QueryTerm

Es un comparador para la consulta de la solicitud de búsqueda.

Campos

value

string

Es el valor de la búsqueda específico con el que se debe establecer la coincidencia.

Debe estar en minúsculas y en UTF-8. Puede tener como máximo 3 términos separados por espacios si full_match es verdadero. No puede ser una cadena vacía. La longitud máxima es de 5,000 caracteres.

full_match

bool

Indica si la búsqueda debe coincidir exactamente con el término de búsqueda.

TimeRange

Se usa para condiciones que dependen del tiempo.

Campos

start_time

Es el inicio del período.

El rango es inclusivo.

end_time

Es el final del intervalo de tiempo.

El rango es inclusivo. Debe ser en el futuro.

ConnectorType

Es el tipo de conector.

Enums
`CONNECTOR_TYPE_UNSPECIFIED`	Valor predeterminado.
`THIRD_PARTY`	Conector de terceros a conector a aplicación de terceros.
`GCP_FHIR`	El conector de datos se conecta entre el almacén de FHIR y el almacén de datos de VAIS.
`BIG_QUERY`	Es un conector de BigQuery.
`GCS`	Es el conector de Google Cloud Storage.
`GOOGLE_MAIL`	Conector de Gmail.
`GOOGLE_CALENDAR`	Es un conector del Calendario de Google.
`GOOGLE_DRIVE`	Es el conector de Google Drive.
`NATIVE_CLOUD_IDENTITY`	Conector nativo de Cloud Identity para la búsqueda de personas con tecnología de la API de People.
`THIRD_PARTY_FEDERATED`	Es un conector federado, es decir, un conector de terceros que no ingiere datos y cuya búsqueda se basa en la API de la aplicación de terceros.
`THIRD_PARTY_EUA`	Es el conector que se utiliza para las funciones de autenticación de usuarios finales.
`GCNV`	Es el conector de Google Cloud NetApp Volumes.

ContactDetails

Es la información de contacto almacenada a nivel del recurso. Si se completan los datos de contacto a nivel del proyecto y del recurso, los datos de contacto a nivel del recurso anularán los datos de contacto a nivel del proyecto.

Campos

email_address

string

Opcional. Es la dirección de correo electrónico del contacto.

Control

Define un comportamiento condicionado que se debe emplear durante la entrega. Debe estar adjunto a un ServingConfig para que se tenga en cuenta en el momento de la publicación. Acciones permitidas que dependen de SolutionType.

Campos
`name`	`string` Inmutable. Nombre completamente calificado `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Obligatorio. Es el nombre legible. Es el identificador que se usa en las vistas de la IU. Debe ser una cadena codificada en UTF-8. El límite de longitud es de 128 caracteres. De lo contrario, se arroja un error INVALID ARGUMENT.
`associated_serving_config_ids[]`	`string` Solo salida. Es la lista de todos los IDs de `ServingConfig` a los que se adjunta este control. La actualización puede tardar hasta 10 minutos después de los cambios.
`solution_type`	`SolutionType` Obligatorio. Inmutable. Solución a la que pertenece el control. Debe ser compatible con la vertical del recurso. De lo contrario, se arroja un error INVALID ARGUMENT.
`use_cases[]`	`SearchUseCase` Especifica el caso de uso del control. Afecta los campos de condición que se pueden establecer. Solo se aplica a `SOLUTION_TYPE_SEARCH`. Actualmente, solo se permite un caso de uso por control. Se debe establecer cuando solution_type es `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Determina cuándo se activará la acción asociada. Si se omite, la acción se aplicará siempre. Actualmente, solo se puede especificar una condición. De lo contrario, se arroja un error INVALID ARGUMENT.
Campo de unión `action`. Las acciones están restringidas por vertical y solución Obligatorio. `action` puede ser una de las siguientes opciones:
`boost_action`	`BoostAction` Define un control de tipo refuerzo
`filter_action`	`FilterAction` Define un control de tipo de filtro. Actualmente, no es compatible con Recommendation.
`redirect_action`	`RedirectAction` Define un control de tipo redireccionamiento.
`synonyms_action`	`SynonymsAction` Trata a un grupo de términos como sinónimos entre sí.
`promote_action`	`PromoteAction` Promocionar ciertos vínculos según búsquedas de activación predefinidas

BoostAction

Ajusta el orden de los productos en la lista que se muestra.

Campos
`boost (deprecated)`	`float` Este elemento está obsoleto. Es la intensidad del boosting, que debe estar en el rango [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0 (sin operación).
`filter`	`string` Obligatorio. Especifica a qué productos se aplicará el aumento. Si no se proporciona ningún filtro, se potenciarán todos los productos (no se realizará ninguna operación). Documentación de la sintaxis: https://cloud.google.com/retail/docs/filter-and-order La longitud máxima es de 5,000 caracteres. De lo contrario, se arroja un error INVALID ARGUMENT.
`data_store`	`string` Obligatorio. Especifica los documentos de qué almacén de datos se pueden potenciar con este control. Nombre completo del almacén de datos, p.ej., projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo de unión `boost_spec`. Especificaciones de impulso de valor constante o de clasificación personalizada basada en el impulso. `boost_spec` puede ser solo uno de los siguientes:
`fixed_boost`	`float` Opcional. Es la intensidad del boosting, que debe estar en el rango [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0 (sin operación).
`interpolation_boost_spec`	`InterpolationBoostSpec` Opcional. Es una especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente.

InterpolationBoostSpec

Es la especificación para la clasificación personalizada basada en el valor del atributo especificado por el cliente. Proporciona más controles para la clasificación personalizada que la combinación simple (condición, refuerzo) anterior.

Campos
`field_name`	`string` Opcional. Nombre del campo cuyo valor se usará para determinar el importe del aumento.
`attribute_type`	`AttributeType` Opcional. Es el tipo de atributo que se usará para determinar el importe del aumento. El valor del atributo se puede derivar del valor del campo del campo field_name especificado. En el caso de los valores numéricos, es sencillo, es decir, attribute_value = numerical_field_value. Sin embargo, en el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Opcional. Es el tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
`control_points[]`	`ControlPoint` Opcional. Son los puntos de control que se usan para definir la curva. La función monotónica (definida a través de interpolation_type más arriba) pasa por los puntos de control que se indican aquí.

AttributeType

Es el atributo(o la función) para el que se aplicará la clasificación personalizada.

Enums
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType no especificado.
`NUMERICAL`	El valor del campo numérico se usará para actualizar de forma dinámica el importe del aumento. En este caso, el attribute_value (el valor de X) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
`FRESHNESS`	En el caso de uso de la actualización, el valor del atributo será la duración entre la hora actual y la fecha especificada en el campo de fecha y hora. El valor debe tener el formato de un valor `dayTimeDuration` de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: `[nD][T[nH][nM][nS]]`. Por ejemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Son los puntos de control que se usan para definir la curva. La curva definida a través de estos puntos de control solo puede aumentar o disminuir de forma monotónica(se aceptan valores constantes).

Campos

attribute_value

string

Opcional. Puede ser uno de los siguientes: 1. Es el valor del campo numérico. 2. Es la especificación de duración para la actualización. El valor debe tener el formato de un valor dayTimeDuration de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: [nD][T[nH][nM][nS]].

boost_amount

float

Opcional. Es el valor entre -1 y 1 por el que se aumentará la puntuación si el atributo attribute_value se evalúa como el valor especificado anteriormente.

InterpolationType

Es el tipo de interpolación que se aplicará. El valor predeterminado será lineal (lineal por partes).

Enums
`INTERPOLATION_TYPE_UNSPECIFIED`	No se especificó el tipo de interpolación. En este caso, se establece de forma predeterminada en lineal.
`LINEAR`	Se aplicará la interpolación lineal por partes.

FilterAction

Se especifican los productos que se pueden incluir en los resultados. Usa el mismo filtro que la potenciación.

Campos

filter

string

Obligatorio. Es un filtro que se aplica a los resultados de la condición de coincidencia.

Documentación de sintaxis requerida: https://cloud.google.com/retail/docs/filter-and-order. La longitud máxima es de 5,000 caracteres. De lo contrario, se arroja un error INVALID ARGUMENT.

data_store

string

Obligatorio. Especifica los documentos de qué almacén de datos se pueden filtrar con este control. Nombre completo del almacén de datos, p.ej., projects/123/locations/global/collections/default_collection/dataStores/default_data_store

PromoteAction

Promocionar ciertos vínculos en función de algunas búsquedas de activación

Ejemplo: Promocionar el vínculo de la tienda de calzado cuando se busca la palabra clave shoe. El vínculo puede estar fuera del almacén de datos asociado.

Campos

data_store

string

Obligatorio. Es el almacén de datos al que se adjunta esta promoción.

search_link_promotion

SearchLinkPromotion

Obligatorio. Es la promoción adjunta a esta acción.

RedirectAction

Redirecciona a un comprador al URI proporcionado.

Campos

redirect_uri

string

Obligatorio. Es el URI al que se redireccionará al comprador.

Obligatorio. El URI debe tener una longitud igual o inferior a 2,000 caracteres. De lo contrario, se arroja un error INVALID ARGUMENT.

SynonymsAction

Crea un conjunto de términos que actuarán como sinónimos entre sí.

Ejemplo: "feliz" también se considerará como "contento", y "contento" también se considerará como "feliz".

Campos

synonyms[]

string

Define un conjunto de sinónimos. Se pueden especificar hasta 100 sinónimos. Se deben especificar al menos 2 sinónimos. De lo contrario, se arroja un error INVALID ARGUMENT.

Conversación

Es la definición del arquetipo de conversación externa.

Campos
`name`	`string` Inmutable. Nombre completamente calificado `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` o `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` Es el estado de la conversación.
`user_pseudo_id`	`string` Es un identificador único para hacer un seguimiento de los usuarios.
`messages[]`	`ConversationMessage` Mensajes de conversaciones
`start_time`	`Timestamp` Solo salida. Fecha y hora en que se inició la conversación.
`end_time`	`Timestamp` Solo salida. Fecha y hora en que finalizó la conversación.

Estado

Es una enumeración del estado de la conversación.

Enums
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	La conversación está abierta.
`COMPLETED`	Se completó la conversación.

ConversationContext

Define el contexto de la conversación

Campos

context_documents[]

string

Es la lista actual de documentos que ve el usuario. Contiene las referencias de recursos del documento.

active_document

string

Es el documento activo actual que abrió el usuario. Contiene la referencia del recurso del documento.

ConversationMessage

Define un mensaje de conversación.

Campos
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo de creación del mensaje.
Campo de unión `message`. `message` puede ser una de las siguientes opciones:
`user_input`	`TextInput` Es la entrada de texto del usuario.
`reply`	`Reply` Respuesta de búsqueda.

ConverseConversationRequest

Mensaje de solicitud para el método ConversationalSearchService.ConverseConversation.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso de la conversación que se obtendrá. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Usa `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` para activar el modo de sesión automática, que crea automáticamente una conversación nueva dentro de una sesión de ConverseConversation.
`query`	`TextInput` Obligatorio. Es la entrada actual del usuario.
`serving_config`	`string` Es el nombre del recurso de la configuración de entrega que se usará. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` Si no se configura, se usará la configuración de entrega predeterminada.
`conversation`	`Conversation` Es la conversación que solo usará la sesión automática. Se ignorará el campo de nombre, ya que asignaremos automáticamente un nombre nuevo a la conversación en la sesión automática.
`safe_search`	`bool` Indica si se debe activar SafeSearch.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Google Cloud Document para obtener más detalles.
`summary_spec`	`SummarySpec` Es una especificación para configurar el resumen que se muestra en la respuesta.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los documentos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas. Se usará para filtrar los resultados de la búsqueda, lo que puede afectar la respuesta del resumen. Si este campo no se puede reconocer, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave del filtro del LHD a una propiedad clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios podría tener un campo "nombre" en su esquema. En este caso, el filtro se vería de la siguiente manera: filter --> name:'ANY("king kong")' Para obtener más información sobre los filtros, incluidos los operadores y la sintaxis de filtros, consulta Filtro.
`boost_spec`	`BoostSpec` Es la especificación de refuerzo para reforzar ciertos documentos en los resultados de la búsqueda, lo que puede afectar la respuesta de la conversación. Para obtener más información sobre el aumento, consulta Aumento.

ConverseConversationResponse

Mensaje de respuesta para el método ConversationalSearchService.ConverseConversation.

Campos

reply

Reply

Es la respuesta a la búsqueda actual.

conversation

Conversación actualizada que incluye la respuesta.

search_results[]

SearchResult

Resultados de la búsqueda

CreateAssistantRequest

Es la solicitud para el método AssistantService.CreateAssistant.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Obligatorio. Es el objeto Assistant que se creará.

assistant_id

string

Obligatorio. Es el ID que se usará para el Assistant, que se convertirá en el componente final del nombre del recurso del Assistant.

Este campo debe cumplir con RFC-1034 y tener un límite de 63 caracteres.

CreateControlRequest

Es la solicitud para el método CreateControl.

Campos

parent

string

Obligatorio. Es el nombre completo del recurso del almacén de datos principal. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} o projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

control

Control

Obligatorio. Es el control que se creará.

control_id

string

Obligatorio. Es el ID que se usará para el control, que se convertirá en el componente final del nombre del recurso del control.

Este valor debe tener entre 1 y 63 caracteres. Los caracteres válidos son /[a-z][0-9]-_/.

CreateConversationRequest

Es la solicitud para el método CreateConversation.

Campos

parent

string

Obligatorio. Es el nombre completo del recurso del almacén de datos principal. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Obligatorio. Es la conversación que se creará.

CreateDataStoreMetadata

Son metadatos relacionados con el progreso de la operación DataStoreService.CreateDataStore. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

CreateDataStoreRequest

Es la solicitud para el método DataStoreService.CreateDataStore.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso principal, como `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Obligatorio. Es el objeto `DataStore` que se creará.
`data_store_id`	`string` Obligatorio. Es el ID que se usará para el `DataStore`, que se convertirá en el componente final del nombre del recurso del `DataStore`. Este campo debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
`create_advanced_site_search`	`bool` Es una marca booleana que indica si el usuario desea crear directamente un almacén de datos avanzado para la búsqueda en el sitio. Si el almacén de datos no está configurado como búsqueda en el sitio (vertical GENERIC y content_config PUBLIC_WEBSITE), se ignorará esta marca.
`skip_default_schema_creation`	`bool` Es una marca booleana que indica si se debe omitir la creación del esquema predeterminado para el almacén de datos. Habilita esta marca solo si tienes la certeza de que el esquema predeterminado no es compatible con tu caso de uso. Si se establece como verdadero, debes crear manualmente un esquema para el almacén de datos antes de que se puedan transferir documentos. Esta marca no se puede especificar si se indica `data_store.starting_schema`.
Campo de unión `cmek_options`. Son las opciones de CMEK para Datastore. Si se configura este campo, se anulará el valor predeterminado de CmekConfig si se estableció uno para el proyecto. `cmek_options` puede ser solo uno de los siguientes:
`cmek_config_name`	`string` Es el nombre del recurso de CmekConfig que se usará para proteger este DataStore.
`disable_cmek`	`bool` DataStore sin protecciones de CMEK. Si se establece un CmekConfig predeterminado para el proyecto, establecer este campo también anulará el CmekConfig predeterminado.

CreateDocumentRequest

Mensaje de solicitud para el método DocumentService.CreateDocument.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Obligatorio. Es el objeto Document que se creará.

document_id

string

Obligatorio. Es el ID que se usará para el Document, que se convertirá en el componente final del Document.name.

Si el llamador no tiene permiso para crear el Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Este campo debe ser único entre todos los Document con el mismo parent. De lo contrario, se muestra un error ALREADY_EXISTS.

Este campo debe cumplir con el estándar RFC-1034 y tener un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.

CreateEngineMetadata

Son metadatos relacionados con el progreso de la operación EngineService.CreateEngine. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

CreateEngineRequest

Es la solicitud para el método EngineService.CreateEngine.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal, como projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Obligatorio. Es el objeto Engine que se creará.

engine_id

string

Obligatorio. Es el ID que se usará para el Engine, que se convertirá en el componente final del nombre del recurso del Engine.

Este campo debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.

CreateIdentityMappingStoreRequest

Mensaje de solicitud para IdentityMappingStoreService.CreateIdentityMappingStore

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso de la colección principal, como `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Obligatorio. Es el ID del almacén de asignación de identidades que se creará. El ID debe contener solo letras (a-z, A-Z), números (0-9), guiones bajos (_) y guiones (-), y tener una longitud máxima de 63 caracteres.
`identity_mapping_store`	`IdentityMappingStore` Obligatorio. Es el almacén de asignación de identidad que se creará.
Campo de unión `cmek_options`. Son las opciones de CMEK para el almacén de asignación de identidades. Si se configura este campo, se anulará el valor predeterminado de CmekConfig si se estableció uno para el proyecto. `cmek_options` puede ser solo uno de los siguientes:
`cmek_config_name`	`string` Es el nombre del recurso de CmekConfig que se usará para proteger este almacén de asignaciones de identidades.
`disable_cmek`	`bool` Es un almacén de asignación de identidades sin protecciones de CMEK. Si se establece un CmekConfig predeterminado para el proyecto, establecer este campo también anulará el CmekConfig predeterminado.

CreateLicenseConfigRequest

Mensaje de solicitud para el método LicenseConfigService.CreateLicenseConfig.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal, como projects/{project}/locations/{location}.

license_config

LicenseConfig

Obligatorio. Es el objeto LicenseConfig que se creará.

license_config_id

string

Opcional. Es el ID que se usará para el LicenseConfig, que se convertirá en el componente final del nombre del recurso del LicenseConfig. Usamos el nombre del nivel (edición del producto) como el ID de configuración de la licencia, como search o search_and_assistant.

CreateSchemaMetadata

Son los metadatos del LRO de Create Schema.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

CreateSchemaRequest

Mensaje de solicitud para el método SchemaService.CreateSchema.

Campos

parent

string

Obligatorio. Es el nombre del recurso de almacén de datos principal, en el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Obligatorio. Es el objeto Schema que se creará.

schema_id

string

Obligatorio. Es el ID que se usará para el Schema, que se convertirá en el componente final del Schema.name.

Este campo debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres.

CreateSessionRequest

Es la solicitud para el método CreateSession.

Campos

parent

string

Obligatorio. Es el nombre completo del recurso del almacén de datos principal. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Obligatorio. Es la sesión que se creará.

CreateSitemapMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.CreateSitemap. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

CreateSitemapRequest

Mensaje de solicitud para el método SiteSearchEngineService.CreateSitemap.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Obligatorio. Es el objeto Sitemap que se creará.

CreateTargetSiteMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.CreateTargetSite. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

CreateTargetSiteRequest

Mensaje de solicitud para el método SiteSearchEngineService.CreateTargetSite.

Campos

parent

string

Obligatorio. Nombre del recurso principal de TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Obligatorio. Es el objeto TargetSite que se creará.

CustomAttribute

Es un atributo personalizado que no se modela de forma explícita en un recurso, p.ej., UserEvent.

Campos

text[]

string

Son los valores de texto de este atributo personalizado. Por ejemplo, ["yellow", "green"] cuando la clave es "color".

No se permite una cadena vacía. De lo contrario, se muestra un error INVALID_ARGUMENT.

Se debe establecer exactamente uno de los campos CustomAttribute.text o CustomAttribute.numbers. De lo contrario, se muestra un error INVALID_ARGUMENT.

numbers[]

double

Son los valores numéricos de este atributo personalizado. Por ejemplo, [2.3, 15.4] cuando la clave es "lengths_cm".

Se debe establecer exactamente uno de los campos CustomAttribute.text o CustomAttribute.numbers. De lo contrario, se muestra un error INVALID_ARGUMENT.

CustomTuningModel

Son los metadatos que describen un modelo ajustado de forma personalizada.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso del modelo completamente calificado. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. El modelo debe ser una cadena alfanumérica con un límite de 40 caracteres.
`display_name`	`string` Es el nombre visible del modelo.
`model_version`	`int64` Es la versión del modelo.
`model_state`	`ModelState` Es el estado en el que se encuentra el modelo (p.ej.,`TRAINING` o `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Este elemento está obsoleto. Obsoleto: Marca de tiempo en la que se creó el modelo.
`training_start_time`	`Timestamp` Es la marca de tiempo en la que se inició el entrenamiento de modelos.
`metrics`	`map<string, double>` Son las métricas del modelo entrenado.
`error_message`	`string` Actualmente, solo se propaga si el estado del modelo es `INPUT_VALIDATION_FAILED`.

ModelState

Es el estado del modelo.

Enums
`MODEL_STATE_UNSPECIFIED`	Valor predeterminado.
`TRAINING_PAUSED`	El modelo está en estado de entrenamiento pausado.
`TRAINING`	Actualmente, se está entrenando el modelo.
`TRAINING_COMPLETE`	El modelo completó el entrenamiento correctamente.
`READY_FOR_SERVING`	El modelo está listo para la entrega.
`TRAINING_FAILED`	No se pudo completar el entrenamiento de modelos.
`NO_IMPROVEMENT`	El entrenamiento de modelos finalizó correctamente, pero las métricas no mejoraron.
`INPUT_VALIDATION_FAILED`	No se pudo validar los datos de entrada. No se inició el entrenamiento del modelo.

DataConnector

Administra la conexión a fuentes de datos externas para todos los almacenes de datos agrupados en un Collection. Es un recurso singleton de Collection. La inicialización solo se admite a través del método DataConnectorService.SetUpDataConnector, que creará un nuevo Collection y, luego, inicializará su DataConnector.

Campos
`name`	`string` Solo salida. Es el nombre completo del recurso del conector de datos. Formato: `projects//locations//collections/*/dataConnector`.
`state`	`State` Solo salida. Estado del conector.
`data_source`	`string` Obligatorio. Es el nombre de la fuente de datos. Valores admitidos: `salesforce`, `jira`, `confluence`, `bigquery`.
`remove_param_keys[]`	`string` Opcional. Especifica las claves que se quitarán del campo "params". Solo está activo cuando se incluye "params" en "update_mask" en un UpdateDataConnectorRequest. La eliminación tiene prioridad si una clave se encuentra en "remove_param_keys" y está presente en el campo "params" de la solicitud.
`refresh_interval`	`Duration` Obligatorio. Es el intervalo de actualización de la sincronización de datos. Si la duración se establece en 0, los datos se sincronizarán en tiempo real. Aún no se admite la función de transmisión. El mínimo es de 30 minutos y el máximo es de 7 días. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental.
`next_sync_time`	`DateTime` Define la hora programada para la próxima sincronización de datos. Este campo requiere hora, minuto y zona horaria de la base de datos de zonas horarias de IANA. Se utiliza cuando el conector de datos tiene un intervalo de actualización superior a 1 día. Cuando no se especifican las horas o los minutos, se supondrá que la hora de sincronización es las 0:00. El usuario debe proporcionar una zona horaria para evitar ambigüedades.
`entities[]`	`SourceEntity` Es la lista de entidades de la fuente de datos conectada que se deben transferir.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo en la que se creó el objeto `DataConnector`.
`latest_pause_time`	`Timestamp` Solo salida. Es la marca de tiempo más reciente en la que se pausó este `DataConnector`, lo que afecta todas las funcionalidades, como la sincronización de datos. Si pausas un conector, se producirán los siguientes efectos: - Se detendrán todas las funcionalidades, incluida la sincronización de datos. - Se cancelará cualquier trabajo de sincronización de datos en curso. - No se programarán ni se podrán activar ejecuciones de sincronización de datos futuras.
`last_sync_time`	`Timestamp` Solo salida. Solo para los conectores periódicos, es la última vez que se completó una sincronización de datos.
`update_time`	`Timestamp` Solo salida. Es la marca de tiempo de la última actualización del `DataConnector`.
`errors[]`	`Status` Solo salida. Son los errores de la inicialización o de la ejecución más reciente del conector.
`sync_mode`	`SyncMode` Es el modo de sincronización de datos que admite el conector de datos.
`kms_key_name`	`string` Solo entrada. Es la clave de KMS que se usará para proteger los almacenes de datos administrados por este conector. Se debe configurar para las solicitudes que deben cumplir con las protecciones de la política de la organización de CMEK. Si este campo se configura y procesa correctamente, los almacenes de datos creados por este conector estarán protegidos por la clave de KMS.
`destination_configs[]`	`DestinationConfig` Opcional. Son todos los destinos objetivo que se usan para conectarse a servicios de terceros.
`action_state`	`State` Solo salida. Es el estado del conector de acción. Esto refleja si el conector de acción se está inicializando, está activo o si se produjeron errores.
`action_config`	`ActionConfig` Opcional. Son las configuraciones de acciones para que el conector admita acciones.
`end_user_config`	`EndUserConfig` Opcional. Son los parámetros y las credenciales que se usan específicamente para los conectores de EUA.
`federated_config`	`FederatedConfig` Opcional. Son los parámetros y las credenciales que se usan específicamente para los conectores híbridos que admiten el modo FEDERATED. Este campo solo debe configurarse si el conector es híbrido y queremos habilitar el modo FEDERATED.
`connector_modes[]`	`ConnectorMode` Opcional. Son los modos habilitados para este conector. El estado predeterminado es CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Opcional. Indica si el cliente habilitó direcciones IP estáticas para este conector.
`static_ip_addresses[]`	`string` Solo salida. Son las direcciones IP estáticas que usa este conector.
`blocking_reasons[]`	`BlockingReason` Solo salida. Son las acciones del usuario que se deben completar antes de que el conector pueda comenzar a sincronizar datos.
`identity_refresh_interval (deprecated)`	`Duration` Este elemento está obsoleto. Es el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos que ingiere este conector. Si no se establece, la lista de control de acceso se actualizará en el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de al menos 30 minutos y de hasta 7 días.
`identity_schedule_config`	`IdentityScheduleConfig` Es la configuración de las ejecuciones de sincronización de datos de identidad. Contiene el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos que ingirió este conector.
`private_connectivity_project_id`	`string` Solo salida. Es el ID del proyecto de usuario asociado con los conectores de conectividad privada. Para que el conector funcione, este proyecto debe estar incluido en la lista de entidades permitidas.
`bap_config`	`BAPConfig` Opcional. Es la configuración para establecer una conexión de BAP.
`connector_type`	`ConnectorType` Solo salida. Es el tipo de conector. Cada fuente solo se puede asignar a un tipo. Por ejemplo, Salesforce, Confluence y Jira tienen el tipo de conector THIRD_PARTY. No se puede modificar una vez que el sistema lo establece.
`realtime_state`	`State` Solo salida. Estado de sincronización en tiempo real
`alert_policy_configs[]`	`AlertPolicyConfig` Opcional. Es la configuración de alerta a nivel del conector.
`realtime_sync_config`	`RealtimeSyncConfig` Opcional. Es la configuración de la sincronización en tiempo real.
`acl_enabled`	`bool` Opcional. Indica si el conector se creará con una configuración de LCA. Actualmente, este campo solo afecta a los conectores de Cloud Storage y BigQuery.
`create_eua_saas`	`bool` Opcional. Indica si el conector de AUTENTICACIÓN DEL USUARIO FINAL se creó en el SaaS.
`auto_run_disabled`	`bool` Opcional. Indica si el conector está inhabilitado para la ejecución automática. Se puede usar para pausar la sincronización periódica y en tiempo real. Actualización: Con la introducción de incremental_sync_disabled, auto_run_disabled se usa para pausar o inhabilitar solo las sincronizaciones completas.
`incremental_sync_disabled`	`bool` Opcional. Indica si las sincronizaciones incrementales están pausadas para este conector. Esto es independiente de auto_run_disabled. Solo se aplica a los conectores de terceros. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental, es decir, se establecerá en verdadero.
`incremental_refresh_interval`	`Duration` Opcional. Es el intervalo de actualización específico para las sincronizaciones de datos incrementales. Si no se establece, las sincronizaciones incrementales usarán el valor predeterminado del entorno, establecido en 3 horas. El mínimo es de 30 minutos y el máximo es de 7 días. Solo se aplica a los conectores de terceros. Cuando el intervalo de actualización se establece en el mismo valor que el intervalo de actualización incremental, se inhabilitará la sincronización incremental.
`hybrid_ingestion_disabled`	`bool` Opcional. Si el conector es híbrido, determina si la transferencia está habilitada y si se aprovisionan los recursos adecuados durante la creación del conector. Si el conector no es híbrido, se ignora este campo.
Campo de unión `data_connector_params`. Son los parámetros necesarios para acceder a la fuente en formato de pares (clave, valor). Los valores de cadena con el formato `projects//[locations//]secrets//versions/` se leerán desde Secret Manager. Parámetros obligatorios para todas las fuentes de datos: Clave: `instance_uri` Valor: Tipo STRING. Es el URI para acceder a la fuente de datos. Parámetros obligatorios para las fuentes que admiten OAuth, es decir, `salesforce`: Clave: `client_id` Valor: Tipo STRING. Es el ID de cliente del proveedor de servicios externo para identificar tu aplicación. Clave: `client_secret` Es un valor de tipo STRING. Es el secreto del cliente que genera el servidor de autorización externo. Clave: `access_token` Valor: Tipo STRING. Es el token de OAuth para que UCS acceda al recurso protegido. Clave: `refresh_token` Valor: Tipo STRING. Es el token de actualización de OAuth para que UCS obtenga un nuevo token de acceso sin interacción del usuario. Parámetros obligatorios para las fuentes que admiten la autenticación básica con token de API, es decir, `jira` y `confluence`: Clave: `user_account` Valor: Tipo STRING. El nombre de usuario o el correo electrónico de la fuente. Clave: `api_token` Valor: Tipo STRING. Es el token de API generado para la cuenta de origen, que se usa para la autenticación en cualquier lugar en el que hubieras usado una contraseña. Ejemplo: `{ "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" }` Parámetro opcional para especificar el tipo de autorización que se usará para la compatibilidad con varios tipos de autorización: Clave: `auth_type` Valor: Tipo STRING. Es el tipo de autorización para la fuente de datos. Valores admitidos: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`. `data_connector_params` puede ser solo una de las siguientes opciones:
`params`	`Struct` Parámetros obligatorios del conector de datos en formato JSON estructurado.
`json_params`	`string` Son los parámetros obligatorios del conector de datos en formato de cadena JSON.

BlockingReason

Son las acciones del usuario que se deben completar antes de que el conector pueda comenzar a sincronizar datos.

Enums
`BLOCKING_REASON_UNSPECIFIED`	Valor predeterminado.
`ALLOWLIST_STATIC_IP`	El conector requiere que el cliente incluya las IPs estáticas en la lista de entidades permitidas.
`ALLOWLIST_IN_SERVICE_ATTACHMENT`	El conector requiere que el cliente incluya nuestro proyecto en la lista de entidades permitidas de su adjunto de servicio.
`ALLOWLIST_SERVICE_ACCOUNT`	El conector requiere que el cliente incluya la cuenta de servicio en la lista de anunciantes permitidos de su proyecto.

ConnectorMode

Son los modos habilitados para este conector. INGESTION, ACTIONS, FEDERATED, OR EUA

Enums
`CONNECTOR_MODE_UNSPECIFIED`	No se especificó el modo del conector.
`DATA_INGESTION`	Es el conector que se utiliza para la transferencia de datos.
`ACTIONS`	Es el conector que se utiliza para las acciones.
`FEDERATED`	Es el conector que se utiliza para la búsqueda federada.
`EUA`	Es el conector que se utiliza para la autenticación del usuario final.
`FEDERATED_AND_EUA`	Es un conector híbrido que se utiliza para la búsqueda federada y la autenticación de usuarios finales.

EndUserConfig

Son los parámetros y las credenciales que se usan específicamente para los conectores de EUA.

Campos
`additional_params`	`Struct` Opcional. Son los parámetros adicionales necesarios para EE.UU.
`tenant`	`Tenant` Opcional. Es el proyecto de usuario al que se conecta el conector.
Campo de unión `auth_config`. Es la configuración de autenticación para los conectores de la EUA. `auth_config` puede ser solo uno de los siguientes:
`auth_params`	`Struct` Opcional. Son los parámetros de autenticación específicos de los conectores de la EUA.
`json_auth_params`	`string` Opcional. Son los parámetros de autenticación específicos de los conectores de la EUA en formato de cadena json.

FederatedConfig

Son los parámetros y las credenciales que se usan específicamente para los conectores híbridos que admiten el modo FEDERATED.

Campos
`additional_params`	`Struct` Opcional. Son los parámetros adicionales necesarios para FEDERATED.
Campo de unión `auth_config`. Es la configuración de autenticación para los conectores FEDERATED. `auth_config` puede ser solo uno de los siguientes:
`auth_params`	`Struct` Opcional. Son los parámetros de autenticación específicos de los conectores FEDERATED.
`json_auth_params`	`string` Opcional. Son los parámetros de autenticación específicos de los conectores FEDERATED en formato de cadena json.

RealtimeSyncConfig

Es la configuración de la sincronización en tiempo real para almacenar parámetros adicionales para la sincronización en tiempo real.

Campos

webhook_uri

string

Opcional. Es la URL de webhook para que el conector especifique parámetros adicionales para la sincronización en tiempo real.

realtime_sync_secret

string

Opcional. Es el ID del secreto de Secret Manager que se usa para el secreto del webhook.

streaming_error

StreamingError

Opcional. Son los detalles del error de transmisión.

StreamingError

Son los detalles del error de transmisión.

Campos

streaming_error_reason

StreamingErrorReason

Opcional. Error de transmisión.

error

Opcional. Son los detalles del error.

StreamingErrorReason

Son tipos generales de errores de transmisión.

Enums
`STREAMING_ERROR_REASON_UNSPECIFIED`	No se especificó el motivo del error de transmisión.
`STREAMING_SETUP_ERROR`	Se produjo un error al configurar los recursos para la sincronización en tiempo real.
`STREAMING_SYNC_ERROR`	Se produjo un error durante la ejecución de la sincronización en tiempo real para el conector.
`INGRESS_ENDPOINT_REQUIRED`	El extremo de entrada es obligatorio cuando se configura la sincronización en tiempo real en la conectividad privada.

SourceEntity

Representa una entidad en la fuente de datos. Por ejemplo, el objeto Account en Salesforce.

Campos
`entity_name`	`string` Es el nombre de la entidad. Valores admitidos por fuente de datos: Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` Jira: `Issue` Confluence: `Content`, `Space`
`key_property_mappings`	`map<string, string>` Son los atributos para la indexación. Clave: Nombre del campo. Valor: Es la propiedad clave para asignar un campo, como `title` y `description`. Propiedades de clave admitidas: `title`: Es el título del registro de datos. Se mostrará en los resultados de la búsqueda. `description`: Es la descripción del registro de datos. Se mostrará en los resultados de la búsqueda.
`data_store`	`string` Solo salida. Es el nombre completo del recurso del almacén de datos asociado para la entidad de origen. Formato: `projects//locations//collections//dataStores/`. Cuando el método `DataConnectorService.SetUpDataConnector` inicializa el conector, se crea automáticamente un `DataStore` para cada entidad fuente.
`starting_schema`	`Schema` Opcional. Es el esquema de inicio que se usará para el `DataStore` creado a partir de este SourceEntity. Si no se establece, se usará un esquema especializado vertical predeterminado. Este campo solo se usa en la API de [SetUpDataConnector][] y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API de [GetDataConnector][]. Para recuperar el esquema de un `DataStore`, usa la API de `SchemaService.GetSchema`. El esquema proporcionado se validará según ciertas reglas del esquema. Obtén más información en este documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Es la configuración para la vertical de `HEALTHCARE_FHIR`.
Campo de unión `entity_params`. Son los parámetros de la entidad para facilitar la transferencia de datos. Por ejemplo, para los conectores de BigQuery: Clave: `document_id_column` Valor: Tipo STRING. Es el valor del ID de la columna. `entity_params` puede ser una de las siguientes opciones:
`params`	`Struct` Son los parámetros de la entidad para facilitar la transferencia de datos en formato JSON estructurado.
`json_params`	`string` Son los parámetros de la entidad para facilitar la transferencia de datos en formato de cadena JSON.

Estado

Es el estado del conector.

Enums
`STATE_UNSPECIFIED`	Valor predeterminado.
`CREATING`	Se está configurando el conector.
`ACTIVE`	El conector se configuró correctamente y está esperando la próxima ejecución de sincronización.
`FAILED`	El conector tiene un error. Los detalles del error se pueden encontrar en `DataConnector.errors`. Si el error no se puede corregir, la API de [CollectionService.DeleteCollection] puede borrar el `DataConnector`.
`RUNNING`	El conector está sincronizando registros de forma activa desde la fuente de datos.
`WARNING`	El conector completó una ejecución de sincronización, pero se encontraron errores recuperables.
`INITIALIZATION_FAILED`	No se pudo inicializar el conector. Entre las posibles causas, se incluyen errores de tiempo de ejecución o problemas en la canalización asíncrona, lo que impide que la solicitud llegue a los servicios posteriores (excepto para algunos tipos de conectores).
`UPDATING`	El conector está en proceso de actualización.

SyncMode

Define el modo de sincronización de datos que admite el conector de datos.

Enums
`PERIODIC`	El conector sincronizará los datos periódicamente según el valor de refresh_interval. Úsalo con auto_run_disabled para pausar la sincronización periódica o indicar una sincronización única.
`STREAMING`	Los datos se sincronizarán en tiempo real.
`UNSPECIFIED`	Los conectores que no transfieren datos tendrán este valor.

DataStore

DataStore captura la configuración y los parámetros globales a nivel de DataStore.

Campos
`name`	`string` Inmutable. Es el identificador. Es el nombre completo del recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
`display_name`	`string` Obligatorio. Es el nombre visible del almacén de datos. Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
`industry_vertical`	`IndustryVertical` Inmutable. Es la vertical de la industria en la que se registra el almacén de datos.
`solution_types[]`	`SolutionType` Son las soluciones en las que se inscribe el almacén de datos. Soluciones disponibles para cada `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` y `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` se inscribe automáticamente. No se pueden inscribir otras soluciones.
`default_schema_id`	`string` Solo salida. Es el ID del `Schema` predeterminado asociado a este almacén de datos.
`content_config`	`ContentConfig` Inmutable. Es la configuración del contenido del almacén de datos. Si no se configura este campo, el comportamiento predeterminado del servidor será `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo en la que se creó el objeto `DataStore`.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Opcional. Es la configuración para la búsqueda avanzada en el sitio.
`kms_key_name`	`string` Solo entrada. Es la clave de KMS que se usará para proteger este DataStore en el momento de la creación. Se debe configurar para las solicitudes que deben cumplir con las protecciones de la política de la organización de CMEK. Si este campo se configura y procesa correctamente, el DataStore estará protegido por la clave de KMS, como se indica en el campo cmek_config.
`cmek_config`	`CmekConfig` Solo salida. Es la información relacionada con la CMEK para el DataStore.
`billing_estimation`	`BillingEstimation` Solo salida. Es una estimación del tamaño de los datos para la facturación.
`acl_enabled`	`bool` Inmutable. Indica si los datos de `DataStore` tienen información de LCA. Si se configura como `true`, los datos de origen deben tener una ACL. La LCA se transferirá cuando los métodos `DocumentService.ImportDocuments` transfieran datos. Cuando la LCA está habilitada para `DataStore`, no se puede acceder a `Document` llamando a `DocumentService.GetDocument` o `DocumentService.ListDocuments`. Actualmente, la LCA solo se admite en la vertical de la industria de `GENERIC` con una configuración de contenido que no sea de `PUBLIC_WEBSITE`.
`workspace_config`	`WorkspaceConfig` Es la configuración para almacenar la configuración del tipo de almacén de datos para los datos del espacio de trabajo. Se debe configurar cuando `DataStore.content_config` se establece como `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Es la configuración para la comprensión y el enriquecimiento de documentos.
`starting_schema`	`Schema` Es el esquema de inicio que se usará para este `DataStore` cuando se aprovisione. Si no se establece, se usará un esquema especializado vertical predeterminado. Este campo solo lo usa la API de `CreateDataStore` y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API de `CreateDataStore`. Para recuperar el esquema de un `DataStore`, usa la API de `SchemaService.GetSchema`. El esquema proporcionado se validará según ciertas reglas del esquema. Obtén más información en este documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Es la configuración para la vertical de `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Opcional. Almacena la configuración de la publicación a nivel de DataStore.
`identity_mapping_store`	`string` Inmutable. Es el nombre del recurso completamente calificado del `IdentityMappingStore` asociado. Este campo solo se puede establecer para DataStores con acl_enabled y un IdP de `THIRD_PARTY` o `GSUITE`. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Opcional. Si se configura, este DataStore es un DataStore de preguntas frecuentes de Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Opcional. Es la configuración para el enfoque de facturación configurable. Ver

BillingEstimation

Es una estimación del tamaño de los datos por almacén de datos.

Campos
`structured_data_size`	`int64` Tamaño de los datos estructurados en bytes.
`unstructured_data_size`	`int64` Tamaño de los datos no estructurados en bytes.
`website_data_size`	`int64` Tamaño de los datos de los sitios web en bytes.
`structured_data_update_time`	`Timestamp` Es la marca de tiempo de la última actualización de los datos estructurados.
`unstructured_data_update_time`	`Timestamp` Es la marca de tiempo de la última actualización de los datos no estructurados.
`website_data_update_time`	`Timestamp` Es la marca de tiempo de la última actualización de los sitios web.

ConfigurableBillingApproach

Es la configuración para el enfoque de facturación configurable.

Enums
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predeterminado. Es el enfoque de facturación no configurable para Spark y no Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Usar la facturación de suscripción base más excedente para la indexación principal del almacenamiento que no es de incorporación
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Usa la facturación de pago por uso de consumo para el complemento de almacenamiento de incorporación.

ContentConfig

Es la configuración del contenido del almacén de datos.

Enums
`CONTENT_CONFIG_UNSPECIFIED`	Valor predeterminado.
`NO_CONTENT`	Solo contiene documentos sin ningún `Document.content`.
`CONTENT_REQUIRED`	Solo contiene documentos con `Document.content`.
`PUBLIC_WEBSITE`	El almacén de datos se usa para la búsqueda de sitios web públicos.
`GOOGLE_WORKSPACE`	El almacén de datos se usa para la búsqueda en el espacio de trabajo. Los detalles del almacén de datos del espacio de trabajo se especifican en `WorkspaceConfig`.

ServingConfigDataStore

Almacena información sobre la configuración de la publicación a nivel de DataStore.

Campos

disabled_for_serving

bool

Opcional. Si se establece como verdadero, DataStore no estará disponible para atender solicitudes de búsqueda.

DeleteAssistantRequest

Mensaje de la solicitud para el método AssistantService.DeleteAssistant.

Campos

name

string

Obligatorio. Es el nombre del recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Si el llamador no tiene permiso para borrar el Assistant, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Assistant que se borrará no existe, se muestra un error NOT_FOUND.

DeleteCmekConfigMetadata

Son metadatos relacionados con el progreso de la operación CmekConfigService.DeleteCmekConfig. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteCmekConfigRequest

Mensaje de solicitud para el método CmekConfigService.DeleteCmekConfig.

Campos

name

string

Obligatorio. Es el nombre del recurso CmekConfig que se borrará, como projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Son metadatos relacionados con el progreso de la operación [CollectionService.UpdateCollection][]. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteCollectionRequest

Mensaje de solicitud para el método CollectionService.DeleteCollection.

Campos

name

string

Obligatorio. Es el nombre completo del recurso de la colección, con el formato projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Es la solicitud para el método DeleteControl.

Campos

name

string

Obligatorio. Es el nombre del recurso del control que se borrará. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Es la solicitud para el método DeleteConversation.

Campos

name

string

Obligatorio. Es el nombre del recurso de la conversación que se borrará. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Son metadatos relacionados con el progreso de la operación DataStoreService.DeleteDataStore. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteDataStoreRequest

Mensaje de solicitud para el método DataStoreService.DeleteDataStore.

Campos

name

string

Obligatorio. Nombre completo del recurso DataStore, como projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Si el llamador no tiene permiso para borrar el DataStore, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el DataStore que se borrará no existe, se muestra un error NOT_FOUND.

DeleteDocumentRequest

Mensaje de solicitud para el método DocumentService.DeleteDocument.

Campos

name

string

Obligatorio. Nombre completo del recurso Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Si el llamador no tiene permiso para borrar el Document, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Document que se borrará no existe, se muestra un error NOT_FOUND.

DeleteEngineMetadata

Son metadatos relacionados con el progreso de la operación EngineService.DeleteEngine. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteEngineRequest

Mensaje de solicitud para el método EngineService.DeleteEngine.

Campos

name

string

Obligatorio. Nombre completo del recurso Engine, como projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Si el llamador no tiene permiso para borrar el Engine, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Engine que se borrará no existe, se muestra un error NOT_FOUND.

DeleteIdentityMappingStoreMetadata

Son metadatos relacionados con el progreso de la operación IdentityMappingStoreService.DeleteIdentityMappingStore. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteIdentityMappingStoreRequest

Mensaje de solicitud para IdentityMappingStoreService.DeleteIdentityMappingStore

Campos

name

string

Obligatorio. Es el nombre del almacén de asignación de identidades que se borrará. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Son los metadatos del LRO de DeleteSchema.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteSchemaRequest

Mensaje de solicitud para el método SchemaService.DeleteSchema.

Campos

name

string

Obligatorio. Es el nombre completo del recurso del esquema, con el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteSessionRequest

Es la solicitud para el método DeleteSession.

Campos

name

string

Obligatorio. Es el nombre del recurso de la sesión que se borrará. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.DeleteSitemap. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteSitemapRequest

Mensaje de solicitud para el método SiteSearchEngineService.DeleteSitemap.

Campos

name

string

Obligatorio. Nombre completo del recurso Sitemap, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

Si el llamador no tiene permiso para acceder al Sitemap, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Sitemap solicitado no existe, se muestra un error NOT_FOUND.

DeleteTargetSiteMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.DeleteTargetSite. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DeleteTargetSiteRequest

Mensaje de solicitud para el método SiteSearchEngineService.DeleteTargetSite.

Campos

name

string

Obligatorio. Nombre completo del recurso TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Si el llamador no tiene permiso para acceder al TargetSite, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el TargetSite solicitado no existe, se muestra un error NOT_FOUND.

DestinationConfig

Define los extremos de destino que se usan para conectarse a fuentes externas.

Campos
`key`	`string` Opcional. Es el identificador único del destino que admite el conector.
`destinations[]`	`Destination` Opcional. Son los destinos de la clave correspondiente.
Campo de unión `destination_config_params`. Son parámetros adicionales para esta configuración de destino. `destination_config_params` puede ser solo uno de los siguientes:
`params`	`Struct` Opcional. Son parámetros adicionales para esta configuración de destino en formato JSON estructurado.
`json_params`	`string` Son parámetros adicionales para esta configuración de destino en formato de cadena JSON.

Destino

Define un extremo de destino

Campos

port

int32

Opcional. Número de puerto de destino aceptado por el destino.

Campo de unión destination. Es el destino del extremo. destination puede ser solo uno de los siguientes:

host

string

Es un host enrutable públicamente.

DisableAdvancedSiteSearchMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.DisableAdvancedSiteSearch. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

DisableAdvancedSiteSearchRequest

Mensaje de solicitud para el método SiteSearchEngineService.DisableAdvancedSiteSearch.

Campos

site_search_engine

string

Obligatorio. Nombre completo del recurso SiteSearchEngine, como projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

Este tipo no tiene campos.

Mensaje de respuesta para el método SiteSearchEngineService.DisableAdvancedSiteSearch.

Documento

El documento captura toda la información de metadatos sin procesar de los elementos que se recomendarán o buscarán.

Campos
`name`	`string` Inmutable. Es el nombre completo del recurso del documento. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
`id`	`string` Inmutable. Es el identificador del documento. El ID debe cumplir con el estándar RFC-1034 y tener un límite de 128 caracteres.
`schema_id`	`string` Es el identificador del esquema ubicado en el mismo almacén de datos.
`content`	`Content` Son los datos no estructurados vinculados a este documento. El contenido solo se puede establecer y se debe establecer si este documento se encuentra en un almacén de datos `CONTENT_REQUIRED`.
`parent_document_id`	`string` Es el identificador del documento principal. Actualmente, admite como máximo una jerarquía de documentos de dos niveles. El ID debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres.
`derived_struct_data`	`Struct` Solo salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no se encuentran en el documento de entrada original.
`acl_info`	`AclInfo` Es la información de control de acceso del documento.
`index_time`	`Timestamp` Solo salida. Es la última vez que se indexó el documento. Si se configura este campo, es posible que el documento se muestre en los resultados de la búsqueda. Este campo es OUTPUT_ONLY. Si este campo no está completado, significa que el documento nunca se indexó.
`index_status`	`IndexStatus` Solo salida. Es el estado de indexación del documento. Si el documento se indexa correctamente, se propagará el campo index_time. De lo contrario, si el documento no se indexa debido a errores, se propagará el campo error_samples. De lo contrario, si la indexación del documento está en curso, se propagará el campo pending_message.
Campo de unión `data`. Representación de datos Se debe proporcionar `struct_data` o `json_data`. De lo contrario, se arrojará un error `INVALID_ARGUMENT`. `data` puede ser solo una de las siguientes opciones:
`struct_data`	`Struct` Son los datos estructurados en formato JSON del documento. Debe cumplir con el `Schema` registrado o se arroja un error `INVALID_ARGUMENT`.
`json_data`	`string` Es la representación de la cadena JSON del documento. Debe cumplir con el `Schema` registrado o se arroja un error `INVALID_ARGUMENT`.

AclInfo

Es la información de la LCA del documento.

Campos

readers[]

AccessRestriction

Son los lectores del documento.

AccessRestriction

AclRestriction para modelar restricciones de herencia complejas.

Ejemplo: Modelado de una herencia de "Permiso doble", en la que, para acceder a un documento secundario, el usuario debe tener acceso al documento principal.

Jerarquía del documento: Space_S --> Page_P.

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

Restricción de ACL de Space_S: { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } }

Restricción de LCA de 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 principales.

idp_wide

bool

Todos los usuarios del proveedor de identidad

Contenido

Son los datos no estructurados vinculados a este documento.

Campos
`mime_type`	`string` Es el tipo de MIME del contenido. Tipos admitidos: `application/pdf` (PDF; por el momento, solo se admiten los PDFs nativos) `text/html` (HTML) `text/plain` (TXT) `application/xml` o `text/xml` (XML) `application/json` (JSON) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) Los siguientes tipos solo se admiten si el analizador de diseño está habilitado en el almacén de datos: `image/bmp` (BMP) `image/gif` (GIF) `image/jpeg` (JPEG) `image/png` (PNG) `image/tiff` (TIFF) Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.
Campo de unión `content`. Es el contenido del documento no estructurado. `content` puede ser solo uno de los siguientes:
`raw_bytes`	`bytes` Es el contenido representado como un flujo de bytes. La longitud máxima es de 1,000,000 de bytes (1 MB / 0.95 MiB). Nota: Al igual que con todos los campos de `bytes`, este campo se representa como binario puro en los búferes de protocolo y como una cadena codificada en Base64 en JSON. Por ejemplo, `abc123!?$*&()'-=@~` se debe representar como `YWJjMTIzIT8kKiYoKSctPUB+` en JSON. Consulta https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` Es el URI del contenido. Solo se admiten los URI de Cloud Storage (p.ej., `gs://bucket-name/path/to/file`). El tamaño máximo del archivo es de 2.5 MB para los formatos basados en texto y de 200 MB para otros formatos.

IndexStatus

Es el estado de indexación del documento.

Campos

index_time

Es la fecha y hora en que se indexó el documento. Si este campo se propaga, significa que el documento se indexó.

error_samples[]

LayoutBasedChunkingConfig

Es una muestra de los errores que se encontraron durante la indexación del documento. Si este campo está completado, el documento no se indexó debido a errores.

pending_message

string

Inmutable. El mensaje indica que el índice de documentos está en curso. Si este campo está completado, el índice del documento está pendiente.

DocumentInfo

Es la información detallada del documento asociada a un evento del usuario.

Campos
`promotion_ids[]`	`string` Son los IDs de las promociones asociadas con este documento. Actualmente, este campo está restringido a un ID como máximo.
`joined`	`bool` Solo salida. Indica si se puede encontrar el documento al que se hace referencia en el almacén de datos.
Campo de unión `document_descriptor`. Es un descriptor obligatorio del `Document` asociado. Si se especifica `id`, se usarán los valores predeterminados de `{location}`, `{collection_id}`, `{data_store_id}` y `{branch_id}` cuando se anote con el documento almacenado. Si se especifica `name`, se usarán los valores proporcionados (se permiten valores predeterminados) para `{location}`, `{collection_id}`, `{data_store_id}` y `{branch_id}` cuando se anote con el documento almacenado. `document_descriptor` puede ser solo uno de los siguientes:
`id`	`string` ID del recurso `Document`.
`name`	`string` Nombre completo del recurso `Document`, con el siguiente formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` El URI de `Document`, solo se permite para los almacenes de datos de sitios web.
`quantity`	`int32` Cantidad del documento asociado al evento del usuario. El valor predeterminado es 1. Por ejemplo, este campo es 2 si dos cantidades del mismo documento están involucradas en un evento `add-to-cart`. Obligatorio para los eventos de los siguientes tipos: `add-to-cart` `purchase`
`conversion_value`	`float` Opcional. Es el valor de conversión asociado a este documento. Se debe establecer si `UserEvent.event_type` es "conversion". Por ejemplo, un valor de 1,000 significa que se dedicaron 1,000 segundos a ver un documento para el tipo de conversión `watch`.

DocumentProcessingConfig

Es un recurso singleton de DataStore. Si está vacío cuando se crea DataStore y DataStore se establece en DataStore.ContentConfig.CONTENT_REQUIRED, el analizador predeterminado se establecerá de forma predeterminada en el analizador digital.

Campos
`name`	`string` Es el nombre completo del recurso de la configuración de procesamiento de documentos. Formato: `projects//locations//collections//dataStores//documentProcessingConfig`.
`chunking_config`	`ChunkingConfig` Indica si el modo de fragmentación está habilitado.
`default_parsing_config`	`ParsingConfig` Es la configuración del analizador de documentos predeterminado. Si no se especifica, lo configuraremos como DigitalParsingConfig predeterminado, y la configuración de análisis predeterminada se aplicará a todos los tipos de archivos para el análisis de documentos.
`parsing_config_overrides`	`map<string, ParsingConfig>` Es un mapa del tipo de archivo para anular la configuración de análisis predeterminada según el tipo de archivo. Claves admitidas: `pdf`: Anula la configuración de análisis para archivos PDF. Se admite el análisis digital, el análisis de OCR o el análisis de diseño. `html`: Anula la configuración de análisis para archivos HTML. Solo se admiten el análisis digital y el análisis de diseño. `docx`: Anula la configuración de análisis para archivos DOCX. Solo se admiten el análisis digital y el análisis de diseño. `pptx`: Anula la configuración de análisis para los archivos PPTX. Solo se admiten el análisis digital y el análisis de diseño. `xlsm`: Anula la configuración de análisis para los archivos XLSM. Solo se admiten el análisis digital y el análisis de diseño. `xlsx`: Anula la configuración de análisis para los archivos XLSX. Solo se admiten el análisis digital y el análisis de diseño.

ChunkingConfig

Es la configuración de la configuración de fragmentación.

Campos

Campo de unión chunk_mode. Es la configuración adicional que define el comportamiento de la división en fragmentos. chunk_mode puede ser solo uno de los siguientes:

layout_based_chunking_config

Es la configuración para la división en fragmentos basada en el diseño.

LayoutBasedChunkingConfig

Es la configuración para la división en fragmentos basada en el diseño.

Campos

chunk_size

int32

Es el límite de tamaño de token para cada fragmento.

Valores admitidos: de 100 a 500 (inclusive). El valor predeterminado es 500.

include_ancestor_headings

bool

Indica si se deben agregar diferentes niveles de encabezados a los fragmentos del medio del documento para evitar la pérdida de contexto.

El valor predeterminado es False.

ParsingConfig

Son parámetros de configuración relacionados que se aplican a un tipo específico de analizador de documentos.

Campos
Campo de unión `type_dedicated_config`. Son parámetros de configuración para los tipos de procesamiento de documentos. `type_dedicated_config` puede ser solo uno de los siguientes:
`digital_parsing_config`	`DigitalParsingConfig` Son las configuraciones que se aplican al analizador digital.
`ocr_parsing_config`	`OcrParsingConfig` Son las configuraciones que se aplican al analizador de OCR. Actualmente, solo se aplica a los archivos PDF.
`layout_parsing_config`	`LayoutParsingConfig` Son las configuraciones que se aplican al analizador de diseños.

DigitalParsingConfig

Este tipo no tiene campos.

Son los parámetros de configuración de análisis digital para documentos.

LayoutParsingConfig

Son los parámetros de configuración del análisis de diseño para documentos.

Campos
`enable_table_annotation`	`bool` Opcional. Si es verdadero, se agrega la anotación basada en LLM a la tabla durante el análisis.
`enable_image_annotation`	`bool` Opcional. Si es verdadero, se agrega la anotación basada en LLM a la imagen durante el análisis.
`structured_content_types[]`	`string` Opcional. Contiene los tipos de estructura requeridos para extraer del documento. Valores admitidos: `shareholder-structure`
`exclude_html_elements[]`	`string` Opcional. Lista de elementos HTML que se excluirán del contenido analizado.
`exclude_html_classes[]`	`string` Opcional. Lista de clases HTML que se excluirán del contenido analizado.
`exclude_html_ids[]`	`string` Opcional. Lista de IDs de HTML que se excluirán del contenido analizado.
`enable_get_processed_document`	`bool` Opcional. Si es verdadero, el documento procesado estará disponible para la API de GetProcessedDocument.

OcrParsingConfig

Son los parámetros de configuración del análisis de OCR para documentos.

Campos

enhanced_document_elements[]
(deprecated)

string

[OBSOLETO] Este campo ya no está disponible. Para usar el procesamiento adicional de elementos de documentos mejorados, cambia a layout_parsing_config.

use_native_text

bool

Si es verdadero, se usará el texto nativo en lugar del texto de OCR en las páginas que contengan texto nativo.

DoubleList

Lista doble.

Campos

values[]

double

Valores dobles

EnableAdvancedSiteSearchMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.EnableAdvancedSiteSearch. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

RecommendedForYouFeatureConfig

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

EnableAdvancedSiteSearchRequest

Mensaje de solicitud para el método SiteSearchEngineService.EnableAdvancedSiteSearch.

Campos

site_search_engine

string

Obligatorio. Nombre completo del recurso SiteSearchEngine, como projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

Este tipo no tiene campos.

Mensaje de respuesta para el método SiteSearchEngineService.EnableAdvancedSiteSearch.

Motor

Son los metadatos que describen los parámetros de entrenamiento y entrega de un Engine.

Campos
`name`	`string` Inmutable. Es el identificador. Es el nombre completamente calificado del recurso del motor. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres. Formato: El motor `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` debe tener entre 1 y 63 caracteres, y los caracteres válidos son /[a-z0-9][a-z0-9-_]*/. De lo contrario, se muestra un error INVALID_ARGUMENT.
`display_name`	`string` Obligatorio. Es el nombre visible del motor. Debe ser legible. Es una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo en la que se creó el motor de recomendaciones.
`update_time`	`Timestamp` Solo salida. Es la marca de tiempo de la última actualización del motor de recomendaciones.
`data_store_ids[]`	`string` Opcional. Son los almacenes de datos asociados a este motor. En el caso de los motores de tipo `SOLUTION_TYPE_SEARCH` y `SOLUTION_TYPE_RECOMMENDATION`, solo se pueden asociar con un máximo de un almacén de datos. Si `solution_type` es `SOLUTION_TYPE_CHAT`, se pueden asociar varios `DataStore` en el mismo `Collection`. Ten en cuenta que, cuando se usa en `CreateEngineRequest`, se debe proporcionar un ID de DataStore, ya que el sistema lo usará para las inicializaciones necesarias.
`solution_type`	`SolutionType` Obligatorio. Son las soluciones del motor.
`industry_vertical`	`IndustryVertical` Opcional. Es la vertical de la industria que registra el motor. La restricción de la vertical de la industria del motor se basa en `DataStore`: La vertical del motor debe coincidir con la vertical del DataStore vinculado al motor.
`common_config`	`CommonConfig` Es una especificación de configuración común que especifica los metadatos del motor.
`app_type`	`AppType` Opcional. Inmutable. Es el tipo de aplicación que representa este recurso del motor. NOTA: Este es un concepto nuevo independiente del sector vertical o el tipo de solución existentes.
`disable_analytics`	`bool` Opcional. Indica si se deben inhabilitar las estadísticas de las búsquedas realizadas en este motor.
`features`	`map<string, FeatureState>` Opcional. Es la configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas: `*`: Todos los elementos. Si está presente, se ignoran todos los demás parámetros de configuración del estado del elemento. `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. Es la configuración para el enfoque de facturación configurable.
Campo de unión `engine_config`. Son especificaciones de configuración adicionales que definen el comportamiento del motor. `engine_config` puede ser solo uno de los siguientes:
`chat_engine_config`	`ChatEngineConfig` Son las configuraciones del motor de chat. Solo se aplica si `solution_type` es `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Son los parámetros de configuración del motor de búsqueda. Solo se aplica si `solution_type` es `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Son las configuraciones del motor de medios. Solo se aplica a los almacenes de datos con las verticales `solution_type`, `SOLUTION_TYPE_RECOMMENDATION` y `IndustryVertical.MEDIA`.
Campo de unión `engine_metadata`. Son los metadatos del motor para supervisar su estado. `engine_metadata` puede ser solo uno de los siguientes:
`chat_engine_metadata`	`ChatEngineMetadata` Solo salida. Es información adicional sobre el motor de Chat. Solo se aplica si `solution_type` es `SOLUTION_TYPE_CHAT`.

AppType

Es la app del motor.

Enums
`APP_TYPE_UNSPECIFIED`	Todas las apps no especificadas.
`APP_TYPE_INTRANET`	Es el tipo de app para la búsqueda en la intranet y Agentspace.

ChatEngineConfig

Es la configuración de un Chat Engine.

Campos

agent_creation_config

AgentCreationConfig

Es la configuración para generar el agente de Dialogflow asociado a este motor.

Ten en cuenta que el servicio de Dialogflow consume y recibe estas configuraciones una sola vez. Esto significa que no se pueden recuperar con la API de EngineService.GetEngine o EngineService.ListEngines después de la creación del motor.

dialogflow_agent_to_link

string

Es el nombre del recurso de un agente de Dialogflow existente que se vinculará a este Chat Engine. Los clientes pueden proporcionar agent_creation_config para crear un agente o proporcionar un nombre de agente que vincule el agente con el motor de Chat.

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

Ten en cuenta que el servicio de Dialogflow consume los dialogflow_agent_to_link una sola vez y los recibe. Esto significa que no se pueden recuperar con la API de EngineService.GetEngine o EngineService.ListEngines después de la creación del motor. Usa ChatEngineMetadata.dialogflow_agent para la asociación real del agente después de que se cree el motor.

allow_cross_region

bool

Opcional. Si la marca se establece como verdadera, permitimos que el agente y el motor estén en ubicaciones diferentes. De lo contrario, se requiere que el agente y el motor estén en la misma ubicación. De forma predeterminada, la marca se establece en falso.

Ten en cuenta que allow_cross_region se consume una sola vez y se pasa a EngineService.CreateEngine. Esto significa que no se pueden recuperar con la API de EngineService.GetEngine o EngineService.ListEngines después de la creación del motor.

AgentCreationConfig

Son los parámetros de configuración para generar un agente de Dialogflow.

Campos
`business`	`string` Nombre de la empresa, organización o cualquier otra entidad que representa el agente Se usa para la instrucción del LLM del conector de conocimiento y para la búsqueda de conocimiento.
`default_language_code`	`string` Obligatorio. El idioma predeterminado del agente como una etiqueta de idioma. Consulta Idiomas admitidos para obtener una lista de los códigos de idioma admitidos en este momento.
`time_zone`	`string` Obligatorio. La zona horaria del agente de la base de datos de zonas horarias, p. ej., America/New_York, Europe/Paris.
`location`	`string` Ubicación del agente para la creación del agente. Los valores admitidos son global/us/eu. Si no se proporciona, el motor de EE.UU. creará el agente con us-central-1 de forma predeterminada, y el motor de la UE creará el agente con eu-west-1 de forma predeterminada.

ChatEngineMetadata

Es información adicional de un motor de Chat. Los campos de este mensaje son solo de salida.

Campos

dialogflow_agent

string

Es el nombre del recurso de un agente de Dialogflow al que hace referencia este Chat Engine.

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

CommonConfig

Son configuraciones comunes para un motor.

Campos

company_name

string

Es el nombre de la empresa, el negocio o la entidad asociados con el motor. Establecer este parámetro de configuración puede ayudar a mejorar las funciones relacionadas con LLM.

ConfigurableBillingApproach

Es la configuración para el enfoque de facturación configurable.

Enums
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predeterminado. Es el enfoque de facturación no configurable para Spark y no Spark. Modelo de precios general.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	El enfoque de facturación sigue las configuraciones especificadas por el cliente.

FeatureState

Es el estado de la función para el motor.

Enums
`FEATURE_STATE_UNSPECIFIED`	El estado de la función no está especificado.
`FEATURE_STATE_ON`	La función está activada para que sea accesible.
`FEATURE_STATE_OFF`	La función está desactivada para que no se pueda acceder a ella.

MediaRecommendationEngineConfig

Son especificaciones de configuración adicionales para un motor de recomendaciones de contenido multimedia.

Campos
`type`	`string` Obligatorio. Es el tipo de motor, p. ej., `recommended-for-you` Este campo, junto con `optimization_objective`, describe los metadatos del motor que se usarán para controlar el entrenamiento y la publicación del motor. Actualmente, los valores admitidos son `recommended-for-you`, `others-you-may-like`, `more-like-this` y `most-popular-items`.
`optimization_objective`	`string` Es el objetivo de optimización, p. ej., `cvr` Este campo, junto con `optimization_objective`, describe los metadatos del motor que se usarán para controlar el entrenamiento y la publicación del motor. Valores admitidos actualmente: `ctr`, `cvr`. Si no se especifica, elegimos el valor predeterminado según el tipo de motor. El valor predeterminado depende del tipo de recomendación: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`
`optimization_objective_config`	`OptimizationObjectiveConfig` Nombre y valor del umbral personalizado para el objetivo de optimización cvr. Para target_field `watch-time`, target_field_value debe ser un valor entero que indique el tiempo de progreso del contenido multimedia en segundos entre (0, 86400] (excluye el 0, incluye el 86400) (p.ej., 90). Para target_field `watch-percentage`, target_field_value debe ser un valor de número de punto flotante válido entre (0, 1.0] (excluye el 0, incluye el 1.0) (p.ej., 0.5).
`training_state`	`TrainingState` Es el estado de entrenamiento en el que se encuentra el motor (p.ej., `TRAINING` o `PAUSED`). Dado que parte del costo de ejecutar el servicio es la frecuencia de entrenamiento, esto se puede usar para determinar cuándo entrenar el motor y controlar el costo. Si no se especifica, el valor predeterminado para el método `CreateEngine` es `TRAINING`. El valor predeterminado para el método `UpdateEngine` es mantener el estado como antes.
`engine_features_config`	`EngineFeaturesConfig` Opcional. Es la configuración de funciones adicionales del motor.

EngineFeaturesConfig

Son más parámetros de configuración de funciones del tipo de motor seleccionado.

Campos

Campo de unión type_dedicated_config. Son los parámetros de configuración relacionados con las funciones que se aplican a un tipo específico de motores de recomendación de medios. type_dedicated_config puede ser solo uno de los siguientes:

recommended_for_you_config

Es la configuración de la función del motor de recomendaciones para ti.

most_popular_config

MostPopularFeatureConfig

Es la configuración de la función del motor más popular.

MostPopularFeatureConfig

Son los parámetros de configuración de funciones que se requieren para crear un motor de búsqueda de lo más popular.

Campos

time_window_days

int64

Es el período durante el cual se consulta el motor en el momento del entrenamiento y la predicción. Solo números enteros positivos. El valor se traduce en los últimos X días de eventos. Actualmente, se requiere para el motor most-popular-items.

OptimizationObjectiveConfig

Es el umbral personalizado para el objetivo de optimización cvr.

Campos

target_field

string

Obligatorio. Es el nombre del campo al que se segmenta. Valores admitidos actualmente: watch-percentage, watch-time.

target_field_value_float

float

Obligatorio. Es el umbral que se aplicará al objetivo (p.ej., 0.5).

RecommendedForYouFeatureConfig

Es la configuración de funciones adicionales para crear un motor de recommended-for-you.

Campos

context_event_type

string

Es el tipo de evento con el que se consulta el motor en el momento de la predicción. Si se configura como generic, solo se usarán view-item, media-play y media-complete como context-event en el entrenamiento del motor. Si se establece en view-home-page, view-home-page también se usará como context-events, además de view-item, media-play y media-complete. Actualmente, se admite para el motor de recommended-for-you. Valores admitidos actualmente: view-home-page, generic.

TrainingState

Es el estado de entrenamiento del motor.

Enums
`TRAINING_STATE_UNSPECIFIED`	No se especificó el estado del entrenamiento.
`PAUSED`	El entrenamiento del motor está en pausa.
`TRAINING`	El motor se está entrenando.

SearchEngineConfig

Son las configuraciones de un motor de búsqueda.

Campos

search_tier

SearchTier

Es el nivel de funciones de búsqueda de este motor.

Los diferentes niveles pueden tener precios diferentes. Para obtener más información, consulta la documentación sobre precios.

El valor predeterminado es SearchTier.SEARCH_TIER_STANDARD si no se especifica.

search_add_ons[]

SearchAddOn

Es el complemento que habilita este motor de búsqueda.

FactChunk

Es un fragmento de hecho.

Campos
`chunk_text`	`string` Es el contenido de texto del fragmento de hecho. Puede tener hasta 10,000 caracteres.
`source`	`string` Es la fuente desde la que se recuperó este fragmento de hecho. Si se recuperó de los GroundingFacts proporcionados en la solicitud, este campo contendrá el índice del hecho específico del que se recuperó este fragmento.
`index`	`int32` Es el índice de este fragmento. Actualmente, solo se usa para el modo de transmisión.
`source_metadata`	`map<string, string>` Es información más detallada para la referencia de la fuente.
`uri`	`string` Es el URI de la fuente.
`title`	`string` Es el título de la fuente.
`domain`	`string` Es el dominio de la fuente.

FetchDomainVerificationStatusRequest

Mensaje de solicitud para el método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

site_search_engine

string

Obligatorio. Es el recurso del motor de búsqueda del sitio en el que recuperamos todo el estado de verificación del dominio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine

page_size

int32

Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. El valor máximo es 1,000; valores superiores a 1,000 se convertirán en 1,000.

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.

page_token

string

Un token de página, recibido desde una llamada FetchDomainVerificationStatus anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a FetchDomainVerificationStatus deben coincidir con la llamada que proporcionó el token de la página.

FetchDomainVerificationStatusResponse

Mensaje de respuesta para el método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

target_sites[]

Es una lista de TargetSites que contiene el estado de verificación del sitio.

next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

total_size

int32

Es la cantidad total de elementos que coinciden con la solicitud. Este campo siempre se propagará en la respuesta.

FetchSitemapsRequest

Mensaje de solicitud para el método SiteSearchEngineService.FetchSitemaps.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Opcional. Si se especifica, recupera los Sitemaps coincidentes. Si no se especifica, se recuperan todos los Sitemap en el DataStore.

Matcher

Es el comparador de los Sitemap. Actualmente, solo admite el comparador de URI.

Campos

Campo de unión matcher. Es el comparador de los Sitemap. matcher puede ser solo uno de los siguientes:

uris_matcher

UrisMatcher

Es un comparador por URI de mapa del sitio.

UrisMatcher

Es un comparador de los Sitemaps por sus URIs.

Campos

uris[]

string

Son los URIs de Sitemap.

FetchSitemapsResponse

Mensaje de respuesta para el método SiteSearchEngineService.FetchSitemaps.

Campos

sitemaps_metadata[]

SitemapMetadata

Es la lista de objetos Sitemap recuperados.

SitemapMetadata

Contiene un Sitemap y sus metadatos.

Campos

sitemap

Sitemap

El tipo Sitemap.

FhirStoreSource

Es el almacén de FHIR de Cloud desde el que se importan los datos.

Campos
`fhir_store`	`string` Obligatorio. Es el nombre completo del recurso del almacén de FHIR desde el que se importarán los datos, con el formato `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Es el directorio intermedio de Cloud Storage que se usa para la importación, con un límite de 2,000 caracteres. Se puede especificar si se desea que FhirStore exporte a un directorio específico de Cloud Storage.
`resource_types[]`	`string` Son los tipos de recursos de FHIR que se importarán. Los tipos de recursos deben ser un subconjunto de todos los tipos de recursos de FHIR compatibles. Si está vacío, se establecerán de forma predeterminada todos los tipos de recursos FHIR admitidos.
`update_from_latest_predefined_schema`	`bool` Opcional. Indica si se debe actualizar el esquema de DataStore al esquema predefinido más reciente. Si es verdadero, el esquema de DataStore se actualizará para incluir cualquier campo o tipo de recurso de FHIR que se haya agregado desde la última importación, y los recursos de FHIR correspondientes se importarán desde el almacén de FHIR. Ten en cuenta que este campo no se puede usar junto con `resource_types`. Se debe usar después de la importación inicial.

FirestoreSource

Es la fuente de la que se importan los datos de Firestore.

Campos
`project_id`	`string` Es el ID del proyecto en el que se encuentra la fuente de Cloud SQL, con un límite de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`database_id`	`string` Obligatorio. Base de datos de Firestore desde la que se copiarán los datos, con un límite de 256 caracteres.
`collection_id`	`string` Obligatorio. Es la colección (o entidad) de Firestore desde la que se copiarán los datos, con un límite de 1,500 caracteres.
`gcs_staging_dir`	`string` Es el directorio intermedio de Cloud Storage que se usa para la importación, con un límite de 2,000 caracteres. Se puede especificar si se desea que Firestore exporte a un directorio específico de Cloud Storage. Asegúrate de que la cuenta de servicio de Firestore tenga los permisos de administrador de Cloud Storage necesarios para acceder al directorio de Cloud Storage especificado.

GcsSource

Ubicación de Cloud Storage para el contenido de entrada.

Campos

input_uris[]

string

Obligatorio. Son los URIs de Cloud Storage para los archivos de entrada. Cada URI puede tener hasta 2,000 caracteres. Los URIs pueden coincidir con la ruta de acceso completa del objeto (por ejemplo, gs://bucket/directory/object.json) o con un patrón que coincida con uno o más archivos, como gs://bucket/directory/*.json.

Una solicitud puede contener hasta 100 archivos (o 100,000 archivos si data_schema es content). Cada archivo puede tener hasta 2 GB (o 100 MB si data_schema es content).

data_schema

string

Es el esquema que se usará cuando se analicen los datos de la fuente.

Valores admitidos para las importaciones de documentos:

document (predeterminado): Un objeto Document JSON por línea. Cada documento debe tener un Document.id válido.
content: Datos no estructurados (p.ej., PDF, HTML). Cada archivo que coincide con input_uris se convierte en un documento, con el ID establecido en los primeros 128 bits de SHA256(URI) codificados como una cadena hexadecimal.
custom: Un objeto JSON de datos personalizados por fila en formato arbitrario que se ajusta al Schema definido del almacén de datos. Solo puede usarlo la vertical de almacén de datos GENÉRICO.
csv: Es un archivo CSV con un encabezado que se ajusta al Schema definido del almacén de datos. Cada entrada después del encabezado se importa como un documento. Solo puede usarlo la vertical de almacén de datos GENÉRICO.

Valores admitidos para las importaciones de eventos de usuario:

user_event (predeterminado): Un objeto UserEvent JSON por línea.

GetAclConfigRequest

Es el mensaje de solicitud para el método GetAclConfigRequest.

Campos

name

string

Obligatorio. Nombre del recurso de AclConfig, como projects/*/locations/*/aclConfig.

Si el llamador no tiene permiso para acceder al AclConfig, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

GetAnswerRequest

Es la solicitud para el método GetAnswer.

Campos

name

string

Obligatorio. Es el nombre del recurso de la respuesta que se obtendrá. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Mensaje de la solicitud para el método AssistAnswerService.GetAssistAnswer.

Campos

name

string

Obligatorio. Es el nombre del recurso AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Mensaje de la solicitud para el método AssistantService.GetAssistant.

Campos

name

string

Obligatorio. Es el nombre del recurso de Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

GetCmekConfigRequest

Es el mensaje de solicitud para el método GetCmekConfigRequest.

Campos

name

string

Obligatorio. Nombre del recurso de CmekConfig, como projects/*/locations/*/cmekConfig o projects/*/locations/*/cmekConfigs/*.

Si el llamador no tiene permiso para acceder al CmekConfig, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

GetControlRequest

Es la solicitud para el método GetControl.

Campos

name

string

Obligatorio. Es el nombre del recurso del control que se obtendrá. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Es la solicitud para el método GetConversation.

Campos

name

string

Obligatorio. Es el nombre del recurso de la conversación que se obtendrá. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Es la solicitud para el método DataConnectorService.GetDataConnector.

Campos

name

string

Obligatorio. Nombre completo del recurso DataConnector, como projects/{project}/locations/{location}/collections/{collection_id}/dataConnector.

Si el llamador no tiene permiso para acceder al DataConnector, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el DataConnector solicitado no existe, se muestra un error NOT_FOUND.

GetDataStoreRequest

Mensaje de solicitud para el método DataStoreService.GetDataStore.

Campos

name

string

Obligatorio. Nombre completo del recurso DataStore, como projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

Si el llamador no tiene permiso para acceder al DataStore, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el DataStore solicitado no existe, se muestra un error NOT_FOUND.

GetDocumentRequest

Mensaje de solicitud para el método DocumentService.GetDocument.

Campos

name

string

Obligatorio. Nombre completo del recurso Document, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

Si el llamador no tiene permiso para acceder al Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Document solicitado no existe, se muestra un error NOT_FOUND.

GetEngineRequest

Mensaje de solicitud para el método EngineService.GetEngine.

Campos

name

string

Obligatorio. Nombre completo del recurso Engine, como projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetIdentityMappingStoreRequest

Mensaje de solicitud para IdentityMappingStoreService.GetIdentityMappingStore

Campos

name

string

Obligatorio. Es el nombre del almacén de asignación de identidades que se obtendrá. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Mensaje de solicitud para el método LicenseConfigService.GetLicenseConfig.

Campos

name

string

Obligatorio. Nombre completo del recurso LicenseConfig, como projects/{project}/locations/{location}/licenseConfigs/*.

Si el llamador no tiene permiso para acceder al LicenseConfig, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el LicenseConfig solicitado no existe, se muestra un error NOT_FOUND.

GetSchemaRequest

Mensaje de solicitud para el método SchemaService.GetSchema.

Campos

name

string

Obligatorio. Es el nombre completo del recurso del esquema, con el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSessionRequest

Es la solicitud para el método GetSession.

Campos

name

string

Obligatorio. Es el nombre del recurso de la sesión que se obtendrá. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Opcional. Si se configura como verdadero, se devolverá la sesión completa, incluidos todos los detalles de las respuestas.

GetSiteSearchEngineRequest

Mensaje de solicitud para el método SiteSearchEngineService.GetSiteSearchEngine.

Campos

name

string

Obligatorio. Nombre del recurso de SiteSearchEngine, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Si el llamador no tiene permiso para acceder a [SiteSearchEngine], independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

GetTargetSiteRequest

Mensaje de solicitud para el método SiteSearchEngineService.GetTargetSite.

Campos

name

string

Obligatorio. Nombre completo del recurso TargetSite, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

Si el llamador no tiene permiso para acceder al TargetSite, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el TargetSite solicitado no existe, se muestra un error NOT_FOUND.

GroundingFact

Es un hecho básico.

Campos

fact_text

string

Es el contenido de texto del hecho. Puede tener hasta 10,000 caracteres.

attributes

map<string, string>

Son los atributos asociados con el hecho. Los atributos comunes incluyen source (que indica la fuente del hecho), author (que indica el autor del hecho), etcétera.

HarmCategory

Son las categorías de daño que bloquearán el contenido.

Enums
`HARM_CATEGORY_UNSPECIFIED`	No se especifica la categoría de daño.
`HARM_CATEGORY_HATE_SPEECH`	La categoría de daño es la incitación al odio o a la violencia.
`HARM_CATEGORY_DANGEROUS_CONTENT`	La categoría de daño es el contenido peligroso.
`HARM_CATEGORY_HARASSMENT`	La categoría de daño es el hostigamiento.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	La categoría de daño es el contenido sexual explícito.
`HARM_CATEGORY_CIVIC_INTEGRITY`	La categoría de daño es la integridad cívica.

HealthcareFhirConfig

Es la configuración del almacén de datos para la vertical de HEALTHCARE_FHIR.

Campos

enable_configurable_schema

bool

Indica si se debe habilitar el esquema configurable para la vertical de HEALTHCARE_FHIR.

Si se configura como true, el esquema de FHIR de atención médica predefinido se puede extender para realizar búsquedas y filtrados más personalizados.

enable_static_indexing_for_batch_ingestion

bool

Indica si se debe habilitar la indexación estática para la transferencia por lotes de HEALTHCARE_FHIR.

Si se configura como true, la transferencia por lotes se procesará en un modo de indexación estático que es más lento, pero más capaz de controlar un volumen mayor.

IdentityMappingEntry

Es una entrada de asignación de identidad que asigna una identidad externa a una identidad interna.

Campos
`external_identity`	`string` Obligatorio. Es la identidad fuera del proveedor de identidad del cliente. El límite de longitud de la identidad externa será de 100 caracteres.
Campo de unión `identity_provider_id`. Campo de unión identity_provider_id. El ID del proveedor de identidad puede ser un usuario o un grupo. `identity_provider_id` puede ser solo uno de los siguientes:
`user_id`	`string` Es el identificador del usuario. En el caso de las cuentas de usuario de Google Workspace, user_id debe ser el correo electrónico del usuario de Google Workspace. Para el proveedor de identidad que no es de Google, user_id es el identificador de usuario asignado que se configuró durante la configuración de workforcepool.
`group_id`	`string` Es el identificador del grupo. En el caso de las cuentas de usuario de Google Workspace, group_id debe ser el correo electrónico del grupo de Google Workspace. Para los proveedores de identidad que no son de Google, group_id es el identificador de grupo asignado que se configuró durante la configuración de workforcepool.

IdentityMappingEntryOperationMetadata

Metadatos de LongRunningOperation de IdentityMappingEntry para IdentityMappingStoreService.ImportIdentityMappings y IdentityMappingStoreService.PurgeIdentityMappings

Campos

success_count

int64

Es la cantidad de IdentityMappingEntries que se procesaron correctamente.

failure_count

int64

Es la cantidad de IdentityMappingEntries que no se pudieron procesar.

total_count

int64

Es la cantidad total de IdentityMappingEntries que se procesaron.

IdentityMappingStore

Es un almacén de asignación de identidades que contiene entradas de asignación de identidades.

Campos

name

string

Inmutable. Es el nombre completo del recurso del almacén de asignación de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.

kms_key_name

string

Solo entrada. Es la clave de KMS que se usará para proteger este almacén de asignación de identidades en el momento de la creación.

Se debe configurar para las solicitudes que deben cumplir con las protecciones de la política de la organización de CMEK.

Si este campo se configura y procesa correctamente, el almacén de asignación de identidades estará protegido por la clave de KMS, como se indica en el campo cmek_config.

cmek_config

CmekConfig

Solo salida. Es la información relacionada con la CMEK para el almacén de asignación de identidades.

IdentityScheduleConfig

Es la configuración de las ejecuciones de sincronización de datos de identidad.

Campos

refresh_interval

Duration

Opcional. Es el intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos que ingiere este conector. Si no se establece, la lista de control de acceso se actualizará en el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de al menos 30 minutos y de hasta 7 días.

next_sync_time

DateTime

Opcional. Es la fecha y hora en UTC en la que se espera que comience la próxima sincronización de datos para el conector de datos. Los clientes solo pueden especificar la hora y el minuto para programar la sincronización de datos. Se utiliza cuando el conector de datos tiene un intervalo de actualización superior a 1 día.

IdpConfig

Configuración del proveedor de identidad

Campos

idp_type

IdpType

Se configuró el tipo de proveedor de identidad.

external_idp_config

ExternalIdpConfig

Es la configuración del proveedor de identidad externo.

ExternalIdpConfig

Configuración del IdP de terceros

Campos

workforce_pool_name

string

Nombre del grupo de trabajadores. Ejemplo: "locations/global/workforcePools/pool_id"

IdpType

Es el tipo de proveedor de identidad.

Enums
`IDP_TYPE_UNSPECIFIED`	Valor predeterminado. La búsqueda de LCA no está habilitada.
`GSUITE`	Es el proveedor de origen de Google.
`THIRD_PARTY`	Proveedor externo.

ImportCompletionSuggestionsMetadata

Son metadatos relacionados con el progreso de la operación ImportCompletionSuggestions. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es la cantidad de `CompletionSuggestion`s que se importaron correctamente.
`failure_count`	`int64` Es el recuento de los objetos `CompletionSuggestion` que no se pudieron importar.

ImportCompletionSuggestionsRequest

Mensaje de solicitud para el método CompletionService.ImportCompletionSuggestions.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del almacén de datos principal para el que se importarán las sugerencias de autocompletar del cliente. Sigue el patrón `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` Ubicación deseada de los errores que se produjeron durante la importación.
Campo de unión `source`. Es la fuente de las sugerencias de autocompletar. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada de las entradas de sugerencias.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage para el contenido de entrada.
`bigquery_source`	`BigQuerySource` Es la fuente de entrada de BigQuery.

InlineSource

Es la fuente intercalada de CompletionSuggestions.

Campos

suggestions[]

CompletionSuggestion

Obligatorio. Es una lista de todas las entradas de la lista de bloqueo que se importarán. Máximo de 1,000 elementos

ImportCompletionSuggestionsResponse

Es la respuesta del método CompletionService.ImportCompletionSuggestions. Si se completó la operación de larga duración, este mensaje se muestra en el campo google.longrunning.Operations.response si la operación se realizó correctamente.

Campos

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

error_config

ImportErrorConfig

Ubicación deseada de los errores que se produjeron durante la importación.

ImportDocumentsMetadata

Son metadatos relacionados con el progreso de la operación ImportDocuments. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es el recuento de las entradas que se procesaron correctamente.
`failure_count`	`int64` Es el recuento de las entradas que tuvieron errores durante el procesamiento.
`total_count`	`int64` Es el recuento total de las entradas que se procesaron.

ImportDocumentsRequest

Es el mensaje de solicitud para los métodos de importación.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso de la rama principal, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Se requiere permiso de creación o actualización.
`error_config`	`ImportErrorConfig` Ubicación deseada de los errores que se produjeron durante la importación.
`reconciliation_mode`	`ReconciliationMode` Es el modo de conciliación entre los documentos existentes y los que se importarán. La configuración predeterminada es `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indica qué campos de los documentos importados proporcionados se deben actualizar. Si no se configura, la opción predeterminada es actualizar todos los campos.
`auto_generate_ids`	`bool` Indica si se deben generar automáticamente IDs para los documentos si no están presentes. Si se configura como `true`, los `Document.id` se generan automáticamente según el hash de la carga útil, en el que los IDs pueden no ser coherentes durante varias importaciones. En ese caso, se recomienda usar `ReconciliationMode.FULL` para evitar contenido duplicado. Si no se configura o se establece en `false`, los `Document.id`s se deben especificar con `id_field`; de lo contrario, no se importarán los documentos sin IDs. Fuentes de datos compatibles: `GcsSource`. `GcsSource.data_schema` debe ser `custom` o `csv`. De lo contrario, se arroja un error INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` debe ser `custom` o `csv`. De lo contrario, se arroja un error INVALID_ARGUMENT. `SpannerSource` `CloudSqlSource` `FirestoreSource` `BigtableSource`
`id_field`	`string` El campo indica el campo o la columna de ID que se usará como IDs únicos de los documentos. Para `GcsSource`, es la clave del campo JSON. Por ejemplo, `my_id` para JSON `{"my_id": "some_uuid"}`. Para otros, puede ser el nombre de la columna de la tabla en la que se almacenan los IDs únicos. Los valores del campo JSON o de la columna de la tabla se usan como los `Document.id`. El campo JSON o la columna de la tabla deben ser de tipo cadena, y los valores deben establecerse como cadenas válidas que cumplan con RFC-1034 con entre 1 y 63 caracteres. De lo contrario, no se podrán importar los documentos sin IDs válidos. Solo establece este campo cuando `auto_generate_ids` no esté establecido o se configure como `false`. De lo contrario, se arroja un error INVALID_ARGUMENT. Si no se configura, se usa el valor predeterminado `_id` cuando se importa desde las fuentes de datos permitidas. Fuentes de datos compatibles: `GcsSource`. `GcsSource.data_schema` debe ser `custom` o `csv`. De lo contrario, se arroja un error INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` debe ser `custom` o `csv`. De lo contrario, se arroja un error INVALID_ARGUMENT. `SpannerSource` `CloudSqlSource` `BigtableSource`
`force_refresh_content`	`bool` Opcional. Indica si se debe forzar la actualización del contenido no estructurado de los documentos. Si se configura como `true`, se actualizará la parte del contenido de los documentos, independientemente del estado de actualización del contenido de referencia.
Campo de unión `source`. Obligatorio. Es la fuente de la entrada. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada del contenido de entrada para los documentos.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage para el contenido de entrada.
`bigquery_source`	`BigQuerySource` Es la fuente de entrada de BigQuery.
`fhir_store_source`	`FhirStoreSource` Es la fuente de entrada de FhirStore.
`spanner_source`	`SpannerSource` Es la fuente de entrada de Spanner.
`cloud_sql_source`	`CloudSqlSource` Es la fuente de entrada de Cloud SQL.
`firestore_source`	`FirestoreSource` Es la fuente de entrada de Firestore.
`alloy_db_source`	`AlloyDbSource` Es la fuente de entrada de AlloyDB.
`bigtable_source`	`BigtableSource` Es la fuente de entrada de Cloud Bigtable.

InlineSource

Es la fuente intercalada de la configuración de entrada para el método ImportDocuments.

Campos

documents[]

Obligatorio. Es una lista de documentos que se deben actualizar o crear. Cada documento debe tener un Document.id válido. Se recomienda un máximo de 100 elementos.

ReconciliationMode

Indica cómo se concilian los documentos importados con los documentos existentes que se crearon o importaron anteriormente.

Enums
`RECONCILIATION_MODE_UNSPECIFIED`	La configuración predeterminada es `INCREMENTAL`.
`INCREMENTAL`	Inserta documentos nuevos o actualiza los existentes.
`FULL`	Calcula la diferencia y reemplaza todo el conjunto de datos del documento. Es posible que se borren los documentos existentes si no están presentes en la ubicación de origen. Cuando se usa este modo, no habrá tiempo de inactividad en el conjunto de datos objetivo. Cualquier documento que deba permanecer sin cambios o que deba actualizarse seguirá publicándose mientras se ejecute la operación.

ImportDocumentsResponse

Respuesta de ImportDocumentsRequest. Si se completó la operación de larga duración, este mensaje se devuelve en el campo google.longrunning.Operations.response si la operación se realizó correctamente.

Campos

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

error_config

ImportErrorConfig

Si se configura, devuelve la respuesta de destino para los errores completos en la solicitud.

ImportErrorConfig

Es la configuración del destino para los errores relacionados con la importación.

Campos

Campo de unión destination. Obligatorio. Es el destino de los errores. destination puede ser solo uno de los siguientes:

gcs_prefix

string

Prefijo de Cloud Storage para los errores de importación. Debe ser un directorio de Cloud Storage existente y vacío. Los errores de importación se escriben en archivos fragmentados en este directorio, uno por línea, como un mensaje google.rpc.Status codificado en JSON.

ImportIdentityMappingsRequest

Mensaje de solicitud para IdentityMappingStoreService.ImportIdentityMappings

Campos

identity_mapping_store

string

Obligatorio. Nombre del almacén de asignación de identidades al que se importarán las entradas de asignación de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Campo de unión source. Es la fuente de la entrada. source puede ser solo uno de los siguientes:

inline_source

InlineSource

Es la fuente intercalada desde la que se importarán las entradas de asignación de identidad.

InlineSource

Es la fuente intercalada desde la que se importarán las entradas de asignación de identidad.

Campos

identity_mapping_entries[]

IdentityMappingEntry

Se puede importar un máximo de 10,000 entradas a la vez

ImportIdentityMappingsResponse

Mensaje de respuesta para IdentityMappingStoreService.ImportIdentityMappings

Campos

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

ImportSuggestionDenyListEntriesMetadata

Son metadatos relacionados con el progreso de la operación ImportSuggestionDenyListEntries. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

SuggestionDenyListEntry

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

ImportSuggestionDenyListEntriesRequest

Mensaje de solicitud para el método CompletionService.ImportSuggestionDenyListEntries.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del almacén de datos principal para el que se importarán las entradas de la lista de bloqueo. Sigue el patrón projects//locations//collections//dataStores/.
Campo de unión `source`. Es la fuente de la SuggestionDenyList actualizada. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada del contenido de entrada para las entradas de la lista de entidades denegadas de sugerencias.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage para el contenido de entrada. Solo se puede especificar 1 archivo que contenga todas las entradas que se importarán. Valores admitidos `gcs_source.schema` para las importaciones de entradas de la lista de bloqueo de sugerencias de autocompletado: `suggestion_deny_list` (predeterminado): Un objeto JSON [SuggestionDenyListEntry] por línea.

InlineSource

Es la fuente intercalada de SuggestionDenyListEntry.

Campos

entries[]

Obligatorio. Es una lista de todas las entradas de la lista de bloqueo que se importarán. Máximo de 1,000 elementos

ImportSuggestionDenyListEntriesResponse

Mensaje de respuesta para el método CompletionService.ImportSuggestionDenyListEntries.

Campos

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

imported_entries_count

int64

Es el recuento de las entradas de la lista de entidades denegadas que se importaron correctamente.

failed_entries_count

int64

Es el recuento de las entradas de la lista de entidades denegadas que no se pudieron importar.

ImportUserEventsMetadata

Son los metadatos relacionados con el progreso de la operación de importación. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es el recuento de las entradas que se procesaron correctamente.
`failure_count`	`int64` Es el recuento de las entradas que tuvieron errores durante el procesamiento.

ImportUserEventsRequest

Es el mensaje de solicitud para la solicitud de ImportUserEvents.

Campos
`parent`	`string` Obligatorio. Nombre del recurso DataStore principal, con el formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` Ubicación deseada de los errores que se produjeron durante la importación. No se puede establecer para las importaciones intercaladas de eventos de usuario.
Campo de unión `source`. Obligatorio: Es la fuente de entrada deseada de los datos de eventos del usuario. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada del contenido de entrada para UserEvents.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage para el contenido de entrada.
`bigquery_source`	`BigQuerySource` Es la fuente de entrada de BigQuery.

InlineSource

Es la fuente intercalada de la configuración de entrada para el método ImportUserEvents.

Campos

user_events[]

UserEvent

Obligatorio. Es una lista de eventos de usuario que se importarán. Se recomienda un máximo de 10,000 elementos.

ImportUserEventsResponse

Es la respuesta de ImportUserEventsRequest. Si la operación de larga duración se completó correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.
`error_config`	`ImportErrorConfig` Devuelve la respuesta de destino para los errores completos si este campo se configuró en la solicitud.
`joined_events_count`	`int64` Es el recuento de eventos de usuario importados con documentos existentes completos.
`unjoined_events_count`	`int64` Es el recuento de eventos de usuario importados, pero sin información del documento en la rama existente.

IndustryVertical

Es el sector vertical asociado con el objeto DataStore.

Enums
`INDUSTRY_VERTICAL_UNSPECIFIED`	Es el valor que se usa cuando no se establece.
`GENERIC`	Es la vertical genérica para los documentos que no son específicos de ninguna vertical de la industria.
`MEDIA`	Vertical de la industria de medios
`HEALTHCARE_FHIR`	Vertical de FHIR de Healthcare

Intervalo

Es un intervalo de punto flotante.

Campos

Campo de unión min. Es el límite inferior del intervalo. Si no se establece ninguno de los campos de valor mínimo, el límite inferior es infinito negativo.

Este campo no debe ser mayor que el valor máximo. De lo contrario, se mostrará un error INVALID_ARGUMENT. min puede ser solo uno de los siguientes:

minimum

double

Es el límite inferior inclusivo.

exclusive_minimum

double

Límite inferior exclusivo.

Campo de unión max. Es el límite superior del intervalo. Si no se establece ninguno de los campos de máximo, el límite superior es infinito positivo.

Este campo no debe ser inferior al valor mín. De lo contrario, se muestra un error INVALID_ARGUMENT. max puede ser solo uno de los siguientes:

maximum

double

Es el límite superior inclusivo.

exclusive_maximum

double

Límite superior exclusivo.

LicenseConfig

Es información sobre las licencias de los usuarios.

Campos
`name`	`string` Inmutable. Es el identificador. Es el nombre de recurso completamente calificado de la configuración de licencia. Formato: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Obligatorio. Cantidad de licencias compradas.
`subscription_tier`	`SubscriptionTier` Obligatorio. Es la información del nivel de suscripción para la configuración de la licencia.
`state`	`State` Solo salida. Es el estado de la configuración de licencias.
`auto_renew`	`bool` Opcional. Indica si la configuración de la licencia se debe renovar automáticamente cuando llegue a la fecha de finalización.
`start_date`	`Date` Obligatorio. Es la fecha de inicio.
`end_date`	`Date` Opcional. Es la fecha de finalización planificada.
`subscription_term`	`SubscriptionTerm` Obligatorio. Es el plazo de suscripción.
`free_trial`	`bool` Opcional. Indica si la configuración de la licencia es para una prueba gratuita.
`alert_policy_resource_config`	`AlertPolicyResourceConfig` Opcional. Es la configuración de la política de alertas para esta configuración de licencia.
`gemini_bundle`	`bool` Solo salida. Indica si la configuración de la licencia es para el paquete de Gemini.

Estado

Es una enumeración del estado de la configuración de licencias.

Enums
`STATE_UNSPECIFIED`	Valor predeterminado. No existe la configuración de la licencia.
`ACTIVE`	La configuración de la licencia es efectiva y se está usando.
`EXPIRED`	Venció la configuración de licencias.
`NOT_STARTED`	La configuración de la licencia aún no comenzó y su fecha de inicio es posterior a la actual.

ListAssistantsRequest

Mensaje de la solicitud para el método AssistantService.ListAssistants.

Campos

parent

string

Obligatorio. Es el nombre del recurso principal. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Cantidad máxima de Assistants que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000, y los valores superiores se convertirán a 1,000.

page_token

string

Un token de página ListAssistantsResponse.next_page_token, recibido desde una llamada a AssistantService.ListAssistants anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListAssistants deben coincidir con la llamada que proporcionó el token de la página.

ListAssistantsResponse

Mensaje de respuesta para el método AssistantService.ListAssistants.

Campos

assistants[]

Assistant

Todos los Assistant del cliente.

next_page_token

string

Es un token que se puede enviar como ListAssistantsRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListCmekConfigsRequest

Mensaje de solicitud para el método CmekConfigService.ListCmekConfigs.

Campos

parent

string

Obligatorio. Nombre del recurso de ubicación principal, como projects/{project}/locations/{location}.

Si el llamador no tiene permiso para enumerar los objetos CmekConfig en esta ubicación, independientemente de si existe o no un CmekConfig, se devuelve un error PERMISSION_DENIED.

ListCmekConfigsResponse

Mensaje de respuesta para el método CmekConfigService.ListCmekConfigs.

Campos

cmek_configs[]

CmekConfig

Todos los CmekConfig del cliente.

ListControlsRequest

Es la solicitud para el método ListControls.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` o `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`page_size`	`int32` Opcional. Cantidad máxima de resultados que se mostrarán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1,000.
`page_token`	`string` Opcional. Un token de página, recibido desde una llamada `ListControls` anterior. Proporciona esto para recuperar la página siguiente.
`filter`	`string` Opcional. Es un filtro que se aplica a los resultados de la lista. Funciones admitidas Enumera todos los productos de la rama principal si `filter` no está configurado. Actualmente, este campo no es compatible.

ListControlsResponse

Es la respuesta del método ListControls.

Campos

controls[]

Control

Son todos los controles de un almacén de datos determinado.

next_page_token

string

Es el token de paginación. Si no se devuelve, indica la última página.

ListConversationsRequest

Es la solicitud para el método ListConversations.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Cantidad máxima de resultados que se mostrarán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1,000.
`page_token`	`string` Un token de página, recibido desde una llamada `ListConversations` anterior. Proporciona esto para recuperar la página siguiente.
`filter`	`string` Es un filtro que se aplica a los resultados de la lista. Las funciones admitidas son user_pseudo_id y state. Ejemplo: "user_pseudo_id = some_id"
`order_by`	`string` Es una lista de campos separados por comas según los cuales se ordenará el resultado, en orden ascendente. Usa "desc" después del nombre de un campo para el orden descendente. Campos admitidos: * `update_time` * `create_time` * `conversation_name` Ejemplo: "update_time desc" "create_time"

ListConversationsResponse

Es la respuesta del método ListConversations.

Campos

conversations[]

Son todas las conversaciones de un almacén de datos determinado.

next_page_token

string

Es el token de paginación. Si no se devuelve, indica la última página.

ListCustomModelsRequest

Mensaje de solicitud para el método SearchTuningService.ListCustomModels.

Campos

data_store

string

Obligatorio. Es el nombre del recurso del almacén de datos principal, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo se usa para identificar el almacén de datos desde el que se recuperarán los modelos.

ListCustomModelsResponse

Mensaje de respuesta para el método SearchTuningService.ListCustomModels.

Campos

models[]

CustomTuningModel

Es la lista de modelos con ajustes personalizados.

ListDataStoresRequest

Mensaje de solicitud para el método DataStoreService.ListDataStores.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso de la rama principal, como `projects/{project}/locations/{location}/collections/{collection_id}`. Si el llamador no tiene permiso para enumerar los `DataStore`s en esta ubicación, independientemente de si existe o no este almacén de datos, se devuelve un error PERMISSION_DENIED.
`page_size`	`int32` Cantidad máxima de `DataStore`s que se devolverán. Si no se especifica, el valor predeterminado es 10. El valor máximo permitido es 50. Los valores superiores a 50 se convertirán a 50. Si este campo es negativo, se devuelve un INVALID_ARGUMENT.
`page_token`	`string` Un token de página `ListDataStoresResponse.next_page_token`, recibido desde una llamada a `DataStoreService.ListDataStores` anterior. Proporciona esto para recuperar la página siguiente. Cuando se pagina, todos los demás parámetros proporcionados a `DataStoreService.ListDataStores` deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se muestra un error INVALID_ARGUMENT.
`filter`	`string` Filtra por tipo de solución . Por ejemplo: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Mensaje de respuesta para el método DataStoreService.ListDataStores.

Campos

data_stores[]

DataStore

Todos los DataStore del cliente.

next_page_token

string

Es un token que se puede enviar como ListDataStoresRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListDocumentsRequest

Mensaje de solicitud para el método DocumentService.ListDocuments.

Campos

parent

string

Obligatorio. Es el nombre del recurso de la rama principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Usa default_branch como el ID de la rama para enumerar los documentos en la rama predeterminada.

Si el emisor no tiene permiso para enumerar los Documents en esta rama, independientemente de si esta rama existe o no, se devuelve un error PERMISSION_DENIED.

page_size

int32

Cantidad máxima de Documents que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000. Los valores superiores a 1,000 se establecen en 1,000.

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.

page_token

string

Un token de página ListDocumentsResponse.next_page_token, recibido desde una llamada a DocumentService.ListDocuments anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a DocumentService.ListDocuments deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se muestra un error INVALID_ARGUMENT.

ListDocumentsResponse

Mensaje de respuesta para el método DocumentService.ListDocuments.

Campos

documents[]

Los Document.

next_page_token

string

Es un token que se puede enviar como ListDocumentsRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListEnginesRequest

Mensaje de solicitud para el método EngineService.ListEngines.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso principal, como `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Opcional. No compatible.
`page_token`	`string` Opcional. No compatible.
`filter`	`string` Opcional. Filtra por tipo de solución. Por ejemplo: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Mensaje de respuesta para el método EngineService.ListEngines.

Campos

engines[]

Engine

Todos los Engine del cliente.

next_page_token

string

No compatible.

ListIdentityMappingStoresRequest

Mensaje de solicitud para IdentityMappingStoreService.ListIdentityMappingStores

Campos

parent

string

Obligatorio. Es el elemento superior de los almacenes de asignación de identidades que se incluirán en la lista. Formato: projects/{project}/locations/{location}.

page_size

int32

Es la cantidad máxima de IdentityMappingStores que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1,000. Los valores superiores a 1,000 se convertirán a 1,000.

page_token

string

Un token de página, recibido desde una llamada ListIdentityMappingStores anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListIdentityMappingStores deben coincidir con la llamada que proporcionó el token de la página.

ListIdentityMappingStoresResponse

Mensaje de respuesta para IdentityMappingStoreService.ListIdentityMappingStores

Campos

identity_mapping_stores[]

IdentityMappingStore

Son los almacenes de asignación de identidad.

next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListIdentityMappingsRequest

Mensaje de solicitud para IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_store

string

Obligatorio. Nombre del almacén de asignación de identidades en el que se enumerarán las entradas de asignación de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

page_size

int32

Es la cantidad máxima de IdentityMappings que se devolverán. Si no se especifica, el valor predeterminado es 2,000. El valor máximo permitido es 10,000. Los valores superiores a 10,000 se convertirán a 10,000.

page_token

string

Un token de página, recibido desde una llamada ListIdentityMappings anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListIdentityMappings deben coincidir con la llamada que proporcionó el token de la página.

ListIdentityMappingsResponse

Mensaje de respuesta para IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_entries[]

IdentityMappingEntry

Son las entradas de asignación de identidad.

next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListSchemasRequest

Mensaje de solicitud para el método SchemaService.ListSchemas.

Campos

parent

string

Obligatorio. Es el nombre del recurso de almacén de datos principal, en el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

Es la cantidad máxima de Schema que se devolverán. El servicio puede mostrar menos que este valor.

Si no se especifica, se devolverán, como máximo, 100 Schemas.

El valor máximo es 1,000, y los valores superiores se establecen en 1,000.

page_token

string

Un token de página, recibido desde una llamada SchemaService.ListSchemas anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a SchemaService.ListSchemas deben coincidir con la llamada que proporcionó el token de la página.

ListSchemasResponse

Mensaje de respuesta para el método SchemaService.ListSchemas.

Campos

schemas[]

Schema

Los Schema.

next_page_token

string

Es un token que se puede enviar como ListSchemasRequest.page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

ListSessionsRequest

Es la solicitud para el método ListSessions.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Cantidad máxima de resultados que se mostrarán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1,000.
`page_token`	`string` Un token de página, recibido desde una llamada `ListSessions` anterior. Proporciona esto para recuperar la página siguiente.
`filter`	`string` Lista de campos separados por comas según los cuales se filtrará, en la gramática de EBNF. Los campos admitidos son los siguientes: `user_pseudo_id` `state` `display_name` `starred` `is_pinned` `labels` `create_time` `update_time` Ejemplos: `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` Es una lista de campos separados por comas según los cuales se ordenará el resultado, en orden ascendente. Usa "desc" después del nombre de un campo para el orden descendente. Campos admitidos: `update_time` `create_time` `session_name` `is_pinned` Ejemplo: `update_time desc` `create_time` `is_pinned desc,update_time desc`: Enumera las sesiones primero por is_pinned y, luego, por update_time.

ListSessionsResponse

Es la respuesta para el método ListSessions.

Campos

sessions[]

Son todas las sesiones de un almacén de datos determinado.

next_page_token

string

Es el token de paginación. Si no se devuelve, indica la última página.

ListTargetSitesRequest

Mensaje de solicitud para el método SiteSearchEngineService.ListTargetSites.

Campos

parent

string

Obligatorio. Es el nombre del recurso del motor de búsqueda del sitio principal, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

Si el llamador no tiene permiso para enumerar los TargetSites en este motor de búsqueda del sitio, independientemente de si existe o no esta rama, se devuelve un error PERMISSION_DENIED.

page_size

int32

Si este campo es negativo, se muestra un error INVALID_ARGUMENT.

page_token

string

Un token de página, recibido desde una llamada ListTargetSites anterior. Proporciona esto para recuperar la página siguiente.

Cuando se pagina, todos los demás parámetros proporcionados a ListTargetSites deben coincidir con la llamada que proporcionó el token de la página.

ListTargetSitesResponse

Mensaje de respuesta para el método SiteSearchEngineService.ListTargetSites.

Campos

target_sites[]

Es la lista de TargetSites.

next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

total_size

int32

Es la cantidad total de elementos que coinciden con la solicitud. Este campo siempre se propagará en la respuesta.

ListUserLicensesRequest

Mensaje de solicitud para UserLicenseService.ListUserLicenses.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso [UserStore][] principal, con el formato `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Opcional. Indica el tamaño de la página solicitada. Es posible que el servidor devuelva menos elementos de los que se solicitaron. Si no se especifica, el valor predeterminado es 10. El valor máximo es 50, y los valores superiores se convertirán a 50. Si este campo es negativo, se muestra un error INVALID_ARGUMENT.
`page_token`	`string` Opcional. Un token de página, recibido desde una llamada `ListUserLicenses` anterior. Proporciona esto para recuperar la página siguiente. Cuando se pagina, todos los demás parámetros proporcionados a `ListUserLicenses` deben coincidir con la llamada que proporcionó el token de la página.
`filter`	`string` Opcional. Es el filtro de la solicitud de lista. Campos admitidos: `license_assignment_state` Ejemplos: `license_assignment_state = ASSIGNED` para enumerar las licencias de usuario asignadas `license_assignment_state = NO_LICENSE` para enumerar los usuarios sin licencia. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` para enumerar los usuarios que intentaron acceder, pero no tienen una licencia asignada. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` para filtrar a los usuarios que intentaron acceder, pero no tienen una licencia asignada.

ListUserLicensesResponse

Mensaje de respuesta para UserLicenseService.ListUserLicenses.

Campos

user_licenses[]

UserLicense

Todos los UserLicense del cliente.

next_page_token

string

Un token, que se puede enviar como page_token para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

MediaInfo

Es información de eventos de usuarios específica de los medios.

Campos

media_progress_duration

Duration

Es el tiempo de progreso del contenido multimedia en segundos, si corresponde. Por ejemplo, si el usuario final terminó de mirar 90 segundos de un video de reproducción, MediaInfo.media_progress_duration.seconds debe establecerse en 90.

media_progress_percentage

float

El progreso de los medios solo se debe calcular con el valor de media_progress_duration en relación con la duración total del contenido multimedia.

Este valor debe ser mayor o igual que [0, 1.0].

Si no se trata de una reproducción o no se puede calcular el progreso (p.ej., una transmisión en vivo en curso), este campo debe quedar sin configurar.

PageInfo

Información detallada de la página

Campos
`pageview_id`	`string` Es el ID único de una vista de página web. Este valor debe ser el mismo para todos los eventos del usuario que se activen desde la misma vista de página. Por ejemplo, la vista de una página de detalles del artículo podría activar varios eventos mientras el usuario navega por la página. La propiedad `pageview_id` debe ser la misma para todos estos eventos, de modo que se puedan agrupar correctamente. Cuando se utiliza el registro de eventos del cliente con JavaScript Pixel y Google Tag Manager, este valor se completa automáticamente.
`page_category`	`string` Es la categoría más específica asociada a una página de categoría. Para representar la ruta de acceso completa de la categoría, usa el signo ">" para separar las diferentes jerarquías. Si ">" forma parte del nombre de la categoría, reemplázalo por otros caracteres. Las páginas de categorías incluyen páginas especiales, como las de ofertas o promociones. Por ejemplo, una página de ofertas especiales puede tener la siguiente jerarquía de categorías: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Obligatorio para los eventos de `view-category-page`. Otros tipos de eventos no deben establecer este campo. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`uri`	`string` Es la URL completa (window.location.href) de la página actual del usuario. Cuando se utiliza el registro de eventos del cliente con JavaScript Pixel y Google Tag Manager, este valor se completa automáticamente. La longitud máxima es de 5,000 caracteres.
`referrer_uri`	`string` Es la URL de referencia de la página actual. Cuando se utiliza el registro de eventos del cliente con JavaScript Pixel y Google Tag Manager, este valor se completa automáticamente. Sin embargo, algunas restricciones de privacidad del navegador pueden hacer que este campo esté vacío.

PanelInfo

Es la información detallada del panel asociada a un evento del usuario.

Campos
`panel_id`	`string` Obligatorio. Es el ID del panel.
`display_name`	`string` Es el nombre visible del panel.
`documents[]`	`DocumentInfo` Opcional. Son los IDs de los documentos asociados con este panel.
`panel_position`	`int32` Es la posición ordenada del panel, si se muestra al usuario con otros paneles. Si se establece, también se debe establecer `total_panels`.
`total_panels`	`int32` Es la cantidad total de paneles, incluido este, que se muestran al usuario. Se debe establecer si se configura `panel_position`.

Principal

Es el identificador principal de un usuario o un grupo.

Campos
Campo de unión `principal`. Es el campo de unión principal. La principal puede ser un usuario o un grupo. `principal` puede ser solo uno de los siguientes:
`user_id`	`string` Es el identificador del usuario. En el caso de las cuentas de usuario de Google Workspace, user_id debe ser el correo electrónico del usuario de Google Workspace. En el caso de la cuenta de usuario del proveedor de identidad que no es de Google, user_id es el identificador de usuario asignado que se configuró durante la configuración de workforcepool.
`group_id`	`string` Es el identificador del grupo. En el caso de las cuentas de usuario de Google Workspace, group_id debe ser el correo electrónico del grupo de Google Workspace. Para las cuentas de usuario de proveedores de identidad que no son de Google, group_id es el identificador de grupo asignado que se configuró durante la configuración de workforcepool.
`external_entity_id`	`string` Para identidades de aplicaciones de terceros que no están presentes en el proveedor de identidad del cliente.

Proyecto

Son los metadatos y la configuración de un proyecto de Google Cloud en el servicio.

Campos
`name`	`string` Solo salida. Nombre completo del recurso del proyecto, por ejemplo, `projects/{project}`. Ten en cuenta que, cuando realices solicitudes, se aceptarán tanto el número como el ID del proyecto, pero el servidor siempre responderá con el número del proyecto.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo de la creación de este proyecto.
`provision_completion_time`	`Timestamp` Solo salida. Es la marca de tiempo en la que se aprovisionó correctamente este proyecto. Un valor vacío significa que este proyecto aún se está aprovisionando y no está listo para usarse.
`service_terms_map`	`map<string, ServiceTerms>` Solo salida. Es un mapa de las condiciones del servicio. La clave es el `id` de `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Opcional. Son los parámetros de configuración que proporciona el cliente.

CustomerProvidedConfig

Son los parámetros de configuración que proporciona el cliente.

Campos

notebooklm_config

NotebooklmConfig

Opcional. Es la configuración de los parámetros de NotebookLM.

NotebooklmConfig

Es la configuración de NotebookLM.

Campos

model_armor_config

ModelArmorConfig

Es la configuración de Model Armor que se usará para limpiar las instrucciones del usuario y las respuestas del LLM.

ModelArmorConfig

Es la configuración de las plantillas de Model Armor definidas por el cliente que se usarán para limpiar las instrucciones del usuario y las respuestas del LLM.

Campos

user_prompt_template

string

Opcional. Es el nombre del recurso de la plantilla de Model Armor para sanear las instrucciones del usuario. Formato: projects/{project}/locations/{location}/templates/{template_id}. Si no se especifica, no se aplicará ninguna limpieza a la instrucción del usuario.

response_template

string

Opcional. Es el nombre del recurso de la plantilla de Model Armor para sanear las respuestas del LLM. Formato: projects/{project}/locations/{location}/templates/{template_id}. Si no se especifica, no se aplicará ninguna limpieza a la respuesta del LLM.

ServiceTerms

Son metadatos sobre las Condiciones del Servicio.

Campos
`id`	`string` Es el identificador único de estas condiciones del servicio. Condiciones disponibles: `GA_DATA_USE_TERMS`: Condiciones para el uso de datos Cuando se usa como `id`, el `version` aceptable que se debe proporcionar es `2022-11-23`.
`version`	`string` Es la cadena de versión de las Condiciones del Servicio. Para obtener valores aceptables, consulta los comentarios de `id` más arriba.
`state`	`State` Indica si el proyecto aceptó o rechazó las condiciones del servicio, o si aún están pendientes.
`accept_time`	`Timestamp` Fecha y hora en que el proyecto aceptó las condiciones del servicio por última vez.
`decline_time`	`Timestamp` Fecha y hora en que el proyecto rechazó o revocó el acuerdo de las condiciones del servicio por última vez.

Estado

El acuerdo establece estas condiciones del servicio.

Enums
`STATE_UNSPECIFIED`	Es el valor predeterminado de la enumeración. En realidad, este valor no se usa.
`TERMS_ACCEPTED`	El proyecto otorgó su consentimiento a las condiciones del servicio.
`TERMS_PENDING`	El proyecto está pendiente de revisión y aceptación de las condiciones del servicio.
`TERMS_DECLINED`	El proyecto rechazó o revocó el acuerdo de las condiciones del servicio.

ProvisionProjectMetadata

Este tipo no tiene campos.

Son los metadatos asociados con una operación de aprovisionamiento de un proyecto.

ProvisionProjectRequest

Es la solicitud para el método ProjectService.ProvisionProject.

Campos
`name`	`string` Obligatorio. Es el nombre completo del recurso de un `Project`, como `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Obligatorio. Se establece en `true` para especificar que el llamador leyó las Condiciones de uso de los datos y desea dar su consentimiento para ellas.
`data_use_terms_version`	`string` Obligatorio. Es la versión de las Condiciones de uso de los datos que leyó el llamador y a las que desea dar su consentimiento. La versión aceptable es `2022-11-23`, y puede cambiar con el tiempo.
`saas_params`	`SaasParams` Opcional. Son los parámetros de Agentspace.

SaasParams

Son los parámetros de Agentspace.

Campos

accept_biz_qos

bool

Opcional. Se establece en true para especificar que el llamador leyó y desea dar su consentimiento para las [Condiciones de calidad del servicio de Agent Space].

is_biz

bool

Opcional. Indica si la solicitud actual es para la edición de Biz (= true) o no (= false).

PurgeCompletionSuggestionsMetadata

Son los metadatos relacionados con el progreso de la operación PurgeCompletionSuggestions. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

PurgeCompletionSuggestionsRequest

Mensaje de solicitud para el método CompletionService.PurgeCompletionSuggestions.

Campos

parent

string

Obligatorio. Es el nombre del recurso del almacén de datos principal para el que se borrarán las sugerencias de autocompletado. Sigue el patrón projects/*/locations/*/collections/*/dataStores/*.

PurgeCompletionSuggestionsResponse

Mensaje de respuesta para el método CompletionService.PurgeCompletionSuggestions.

Campos

purge_succeeded

bool

Indica si las sugerencias de completado se borraron correctamente.

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

PurgeDocumentsMetadata

Son metadatos relacionados con el progreso de la operación PurgeDocuments. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es el recuento de las entradas que se borraron correctamente.
`failure_count`	`int64` Es el recuento de las entradas que tuvieron errores durante el procesamiento.
`ignored_count`	`int64` Es el recuento de las entradas que se ignoraron porque no se encontraron.

PurgeDocumentsRequest

Mensaje de solicitud para el método DocumentService.PurgeDocuments.

Campos
`parent`	`string` Obligatorio. Es el nombre del recurso principal, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Obligatorio. Filtra los documentos coincidentes que se borrarán definitivamente. Por el momento, el único valor admitido es `*` (todos los elementos).
`error_config`	`PurgeErrorConfig` Es la ubicación deseada de los errores que se produjeron durante la purga.
`force`	`bool` Realiza la eliminación definitiva. Si `force` se establece como falso, devuelve el recuento de eliminación definitiva previsto sin borrar ningún documento.
Campo de unión `source`. Es la fuente de entrada deseada para purgar documentos según los IDs de documentos. `source` puede ser solo uno de los siguientes:
`gcs_source`	`GcsSource` Ubicación de Cloud Storage para el contenido de entrada. `data_schema` admitidos: * `document_id`: Un `Document.id` válido por línea.
`inline_source`	`InlineSource` Es la fuente intercalada del contenido de entrada para la eliminación.

InlineSource

Es la fuente intercalada para la configuración de entrada del método DocumentService.PurgeDocuments.

Campos

documents[]

string

Obligatorio. Es una lista de los nombres completos de los recursos de los documentos que se borrarán. En el formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Se recomienda un máximo de 100 elementos.

PurgeDocumentsResponse

Mensaje de respuesta para el método DocumentService.PurgeDocuments. Si la operación de larga duración se realiza correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos

purge_count

int64

Es el recuento total de documentos purgados como resultado de la operación.

purge_sample[]

string

Es una muestra de los nombres de los documentos que se borrarán. Solo se propaga si force se establece como falso. Se devolverá un máximo de 100 nombres, que se elegirán de forma aleatoria.

PurgeErrorConfig

Es la configuración del destino para los errores relacionados con la eliminación.

Campos

Campo de unión destination. Obligatorio. Es el destino de los errores. destination puede ser solo uno de los siguientes:

gcs_prefix

string

Es el prefijo de Cloud Storage para los errores de purga. Debe ser un directorio de Cloud Storage existente y vacío. Los errores de eliminación se escriben en archivos fragmentados en este directorio, uno por línea, como un mensaje google.rpc.Status codificado en JSON.

PurgeIdentityMappingsRequest

Mensaje de solicitud para IdentityMappingStoreService.PurgeIdentityMappings

Campos
`identity_mapping_store`	`string` Obligatorio. Nombre del almacén de asignación de identidades del que se borrarán las entradas de asignación de identidades. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Filtra las asignaciones de identidad coincidentes que se deben purgar. El campo apto para filtrar es * `update_time`: En formato ISO 8601 “zulu” * `external_id` Ejemplos: Borra todas las asignaciones de identidad actualizadas en un período: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Borra todas las asignaciones de identidad para un external_id determinado: `external_id = "id1"` Borra todas las asignaciones de identidad dentro de un almacén de asignaciones de identidad: `*` Se supone que los campos de filtrado tienen un AND implícito. No se debe usar con la fuente. Si se proporcionan ambos, se arrojará un error.
Campo de unión `source`. Es la fuente de la entrada. `source` puede ser solo uno de los siguientes:
`inline_source`	`InlineSource` Es la fuente intercalada desde la que se borrarán las entradas de asignación de identidad.
`force`	`bool` Realiza la eliminación definitiva. Si `force` se establece como falso, devuelve el recuento de eliminación definitiva previsto sin borrar ninguna asignación de identidad. Este campo solo se admite para la eliminación con filtro. Para la fuente de entrada, este campo se ignora y los datos se borrarán independientemente del valor de este campo.

InlineSource

Es la fuente intercalada desde la que se borrarán las entradas de asignación de identidad.

Campos

identity_mapping_entries[]

IdentityMappingEntry

Se puede purgar un máximo de 10,000 entradas a la vez.

PurgeSuggestionDenyListEntriesMetadata

Son metadatos relacionados con el progreso de la operación PurgeSuggestionDenyListEntries. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

PurgeSuggestionDenyListEntriesRequest

Mensaje de solicitud para el método CompletionService.PurgeSuggestionDenyListEntries.

Campos

parent

string

Obligatorio. Es el nombre del recurso del almacén de datos principal para el que se importarán las entradas de la lista de bloqueo. Sigue el patrón projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Mensaje de respuesta para el método CompletionService.PurgeSuggestionDenyListEntries.

Campos

purge_count

int64

Es la cantidad de entradas de la lista de bloqueo de sugerencias que se borraron definitivamente.

error_samples[]

Es una muestra de los errores que se encontraron durante el procesamiento de la solicitud.

PurgeUserEventsMetadata

Son los metadatos relacionados con el progreso de la operación PurgeUserEvents. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`success_count`	`int64` Es el recuento de las entradas que se borraron correctamente.
`failure_count`	`int64` Es el recuento de las entradas que tuvieron errores durante el procesamiento.

PurgeUserEventsRequest

Es el mensaje de solicitud para el método PurgeUserEvents.

Campos

parent

string

Obligatorio. Es el nombre del recurso del catálogo en el que se crean los eventos. El formato es projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}.

filter

string

Obligatorio. Es la cadena de filtro para especificar los eventos que se borrarán, con un límite de 5,000 caracteres. Estos son los campos aptos para filtrar:

eventType: Cadena UserEvent.event_type entre comillas dobles.
eventTime: En formato ISO 8601 “zulu”.
userPseudoId: Cadena entre comillas dobles. Si especificas esto, se borrarán todos los eventos asociados con un visitante.
userId: Cadena entre comillas dobles. Si especificas esto, se borrarán todos los eventos asociados con un usuario.

Nota: Esta API solo admite la purga de un rango máximo de 30 días.

Ejemplos:

Cómo borrar todos los eventos en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Borra un eventType específico en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Borra todos los eventos de un visitante específico en un período: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Borra los eventos de los últimos 30 días dentro de un DataStore: *

Se supone que los campos de filtrado tienen un AND implícito.

force

bool

Actualmente, no se admite el campo force. Las solicitudes de borrado definitivo de eventos de usuario borrarán de forma permanente todos los eventos que se puedan borrar definitivamente. Una vez que se complete el desarrollo, si force se establece como falso, el método devolverá el recuento de eliminación previsto sin borrar los eventos del usuario. Si no se incluye en la solicitud, el valor predeterminado de este campo será falso.

PurgeUserEventsResponse

Es la respuesta de PurgeUserEventsRequest. Si la operación de larga duración se realiza correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos

purge_count

int64

Es el recuento total de eventos que se borraron como resultado de la operación.

Consulta

Define una búsqueda ingresada por el usuario.

Campos

query_id

string

Solo salida. Es el ID único de la búsqueda.

Campo de unión content. Contenido de la búsqueda. content puede ser solo uno de los siguientes:

text

string

Texto sin formato

RankRequest

Mensaje de solicitud para el método RankService.Rank.

Campos
`ranking_config`	`string` Obligatorio. Es el nombre del recurso de la configuración del servicio de clasificación, como `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` Es el identificador del modelo que se usará. Puede ser uno de los siguientes: `semantic-ranker-512@latest`: Es el modelo de clasificación semántica con un tamaño máximo de tokens de entrada de 512. Si no se especifica, el valor predeterminado es `semantic-ranker-512@latest`.
`top_n`	`int32` Es la cantidad de resultados que se devolverán. Si no se configura o no es mayor que cero, se devuelven todos los resultados.
`query`	`string` Es la consulta que se usará.
`records[]`	`RankingRecord` Obligatorio. Es una lista de registros que se deben clasificar.
`ignore_record_details_in_response`	`bool` Si es verdadero, la respuesta solo contendrá el ID y la puntuación del registro. De forma predeterminada, es falso, y la respuesta contendrá detalles del registro.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Google Cloud Document para obtener más detalles.

RankResponse

Mensaje de respuesta para el método RankService.Rank.

Campos

records[]

RankingRecord

Es una lista de registros ordenados por puntuación descendente.

RankingRecord

Mensaje de registro para el método RankService.Rank.

Campos
`id`	`string` Es el ID único que representa el registro.
`title`	`string` Es el título del registro. Está vacío de forma predeterminada. Se debe configurar al menos uno de los valores `title` o `content`; de lo contrario, se arrojará un error INVALID_ARGUMENT.
`content`	`string` Es el contenido del registro. Está vacío de forma predeterminada. Se debe configurar al menos uno de los valores `title` o `content`; de lo contrario, se arrojará un error INVALID_ARGUMENT.
`score`	`float` Es la puntuación de este registro según la búsqueda determinada y el modelo seleccionado. La puntuación se redondeará a 2 decimales. Si la puntuación se acerca a 0, se redondeará a 0.0001 para evitar que se muestre como no establecida.

RecommendRequest

Es el mensaje de solicitud para el método Recommend.

Campos
`serving_config`	`string` Obligatorio. Nombre completo del recurso de un `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/` o `projects//locations/global/collections//dataStores//servingConfigs/` Se crea una configuración de entrega predeterminada junto con la creación del motor de recomendaciones. El ID del motor se usa como el ID de la configuración de publicación predeterminada. Por ejemplo, para el motor `projects//locations/global/collections//engines/my-engine`, puedes usar `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` para tus solicitudes de `RecommendationService.Recommend`.
`user_event`	`UserEvent` Obligatorio. Es el contexto sobre el usuario, lo que está mirando y la acción que realizó para activar la solicitud de Recommend. Ten en cuenta que este detalle del evento del usuario no se incorporará a los registros de userEvent. Por lo tanto, se requiere una solicitud de escritura de userEvent independiente para el registro de eventos. No establezcas `UserEvent.user_pseudo_id` o `UserEvent.user_info.user_id` en el mismo ID fijo para diferentes usuarios. Si intentas recibir recomendaciones no personalizadas (no se recomienda, ya que puede afectar de forma negativa el rendimiento del modelo), establece `UserEvent.user_pseudo_id` en un ID único aleatorio y deja `UserEvent.user_info.user_id` sin configurar.
`page_size`	`int32` Cantidad máxima de resultados que se mostrarán. Establece esta propiedad en la cantidad de resultados de recomendaciones que se necesitan. Si es cero, el servicio elige un valor predeterminado razonable. El valor máximo permitido es 100. Los valores superiores a 100 se establecen en 100.
`filter`	`string` Es un filtro para restringir los resultados de la recomendación con un límite de longitud de 5,000 caracteres. Actualmente, solo se admiten expresiones de filtro en el atributo `filter_tags`. Ejemplos: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` Si `attributeFilteringSyntax` se establece como verdadero en el campo `params`, se esperan expresiones basadas en atributos en lugar de la sintaxis basada en etiquetas que se describió anteriormente. Ejemplos: (language: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie")) Si tu filtro bloquea todos los resultados, la API devolverá documentos populares genéricos (sin filtrar). Si solo quieres obtener resultados que coincidan estrictamente con los filtros, configura `strictFiltering` como `true` en `RecommendRequest.params` para recibir resultados vacíos. Ten en cuenta que la API nunca devuelve objetos `Document` con `storageStatus` como `EXPIRED` o `DELETED`, independientemente de las opciones de filtro.
`validate_only`	`bool` Usa el modo de solo validación para esta búsqueda de recomendaciones. Si se establece en `true`, se usa un modelo falso que devuelve IDs de documentos arbitrarios. Ten en cuenta que el modo de solo validación solo debe usarse para probar la API o si el modelo no está listo.
`params`	`map<string, Value>` Son parámetros adicionales específicos del dominio para las recomendaciones. Valores permitidos: `returnDocument`: Booleano. Si se establece en `true`, el objeto Document asociado se devuelve en `RecommendResponse.RecommendationResult.document`. `returnScore`: Booleano. Si se establece como verdadero, la puntuación de recomendación correspondiente a cada documento devuelto se establece en `RecommendResponse.RecommendationResult.metadata`. La puntuación proporcionada indica la probabilidad de una conversión de Documento en función del historial y el contexto del usuario. `strictFiltering`: Booleano. El valor predeterminado es verdadero. Si se establece en `false`, el servicio devuelve documentos populares genéricos (sin filtrar) en lugar de vacíos si el filtro bloquea todos los resultados de la recomendación. `diversityLevel`: Cadena. El valor predeterminado es vacío. Si se configura para que no esté vacío, debe ser uno de los siguientes: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Esto proporciona control a nivel de la solicitud y ajusta los resultados de las recomendaciones según la categoría del documento. `attributeFilteringSyntax`: Booleano. El valor predeterminado es falso. Si se establece como verdadero, el campo `filter` se interpreta según la nueva sintaxis basada en atributos.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Requisitos para las etiquetas para obtener más detalles.

RecommendResponse

Es el mensaje de respuesta para el método Recommend.

Campos
`results[]`	`RecommendationResult` Es una lista de documentos recomendados. El orden representa la clasificación (del documento más pertinente al menos pertinente).
`attribution_token`	`string` Es un token de atribución único. Esto se debe incluir en los registros de `UserEvent` que resulten de esta recomendación, lo que permite una atribución precisa del rendimiento del modelo de recomendación.
`missing_ids[]`	`string` Son los IDs de los documentos de la solicitud que faltaban en la rama predeterminada asociada con el ServingConfig solicitado.
`validate_only`	`bool` Es verdadero si se configuró `RecommendRequest.validate_only`.

RecommendationResult

RecommendationResult representa un resultado de recomendación genérico con metadatos asociados.

Campos

id

string

Es el ID de recurso del documento recomendado.

document

MatchHighlightingCondition

Se establece si returnDocument se configura como verdadero en RecommendRequest.params.

metadata

map<string, Value>

Son los metadatos o las anotaciones adicionales del documento.

Valores posibles:

score: Es la puntuación de la recomendación en valor doble. Se establece si returnScore se establece como verdadero en RecommendRequest.params.

RecrawlUrisMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.RecrawlUris. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Es la fecha y hora de creación de la operación.
`update_time`	`Timestamp` Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.
`invalid_uris[]`	`string` Son los URIs únicos de la solicitud que tienen un formato no válido. La muestra se limita a 1,000.
`invalid_uris_count`	`int32` Cantidad total de URIs únicos en la solicitud que tienen un formato no válido.
`noindex_uris[]`	`string` Son los URIs que no tienen una metaetiqueta de indexación. La muestra se limita a 1,000.
`noindex_uris_count`	`int32` Es la cantidad total de URIs que no tienen una metaetiqueta de indexación.
`uris_not_matching_target_sites[]`	`string` Los URIs únicos en la solicitud que no coinciden con ningún TargetSite en el DataStore, solo coinciden con los TargetSites que no se indexaron por completo o con un TargetSite con el tipo EXCLUDE. La muestra se limita a 1,000.
`uris_not_matching_target_sites_count`	`int32` Es la cantidad total de URIs que no coinciden con ningún TargetSite.
`valid_uris_count`	`int32` Es la cantidad total de URIs únicos en la solicitud que no se encuentran en invalid_uris.
`success_count`	`int32` Es la cantidad total de URIs que se rastrearon hasta el momento.
`pending_count`	`int32` Es la cantidad total de URIs que aún no se rastrearon.
`quota_exceeded_count`	`int32` Es la cantidad total de URIs que se rechazaron debido a que no había suficientes recursos de indexación.

RecrawlUrisRequest

Mensaje de solicitud para el método SiteSearchEngineService.RecrawlUris.

Campos

site_search_engine

string

Obligatorio. Nombre completo del recurso SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Obligatorio. Es la lista de URIs que se rastrearán. Se admiten hasta 10,000 URIs. De lo contrario, se arroja un error INVALID_ARGUMENT. Cada URI debe coincidir con al menos un TargetSite en site_search_engine.

site_credential

string

Opcional. Es el ID de credencial que se usará para el rastreo.

RecrawlUrisResponse

Mensaje de respuesta para el método SiteSearchEngineService.RecrawlUris.

Campos

failure_samples[]

FailureInfo

Son los detalles de una muestra de hasta 10 failed_uris.

failed_uris[]

string

Son los URIs que no se rastrearon antes de que finalizara el LRO.

FailureInfo

Son detalles sobre por qué no se pudo rastrear un URI en particular. Cada FailureInfo contiene un FailureReason por CorpusType.

Campos

uri

string

Es el URI que no se pudo rastrear.

failure_reasons[]

FailureReason

Es una lista de los motivos de falla por tipo de corpus (p.ej., computadora de escritorio, dispositivo móvil).

FailureReason

Son detalles sobre por qué falló el rastreo para un CorpusType en particular, p.ej., El rastreo para COMPUTADORAS y DISPOSITIVOS MÓVILES puede fallar por diferentes motivos.

Campos

corpus_type

CorpusType

DESKTOP, MOBILE o CORPUS_TYPE_UNSPECIFIED.

error_message

string

Es el motivo por el que no se rastreó el URI.

CorpusType

Es el tipo de corpus de la operación de rastreo fallida.

Enums
`CORPUS_TYPE_UNSPECIFIED`	Valor predeterminado.
`DESKTOP`	Indica un intento de rastreo para la versión de escritorio de una página.
`MOBILE`	Indica un intento de rastreo de la versión para dispositivos móviles de una página.

Responder

Define un mensaje de respuesta para el usuario.

Campos

summary

Summary

Resumen basado en los resultados de la búsqueda.

SafetyRating

Es la calificación de seguridad correspondiente al contenido generado.

Campos
`category`	`HarmCategory` Solo salida. Es la categoría de daño.
`probability`	`HarmProbability` Solo salida. Son los niveles de probabilidad de daños en el contenido.
`probability_score`	`float` Solo salida. Es la puntuación de probabilidad de daño.
`severity`	`HarmSeverity` Solo salida. Son los niveles de gravedad de los daños en el contenido.
`severity_score`	`float` Solo salida. Es la puntuación de gravedad del daño.
`blocked`	`bool` Solo salida. Indica si se filtró el contenido debido a esta clasificación.

HarmProbability

Son los niveles de probabilidad de daños en el contenido.

Enums
`HARM_PROBABILITY_UNSPECIFIED`	No se especifica la probabilidad de daño.
`NEGLIGIBLE`	Nivel de daño insignificante.
`LOW`	Nivel de daño bajo
`MEDIUM`	Nivel de daño medio
`HIGH`	Nivel de daño alto

HarmSeverity

Niveles de gravedad de daños.

Enums
`HARM_SEVERITY_UNSPECIFIED`	No se especifica la gravedad del daño.
`HARM_SEVERITY_NEGLIGIBLE`	Nivel de gravedad del daño insignificante.
`HARM_SEVERITY_LOW`	Nivel de gravedad de daño bajo.
`HARM_SEVERITY_MEDIUM`	Nivel medio de gravedad del daño.
`HARM_SEVERITY_HIGH`	Nivel de gravedad del daño alto

Esquema

Define la estructura y el diseño de un tipo de datos de documentos.

Campos
`name`	`string` Inmutable. Es el nombre completo del recurso del esquema, con el formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. Este campo debe ser una cadena codificada en UTF-8 con un límite de longitud de 1,024 caracteres.
Campo de unión `schema`. Es la representación del esquema. Se debe proporcionar `struct_schema` o `json_schema`. De lo contrario, se arrojará un error `INVALID_ARGUMENT`. `schema` puede ser solo una de las siguientes opciones:
`struct_schema`	`Struct` Es la representación estructurada del esquema.
`json_schema`	`string` Es la representación JSON del esquema.

SearchAddOn

Es un complemento que proporciona funcionalidad adicional para la búsqueda.

Enums
`SEARCH_ADD_ON_UNSPECIFIED`	Es el valor predeterminado cuando no se especifica el enum. No se puede usar.
`SEARCH_ADD_ON_LLM`	Complemento de modelo de lenguaje grande.

SearchInfo

Es información detallada sobre la búsqueda.

Campos

search_query

string

Es la búsqueda del usuario.

Consulta SearchRequest.query para obtener la definición.

El valor debe ser una cadena codificada en UTF-8 con un límite de 5,000 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.

Se requiere al menos uno de los parámetros search_query o PageInfo.page_category para los eventos search. Otros tipos de eventos no deben establecer este campo. De lo contrario, se muestra un error INVALID_ARGUMENT.

order_by

string

Es el orden en el que se muestran los productos, si corresponde.

Consulta SearchRequest.order_by para ver la definición y la sintaxis.

El valor debe ser una cadena codificada en UTF-8 con un límite de 1,000 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.

Solo se puede configurar para eventos search. Otros tipos de eventos no deben establecer este campo. De lo contrario, se muestra un error INVALID_ARGUMENT.

offset

int32

Es un número entero que especifica el desplazamiento actual para la paginación (la ubicación inicial indexada en 0, entre los productos que la API considera relevantes).

Consulta SearchRequest.offset para obtener la definición.

Si este campo es negativo, se devuelve un INVALID_ARGUMENT.

Solo se puede configurar para eventos search. Otros tipos de eventos no deben establecer este campo. De lo contrario, se muestra un error INVALID_ARGUMENT.

SearchLinkPromotion

El arquetipo de promoción incluye el URI y otra información útil para mostrar la promoción.

Campos
`title`	`string` Obligatorio. Es el título de la promoción. Longitud máxima: 160 caracteres.
`uri`	`string` Opcional. Es la URL de la página que el usuario desea promocionar. Se debe configurar para la búsqueda en el sitio. Para otras verticales, este campo es opcional.
`document`	`string` Opcional. Es el `Document` que el usuario quiere promocionar. Para la búsqueda en el sitio, deja este campo sin configurar y solo completa el URI. Se puede configurar junto con el URI.
`image_uri`	`string` Opcional. Es la URL de la imagen en miniatura de la promoción.
`description`	`string` Opcional. Es la descripción de la promoción. Longitud máxima: 200 caracteres.
`enabled`	`bool` Opcional. La promoción habilitada se devolverá para cualquier configuración de entrega asociada al elemento superior del control al que se adjunta esta promoción. Esta marca solo se usa para la búsqueda básica en el sitio.

SearchRequest

Mensaje de solicitud para el método SearchService.Search.

Campos
`serving_config`	`string` Obligatorio. Es el nombre del recurso de la configuración de entrega de la Búsqueda, como `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config` o `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. Este campo se usa para identificar el nombre de la configuración de entrega, el conjunto de modelos que se usan para realizar la búsqueda.
`branch`	`string` Nombre del recurso de la rama, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Usa `default_branch` como el ID de la rama o deja este campo vacío para buscar documentos en la rama predeterminada.
`query`	`string` Es la búsqueda sin procesar.
`image_query`	`ImageQuery` Es la búsqueda de imágenes sin procesar.
`page_size`	`int32` Cantidad máxima de `Document`s que se devolverán. El valor máximo permitido depende del tipo de datos. Los valores superiores al valor máximo se convierten al valor máximo. Sitios web con indexación básica: `10` predeterminado y `25` máximo. Sitios web con indexación avanzada: Predeterminado `25`, Máximo `50`. Otro: El valor predeterminado es `50` y el máximo es `100`. Si este campo es negativo, se devuelve un `INVALID_ARGUMENT`.
`page_token`	`string` Es un token de página que se recibió de una llamada a `SearchService.Search` anterior. Proporciona esto para recuperar la página siguiente. Cuando se pagina, todos los demás parámetros proporcionados a `SearchService.Search` deben coincidir con la llamada que proporcionó el token de la página. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`offset`	`int32` Es un número entero con índice 0 que especifica la compensación actual (es decir, la ubicación del resultado inicial, entre los `Document`s que la API considera relevantes) en los resultados de la búsqueda. Este campo solo se tiene en cuenta si `page_token` no está configurado. Si este campo es negativo, se devuelve un `INVALID_ARGUMENT`. Un desfase grande puede limitarse a un umbral razonable.
`one_box_page_size`	`int32` Es la cantidad máxima de resultados que se devolverán para OneBox. Esto se aplica a cada tipo de OneBox de forma individual. La cantidad predeterminada es 10.
`data_store_specs[]`	`DataStoreSpec` Son especificaciones que definen los `DataStore`s específicos que se buscarán, junto con las configuraciones de esos almacenes de datos. Esto solo se considera para los `Engine`s con varios almacenes de datos. Para los motores con un solo almacén de datos, se deben usar las especificaciones directamente debajo de `SearchRequest`.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los documentos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas. Si este campo no se puede reconocer, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave del filtro del LHD a una propiedad clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios podría tener un campo "nombre" en su esquema. En este caso, el filtro se vería de la siguiente manera: filter --> name:'ANY("king kong")' Para obtener más información sobre los filtros, incluidos los operadores y la sintaxis de filtros, consulta Filtro.
`canonical_filter`	`string` Es el filtro predeterminado que se aplica cuando un usuario realiza una búsqueda sin marcar ningún filtro en la página de búsqueda. Es el filtro que se aplica a cada solicitud de búsqueda cuando se necesita una mejora de la calidad, como la búsqueda expandida. En el caso de que una búsqueda no tenga una cantidad suficiente de resultados, se usará este filtro para determinar si se habilita o no el flujo de búsqueda expandida. El filtro original se seguirá usando para la búsqueda expandida de la consulta. Se recomienda encarecidamente usar este campo para lograr una alta calidad de búsqueda. Para obtener más información sobre la sintaxis de los filtros, consulta `SearchRequest.filter`.
`order_by`	`string` Es el orden en que se muestran los documentos. Los documentos se pueden ordenar por un campo en un objeto `Document`. Déjalo sin configurar si se ordena por relevancia. La expresión `order_by` distingue mayúsculas de minúsculas. Para obtener más información sobre cómo ordenar los resultados de la búsqueda en el sitio web, consulta Cómo ordenar los resultados de la búsqueda web. Para obtener más información sobre el orden de los resultados de la búsqueda de atención médica, consulta Cómo ordenar los resultados de la búsqueda de atención médica. Si este campo no se puede reconocer, se devuelve un `INVALID_ARGUMENT`.
`user_info`	`UserInfo` Es la información sobre el usuario final. Se recomienda para las estadísticas y la personalización. `UserInfo.user_agent` se usa para deducir `device_type` para las estadísticas.
`language_code`	`string` El código de idioma BCP-47, como "en-US" o "sr-Latn". Para obtener más información, consulta Campos estándar. Este campo ayuda a interpretar mejor la búsqueda. Si no se especifica un valor, el código de idioma de la búsqueda se detecta automáticamente, lo que puede no ser preciso.
`facet_specs[]`	`FacetSpec` Son las especificaciones de facetas para la búsqueda por facetas. Si está vacío, no se devuelven facetas. Se permite un máximo de 100 valores. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`boost_spec`	`BoostSpec` Especificación de refuerzo para reforzar ciertos documentos. Para obtener más información sobre el aumento, consulta Aumento.
`params`	`map<string, Value>` Son parámetros de búsqueda adicionales. Solo para la búsqueda en sitios web públicos, los valores admitidos son los siguientes: `user_country_code`: cadena. El valor predeterminado es vacío. Si se establece como no vacío, los resultados se restringen o se potencian según la ubicación proporcionada. Por ejemplo, `user_country_code: "au"` Para ver los códigos disponibles, consulta Códigos de países. `search_type`: double. El valor predeterminado es vacío. Habilita la búsqueda que no es de páginas web según el valor. El único valor no predeterminado válido es 1, que habilita la búsqueda de imágenes. Por ejemplo, `search_type: 1`
`query_expansion_spec`	`QueryExpansionSpec` Es la especificación de búsqueda expandida que indica las condiciones en las que se produce la búsqueda expandida.
`spell_correction_spec`	`SpellCorrectionSpec` Es la especificación de corrección ortográfica que indica el modo en el que se aplica la corrección ortográfica.
`user_pseudo_id`	`string` Es un identificador único para hacer un seguimiento de los visitantes. Por ejemplo, esto se podría implementar con una cookie HTTP, que debería poder identificar de forma única a un visitante en un solo dispositivo. Este identificador único no debe cambiar si el visitante accede al sitio web o sale de él. Este campo NO debe tener un valor fijo, como `unknown_visitor`. Debe ser el mismo identificador que `UserEvent.user_pseudo_id` y `CompleteQueryRequest.user_pseudo_id`. El campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`content_search_spec`	`ContentSearchSpec` Es una especificación para configurar el comportamiento de la búsqueda de contenido.
`ranking_expression`	`string` Opcional. La expresión de clasificación controla la clasificación personalizada de los documentos recuperados. Esto anula `ServingConfig.ranking_expression`. La sintaxis y las funciones admitidas dependen del valor de `ranking_expression_backend`. Si no se proporciona `ranking_expression_backend`, el valor predeterminado es `RANK_BY_EMBEDDING`. Si no se proporciona `ranking_expression_backend` o se establece en `RANK_BY_EMBEDDING`, debe ser una sola función o varias funciones unidas por "+". ranking_expression = function, { " + ", function }; Funciones compatibles: double * relevance_score double * dotProduct(embedding_field_path) Variables de función: `relevance_score`: Son palabras clave predefinidas que se usan para medir la relevancia entre la búsqueda y el documento. `embedding_field_path`: Es el campo de incorporación de documentos que se usa con el vector de incorporación de la búsqueda. `dotProduct`: Es la función de embedding entre `embedding_field_path` y el vector de embedding de la búsqueda. Ejemplo de expresión de clasificación: Si el documento tiene un campo de incorporación doc_embedding, la expresión de clasificación podría ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. Si `ranking_expression_backend` se configura como `RANK_BY_FORMULA`, se admiten los siguientes tipos de expresiones (y combinaciones de esos tipos encadenados con los operadores + o ): `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)`: Es una transformación del rango recíproco en la que el segundo argumento es una constante del denominador. `is_nan(signal)`: Muestra 0 si el indicador es NaN y 1 en caso contrario. `fill_nan(signal1, signal2 \| double)`: Si signal1 es NaN, devuelve signal2 \| double; de lo contrario, devuelve signal1. A continuación, se muestran algunos ejemplos de fórmulas de clasificación que usan los tipos de expresiones de clasificación admitidos: `0.2 semantic_similarity_score + 0.8 * log(keyword_similarity_score)`: Principalmente, se clasifica según el logaritmo de `keyword_similarity_score` con un pequeño ajuste de `semantic_smilarity_score`. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)`: Clasifica según el exponente de `semantic_similarity_score` y completa el valor con 0 si es NaN. También agrega un ajuste constante de 0.3 a la puntuación final si `semantic_similarity_score` es NaN. `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)`: Principalmente, se clasifica según la clasificación recíproca de `keyword_similarity_score` con un pequeño ajuste de la clasificación recíproca de `semantic_smilarity_score`. Se admiten los siguientes indicadores: `semantic_similarity_score`: Ajuste de similitud semántica que se calcula con los embeddings generados por un modelo propietario de Google. Esta puntuación determina qué tan similar semánticamente es una búsqueda a un documento. `keyword_similarity_score`: El ajuste de la concordancia de palabras clave usa la función de clasificación Best Match 25 (BM25). Esta puntuación se calcula con un modelo probabilístico para estimar la probabilidad de que un documento sea pertinente para una búsqueda determinada. `relevance_score`: Ajuste de relevancia semántica que usa un modelo propietario de Google para determinar el significado y la intención detrás de la búsqueda de un usuario en el contexto del contenido de los documentos. `pctr_rank`: Ajuste del porcentaje de conversiones previsto como uso del ranking. El porcentaje de clics previsto (pCTR) se utiliza para medir la relevancia y el atractivo de un resultado de la búsqueda desde la perspectiva del usuario. Un pCTR más alto sugiere que es más probable que el resultado satisfaga la búsqueda y la intención del usuario, lo que lo convierte en un indicador valioso para la clasificación. `freshness_rank`: Ajuste de actualidad como un ranking `document_age`: Es el tiempo en horas transcurrido desde la última actualización del documento, un número de punto flotante (p.ej., 0.25 significa 15 minutos. `topicality_rank`: Ajuste de la actualidad como un ranking. Usa el modelo propietario de Google para determinar la superposición basada en palabras clave entre la búsqueda y el documento. `base_rank`: Es el rango predeterminado del resultado.
`ranking_expression_backend`	`RankingExpressionBackend` Opcional. Es el backend que se usará para la evaluación de la expresión de clasificación.
`safe_search`	`bool` Indica si se debe activar SafeSearch. Esta función solo se admite para la búsqueda en sitios web.
`user_labels`	`map<string, string>` Las etiquetas de usuario que se aplican a un recurso deben cumplir con los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta 64. Cada etiqueta debe ser un par clave-valor. Las claves deben tener una longitud mínima de 1 carácter y una longitud máxima de 63 caracteres, y no pueden estar vacías. Los valores pueden estar vacíos y su longitud máxima es de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, números, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se permiten los caracteres internacionales. La porción de clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave en varios recursos. Las claves deben comenzar con una letra en minúscula o un carácter internacional. Consulta Google Cloud Document para obtener más detalles.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Opcional. Es la configuración para las capacidades de comprensión de consultas de lenguaje natural, como la extracción de filtros de campos estructurados de la consulta. Consulta esta documentación para obtener más información. Si no se especifica `naturalLanguageQueryUnderstandingSpec`, no se realizará ninguna comprensión adicional de la búsqueda en lenguaje natural.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Configuración de la función de búsqueda mientras escribes. Solo se admite para la vertical de `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Opcional. Es la configuración de la función de visualización, como el resaltado de coincidencias en los resultados de la búsqueda.
`session`	`string` Es el nombre del recurso de sesión. Opcional. La sesión permite a los usuarios realizar varias llamadas a la API de /search o coordinar llamadas a la API de /search y llamadas a la API de /answer. Ejemplo 1 (llamadas a la API de /search de varios turnos): Llama a la API de /search con el ID de sesión generado en la primera llamada. Aquí, la búsqueda anterior se considera en la posición de la consulta. Es decir, si la primera búsqueda es "¿Cómo le fue a Alphabet en 2022?". y la búsqueda actual es "¿Qué tal 2023?", se interpretará como "¿Cómo le fue a Alphabet en 2023?". Ejemplo 2 (coordinación entre las llamadas a la API de /search y las llamadas a la API de /answer): Llama a la API de /answer con el ID de sesión generado en la primera llamada. Aquí, la generación de respuestas se produce en el contexto de los resultados de la búsqueda de la primera llamada de búsqueda. Actualmente, la función de búsqueda de turnos múltiples se encuentra en la etapa de disponibilidad general privada. Usa la versión v1alpha o v1beta antes de que lancemos esta función para la DG pública, o bien solicita que se agregue a la lista de entidades permitidas a través del equipo de Atención al cliente de Google.
`session_spec`	`SessionSpec` Es la especificación de la sesión. Solo se puede usar cuando se establece `session`.
`relevance_threshold`	`RelevanceThreshold` Es el umbral de relevancia de los resultados de la búsqueda. Se establece de forma predeterminada el umbral definido por Google, que aprovecha un equilibrio entre la precisión y la recuperación para ofrecer resultados muy precisos y una cobertura integral de la información pertinente. Esta función no es compatible con la búsqueda de atención médica.
`relevance_score_spec`	`RelevanceScoreSpec` Opcional. Es la especificación para devolver la puntuación de relevancia.

BoostSpec

Especificación de refuerzo para reforzar ciertos documentos.

Campos

condition_boost_specs[]

ConditionBoostSpec

Son las especificaciones de la mejora de la condición. Si un documento coincide con varias condiciones en las especificaciones, se aplican y combinan de forma no lineal todas las puntuaciones de refuerzo de estas especificaciones. La cantidad máxima de especificaciones es 20.

ConditionBoostSpec

El refuerzo se aplica a los documentos que cumplen con una condición.

Campos

condition

string

Es una expresión que especifica una condición de refuerzo. La sintaxis y los campos admitidos son los mismos que los de una expresión de filtro. Consulta SearchRequest.filter para obtener detalles sobre la sintaxis y las limitaciones.

Ejemplos:

Para potenciar los documentos con el ID "doc_1" o "doc_2", y el color "Rojo" o "Azul", usa (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")).

boost

float

Es la intensidad del boosting de condición, que debe estar en el rango [-1, 1]. El boosting negativo significa un descenso de nivel. El valor predeterminado es 0.0.

Si se establece en 1.0, el documento recibirá una gran promoción. Sin embargo, esto no significa necesariamente que el documento con boosting será el primer resultado siempre ni que se excluirán otros documentos. Es posible que se muestren resultados incluso si ninguno cumple la condición. Además, los resultados que son significativamente más relevantes para la búsqueda aún pueden tener prioridad sobre los documentos que prefieres, pero que son irrelevantes.

Si se establece en -1.0, el documento recibirá un gran descenso. Sin embargo, es posible que se sigan mostrando los resultados muy relevantes. El documento tendrá una batalla ascendente para obtener una clasificación bastante alta, pero no se bloqueará por completo.

Si se establece en 0.0, no se aplica ningún aumento. Se ignora la condición de refuerzo. Solo se establece una de las combinaciones (condición, refuerzo) o el objeto boost_control_spec que se muestra a continuación. Si se configuran ambos, se ignorará el refuerzo global y se aplicará el boost_control_spec más detallado.

boost_control_spec

BoostControlSpec

Es una especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente.

BoostControlSpec

Campos
`field_name`	`string` Nombre del campo cuyo valor se usará para determinar el importe del aumento.
`attribute_type`	`AttributeType` Es el tipo de atributo que se usará para determinar el importe del aumento. El valor del atributo se puede derivar del valor del campo del campo field_name especificado. En el caso de los valores numéricos, es sencillo, es decir, attribute_value = numerical_field_value. Sin embargo, en el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Es el tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
`control_points[]`	`ControlPoint` Son los puntos de control que se usan para definir la curva. La función monotónica (definida a través de interpolation_type más arriba) pasa por los puntos de control que se indican aquí.

AttributeType

Es el atributo(o la función) para el que se aplicará la clasificación personalizada.

Enums
`ATTRIBUTE_TYPE_UNSPECIFIED`	AttributeType no especificado.
`NUMERICAL`	El valor del campo numérico se usará para actualizar de forma dinámica el importe del aumento. En este caso, el attribute_value (el valor de X) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
`FRESHNESS`	En el caso de uso de la actualización, el valor del atributo será la duración entre la hora actual y la fecha especificada en el campo de fecha y hora. El valor debe tener el formato de un valor `dayTimeDuration` de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: `[nD][T[nH][nM][nS]]`. Por ejemplo, `5D`, `3DT12H30M`, `T24H`.

ControlPoint

Campos

attribute_value

string

Puede ser uno de los siguientes: 1. Es el valor del campo numérico. 2. Es la especificación de duración para la actualización. El valor debe tener el formato de un valor dayTimeDuration de XSD (un subconjunto restringido de un valor de duración ISO 8601). El patrón para esto es: [nD][T[nH][nM][nS]].

boost_amount

float

Es el valor entre -1 y 1 por el que se aumentará la puntuación si el atributo attribute_value se evalúa como el valor especificado anteriormente.

InterpolationType

Es el tipo de interpolación que se aplicará. El valor predeterminado será lineal (lineal por partes).

Enums
`INTERPOLATION_TYPE_UNSPECIFIED`	No se especificó el tipo de interpolación. En este caso, se establece de forma predeterminada en lineal.
`LINEAR`	Se aplicará la interpolación lineal por partes.

ContentSearchSpec

Es una especificación para configurar el comportamiento de la búsqueda de contenido.

Campos
`snippet_spec`	`SnippetSpec` Si no se especifica `snippetSpec`, los fragmentos no se incluirán en la respuesta de la búsqueda.
`summary_spec`	`SummarySpec` Si no se especifica `summarySpec`, los resúmenes no se incluyen en la respuesta de búsqueda.
`extractive_content_spec`	`ExtractiveContentSpec` Si no se proporciona ningún extractive_content_spec, no habrá respuesta extractiva en la respuesta de búsqueda.
`search_result_mode`	`SearchResultMode` Especifica el modo de resultado de la búsqueda. Si no se especifica, el modo de resultado de la búsqueda se establece de forma predeterminada como `DOCUMENTS`.
`chunk_spec`	`ChunkSpec` Especifica el objeto ChunkSpec que se devolverá en la respuesta de búsqueda. Solo está disponible si `SearchRequest.ContentSearchSpec.search_result_mode` se establece como `CHUNKS`.

ChunkSpec

Especifica el objeto ChunkSpec que se devolverá en la respuesta de búsqueda. Solo está disponible si SearchRequest.ContentSearchSpec.search_result_mode se establece como CHUNKS.

Campos

num_previous_chunks

int32

Es la cantidad de fragmentos anteriores del fragmento actual que se devolverán. El valor máximo permitido es 3. Si no se especifica, no se devolverán fragmentos anteriores.

num_next_chunks

int32

Es la cantidad de fragmentos siguientes que se devolverán del fragmento actual. El valor máximo permitido es 3. Si no se especifica, no se devolverán los próximos fragmentos.

ExtractiveContentSpec

Es una especificación para configurar el contenido extractivo en una respuesta de búsqueda.

Campos
`max_extractive_answer_count`	`int32` Es la cantidad máxima de respuestas extractivas que se muestran en cada resultado de la búsqueda. Una respuesta extractiva es una respuesta textual extraída del documento original, que proporciona una respuesta precisa y pertinente a nivel contextual para la búsqueda. Si la cantidad de respuestas coincidentes es menor que `max_extractive_answer_count`, devuelve todas las respuestas. De lo contrario, devuelve `max_extractive_answer_count`. Se devuelven como máximo cinco respuestas para cada `SearchResult`.
`max_extractive_segment_count`	`int32` Es la cantidad máxima de segmentos extractivos que se muestran en cada resultado de la búsqueda. Solo se aplica si `DataStore` se configura como `DataStore.ContentConfig.CONTENT_REQUIRED` o `DataStore.solution_types` es `SOLUTION_TYPE_CHAT`. Un segmento extractivo es un segmento de texto extraído del documento original que es pertinente para la búsqueda y, en general, más detallado que una respuesta extractiva. Luego, el segmento se podría usar como entrada para que los LLMs generen resúmenes y respuestas. Si la cantidad de segmentos coincidentes es menor que `max_extractive_segment_count`, se devuelven todos los segmentos. De lo contrario, devuelve `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Especifica si se debe devolver la puntuación de confianza de los segmentos extractivos en cada resultado de la búsqueda. Esta función solo está disponible para los almacenes de datos nuevos o incluidos en la lista de entidades permitidas. Para incluir tu almacén de datos en la lista de entidades permitidas, comunícate con tu ingeniero de atención al cliente. El valor predeterminado es `false`.
`num_previous_segments`	`int32` Especifica si también se debe incluir el tramo adyacente de cada segmento seleccionado. Devuelve un máximo de `num_previous_segments` segmentos antes de cada segmento seleccionado.
`num_next_segments`	`int32` Devuelve un máximo de `num_next_segments` segmentos después de cada segmento seleccionado.

SearchResultMode

Especifica el modo de resultado de la búsqueda. Si no se especifica, el modo de resultado de la búsqueda se establece de forma predeterminada como DOCUMENTS.

Enums
`SEARCH_RESULT_MODE_UNSPECIFIED`	Valor predeterminado.
`DOCUMENTS`	Devuelve documentos en el resultado de la búsqueda.
`CHUNKS`	Devuelve fragmentos en el resultado de la búsqueda. Solo está disponible si se especifica `DocumentProcessingConfig.chunking_config`.

SnippetSpec

Es una especificación para configurar fragmentos en una respuesta de búsqueda.

Campos

max_snippet_count
(deprecated)

int32

[OBSOLETO] Este campo ya no está disponible. Para controlar la devolución de fragmentos, usa el campo return_snippet. Para la retrocompatibilidad, mostraremos el fragmento si max_snippet_count > 0.

reference_only
(deprecated)

bool

[EN DESUSO] Este campo está en desuso y no tendrá ningún efecto en el fragmento.

return_snippet

bool

Si es true, devuelve el fragmento. Si no se puede generar ningún fragmento, devolvemos el mensaje "No hay fragmentos disponibles para esta página". También se devolverá un snippet_status con SUCCESS o NO_SNIPPET_AVAILABLE.

SummarySpec

Es una especificación para configurar un resumen que se muestra en una respuesta de búsqueda.

Campos
`summary_result_count`	`int32` Cantidad de resultados principales a partir de los que se generará el resumen. Si la cantidad de resultados que se muestran es menor que `summaryResultCount`, el resumen se genera a partir de todos los resultados. Se pueden usar hasta 10 resultados para el modo de documentos o 50 para el modo de fragmentos para generar un resumen. El modo de fragmentos se usa cuando `SearchRequest.ContentSearchSpec.search_result_mode` se establece en `CHUNKS`.
`include_citations`	`bool` Especifica si se deben incluir citas en el resumen. El valor predeterminado es `false`. Cuando este campo se establece en `true`, los resúmenes incluyen números de citas intercalados. Ejemplo de resumen con citas: BigQuery es el almacén de datos empresarial completamente administrado y sin servidores de Google Cloud [1]. BigQuery es compatible con todos los tipos de datos, funciona en todas las nubes y cuenta con inteligencia empresarial y aprendizaje automático integrados, todo en una plataforma unificada [2, 3]. Los números de cita hacen referencia a los resultados de la búsqueda devueltos y se indexan a partir del 1. Por ejemplo, [1] significa que la oración se atribuye al primer resultado de la búsqueda. [2, 3] significa que la oración se atribuye al segundo y al tercer resultado de la búsqueda.
`ignore_adversarial_query`	`bool` Especifica si se deben filtrar las búsquedas adversarias. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas adversarias. No se devuelve ningún resumen si la búsqueda se clasifica como una búsqueda adversarial. Por ejemplo, un usuario puede hacer una pregunta sobre comentarios negativos sobre la empresa o enviar una búsqueda diseñada para generar resultados inseguros que incumplan las políticas. Si este campo se establece en `true`, omitimos la generación de resúmenes para las búsquedas adversariales y, en su lugar, devolvemos mensajes de resguardo.
`ignore_non_summary_seeking_query`	`bool` Especifica si se deben filtrar las búsquedas que no buscan un resumen. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas que buscan resúmenes. No se devuelve ningún resumen si la búsqueda se clasifica como una búsqueda que no busca un resumen. Por ejemplo, `why is the sky blue` y `Who is the best soccer player in the world?` son búsquedas de resumen, pero `SFO airport` y `world cup 2026` no lo son. Es muy probable que sean búsquedas de navegación. Si este campo se establece en `true`, omitimos la generación de resúmenes para las búsquedas que no son de resumen y, en su lugar, devolvemos mensajes de resguardo.
`ignore_low_relevant_content`	`bool` Especifica si se deben filtrar las búsquedas que tienen baja relevancia. El valor predeterminado es `false`. Si este campo se establece en `false`, se usarán todos los resultados de la búsqueda, independientemente de su relevancia, para generar respuestas. Si se configura como `true`, solo las búsquedas con resultados de alta relevancia generarán respuestas.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica si se deben filtrar las preguntas que intentan evadir las restricciones. El valor predeterminado es `false`. Google emplea la clasificación de búsquedas para detectar las búsquedas que intentan eludir las restricciones. No se devuelve ningún resumen si la búsqueda se clasifica como una búsqueda de evasión de restricciones. Un usuario puede agregar instrucciones a la búsqueda para cambiar el tono, el estilo, el idioma o el contenido de la respuesta, o bien pedirle al modelo que actúe como una entidad diferente, p.ej., "Responde con el tono del CEO de una empresa de la competencia". Si este campo se establece en `true`, omitimos la generación de resúmenes para las búsquedas de evasión de restricciones y, en su lugar, devolvemos mensajes de resguardo.
`model_prompt_spec`	`ModelPromptSpec` Si se especifica, se usará la especificación para modificar la instrucción proporcionada al LLM.
`language_code`	`string` Es el código de idioma del resumen. Usa las etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental.
`model_spec`	`ModelSpec` Si se especifica, se usará la especificación para modificar la especificación del modelo proporcionada al LLM.
`use_semantic_chunks`	`bool` Si es verdadero, la respuesta se generará a partir de los fragmentos más relevantes de los principales resultados de la búsqueda. Esta función mejorará la calidad de los resúmenes. Ten en cuenta que, con esta función habilitada, no se hará referencia a todos los resultados de la búsqueda principales ni se incluirán en la lista de referencias, por lo que el índice de fuentes de citas solo apunta a los resultados de la búsqueda que se indican en la lista de referencias.

ModelPromptSpec

Es la especificación de la instrucción para usar con el modelo.

Campos

preamble

string

Es el texto al comienzo de la instrucción que le indica al asistente qué hacer. En la guía del usuario, se incluyen ejemplos.

ModelSpec

Es la especificación del modelo.

Campos

version

string

Es la versión del modelo que se usó para generar el resumen.

Los valores admitidos son los que se detallan a continuación:

stable: cadena. Es el valor predeterminado cuando no se especifica ningún valor. Usa un modelo ajustado disponible de forma general. Para obtener más información, consulta Versiones de modelos de generación de respuestas y ciclo de vida.
preview: cadena. (Versión preliminar pública) Usa un modelo de versión preliminar. Para obtener más información, consulta Versiones de modelos de generación de respuestas y ciclo de vida.

DataStoreSpec

Es una estructura para definir los almacenes de datos en los que se filtrará una llamada de búsqueda y las configuraciones de esos almacenes de datos. De lo contrario, se muestra un error INVALID_ARGUMENT.

Campos
`data_store`	`string` Obligatorio. Nombre completo del recurso `DataStore`, como `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. La ruta de acceso debe incluir el número del proyecto. No se admite el ID del proyecto en este campo.
`filter`	`string` Opcional. Especificación del filtro para filtrar documentos en el almacén de datos especificado por el campo data_store. Para obtener más información sobre el filtrado, consulta Filtrado.
`boost_spec`	`BoostSpec` Opcional. Especificación de refuerzo para reforzar ciertos documentos. Para obtener más información sobre el aumento, consulta Aumento.
`custom_search_operators`	`string` Opcional. Son operadores de búsqueda personalizados que, si se especifican, se usarán para filtrar los resultados de los almacenes de datos del espacio de trabajo. Para obtener más información sobre los operadores de búsqueda personalizados, consulta SearchOperators.

DisplaySpec

Especifica las funciones para mostrar, como el resaltado de coincidencias.

Campos

match_highlighting_condition

Condición en la que se debe destacar la coincidencia.

MatchHighlightingCondition

Es una enumeración que describe en qué condición se debe destacar la coincidencia.

Enums
`MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED`	El comportamiento del servidor es el mismo que el de `MATCH_HIGHLIGHTING_DISABLED`.
`MATCH_HIGHLIGHTING_DISABLED`	Inhabilita el resaltado de coincidencias en todos los documentos.
`MATCH_HIGHLIGHTING_ENABLED`	Habilita el resaltado de coincidencias en todos los documentos.

FacetSpec

Es una especificación de faceta para realizar una búsqueda por facetas.

Campos
`facet_key`	`FacetKey` Obligatorio. Es la especificación de la clave de faceta.
`limit`	`int32` Es la cantidad máxima de valores de faceta que se devuelven para esta faceta. Si no se especifica, el valor predeterminado es 20. El valor máximo permitido es 300. Los valores superiores a 300 se convertirán a 300. Para la agregación en la búsqueda de atención médica, cuando [FacetKey.key] es "healthcare_aggregation_key", el límite se anulará internamente a 10,000, independientemente del valor establecido aquí. Si este campo es negativo, se devuelve un `INVALID_ARGUMENT`.
`excluded_filter_keys[]`	`string` Es la lista de claves que se excluirán cuando se creen facetas. De forma predeterminada, `FacetKey.key` no se excluye del filtro, a menos que aparezca en este campo. Si se incluye una clave de faceta en este campo, sus valores pueden aparecer como resultados de faceta, incluso cuando se filtran de los resultados de la búsqueda. El uso de este campo no afecta los resultados de la búsqueda que se muestran. Por ejemplo, supongamos que hay 100 documentos con la faceta de color "Rojo" y 200 documentos con la faceta de color "Azul". Una búsqueda que contenga el filtro "color:ANY("Red")" y que tenga "color" como `FacetKey.key` de forma predeterminada solo mostrará los documentos "Rojos" en los resultados de la búsqueda y también mostrará "Rojo" con el recuento 100 como la única faceta de color. Si bien también hay documentos azules disponibles, "Azul" no se mostraría como un valor de faceta disponible. Si "color" aparece en "excludedFilterKeys", la búsqueda devuelve los valores de la faceta "Rojo" con el recuento 100 y "Azul" con el recuento 200, ya que la clave "color" ahora se excluye del filtro. Dado que este campo no afecta los resultados de la búsqueda, estos se filtran correctamente para mostrar solo los documentos "rojos". Se permite un máximo de 100 valores. De lo contrario, se muestra un error `INVALID_ARGUMENT`.
`enable_dynamic_position`	`bool` Habilita la posición dinámica para esta faceta. Si se establece como verdadero, la posición de esta faceta entre todas las facetas de la respuesta se determina automáticamente. Si las facetas dinámicas están habilitadas, se ordenan juntas. Si se establece como falso, la posición de esta faceta en la respuesta es la misma que en la solicitud, y se clasifica antes que las facetas con posición dinámica habilitada y todas las facetas dinámicas. Por ejemplo, es posible que siempre desees que se muestre la faceta de clasificación en la respuesta, pero no es necesario que siempre se muestre en la parte superior. En ese caso, puedes establecer enable_dynamic_position como verdadero para que la posición de la faceta de calificación en la respuesta se determine automáticamente. Otro ejemplo, suponiendo que tienes los siguientes facets en la solicitud: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false También tienes habilitadas las facetas dinámicas, que generan una faceta `gender`. Luego, el orden final de las facetas en la respuesta puede ser ("precio", "marcas", "calificación", "género") o ("precio", "marcas", "género", "calificación"), según cómo la API ordene las facetas "género" y "calificación". Sin embargo, observa que "price" y "brands" siempre se clasifican en la primera y segunda posición porque su enable_dynamic_position es falso.

FacetKey

Especifica cómo se calcula una faceta.

Campos
`key`	`string` Obligatorio. Son las claves de facetas textuales y numéricas admitidas en el objeto `Document`, para las que se calculan los valores de facetas. La clave de faceta distingue mayúsculas de minúsculas.
`intervals[]`	`Interval` Solo se establece si los valores se deben agrupar en intervalos. Se debe configurar para las facetas con valores numéricos. No se debe establecer para la faceta con valores de texto. La cantidad máxima de intervalos es 30.
`restricted_values[]`	`string` Solo se obtiene la faceta para los valores restringidos determinados. Solo se admite en campos de texto. Por ejemplo, supongamos que "categoría" tiene tres valores: "Acción > 2022", "Acción > 2021" y "Ciencia ficción > 2022". Si se establece "restricted_values" en "Action > 2022", la faceta "category" solo contiene "Action > 2022". Solo se admite en campos de texto. El máximo es 10.
`prefixes[]`	`string` Solo se obtienen los valores de faceta que comienzan con el prefijo de cadena determinado. Por ejemplo, supongamos que "categoría" tiene tres valores: "Acción > 2022", "Acción > 2021" y "Ciencia ficción > 2022". Si se establece "prefixes" en "Action", la faceta "category" solo contiene "Action > 2022" y "Action > 2021". Solo se admite en campos de texto. El máximo es 10.
`contains[]`	`string` Solo se obtienen los valores de faceta que contienen las cadenas proporcionadas. Por ejemplo, supongamos que "categoría" tiene tres valores: "Acción > 2022", "Acción > 2021" y "Ciencia ficción > 2022". Si se establece "contiene" en "2022", la faceta "categoría" solo contendrá "Acción > 2022" y "Ciencia ficción > 2022". Solo se admite en campos de texto. El máximo es 10.
`case_insensitive`	`bool` Es verdadero si las claves de faceta no distinguen mayúsculas de minúsculas cuando se obtienen valores de facetas con prefijos o contiene; de lo contrario, es falso.
`order_by`	`string` Es el orden en que se muestran los documentos. Los valores permitidos son los siguientes: "count desc", que significa ordenar por `SearchResponse.Facet.values.count` de forma descendente "value desc", que significa ordenar por `SearchResponse.Facet.values.value` de forma descendente. Solo se aplica a las facetas textuales. Si no se establece, los valores textuales se ordenan en orden natural, y los intervalos numéricos se ordenan según el orden que indica `FacetSpec.FacetKey.intervals`.

ImageQuery

Especifica la entrada de la búsqueda de imágenes.

Campos

Campo de unión image.

image puede ser una de las siguientes opciones:

image_bytes

string

Son los bytes de la imagen codificados en Base64. Formatos de imagen admitidos: JPEG, PNG y BMP.

NaturalLanguageQueryUnderstandingSpec

Es una especificación para habilitar las capacidades de comprensión del lenguaje natural para las solicitudes de búsqueda.

Campos
`filter_extraction_condition`	`FilterExtractionCondition` Condición en la que se debe realizar la extracción del filtro. El comportamiento del servidor se establece de forma predeterminada en `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` Son los nombres de los campos que se usan para el filtrado basado en la ubicación, en el que se detectan filtros de ubicación geográfica en las búsquedas en lenguaje natural. Solo es válido cuando FilterExtractionCondition se establece en `ENABLED`. Si se configura este campo, se anulan los nombres de los campos establecidos en `ServingConfig.geo_search_query_detection_field_names`.
`extracted_filter_behavior`	`ExtractedFilterBehavior` Opcional. Controla el comportamiento de cómo se aplican los filtros extraídos a la búsqueda. El comportamiento predeterminado depende de la solicitud. Para la búsqueda estructurada de un solo almacén de datos, el valor predeterminado es `HARD_FILTER`. En el caso de la búsqueda en varios almacenes de datos, el comportamiento predeterminado es `SOFT_BOOST`. Los filtros basados en la ubicación siempre se aplican como filtros estrictos, y el parámetro de configuración `SOFT_BOOST` no los afectará. Este campo solo se usa si [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] se establece en `FilterExtractionCondition.ENABLED`.
`allowed_field_names[]`	`string` Opcional. Lista de entidades permitidas de los campos que se pueden usar para la extracción de filtros de lenguaje natural. De forma predeterminada, si no se especifica, todos los campos indexables son aptos para la extracción de filtros de lenguaje natural (pero no se garantiza que se usen). Si se especifica algún campo en allowed_field_names, solo los campos que estén marcados como indexables en el esquema y especificados en la lista de entidades permitidas serán aptos para la extracción de filtros de lenguaje natural. Nota: Aún no se admite la búsqueda en varios almacenes de datos, por lo que se ignorará este parámetro.

ExtractedFilterBehavior

Es una enumeración que describe cómo se aplican los filtros extraídos a la búsqueda.

Enums
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` usará el comportamiento predeterminado para los filtros extraídos. En el caso de la búsqueda en un solo almacén de datos, la configuración predeterminada es aplicar filtros estrictos. En el caso de la búsqueda en varios almacenes de datos, la configuración predeterminada es aplicar los aumentos como aumentos leves.
`HARD_FILTER`	Aplica todos los filtros extraídos como filtros estrictos en los resultados. Los resultados que no pasen los filtros extraídos no se devolverán en el conjunto de resultados.
`SOFT_BOOST`	Aplica todos los filtros extraídos como refuerzos leves. Los resultados que pasen los filtros se impulsarán a clasificaciones más altas en el conjunto de resultados.

FilterExtractionCondition

Es una enumeración que describe en qué condición se debe realizar la extracción del filtro.

Enums
`CONDITION_UNSPECIFIED`	El comportamiento del servidor se establece de forma predeterminada en `DISABLED`.
`DISABLED`	Inhabilita la extracción de filtros de NL.
`ENABLED`	Habilita la extracción de filtros de lenguaje natural.

QueryExpansionSpec

Es la especificación para determinar en qué condiciones se debe realizar la búsqueda expandida.

Campos

condition

Condition

Es la condición en la que se debe realizar la búsqueda expandida. Margen aproximado predeterminado: Condition.DISABLED

pin_unexpanded_results

bool

Indica si se deben fijar los resultados sin expandir. Si este campo se establece como verdadero, los productos que no son parte de la búsqueda expandida siempre aparecerán en la parte superior de los resultados de la búsqueda, seguidos de los resultados expandidos.

Condición

Es una enumeración que describe bajo qué condición debe ocurrir la búsqueda expandida.

Enums
`CONDITION_UNSPECIFIED`	No se especificó la condición de búsqueda expandida. En este caso, el comportamiento del servidor se establece de forma predeterminada en `Condition.DISABLED`.
`DISABLED`	Se inhabilitó la búsqueda expandida. Solo se usa la búsqueda exacta, incluso si `SearchResponse.total_size` es cero.
`AUTO`	Búsqueda expandida automática que crea la API de Search.

RankingExpressionBackend

Es el backend que se usará para la evaluación de la expresión de clasificación.

Enums
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Es la opción predeterminada para los valores no especificados o desconocidos.
`BYOE`	Obsoleto: Usa `RANK_BY_EMBEDDING` en su lugar. Clasificación según el modelo de incorporación personalizado, la forma predeterminada de evaluar la expresión de clasificación. Es una opción de enumeración heredada. En su lugar, se debe usar `RANK_BY_EMBEDDING`. Este elemento está obsoleto.
`CLEARBOX`	Obsoleto: Usa `RANK_BY_FORMULA` en su lugar. Es el ranking según una fórmula personalizada. Es una opción de enumeración heredada. En su lugar, se debe usar `RANK_BY_FORMULA`. Este elemento está obsoleto.
`RANK_BY_EMBEDDING`	Clasificación según el modelo de incorporación personalizado, la forma predeterminada de evaluar la expresión de clasificación.
`RANK_BY_FORMULA`	Es el ranking según una fórmula personalizada.

RelevanceScoreSpec

Es la especificación para devolver la puntuación de relevancia del documento.

Campos

return_relevance_score

bool

Opcional. Indica si se debe devolver la puntuación de relevancia para los resultados de la búsqueda. Cuanto más alta sea la puntuación, más pertinente será el documento para la búsqueda.

RelevanceThreshold

Es el umbral de relevancia de los resultados de la búsqueda. Cuanto más alto sea el umbral de relevancia, más resultados pertinentes se mostrarán y menos resultados se devolverán.

Enums
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Valor predeterminado. En este caso, el comportamiento del servidor se establece de forma predeterminada en el umbral definido por Google.
`LOWEST`	Es el umbral de relevancia más bajo.
`LOW`	Umbral de relevancia bajo.
`MEDIUM`	Umbral de relevancia medio.
`HIGH`	Umbral de relevancia alto.

SearchAsYouTypeSpec

Es la especificación de la búsqueda mientras escribes en las solicitudes de búsqueda.

Campos

condition

Condition

Condición en la que se debe realizar la búsqueda a medida que escribes. Margen aproximado predeterminado: Condition.DISABLED

Condición

Es una enumeración que describe en qué condición debe ocurrir la búsqueda mientras escribes.

Enums
`CONDITION_UNSPECIFIED`	El comportamiento del servidor se establece de forma predeterminada en `Condition.DISABLED`.
`DISABLED`	Inhabilita la función de búsqueda mientras escribes.
`ENABLED`	Habilita la función de búsqueda mientras escribes.
`AUTO`	Cambio automático entre los modos de búsqueda estándar y de búsqueda mientras escribes, ideal para implementaciones de una sola API (p.ej., eliminación de rebotes).

SessionSpec

Es la especificación de la sesión.

Actualmente, la función de búsqueda de turnos múltiples se encuentra en la etapa de disponibilidad general privada. Usa la versión v1alpha o v1beta antes de que lancemos esta función para la DG pública, o bien solicita que se agregue a la lista de entidades permitidas a través del equipo de Atención al cliente de Google.

Campos

query_id

string

Si se configura, el resultado de la búsqueda se almacena en el "turno" especificado por este ID de búsqueda.

Ejemplo: Supongamos que la sesión se ve de la siguiente manera: 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" } } }

El usuario puede llamar a la API de /search con una solicitud como esta:

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

Luego, la API almacena el resultado de la búsqueda asociado con el último turno. El resultado de la búsqueda almacenado se puede usar en una llamada posterior a la API de /answer (con el ID de sesión y el ID de consulta especificados). También es posible llamar a /search y /answer en paralelo con el mismo ID de sesión y de búsqueda.

search_result_persistence_count

int32

Es la cantidad de resultados de la búsqueda principales que se conservarán. Los resultados de la búsqueda persistentes se pueden usar para la llamada posterior a la API de /answer.

Este campo es similar al campo summary_result_count en SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Como máximo, 10 resultados para el modo de documentos o 50 para el modo de fragmentos.

SpellCorrectionSpec

Es la especificación para la corrección ortográfica de la búsqueda.

Campos

mode

Mode

Es el modo en el que la corrección ortográfica reemplaza la búsqueda original. La configuración predeterminada es Mode.AUTO.

Modo

Es una enumeración que describe en qué modo se debe realizar la corrección ortográfica.

Enums
`MODE_UNSPECIFIED`	No se especificó el modo de corrección ortográfica. En este caso, el comportamiento del servidor se establece de forma predeterminada en `Mode.AUTO`.
`SUGGESTION_ONLY`	La API de Search intenta encontrar una sugerencia ortográfica. Si se encuentra una sugerencia, se coloca en `SearchResponse.corrected_query`. La sugerencia de ortografía no se usará como consulta de búsqueda.
`AUTO`	Corrección ortográfica automática integrada en la API de Search. La búsqueda se basará en la consulta corregida, si se encuentra.

SearchResponse

Mensaje de respuesta para el método SearchService.Search.

Campos
`results[]`	`SearchResult` Es una lista de documentos coincidentes. El orden representa la clasificación.
`facets[]`	`Facet` Son los resultados de las facetas solicitadas por el usuario.
`total_size`	`int32` Es el recuento total estimado de artículos coincidentes, sin importar la paginación. El recuento de `results` que devuelve la paginación puede ser menor que el de `total_size` que coincide.
`attribution_token`	`string` Es un token de búsqueda único. Esto se debe incluir en los registros de `UserEvent` que resulten de esta búsqueda, lo que permite una atribución precisa del rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.
`redirect_uri`	`string` Es el URI de una página de redireccionamiento definida por el cliente. Si se activa la acción de redireccionamiento, no se realiza ninguna búsqueda y solo se configuran `redirect_uri` y `attribution_token` en la respuesta.
`next_page_token`	`string` Es un token que se puede enviar como `SearchRequest.page_token` para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.
`corrected_query`	`string` Contiene la consulta corregida ortográficamente, si se encuentra. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de la búsqueda se basan en corrected_query. De lo contrario, se usa la búsqueda original.
`summary`	`Summary` Es un resumen que forma parte de los resultados de la búsqueda. Este campo solo se devuelve si se configura `SearchRequest.ContentSearchSpec.summary_spec`.
`query_expansion_info`	`QueryExpansionInfo` Es la información de expansión de la búsqueda para los resultados devueltos.
`session_info`	`SessionInfo` Es la información de la sesión. Solo se establece si se proporciona `SearchRequest.session`. Consulta la descripción para obtener más detalles.
`search_link_promotions[]`	`SearchLinkPromotion` Son las promociones para la búsqueda en el sitio.

Es un resultado de faceta.

Campos

key

string

Es la clave de esta faceta. Por ejemplo, "colors" o "price". Coincide con SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Son los valores de faceta para este campo.

dynamic_facet

bool

Indica si la faceta se genera de forma dinámica.

FacetValue

Es un valor de faceta que contiene nombres de valores y su recuento.

Campos
`count`	`int64` Es la cantidad de elementos que tienen este valor de faceta.
Campo de unión `facet_value`. Es un valor de faceta que contiene valores. `facet_value` puede ser solo uno de los siguientes:
`value`	`string` Es el valor de texto de una faceta, como "Negro" para la faceta "colores".
`interval`	`Interval` Es el valor del intervalo para una faceta, como [10, 20) para la faceta "precio". Coincide con `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Es información que describe la búsqueda expandida, incluido si se produjo la expansión.

Campos

expanded_query

bool

Es un valor booleano que describe si se produjo la búsqueda expandida.

pinned_result_count

int64

Cantidad de resultados fijados. Este campo solo se establecerá cuando se produzca la expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results se establezca como verdadero.

SearchResult

Representa los resultados de la búsqueda.

Campos
`id`	`string` `Document.id` de la `Document` buscada.
`document`	`Document` Es el fragmento de datos del documento en la respuesta de búsqueda. Solo se propagan los campos marcados como `retrievable`.
`chunk`	`Chunk` Son los datos de fragmentos en la respuesta de búsqueda si `SearchRequest.ContentSearchSpec.search_result_mode` se establece en `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Solo salida. Google proporcionó las puntuaciones disponibles.
`rank_signals`	`RankSignals` Opcional. Es un conjunto de indicadores de clasificación asociados con el resultado.

RankSignals

Es un conjunto de indicadores de clasificación.

Campos
`default_rank`	`float` Opcional. Es el rango predeterminado del resultado.
`custom_signals[]`	`CustomSignal` Opcional. Es una lista de indicadores de Clearbox personalizados.
`keyword_similarity_score`	`float` Opcional. Ajuste de la concordancia de palabras clave.
`relevance_score`	`float` Opcional. Ajuste de relevancia semántica.
`semantic_similarity_score`	`float` Opcional. Ajuste de similitud semántica.
`pctr_rank`	`float` Opcional. Ajuste del porcentaje de conversiones previsto como un ranking.
`topicality_rank`	`float` Opcional. Ajuste de la relevancia del tema como un ranking.
`document_age`	`float` Opcional. Es la antigüedad del documento en horas.
`boosting_factor`	`float` Opcional. Es la combinación de los aumentos personalizados para un documento.

CustomSignal

Es un indicador de Clearbox personalizado representado por un par de nombre y valor.

Campos

name

string

Opcional. Es el nombre del indicador.

value

float

Opcional. Es un valor de número de punto flotante que representa el indicador de clasificación (p.ej., 1.25 para BM25).

SessionInfo

Es información sobre la sesión.

Campos

name

string

Nombre de la sesión. Si se usa el modo de sesión automática (cuando SearchRequest.session termina con "-"), este campo contiene el nombre de la sesión recién generada.

query_id

string

Es el ID de la búsqueda que corresponde a esta llamada a la API de Search. Una sesión puede tener varios turnos, cada uno con un ID de búsqueda único.

Si especificas el nombre de la sesión y este ID de búsqueda en la llamada a la API de Answer, la generación de la respuesta se realizará en el contexto de los resultados de la búsqueda de esta llamada de búsqueda.

Resumen

Es el resumen de los N resultados de la búsqueda principales especificados por el objeto SummarySpec.

Campos
`summary_text`	`string` Es el contenido del resumen.
`summary_skipped_reasons[]`	`SummarySkippedReason` Son motivos adicionales por los que se omitió el resumen. Esto proporciona el motivo por el que se ignoraron los casos. Si no se omite nada, este campo no se establece.
`safety_attributes`	`SafetyAttributes` Es una colección de categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.
`summary_with_metadata`	`SummaryWithMetadata` Es un resumen con información de metadatos.

Cita

Es la información de la cita de un segmento.

Campos

start_index

int64

El índice indica el inicio del segmento, medido en bytes o Unicode.

end_index

int64

Es el final del segmento atribuido, exclusivo.

sources[]

CitationSource

Son las fuentes de citas del segmento atribuido.

CitationMetadata

Son los metadatos de la cita.

Campos

citations[]

Citation

Son las citas de los segmentos.

CitationSource

Es la fuente de la cita.

Campos

reference_index

int64

Índice de referencia del documento de SummaryWithMetadata.references. Está indexado a partir de 0 y el valor será cero si no se establece reference_index de forma explícita.

Reference

Es la referencia del documento.

Campos
`title`	`string` Es el título del documento.
`document`	`string` Obligatorio. `Document.name` del documento. Nombre completo del recurso del documento al que se hace referencia, en el formato `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` Es el URI de Cloud Storage o HTTP del documento.
`chunk_contents[]`	`ChunkContent` Es la lista de contenido de fragmentos citados que se deriva del contenido del documento.

ChunkContent

Divide el contenido en fragmentos.

Campos

content

string

Fragmenta el contenido textual.

page_identifier

string

Es el identificador de la página.

SafetyAttributes

Son las categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.

Campos

categories[]

string

Los nombres visibles de las categorías de atributos de seguridad asociados con el contenido generado. El orden coincide con las puntuaciones.

scores[]

float

Las puntuaciones de confianza de cada categoría, un valor más alto significa más confianza. El orden coincide con las categorías.

SummarySkippedReason

Es una enumeración para los motivos por los que se omitió el resumen.

Enums
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se especificó el motivo por el que se omitió el resumen.
`ADVERSARIAL_QUERY_IGNORED`	Es la consulta adversaria que se ignoró. Solo se usa cuando `SummarySpec.ignore_adversarial_query` se establece en `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	Es la consulta que no busca un resumen y que ignora las mayúsculas y minúsculas. Google omite el resumen si la búsqueda es una conversación informal. Solo se usa cuando `SummarySpec.ignore_non_summary_seeking_query` se establece en `true`.
`OUT_OF_DOMAIN_QUERY_IGNORED`	Es la búsqueda fuera del dominio que ignoró las mayúsculas y minúsculas. Google omite el resumen si no hay resultados de la búsqueda muy relevantes. Por ejemplo, el almacén de datos contiene hechos sobre la empresa A, pero la búsqueda del usuario hace preguntas sobre la empresa B.
`POTENTIAL_POLICY_VIOLATION`	Es el caso de posible incumplimiento de política. Google omite el resumen si se detecta un posible incumplimiento de política. Esto incluye contenido que puede ser violento o tóxico.
`LLM_ADDON_NOT_ENABLED`	Caso en el que no está habilitado el complemento de LLM. Google omite el resumen si el complemento de LLM no está habilitado.
`NO_RELEVANT_CONTENT`	Es el caso en el que no hay contenido relevante. Google omite el resumen si no hay contenido pertinente en los resultados de la búsqueda recuperados.
`JAIL_BREAKING_QUERY_IGNORED`	La búsqueda de jailbreak ignoró las mayúsculas y minúsculas. Por ejemplo, "Responde con el tono del director ejecutivo de una empresa de la competencia". Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] se establece en `true`.
`CUSTOMER_POLICY_VIOLATION`	Es el caso de incumplimiento de política del cliente. Google omite el resumen si se detecta un incumplimiento de la política del cliente. El cliente define la política.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	Es la búsqueda que no busca respuestas y que ignora las mayúsculas y minúsculas. Google omite el resumen si la búsqueda no tiene una intención clara. Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] se establece en `true`.
`TIME_OUT`	Se agotó el tiempo de espera. Google omite el resumen si se agota el tiempo.

SummaryWithMetadata

Es un resumen con información de metadatos.

Campos

summary

string

Es un texto de resumen sin información de citas.

citation_metadata

CitationMetadata

Son los metadatos de la cita del resumen determinado.

references[]

Reference

Referencias de documentos

SearchTier

Son los niveles de las funciones de búsqueda. Los diferentes niveles pueden tener precios diferentes. Para obtener más información, consulta la documentación sobre precios.

Enums
`SEARCH_TIER_UNSPECIFIED`	Es el valor predeterminado cuando no se especifica el enum. No se puede usar.
`SEARCH_TIER_STANDARD`	Nivel Estándar.
`SEARCH_TIER_ENTERPRISE`	Nivel empresarial.

SearchUseCase

Define una subdivisión adicional de SolutionType. Se aplica específicamente a SOLUTION_TYPE_SEARCH.

Enums
`SEARCH_USE_CASE_UNSPECIFIED`	Es el valor que se usa cuando no se establece. No ocurrirá en CSS.
`SEARCH_USE_CASE_SEARCH`	Caso de uso de búsqueda. Se espera que el tráfico tenga un `query` no vacío.
`SEARCH_USE_CASE_BROWSE`	Caso de uso de exploración. Se espera que el tráfico tenga un `query` vacío.

ServingConfig

Configura los metadatos que se usan para generar resultados en el momento de la entrega (p.ej., resultados de la búsqueda o predicciones de recomendaciones). El objeto ServingConfig se pasa en la solicitud de búsqueda y predicción, y genera resultados.

Campos
`name`	`string` Inmutable. Nombre completamente calificado `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Obligatorio. Es el nombre visible de la configuración de entrega legible por humanos. Se usa en la IU de Discovery. Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
`solution_type`	`SolutionType` Obligatorio. Inmutable. Especifica el tipo de solución con el que se puede asociar una configuración de publicación.
`model_id`	`string` Es el ID del modelo que se usará en el momento de la entrega. Actualmente, solo se admiten los RecommendationModels. Se puede cambiar, pero solo a un modelo compatible (p.ej., de la CTR de otras que podrían gustarte al CVR de otras que podrían gustarte). Obligatorio cuando `SolutionType` es `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` Es la cantidad de diversidad que se usará en los resultados del modelo de recomendación, p.ej., `medium-diversity` o `high-diversity`. Valores admitidos actualmente: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` Si no se especifica, elegimos el valor predeterminado según el tipo de modelo de recomendación. Valor predeterminado: `no-diversity`. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_RECOMMENDATION`.
`ranking_expression`	`string` La expresión de clasificación controla la clasificación personalizada de los documentos recuperados. Para aprovechar esta función, se requiere la incorporación de documentos. El parámetro de configuración de la expresión de clasificación en ServingConfig se aplica a todas las solicitudes de búsqueda que se entregan con la configuración de entrega. Sin embargo, si se especifica `SearchRequest.ranking_expression`, se anula la expresión de clasificación de ServingConfig. La expresión de clasificación es una sola función o varias funciones unidas por "+". ranking_expression = function, { " + ", function }; Funciones compatibles: double * relevance_score double * dotProduct(embedding_field_path) Variables de función: `relevance_score`: Son palabras clave predefinidas que se usan para medir la relevancia entre la búsqueda y el documento. `embedding_field_path`: Es el campo de incorporación de documentos que se usa con el vector de incorporación de la búsqueda. `dotProduct`: Es la función de embedding entre embedding_field_path y el vector de embedding de la búsqueda. Ejemplo de expresión de clasificación: Si el documento tiene un campo de incorporación doc_embedding, la expresión de clasificación podría ser `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
`create_time`	`Timestamp` Solo salida. Es la marca de tiempo de creación de ServingConfig.
`update_time`	`Timestamp` Solo salida. Es la marca de tiempo de actualización de ServingConfig.
`filter_control_ids[]`	`string` Son los controles de filtro que se usarán en la ruta de entrega. Se aplicarán todos los controles de filtro activados. Los controles de filtro deben estar en el mismo almacén de datos que la configuración de la publicación. Se permite un máximo de 20 controles de filtros.
`boost_control_ids[]`	`string` Controles de refuerzo que se usarán en la ruta de entrega. Se aplicarán todos los controles de potenciación activados. Los controles de refuerzo deben estar en el mismo almacén de datos que la configuración de la publicación. Se pueden aplicar un máximo de 20 controles de potenciación.
`redirect_control_ids[]`	`string` Son los IDs de los controles de redireccionamiento. Solo se aplica la primera acción de redireccionamiento activada, incluso si se aplican varias. La cantidad máxima de especificaciones es 100. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`synonyms_control_ids[]`	`string` Son las especificaciones de los sinónimos de condiciones. Si coinciden varias condiciones de sinónimos, se ejecutarán todos los controles de sinónimos coincidentes de la lista. La cantidad máxima de especificaciones es 100. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`oneway_synonyms_control_ids[]`	`string` Son las especificaciones de los sinónimos unidireccionales de la condición. Si coinciden varias condiciones de sinónimos unidireccionales, se ejecutarán todos los controles de sinónimos unidireccionales coincidentes de la lista. La cantidad máxima de especificaciones es 100. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`dissociate_control_ids[]`	`string` La condición no asocia especificaciones. Si coinciden varias condiciones de no asociación, se ejecutarán todos los controles de no asociación coincidentes de la lista. El orden no importa. La cantidad máxima de especificaciones es 100. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`replacement_control_ids[]`	`string` Son las especificaciones de reemplazo de la condición. Se aplican según el orden en la lista. No se puede volver a reemplazar un término que ya se reemplazó. La cantidad máxima de especificaciones es 100. Solo se puede configurar si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Especificaciones de ignorar la condición. Si coinciden varias condiciones de ignorar, se ejecutarán todos los controles de ignorar coincidentes de la lista. El orden no importa. La cantidad máxima de especificaciones es 100.
`promote_control_ids[]`	`string` Son las especificaciones de la promoción de condiciones. La cantidad máxima de especificaciones es 100.
`answer_generation_spec`	`AnswerGenerationSpec` Opcional. Es la especificación para la generación de respuestas.
Campo de unión `vertical_config`. Es la configuración específica de la vertical de la industria. `vertical_config` puede ser solo uno de los siguientes:
`media_config`	`MediaConfig` Es el MediaConfig de la configuración de entrega.
`generic_config`	`GenericConfig` Es el GenericConfig de la configuración de entrega.

GenericConfig

Especifica las configuraciones necesarias para el Descubrimiento genérico.Actualmente, admitimos lo siguiente:

content_search_spec: Es la configuración para la búsqueda de contenido genérico.

Campos

content_search_spec

ContentSearchSpec

Especifica el comportamiento esperado de la búsqueda de contenido. Solo es válido para el almacén de datos habilitado para la búsqueda de contenido.

MediaConfig

Especifica la configuración necesaria para el Descubrimiento de contenido multimedia. Actualmente, admitimos lo siguiente:

demote_content_watched: Es el umbral para la reducción de la visibilidad del contenido visto. Los clientes pueden especificar si usan la reducción de nivel del contenido visto o la página de detalles vista. Con la reducción de visibilidad del contenido visto, los clientes deben especificar que los minutos o el porcentaje vistos superan el umbral. De lo contrario, se reducirá la visibilidad del contenido en el resultado de la recomendación.
promote_fresh_content: Son los días límite para la promoción de contenido nuevo. Los clientes pueden especificar si se usa la promoción de la actualización del contenido. Si el contenido se publicó dentro de los días límite, se promocionará en el resultado de la recomendación. Solo se puede configurar si SolutionType es SOLUTION_TYPE_RECOMMENDATION.

Campos
`demotion_event_type`	`string` Especifica el tipo de evento que se usa para reducir la posición del resultado de la recomendación. Valores admitidos actualmente: `view-item`: Se vio el elemento. `media-play`: Comenzar o reanudar la reproducción de un video, una canción, etcétera `media-complete`: Terminó o se detuvo a mitad de un video, una canción, etcétera. Si no se configura, no se aplicará la reducción de la visibilidad del historial de reproducciones. Aún se aplicará la reducción de la actualización del contenido.
`demote_content_watched_past_days`	`int32` Opcional. Especifica la cantidad de días hacia atrás para bajar el contenido visto. Si se establece en cero o no se establece, el valor predeterminado es el máximo de 365 días.
`content_freshness_cutoff_days`	`int32` Especifica la actualización del contenido que se usa para el resultado de la recomendación. El contenido descenderá de nivel si se publicó hace más de los días límite de actualización del contenido.
Campo de unión `demote_content_watched`. Especifica el umbral para reducir la visibilidad del contenido visto. El umbral puede ser un valor de porcentaje o de minutos. Se debe configurar para el tipo de evento `media-complete`. `demote_content_watched` puede ser solo uno de los siguientes:
`content_watched_percentage_threshold`	`float` Especifica el umbral de porcentaje de contenido visto para la baja. El valor del umbral debe estar entre [0, 1.0], inclusive.
`content_watched_seconds_threshold`	`float` Especifica el umbral de minutos de contenido visto para la baja.

Sesión

Es la definición del arquetipo de sesión externa.

Campos
`name`	`string` Inmutable. Nombre completamente calificado `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` Opcional. Es el nombre visible de la sesión. Este campo se usa para identificar la sesión en la IU. De forma predeterminada, el nombre visible es el texto de la primera pregunta de la sesión.
`state`	`State` Es el estado de la sesión.
`user_pseudo_id`	`string` Es un identificador único para hacer un seguimiento de los usuarios.
`turns[]`	`Turn` Giros
`labels[]`	`string` Opcional. Son las etiquetas de la sesión. Se puede establecer como filtro en ListSessionsRequest.
`start_time`	`Timestamp` Solo salida. Es la fecha y hora en que se inició la sesión.
`end_time`	`Timestamp` Solo salida. Fecha y hora en que finalizó la sesión.
`is_pinned`	`bool` Opcional. Indica si la sesión está fijada. Si lo está, se mostrará en la parte superior de la lista de sesiones.

Estado

Es una enumeración del estado de la sesión.

Enums
`STATE_UNSPECIFIED`	El estado no se especifica.
`IN_PROGRESS`	La sesión está abierta en este momento.

Turno

Representa un turno, incluida una búsqueda del usuario y una respuesta del servicio.

Campos
`query`	`Query` Opcional. Es la consulta del usuario. Es posible que no se establezca si este turno solo regenera una respuesta a un turno diferente.
`answer`	`string` Opcional. Es el nombre del recurso de la respuesta a la búsqueda del usuario. Solo se configura si la generación de respuestas (llamada a la API de /answer) ocurrió en este turno.
`assist_answer`	`string` Solo salida. Es el nombre del recurso de la respuesta de Asistente a la búsqueda del usuario. Solo se establece si se realizó una llamada de asistencia (llamada a la API de /assist) en este turno. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Para obtener todas las respuestas de AssistAnswers para una sesión, establece GetSessionRequest.include_answer_details en verdadero. Como alternativa, para obtener un recurso de AssistAnswer individual, usa la API de AssistAnswerService.GetAssistAnswer.
`detailed_answer`	`Answer` Solo salida. En la API de `ConversationalSearchService.GetSession`, si `GetSessionRequest.include_answer_details` se establece como verdadero, este campo se completará cuando se obtenga la sesión de consulta de respuesta.
`detailed_assist_answer`	`AssistAnswer` Solo salida. En la API de `ConversationalSearchService.GetSession`, si `GetSessionRequest.include_answer_details` se establece como verdadero, este campo se propagará cuando se obtenga la sesión del asistente.
`query_config`	`map<string, string>` Opcional. Representa los metadatos relacionados con la configuración de la búsqueda, por ejemplo, el modelo y la versión del LLM que se usaron, los parámetros del modelo (temperatura, parámetros de fundamentación, etcétera). El prefijo "google." está reservado para la funcionalidad desarrollada por Google.

SetUpDataConnectorMetadata

Este tipo no tiene campos.

Son los metadatos del método DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Es la solicitud para el método DataConnectorService.SetUpDataConnector.

Campos
`parent`	`string` Obligatorio. Es el elemento superior de `Collection`, con el formato `projects/{project}/locations/{location}`.
`collection_id`	`string` Obligatorio. Es el ID que se usará para el `Collection`, que se convertirá en el componente final del nombre del recurso del `Collection`. Se crea un nuevo `Collection` como parte de la configuración de `DataConnector`. `DataConnector` es un recurso singleton en `Collection` que administra todos los `DataStore` de `Collection`. Este campo debe cumplir con el estándar RFC-1034 y tener un límite de 63 caracteres. De lo contrario, se muestra un error INVALID_ARGUMENT.
`collection_display_name`	`string` Obligatorio. El nombre visible del `Collection`. Debe ser legible y usarse para mostrar colecciones en el panel de la consola. Es una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
`data_connector`	`DataConnector` Obligatorio. Es el `DataConnector` que se inicializará en el `Collection` recién creado.

SingleRegionKey

Son los metadatos de las CMEK regionales únicas.

Campos

kms_key

string

Obligatorio. Nombre del recurso de clave de KMS de una sola región que se usará para encriptar los recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

SiteSearchEngine captura las configuraciones persistentes de la búsqueda en el sitio a nivel de DataStore. Es un valor singleton por almacén de datos.

Campos

name

string

Es el nombre de recurso completamente calificado del motor de búsqueda del sitio. Formato: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Es la información de verificación de los sitios objetivo en la búsqueda avanzada en el sitio.

Campos

site_verification_state

SiteVerificationState

Estado de verificación del sitio que indica la propiedad y la validez.

verify_time

Es la fecha y hora de la verificación del sitio más reciente.

SiteVerificationState

Es el estado de verificación del sitio.

Enums
`SITE_VERIFICATION_STATE_UNSPECIFIED`	La configuración predeterminada es VERIFIED.
`VERIFIED`	Se verificó la propiedad del sitio.
`UNVERIFIED`	La verificación de la propiedad del sitio está pendiente o falló.
`EXEMPTED`	El sitio está exento de verificación, p.ej., un sitio web público que se abre para todos.

Campos
`name`	`string` Solo salida. Es el nombre de recurso completamente calificado del mapa del sitio. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` El sufijo `sitemap_id` lo genera el sistema.
`create_time`	`Timestamp` Solo salida. Es la hora de creación del mapa del sitio.
Campo de unión `feed`. Son las fuentes de feeds admitidas. `feed` puede ser solo uno de los siguientes:
`uri`	`string` Es el URI público del mapa del sitio, p.ej., `www.example.com/sitemap.xml`.

SolutionType

Es el tipo de solución.

Enums
`SOLUTION_TYPE_UNSPECIFIED`	Valor predeterminado.
`SOLUTION_TYPE_RECOMMENDATION`	Se usa para Recomendaciones IA.
`SOLUTION_TYPE_SEARCH`	Se usa para la Búsqueda por descubrimiento.
`SOLUTION_TYPE_CHAT`	Se usa para casos de uso relacionados con el agente de IA generativa.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Se usa para casos de uso relacionados con el agente de chat generativo. Solo se usa para el motor de chat generativo. Los almacenes de datos asociados deben estar inscritos en la solución de `SOLUTION_TYPE_CHAT`.

SpannerSource

La fuente de Spanner para importar datos

Campos
`project_id`	`string` Es el ID del proyecto que contiene la fuente de Spanner. Tiene un límite de longitud de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`instance_id`	`string` Obligatorio. ID de la instancia de la tabla de Spanner de origen.
`database_id`	`string` Obligatorio. Es el ID de la base de datos de la tabla de Spanner de origen.
`table_id`	`string` Obligatorio. Es el nombre de la tabla de la base de datos de Spanner que se debe importar.
`enable_data_boost`	`bool` Indica si se debe aplicar Data Boost en la exportación de Spanner. Habilitar esta opción generará costos adicionales. Obtén más información aquí.

StreamAssistRequest

Es la solicitud para el método AssistantService.StreamAssist.

Campos
`name`	`string` Obligatorio. Es el nombre del recurso `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Es la consulta del usuario actual. Solo se admite la búsqueda vacía si se proporciona `file_ids`. En este caso, la respuesta se generará en función de esos archivos de contexto.
`session`	`string` Opcional. Es la sesión que se usará para la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la búsqueda y la respuesta se almacenan allí. Si se especifica `-` como el ID de sesión o se deja vacío, se crea una sesión nueva con un ID generado automáticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Opcional. Es información sobre el usuario que inicia la búsqueda.
`agents_spec`	`AgentsSpec` Opcional. Es la especificación de los agentes que se usan para atender la solicitud.
`tools_spec`	`ToolsSpec` Opcional. Es la especificación de las herramientas que se usan para atender la solicitud.
`generation_spec`	`GenerationSpec` Opcional. Es la especificación de la configuración de generación para la solicitud.

AgentsSpec

Es la especificación de los agentes que se usan para atender la solicitud.

Campos

agent_specs[]

AgentSpec

Opcional. Es la especificación de los agentes que se usan para atender la solicitud.

AgentSpec

Es la especificación de un agente.

Campos

agent_id

string

Obligatorio. Es el ID que identifica el recurso del agente que procesa la solicitud.

Este campo debe cumplir con RFC-1034 y tener un límite de 63 caracteres.

GenerationSpec

Es la especificación de generación del asistente para la solicitud. Esto permite anular la configuración de generación predeterminada a nivel del motor.

Campos

model_id

string

Opcional. Es el model_id de Vertex AI que se usa para el modelo generativo. Si no se configura, se usará el modelo predeterminado de Assistant.

ToolsSpec

Es la especificación de las herramientas que se usan para atender la solicitud.

Campos
`vertex_ai_search_spec`	`VertexAiSearchSpec` Opcional. Es la especificación de la herramienta de Vertex AI Search.
`web_grounding_spec`	`WebGroundingSpec` Opcional. Es la especificación de la herramienta de fundamentación web. Si el campo está presente, habilita la fundamentación con la búsqueda web. Solo funciona si `Assistant.web_grounding_type` es [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] o [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
`image_generation_spec`	`ImageGenerationSpec` Opcional. Es la especificación de la herramienta de generación de imágenes.
`video_generation_spec`	`VideoGenerationSpec` Opcional. Es la especificación de la herramienta de generación de videos.

ImageGenerationSpec

Este tipo no tiene campos.

Es la especificación de la herramienta de generación de imágenes.

VertexAiSearchSpec

Es la especificación de la herramienta de Vertex AI Search.

Campos

data_store_specs[]

DataStoreSpec

Opcional. Son especificaciones que definen los DataStores para filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se considera para los Engines con varios almacenes de datos.

filter

string

Opcional. La sintaxis del filtro consta de un lenguaje de expresión para construir un predicado a partir de uno o más campos de los documentos que se filtran. La expresión del filtro distingue mayúsculas de minúsculas.

Si este campo no se puede reconocer, se devuelve un INVALID_ARGUMENT.

El filtrado en Vertex AI Search se realiza asignando la clave del filtro del LHD a una propiedad clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios podría tener un campo "nombre" en su esquema. En este caso, el filtro se vería de la siguiente manera: filter --> name:'ANY("king kong")'

Para obtener más información sobre los filtros, incluidos los operadores y la sintaxis de filtros, consulta Filtro.

VideoGenerationSpec

Este tipo no tiene campos.

Es la especificación de la herramienta de generación de videos.

WebGroundingSpec

Este tipo no tiene campos.

Es la especificación de la herramienta de fundamentación web.

StreamAssistResponse

Respuesta del método AssistantService.StreamAssist.

Campos

answer

AssistAnswer

Es un objeto de recurso de respuesta de Assist que contiene partes de la respuesta final del asistente para la búsqueda del usuario.

No está presente si la respuesta actual no agrega nada a la AssistAnswer.replies enviada anteriormente.

Observa AssistAnswer.state para ver si se esperan más partes. Mientras el estado sea IN_PROGRESS, el campo AssistAnswer.replies de cada respuesta contendrá respuestas (fragmentos de respuestas) que se agregarán a las que se recibieron en respuestas anteriores. No se completará AssistAnswer.name.

Si el estado es SUCCEEDED, FAILED o SKIPPED, la respuesta es la última y AssistAnswer.name tendrá un valor.

session_info

SessionInfo

Es la información de la sesión. Solo se incluye en el StreamAssistResponse final de la transmisión de respuesta.

assist_token

string

Es un ID único global que identifica el par actual de solicitud y flujo de respuestas. Se usa para brindar comentarios y asistencia.

SessionInfo

Es información sobre la sesión.

Campos

session

string

Nombre de la sesión recién generada o continuada.

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

SubscriptionTerm

Es el plazo de suscripción. LINT.IfChange

Enums
`SUBSCRIPTION_TERM_UNSPECIFIED`	Es un valor predeterminado que no se debe usar.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 mes
`SUBSCRIPTION_TERM_ONE_YEAR`	1 año
`SUBSCRIPTION_TERM_THREE_YEARS`	3 años

SubscriptionTier

Es la información del nivel de suscripción.

Enums
`SUBSCRIPTION_TIER_UNSPECIFIED`	Valor predeterminado.
`SUBSCRIPTION_TIER_SEARCH`	Es el nivel de búsqueda. El nivel de búsqueda puede acceder a las funciones de búsqueda de VAIS y a las funciones de NotebookLM.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Nivel de Búsqueda + Asistente. El nivel de búsqueda y asistente puede acceder a las funciones de búsqueda de VAIS, las funciones de NotebookLM y las funciones de asistente.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	Nivel de NotebookLM NotebookLM es un nivel de suscripción que solo puede acceder a las funciones de NotebookLM.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Nivel de trabajador de primera línea.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Nivel Starter de Agentspace.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Nivel de Agentspace Business.
`SUBSCRIPTION_TIER_ENTERPRISE`	Nivel empresarial.
`SUBSCRIPTION_TIER_EDU`	Nivel de EDU
`SUBSCRIPTION_TIER_EDU_PRO`	Nivel de EDU Pro.
`SUBSCRIPTION_TIER_EDU_EMERGING`	Es el nivel de mercado emergente de EDU.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Es el nivel de mercado emergente de EDU Pro.

SuggestionDenyListEntry

Entrada de la lista de bloqueo de sugerencias que identifica la frase que se bloqueará de las sugerencias y la operación aplicada a la frase.

Campos

block_phrase

string

Obligatorio. Es la frase que se bloqueará en las sugerencias que se publican. Puede tener un máximo de 125 caracteres.

match_operator

MatchOperator

Obligatorio. Es el operador de coincidencia que se aplicará a esta frase. Indica si se debe bloquear la frase exacta o cualquier sugerencia que la contenga.

MatchOperator

Es el operador para la coincidencia con las sugerencias generadas.

Enums
`MATCH_OPERATOR_UNSPECIFIED`	Valor predeterminado. No se debe usar.
`EXACT_MATCH`	Si la sugerencia coincide exactamente con block_phrase, se bloqueará.
`CONTAINS`	Si la sugerencia contiene la frase block_phrase, bloquéala.

TargetSite

Es un sitio objetivo para el motor de búsqueda del sitio.

Campos
`name`	`string` Solo salida. Es el nombre de recurso completamente calificado del sitio de destino. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` El `target_site_id` se genera automáticamente.
`provided_uri_pattern`	`string` Obligatorio. Solo entrada. Es el patrón de URI proporcionado por el usuario a partir del cual se genera el objeto `generated_uri_pattern`.
`type`	`Type` Es el tipo de sitio objetivo, p.ej., si el sitio se debe incluir o excluir.
`exact_match`	`bool` Inmutable. Si se configura como falso, se genera un uri_pattern para incluir todas las páginas cuya dirección contenga el provided_uri_pattern. Si se establece como verdadero, se genera un uri_pattern para intentar que coincida exactamente con el provided_uri_pattern o solo con la página específica si el provided_uri_pattern es específico. El provided_uri_pattern siempre se normaliza para generar el patrón de URI que usará el motor de búsqueda.
`generated_uri_pattern`	`string` Solo salida. Se genera automáticamente según el provided_uri_pattern.
`root_domain_uri`	`string` Solo salida. Es el dominio raíz de provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Solo salida. Es el estado de verificación de la propiedad y la validez del sitio.
`indexing_status`	`IndexingStatus` Solo salida. Es el estado de indexación.
`update_time`	`Timestamp` Solo salida. Fecha y hora de la última actualización del sitio objetivo.
`failure_reason`	`FailureReason` Solo salida. Es el motivo de la falla.

FailureReason

Son los motivos por los que falló la indexación de la búsqueda en el sitio.

Campos

Campo de unión failure. Es el motivo de la falla. failure puede ser solo uno de los siguientes:

quota_failure

QuotaFailure

La operación falló debido a que la cuota es insuficiente.

QuotaFailure

La operación falló debido a que la cuota es insuficiente.

Campos

total_required_quota

int64

Este número es una estimación de la cuota total que necesita este proyecto para completar la indexación correctamente.

IndexingStatus

Es una enumeración del estado de indexación del sitio objetivo.

Enums
`INDEXING_STATUS_UNSPECIFIED`	El valor predeterminado es SUCCEEDED.
`PENDING`	El sitio de destino está en la cola de actualización y la canalización de indexación lo recogerá.
`FAILED`	No se pudo indexar el sitio de destino.
`SUCCEEDED`	Se indexó el sitio de destino.
`DELETING`	Se marcó el sitio de destino indexado anteriormente para que se borre. Este es un estado de transición que generará uno de los siguientes resultados: 1. Se borra el sitio de destino si se quita la indexación correctamente. 2. El estado vuelve a SUCCEEDED si falla la eliminación de la indexación.
`CANCELLABLE`	El cambio de sitio de destino está pendiente, pero se puede cancelar.
`CANCELLED`	Se canceló el cambio de sitio de destino.

Tipo

Son los tipos de sitios objetivo posibles.

Enums
`TYPE_UNSPECIFIED`	Este valor no se usa. En este caso, el comportamiento del servidor se establece de forma predeterminada en `Type.INCLUDE`.
`INCLUDE`	Incluye el sitio de destino.
`EXCLUDE`	Excluye el sitio de destino.

Usuario

Es la información del arrendatario para una fuente de conector. Esto incluye parte de la misma información almacenada en el mensaje Credential, pero se limita solo a lo que se necesita para proporcionar una lista de inquilinos accesibles al usuario.

Campos

id

string

Es el ID de instancia del arrendatario. Ejemplos: Jira (“8594f221-9797-5f78-1fa4-485e198d7cd0”), Slack (“T123456”).

uri

string

Es el URI del arrendatario, si corresponde. Por ejemplo, el URI de una instancia de Jira es https://my-jira-instance.atlassian.net, y un arrendatario de Slack no tiene un URI.

display_name

string

Es el nombre visible opcional del arrendatario, p.ej., "Mi equipo de Slack".

TextInput

Define la entrada de texto.

Campos

input

string

Es una entrada de texto.

context

ConversationContext

Es el contexto de la conversación de la entrada.

TrainCustomModelMetadata

Son los metadatos relacionados con el progreso de la operación TrainCustomModel. Este valor se muestra en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

TrainCustomModelRequest

Mensaje de solicitud para el método SearchTuningService.TrainCustomModel.

Campos
`data_store`	`string` Obligatorio. Es el nombre del recurso del almacén de datos, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. Este campo se usa para identificar el almacén de datos en el que se entrenarán los modelos.
`model_type`	`string` Es el modelo que se entrenará. Los valores admitidos son los que se detallan a continuación: search-tuning: Ajuste preciso del sistema de búsqueda en función de los datos proporcionados.
`error_config`	`ImportErrorConfig` Ubicación deseada de los errores que se produjeron durante la transferencia y el entrenamiento de los datos.
`model_id`	`string` Si no se proporciona, se generará un UUID.
Campo de unión `training_input`. Es la entrada del entrenamiento del modelo. `training_input` puede ser solo uno de los siguientes:
`gcs_training_input`	`GcsTrainingInput` Es la entrada de entrenamiento de Cloud Storage.

GcsTrainingInput

Es la entrada de datos de entrenamiento de Cloud Storage.

Campos
`corpus_data_path`	`string` Son los datos del corpus de Cloud Storage que se podrían asociar en los datos de entrenamiento. El formato de la ruta de datos es `gs://<bucket_to_data>/<jsonl_file_name>`. Es un archivo jsonl/ndjson delimitado por saltos de línea. En el caso del modelo de ajuste de la búsqueda, cada línea debe tener el _id, el título y el texto. Ejemplo: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` Son los datos de la consulta de GCS que se podrían asociar con los datos de entrenamiento. El formato de la ruta de datos es `gs://<bucket_to_data>/<jsonl_file_name>`. Es un archivo jsonl/ndjson delimitado por saltos de línea. En el caso del modelo de ajuste de la búsqueda, cada línea debe tener el _id y el texto. Ejemplo: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Es la ruta de acceso a los datos de entrenamiento de Cloud Storage, cuyo formato debe ser `gs://<bucket_to_data>/<tsv_file_name>`. El archivo debe estar en formato TSV. Cada línea debe tener el doc_id, el query_id y la puntuación (número). En el caso del modelo de ajuste de la búsqueda, debe tener la puntuación de ID de consulta y de ID de corpus como encabezado del archivo TSV. La puntuación debe ser un número en `[0, inf+)`. Cuanto mayor sea el número, más relevante será el par. Ejemplo: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Son los datos de prueba de Cloud Storage. Tiene el mismo formato que train_data_path. Si no se proporciona, se realizará una división aleatoria del 80/20 entre los datos de entrenamiento y prueba en train_data_path.

TrainCustomModelResponse

Respuesta de TrainCustomModelRequest. Este mensaje se muestra en el campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Es una muestra de los errores que se encontraron durante el procesamiento de los datos.
`error_config`	`ImportErrorConfig` Si se configura, devuelve la respuesta de destino para los errores completos en la solicitud.
`model_status`	`string` Es el estado del modelo entrenado. Los valores posibles son: bad-data: La calidad de los datos de entrenamiento es baja. no-improvement: El ajuste no mejoró el rendimiento. No se implementará. in-progress: Se está creando el trabajo de entrenamiento del modelo. training: El modelo se está entrenando de forma activa. evaluating: El modelo está evaluando las métricas entrenadas. Indexación: Las métricas del modelo entrenado se indexan. ready: El modelo está listo para la entrega.
`metrics`	`map<string, double>` Son las métricas del modelo entrenado.
`model_name`	`string` Es el nombre completamente calificado del CustomTuningModel.

TransactionInfo

Una transacción representa toda la transacción de compra.

Campos
`currency`	`string` Obligatorio. Código de moneda. Utiliza el código ISO-4217 de tres caracteres.
`transaction_id`	`string` Es el ID de transacción con un límite de 128 caracteres.
`value`	`float` Obligatorio. Es el valor total no nulo asociado a la transacción. Este valor puede incluir el envío, los impuestos o cualquier otro ajuste al valor total que desees incluir.
`tax`	`float` Son todos los impuestos asociados a la transacción.
`cost`	`float` Son todos los costos asociados a los productos. Estos pueden ser costos de fabricación, gastos de envío que no paga el usuario final o cualquier otro costo, de modo que se cumpla la siguiente ecuación: Ganancia = `value` - `tax` - `cost`
`discount_value`	`float` Es el valor total de los descuentos aplicados a esta transacción. Esta cifra se debe excluir de `TransactionInfo.value`. Por ejemplo, si un usuario pagó el importe `TransactionInfo.value`, el valor nominal (antes del descuento) de la transacción es la suma de `TransactionInfo.value` y `TransactionInfo.discount_value`. Esto significa que la ganancia se calcula de la misma manera, independientemente del valor del descuento, y que `TransactionInfo.discount_value` puede ser mayor que `TransactionInfo.value`: Ganancia = `value` - `tax` - `cost`

UpdateAclConfigRequest

Es el mensaje de solicitud para el método UpdateAclConfig.

Campos
`acl_config`	`AclConfig`

UpdateAssistantRequest

Mensaje de la solicitud para el método AssistantService.UpdateAssistant.

Campos

assistant

Assistant

Obligatorio. Es el Assistant que se actualizará.

El campo name de Assistant se usa para identificar el Assistant que se actualizará. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Si la entidad llamadora no tiene permiso para actualizar el Assistant, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Assistant que se actualizará no existe, se mostrará un error NOT_FOUND.

update_mask

La lista de campos que se deben actualizar.

UpdateCmekConfigMetadata

Son metadatos relacionados con el progreso de la operación CmekConfigService.UpdateCmekConfig. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

UpdateCmekConfigRequest

Es el mensaje de solicitud para el método UpdateCmekConfig. rpc.

Campos

config

CmekConfig

Obligatorio. Es el recurso CmekConfig.

set_default

bool

Establece el siguiente CmekConfig como el valor predeterminado que se usará para los recursos secundarios si no se especifica uno.

UpdateControlRequest

Es la solicitud del método UpdateControl.

Campos

control

Control

Obligatorio. Es el control que se actualizará.

update_mask

Opcional. Indica qué campos del Control proporcionado se deben actualizar. NO se admiten los siguientes elementos:

Control.name
Control.solution_type

Si no se configura o está vacío, se actualizan todos los campos compatibles.

UpdateConversationRequest

Es la solicitud del método UpdateConversation.

Campos

conversation

Obligatorio. Es la conversación que se actualizará.

update_mask

Indica qué campos del Conversation proporcionado se deben actualizar. NO se admiten los siguientes elementos:

Conversation.name

Si no se configura o está vacío, se actualizan todos los campos compatibles.

UpdateDataConnectorRequest

Mensaje de solicitud para el método DataConnectorService.UpdateDataConnector.

Campos

data_connector

DataConnector

Obligatorio. Es el DataConnector que se actualizará.

Si la entidad llamadora no tiene permiso para actualizar el DataConnector, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si no existe el DataConnector, se muestra un error NOT_FOUND.

update_mask

Indica qué campos del DataConnector proporcionado se deben actualizar.

Las rutas de campo admitidas incluyen las siguientes:

refresh_interval
params
auto_run_disabled
action_config
action_config.action_params
action_config.service_name
destination_configs
blocking_reasons
sync_mode
incremental_sync_disabled
incremental_refresh_interval

Nota: La compatibilidad con estos campos puede variar según el tipo de conector. Por ejemplo, no todos los conectores admiten destination_configs.

Si se proporciona una ruta de campo desconocida o no admitida, la solicitud devolverá un error INVALID_ARGUMENT.

UpdateDataStoreRequest

Mensaje de solicitud para el método DataStoreService.UpdateDataStore.

Campos

data_store

DataStore

Obligatorio. Es el DataStore que se actualizará.

Si la entidad llamadora no tiene permiso para actualizar el DataStore, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el DataStore que se actualizará no existe, se mostrará un error NOT_FOUND.

update_mask

Indica qué campos del DataStore proporcionado se deben actualizar.

Si se proporciona un campo desconocido o no admitido, se muestra un error INVALID_ARGUMENT.

UpdateDocumentRequest

Mensaje de solicitud para el método DocumentService.UpdateDocument.

Campos

document

Obligatorio. Documento que se actualizará o creará.

Si el llamador no tiene permiso para actualizar el Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Document que se actualizará no existe y no se configuró allow_missing, se devolverá un error NOT_FOUND.

allow_missing

bool

Si se establece en true y no se encuentra el Document, se creará un nuevo Document.

update_mask

Indica qué campos del "documento" importado proporcionado se deben actualizar. Si no se configura, de forma predeterminada, se actualizan todos los campos.

UpdateEngineRequest

Mensaje de solicitud para el método EngineService.UpdateEngine.

Campos

engine

Engine

Obligatorio. Es el Engine que se actualizará.

Si la entidad llamadora no tiene permiso para actualizar el Engine, independientemente de si existe o no, se muestra un error PERMISSION_DENIED.

Si el Engine que se actualizará no existe, se mostrará un error NOT_FOUND.

update_mask

Indica qué campos del Engine proporcionado se deben actualizar.

Si se proporciona un campo desconocido o no admitido, se muestra un error INVALID_ARGUMENT.

UpdateLicenseConfigRequest

Mensaje de solicitud para el método LicenseConfigService.UpdateLicenseConfig.

Campos

license_config

LicenseConfig

Obligatorio. Es el LicenseConfig que se actualizará.

update_mask

Opcional. Indica qué campos del LicenseConfig proporcionado se deben actualizar.

Si se proporciona un campo desconocido o no admitido, se muestra un error INVALID_ARGUMENT.

UpdateSchemaMetadata

Son los metadatos de la LRO de UpdateSchema.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

UpdateSchemaRequest

Mensaje de solicitud para el método SchemaService.UpdateSchema.

Campos

schema

Schema

Obligatorio. Es el Schema que se actualizará.

allow_missing

bool

Si se configura como verdadero y no se encuentra el Schema, se crea un Schema nuevo. En esta situación, se ignora update_mask.

UpdateServingConfigRequest

Es la solicitud para el método UpdateServingConfig.

Campos

serving_config

ServingConfig

Obligatorio. ServingConfig que se actualizará.

update_mask

Indica qué campos del ServingConfig proporcionado se deben actualizar. NO se admiten los siguientes elementos:

ServingConfig.name

Si no se configura, se actualizarán todos los campos compatibles.

UpdateSessionRequest

Es la solicitud para el método UpdateSession.

Campos

session

Obligatorio. Es la sesión que se actualizará.

update_mask

Indica qué campos del Session proporcionado se deben actualizar. NO se admiten los siguientes elementos:

Session.name

Si no se configura o está vacío, se actualizan todos los campos compatibles.

UpdateTargetSiteMetadata

Son metadatos relacionados con el progreso de la operación SiteSearchEngineService.UpdateTargetSite. Este valor se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Es la fecha y hora de creación de la operación.

update_time

Fecha y hora de la última actualización de la operación. Si la operación finalizó, esta también es la hora de finalización.

UpdateTargetSiteRequest

Mensaje de solicitud para el método SiteSearchEngineService.UpdateTargetSite.

Campos

target_site