Package google.cloud.discoveryengine.v1

QueryClassificationInfo

Hora en la que se produjo esta búsqueda reciente.

score

double

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

AdvancedSiteSearchConfig

Datos de configuración de la búsqueda avanzada en el sitio.

Campos

disable_initial_index

bool

Si se le asigna el valor true, se inhabilita la indexación inicial de DataStore.

disable_automatic_refresh

bool

Si se le asigna el valor true, se inhabilita la actualización automática de DataStore.

AlertPolicyConfig

Configuración de alertas a nivel de conector.

Campos

alert_policy_name

string

Inmutable. Nombre completo del recurso AlertPolicy.

alert_enrollments[]

AlertEnrollment

Opcional. El estado de registro de cada alerta.

AlertEnrollment

Estado del registro de alertas.

Campos

alert_id

string

Inmutable. El ID de una alerta.

enroll_state

EnrollStates

Obligatorio. El estado de registro de un cliente.

EnrollStates

Enumeración del estado de registro de la alerta.

Enumeraciones
`ENROLL_STATES_UNSPECIFIED`	Valor predeterminado. Se usa para los clientes que no han respondido a la política de alertas.
`ENROLLED`	El cliente tiene habilitada esta política.
`DECLINED`	El cliente ha rechazado esta política.

AlertPolicyResourceConfig

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

Campos
`alert_policy`	`string` Inmutable. Nombre completo del recurso AlertPolicy.
`alert_enrollments[]`	`AlertEnrollment` Opcional. El estado de registro de cada alerta.
`contact_details[]`	`ContactDetails` Opcional. Los detalles de contacto de cada política de alertas.
`language_code`	`string` Opcional. El código de idioma que se usa en las notificaciones.

AlertEnrollment

Estado del registro de alertas.

Campos

alert_id

string

Inmutable. El ID de una alerta.

enroll_state

EnrollState

Obligatorio. El estado de registro de un cliente.

notification_params

map<string, string>

Opcional. Parámetros usados para crear una instancia de una notificación. Se usa para las notificaciones que se activan cuando se registra. No se almacenan. * Correos de bienvenida de Gemini Business. * Correos de invitación de usuarios de Gemini Business.

EnrollState

Enumeración del estado de registro de la alerta.

Enumeraciones
`ENROLL_STATE_UNSPECIFIED`	Valor predeterminado. Se usa para los clientes que no han respondido a la política de alertas.
`ENROLLED`	El cliente tiene habilitada esta política.
`DECLINED`	El cliente ha rechazado esta política.

AlloyDbSource

Fuente de la que se importan los datos de AlloyDB.

Campos
`project_id`	`string` El ID del proyecto que contiene la fuente de AlloyDB. Tiene un límite 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. La longitud máxima es de 256 caracteres.
`cluster_id`	`string` Obligatorio. El clúster de AlloyDB del que se copiarán los datos, con un límite de 256 caracteres.
`database_id`	`string` Obligatorio. La base de datos de AlloyDB de la que se van a copiar los datos. La longitud máxima es de 256 caracteres.
`table_id`	`string` Obligatorio. Tabla de AlloyDB de la que se copiarán los datos. La longitud máxima es de 256 caracteres.
`gcs_staging_dir`	`string` Directorio intermedio de Cloud Storage que se usa para la importación,con un límite de longitud de 2000 caracteres. Se puede especificar si se quiere que la exportación de AlloyDB se realice a un directorio de Cloud Storage concreto. 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 completo `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions//answers/`
`state`	`State` El estado de la generación de la respuesta.
`answer_text`	`string` La respuesta textual.
`citations[]`	`Citation` Citas.
`grounding_supports[]`	`GroundingSupport` Opcional. Se admiten las bases.
`references[]`	`Reference` Referencias.
`related_questions[]`	`string` Preguntas relacionadas sugeridas.
`steps[]`	`Step` Pasos para generar respuestas.
`query_understanding_info`	`QueryUnderstandingInfo` Información sobre la comprensión de las consultas.
`answer_skipped_reasons[]`	`AnswerSkippedReason` Motivos adicionales por los que se ha saltado la respuesta. Proporciona el motivo de los casos ignorados. Si no se omite nada, este campo no se define.
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de creación de la respuesta.
`complete_time`	`Timestamp` Solo de salida. Marca de tiempo de la respuesta completada.
`safety_ratings[]`	`SafetyRating` Opcional. Puntuaciones de seguridad.
`grounding_score`	`double` Puntuación en el intervalo [0, 1] que describe el grado de fundamentación de la respuesta en los fragmentos de referencia.

AnswerSkippedReason

Enumeración de los motivos por los que se ha saltado una respuesta.

Enumeraciones
`ANSWER_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se ha especificado el motivo por el que se ha saltado la respuesta.
`ADVERSARIAL_QUERY_IGNORED`	La consulta adversarial no distingue entre mayúsculas y minúsculas.
`NON_ANSWER_SEEKING_QUERY_IGNORED`	La consulta que no busca una respuesta no distingue entre mayúsculas y minúsculas Google omite la respuesta si la consulta es una conversación informal.
`OUT_OF_DOMAIN_QUERY_IGNORED`	La consulta fuera del dominio no distingue entre mayúsculas y minúsculas. Google omite la respuesta si no hay resultados de búsqueda de alta relevancia.
`POTENTIAL_POLICY_VIOLATION`	El caso de posible infracción de las políticas. Google omite la respuesta si detecta una posible infracción de las políticas. Esto incluye contenido que puede ser violento o tóxico.
`NO_RELEVANT_CONTENT`	El caso de que no haya contenido relevante. Google omite la respuesta si no hay contenido relevante en los resultados de búsqueda obtenidos.
`JAIL_BREAKING_QUERY_IGNORED`	La consulta para saltarse las restricciones no distinguía entre mayúsculas y minúsculas. Por ejemplo, "Responde con el tono del CEO de una empresa de la competencia". Google omite la respuesta si la consulta se clasifica como una consulta de jailbreak.
`CUSTOMER_POLICY_VIOLATION`	El caso de infracción de la política de clientes. Google omite el resumen si se detecta una infracción de la política para clientes. La política la define el cliente.
`NON_ANSWER_SEEKING_QUERY_IGNORED_V2`	La consulta que no busca una respuesta no distingue entre mayúsculas y minúsculas. Google omite la respuesta si la consulta no tiene una intención clara.
`LOW_GROUNDED_ANSWER`	La respuesta realista. Google omite la respuesta si no se ha podido generar una respuesta bien fundamentada.
`USER_DEFINED_CLASSIFICATION_QUERY_IGNORED`	Clasificación de consultas definida por el usuario que no distingue entre mayúsculas y minúsculas. Google omite la respuesta si la consulta se clasifica como una consulta definida por el usuario.
`UNHELPFUL_ANSWER`	El caso de la respuesta poco útil. Google se salta la respuesta si no es útil. Esto puede deberse a varios factores, como que no se pueda responder a la consulta, que la respuesta no sea pertinente o que no esté bien formateada.

Referencia

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 que no son ASCII, la medición del índice es mayor que la longitud de la cadena.

end_index

int64

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

sources[]

CitationSource

Fuentes de citas del segmento atribuido.

CitationSource

Fuente de la cita.

Campos

reference_id

string

ID de la fuente de la cita.

GroundingSupport

Basa tu ayuda en la evidencia recogida en answer_text.

Campos
`start_index`	`int64` Obligatorio. El índice indica el inicio de la reclamación, medido en bytes (Unicode UTF-8).
`end_index`	`int64` Obligatorio. Fin de la reclamación (no incluido).
`sources[]`	`CitationSource` Opcional. Fuentes de cita de la reclamación.
`grounding_score`	`double` Puntuación entre 0 y 1 que describe el grado de fundamentación de una afirmación específica en las referencias. Cuanto mayor sea el valor, más respaldada estará la afirmación por los fragmentos de referencia.
`grounding_check_required`	`bool` Indica que esta reclamación ha requerido una comprobación de la fundamentación. Si el sistema ha determinado que esta reclamación no requiere una comprobación de atribución o de fundamento, este campo se define como "false". En ese caso, no se ha realizado ninguna comprobación de la base de la afirmación y, por lo tanto, no se devuelve `grounding_score`, `sources`.

QueryUnderstandingInfo

Información sobre la comprensión de las consultas.

Campos

query_classification_info[]

Consultar información de clasificación.

QueryClassificationInfo

Consultar información de clasificación.

Campos

type

Type

Tipo de clasificación de la consulta.

positive

bool

Salida de clasificación.

Tipo

Tipos de clasificación de consultas.

Enumeraciones
`TYPE_UNSPECIFIED`	Tipo de clasificación de consulta no especificado.
`ADVERSARIAL_QUERY`	Tipo de clasificación de consultas adversarias.
`NON_ANSWER_SEEKING_QUERY`	Tipo de clasificación de consultas que no buscan respuestas, para conversaciones informales.
`JAIL_BREAKING_QUERY`	Tipo de clasificación de consultas de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de clasificación de consultas que no buscan respuestas, sin una intención clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de clasificación de consultas definido por el usuario.

Referencia

Referencia.

Campos
Campo de unión `content`. Contenido de los resultados de búsqueda. `content` solo puede ser una de estas dos opciones:
`unstructured_document_info`	`UnstructuredDocumentInfo` Información de documentos no estructurada.
`chunk_info`	`ChunkInfo` Información de los fragmentos.
`structured_document_info`	`StructuredDocumentInfo` Información estructurada del documento.

ChunkInfo

Información de los fragmentos.

Campos
`chunk`	`string` Nombre de recurso del fragmento.
`content`	`string` Divide el contenido textual en fragmentos.
`document_metadata`	`DocumentMetadata` Metadatos del documento.
`relevance_score`	`float` La relevancia del fragmento para una consulta determinada. Los valores van de 0,0 (totalmente irrelevante) a 1,0 (totalmente relevante). Este valor tiene un carácter meramente informativo. Puede cambiar en cualquier momento para la misma consulta y el mismo fragmento debido a un reentrenamiento del modelo o a un cambio en la implementación.

DocumentMetadata

Metadatos del documento.

Campos
`document`	`string` Nombre de recurso del documento.
`uri`	`string` URI del documento.
`title`	`string` Título.
`page_identifier`	`string` Identificador de la página.
`struct_data`	`Struct` Los metadatos JSON estructurados del documento. Se rellena con los datos estructurados del fragmento del resultado de búsqueda.

StructuredDocumentInfo

Información de búsqueda estructurada.

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

UnstructuredDocumentInfo

Información de documentos no estructurada.

Campos
`document`	`string` Nombre de recurso del documento.
`uri`	`string` URI del documento.
`title`	`string` Título.
`chunk_contents[]`	`ChunkContent` Lista de contenidos de fragmentos citados derivados del contenido del documento.
`struct_data`	`Struct` Los metadatos JSON estructurados del documento. Se rellena con los datos estructurados del fragmento del resultado de búsqueda.

ChunkContent

Contenido de fragmento.

Campos

content

string

Divide el contenido textual en fragmentos.

page_identifier

string

Identificador de la página.

relevance_score

float

La relevancia del fragmento para una consulta determinada. Los valores van de 0,0 (totalmente irrelevante) a 1,0 (totalmente relevante). Este valor tiene un carácter meramente informativo. Puede cambiar en cualquier momento para la misma consulta y el mismo fragmento debido a un reentrenamiento del modelo o a un cambio en la implementación.

Estado

Enumeración del estado de la generación de respuestas.

Enumeraciones
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	Se está generando la respuesta.
`FAILED`	No se ha podido generar la respuesta.
`SUCCEEDED`	La generación de respuestas se ha completado correctamente.
`STREAMING`	Se está generando la respuesta.

Paso

Información sobre el paso.

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

Acción

Acción.

Campos

observation

Observation

Observación.

Campo de unión action. La acción. action solo puede ser una de estas dos opciones:

search_action

SearchAction

Acción de búsqueda.

Observación

Observación.

Campos

search_results[]

SearchResult

Resultados de búsqueda observados por la acción de búsqueda. Pueden ser información de fragmentos o de bloques, según el tipo de cita que haya definido el usuario.

SearchResult

Campos
`document`	`string` Nombre de recurso del documento.
`uri`	`string` URI del documento.
`title`	`string` Título.
`snippet_info[]`	`SnippetInfo` Si citation_type es DOCUMENT_LEVEL_CITATION, rellena los fragmentos a nivel de documento.
`chunk_info[]`	`ChunkInfo` Si citation_type es CHUNK_LEVEL_CITATION y el modo de fragmento está activado, rellena la información del fragmento.
`struct_data`	`Struct` Representación de datos. Los datos JSON estructurados del documento. Se rellena con los datos estructurados del documento o del fragmento del resultado de búsqueda.

ChunkInfo

Información de los fragmentos.

Campos

chunk

string

Nombre de recurso del fragmento.

content

string

Divide el contenido textual en fragmentos.

relevance_score

float

SnippetInfo

Información del fragmento.

Campos

snippet

string

Contenido del fragmento.

snippet_status

string

Estado del fragmento definido por el equipo de búsqueda.

SearchAction

Acción de búsqueda.

Campos

query

string

Consulta de búsqueda.

Estado

Enumeración del estado del paso.

Enumeraciones
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	El paso está en curso.
`FAILED`	El paso ha fallado.
`SUCCEEDED`	El paso se ha completado correctamente.

AnswerGenerationSpec

Especificación para la generación de respuestas.

Campos

user_defined_classifier_spec

UserDefinedClassifierSpec

Opcional. Especificación del clasificador especificado por el usuario.

UserDefinedClassifierSpec

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. Preámbulo que se usará para el clasificador definido por el usuario.
`model_id`	`string` Opcional. ID del modelo que se va a usar en el clasificador definido por el usuario.
`task_marker`	`string` Opcional. El marcador de tarea que se va a usar en el clasificador definido por el usuario.
`top_p`	`double` Opcional. Valor de top_p que se usará en el clasificador definido por el usuario.
`top_k`	`int64` Opcional. El valor de los k elementos principales que se usará en el clasificador definido por el usuario.
`temperature`	`double` Opcional. Valor de temperatura que se usará en el clasificador definido por el usuario.
`seed`	`int32` Opcional. Valor de semilla que se usará en el clasificador definido por el usuario.

AnswerQueryRequest

Mensaje de solicitud del método ConversationalSearchService.AnswerQuery.

Campos
`serving_config`	`string` Obligatorio. Nombre del recurso de la configuración de servicio de 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 servicio, el conjunto de modelos que se usan para hacer la búsqueda.
`query`	`Query` Obligatorio. Consulta del usuario actual.
`session`	`string` Nombre de recurso de la sesión. No es obligatorio. Si no se define el campo de sesión, la API estará 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á un nuevo ID automáticamente.
`safety_spec`	`SafetySpec` Especificación del modelo.
`related_questions_spec`	`RelatedQuestionsSpec` Especificación de las preguntas relacionadas.
`grounding_spec`	`GroundingSpec` Opcional. Especificación de la fundamentación.
`answer_generation_spec`	`AnswerGenerationSpec` Especificación de generación de respuestas.
`search_spec`	`SearchSpec` Especificación de búsqueda.
`query_understanding_spec`	`QueryUnderstandingSpec` Especificación de la comprensión de consultas.
`asynchronous_mode (deprecated)`	`bool` Este elemento está obsoleto. Obsoleto: este campo está obsoleto. Se admitirá la API Streaming Answer. Control del modo asíncrono. Si está habilitada, la respuesta se devolverá con el nombre del recurso de respuesta o sesión sin la respuesta final. Los usuarios de la API deben hacer 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` Identificador único para hacer un seguimiento de los visitantes. Por ejemplo, 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 debería cambiar si el visitante inicia o cierra sesión en el sitio web. 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 devuelve un error `INVALID_ARGUMENT`.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta más información en el documento de Google Cloud.
`end_user_spec`	`EndUserSpec` Opcional. Especificación del usuario final.

AnswerGenerationSpec

Especificación de generación de respuestas.

Campos
`model_spec`	`ModelSpec` Especificación del modelo de generación de respuestas.
`prompt_spec`	`PromptSpec` Especificación de la petición de generación de respuestas.
`include_citations`	`bool` Especifica si se deben incluir los metadatos de las citas en la respuesta. El valor predeterminado es `false`.
`answer_language_code`	`string` Código de idioma de la respuesta. Usa etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental.
`ignore_adversarial_query`	`bool` Especifica si se deben filtrar las consultas adversarias. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar consultas adversarias. No se devuelve ninguna respuesta si la consulta de búsqueda se clasifica como consulta adversarial. Por ejemplo, un usuario puede hacer una pregunta sobre comentarios negativos sobre la empresa o enviar una consulta diseñada para generar contenido no seguro que infrinja las políticas. Si este campo tiene el valor `true`, no generaremos respuestas a consultas adversarias y devolveremos mensajes alternativos.
`ignore_non_answer_seeking_query`	`bool` Especifica si se deben filtrar las consultas que no buscan respuestas. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar las consultas que buscan respuestas. No se devuelve ninguna respuesta si la consulta de búsqueda se clasifica como una consulta que no busca una respuesta. Si este campo tiene el valor `true`, no generaremos respuestas para las consultas que no busquen respuestas y devolveremos mensajes alternativos.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica si se deben filtrar las consultas de jailbreak. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar consultas de jailbreak. No se devuelve ningún resumen si la consulta de búsqueda se clasifica como una consulta de jailbreak. Un usuario puede añadir instrucciones a la consulta para cambiar el tono, el estilo, el idioma o el contenido de la respuesta, o pedirle al modelo que actúe como otra entidad. Por ejemplo, "Responde con el tono del CEO de una empresa de la competencia". Si este campo tiene el valor `true`, no generaremos resúmenes para las consultas de jailbreaking y devolveremos mensajes alternativos.
`ignore_low_relevant_content`	`bool` Especifica si se deben filtrar las consultas que tengan poca relevancia. Si este campo tiene el valor `false`, se usarán todos los resultados de búsqueda, independientemente de su relevancia, para generar respuestas. Si se define como `true` o no se define, el servicio determinará el comportamiento automáticamente.

ModelSpec

Especificación del modelo de generación de respuestas.

Campos

model_version

string

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

PromptSpec

Especificación de la petición de generación de respuestas.

Campos

preamble

string

Preámbulo personalizado.

EndUserSpec

Especificación del usuario final.

Campos

end_user_metadata[]

EndUserMetaData

Opcional. Metadatos de usuario final.

EndUserMetaData

Metadatos de usuario final.

Campos

Campo de unión content. Contenido de los resultados de búsqueda. content solo puede ser una de estas dos opciones:

chunk_info

ChunkInfo

Información de los fragmentos.

ChunkInfo

Información de los fragmentos.

Campos

content

string

Divide el contenido textual en fragmentos. Tiene un límite de 8000 caracteres.

document_metadata

QueryClassificationSpec

Metadatos del documento del fragmento actual.

DocumentMetadata

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

Campos

title

string

Título del documento.

GroundingSpec

Especificación de la fundamentación.

Campos

include_grounding_supports

bool

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

Si este campo tiene el valor true, la respuesta devuelta tendrá el valor grounding_score y contendrá GroundingSupports para cada afirmación.

filtering_level

FilteringLevel

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

FilteringLevel

Nivel para filtrar en función de la base de la respuesta.

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

QueryUnderstandingSpec

Especificación de la comprensión de consultas.

Campos

query_classification_spec

Especificación de la clasificación de consultas.

query_rephraser_spec

QueryRephraserSpec

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

Especificación de la clasificación de consultas.

Campos

types[]

Type

Tipos de clasificación de consultas habilitados.

Tipo

Tipos de clasificación de consultas.

Enumeraciones
`TYPE_UNSPECIFIED`	Tipo de clasificación de consulta no especificado.
`ADVERSARIAL_QUERY`	Tipo de clasificación de consultas adversarias.
`NON_ANSWER_SEEKING_QUERY`	Tipo de clasificación de consultas que no buscan respuestas, para conversaciones informales.
`JAIL_BREAKING_QUERY`	Tipo de clasificación de consultas de jailbreak.
`NON_ANSWER_SEEKING_QUERY_V2`	Tipo de clasificación de consultas que no buscan respuestas, sin una intención clara.
`USER_DEFINED_CLASSIFICATION_QUERY`	Tipo de clasificación de consultas definido por el usuario.

QueryRephraserSpec

Especificación del reformulador de consultas.

Campos

disable

bool

Inhabilita la reformulación de consultas.

max_rephrase_steps

int32

Número máximo de pasos de reformulación. El número máximo es de 5 pasos. Si no se define o se le asigna un valor inferior a 1, se le asignará el valor 1 de forma predeterminada.

model_spec

ModelSpec

Opcional. Especificación del modelo de reformulación de consultas.

ModelSpec

Especificación del modelo de reformulación de consultas.

Campos

model_type

ModelType

Opcional. Tipo de modelo de reformulación de consultas habilitado. Si no se define, se usará LARGE de forma predeterminada.

ModelType

Tipos de reformuladores de consultas. Actualmente, solo se admiten selecciones de modelos de un solo salto (max_rephrase_steps = 1). En el caso de las peticiones de varias fases (max_rephrase_steps > 1), solo hay un modelo predeterminado.

Enumeraciones
`MODEL_TYPE_UNSPECIFIED`	Tipo de modelo no especificado.
`SMALL`	Modelo de reformulación de consultas pequeño. Modelo Gemini 1.0 XS.
`LARGE`	Modelo de reformulación de consultas grandes. Modelo Gemini 1.0 Pro.

RelatedQuestionsSpec

Especificación de las preguntas relacionadas.

Campos

enable

bool

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

SafetySpec

Especificación de seguridad. Hay dos casos prácticos: 1. Si solo se define safety_spec.enable, se aplicará el umbral BLOCK_LOW_AND_ABOVE a todas las categorías. 2. Cuando se define safety_spec.enable y se definen algunos safety_settings, solo se aplican los safety_settings especificados.

Campos

enable

bool

Habilita el filtro de seguridad en la respuesta. El valor predeterminado es "false".

safety_settings[]

SafetySetting

Opcional. Ajustes de seguridad. Estos ajustes solo se aplican cuando safety_spec.enable tiene el valor true.

SafetySetting

Ajustes de seguridad.

Campos

category

HarmCategory

Obligatorio. Categoría de daño.

threshold

HarmBlockThreshold

Obligatorio. Umbral de bloqueo de contenido dañino.

HarmBlockThreshold

Niveles de umbral basados en la probabilidad de bloqueo.

Enumeraciones
`HARM_BLOCK_THRESHOLD_UNSPECIFIED`	Umbral de bloqueo de daños no especificado.
`BLOCK_LOW_AND_ABOVE`	Bloquear el umbral bajo y los valores superiores (es decir, bloquear más contenido).
`BLOCK_MEDIUM_AND_ABOVE`	Bloquear el umbral medio y los superiores.
`BLOCK_ONLY_HIGH`	Bloquear solo el umbral alto (es decir, bloquear menos).
`BLOCK_NONE`	No bloquear nada.
`OFF`	Desactiva el filtro de seguridad.

SearchSpec

Especificación de búsqueda.

Campos

Campo de unión input. Parámetros de búsqueda para controlar el comportamiento de la búsqueda. También puedes proporcionar una lista de resultados de búsqueda para generar una respuesta. input solo puede ser una de estas dos opciones:

search_params

SearchParams

Parámetros de búsqueda.

search_result_list

SearchResultList

Lista de resultados de búsqueda.

SearchParams

Parámetros de búsqueda.

Campos
`max_return_results`	`int32` Número de resultados de búsqueda que se devolverán. El valor predeterminado es 10.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los documentos que se van a filtrar. La expresión de filtro distingue entre mayúsculas y minúsculas. Se usará para filtrar los resultados de búsqueda, lo que puede afectar a la respuesta. Si este campo no se reconoce, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave de filtro del lado izquierdo a una propiedad de 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 sería el siguiente: filter --> name:'ANY("king kong")' Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtrar.
`boost_spec`	`BoostSpec` Especificación de impulso para impulsar determinados documentos en los resultados de búsqueda, lo que puede afectar a la respuesta de la consulta. Para obtener más información sobre el aumento, consulta Aumento.
`order_by`	`string` El orden en el que se devuelven los documentos. Los documentos se pueden ordenar por un campo de un objeto `Document`. Déjalo sin definir si los resultados se ordenan por relevancia. La expresión `order_by` distingue entre mayúsculas y minúsculas. Para obtener más información sobre los pedidos, consulta la sección Pedidos. Si este campo no se reconoce, se devuelve un `INVALID_ARGUMENT`.
`search_result_mode`	`SearchResultMode` Especifica el modo de resultados de búsqueda. Si no se especifica, el modo de resultado de búsqueda predeterminado es `DOCUMENTS`. Consulta Analizar y dividir documentos en fragmentos.
`data_store_specs[]`	`DataStoreSpec` Especificaciones que definen los almacenes de datos que se van a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en el caso práctico de los motores con varios almacenes de datos. Si solo hay un almacén de datos en un motor, deben usar las especificaciones de nivel superior.

SearchResultList

Lista de resultados de búsqueda.

Campos

search_results[]

SearchResult

Resultados de búsqueda.

SearchResult

Resultado de búsqueda.

Campos

Campo de unión content. Contenido de los resultados de búsqueda. content solo puede ser una de estas dos opciones:

unstructured_document_info

UnstructuredDocumentInfo

Información de documentos no estructurada.

chunk_info

ChunkInfo

Información de los fragmentos.

ChunkInfo

Información de los fragmentos.

Campos

chunk

string

Nombre de recurso del fragmento.

content

string

Divide el contenido textual en fragmentos.

document_metadata

Metadatos del documento del fragmento actual.

DocumentMetadata

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

Campos

uri

string

URI del documento.

title

string

Título del documento.

UnstructuredDocumentInfo

Información de documentos no estructurada.

Campos
`document`	`string` Nombre de recurso del documento.
`uri`	`string` URI del documento.
`title`	`string` Título.
`document_contexts[]`	`DocumentContext` Lista de contextos de documentos. El contenido se usará para generar respuestas. Se trata del contenido principal del documento, que puede ser largo y completo.
`extractive_segments[]`	`ExtractiveSegment` 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. Lista de respuestas extractivas.

DocumentContext

Contexto del documento.

Campos

page_identifier

string

Identificador de la página.

content

string

Contenido del documento que se usará para generar respuestas.

ExtractiveAnswer

Respuesta extractiva. Guía

Campos

page_identifier

string

Identificador de la página.

content

string

Contenido de la respuesta extractiva.

ExtractiveSegment

Segmento extractivo. Guía: La generación de respuestas solo lo usará si document_contexts está vacío. Se supone que deben ser fragmentos más cortos.

Campos

page_identifier

string

Identificador de la página.

content

string

Contenido de segmentos extractivos.

AnswerQueryResponse

Mensaje de respuesta del método ConversationalSearchService.AnswerQuery.

Campos

answer

Answer

Objeto de recurso de respuesta. Si AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps es mayor que 1, usa Answer.name para obtener información de la respuesta mediante la API ConversationalSearchService.GetAnswer.

session

PolicyEnforcementResult

Objeto de recurso de sesión. Solo estará disponible cuando el campo de sesión se haya definido y sea válido en la solicitud AnswerQueryRequest.

answer_query_token

string

Un ID único global que se usa para registrar eventos.

AssistAnswer

Recurso AssistAnswer, parte principal de AssistResponse.

Campos
`name`	`string` Inmutable. Identificador. Nombre de recurso de `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 1024 caracteres.
`state`	`State` Estado de la generación de la respuesta.
`replies[]`	`Reply` Respuestas del asistente.
`assist_skipped_reasons[]`	`AssistSkippedReason` Motivos por los que no se ha respondido a la llamada de asistencia.
`customer_policy_enforcement_result`	`CustomerPolicyEnforcementResult` Opcional. Este campo contiene información sobre los resultados de las distintas comprobaciones de políticas, como las frases prohibidas o las comprobaciones de Model Armor. Este campo solo se rellena si se ha omitido la llamada de asistencia debido a una infracción de las políticas.

AssistSkippedReason

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

Enumeraciones
`ASSIST_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se ha especificado el motivo para saltar el anuncio.
`NON_ASSIST_SEEKING_QUERY_IGNORED`	El asistente ha ignorado la consulta porque no parecía que el usuario estuviera buscando una respuesta.
`CUSTOMER_POLICY_VIOLATION`	El asistente ha ignorado la consulta o se ha negado a responder debido a una infracción de las políticas de clientes (por ejemplo, la consulta o la respuesta contenían una frase prohibida).

CustomerPolicyEnforcementResult

Resultados del cumplimiento de las políticas de clientes. Contiene los resultados de las distintas comprobaciones de las políticas, como las frases prohibidas o las comprobaciones de Model Armor.

Campos

verdict

Verdict

Veredicto final sobre el cumplimiento de la política de clientes. Si solo una política ha bloqueado el procesamiento, el veredicto es BLOQUEAR.

policy_results[]

Resultados del cumplimiento de las políticas de clientes. Se rellena solo si se ha omitido la llamada de asistencia debido a una infracción de las políticas. Contiene los resultados de los filtros que han bloqueado el procesamiento de la consulta.

BannedPhraseEnforcementResult

Resultado de la aplicación de la política de clientes para la política de frases prohibidas.

Campos

banned_phrases[]

string

Las frases prohibidas que se han encontrado en la consulta o en la respuesta.

ModelArmorEnforcementResult

Resultado de la aplicación de la política de clientes de la política Model Armor.

Campos

Campo de unión result. El resultado de la política de Model Armor. result solo puede ser una de estas dos opciones:

model_armor_violation

string

La infracción de Model Armor que se ha detectado.

error

BannedPhraseEnforcementResult

Error devuelto por Model Armor si no se ha podido aplicar la política por algún motivo.

PolicyEnforcementResult

Resultado de la aplicación de la política de cliente para un solo tipo de política.

Campos

Campo de unión enforcement_result. El resultado específico del tipo de política. Puede ser un error o información detallada sobre el resultado de la medida por incumplimiento de políticas. enforcement_result solo puede ser una de estas dos opciones:

banned_phrase_enforcement_result

El resultado de la aplicación de la política de frases prohibidas.

model_armor_enforcement_result

ModelArmorEnforcementResult

Resultado de la aplicación de la política Model Armor.

Veredicto

El veredicto de la medida por incumplimiento de la política de clientes.

Enumeraciones
`UNSPECIFIED`	Valor desconocido.
`ALLOW`	No se ha infringido ninguna política.
`BLOCK`	El procesamiento se ha bloqueado por infringir la política de clientes.

Responder

Una parte de la respuesta de varias partes de la llamada de asistencia.

Campos

Campo de unión reply. Alternativas para la respuesta del asistente. reply solo puede ser una de estas dos opciones:

grounded_content

AssistantGroundedContent

Texto o contenido multimedia de respuesta posiblemente fundamentado del asistente.

Estado

Estado de la generación de la respuesta.

Enumeraciones
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	La operación de asistencia está en curso.
`FAILED`	No se ha podido realizar la operación de asistencia.
`SUCCEEDED`	La operación de asistencia se ha realizado correctamente.
`SKIPPED`	Se ha omitido la operación de asistencia.

AssistRequest

Solicitud del método AssistantService.Assist.

Campos
`name`	`string` Obligatorio. Nombre de recurso de `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta del usuario actual. Las consultas vacías solo se admiten si se proporcionan `file_ids`. En este caso, la respuesta se generará a partir de esos archivos de contexto.
`session`	`string` Opcional. La sesión que se va a usar en la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la consulta y la respuesta se almacenan ahí. Si se especifica `-` como ID de sesión o se deja vacío, se crea una sesión 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á a la consulta. Si se omite la respuesta, los motivos se mostrarán en `AssistAnswer.assist_skipped_reasons` dentro de `AssistResponse.answer`.
`file_ids[]`	`string` Opcional. Los IDs de los archivos que se usarán para responder a la solicitud. Al subir un archivo, su ID se devuelve en `AddContextFileResponse.file_id`.
`user_metadata`	`AssistUserMetadata` Opcional. Información sobre el usuario que inicia la consulta.

AssistSkippingMode

Comportamientos de omisión disponibles para las solicitudes de asistencia.

Enumeraciones
`ASSIST_SKIPPING_MODE_UNSPECIFIED`	Valor predeterminado. La respuesta se puede omitir si la consulta no busca asistencia.
`REQUEST_ASSIST`	Solicita la respuesta del Asistente. La respuesta se puede omitir si la consulta no supera las comprobaciones de las políticas.

AssistResponse

Respuesta del método AssistantService.Assist.

Campos

answer

AssistAnswer

El recurso AssistAnswer generado en respuesta a la consulta.

session_info

SessionInfo

Información de la sesión.

assist_token

string

Un ID único global que identifica el par de solicitud y respuesta actual. Se usa para enviar comentarios y recibir asistencia.

SessionInfo

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

ID de consulta que corresponde a esta llamada a la API de asistencia. Una sesión puede tener varias interacciones, cada una con un ID de consulta único.

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

AssistUserMetadata

Metadatos del usuario de la solicitud.

Campos

time_zone

string

Opcional. Zona horaria de IANA, por ejemplo, Europe/Budapest.

preferred_language_code

string

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

Asistente

Recurso de Discovery Engine Assistant.

Campos
`name`	`string` Inmutable. Nombre de 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 1024 caracteres.
`display_name`	`string` Obligatorio. Nombre visible del asistente. Debe ser una cadena codificada en UTF-8 con una longitud máxima de 128 caracteres.
`description`	`string` Opcional. Descripción de la información adicional. Se espera que se muestre en la interfaz de configuración, no a los usuarios del asistente.
`generation_config`	`GenerationConfig` Opcional. Configuración para la generación de la respuesta del asistente.
`google_search_grounding_enabled (deprecated)`	`bool` Este elemento está obsoleto. Opcional. Obsoleto. En su lugar, usa `web_grounding_type`.
`web_grounding_type`	`WebGroundingType` Opcional. El tipo de base web que se va a usar.
`enabled_actions (deprecated)`	`map<string, ActionList>` Este elemento está obsoleto. Opcional. Obsoleto: se sustituirá por `enabled_tools`. Las acciones habilitadas en este asistente. Las claves son el nombre del conector (por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector"). Los valores son las acciones habilitadas por el administrador en la instancia del conector. El administrador puede habilitar de forma selectiva varias acciones en cualquiera de las instancias de conector que haya creado en el proyecto. Por ejemplo, {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
`enabled_tools`	`map<string, ToolList>` Opcional. Nota: Aún no se ha implementado. En su lugar, usa `enabled_actions`. Las herramientas habilitadas en este asistente. Las claves son el nombre del conector (por ejemplo, "projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector"). Los valores son las herramientas habilitadas por el administrador para la instancia del conector. Los administradores pueden habilitar de forma selectiva varias herramientas en cualquiera de las instancias de conector que hayan creado en el proyecto. Por ejemplo, {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
`customer_policy`	`CustomerPolicy` Opcional. Política de clientes del asistente.

ActionInfo

Obsoleto: se sustituirá por ToolInfo. 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

Nombre visible de la acción.

ActionList

Obsoleto: se sustituirá por ToolList. Las acciones habilitadas en un conector

Campos

action_info[]

ActionInfo

Lista de acciones con la información correspondiente.

CustomerPolicy

Política definida por el cliente para el asistente.

Campos

banned_phrases[]

BannedPhrase

Opcional. Lista de frases prohibidas.

model_armor_config

ModelArmorConfig

Opcional. Configuración de Model Armor que se usará para desinfectar las peticiones de los usuarios y las respuestas del asistente.

BannedPhrase

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

Campos

phrase

string

Obligatorio. El contenido de la cadena sin formato que se va a prohibir.

match_type

BannedPhraseMatchType

Opcional. Tipo de concordancia de la frase prohibida.

ignore_diacritics

bool

Opcional. Si se le asigna el valor true, las marcas diacríticas (por ejemplo, los acentos y las diéresis) se ignoran al buscar coincidencias con frases prohibidas. Por ejemplo, "cafe" coincidiría con "café".

BannedPhraseMatchType

El método de coincidencia de la frase prohibida.

Enumeraciones
`BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED`	El valor predeterminado 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 encontrado en el texto está rodeado de delimitadores de palabras. La frase en sí puede seguir conteniendo delimitadores de palabras.

ModelArmorConfig

Configuración de las plantillas de Model Armor definidas por el cliente que se usarán para desinfectar las peticiones de los usuarios y las respuestas del asistente.

Campos

user_prompt_template

string

Opcional. Nombre de recurso de la plantilla de Model Armor para sanear las peticiones de los usuarios. Formato: projects/{project}/locations/{location}/templates/{template_id}

Si no se especifica, no se aplicará ninguna medida de protección al mensaje del usuario.

response_template

string

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

Si no se especifica, no se aplicará ninguna medida de protección a la respuesta del asistente.

failure_mode

FailureMode

Opcional. Define el modo de fallo de la sanitización de Model Armor.

FailureMode

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

Enumeraciones
`FAILURE_MODE_UNSPECIFIED`	Modo de fallo no especificado. El comportamiento predeterminado es `FAIL_CLOSED`.
`FAIL_OPEN`	En caso de que falle el procesamiento de Model Armor, la solicitud podrá continuar sin ningún cambio.
`FAIL_CLOSED`	Si se produce un error de procesamiento de Model Armor, la solicitud se rechaza.

GenerationConfig

Configuración para la generación de la respuesta del asistente.

Campos

system_instruction

SystemInstruction

Instrucción del sistema, también conocida como preámbulo de la petición para las llamadas a LLMs. Consulta también https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions.

default_language

string

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

Instrucción del sistema, también conocida como preámbulo de la petición para las llamadas a LLMs.

Campos

additional_system_instruction

string

Opcional. Instrucción adicional del sistema que se añadirá a la instrucción predeterminada del sistema.

ToolInfo

Información para identificar una herramienta.

Campos

tool_name

string

El nombre de la herramienta tal como lo define DataConnectorService.QueryAvailableActions. Nota: Se usa action en las APIs de DataConnectorService, pero es lo mismo que tool.

tool_display_name

string

El nombre visible de la herramienta.

ToolList

Las herramientas habilitadas en un conector

Campos

tool_info[]

ToolInfo

La lista de herramientas con la información correspondiente.

WebGroundingType

El tipo de base web que se va a usar.

Enumeraciones
`WEB_GROUNDING_TYPE_UNSPECIFIED`	Ajuste predeterminado o 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 función de fundamentación con la búsqueda web para empresas está habilitada.

AssistantContent

Contenido multimodal.

Campos
`role`	`string` El productor del contenido. Puede ser "model" o "user".
`thought`	`bool` Opcional. Indica si el modelo ha pensado en la parte.
Campo de unión `data`. Datos incluidos. `data` solo puede ser una de estas dos opciones:
`text`	`string` Texto insertado.
`inline_data`	`Blob` Datos binarios insertados.
`file`	`File` Un archivo, por ejemplo, un resumen de audio.
`executable_code`	`ExecutableCode` Código generado por el modelo que se debe ejecutar.
`code_execution_result`	`CodeExecutionResult` Resultado de la ejecución de un ExecutableCode.

Blob

Blob insertado.

Campos

mime_type

string

Obligatorio. El tipo de contenido (tipo MIME) de los datos generados.

data

bytes

Obligatorio. Bytes sin procesar.

CodeExecutionResult

Resultado de la ejecución de ExecutableCode.

Campos

outcome

Outcome

Obligatorio. Resultado de la ejecución del código.

output

string

Opcional. Contiene stdout cuando la ejecución del código se realiza correctamente; de lo contrario, contiene stderr u otra descripción.

Resultado

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

Enumeraciones
`OUTCOME_UNSPECIFIED`	Estado no especificado. Este valor no se debe usar.
`OUTCOME_OK`	La ejecución del código se ha completado correctamente.
`OUTCOME_FAILED`	La ejecución del código ha finalizado, pero se ha producido un error. `stderr` debe contener el motivo.
`OUTCOME_DEADLINE_EXCEEDED`	La ejecución del código ha tardado demasiado y se ha cancelado. Puede que haya o no una salida parcial.

ExecutableCode

Código generado por el modelo que está diseñado para que lo ejecute el modelo.

Campos

code

string

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

Archivo

Un archivo, por ejemplo, un resumen de audio.

Campos

mime_type

string

Obligatorio. El tipo de medio (tipo MIME) del archivo.

file_id

string

Obligatorio. El ID del archivo.

AssistantGroundedContent

Un contenido y, posiblemente, su información de base.

No todo el contenido necesita una base. No es necesario fundamentar frases como "Por supuesto, lo buscaré con gusto".

Campos
`content`	`AssistantContent` El contenido.
`citation_metadata`	`CitationMetadata` 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. Metadatos del contenido. Actualmente solo se usa para las respuestas de los asistentes de investigación.
Campo de unión `metadata`. Metadatos de base para varias ventanas modales. Por ahora, solo admite texto. `metadata` solo puede ser una de estas dos opciones:
`text_grounding_metadata`	`TextGroundingMetadata` Metadatos para fundamentar la información a partir de fuentes de texto.

ContentMetadata

Metadatos del contenido.

Campos

content_kind

ContentKind

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

content_id

string

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

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

Enumeraciones
`CONTENT_KIND_UNSPECIFIED`	Desconocido.
`RESEARCH_PLAN`	Plan de investigación.
`RESEARCH_QUESTION`	Pregunta de investigación.
`RESEARCH_ANSWER`	Respuesta de investigación.
`RESEARCH_REPORT`	Informe de investigación.
`RESEARCH_AUDIO_SUMMARY`	Resumen de audio de investigación.

TextGroundingMetadata

Detalles de la fundamentación de las fuentes de texto.

Campos

segments[]

Segment

Información de base de partes del texto.

references[]

Reference

Referencias del texto fundamentado.

Referencia

Contenido referenciado y metadatos de documentos relacionados.

Campos

content

string

Contenido de texto de referencia.

document_metadata

Metadatos del documento.

DocumentMetadata

Metadatos del documento.

Campos
`document`	`string` Nombre de recurso del documento.
`uri`	`string` URI del documento. Puede contener una URL que redirija al sitio web real.
`title`	`string` Título.
`page_identifier`	`string` 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 redirija al sitio web real, en cuyo caso contendrá el nombre de dominio del sitio de destino.
`mime_type`	`string` El tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml

Segmento

Información de fundamentación de un segmento del texto.

Campos
`start_index`	`int64` Índice de base 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 superior a uno).
`end_index`	`int64` Fin del segmento, exclusivo.
`reference_indices[]`	`int32` Referencias del segmento.
`grounding_score`	`float` Puntuación del segmento.
`text`	`string` El segmento de texto en sí.

BAPConfig

La configuración del conector de BAP.

Campos

supported_connector_modes[]

ConnectorMode

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

enabled_actions[]

string

Opcional. Las acciones habilitadas en la conexión BAP asociada.

ConnectorMode

Casos prácticos admitidos por este conector de BAP.

Enumeraciones
`CONNECTOR_MODE_UNSPECIFIED`	Modo de conector no especificado.
`DATA_INGESTION`	Conector utilizado para la ingestión de datos.
`ACTIONS`	Conector utilizado para las acciones
`END_USER_AUTHENTICATION`	Conector utilizado para la autenticación de usuarios finales.

BatchCreateTargetSiteMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.BatchCreateTargetSites. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

CreateTargetSiteRequest

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

BatchCreateTargetSitesRequest

Mensaje de solicitud del método SiteSearchEngineService.BatchCreateTargetSites.

Campos

parent

string

Obligatorio. El recurso superior compartido por todos los TargetSites que se están creando. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. El campo parent de los mensajes CreateBookRequest debe estar vacío o coincidir con este campo.

requests[]

Obligatorio. Mensaje de solicitud que especifica los recursos que se van a crear. Se pueden crear hasta 20 TargetSites en un lote.

BatchCreateTargetSitesResponse

Mensaje de respuesta del método SiteSearchEngineService.BatchCreateTargetSites.

Campos

target_sites[]

TargetSites created.

BatchGetDocumentsMetadataRequest

Mensaje de solicitud del método DocumentService.BatchGetDocumentsMetadata.

Campos

parent

string

Obligatorio. Nombre de recurso de la rama superior, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

matcher

Matcher

Obligatorio. Objeto de comparación de Document.

FhirMatcher

Matcher de los Documents por nombres de recursos FHIR.

Campos

fhir_resources[]

string

Obligatorio. Los recursos FHIR por los que se va a buscar coincidencias. Formato: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

Objeto de comparación

Objeto de comparación de Document. Actualmente, solo se admite la coincidencia por URIs exactos.

Campos

Campo de unión matcher. Objeto de comparación de Document. matcher solo puede ser una de estas dos opciones:

uris_matcher

UrisMatcher

Matcher por URIs exactos.

fhir_matcher

FhirMatcher

Matcher por nombres de recursos FHIR.

UrisMatcher

Matcher para los Documents por URIs exactas.

Campos

uris[]

string

Los URIs exactos con los que se debe buscar coincidencias.

BatchGetDocumentsMetadataResponse

Mensaje de respuesta del método DocumentService.BatchGetDocumentsMetadata.

Campos

documents_metadata[]

Los metadatos de los Documents.

DocumentMetadata

Los metadatos de un Document.

Campos
`matcher_value`	`MatcherValue` El valor del elemento de coincidencia que se ha usado para buscar la `Document`.
`state`	`State` El estado del documento.
`last_refreshed_time`	`Timestamp` Marca de tiempo de la última vez que se indexó `Document`.
`data_ingestion_source`	`string` La fuente de ingesta de datos de `Document`. Los valores permitidos son: `batch`: datos insertados mediante la API Batch, por ejemplo: ImportDocuments. `streaming` Datos insertados mediante la API Streaming, por ejemplo: Streaming de FHIR.

MatcherValue

El valor del elemento de coincidencia que se ha usado para buscar la Document.

Campos

Campo de unión matcher_value. El valor del elemento de coincidencia que se ha usado para buscar la Document. matcher_value solo puede ser una de estas dos opciones:

uri

string

Si se trata de una coincidencia por URI, el URI de Document.

fhir_resource

string

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

Estado

El estado de Document.

Enumeraciones
`STATE_UNSPECIFIED`	No se debe definir nunca.
`INDEXED`	El `Document` está indexado.
`NOT_IN_TARGET_SITE`	La `Document` no está indexada porque su URI no está en el `TargetSite`.
`NOT_IN_INDEX`	No se indexa `Document`.

BatchUpdateUserLicensesMetadata

Metadatos relacionados con el progreso de la operación UserLicenseService.BatchUpdateUserLicenses. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de licencias de usuario actualizadas correctamente.
`failure_count`	`int64` Número de licencias de usuario que no se han podido actualizar.

BatchUpdateUserLicensesRequest

Mensaje de solicitud del método UserLicenseService.BatchUpdateUserLicenses.

Campos
`parent`	`string` Obligatorio. Nombre del recurso [UserStore][] principal. Formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`delete_unassigned_user_licenses`	`bool` Opcional. Si es true, si las licencias de usuario eliminan la configuración de licencia asociada, la licencia de usuario se eliminará. De forma predeterminada, el valor es false y la licencia de usuario se actualizará al estado sin asignar.
Campo de unión `source`. Obligatorio. La fuente de la entrada. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` El origen insertado del contenido de entrada de las inserciones de documentos.

InlineSource

Fuente insertada de la configuración de entrada del método BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

Obligatorio. Lista de licencias de usuario que se van a actualizar. Cada licencia de usuario debe tener un UserLicense.user_principal válido.

update_mask

Opcional. Lista de campos que se van a actualizar.

BatchUpdateUserLicensesResponse

Mensaje de respuesta del método UserLicenseService.BatchUpdateUserLicenses.

Campos

user_licenses[]

UserLicense

UserLicenses se ha actualizado correctamente.

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

BatchVerifyTargetSitesMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.BatchVerifyTargetSites. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

BatchVerifyTargetSitesRequest

Mensaje de solicitud del método SiteSearchEngineService.BatchVerifyTargetSites.

Campos

parent

string

Obligatorio. El recurso principal compartido por todos los TargetSites que se están verificando. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

Este tipo no tiene campos.

Mensaje de respuesta del método SiteSearchEngineService.BatchVerifyTargetSites.

BigQuerySource

Fuente de BigQuery de la que se importan los datos.

Campos
`project_id`	`string` El ID o el número del proyecto que contiene la fuente de BigQuery. Tiene un límite de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`dataset_id`	`string` Obligatorio. Conjunto de datos de BigQuery del que se copiarán los datos. La longitud máxima es de 1024 caracteres.
`table_id`	`string` Obligatorio. Tabla de BigQuery de la que se copiarán los datos. La longitud máxima es de 1024 caracteres.
`gcs_staging_dir`	`string` Directorio intermedio de Cloud Storage que se usa para la importación,con un límite de longitud de 2000 caracteres. Se puede especificar si se quiere que la exportación de BigQuery se haga a un directorio de Cloud Storage concreto.
`data_schema`	`string` Esquema que se usa al analizar 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 elementos: `Document.json_data` o `Document.struct_data`. `custom`: un dato personalizado por fila en un formato arbitrario que se ajuste al `Schema` definido del almacén de datos. Solo puede usarlo la vertical GENERIC Data Store.
Campo de unión `partition`. Información de la partición de la tabla de BigQuery. Deje este campo vacío si la tabla de BigQuery no tiene particiones. `partition` solo puede ser una de estas dos opciones:
`partition_date`	`Date` _PARTITIONDATE de la tabla con particiones por tiempo de BigQuery en formato AAAA-MM-DD.

BigtableOptions

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>

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

BigtableColumn

La columna de Bigtable.

Campos
`qualifier`	`bytes` Obligatorio. Calificador de la columna. Si no se puede decodificar con UTF-8, utilice 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 define, se analiza a partir de los bytes del calificador con el mejor esfuerzo posible. Sin embargo, debido a los diferentes patrones de nomenclatura, podrían producirse colisiones de nombres de campos, en las que el comportamiento de análisis no está definido.
`encoding`	`Encoding` Modo de codificación de los valores cuando el tipo no es `STRING`. Los valores de codificación aceptados son: `TEXT`: indica que los valores son cadenas de texto alfanuméricas. `BINARY`: indica que los valores se codifican mediante la familia de funciones `HBase Bytes.toBytes`. Esto se puede anular en una columna específica incluyéndola en `columns` y especificando una codificación para ella.
`type`	`Type` El tipo de valores de esta familia de columnas. Los valores deben codificarse con la función `HBase Bytes.toBytes` cuando el valor de codificación sea `BINARY`.

BigtableColumnFamily

La familia de columnas de Bigtable.

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

Codificación

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

Enumeraciones
`ENCODING_UNSPECIFIED`	No se ha especificado la codificación.
`TEXT`	Codificación de texto.
`BINARY`	Codificación binaria.

Tipo

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

Enumeraciones
`TYPE_UNSPECIFIED`	El tipo no está especificado.
`STRING`	Tipo de cadena.
`NUMBER`	Tipo numérico.
`INTEGER`	Tipo entero.
`VAR_INTEGER`	Tipo de entero de longitud variable.
`BIG_NUMERIC`	Tipo BigDecimal.
`BOOLEAN`	Tipo booleano.
`JSON`	Tipo JSON.

BigtableSource

La fuente de Cloud Bigtable para importar datos.

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

CheckGroundingRequest

Mensaje de solicitud del método GroundedGenerationService.CheckGrounding.

Campos
`grounding_config`	`string` Obligatorio. Nombre de recurso de la configuración de grounding, como `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Respuesta del candidato que se va a comprobar. Puede tener una longitud máxima de 4096 tokens.
`facts[]`	`GroundingFact` Lista de datos para la comprobación de la base. Admitimos hasta 200 datos.
`grounding_spec`	`CheckGroundingSpec` Configuración de la comprobación de la información de base.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta más información en el documento de Google Cloud.

CheckGroundingResponse

Mensaje de respuesta del método GroundedGenerationService.CheckGrounding.

Campos
`cited_chunks[]`	`FactChunk` Lista de hechos citados en todas las reclamaciones de la respuesta candidata. Se derivan de los datos proporcionados en la solicitud.
`cited_facts[]`	`CheckGroundingFactChunk` Lista de hechos citados en todas las reclamaciones de la respuesta candidata. Se derivan de los datos proporcionados en la solicitud.
`claims[]`	`Claim` Textos de reclamaciones e información de citas de todas las reclamaciones de la respuesta candidata.
`support_score`	`float` Puntuación de asistencia de la respuesta candidata introducida. Cuanto mayor sea la puntuación, mayor será la fracción de las afirmaciones que se respalden con los datos proporcionados. Este valor siempre se asigna cuando se devuelve una respuesta.

CheckGroundingFactChunk

Fragmento de información para la comprobación de la base fáctica.

Campos

chunk_text

string

Contenido de texto del fragmento de información. Puede tener como máximo 10.000 caracteres.

Reclamar

Texto e información de la cita de una afirmación en la respuesta candidata.

Campos
`claim_text`	`string` Texto de la reclamación en la respuesta candidata. Se proporciona siempre, independientemente de si se encuentran citas o anticitas.
`citation_indices[]`	`int32` Lista de índices (en "cited_chunks") que especifican las citas asociadas a la reclamación. Por ejemplo, [1,3, 4] significa que los hechos citados que respaldan la afirmación son cited_chunks[1], cited_chunks[3] y cited_chunks[4]. Una cita de un hecho indica que la afirmación se basa en ese hecho.
`start_pos`	`int32` Posición que indica el inicio de la reclamación en la respuesta candidata, medida en bytes. Ten en cuenta que no se mide en caracteres y, por lo tanto, debe renderizarse en la interfaz de usuario teniendo en cuenta que algunos caracteres pueden ocupar más de un byte. Por ejemplo, si el texto de la reclamación contiene caracteres no ASCII, las posiciones de inicio y fin varían si se miden en caracteres (depende del lenguaje de programación) o en bytes (no depende del lenguaje de programación).
`end_pos`	`int32` Posición que indica el final de la reclamación en el candidato de respuesta, exclusiva, en bytes. Ten en cuenta que no se mide en caracteres y, por lo tanto, debe renderizarse como tal. Por ejemplo, si el texto de la reclamación contiene caracteres no ASCII, las posiciones de inicio y fin varían si se miden en caracteres (depende del lenguaje de programación) o en bytes (no depende del lenguaje de programación).
`grounding_check_required`	`bool` Indica que esta reclamación ha requerido una comprobación de la fundamentación. Si el sistema determina que esta reclamación no requiere una comprobación de atribución o de fundamento, este campo se definirá como "false". En ese caso, no se ha realizado ninguna comprobación de la base de conocimientos de la reclamación y, por lo tanto, no se debería devolver `citation_indices`.
`score`	`double` Puntuación de confianza de la afirmación en la respuesta candidata, en el intervalo [0, 1]. Este valor solo se define cuando `CheckGroundingRequest.grounding_spec.enable_claim_level_score` es true.

CheckGroundingSpec

Especificación de la comprobación de puesta a tierra.

Campos

citation_threshold

double

Umbral (en [0,1]) que se usa para determinar si se debe citar un dato para una afirmación en la respuesta candidata. Si elige un umbral más alto, obtendrá menos citas, pero serán muy sólidas. Si elige un umbral más bajo, obtendrá más citas, pero serán algo más débiles. Si no se define, el umbral será 0,6 de forma predeterminada.

enable_claim_level_score

bool

Marca de control que habilita la puntuación de fundamentación a nivel de reclamación en la respuesta.

Chunk

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

Campos
`name`	`string` 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 1024 caracteres.
`id`	`string` ID único del fragmento actual.
`content`	`string` Content es una cadena de un documento (contenido analizado).
`document_metadata`	`DocumentMetadata` Metadatos del documento del fragmento actual.
`derived_struct_data`	`Struct` Solo de salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no están en el documento de entrada original.
`page_span`	`PageSpan` Intervalo de páginas del fragmento.
`chunk_metadata`	`ChunkMetadata` Solo de salida. Metadatos del fragmento actual.
`data_urls[]`	`string` Solo de salida. URLs de datos de imagen si el fragmento actual contiene imágenes. Las URLs de datos se componen de cuatro partes: un prefijo (data:), un tipo 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 de salida. Contenido de la anotación si el fragmento actual contiene anotaciones.
`annotation_metadata[]`	`AnnotationMetadata` Solo de salida. Los metadatos de la anotación incluyen contenido estructurado en el fragmento actual.
`relevance_score`	`double` Solo de 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 intervalo [-1,0, 1,0]. Solo se rellena en `SearchResponse`.

AnnotationMetadata

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

Campos

structured_content

StructuredContent

Solo de salida. Información de contenido estructurado.

image_id

string

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

ChunkMetadata

Metadatos del fragmento actual. Este campo solo se rellena en la API SearchService.Search.

Campos

previous_chunks[]

Chunk

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

next_chunks[]

Chunk

Los siguientes fragmentos del fragmento actual. SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks controla el número. Este campo solo se rellena en la API SearchService.Search.

DocumentMetadata

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

Campos
`uri`	`string` URI del documento.
`title`	`string` Título del documento.
`mime_type`	`string` El tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml
`struct_data`	`Struct` Representación de datos. Los datos JSON estructurados del documento. Debe ajustarse al `Schema` registrado o se producirá un error `INVALID_ARGUMENT`.

PageSpan

Intervalo de páginas del fragmento.

Campos

page_start

int32

La página de inicio del fragmento.

page_end

int32

La página final del fragmento.

StructureType

Define los tipos de contenido estructurado que se pueden extraer.

Enumeraciones
`STRUCTURE_TYPE_UNSPECIFIED`	Valor predeterminado.
`SHAREHOLDER_STRUCTURE`	Estructura de los accionistas.
`SIGNATURE_STRUCTURE`	Estructura de la firma.
`CHECKBOX_STRUCTURE`	Estructura de la casilla.

StructuredContent

Información de contenido estructurado.

Campos

structure_type

StructureType

Solo de salida. El tipo de estructura del contenido estructurado.

content

string

Solo de salida. El contenido del contenido estructurado.

Referencia

Atribuciones de la fuente del contenido.

Campos
`start_index`	`int32` Solo de salida. Índice de inicio del contenido.
`end_index`	`int32` Solo de salida. Índice final del contenido.
`uri`	`string` Solo de salida. Referencia de URL de la atribución.
`title`	`string` Solo de salida. Título de la atribución.
`license`	`string` Solo de salida. Licencia de la atribución.
`publication_date`	`Date` Solo de salida. Fecha de publicación de la atribución.

CitationMetadata

Colección de atribuciones de origen de un contenido.

Campos

citations[]

Citation

Solo de salida. Lista de citas.

CloudSqlSource

Instancia de Cloud SQL de origen desde la que se importan los datos.

Campos
`project_id`	`string` El ID del proyecto que contiene la fuente de Cloud SQL. Tiene un límite de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`instance_id`	`string` Obligatorio. La instancia de Cloud SQL desde la que se copiarán los datos. La longitud máxima es de 256 caracteres.
`database_id`	`string` Obligatorio. La base de datos de Cloud SQL desde la que se copiarán los datos. La longitud máxima es de 256 caracteres.
`table_id`	`string` Obligatorio. La tabla de Cloud SQL de la que se copiarán los datos. La longitud máxima es de 256 caracteres.
`gcs_staging_dir`	`string` Directorio intermedio de Cloud Storage que se usa para la importación,con un límite de longitud de 2000 caracteres. Se puede especificar si se quiere que la exportación de Cloud SQL se realice en un directorio de Cloud Storage concreto. 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 de exportación sin servidor. Si habilitas esta opción, se te aplicará un coste adicional. En este artículo encontrarás más información.

CmekConfig

Configuraciones que se usan para habilitar el cifrado de datos con CMEK mediante claves de Cloud KMS.

Campos
`name`	`string` Obligatorio. Nombre de CmekConfig del formulario `projects/{project}/locations/{location}/cmekConfig` o `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
`kms_key`	`string` Obligatorio. Nombre del recurso de clave de KMS que se usará para cifrar recursos `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
`kms_key_version`	`string` Solo de salida. Nombre del recurso de la versión de la clave de KMS que se usará para cifrar los recursos `<kms_key>/cryptoKeyVersions/{keyVersion}`.
`state`	`State` Solo de salida. Estados de CmekConfig.
`is_default`	`bool` Solo de salida. CmekConfig predeterminado del cliente.
`last_rotation_timestamp_micros`	`int64` Solo de salida. Marca de tiempo de la última rotación de claves.
`single_region_keys[]`	`SingleRegionKey` Opcional. CMEKs de una sola región que son necesarias para algunas funciones de VAIS.
`notebooklm_state`	`NotebookLMState` Solo de salida. Indica si el corpus de NotebookLM está listo para usarse.

NotebookLMState

Estados de NotebookLM.

Enumeraciones
`NOTEBOOK_LM_STATE_UNSPECIFIED`	Se desconoce el estado de NotebookLM.
`NOTEBOOK_LM_NOT_READY`	NotebookLM no está listo.
`NOTEBOOK_LM_READY`	Ya puedes usar NotebookLM.
`NOTEBOOK_LM_NOT_ENABLED`	NotebookLM no está habilitado.

Estado

Estados de CmekConfig.

Enumeraciones
`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 ha revocado la clave de KMS.
`DELETING`	Se está eliminando el CmekConfig.
`DELETE_FAILED`	No se ha podido eliminar CmekConfig.
`UNUSABLE`	No se puede usar CmekConfig, probablemente debido a algún problema interno.
`ACTIVE_ROTATING`	La versión de la clave de KMS se está rotando.
`DELETED`	La clave de KMS se elimina de forma lógica. Se aplicará alguna política de limpieza.
`EXPIRED`	La clave de KMS ha caducado, lo que significa que se ha inhabilitado durante más de 30 días. El cliente puede llamar a DeleteCmekConfig para cambiar el estado a DELETED.

CollectUserEventRequest

Mensaje de solicitud del método CollectUserEvent.

Campos
`parent`	`string` Obligatorio. Nombre del recurso superior. Si la acción de recoger eventos de usuario se aplica a nivel de `DataStore`, el formato es `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. Por ejemplo, si la acción de recoger eventos de usuario se aplica en el nivel `Location`, el evento con `Document` en varios `DataStore` tiene el siguiente formato: `projects/{project}/locations/{location}`.
`user_event`	`string` Obligatorio. UserEvent proto codificado en URL con un límite de longitud de 2.000.000 caracteres.
`uri`	`string` La URL, incluidos los parámetros cgi, pero excluido el fragmento hash, con un límite de 5000 caracteres. A menudo, esta información es más útil que la URL referente, ya que muchos navegadores solo envían el dominio de las solicitudes de terceros.
`ets`	`int64` Marca de tiempo del evento en milisegundos. De esta forma, se evita que el navegador almacene en caché 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 acceder a un conjunto de DataStores.

Campos

name

string

Inmutable. 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 1024 caracteres.

display_name

string

Obligatorio. 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 devuelve un error INVALID_ARGUMENT.

create_time

Solo de salida. Marca de tiempo de la creación de Collection.

CompleteQueryRequest

Mensaje de solicitud del método CompletionService.CompleteQuery.

Campos
`data_store`	`string` Obligatorio. Nombre del recurso del almacén de datos superior para el que se realiza la finalización, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Obligatorio. La entrada de escritura predictiva que se ha usado para obtener las sugerencias. La longitud máxima es de 128 caracteres.
`query_model`	`string` Especifica el modelo de datos de autocompletado. Esta opción 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 los usuarios. `search-history`: se usan sugerencias generadas a partir del historial de llamadas a la API `SearchService.Search`. No la uses cuando no haya tráfico para la API Search. `user-event`: se usan sugerencias generadas a partir de eventos de búsqueda importados por los usuarios. `document-completable`: se usan sugerencias tomadas directamente de los campos de documentos importados por los usuarios que están marcados como completables. Valores predeterminados: `document` es el modelo predeterminado de los almacenes de datos normales. `search-history` es el modelo predeterminado de los almacenes de datos de búsqueda en el sitio.
`user_pseudo_id`	`string` Identificador único para hacer un seguimiento de los visitantes. Por ejemplo, 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 debería cambiar si el visitante inicia o cierra sesión en el sitio web. 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 devuelve un error `INVALID_ARGUMENT`.
`include_tail_suggestions`	`bool` Indica si se deben devolver sugerencias de cola si no hay sugerencias que coincidan con la consulta completa. Aunque se le asigne el valor "true", si hay sugerencias que coincidan con la consulta completa, se devolverán esas sugerencias y no se devolverán sugerencias de cola.

CompleteQueryResponse

Mensaje de respuesta del método CompletionService.CompleteQuery.

Campos

query_suggestions[]

QuerySuggestion

Resultados de las sugerencias de consulta coincidentes. La lista de resultados está ordenada y el primer resultado es una sugerencia destacada.

tail_match_triggered

bool

True si todas las sugerencias devueltas son sugerencias de cola.

Para que se active la coincidencia de cola, include_tail_suggestions en la solicitud debe ser true y no debe haber sugerencias que coincidan con la consulta completa.

QuerySuggestion

Sugerencias como consultas de búsqueda.

Campos

suggestion

string

La sugerencia para la consulta.

completable_field_paths[]

string

Las rutas de campo de documento únicas que sirven como origen de esta sugerencia si se ha generado a partir de campos completables.

Este campo solo se rellena en el modelo que puede completar documentos.

CompletionInfo

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 ha hecho clic.

Campos

selected_suggestion

string

Usuario final seleccionado: CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

Posición CompleteQueryResponse.QuerySuggestion.suggestion seleccionada por el usuario final, empezando por 0.

CompletionSuggestion

Sugerencias de autocompletado importadas de Customer.

Campos
`suggestion`	`string` Obligatorio. Texto de la sugerencia.
`language_code`	`string` 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 eliminar las sugerencias semánticamente idénticas.
`group_score`	`double` La puntuación de esta sugerencia en su grupo.
`alternative_phrases[]`	`string` Frases alternativas que coinciden con esta sugerencia.
Campo de unión `ranking_info`. Métricas de ranking de esta sugerencia. `ranking_info` solo puede ser una de estas dos opciones:
`global_score`	`double` Puntuación global de esta sugerencia. Controlar cómo se puntuará o clasificará 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 comprobar antes de permitir un comportamiento.

Campos

query_terms[]

QueryTerm

Busca solo en una lista de términos para que coincidan con la consulta. No se puede definir cuando se ha definido Condition.query_regex.

Un máximo de 10 términos de consulta.

active_time_range[]

TimeRange

Intervalo de tiempo que especifica cuándo está activa la condición.

Puedes añadir un máximo de 10 intervalos de tiempo.

query_regex

string

Opcional. Expresión regular de la consulta para que coincida con toda la consulta de búsqueda. No se puede definir cuando se ha definido Condition.query_terms. Solo se admite en los controles de servicio de promoción de la búsqueda básica en el sitio.

QueryTerm

Matcher de la consulta de la solicitud de búsqueda

Campos

value

string

El valor de consulta específico con el que se va a comparar

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

full_match

bool

Si la consulta de búsqueda debe coincidir exactamente con el término de la consulta.

TimeRange

Se usa para condiciones dependientes del tiempo.

Campos

start_time

Inicio del periodo.

El intervalo es inclusivo.

end_time

Fin del periodo.

El intervalo es inclusivo. Debe ser una fecha posterior a la actual.

ConnectorType

El tipo de conector.

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

ContactDetails

La información de contacto almacenada a nivel de recurso. Si se rellenan los campos de nivel de proyecto y de nivel de recurso, la información de contacto del nivel de recurso prevalecerá sobre la del nivel de proyecto.

Campos

email_address

string

Opcional. Dirección de correo del contacto.

Control

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

Campos
`name`	`string` Inmutable. Nombre completo `projects//locations/global/dataStore//controls/*`
`display_name`	`string` Obligatorio. Nombre legible. El identificador que se usa en las vistas de la interfaz de usuario. Debe ser una cadena codificada en UTF-8. El límite de longitud es de 128 caracteres. De lo contrario, se producirá un error INVALID ARGUMENT.
`associated_serving_config_ids[]`	`string` Solo de salida. Lista de todos los IDs de `ServingConfig` a los que está asociado este control. Los cambios pueden tardar hasta 10 minutos en aplicarse.
`solution_type`	`SolutionType` Obligatorio. Inmutable. A qué solución pertenece el control. Debe ser compatible con el vertical del recurso. De lo contrario, se producirá un error INVALID ARGUMENT.
`use_cases[]`	`SearchUseCase` Especifica el caso práctico del control. Afecta a los campos de condición que se pueden definir. Solo se aplica a `SOLUTION_TYPE_SEARCH`. Actualmente, solo se permite un caso práctico por control. Se debe definir cuando solution_type es `SolutionType.SOLUTION_TYPE_SEARCH`.
`conditions[]`	`Condition` Determina cuándo se activará la acción asociada. Omite este paso para aplicar siempre la acción. Actualmente, solo se puede especificar una condición. De lo contrario, se producirá un error INVALID ARGUMENT.
Campo de unión `action`. Las acciones están restringidas por vertical y solución Obligatorio. `action` solo puede ser una de estas dos opciones:
`boost_action`	`BoostAction` Define un control de tipo de aumento.
`filter_action`	`FilterAction` Define un control de tipo de filtro. Actualmente no es compatible con Recomendación.
`redirect_action`	`RedirectAction` Define un control de tipo de redirección.
`synonyms_action`	`SynonymsAction` Trata un grupo de términos como sinónimos entre sí.
`promote_action`	`PromoteAction` Promocionar determinados enlaces en función de consultas de activación predefinidas.

BoostAction

Ajusta el orden de los productos en la lista devuelta.

Campos
`boost (deprecated)`	`float` Este elemento está obsoleto. Intensidad del aumento, que debe estar entre -1 y 1. Un impulso negativo significa que se ha bajado de nivel. El valor predeterminado es 0.0 (sin operación).
`filter`	`string` Obligatorio. Especifica a qué productos se aplica el impulso. Si no se proporciona ningún filtro, se potenciarán todos los productos (sin operación). Documentación sobre la sintaxis: https://cloud.google.com/retail/docs/filter-and-order. La longitud máxima es de 5000 caracteres. De lo contrario, se producirá un error INVALID ARGUMENT.
`data_store`	`string` Obligatorio. Especifica qué documentos del almacén de datos se pueden destacar con este control. Nombre completo del almacén de datos, por ejemplo, projects/123/locations/global/collections/default_collection/dataStores/default_data_store
Campo de unión `boost_spec`. Especificaciones de aumento de valor constante o de aumento basado en la clasificación personalizada. `boost_spec` solo puede ser una de estas dos opciones:
`fixed_boost`	`float` Opcional. Intensidad del aumento, que debe estar entre -1 y 1. Un impulso negativo significa que se ha bajado de nivel. El valor predeterminado es 0.0 (sin operación).
`interpolation_boost_spec`	`InterpolationBoostSpec` Opcional. Especificación compleja para la clasificación personalizada basada en el valor del atributo definido por el cliente.

InterpolationBoostSpec

Especificación de la clasificación personalizada basada en el valor de atributo especificado por el cliente. Ofrece más controles para personalizar la clasificación que la combinación simple (condición, impulso) que se ha descrito anteriormente.

Campos
`field_name`	`string` Opcional. Nombre del campo cuyo valor se usará para determinar el aumento.
`attribute_type`	`AttributeType` Opcional. 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_nombre especificado. En el caso de los valores numéricos, es sencillo: attribute_value = numerical_field_value. En el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` Opcional. El tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
`control_points[]`	`ControlPoint` Opcional. Los puntos de control que se usan para definir la curva. La función monotónica (definida mediante el interpolation_type anterior) pasa por los puntos de control que se indican aquí.

AttributeType

El atributo(o la función) al que se debe aplicar la clasificación personalizada.

Enumeraciones
`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 valor_atributo (el valor x) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
`FRESHNESS`	En el caso práctico de la actualización, el valor del atributo será la duración entre la hora actual y la fecha especificada en el campo datetime. 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 es el siguiente: `[nD][T[nH][nM][nS]]`. Por ejemplo, `5D`, `3DT12H30M` y `T24H`.

ControlPoint

Los puntos de control que se usan para definir la curva. La curva definida mediante estos puntos de control solo puede ser creciente o decreciente de forma monótona(se aceptan valores constantes).

Campos

attribute_value

string

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

boost_amount

float

Opcional. Valor entre -1 y 1 que se debe sumar a la puntuación si el valor_atributo se evalúa como el valor especificado anteriormente.

InterpolationType

El tipo de interpolación que se va a aplicar. El valor predeterminado será lineal (lineal a tramos).

Enumeraciones
`INTERPOLATION_TYPE_UNSPECIFIED`	No se ha especificado el tipo de interpolación. En este caso, se utiliza el valor predeterminado Lineal.
`LINEAR`	Se aplicará la interpolación lineal a tramos.

FilterAction

Especifica qué productos se pueden incluir en los resultados. Usa el mismo filtro que el aumento.

Campos

filter

string

Obligatorio. Filtro que se aplica a los resultados de la condición coincidente.

Documentación sobre la sintaxis obligatoria: https://cloud.google.com/retail/docs/filter-and-order. La longitud máxima es de 5000 caracteres. De lo contrario, se producirá un error INVALID ARGUMENT.

data_store

string

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

PromoteAction

Promocionar determinados enlaces en función de algunas consultas de activación.

Ejemplo: promocionar el enlace de una zapatería cuando se busca la palabra clave shoe. El enlace puede estar fuera del almacén de datos asociado.

Campos

data_store

string

Obligatorio. Almacén de datos al que está asociada esta promoción.

search_link_promotion

SearchLinkPromotion

Obligatorio. Promoción adjunta a esta acción.

RedirectAction

Redirige a un comprador al URI proporcionado.

Campos

redirect_uri

string

Obligatorio. El URI al que se redirigirá al comprador.

Obligatorio. La URI debe tener una longitud igual o inferior a 2000 caracteres. De lo contrario, se producirá un error INVALID ARGUMENT.

SynonymsAction

Crea un conjunto de términos que actúan como sinónimos entre sí.

Por ejemplo, "feliz" también se considerará "contento", y "contento" también se considerará "feliz".

Campos

synonyms[]

string

Define un conjunto de sinónimos. Puede especificar hasta 100 sinónimos. Debes especificar al menos 2 sinónimos. De lo contrario, se producirá un error INVALID ARGUMENT.

Conversación

Definición del proto de conversación externa.

Campos
`name`	`string` Inmutable. Nombre completo `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` o `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` El estado de la conversación.
`user_pseudo_id`	`string` Identificador único para monitorizar a los usuarios.
`messages[]`	`ConversationMessage` Mensajes de conversaciones.
`start_time`	`Timestamp` Solo de salida. La hora en la que se inició la conversación.
`end_time`	`Timestamp` Solo de salida. La hora en la que finalizó la conversación.

Estado

Enumeración del estado de la conversación.

Enumeraciones
`STATE_UNSPECIFIED`	Desconocido.
`IN_PROGRESS`	La conversación está abierta.
`COMPLETED`	La conversación se ha completado.

ConversationContext

Define el contexto de la conversación.

Campos

context_documents[]

string

La lista de documentos que está viendo el usuario. Contiene las referencias de recursos del documento.

active_document

string

El documento activo que ha abierto el usuario. Contiene la referencia del recurso del documento.

ConversationMessage

Define un mensaje de conversación.

Campos
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de creación del mensaje.
Campo de unión `message`. `message` solo puede ser una de estas dos opciones:
`user_input`	`TextInput` Entrada de texto del usuario.
`reply`	`Reply` Buscar respuesta.

ConverseConversationRequest

Mensaje de solicitud del método ConversationalSearchService.ConverseConversation.

Campos
`name`	`string` Obligatorio. Nombre de recurso de la conversación que se va a obtener. 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 nueva conversación dentro de una sesión de ConverseConversation.
`query`	`TextInput` Obligatorio. Entrada del usuario actual.
`serving_config`	`string` Nombre de recurso de la configuración de servicio que se va a usar. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`. Si no se define, se usará la configuración de publicación predeterminada.
`conversation`	`Conversation` La conversación que se va a usar solo en la sesión automática. El campo de nombre se ignorará, ya que asignaremos automáticamente un nuevo nombre a la conversación en la sesión automática.
`safe_search`	`bool` Si quieres activar Búsqueda segura.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta más información en el documento de Google Cloud.
`summary_spec`	`SummarySpec` Especificación para configurar el resumen devuelto en la respuesta.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los documentos que se van a filtrar. La expresión de filtro distingue entre mayúsculas y minúsculas. Se usará para filtrar los resultados de búsqueda, lo que puede afectar a la respuesta del resumen. Si este campo no se reconoce, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave de filtro del lado izquierdo a una propiedad de clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios puede tener un campo "nombre" en su esquema. En este caso, el filtro sería el siguiente: filter --> name:'ANY("king kong")' Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtrar.
`boost_spec`	`BoostSpec` Especificación de impulso para impulsar determinados documentos en los resultados de búsqueda, lo que puede afectar a la respuesta de la conversación. Para obtener más información sobre el aumento, consulta Aumento.

ConverseConversationResponse

Mensaje de respuesta del método ConversationalSearchService.ConverseConversation.

Campos

reply

Reply

Respuesta a la consulta actual.

conversation

Conversación actualizada con la respuesta.

search_results[]

SearchResult

Resultados de búsqueda.

CreateAssistantRequest

Solicitud del método AssistantService.CreateAssistant.

Campos

parent

string

Obligatorio. Nombre del recurso superior. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

assistant

Assistant

Obligatorio. El Assistant que se va a crear.

assistant_id

string

Obligatorio. El ID que se va a usar en Assistant, que se convertirá en el componente final del nombre de recurso de Assistant.

Este campo debe cumplir la RFC-1034 y tener una longitud máxima de 63 caracteres.

CreateControlRequest

Solicitud del método CreateControl.

Campos

parent

string

Obligatorio. Nombre completo del recurso del almacén de datos superior. 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. Control que se va a crear.

control_id

string

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

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

CreateConversationRequest

Solicitud del método CreateConversation.

Campos

parent

string

Obligatorio. Nombre completo del recurso del almacén de datos superior. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

conversation

Obligatorio. Conversación que se va a crear.

CreateDataStoreMetadata

Metadatos relacionados con el progreso de la operación DataStoreService.CreateDataStore. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

CreateDataStoreRequest

Solicitud del método DataStoreService.CreateDataStore.

Campos
`parent`	`string` Obligatorio. Nombre del recurso superior, como `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Obligatorio. El `DataStore` que se va a crear.
`data_store_id`	`string` Obligatorio. El ID que se va a usar en `DataStore`, que se convertirá en el componente final del nombre de recurso de `DataStore`. Este campo debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.
`create_advanced_site_search`	`bool` Un indicador booleano que indica si el usuario quiere 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), esta marca se ignorará.
`skip_default_schema_creation`	`bool` Un indicador booleano que indica si se debe omitir la creación del esquema predeterminado del almacén de datos. Habilita esta marca solo si tienes la certeza de que el esquema predeterminado no es compatible con tu caso práctico. Si se define como true, debes crear manualmente un esquema para el almacén de datos antes de poder ingerir documentos. Esta marca no se puede especificar si se ha indicado `data_store.starting_schema`.
Campo de unión `cmek_options`. Opciones de CMEK para DataStore. Si se define este campo, se anulará el valor predeterminado de CmekConfig si se ha definido uno para el proyecto. `cmek_options` solo puede ser una de estas dos opciones:
`cmek_config_name`	`string` Nombre de recurso de CmekConfig que se usará para proteger este almacén de datos.
`disable_cmek`	`bool` DataStore sin protecciones de CMEK. Si se ha definido un valor predeterminado para CmekConfig en el proyecto, al definir este campo también se anulará el valor predeterminado de CmekConfig.

CreateDocumentRequest

Mensaje de solicitud del método DocumentService.CreateDocument.

Campos

parent

string

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

document

Obligatorio. El Document que se va a crear.

document_id

string

Obligatorio. El ID que se va a usar en Document, que se convierte en el componente final de Document.name.

Si la persona que llama 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 Documents con el mismo parent. De lo contrario, se devuelve un error ALREADY_EXISTS.

Este campo debe cumplir el estándar RFC-1034 y tener una longitud máxima de 128 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.

CreateEngineMetadata

Metadatos relacionados con el progreso de la operación EngineService.CreateEngine. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

CreateEngineRequest

Solicitud del método EngineService.CreateEngine.

Campos

parent

string

Obligatorio. Nombre del recurso superior, como projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Obligatorio. El Engine que se va a crear.

engine_id

string

Obligatorio. El ID que se va a usar en Engine, que se convertirá en el componente final del nombre de recurso de Engine.

Este campo debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.

CreateIdentityMappingStoreRequest

Mensaje de solicitud de IdentityMappingStoreService.CreateIdentityMappingStore

Campos
`parent`	`string` Obligatorio. Nombre del recurso de la colección superior, como `projects/{project}/locations/{location}`.
`identity_mapping_store_id`	`string` Obligatorio. ID del almacén de mapeado de identidades que se va a crear. El ID solo puede contener letras (a-z, A-Z), números (0-9), guiones bajos (_) y guiones (-). La longitud máxima es de 63 caracteres.
`identity_mapping_store`	`IdentityMappingStore` Obligatorio. El almacén de mapeado de identidades que se va a crear.
Campo de unión `cmek_options`. Opciones de CMEK para el almacén de asignación de identidades. Si se define este campo, se anulará el valor predeterminado de CmekConfig si se ha definido uno para el proyecto. `cmek_options` solo puede ser una de estas dos opciones:
`cmek_config_name`	`string` Nombre de recurso de CmekConfig que se usará para proteger este almacén de asignaciones de identidad.
`disable_cmek`	`bool` Almacén de mapeo de identidades sin protecciones de CMEK. Si se ha definido un valor predeterminado para CmekConfig en el proyecto, al definir este campo también se anulará el valor predeterminado de CmekConfig.

CreateLicenseConfigRequest

Mensaje de solicitud del método LicenseConfigService.CreateLicenseConfig.

Campos

parent

string

Obligatorio. Nombre del recurso superior, como projects/{project}/locations/{location}.

license_config

LicenseConfig

Obligatorio. El LicenseConfig que se va a crear.

license_config_id

string

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

CreateSchemaMetadata

Metadatos de la operación LRO de creación de esquemas.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

CreateSchemaRequest

Mensaje de solicitud del método SchemaService.CreateSchema.

Campos

parent

string

Obligatorio. Nombre del recurso del almacén de datos superior, con el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Obligatorio. El Schema que se va a crear.

schema_id

string

Obligatorio. El ID que se va a usar en Schema, que se convierte en el componente final de Schema.name.

Este campo debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres.

CreateSessionRequest

Solicitud del método CreateSession.

Campos

parent

string

Obligatorio. Nombre completo del recurso del almacén de datos superior. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}

session

Obligatorio. Sesión que se va a crear.

CreateSitemapMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.CreateSitemap. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

CreateSitemapRequest

Mensaje de solicitud del método SiteSearchEngineService.CreateSitemap.

Campos

parent

string

Obligatorio. Nombre del recurso superior de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

sitemap

Sitemap

Obligatorio. El Sitemap que se va a crear.

CreateTargetSiteMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.CreateTargetSite. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

CreateTargetSiteRequest

Mensaje de solicitud del método SiteSearchEngineService.CreateTargetSite.

Campos

parent

string

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

target_site

Obligatorio. El TargetSite que se va a crear.

CustomAttribute

Un atributo personalizado que no se modela explícitamente en un recurso, como UserEvent.

Campos

text[]

string

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

No se permiten cadenas vacías. De lo contrario, se devuelve un error INVALID_ARGUMENT.

Se debe definir exactamente una de las propiedades CustomAttribute.text o CustomAttribute.numbers. De lo contrario, se devuelve un error INVALID_ARGUMENT.

numbers[]

double

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

Se debe definir exactamente una de las propiedades CustomAttribute.text o CustomAttribute.numbers. De lo contrario, se devuelve un error INVALID_ARGUMENT.

CustomTuningModel

Metadatos que describen un modelo ajustado personalizado.

Campos
`name`	`string` Obligatorio. Nombre completo del recurso del modelo. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. El modelo debe ser una cadena alfanumérica de 40 caracteres como máximo.
`display_name`	`string` Nombre visible del modelo.
`model_version`	`int64` La versión del modelo.
`model_state`	`ModelState` El estado en el que se encuentra el modelo (por ejemplo, `TRAINING` o `TRAINING_FAILED`).
`create_time (deprecated)`	`Timestamp` Este elemento está obsoleto. Obsoleto: marca de tiempo de creación del modelo.
`training_start_time`	`Timestamp` Marca de tiempo en la que se inició el entrenamiento del modelo.
`metrics`	`map<string, double>` Las métricas del modelo entrenado.
`error_message`	`string` Actualmente, solo se rellena si el estado del modelo es `INPUT_VALIDATION_FAILED`.

ModelState

El estado del modelo.

Enumeraciones
`MODEL_STATE_UNSPECIFIED`	Valor predeterminado.
`TRAINING_PAUSED`	El modelo está en un estado de entrenamiento en pausa.
`TRAINING`	El modelo se está entrenando.
`TRAINING_COMPLETE`	El modelo ha completado correctamente el entrenamiento.
`READY_FOR_SERVING`	El modelo está listo para publicarse.
`TRAINING_FAILED`	No se ha podido entrenar el modelo.
`NO_IMPROVEMENT`	El entrenamiento del modelo se ha completado correctamente, pero las métricas no han mejorado.
`INPUT_VALIDATION_FAILED`	No se ha podido validar la entrada de datos. No se ha iniciado el entrenamiento del modelo.

DataConnector

Gestiona la conexión a fuentes de datos externas de 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 e inicializará su DataConnector.

Campos
`name`	`string` Solo de salida. Nombre de recurso completo del conector de datos. Formato: `projects//locations//collections/*/dataConnector`.
`state`	`State` Solo de salida. Estado del conector.
`data_source`	`string` Obligatorio. El nombre de la fuente de datos. Valores admitidos: `salesforce`, `jira`, `confluence` y `bigquery`.
`remove_param_keys[]`	`string` Opcional. Especifica las claves que se van a quitar del campo "params". Solo está activo cuando se incluye "params" en "update_mask" en un UpdateDataConnectorRequest. Las eliminaciones tienen prioridad si una clave está tanto en "remove_param_keys" como en el campo "params" de la solicitud.
`refresh_interval`	`Duration` Obligatorio. El intervalo de actualización de la sincronización de datos. Si la duración es 0, los datos se sincronizarán en tiempo real. La función de streaming aún no está disponible. El mínimo es de 30 minutos y el máximo es de 7 días. Si el intervalo de actualización es el mismo que el intervalo de actualización incremental, la sincronización incremental se inhabilitará.
`next_sync_time`	`DateTime` Define la hora programada para la próxima sincronización de datos. Este campo requiere la hora, los minutos y la 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. Si no se especifican las horas o los minutos, se asumirá que la hora de sincronización es las 0:00. El usuario debe proporcionar una zona horaria para evitar ambigüedades.
`entities[]`	`SourceEntity` Lista de entidades de la fuente de datos conectada que se van a ingerir.
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de la creación de `DataConnector`.
`latest_pause_time`	`Timestamp` Solo de salida. La marca de tiempo más reciente en la que se pausó este `DataConnector`, lo que afecta a todas las funciones, como la sincronización de datos. Si pausas un conector, ocurrirá lo siguiente: - Se detendrán todas las funciones, incluida la sincronización de datos. - Se cancelará cualquier tarea de sincronización de datos en curso. - No se programarán ni se podrán activar sincronizaciones de datos futuras.
`last_sync_time`	`Timestamp` Solo de salida. Solo en el caso de los conectores periódicos, la última vez que se completó una sincronización de datos.
`update_time`	`Timestamp` Solo de salida. Marca de tiempo de la última actualización del `DataConnector`.
`errors[]`	`Status` Solo de salida. Los errores de inicialización o de la última ejecución del conector.
`sync_mode`	`SyncMode` El modo de sincronización de datos admitido por el conector de datos.
`kms_key_name`	`string` Solo de entrada. La clave de KMS que se usará para proteger los almacenes de datos gestionados por este conector. Se debe definir en las solicitudes que deban cumplir las protecciones de la política de organización de CMEK. Si este campo se define y se procesa correctamente, los almacenes de datos creados por este conector estarán protegidos por la clave de KMS.
`destination_configs[]`	`DestinationConfig` Opcional. Cualquier destino utilizado para conectarse a servicios de terceros.
`action_state`	`State` Solo de salida. Estado del conector de acciones. Esto refleja si el conector de acciones se está inicializando, está activo o ha detectado errores.
`action_config`	`ActionConfig` Opcional. Configuraciones de acciones para que el conector admita acciones.
`end_user_config`	`EndUserConfig` Opcional. Parámetros y credenciales que se usan específicamente para los conectores de la UEA.
`federated_config`	`FederatedConfig` Opcional. Parámetros y credenciales que se usan específicamente para conectores híbridos que admiten el modo FEDERATED. Este campo solo se debe definir si el conector es un conector híbrido y queremos habilitar el modo FEDERATED.
`connector_modes[]`	`ConnectorMode` Opcional. Los modos habilitados para este conector. El estado predeterminado es CONNECTOR_MODE_UNSPECIFIED.
`static_ip_enabled`	`bool` Opcional. Indica si el cliente ha habilitado direcciones IP estáticas para este conector.
`static_ip_addresses[]`	`string` Solo de salida. Las direcciones IP estáticas que usa este conector.
`blocking_reasons[]`	`BlockingReason` Solo de salida. Acciones que deben completar los usuarios antes de que el conector pueda empezar a sincronizar datos.
`identity_refresh_interval (deprecated)`	`Duration` Este elemento está obsoleto. Intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos insertados por este conector. Si no se establece esta política, la lista de control de acceso se actualizará con el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de 30 minutos como mínimo y de 7 días como máximo.
`identity_schedule_config`	`IdentityScheduleConfig` 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 insertados por este conector.
`private_connectivity_project_id`	`string` Solo de salida. ID de proyecto de arrendatario asociado a conectores de conectividad privada. Para que el conector funcione, este proyecto debe estar en la lista de permitidos.
`bap_config`	`BAPConfig` Opcional. La configuración para establecer una conexión BAP.
`connector_type`	`ConnectorType` Solo de salida. 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 la ha definido.
`realtime_state`	`State` Solo de salida. Estado de sincronización en tiempo real.
`alert_policy_configs[]`	`AlertPolicyConfig` Opcional. Configuración de alertas a nivel de conector.
`realtime_sync_config`	`RealtimeSyncConfig` Opcional. Configuración de la sincronización en tiempo real.
`acl_enabled`	`bool` Opcional. Indica si el conector se creará con una configuración de ACL. Actualmente, este campo solo afecta a los conectores de Cloud Storage y BigQuery.
`create_eua_saas`	`bool` Opcional. Indica si el conector END USER AUTHENTICATION se ha creado en 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 en este conector. Esto es independiente de auto_run_disabled. Solo se aplica a los conectores de terceros. Si el intervalo de actualización se define con el mismo valor que el intervalo de actualización incremental, la sincronización incremental se inhabilitará (es decir, se definirá como "true").
`incremental_refresh_interval`	`Duration` Opcional. Intervalo de actualización específico para las sincronizaciones de datos incrementales. Si no se define, las sincronizaciones incrementales usarán el valor predeterminado del entorno, que es de 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. Si el intervalo de actualización es el mismo que el intervalo de actualización incremental, la sincronización incremental se inhabilitará.
`hybrid_ingestion_disabled`	`bool` Opcional. Si el conector es un conector híbrido, determina si la ingestión está habilitada y si se aprovisionan los recursos adecuados durante la creación del conector. Si el conector no es un conector híbrido, este campo se ignora.
Campo de unión `data_connector_params`. 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 de Secret Manager. Parámetros obligatorios para todas las fuentes de datos: Tecla: `instance_uri` Valor: tipo STRING. URI para acceder a la fuente de datos. Parámetros obligatorios para las fuentes que admiten OAuth, es decir, `salesforce`: Tecla: `client_id` Valor: tipo STRING. El ID de cliente del proveedor de servicios externo para identificar tu aplicación. Tecla: `client_secret` Value:type STRING. El secreto de cliente generado por el servidor de autorización de terceros. Tecla: `access_token` Valor: tipo STRING. Token OAuth de UCS para acceder al recurso protegido. Tecla: `refresh_token` Valor: tipo STRING. 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, como `jira` y `confluence`: Tecla: `user_account` Valor: tipo STRING. El nombre de usuario o el correo electrónico de la fuente. Tecla: `api_token` Valor: tipo STRING. El token de API generado para la cuenta de origen, que se usa para autenticarte en cualquier lugar en el que habrías 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 va a usar en la compatibilidad con varios tipos de autorización: Tecla: `auth_type` Valor: tipo STRING. Tipo de autorización de la fuente de datos. Valores admitidos: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN` y `FEDERATED_CREDENTIAL`. `data_connector_params` solo puede ser una de estas dos opciones:
`params`	`Struct` Parámetros obligatorios del conector de datos en formato JSON estructurado.
`json_params`	`string` Parámetros obligatorios del conector de datos en formato de cadena JSON.

BlockingReason

Acciones que deben completar los usuarios antes de que el conector pueda empezar a sincronizar datos.

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

ConnectorMode

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

Enumeraciones
`CONNECTOR_MODE_UNSPECIFIED`	Modo de conector no especificado.
`DATA_INGESTION`	Conector utilizado para la ingestión de datos.
`ACTIONS`	Conector utilizado para las acciones.
`FEDERATED`	Conector utilizado para la búsqueda federada.
`EUA`	Conector utilizado para la autenticación de usuarios finales.
`FEDERATED_AND_EUA`	Conector híbrido utilizado para la búsqueda federada y la autenticación de usuarios finales.

EndUserConfig

Parámetros y credenciales que se usan específicamente para los conectores de la UEA.

Campos
`additional_params`	`Struct` Opcional. Cualquier parámetro adicional necesario para el EULA.
`tenant`	`Tenant` Opcional. El proyecto de cliente al que está conectado el conector.
Campo de unión `auth_config`. Configuración de autenticación para conectores de EUA. `auth_config` solo puede ser una de estas dos opciones:
`auth_params`	`Struct` Opcional. Parámetros de autenticación específicos de los conectores de EUA.
`json_auth_params`	`string` Opcional. Parámetros de autenticación específicos de los conectores de EUA en formato de cadena JSON.

FederatedConfig

Parámetros y credenciales que se usan específicamente para conectores híbridos que admiten el modo FEDERATED.

Campos
`additional_params`	`Struct` Opcional. Parámetros adicionales necesarios para FEDERATED.
Campo de unión `auth_config`. Configuración de autenticación para conectores FEDERATED. `auth_config` solo puede ser una de estas dos opciones:
`auth_params`	`Struct` Opcional. Parámetros de autenticación específicos de los conectores FEDERATED.
`json_auth_params`	`string` Opcional. Parámetros de autenticación específicos de los conectores FEDERATED en formato de cadena JSON.

RealtimeSyncConfig

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

Campos

webhook_uri

string

Opcional. URL de webhook del conector para especificar parámetros adicionales de la sincronización en tiempo real.

realtime_sync_secret

string

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

streaming_error

StreamingError

Opcional. Detalles del error de streaming.

StreamingError

Detalles del error de streaming.

Campos

streaming_error_reason

StreamingErrorReason

Opcional. Error de streaming.

error

Opcional. Detalles del error.

StreamingErrorReason

Tipos generales de errores de streaming.

Enumeraciones
`STREAMING_ERROR_REASON_UNSPECIFIED`	No se ha especificado el motivo del error de streaming.
`STREAMING_SETUP_ERROR`	Se ha producido un error al configurar los recursos para la sincronización en tiempo real.
`STREAMING_SYNC_ERROR`	Se ha producido un error al ejecutar la sincronización en tiempo real del conector.
`INGRESS_ENDPOINT_REQUIRED`	El endpoint de entrada es obligatorio al configurar la sincronización en tiempo real en la conectividad privada.

SourceEntity

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

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

Estado

El estado del conector.

Enumeraciones
`STATE_UNSPECIFIED`	Valor predeterminado.
`CREATING`	Se está configurando el conector.
`ACTIVE`	El conector se ha configurado correctamente y está esperando la próxima sincronización.
`FAILED`	El conector tiene un error. Puede consultar los detalles del error en `DataConnector.errors`. Si el error no se puede solucionar, se puede eliminar el `DataConnector` con la API [CollectionService.DeleteCollection].
`RUNNING`	El conector está sincronizando activamente los registros de la fuente de datos.
`WARNING`	El conector ha completado una sincronización, pero ha detectado errores no críticos.
`INITIALIZATION_FAILED`	No se ha podido 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 en 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.

Enumeraciones
`PERIODIC`	El conector sincronizará los datos periódicamente en función 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 ingieran datos tendrán este valor.

DataStore

DataStore captura los ajustes y las configuraciones globales a nivel de DataStore.

Campos
`name`	`string` Inmutable. Identificador. Nombre de recurso completo 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 1024 caracteres.
`display_name`	`string` Obligatorio. 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 devuelve un error INVALID_ARGUMENT.
`industry_vertical`	`IndustryVertical` Inmutable. El vertical del sector en el que se registra el almacén de datos.
`solution_types[]`	`SolutionType` Las soluciones en las que se registra 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 registra automáticamente. No se pueden registrar otras soluciones.
`default_schema_id`	`string` Solo de salida. ID del `Schema` predeterminado asociado a este almacén de datos.
`content_config`	`ContentConfig` Inmutable. La configuración de contenido del almacén de datos. Si no se define este campo, el comportamiento predeterminado del servidor será `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de la creación de `DataStore`.
`advanced_site_search_config`	`AdvancedSiteSearchConfig` Opcional. Configuración de la búsqueda avanzada en el sitio.
`kms_key_name`	`string` Solo de entrada. Clave de KMS que se usará para proteger este almacén de datos en el momento de la creación. Se debe definir en las solicitudes que deban cumplir las protecciones de la política de organización de CMEK. Si este campo se define y se procesa correctamente, el almacén de datos estará protegido por la clave de KMS, tal como se indica en el campo cmek_config.
`cmek_config`	`CmekConfig` Solo de salida. Información relacionada con CMEK de DataStore.
`billing_estimation`	`BillingEstimation` Solo de salida. Estimación del tamaño de los datos para la facturación.
`acl_enabled`	`bool` Inmutable. Si los datos de `DataStore` tienen información de LCA. Si se define como `true`, los datos de origen deben tener una lista de control de acceso. Los LCA se ingieren cuando los datos se ingieren mediante métodos de `DocumentService.ImportDocuments`. Cuando la ACL está habilitada para `DataStore`, no se puede acceder a `Document` llamando a `DocumentService.GetDocument` o `DocumentService.ListDocuments`. Actualmente, las listas de control de acceso solo se admiten en el vertical de la industria `GENERIC` con una configuración de contenido que no sea `PUBLIC_WEBSITE`.
`workspace_config`	`WorkspaceConfig` Configuración para almacenar la configuración del tipo de almacén de datos de los datos del espacio de trabajo. Este valor debe definirse cuando `DataStore.content_config` se define como `DataStore.ContentConfig.GOOGLE_WORKSPACE`.
`document_processing_config`	`DocumentProcessingConfig` Configuración de la comprensión y el enriquecimiento de documentos.
`starting_schema`	`Schema` El esquema de inicio que se usará para este `DataStore` al aprovisionarlo. Si no se define, se usará un esquema especializado vertical predeterminado. Este campo solo lo usa la API `CreateDataStore` y se ignorará si se usa en otras APIs. Este campo se omitirá en todas las respuestas de la API, incluida la API `CreateDataStore`. Para recuperar el esquema de un `DataStore`, usa la API `SchemaService.GetSchema`. El esquema proporcionado se validará según determinadas reglas del esquema. Consulta más información en este documento.
`healthcare_fhir_config`	`HealthcareFhirConfig` Opcional. Configuración de la vertical `HEALTHCARE_FHIR`.
`serving_config_data_store`	`ServingConfigDataStore` Opcional. Almacena la configuración de servicio a nivel de DataStore.
`identity_mapping_store`	`string` Inmutable. Nombre de recurso completo del `IdentityMappingStore` asociado. Este campo solo se puede definir en DataStores con acl_enabled y un proveedor de identidades `THIRD_PARTY` o `GSUITE`. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.
`is_infobot_faq_data_store`	`bool` Opcional. Si se define, este DataStore es un DataStore de preguntas frecuentes de Infobot.
`configurable_billing_approach`	`ConfigurableBillingApproach` Opcional. Configuración del método de facturación configurable. Consulta

BillingEstimation

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` Marca de tiempo de la última actualización de los datos estructurados.
`unstructured_data_update_time`	`Timestamp` Marca de tiempo de la última actualización de los datos sin estructurar.
`website_data_update_time`	`Timestamp` Marca de tiempo de la última actualización de los sitios web.

ConfigurableBillingApproach

Configuración del método de facturación configurable.

Enumeraciones
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predeterminado. Enfoque de facturación no configurable para Spark y no Spark.
`CONFIGURABLE_SUBSCRIPTION_INDEXING_CORE`	Usa la base de suscripción + la facturación por exceso para indexar el almacenamiento principal que no es de inserciones.
`CONFIGURABLE_CONSUMPTION_EMBEDDING`	Usa la facturación por consumo para el complemento de almacenamiento insertado.

ContentConfig

Configuración del contenido del almacén de datos.

Enumeraciones
`CONTENT_CONFIG_UNSPECIFIED`	Valor predeterminado.
`NO_CONTENT`	Solo contiene documentos sin `Document.content`.
`CONTENT_REQUIRED`	Solo contiene documentos con `Document.content`.
`PUBLIC_WEBSITE`	El almacén de datos se usa para la búsqueda en 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 los `WorkspaceConfig`.

ServingConfigDataStore

Almacena información sobre las configuraciones de publicación a nivel de DataStore.

Campos

disabled_for_serving

bool

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

DeleteAssistantRequest

Mensaje de solicitud del método AssistantService.DeleteAssistant.

Campos

name

string

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

Si la persona que llama no tiene permiso para eliminar el Assistant, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Assistant que se va a eliminar no existe, se devuelve un error NOT_FOUND.

DeleteCmekConfigMetadata

Metadatos relacionados con el progreso de la operación CmekConfigService.DeleteCmekConfig. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteCmekConfigRequest

Mensaje de solicitud del método CmekConfigService.DeleteCmekConfig.

Campos

name

string

Obligatorio. Nombre de recurso del CmekConfig que se va a eliminar, como projects/{project}/locations/{location}/cmekConfigs/{cmek_config}.

DeleteCollectionMetadata

Metadatos relacionados con el progreso de la operación [CollectionService.UpdateCollection][]. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteCollectionRequest

Mensaje de solicitud del método CollectionService.DeleteCollection.

Campos

name

string

Obligatorio. Nombre completo del recurso Collection, con el formato projects/{project}/locations/{location}/collections/{collection}.

DeleteControlRequest

Solicitud del método DeleteControl.

Campos

name

string

Obligatorio. Nombre de recurso del control que se va a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

DeleteConversationRequest

Solicitud del método DeleteConversation.

Campos

name

string

Obligatorio. Nombre de recurso de la conversación que se va a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadatos relacionados con el progreso de la operación DataStoreService.DeleteDataStore. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteDataStoreRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para eliminar el DataStore, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el DataStore que se va a eliminar no existe, se devuelve un error NOT_FOUND.

DeleteDocumentRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para eliminar el Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Document que se va a eliminar no existe, se devuelve un error NOT_FOUND.

DeleteEngineMetadata

Metadatos relacionados con el progreso de la operación EngineService.DeleteEngine. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteEngineRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para eliminar el Engine, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Engine que se va a eliminar no existe, se devuelve un error NOT_FOUND.

DeleteIdentityMappingStoreMetadata

Metadatos relacionados con el progreso de la operación IdentityMappingStoreService.DeleteIdentityMappingStore. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteIdentityMappingStoreRequest

Mensaje de solicitud de IdentityMappingStoreService.DeleteIdentityMappingStore

Campos

name

string

Obligatorio. Nombre del almacén de mapeo de identidades que se va a eliminar. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

DeleteSchemaMetadata

Metadatos de la operación de larga duración DeleteSchema.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteSchemaRequest

Mensaje de solicitud del método SchemaService.DeleteSchema.

Campos

name

string

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

DeleteSessionRequest

Solicitud del método DeleteSession.

Campos

name

string

Obligatorio. Nombre de recurso de la sesión que se va a eliminar. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

DeleteSitemapMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.DeleteSitemap. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteSitemapRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para acceder a Sitemap, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

DeleteTargetSiteMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.DeleteTargetSite. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DeleteTargetSiteRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para acceder a TargetSite, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

DestinationConfig

Define los endpoints de destino que se usan para conectarse a fuentes de terceros.

Campos
`key`	`string` Opcional. Identificador de destino único admitido por el conector.
`destinations[]`	`Destination` Opcional. Los destinos de la clave correspondiente.
Campo de unión `destination_config_params`. Parámetros adicionales de esta configuración de destino. `destination_config_params` solo puede ser una de estas dos opciones:
`params`	`Struct` Opcional. Parámetros adicionales de esta configuración de destino en formato JSON estructurado.
`json_params`	`string` Parámetros adicionales de esta configuración de destino en formato de cadena JSON.

Destino

Define un endpoint de destino.

Campos

port

int32

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

Campo de unión destination. El destino del endpoint. destination solo puede ser una de estas dos opciones:

host

string

Host disponible públicamente.

DisableAdvancedSiteSearchMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.DisableAdvancedSiteSearch. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

DisableAdvancedSiteSearchRequest

Mensaje de solicitud del 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 del método SiteSearchEngineService.DisableAdvancedSiteSearch.

Documento

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

Campos
`name`	`string` Inmutable. Nombre de recurso completo 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 1024 caracteres.
`id`	`string` Inmutable. Identificador del documento. El ID debe cumplir el estándar RFC-1034 y tener una longitud máxima de 128 caracteres.
`schema_id`	`string` El identificador del esquema ubicado en el mismo almacén de datos.
`content`	`Content` Los datos no estructurados vinculados a este documento. El contenido solo se puede definir y debe definirse si este documento está en un almacén de datos `CONTENT_REQUIRED`.
`parent_document_id`	`string` Identificador del documento principal. Actualmente, admite una jerarquía de documentos de dos niveles como máximo. El ID debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres.
`derived_struct_data`	`Struct` Solo de salida. Este campo es OUTPUT_ONLY. Contiene datos derivados que no están en el documento de entrada original.
`acl_info`	`AclInfo` Información de control de acceso del documento.
`index_time`	`Timestamp` Solo de salida. La última vez que se indexó el documento. Si se define este campo, el documento podría devolverse en los resultados de búsqueda. Este campo es OUTPUT_ONLY. Si este campo no se rellena, significa que el documento nunca se ha indexado.
`index_status`	`IndexStatus` Solo de salida. Estado de indexación del documento. Si el documento se indexa correctamente, se rellena el campo index_time. De lo contrario, si el documento no se indexa debido a errores, se rellenará el campo error_samples. De lo contrario, si el índice del documento está en curso, se rellena 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 producirá un error `INVALID_ARGUMENT`. `data` solo puede ser una de estas dos opciones:
`struct_data`	`Struct` Los datos JSON estructurados del documento. Debe ajustarse al `Schema` registrado o se producirá un error `INVALID_ARGUMENT`.
`json_data`	`string` Representación de cadena JSON del documento. Debe ajustarse al `Schema` registrado o se producirá un error `INVALID_ARGUMENT`.

AclInfo

Información de la LCA del documento.

Campos

readers[]

AccessRestriction

Lectores del documento.

AccessRestriction

AclRestriction para modelar restricciones de herencia complejas.

Ejemplo: modelización de una herencia de tipo "Permitir ambos", en la que, para acceder a un documento secundario, el usuario debe tener acceso al documento principal.

Jerarquía del documento - Espacio_S --> Página_P.

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

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

Contenido

Datos no estructurados vinculados a este documento.

Campos
`mime_type`	`string` Tipo MIME del contenido. Tipos admitidos: `application/pdf` (PDF, por ahora solo se admiten 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`. El contenido del documento no estructurado. `content` solo puede ser una de estas dos opciones:
`raw_bytes`	`bytes` El contenido representado como un flujo de bytes. La longitud máxima es de 1.000.000 de bytes (1 MB o aproximadamente 0,95 MiB). Nota: Al igual que todos los campos `bytes`, este campo se representa como binario puro en Protocol Buffers y como una cadena codificada en base64 en JSON. Por ejemplo, `abc123!?$*&()'-=@~` debe representarse como `YWJjMTIzIT8kKiYoKSctPUB+` en JSON. Consulta https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` URI del contenido. Solo se admiten URIs de Cloud Storage (por ejemplo, `gs://bucket-name/path/to/file`). El tamaño máximo de archivo es de 2, 5 MB para los formatos basados en texto y de 200 MB para otros formatos.

IndexStatus

Estado de indexación del documento.

Campos

index_time

La hora en la que se indexó el documento. Si este campo está rellenado, significa que el documento se ha indexado.

error_samples[]

LayoutBasedChunkingConfig

Una muestra de los errores que se han producido al indexar el documento. Si este campo se rellena, el documento no se indexa debido a errores.

pending_message

string

Inmutable. El mensaje indica que se está creando el índice del documento. Si este campo está rellenado, el índice del documento está pendiente.

DocumentInfo

Información detallada del documento asociado a un evento de usuario.

Campos
`promotion_ids[]`	`string` IDs de las promociones asociadas a este documento. Actualmente, este campo está limitado a un ID como máximo.
`joined`	`bool` Solo de salida. Indica si se puede encontrar el documento de referencia en el almacén de datos.
Campo de unión `document_descriptor`. 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}` al anotar con el documento almacenado. Si se especifica `name`, se usarán los valores proporcionados (se permiten valores predeterminados) de `{location}`, `{collection_id}`, `{data_store_id}` y `{branch_id}` al anotar con el documento almacenado. `document_descriptor` solo puede ser una de estas dos opciones:
`id`	`string` El ID de recurso `Document`.
`name`	`string` El nombre completo del recurso `Document`, con el formato `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` El URI `Document` solo se permite en los almacenes de datos de sitios web.
`quantity`	`int32` Cantidad del documento asociado al evento de usuario. El valor predeterminado es 1. Por ejemplo, este campo es 2 si hay dos cantidades del mismo documento en un evento `add-to-cart`. Obligatorio para los eventos de los siguientes tipos: `add-to-cart` `purchase`
`conversion_value`	`float` Opcional. Valor de conversión asociado a este documento. Se debe definir si `UserEvent.event_type` es "conversion". Por ejemplo, el valor 1000 significa que se han dedicado 1000 segundos a ver un documento del tipo de conversión `watch`.

DocumentProcessingConfig

Un recurso singleton de DataStore. Si está vacío cuando se crea DataStore y DataStore se define como DataStore.ContentConfig.CONTENT_REQUIRED, el analizador predeterminado se convertirá en el analizador digital.

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

ChunkingConfig

Configuración de la configuración de fragmentación.

Campos

Campo de unión chunk_mode. Configuraciones adicionales que definen el comportamiento de la fragmentación. chunk_mode solo puede ser una de estas dos opciones:

layout_based_chunking_config

Configuración de la fragmentación basada en el diseño.

LayoutBasedChunkingConfig

Configuración de la fragmentación basada en el diseño.

Campos

chunk_size

int32

El límite de tamaño de los tokens de cada fragmento.

Valores admitidos: de 100 a 500 (inclusive). Valor predeterminado: 500.

include_ancestor_headings

bool

Indica si se deben añadir diferentes niveles de encabezados a los fragmentos desde la mitad del documento para evitar la pérdida de contexto.

Valor predeterminado: False.

ParsingConfig

Configuraciones relacionadas que se aplican a un tipo específico de analizador de documentos.

Campos
Campo de unión `type_dedicated_config`. Configuraciones de los tipos de procesamiento de documentos. `type_dedicated_config` solo puede ser una de estas dos opciones:
`digital_parsing_config`	`DigitalParsingConfig` Configuraciones aplicadas al analizador digital.
`ocr_parsing_config`	`OcrParsingConfig` Configuraciones aplicadas al analizador de OCR. Actualmente, solo se aplica a los PDFs.
`layout_parsing_config`	`LayoutParsingConfig` Configuraciones aplicadas al analizador de diseño.

DigitalParsingConfig

Este tipo no tiene campos.

Las configuraciones de análisis digital de documentos.

LayoutParsingConfig

Las configuraciones de análisis de diseño de los documentos.

Campos
`enable_table_annotation`	`bool` Opcional. Si es true, la anotación basada en LLM se añade a la tabla durante el análisis.
`enable_image_annotation`	`bool` Opcional. Si es true, la anotación basada en LLM se añade a la imagen durante el análisis.
`structured_content_types[]`	`string` Opcional. Contiene los tipos de estructura necesarios para extraerlos 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 true, el documento procesado estará disponible para la API GetProcessedDocument.

OcrParsingConfig

Configuraciones de análisis de OCR para documentos.

Campos

enhanced_document_elements[]
(deprecated)

string

[DEPRECATED] Este campo está obsoleto. Para usar el procesamiento mejorado adicional de elementos de documentos, cambia a layout_parsing_config.

use_native_text

bool

Si se le asigna el valor true, 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

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.EnableAdvancedSiteSearch. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

RecommendedForYouFeatureConfig

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

EnableAdvancedSiteSearchRequest

Mensaje de solicitud del 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 del método SiteSearchEngineService.EnableAdvancedSiteSearch.

Engine

Metadatos que describen los parámetros de entrenamiento y servicio de un Engine.

Campos
`name`	`string` Inmutable. Identificador. Nombre completo del recurso del motor. Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` engine debe tener entre 1 y 63 caracteres, y los caracteres válidos son /[a-z0-9][a-z0-9-_]*/. De lo contrario, se devuelve un error INVALID_ARGUMENT.
`display_name`	`string` Obligatorio. Nombre visible del motor. Debe ser legible. Cadena codificada en UTF-8 con un límite de 1024 caracteres.
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de la creación del motor de recomendaciones.
`update_time`	`Timestamp` Solo de salida. Marca de tiempo de la última actualización de Recommendation Engine.
`data_store_ids[]`	`string` Opcional. Los almacenes de datos asociados a este motor. En el caso de los buscadores de tipo `SOLUTION_TYPE_SEARCH` y `SOLUTION_TYPE_RECOMMENDATION`, solo pueden asociarse con un almacén de datos como máximo. Si `solution_type` es `SOLUTION_TYPE_CHAT`, se pueden asociar varios `DataStore`s 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. Las soluciones del motor.
`industry_vertical`	`IndustryVertical` Opcional. El vertical del sector que registra el motor. La restricción de la vertical del sector de buscadores se basa en `DataStore`: la vertical del buscador debe coincidir con la vertical del almacén de datos vinculado al buscador.
`common_config`	`CommonConfig` 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 de motor. NOTA: Se trata de un concepto nuevo que no depende del vertical del sector ni del tipo de solución.
`disable_analytics`	`bool` Opcional. Indica si se deben inhabilitar las analíticas de las búsquedas realizadas en este buscador.
`features`	`map<string, FeatureState>` Opcional. Configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas: `*`: todas las funciones. Si este valor está presente, se ignoran todos los demás ajustes de estado de las funciones. `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. Configuración del método de facturación configurable.
Campo de unión `engine_config`. Especificaciones de configuración adicionales que definen el comportamiento del motor. `engine_config` solo puede ser una de estas dos opciones:
`chat_engine_config`	`ChatEngineConfig` Configuraciones de Chat Engine. Solo se aplica si `solution_type` es `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Configuraciones del buscador. Solo se aplica si `solution_type` es `SOLUTION_TYPE_SEARCH`.
`media_recommendation_engine_config`	`MediaRecommendationEngineConfig` Configuraciones de Media Engine. Solo se aplica a los almacenes de datos de los verticales `solution_type` `SOLUTION_TYPE_RECOMMENDATION` y `IndustryVertical.MEDIA`.
Campo de unión `engine_metadata`. Metadatos del buscador para monitorizar el estado del buscador. `engine_metadata` solo puede ser una de estas dos opciones:
`chat_engine_metadata`	`ChatEngineMetadata` Solo de salida. Información adicional sobre el motor de chat. Solo se aplica si `solution_type` es `SOLUTION_TYPE_CHAT`.

AppType

La aplicación del motor.

Enumeraciones
`APP_TYPE_UNSPECIFIED`	Todas las aplicaciones no especificadas.
`APP_TYPE_INTRANET`	Tipo de aplicación para la búsqueda en la intranet y Agentspace.

ChatEngineConfig

Configuraciones de un Chat Engine.

Campos

agent_creation_config

AgentCreationConfig

La configuración para generar el agente de Dialogflow asociado a este Engine.

Ten en cuenta que el servicio Dialogflow usa estas configuraciones una sola vez. Esto significa que no se pueden recuperar mediante las APIs EngineService.GetEngine o EngineService.ListEngines después de crear el motor.

dialogflow_agent_to_link

string

Nombre de recurso de un agente de Dialogflow que ya exista para vincularlo 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 los dialogflow_agent_to_link se consumen una sola vez y se transfieren al servicio de Dialogflow. Esto significa que no se pueden recuperar mediante las APIs EngineService.GetEngine o EngineService.ListEngines después de crear el motor. Usa ChatEngineMetadata.dialogflow_agent para asociar el agente después de crear el buscador.

allow_cross_region

bool

Opcional. Si la marca se define como "true", permitimos que el agente y el motor estén en ubicaciones diferentes. De lo contrario, el agente y el motor deben estar en la misma ubicación. La marca tiene el valor "false" de forma predeterminada.

Ten en cuenta que los allow_cross_region se consumen una sola vez y se transfieren a EngineService.CreateEngine. Esto significa que no se pueden recuperar mediante las APIs EngineService.GetEngine o EngineService.ListEngines después de crear el motor.

AgentCreationConfig

Configuraciones para generar un agente de Dialogflow.

Campos
`business`	`string` Nombre de la empresa, organización u otra entidad a la que representa el agente. Se usa para la petición del LLM del conector de conocimientos y para la búsqueda de conocimientos.
`default_language_code`	`string` Obligatorio. El idioma predeterminado del agente como etiqueta de idioma. Consulta el apartado sobre compatibilidad de idiomas para obtener una lista de los códigos de idioma admitidos actualmente.
`time_zone`	`string` Obligatorio. La zona horaria del agente de la base de datos de zonas horarias, por ejemplo: America/New_York, Europe/Paris.
`location`	`string` Ubicación del agente para la creación de agentes. Valores admitidos: global, us o eu. Si no se proporciona, el motor de EE. UU. creará el agente con us-central-1 de forma predeterminada, mientras que el motor de la UE lo creará con eu-west-1 de forma predeterminada.

ChatEngineMetadata

Información adicional de un Chat Engine. Los campos de este mensaje son de solo salida.

Campos

dialogflow_agent

string

Nombre de recurso de un agente de Dialogflow al que hace referencia este Chat Engine.

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

CommonConfig

Configuraciones habituales de un motor.

Campos

company_name

string

Nombre de la empresa, el negocio o la entidad asociados al motor. Si lo haces, puede que mejoren las funciones relacionadas con LLMs.

ConfigurableBillingApproach

Configuración del método de facturación configurable.

Enumeraciones
`CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED`	Valor predeterminado. Enfoque de facturación no configurable para Spark y no Spark. Modelo de precios general.
`CONFIGURABLE_BILLING_APPROACH_ENABLED`	El método de facturación sigue las configuraciones especificadas por el cliente.

FeatureState

El estado de la función del motor.

Enumeraciones
`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

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

Campos
`type`	`string` Obligatorio. El tipo de motor. Por ejemplo: `recommended-for-you`. Este campo, junto con `optimization_objective`, describe los metadatos del buscador que se usarán para controlar el entrenamiento y la publicación del buscador. Valores admitidos actualmente: `recommended-for-you`, `others-you-may-like`, `more-like-this` y `most-popular-items`.
`optimization_objective`	`string` El objetivo de optimización. Por ejemplo: `cvr`. Este campo, junto con `optimization_objective`, describe los metadatos del buscador que se usarán para controlar el entrenamiento y la publicación del buscador. Valores admitidos actualmente: `ctr` y `cvr`. Si no se especifica, elegimos el valor predeterminado en función del 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 de cvr para optimization_objective. En el caso de 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 0 e incluye 86400). Por ejemplo, 90). En el caso de target_field `watch-percentage`, target_field_value debe ser un valor flotante válido entre (0, 1.0] (excluye 0 e incluye 1.0) (por ejemplo, 0,5).
`training_state`	`TrainingState` El estado de entrenamiento en el que se encuentra el motor (por ejemplo, `TRAINING` o `PAUSED`). Como parte del coste de ejecutar el servicio es la frecuencia de entrenamiento, se puede usar para determinar cuándo entrenar el motor y, así, controlar los costes. Si no se especifica, el valor predeterminado del método `CreateEngine` es `TRAINING`. El valor predeterminado del método `UpdateEngine` es mantener el estado igual que antes.
`engine_features_config`	`EngineFeaturesConfig` Opcional. Configuración de funciones adicionales del motor.

EngineFeaturesConfig

Más configuraciones de funciones del tipo de motor seleccionado.

Campos

Campo de unión type_dedicated_config. Configuraciones relacionadas con funciones aplicadas a un tipo específico de motores de recomendaciones de contenido multimedia. type_dedicated_config solo puede ser una de estas dos opciones:

recommended_for_you_config

Configuración recomendada para la función de motor.

most_popular_config

MostPopularFeatureConfig

Configuración de las funciones más populares del motor.

MostPopularFeatureConfig

Configuraciones de funciones necesarias para crear un motor Más populares.

Campos

time_window_days

int64

Ventana temporal en la que se consulta el motor durante el entrenamiento y la predicción. Solo números enteros positivos. El valor se traduce en los últimos X días de eventos. Actualmente, es obligatorio para el motor most-popular-items.

OptimizationObjectiveConfig

Umbral personalizado para cvr optimization_objective.

Campos

target_field

string

Obligatorio. Nombre del campo al que se va a orientar. Valores admitidos actualmente: watch-percentage y watch-time.

target_field_value_float

float

Obligatorio. El umbral que se va a aplicar al objetivo (por ejemplo, 0,5).

RecommendedForYouFeatureConfig

Configuraciones adicionales para crear un buscador recommended-for-you.

Campos

context_event_type

string

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

TrainingState

El estado de entrenamiento del motor.

Enumeraciones
`TRAINING_STATE_UNSPECIFIED`	Estado de entrenamiento no especificado.
`PAUSED`	El entrenamiento del motor está en pausa.
`TRAINING`	El motor se está entrenando.

SearchEngineConfig

Configuraciones de un buscador.

Campos

search_tier

SearchTier

Nivel de la función de búsqueda de este buscador.

Los precios pueden variar en función del nivel. Para obtener más información, consulta la documentación sobre los precios.

Si no se especifica, se asigna el valor SearchTier.SEARCH_TIER_STANDARD de forma predeterminada.

search_add_ons[]

SearchAddOn

El complemento que habilita este buscador.

FactChunk

Fact Chunk.

Campos
`chunk_text`	`string` Contenido de texto del fragmento de información. Puede tener como máximo 10.000 caracteres.
`source`	`string` Fuente de la que se ha obtenido este fragmento de información. Si se ha obtenido de los GroundingFacts proporcionados en la solicitud, este campo contendrá el índice del dato específico del que se ha obtenido este fragmento.
`index`	`int32` Índice de este fragmento. Actualmente, solo se usa en el modo de streaming.
`source_metadata`	`map<string, string>` Información más detallada sobre la referencia de la fuente.
`uri`	`string` URI de la fuente.
`title`	`string` El título de la fuente.
`domain`	`string` El dominio de la fuente.

FetchDomainVerificationStatusRequest

Mensaje de solicitud del método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

site_search_engine

string

Obligatorio. El recurso del buscador de sitios en el que obtenemos todo el estado de verificación del dominio. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Tamaño de la página solicitado. El servidor puede devolver menos elementos de los solicitados. Si no se especifica, el servidor elegirá un valor predeterminado adecuado. El valor máximo es 1000; los valores superiores a este límite se convertirán a 1000.

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

page_token

string

Token de página recibido de una llamada FetchDomainVerificationStatus anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a FetchDomainVerificationStatus deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

FetchDomainVerificationStatusResponse

Mensaje de respuesta del método SiteSearchEngineService.FetchDomainVerificationStatus.

Campos

target_sites[]

Lista de TargetSites que contiene el estado de verificación del sitio.

next_page_token

string

Token que se puede enviar como page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

total_size

int32

Número total de elementos que coinciden con la solicitud. Este campo siempre se rellenará en la respuesta.

FetchSitemapsRequest

Mensaje de solicitud del método SiteSearchEngineService.FetchSitemaps.

Campos

parent

string

Obligatorio. Nombre del recurso superior de SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

matcher

Matcher

Opcional. Si se especifica, obtiene los Sitemaps correspondientes. Si no se especifica, se obtienen todos los Sitemaps del DataStore.

Objeto de comparación

Objeto de comparación de Sitemap. Actualmente, solo admite el matcher de URIs.

Campos

Campo de unión matcher. Objeto de comparación de Sitemap. matcher solo puede ser una de estas dos opciones:

uris_matcher

UrisMatcher

Matcher por URIs de sitemap.

UrisMatcher

Matcher para los Sitemaps por sus URIs.

Campos

uris[]

string

Las URIs de Sitemap.

FetchSitemapsResponse

Mensaje de respuesta del método SiteSearchEngineService.FetchSitemaps.

Campos

sitemaps_metadata[]

SitemapMetadata

Lista de Sitemaps obtenidas.

SitemapMetadata

Contiene un Sitemap y sus metadatos.

Campos

sitemap

Sitemap

El Sitemap.

FhirStoreSource

Cloud FhirStore desde el que se importan los datos.

Campos
`fhir_store`	`string` Obligatorio. Nombre de recurso completo del almacén FHIR del que se van a importar los datos, con el formato `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.
`gcs_staging_dir`	`string` Directorio intermedio de Cloud Storage que se usa para la importación,con un límite de longitud de 2000 caracteres. Se puede especificar si se quiere que FhirStore exporte a un directorio de Cloud Storage concreto.
`resource_types[]`	`string` Los tipos de recursos FHIR que se van a importar. Los tipos de recursos deben ser un subconjunto de todos los tipos de recursos FHIR admitidos. Si está vacío, se usarán 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 true, el esquema de DataStore se actualizará para incluir los campos o tipos de recursos FHIR que se hayan añadido desde la última importación y se importarán los recursos FHIR correspondientes del almacén FHIR. Nota: Este campo no se puede usar junto con `resource_types`. Debe usarse después de la importación inicial.

FirestoreSource

Fuente de Firestore de la que se importan los datos.

Campos
`project_id`	`string` 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. La base de datos de Firestore de la que se copiarán los datos, con un límite de 256 caracteres.
`collection_id`	`string` Obligatorio. La colección (o entidad) de Firestore de la que se copiarán los datos,con un límite de 1500 caracteres.
`gcs_staging_dir`	`string` Directorio intermedio de Cloud Storage que se usa para la importación,con un límite de longitud de 2000 caracteres. Se puede especificar si se quiere que la exportación de Firestore se realice a un directorio de Cloud Storage concreto. 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 del contenido de entrada.

Campos

input_uris[]

string

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

Una solicitud puede contener un máximo de 100 archivos (o 100.000 archivos si data_schema es content). Cada archivo puede tener un tamaño de hasta 2 GB (o 100 MB si data_schema es content).

data_schema

string

Esquema que se usa al analizar los datos de la fuente.

Valores admitidos para las importaciones de documentos:

document (opción predeterminada): un JSON Document por línea. Cada documento debe tener un Document.id válido.
content: datos no estructurados (por ejemplo, PDF o HTML). Cada archivo que coincida con input_uris se convertirá en un documento, cuyo ID será los primeros 128 bits de SHA256(URI) codificados como una cadena hexadecimal.
custom: un JSON de datos personalizados por fila en formato arbitrario que se ajuste al Schema definido del almacén de datos. Solo puede usarlo la vertical GENERIC Data Store.
csv: un archivo CSV con un encabezado que se ajuste al Schema definido del almacén de datos. Cada entrada después del encabezado se importa como un documento. Solo puede usarlo el vertical GENERIC Data Store.

Valores admitidos para las importaciones de eventos de usuario:

user_event (opción predeterminada): un JSON UserEvent por línea.

GetAclConfigRequest

Mensaje de solicitud del método GetAclConfigRequest.

Campos

name

string

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

Si la persona que llama no tiene permiso para acceder a AclConfig, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

GetAnswerRequest

Solicitud del método GetAnswer.

Campos

name

string

Obligatorio. Nombre de recurso de la respuesta que se va a obtener. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}

GetAssistAnswerRequest

Mensaje de solicitud del método AssistAnswerService.GetAssistAnswer.

Campos

name

string

Obligatorio. Nombre de recurso de AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}

GetAssistantRequest

Mensaje de solicitud del método AssistantService.GetAssistant.

Campos

name

string

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

GetCmekConfigRequest

Mensaje de solicitud del método GetCmekConfigRequest.

Campos

name

string

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

Si la persona que llama no tiene permiso para acceder a CmekConfig, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

GetControlRequest

Solicitud del método GetControl.

Campos

name

string

Obligatorio. Nombre de recurso del control que se va a obtener. Formato: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}

GetConversationRequest

Solicitud del método GetConversation.

Campos

name

string

Obligatorio. Nombre de recurso de la conversación que se va a obtener. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataConnectorRequest

Solicitud del método DataConnectorService.GetDataConnector.

Campos

name

string

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

Si la persona que llama no tiene permiso para acceder a DataConnector, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

GetDataStoreRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para acceder a DataStore, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

GetDocumentRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para acceder a Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

GetEngineRequest

Mensaje de solicitud del 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 de IdentityMappingStoreService.GetIdentityMappingStore

Campos

name

string

Obligatorio. Nombre del almacén de asignaciones de identidades que se va a obtener. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

GetLicenseConfigRequest

Mensaje de solicitud del método LicenseConfigService.GetLicenseConfig.

Campos

name

string

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

Si la persona que llama no tiene permiso para acceder a LicenseConfig, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

GetSchemaRequest

Mensaje de solicitud del método SchemaService.GetSchema.

Campos

name

string

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

GetSessionRequest

Solicitud del método GetSession.

Campos

name

string

Obligatorio. Nombre de recurso de la sesión que se va a obtener. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}

include_answer_details

bool

Opcional. Si se le asigna el valor "true", se devolverá la sesión completa, incluidos todos los detalles de las respuestas.

GetSiteSearchEngineRequest

Mensaje de solicitud del método SiteSearchEngineService.GetSiteSearchEngine.

Campos

name

string

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

Si la persona que llama no tiene permiso para acceder a [SiteSearchEngine], independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

GetTargetSiteRequest

Mensaje de solicitud del 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 la persona que llama no tiene permiso para acceder a TargetSite, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

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

GroundingFact

Fundamentación de los hechos.

Campos

fact_text

string

Contenido de texto del dato. Puede tener como máximo 10.000 caracteres.

attributes

map<string, string>

Atributos asociados al hecho. Entre los atributos comunes se incluyen source (que indica de dónde se ha obtenido el dato) y author (que indica el autor del dato), entre otros.

HarmCategory

Categorías de daño que bloquearán el contenido.

Enumeraciones
`HARM_CATEGORY_UNSPECIFIED`	La categoría de daño no se ha especificado.
`HARM_CATEGORY_HATE_SPEECH`	La categoría de contenido dañino es incitación al odio.
`HARM_CATEGORY_DANGEROUS_CONTENT`	La categoría de daño es contenido peligroso.
`HARM_CATEGORY_HARASSMENT`	La categoría de daño es acoso.
`HARM_CATEGORY_SEXUALLY_EXPLICIT`	La categoría de daño es contenido sexual explícito.
`HARM_CATEGORY_CIVIC_INTEGRITY`	La categoría de daño es integridad cívica.

HealthcareFhirConfig

Configuración del almacén de datos de la vertical HEALTHCARE_FHIR.

Campos

enable_configurable_schema

bool

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

Si se define como true, el esquema FHIR de asistencia sanitaria predefinido se puede ampliar para realizar búsquedas y filtros más personalizados.

enable_static_indexing_for_batch_ingestion

bool

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

Si se define como true, la ingestión por lotes se procesará en un modo de indexación estático, que es más lento, pero puede gestionar un mayor volumen.

IdentityMappingEntry

Entrada de mapeado de identidades que mapea una identidad externa con una interna.

Campos
`external_identity`	`string` Obligatorio. Identidad fuera del proveedor de identidades del cliente. La longitud máxima 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 identidades puede ser un usuario o un grupo. `identity_provider_id` solo puede ser una de estas dos opciones:
`user_id`	`string` Identificador de usuario. En el caso de las cuentas de usuario de Google Workspace, user_id debe ser el correo del usuario de Google Workspace. En el caso de los proveedores de identidades que no son de Google, user_id es el identificador de usuario asignado que se configura durante la configuración de WorkforcePool.
`group_id`	`string` Identificador del grupo. En el caso de las cuentas de usuario de Google Workspace, group_id debe ser el correo del grupo de Google Workspace. En el caso de los proveedores de identidades que no son de Google, group_id es el identificador de grupo asignado que se configura durante la configuración de workforcepool.

IdentityMappingEntryOperationMetadata

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

Campos

success_count

int64

Número de IdentityMappingEntries que se han procesado correctamente.

failure_count

int64

Número de IdentityMappingEntries que no se han podido procesar.

total_count

int64

Número total de IdentityMappingEntries que se han procesado.

IdentityMappingStore

Almacén de mapeo de identidades que contiene entradas de mapeo de identidades.

Campos

name

string

Inmutable. Nombre completo del recurso del almacén de asignaciones de identidad. Formato: projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}. Este campo debe ser una cadena codificada en UTF-8 con un límite de 1024 caracteres.

kms_key_name

string

Solo de entrada. Clave de KMS que se usará para proteger este almacén de asignaciones de identidad en el momento de la creación.

Se debe definir en las solicitudes que deban cumplir las protecciones de la política de organización de CMEK.

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

cmek_config

CmekConfig

Solo de salida. Información relacionada con CMEK de Identity Mapping Store.

IdentityScheduleConfig

La configuración de las ejecuciones de sincronización de datos de identidad.

Campos

refresh_interval

Duration

Opcional. Intervalo de actualización para sincronizar la información de la lista de control de acceso de los documentos insertados por este conector. Si no se establece esta política, la lista de control de acceso se actualizará con el intervalo predeterminado de 30 minutos. El intervalo de actualización de la identidad puede ser de 30 minutos como mínimo y de 7 días como máximo.

next_sync_time

DateTime

Opcional. Hora UTC en la que se espera que empiece la próxima sincronización de datos del conector de datos. Los clientes solo pueden especificar la hora y los minutos 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 identidades.

Campos

idp_type

IdpType

Tipo de proveedor de identidades configurado.

external_idp_config

ExternalIdpConfig

Configuración de proveedor de identidades externo.

ExternalIdpConfig

Configuración de proveedor de identidades de terceros

Campos

workforce_pool_name

string

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

IdpType

Tipo de proveedor de identidades.

Enumeraciones
`IDP_TYPE_UNSPECIFIED`	Valor predeterminado. La búsqueda de ACL no está habilitada.
`GSUITE`	Proveedor de datos propios de Google.
`THIRD_PARTY`	Proveedor externo.

ImportCompletionSuggestionsMetadata

Metadatos relacionados con el progreso de la operación ImportCompletionSuggestions. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de `CompletionSuggestion`s importados correctamente.
`failure_count`	`int64` Número de `CompletionSuggestion`s que no se han podido importar.

ImportCompletionSuggestionsRequest

Mensaje de solicitud del método CompletionService.ImportCompletionSuggestions.

Campos
`parent`	`string` Obligatorio. Nombre del recurso de almacén de datos superior para el que se importarán las sugerencias de autocompletar de los clientes. Sigue el patrón `projects//locations//collections//dataStores/`
`error_config`	`ImportErrorConfig` La ubicación deseada de los errores producidos durante la importación.
Campo de unión `source`. La fuente de las sugerencias de autocompletado. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` La fuente insertada de las entradas de sugerencias.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage del contenido de entrada.
`bigquery_source`	`BigQuerySource` Fuente de entrada de BigQuery.

InlineSource

Fuente insertada de CompletionSuggestions.

Campos

suggestions[]

CompletionSuggestion

Obligatorio. Lista de todas las entradas de la lista de denegación que se van a importar. Máximo de 1000 elementos.

ImportCompletionSuggestionsResponse

Respuesta del método CompletionService.ImportCompletionSuggestions. Si la operación de larga duración se ha completado, este mensaje se devuelve en el campo google.longrunning.Operations.response si la operación se ha realizado correctamente.

Campos

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

error_config

ImportErrorConfig

La ubicación deseada de los errores producidos durante la importación.

ImportDocumentsMetadata

Metadatos relacionados con el progreso de la operación ImportDocuments. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de entradas que se han procesado correctamente.
`failure_count`	`int64` Número de entradas en las que se han detectado errores durante el procesamiento.
`total_count`	`int64` Número total de entradas que se han procesado.

ImportDocumentsRequest

Mensaje de solicitud de métodos de importación.

Campos
`parent`	`string` Obligatorio. Nombre de recurso de la rama superior, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requiere permiso de creación o actualización.
`error_config`	`ImportErrorConfig` La ubicación deseada de los errores producidos durante la importación.
`reconciliation_mode`	`ReconciliationMode` El modo de conciliación entre los documentos que ya existen y los que se van a importar. El valor predeterminado es `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indica qué campos de los documentos importados proporcionados se van a actualizar. Si no se define, se actualizarán todos los campos de forma predeterminada.
`auto_generate_ids`	`bool` Indica si se deben generar automáticamente los IDs de los documentos si no se proporcionan. Si se define como `true`, los `Document.id`s se generan automáticamente en función del hash de la carga útil, por lo que es posible que los IDs no sean coherentes durante varias importaciones. En ese caso, es muy recomendable usar `ReconciliationMode.FULL` para evitar el contenido duplicado. Si no se define o se le asigna el valor `false`, los `Document.id`s se deben especificar mediante `id_field`. De lo contrario, no se podrán importar los documentos sin IDs. Fuentes de datos admitidas: `GcsSource`. `GcsSource.data_schema` debe ser `custom` o `csv`. De lo contrario, se producirá un error INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` debe ser `custom` o `csv`. De lo contrario, se producirá un error INVALID_ARGUMENT. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` Este campo indica el campo o la columna de ID que se va a usar como ID único de los documentos. En `GcsSource`, es la clave del campo JSON. Por ejemplo, `my_id` para JSON `{"my_id": "some_uuid"}`. En otros casos, 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 `Document.id`s. El campo JSON o la columna de la tabla deben ser de tipo cadena y los valores deben definirse como cadenas válidas que cumplan la RFC-1034 con una longitud de entre 1 y 63 caracteres. De lo contrario, no se podrán importar los documentos sin IDs válidos. Solo debes definir este campo si `auto_generate_ids` no tiene ningún valor asignado o si se le asigna el valor `false`. De lo contrario, se producirá un error INVALID_ARGUMENT. Si no se define, se usará el valor predeterminado `_id` al importar datos de las fuentes de datos permitidas. Fuentes de datos admitidas: `GcsSource`. `GcsSource.data_schema` debe ser `custom` o `csv`. De lo contrario, se producirá un error INVALID_ARGUMENT. `BigQuerySource`. `BigQuerySource.data_schema` debe ser `custom` o `csv`. De lo contrario, se producirá 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 asigna el valor `true`, la parte del contenido de los documentos se actualizará independientemente del estado de actualización del contenido de referencia.
Campo de unión `source`. Obligatorio. La fuente de la entrada. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` La fuente insertada del contenido de entrada de los documentos.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage del contenido de entrada.
`bigquery_source`	`BigQuerySource` Fuente de entrada de BigQuery.
`fhir_store_source`	`FhirStoreSource` Fuente de entrada de FhirStore.
`spanner_source`	`SpannerSource` Fuente de entrada de Spanner.
`cloud_sql_source`	`CloudSqlSource` Fuente de entrada de Cloud SQL.
`firestore_source`	`FirestoreSource` Fuente de entrada de Firestore.
`alloy_db_source`	`AlloyDbSource` Fuente de entrada de AlloyDB.
`bigtable_source`	`BigtableSource` Fuente de entrada de Cloud Bigtable.

InlineSource

Fuente insertada de la configuración de entrada del método ImportDocuments.

Campos

documents[]

Obligatorio. Lista de documentos que se van a 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 creados o importados anteriormente.

Enumeraciones
`RECONCILIATION_MODE_UNSPECIFIED`	El valor predeterminado es `INCREMENTAL`.
`INCREMENTAL`	Inserta documentos nuevos o actualiza documentos que ya tengas.
`FULL`	Calcula la diferencia y sustituye todo el conjunto de datos del documento. Los documentos que ya existan se pueden eliminar si no están en la ubicación de origen. Cuando se usa este modo, no hay tiempo de inactividad en el conjunto de datos de destino. Los documentos que no deban cambiar o que deban actualizarse seguirán publicándose mientras se lleve a cabo la operación.

ImportDocumentosResponse

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

Campos

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

error_config

ImportErrorConfig

Muestra el destino de los errores completos de la solicitud, si se ha definido.

ImportErrorConfig

Configuración del destino de los errores relacionados con la importación.

Campos

Campo de unión destination. Obligatorio. Destino de errores. destination solo puede ser una de estas dos opciones:

gcs_prefix

string

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

ImportIdentityMappingsRequest

Mensaje de solicitud de IdentityMappingStoreService.ImportIdentityMappings

Campos

identity_mapping_store

string

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

Campo de unión source. La fuente de la entrada. source solo puede ser una de estas dos opciones:

inline_source

InlineSource

La fuente insertada desde la que se importarán las entradas de mapeado de identidades.

InlineSource

La fuente insertada desde la que se importarán las entradas de mapeado de identidades.

Campos

identity_mapping_entries[]

IdentityMappingEntry

Se pueden importar un máximo de 10.000 entradas a la vez

ImportIdentityMappingsResponse

Mensaje de respuesta a IdentityMappingStoreService.ImportIdentityMappings

Campos

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

ImportSuggestionDenyListEntriesMetadata

Metadatos relacionados con el progreso de la operación ImportSuggestionDenyListEntries. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

SuggestionDenyListEntry

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

ImportSuggestionDenyListEntriesRequest

Mensaje de solicitud del método CompletionService.ImportSuggestionDenyListEntries.

Campos
`parent`	`string` Obligatorio. Nombre del recurso del almacén de datos superior al que se importarán las entradas de la lista de denegación. Sigue el patrón projects//locations//collections//dataStores/.
Campo de unión `source`. La fuente de la SuggestionDenyList actualizada. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` Fuente insertada del contenido de entrada de las entradas de la lista de denegación de sugerencias.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage del contenido de entrada. Solo se puede especificar un archivo que contenga todas las entradas que se van a importar. Valores admitidos `gcs_source.schema` para las importaciones de entradas de la lista de denegación de sugerencias de Autocompletar: `suggestion_deny_list` (opción predeterminada): un JSON [SuggestionDenyListEntry] por línea.

InlineSource

Fuente insertada de SuggestionDenyListEntry.

Campos

entries[]

Obligatorio. Lista de todas las entradas de la lista de denegación que se van a importar. Máximo de 1000 elementos.

ImportSuggestionDenyListEntriesResponse

Mensaje de respuesta del método CompletionService.ImportSuggestionDenyListEntries.

Campos

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

imported_entries_count

int64

Número de entradas de la lista de denegación importadas correctamente.

failed_entries_count

int64

Número de entradas de la lista de denegación que no se han podido importar.

ImportUserEventsMetadata

Metadatos relacionados con el progreso de la operación de importación. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de entradas que se han procesado correctamente.
`failure_count`	`int64` Número de entradas en las que se han detectado errores durante el procesamiento.

ImportUserEventsRequest

Mensaje de solicitud de ImportUserEvents.

Campos
`parent`	`string` Obligatorio. Nombre de recurso DataStore superior, con el formato `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` La ubicación deseada de los errores producidos durante la importación. No se puede definir para importaciones de eventos de usuario insertados.
Campo de unión `source`. Obligatorio: la fuente de entrada deseada de los datos de eventos de usuario. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` La fuente insertada del contenido de entrada de UserEvents.
`gcs_source`	`GcsSource` Ubicación de Cloud Storage del contenido de entrada.
`bigquery_source`	`BigQuerySource` Fuente de entrada de BigQuery.

InlineSource

Fuente insertada de la configuración de entrada del método ImportUserEvents.

Campos

user_events[]

UserEvent

Obligatorio. Una lista de eventos de usuario que se van a importar. Se recomienda un máximo de 10.000 elementos.

ImportUserEventsResponse

Respuesta de ImportUserEventsRequest. Si la operación de larga duración se ha completado correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Una muestra de los errores detectados al procesar la solicitud.
`error_config`	`ImportErrorConfig` Devuelve el destino de los errores completos si este campo se ha definido en la solicitud.
`joined_events_count`	`int64` Recuento de eventos de usuario importados con documentos completos.
`unjoined_events_count`	`int64` Número de eventos de usuario importados, pero sin información de documento en la rama.

IndustryVertical

El vertical de sector asociado al DataStore.

Enumeraciones
`INDUSTRY_VERTICAL_UNSPECIFIED`	Valor que se usa cuando no se define.
`GENERIC`	Vertical genérica para documentos que no son específicos de ningún sector.
`MEDIA`	El vertical de la industria de los medios de comunicación.
`HEALTHCARE_FHIR`	Vertical de FHIR de Healthcare.

Intervalo

Un intervalo de punto flotante.

Campos

Campo de unión min. Límite inferior del intervalo. Si no se define ninguno de los campos mínimos, el límite inferior es infinito negativo.

Este campo no debe ser mayor que el valor máximo. De lo contrario, se devolverá un error INVALID_ARGUMENT. min solo puede ser una de estas dos opciones:

minimum

double

Límite inferior inclusivo.

exclusive_minimum

double

Límite inferior exclusivo.

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

Este campo no debe ser inferior al valor mínimo. De lo contrario, se devuelve un error INVALID_ARGUMENT. max solo puede ser una de estas dos opciones:

maximum

double

Límite superior inclusivo.

exclusive_maximum

double

Límite superior exclusivo.

LicenseConfig

Información sobre las licencias de los usuarios.

Campos
`name`	`string` Inmutable. Identificador. Nombre completo del recurso de la configuración de la licencia. Formato: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
`license_count`	`int64` Obligatorio. Número de licencias compradas.
`subscription_tier`	`SubscriptionTier` Obligatorio. Información del nivel de suscripción de la configuración de la licencia.
`state`	`State` Solo de salida. Estado de la configuración de la licencia.
`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. La fecha de inicio.
`end_date`	`Date` Opcional. Fecha de finalización prevista.
`subscription_term`	`SubscriptionTerm` Obligatorio. Periodo de vigencia de la 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. Configuración de la política de alertas de esta configuración de licencia.
`gemini_bundle`	`bool` Solo de salida. Indica si la configuración de la licencia es para el paquete de Gemini.

Estado

Enumeración del estado de la configuración de la licencia.

Enumeraciones
`STATE_UNSPECIFIED`	Valor predeterminado. La configuración de la licencia no existe.
`ACTIVE`	La configuración de la licencia está en vigor y se está usando.
`EXPIRED`	La configuración de la licencia ha caducado.
`NOT_STARTED`	La configuración de la licencia aún no ha empezado y su fecha de inicio es posterior a la actual.

ListAssistantsRequest

Mensaje de solicitud del método AssistantService.ListAssistants.

Campos

parent

string

Obligatorio. Nombre del recurso superior. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}

page_size

int32

Número máximo de Assistants que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores se reducirán a 1000.

page_token

string

Un token de página ListAssistantsResponse.next_page_token, recibido de una llamada AssistantService.ListAssistants anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a ListAssistants deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

ListAssistantsResponse

Mensaje de respuesta del método AssistantService.ListAssistants.

Campos

assistants[]

Assistant

Todos los Assistant del cliente.

next_page_token

string

Token que se puede enviar como ListAssistantsRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListCmekConfigsRequest

Mensaje de solicitud del método CmekConfigService.ListCmekConfigs.

Campos

parent

string

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

Si la persona que llama no tiene permiso para enumerar CmekConfigs en esta ubicación, independientemente de si existe o no un CmekConfig, se devuelve un error PERMISSION_DENIED.

ListCmekConfigsResponse

Mensaje de respuesta del método CmekConfigService.ListCmekConfigs.

Campos

cmek_configs[]

CmekConfig

Todos los CmekConfig del cliente.

ListControlsRequest

Solicitud del método ListControls.

Campos
`parent`	`string` Obligatorio. Nombre de 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. Número máximo de resultados que se devolverán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1000.
`page_token`	`string` Opcional. Token de página recibido de una llamada `ListControls` anterior. Proporciona este elemento para obtener la siguiente página.
`filter`	`string` Opcional. Filtro que se aplica a los resultados de la lista. Funciones incluidas: Muestra todos los productos de la rama principal si `filter` no está definido. Actualmente, este campo no se admite.

ListControlsResponse

Respuesta del método ListControls.

Campos

controls[]

Control

Todos los controles de un almacén de datos determinado.

next_page_token

string

Token de paginación. Si no se devuelve, indica que es la última página.

ListConversationsRequest

Solicitud del método ListConversations.

Campos
`parent`	`string` Obligatorio. Nombre de recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados que se devolverán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1000.
`page_token`	`string` Token de página recibido de una llamada `ListConversations` anterior. Proporciona este elemento para obtener la siguiente página.
`filter`	`string` 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` Lista separada por comas de campos por los que se ordenará el resultado, ordenados de forma ascendente. Usa "desc" después del nombre de un campo para ordenarlo de forma descendente. Campos admitidos: * `update_time` * `create_time` * `conversation_name` Ejemplo: "update_time desc" "create_time"

ListConversationsResponse

Respuesta del método ListConversations.

Campos

conversations[]

Todas las conversaciones de un almacén de datos concreto.

next_page_token

string

Token de paginación. Si no se devuelve, indica que es la última página.

ListCustomModelsRequest

Mensaje de solicitud del método SearchTuningService.ListCustomModels.

Campos

data_store

string

Obligatorio. Nombre de recurso del almacén de datos superior, como projects/*/locations/global/collections/default_collection/dataStores/default_data_store. Este campo se usa para identificar el almacén de datos del que se deben obtener los modelos.

ListCustomModelsResponse

Mensaje de respuesta del método SearchTuningService.ListCustomModels.

Campos

models[]

CustomTuningModel

Lista de modelos de ajuste personalizados.

ListDataStoresRequest

Mensaje de solicitud del método DataStoreService.ListDataStores.

Campos
`parent`	`string` Obligatorio. Nombre de recurso de la rama superior, como `projects/{project}/locations/{location}/collections/{collection_id}`. Si la persona que llama no tiene permiso para enumerar `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` Número máximo 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 error INVALID_ARGUMENT.
`page_token`	`string` Un token de página `ListDataStoresResponse.next_page_token`, recibido de una llamada `DataStoreService.ListDataStores` anterior. Proporciona este elemento para obtener la siguiente página. Al hacer la paginación, todos los demás parámetros proporcionados a `DataStoreService.ListDataStores` deben ser los mismos que aparecen en la llamada que proporcionó el token de la página. De lo contrario, se devuelve un error INVALID_ARGUMENT.
`filter`	`string` Filtra por tipo de solución . Por ejemplo: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`

ListDataStoresResponse

Mensaje de respuesta del método DataStoreService.ListDataStores.

Campos

data_stores[]

DataStore

Todos los DataStore del cliente.

next_page_token

string

Token que se puede enviar como ListDataStoresRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListDocumentsRequest

Mensaje de solicitud del método DocumentService.ListDocuments.

Campos

parent

string

Obligatorio. Nombre de recurso de la rama superior, como projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Usa default_branch como ID de rama para mostrar los documentos de la rama predeterminada.

Si la persona que llama no tiene permiso para enumerar Documents en esta rama, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

page_size

int32

Número máximo de Documents que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores a 1000 se establecen en 1000.

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

page_token

string

Un token de página ListDocumentsResponse.next_page_token, recibido de una llamada DocumentService.ListDocuments anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a DocumentService.ListDocuments deben ser los mismos que aparecen en la llamada que proporcionó el token de la página. De lo contrario, se devuelve un error INVALID_ARGUMENT.

ListDocumentsResponse

Mensaje de respuesta del método DocumentService.ListDocuments.

Campos

documents[]

Los Document.

next_page_token

string

Token que se puede enviar como ListDocumentsRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListEnginesRequest

Mensaje de solicitud del método EngineService.ListEngines.

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

ListEnginesResponse

Mensaje de respuesta del método EngineService.ListEngines.

Campos

engines[]

Engine

Todos los Engine del cliente.

next_page_token

string

No es compatible.

ListIdentityMappingStoresRequest

Mensaje de solicitud de IdentityMappingStoreService.ListIdentityMappingStores

Campos

parent

string

Obligatorio. Elemento superior de los Identity Mapping Stores que se van a enumerar. Formato: projects/{project}/locations/{location}.

page_size

int32

Número máximo de IdentityMappingStores que se devolverán. Si no se especifica, el valor predeterminado es 100. El valor máximo permitido es 1000. Los valores superiores a 1000 se convertirán a 1000.

page_token

string

Token de página recibido de una llamada ListIdentityMappingStores anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a ListIdentityMappingStores deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

ListIdentityMappingStoresResponse

Mensaje de respuesta a IdentityMappingStoreService.ListIdentityMappingStores

Campos

identity_mapping_stores[]

IdentityMappingStore

Las tiendas de mapeado de identidades.

next_page_token

string

Token que se puede enviar como page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListIdentityMappingsRequest

Mensaje de solicitud de IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_store

string

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

page_size

int32

Número máximo de IdentityMappings que se devolverán. Si no se especifica, el valor predeterminado es 2000. El valor máximo permitido es 10.000. Los valores superiores a 10.000 se convertirán a 10.000.

page_token

string

Token de página recibido de una llamada ListIdentityMappings anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a ListIdentityMappings deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

ListIdentityMappingsResponse

Mensaje de respuesta a IdentityMappingStoreService.ListIdentityMappings

Campos

identity_mapping_entries[]

IdentityMappingEntry

Las entradas de mapeado de identidades.

next_page_token

string

Token que se puede enviar como page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListSchemasRequest

Mensaje de solicitud del método SchemaService.ListSchemas.

Campos

parent

string

Obligatorio. Nombre del recurso del almacén de datos superior, con el formato projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

Número máximo de Schemas que se devolverán. Es posible que el servicio devuelva un número inferior a este valor.

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

El valor máximo es 1000; los valores superiores a este límite se convertirán a 1000.

page_token

string

Token de página recibido de una llamada SchemaService.ListSchemas anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a SchemaService.ListSchemas deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

ListSchemasResponse

Mensaje de respuesta del método SchemaService.ListSchemas.

Campos

schemas[]

Schema

Los Schema.

next_page_token

string

Token que se puede enviar como ListSchemasRequest.page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

ListSessionsRequest

Solicitud del método ListSessions.

Campos
`parent`	`string` Obligatorio. Nombre de recurso del almacén de datos. Formato: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Número máximo de resultados que se devolverán. Si no se especifica, el valor predeterminado es 50. El valor máximo permitido es 1000.
`page_token`	`string` Token de página recibido de una llamada `ListSessions` anterior. Proporciona este elemento para obtener la siguiente página.
`filter`	`string` Lista separada por comas de los campos por los que se va a filtrar, en gramática EBNF. Los campos admitidos son: `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` Lista separada por comas de campos por los que se ordenará el resultado, ordenados de forma ascendente. Usa "desc" después del nombre de un campo para ordenarlo de forma descendente. Campos admitidos: `update_time` `create_time` `session_name` `is_pinned` Ejemplo: `update_time desc` `create_time` `is_pinned desc,update_time desc`: lista las sesiones primero por is_pinned y, después, por update_time.

ListSessionsResponse

Respuesta del método ListSessions.

Campos

sessions[]

Todas las sesiones de un almacén de datos determinado.

next_page_token

string

Token de paginación. Si no se devuelve, indica que es la última página.

ListTargetSitesRequest

Mensaje de solicitud del método SiteSearchEngineService.ListTargetSites.

Campos

parent

string

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

Si la persona que llama no tiene permiso para enumerar TargetSites en este buscador de sitio, independientemente de si existe o no esta rama, se devuelve un error PERMISSION_DENIED.

page_size

int32

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

page_token

string

Token de página recibido de una llamada ListTargetSites anterior. Proporciona este elemento para obtener la siguiente página.

Al hacer la paginación, todos los demás parámetros proporcionados a ListTargetSites deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.

ListTargetSitesResponse

Mensaje de respuesta del método SiteSearchEngineService.ListTargetSites.

Campos

target_sites[]

Lista de TargetSites.

next_page_token

string

Token que se puede enviar como page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

total_size

int32

Número total de elementos que coinciden con la solicitud. Este campo siempre se rellenará en la respuesta.

ListUserLicensesRequest

Mensaje de solicitud de UserLicenseService.ListUserLicenses.

Campos
`parent`	`string` Obligatorio. Nombre del recurso [UserStore][] principal. Formato: `projects/{project}/locations/{location}/userStores/{user_store_id}`.
`page_size`	`int32` Opcional. Tamaño de la página solicitado. El servidor puede devolver menos elementos de los solicitados. Si no se especifica, el valor predeterminado es 10. El valor máximo es 50; los valores superiores a este límite se convertirán a 50. Si este campo es negativo, se devuelve un error INVALID_ARGUMENT.
`page_token`	`string` Opcional. Token de página recibido de una llamada `ListUserLicenses` anterior. Proporciona este elemento para obtener la siguiente página. Al hacer la paginación, todos los demás parámetros proporcionados a `ListUserLicenses` deben ser los mismos que aparecen en la llamada que proporcionó el token de la página.
`filter`	`string` Opcional. Filtro de la solicitud de lista. Campos admitidos: `license_assignment_state` Ejemplos: `license_assignment_state = ASSIGNED` para ver la lista de licencias de usuario asignadas. `license_assignment_state = NO_LICENSE` para ver la lista de usuarios sin licencia. `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` para ver una lista de los usuarios que han intentado iniciar sesión, pero no tienen ninguna licencia asignada. `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` para filtrar a los usuarios que han intentado iniciar sesión, pero no tienen ninguna licencia asignada.

ListUserLicensesResponse

Mensaje de respuesta a UserLicenseService.ListUserLicenses.

Campos

user_licenses[]

UserLicense

Todos los UserLicense del cliente.

next_page_token

string

Token que se puede enviar como page_token para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.

MediaInfo

Información de eventos de usuario específicos de medios.

Campos

media_progress_duration

Duration

El tiempo de progreso del contenido multimedia en segundos, si procede. Por ejemplo, si el usuario final ha visto 90 segundos de un vídeo de reproducción, MediaInfo.media_progress_duration.seconds debe ser 90.

media_progress_percentage

float

El progreso del contenido multimedia debe calcularse usando solo el media_progress_duration en relación con la duración total del contenido multimedia.

Este valor debe estar entre [0, 1.0] (inclusive).

Si no se trata de una reproducción o no se puede calcular el progreso (por ejemplo, en una emisión en directo en curso), este campo no debe definirse.

PageInfo

Información detallada de la página.

Campos
`pageview_id`	`string` ID único de una vista de página web. Este valor debe ser el mismo para todos los eventos de usuario activados desde la misma vista de página. Por ejemplo, la vista de la página de detalles de un artículo podría activar varios eventos mientras el usuario navega por la página. La propiedad `pageview_id` debe ser la misma en todos estos eventos para que se puedan agrupar correctamente. Si usa el registro de eventos del lado del cliente con el píxel de JavaScript y Google Tag Manager, este valor se rellena automáticamente.
`page_category`	`string` La categoría más específica asociada a una página de categoría. Para representar la ruta completa de la categoría, use el signo ">" para separar las distintas jerarquías. Si el carácter ">" forma parte del nombre de la categoría, sustitúyelo por otro u otros caracteres. Las páginas de categorías incluyen páginas especiales, como las de rebajas o promociones. Por ejemplo, una página de rebajas especiales puede tener la siguiente jerarquía de categorías: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Es obligatorio en los eventos `view-category-page`. Otros tipos de eventos no deben definir este campo. De lo contrario, se devuelve un error `INVALID_ARGUMENT`.
`uri`	`string` URL completa (window.location.href) de la página actual del usuario. Si usa el registro de eventos del lado del cliente con el píxel de JavaScript y Google Tag Manager, este valor se rellena automáticamente. La longitud máxima es de 5000 caracteres.
`referrer_uri`	`string` La URL referente de la página actual. Si usa el registro de eventos del lado del cliente con el píxel de JavaScript y Google Tag Manager, este valor se rellena automáticamente. Sin embargo, es posible que este campo esté vacío debido a algunas restricciones de privacidad del navegador.

PanelInfo

Información detallada del panel asociada a un evento de usuario.

Campos
`panel_id`	`string` Obligatorio. El ID del panel.
`display_name`	`string` Nombre visible del panel.
`documents[]`	`DocumentInfo` Opcional. Los IDs de documento asociados a este panel.
`panel_position`	`int32` La posición ordenada del panel, si se muestra al usuario junto con otros paneles. Si se define, también se debe definir `total_panels`.
`total_panels`	`int32` El número total de paneles, incluido este, que se muestran al usuario. Se debe definir si se define `panel_position`.

Principal

Identificador principal de un usuario o un grupo.

Campos
Campo de unión `principal`. Campo de unión principal. La entidad principal puede ser un usuario o un grupo. `principal` solo puede ser una de estas dos opciones:
`user_id`	`string` Identificador de usuario. En el caso de las cuentas de usuario de Google Workspace, user_id debe ser el correo del usuario de Google Workspace. En el caso de las cuentas de usuario de proveedores de identidades que no sean de Google, user_id es el identificador de usuario asignado que se configura durante la configuración de workforcepool.
`group_id`	`string` Identificador del grupo. En el caso de las cuentas de usuario de Google Workspace, group_id debe ser el correo del grupo de Google Workspace. En el caso de las cuentas de usuario de proveedores de identidades que no sean 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 identidades del cliente.

Proyecto

Metadatos y configuraciones de un proyecto de Google Cloud en el servicio.

Campos
`name`	`string` Solo de salida. Nombre completo del recurso del proyecto, por ejemplo, `projects/{project}`. Ten en cuenta que, al hacer solicitudes, se pueden usar tanto el número como el ID del proyecto, pero el servidor siempre responderá con el número del proyecto.
`create_time`	`Timestamp` Solo de salida. Marca de tiempo de creación del proyecto.
`provision_completion_time`	`Timestamp` Solo de salida. Marca de tiempo en la que se aprovisiona correctamente este proyecto. Si el valor está vacío, significa que el proyecto aún se está aprovisionando y no está listo para usarse.
`service_terms_map`	`map<string, ServiceTerms>` Solo de salida. Un mapa de términos del servicio. La clave es el `id` de `ServiceTerms`.
`customer_provided_config`	`CustomerProvidedConfig` Opcional. Configuraciones proporcionadas por el cliente.

CustomerProvidedConfig

Configuraciones proporcionadas por el cliente.

Campos

notebooklm_config

NotebooklmConfig

Opcional. Configuración de los ajustes de NotebookLM.

NotebooklmConfig

Configuración de NotebookLM.

Campos

model_armor_config

ModelArmorConfig

Configuración de Model Armor que se usará para desinfectar las peticiones de los usuarios y las respuestas de los LLMs.

ModelArmorConfig

Configuración de plantillas de Model Armor definidas por el cliente que se usarán para desinfectar las peticiones de los usuarios y las respuestas de los LLMs.

Campos

user_prompt_template

string

Opcional. Nombre de recurso de la plantilla de protección de modelos para anonimizar las peticiones de los usuarios. Formato: projects/{project}/locations/{location}/templates/{template_id}. Si no se especifica, no se aplicará ninguna limpieza a la petición del usuario.

response_template

string

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

ServiceTerms

Metadatos sobre los términos del servicio.

Campos
`id`	`string` Identificador único de estos términos del servicio. Términos disponibles: `GA_DATA_USE_TERMS`: Términos de uso de datos. Si usa este atributo como `id`, el valor de `version` que puede proporcionar es `2022-11-23`.
`version`	`string` Cadena de versión de los términos del servicio. Para ver los valores aceptables, consulta los comentarios de `id` más arriba.
`state`	`State` Indica si el proyecto ha aceptado o rechazado los términos del servicio o si aún está pendiente.
`accept_time`	`Timestamp` La última vez que el proyecto aceptó los términos del servicio.
`decline_time`	`Timestamp` La última vez que el proyecto rechazó o revocó el acuerdo de los términos del servicio.

Estado

El contrato establece estos términos del servicio.

Enumeraciones
`STATE_UNSPECIFIED`	Valor predeterminado de la enumeración. Este valor no se usa realmente.
`TERMS_ACCEPTED`	El proyecto ha dado su consentimiento a los términos del servicio.
`TERMS_PENDING`	El proyecto está pendiente de revisión y de que se acepten los términos del servicio.
`TERMS_DECLINED`	El proyecto ha rechazado o revocado el acuerdo de los términos del servicio.

ProvisionProjectMetadata

Este tipo no tiene campos.

Metadatos asociados a una operación de aprovisionamiento de proyectos.

ProvisionProjectRequest

Solicitud del método ProjectService.ProvisionProject.

Campos
`name`	`string` Obligatorio. Nombre completo del recurso `Project`, como `projects/{project_id_or_number}`.
`accept_data_use_terms`	`bool` Obligatorio. Asigna el valor `true` para especificar que la persona que llama ha leído los Términos de uso de los datos y quiere dar su consentimiento.
`data_use_terms_version`	`string` Obligatorio. La versión de los Términos de uso de los datos que ha leído la persona que llama y a la que quiere dar su consentimiento. La versión aceptada es `2022-11-23`, y puede cambiar con el tiempo.
`saas_params`	`SaasParams` Opcional. Parámetros de Agentspace.

SaasParams

Parámetros de Agentspace.

Campos

accept_biz_qos

bool

Opcional. Definir como true para especificar que la persona que llama ha leído y quiere dar su consentimiento a los [Términos de calidad del servicio de Agentspace].

is_biz

bool

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

PurgeCompletionSuggestionsMetadata

Metadatos relacionados con el progreso de la operación PurgeCompletionSuggestions. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

PurgeCompletionSuggestionsRequest

Mensaje de solicitud del método CompletionService.PurgeCompletionSuggestions.

Campos

parent

string

Obligatorio. Nombre del recurso de almacén de datos superior para el que se van a purgar las sugerencias de finalización. Sigue el patrón projects/*/locations/*/collections/*/dataStores/*.

PurgeCompletionSuggestionsResponse

Mensaje de respuesta del método CompletionService.PurgeCompletionSuggestions.

Campos

purge_succeeded

bool

Indica si las sugerencias de autocompletado se han purgado correctamente.

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

PurgeDocumentsMetadata

Metadatos relacionados con el progreso de la operación PurgeDocuments. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de entradas que se han eliminado correctamente.
`failure_count`	`int64` Número de entradas en las que se han detectado errores durante el procesamiento.
`ignored_count`	`int64` Número de entradas que se han ignorado porque no se han encontrado.

PurgeDocumentsRequest

Mensaje de solicitud del método DocumentService.PurgeDocuments.

Campos
`parent`	`string` Obligatorio. Nombre del recurso superior, como `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
`filter`	`string` Obligatorio. Filtrar los documentos coincidentes que se van a purgar. El único valor admitido actualmente es `*` (todos los elementos).
`error_config`	`PurgeErrorConfig` La ubicación deseada de los errores producidos durante la purga.
`force`	`bool` Realiza la purga. Si `force` tiene el valor "false", devuelve el número de purgas esperado sin eliminar ningún documento.
Campo de unión `source`. La fuente de entrada deseada para purgar documentos en función de los IDs de los documentos. `source` solo puede ser una de estas dos opciones:
`gcs_source`	`GcsSource` Ubicación de Cloud Storage del contenido de entrada. `data_schema` admitidos: * `document_id`: un `Document.id` válido por línea.
`inline_source`	`InlineSource` Fuente insertada del contenido de entrada que se va a purgar.

InlineSource

Fuente insertada de la configuración de entrada del método DocumentService.PurgeDocuments.

Campos

documents[]

string

Obligatorio. Lista de nombres de recursos completos de los documentos que se van a purgar. Con el formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Se recomienda un máximo de 100 elementos.

PurgeDocumentsResponse

Mensaje de respuesta del método DocumentService.PurgeDocuments. Si la operación de larga duración se completa correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos

purge_count

int64

Número total de documentos purgados como resultado de la operación.

purge_sample[]

string

Una muestra de los nombres de los documentos que se van a eliminar. Solo se rellena si el valor de force es false. Se devolverán un máximo de 100 nombres, que se elegirán al azar.

PurgeErrorConfig

Configuración del destino de los errores relacionados con la purga.

Campos

Campo de unión destination. Obligatorio. Destino de errores. destination solo puede ser una de estas dos opciones:

gcs_prefix

string

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

PurgeIdentityMappingsRequest

Mensaje de solicitud de IdentityMappingStoreService.PurgeIdentityMappings

Campos
`identity_mapping_store`	`string` Obligatorio. Nombre del almacén de mapeo de identidades del que se purgarán las entradas de mapeo de identidades. Formato: `projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}`
`filter`	`string` Filtra los mapeados de identidades coincidentes que quieras purgar. El campo apto para filtrar es: * `update_time`: en formato "zulu" ISO 8601. * `external_id` Ejemplos: Eliminar todos los mapeados de identidades actualizados en un intervalo de tiempo: `update_time > "2012-04-23T18:25:43.511Z" AND update_time < "2012-04-23T18:30:43.511Z"` Eliminar todos los mapeados de identidades de un external_id determinado: `external_id = "id1"` Eliminar todos los mapeados de identidades de un almacén de mapeados de identidades: `*` Se presupone que los campos de filtrado tienen un AND implícito. No se debe usar con la fuente. Se producirá un error si se proporcionan ambos.
Campo de unión `source`. La fuente de la entrada. `source` solo puede ser una de estas dos opciones:
`inline_source`	`InlineSource` La fuente insertada de la que se purgarán las entradas de mapeo de identidades.
`force`	`bool` Realiza la purga. Si `force` tiene el valor "false", devuelve el recuento de purgas esperado sin eliminar ninguna asignación de identidad. Este campo solo se admite en la purga con filtro. En el caso de la fuente de entrada, este campo se ignora y los datos se purgan independientemente del valor de este campo.

InlineSource

La fuente insertada de la que se purgarán las entradas de mapeo de identidades.

Campos

identity_mapping_entries[]

IdentityMappingEntry

Se pueden purgar un máximo de 10.000 entradas a la vez

PurgeSuggestionDenyListEntriesMetadata

Metadatos relacionados con el progreso de la operación PurgeSuggestionDenyListEntries. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

PurgeSuggestionDenyListEntriesRequest

Mensaje de solicitud del método CompletionService.PurgeSuggestionDenyListEntries.

Campos

parent

string

Obligatorio. Nombre del recurso del almacén de datos superior al que se importarán las entradas de la lista de denegación. Sigue el patrón projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Mensaje de respuesta del método CompletionService.PurgeSuggestionDenyListEntries.

Campos

purge_count

int64

Número de entradas de la lista de denegación de sugerencias purgadas.

error_samples[]

Una muestra de los errores detectados al procesar la solicitud.

PurgeUserEventsMetadata

Metadatos relacionados con el progreso de la operación PurgeUserEvents. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`success_count`	`int64` Número de entradas que se han eliminado correctamente.
`failure_count`	`int64` Número de entradas en las que se han detectado errores durante el procesamiento.

PurgeUserEventsRequest

Mensaje de solicitud del método PurgeUserEvents.

Campos

parent

string

Obligatorio. Nombre de 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. Cadena de filtro para especificar los eventos que se van a eliminar. La longitud máxima es de 5000 caracteres. Los campos aptos para filtrar son los siguientes:

eventType: cadena UserEvent.event_type entre comillas dobles.
eventTime: en formato "zulu" ISO 8601.
userPseudoId: cadena entre comillas dobles. Si especifica este valor, se eliminarán todos los eventos asociados a un visitante.
userId: cadena entre comillas dobles. Si lo especificas, se eliminarán todos los eventos asociados a un usuario.

Nota: Esta API solo admite purgas de un intervalo máximo de 30 días.

Ejemplos:

Eliminar todos los eventos de un periodo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"
Eliminar un eventType específico en un intervalo de tiempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"
Eliminar todos los eventos de un visitante específico en un intervalo de tiempo: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"
Eliminar los eventos de los últimos 30 días de un DataStore: *

Se presupone que los campos de filtrado tienen un AND implícito.

force

bool

Actualmente, no se admite el campo force. Las solicitudes de purga de eventos de usuario eliminarán de forma permanente todos los eventos que se puedan purgar. Una vez que se haya completado el desarrollo, si force tiene el valor false, el método devolverá el recuento de purga esperado sin eliminar ningún evento de usuario. Si no se incluye en la solicitud, el valor predeterminado de este campo será false.

PurgeUserEventsResponse

Respuesta de PurgeUserEventsRequest. Si la operación de larga duración se completa correctamente, este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos

purge_count

int64

El recuento total de eventos purgados como resultado de la operación.

Consulta

Define una consulta introducida por el usuario.

Campos

query_id

string

Solo de salida. ID único de la consulta.

Campo de unión content. Contenido de la consulta. content solo puede ser una de estas dos opciones:

text

string

Texto sin formato.

RankRequest

Mensaje de solicitud del método RankService.Rank.

Campos
`ranking_config`	`string` Obligatorio. Nombre de recurso de la configuración del servicio de ranking, como `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
`model`	`string` Identificador del modelo que se va a usar. Es uno de los siguientes: `semantic-ranker-512@latest`: modelo de clasificación semántica con un tamaño máximo de token de entrada de 512. Si no se especifica, se asigna el valor `semantic-ranker-512@latest` de forma predeterminada.
`top_n`	`int32` El número de resultados que se van a devolver. Si no se define o no es mayor que cero, devuelve todos los resultados.
`query`	`string` Consulta que se va a usar.
`records[]`	`RankingRecord` Obligatorio. Lista de registros que se van a clasificar.
`ignore_record_details_in_response`	`bool` Si es true, la respuesta solo contendrá el ID de registro y la puntuación. De forma predeterminada, es false, por lo que la respuesta contendrá los detalles del registro.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta más información en el documento de Google Cloud.

RankResponse

Mensaje de respuesta del método RankService.Rank.

Campos

records[]

RankingRecord

Lista de registros ordenados por puntuación de mayor a menor.

RankingRecord

Graba un mensaje para el método RankService.Rank.

Campos
`id`	`string` ID único que representa el registro.
`title`	`string` El título del registro. Está vacío de forma predeterminada. Se debe definir al menos uno de los dos, ya que, de lo contrario, se producirá un error INVALID_ARGUMENT.`titlecontent`
`content`	`string` El contenido del registro. Está vacío de forma predeterminada. Se debe definir al menos uno de los dos, ya que, de lo contrario, se producirá un error INVALID_ARGUMENT.`titlecontent`
`score`	`float` La puntuación de este registro en función de la consulta proporcionada y el modelo seleccionado. La puntuación se redondeará a dos decimales. Si la puntuación se acerca a 0, se redondeará a 0,0001 para evitar que se devuelva el valor predeterminado.

RecommendRequest

Mensaje de solicitud del método Recommend.

Campos
`serving_config`	`string` Obligatorio. Nombre completo del recurso `ServingConfig`: `projects//locations/global/collections//engines//servingConfigs/` o `projects//locations/global/collections//dataStores//servingConfigs/` Se crea una configuración de servicio predeterminada junto con el motor de recomendaciones. El ID de motor se usa como ID de la configuración de publicación predeterminada. Por ejemplo, en el caso del motor `projects//locations/global/collections//engines/my-engine`, puedes usar `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` para tus solicitudes `RecommendationService.Recommend`.
`user_event`	`UserEvent` Obligatorio. Contexto sobre el usuario, lo que está viendo y la acción que ha realizado para activar la solicitud de recomendación. Ten en cuenta que este detalle del evento de usuario no se incluirá en los registros userEvent. Por lo tanto, se necesita una solicitud de escritura de userEvent independiente para registrar eventos. No asigne el mismo ID fijo a `UserEvent.user_pseudo_id` o `UserEvent.user_info.user_id` para diferentes usuarios. Si quieres recibir recomendaciones no personalizadas (no es recomendable, ya que puede afectar negativamente al rendimiento del modelo), asigna a `UserEvent.user_pseudo_id` un ID único aleatorio y deja `UserEvent.user_info.user_id` sin asignar.
`page_size`	`int32` Número máximo de resultados que se devolverán. Asigna a esta propiedad el número de resultados de recomendación que necesites. Si es cero, el servicio elige un valor predeterminado razonable. El valor máximo permitido es 100. Los valores superiores a 100 se definen como 100.
`filter`	`string` Filtro para restringir los resultados de las recomendaciones con un límite de longitud de 5000 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` tiene el valor "true" en el campo `params`, se esperan expresiones basadas en atributos en lugar de la sintaxis basada en etiquetas descrita 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 devuelve documentos populares genéricos (sin filtrar). Si solo quieres obtener resultados que coincidan exactamente con los filtros, asigna el valor `true` a `strictFiltering` en `RecommendRequest.params` para recibir resultados vacíos. Ten en cuenta que la API nunca devuelve `Document`s con `storageStatus` como `EXPIRED` o `DELETED`, independientemente de los filtros elegidos.
`validate_only`	`bool` Usa el modo de solo validación para esta consulta de recomendación. Si se asigna el valor `true`, se usa un modelo falso que devuelve IDs de documento 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>` Parámetros adicionales específicos del dominio de las recomendaciones. Valores permitidos: `returnDocument`: booleano. Si se le asigna el valor `true`, el objeto Document asociado se devuelve en `RecommendResponse.RecommendationResult.document`. `returnScore`: booleano. Si se define como true, la puntuación de recomendación correspondiente a cada documento devuelto se define en `RecommendResponse.RecommendationResult.metadata`. La puntuación indica la probabilidad de que se produzca una conversión de documento en función del contexto y el historial del usuario. `strictFiltering`: booleano. "True" de forma predeterminada Si se define como `false`, el servicio devuelve documentos populares genéricos (sin filtrar) en lugar de estar vacío si el filtro bloquea todos los resultados de recomendación. `diversityLevel`: cadena. El valor predeterminado es una cadena vacía. Si se asigna un valor 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 solicitud y ajusta los resultados de las recomendaciones en función de la categoría del documento. `attributeFilteringSyntax`: booleano. El valor predeterminado es "false". Si se define como true, el campo `filter` se interpreta según la nueva sintaxis basada en atributos.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta los requisitos de las etiquetas para obtener más información.

RecommendResponse

Mensaje de respuesta del método Recommend.

Campos
`results[]`	`RecommendationResult` Una lista de documentos recomendados. El orden representa la clasificación (del documento más relevante al menos relevante).
`attribution_token`	`string` Un token de atribución único. Esto debe incluirse en los registros de `UserEvent` resultantes de esta recomendación, lo que permite atribuir con precisión el rendimiento del modelo de recomendación.
`missing_ids[]`	`string` IDs de los documentos de la solicitud que faltaban en la rama predeterminada asociada a la ServingConfig solicitada.
`validate_only`	`bool` Devuelve el valor "true" si se ha definido `RecommendRequest.validate_only`.

RecommendationResult

RecommendationResult representa un resultado de recomendación genérico con metadatos asociados.

Campos

id

string

ID de recurso del documento recomendado.

document

MatchHighlightingCondition

Se define si returnDocument se establece en true en RecommendRequest.params.

metadata

map<string, Value>

Metadatos o anotaciones adicionales del documento.

Posibles valores:

score: puntuación de recomendación en valor doble. Se define si returnScore se establece en true en RecommendRequest.params.

RecrawlUrisMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.RecrawlUris. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos
`create_time`	`Timestamp` Hora de creación de la operación.
`update_time`	`Timestamp` Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.
`invalid_uris[]`	`string` URIs únicos de la solicitud que tienen un formato no válido. Muestra limitada a 1000.
`invalid_uris_count`	`int32` Número total de URIs únicos de la solicitud que tienen un formato no válido.
`noindex_uris[]`	`string` URIs que no tienen una etiqueta meta index. Muestra limitada a 1000.
`noindex_uris_count`	`int32` Número total de URIs que no tienen ninguna etiqueta meta de índice.
`uris_not_matching_target_sites[]`	`string` URIs únicos de la solicitud que no coinciden con ningún TargetSite de DataStore, solo coinciden con TargetSites que no se han indexado por completo o coinciden con un TargetSite de tipo EXCLUDE. Muestra limitada a 1000.
`uris_not_matching_target_sites_count`	`int32` Número total de URIs que no coinciden con ningún TargetSite.
`valid_uris_count`	`int32` Número total de URIs únicos de la solicitud que no están en invalid_uris.
`success_count`	`int32` Número total de URIs que se han rastreado hasta el momento.
`pending_count`	`int32` Número total de URIs que aún no se han rastreado.
`quota_exceeded_count`	`int32` Número total de URIs que se han rechazado porque no había suficientes recursos de indexación.

RecrawlUrisRequest

Mensaje de solicitud del método SiteSearchEngineService.RecrawlUris.

Campos

site_search_engine

string

Obligatorio. Nombre completo del recurso SiteSearchEngine, como projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Obligatorio. Lista de URIs que rastrear. Se admiten 10.000 URIs como máximo. De lo contrario, se producirá un error INVALID_ARGUMENT. Cada URI debe coincidir con al menos un TargetSite en site_search_engine.

site_credential

string

Opcional. ID de credencial que se usará para el rastreo.

RecrawlUrisResponse

Mensaje de respuesta del método SiteSearchEngineService.RecrawlUris.

Campos

failure_samples[]

FailureInfo

Detalles de una muestra de hasta 10 failed_uris.

failed_uris[]

string

URIs que no se rastrearon antes de que finalizara la operación de larga duración.

FailureInfo

Detalles sobre por qué no se ha podido rastrear un URI concreto. Cada FailureInfo contiene un FailureReason por CorpusType.

Campos

uri

string

URI que no se ha podido rastrear.

failure_reasons[]

FailureReason

Lista de motivos de error por tipo de corpus (por ejemplo, ordenador o móvil).

FailureReason

Detalles sobre por qué no se ha podido rastrear un CorpusType concreto. Por ejemplo: El rastreo de las versiones para ORDENADOR y MÓVIL puede fallar por diferentes motivos.

Campos

corpus_type

CorpusType

DESKTOP, MOBILE o CORPUS_TYPE_UNSPECIFIED.

error_message

string

Motivo por el que no se ha rastreado el URI.

CorpusType

CorpusType de la operación de rastreo fallida.

Enumeraciones
`CORPUS_TYPE_UNSPECIFIED`	Valor predeterminado.
`DESKTOP`	Denota un intento de rastreo de la versión para ordenadores de una página.
`MOBILE`	Indica un intento de rastreo de la versión para móviles de una página.

Responder

Define un mensaje de respuesta para el usuario.

Campos

summary

Summary

Resumen basado en los resultados de búsqueda.

SafetyRating

Valoración de seguridad correspondiente al contenido generado.

Campos
`category`	`HarmCategory` Solo de salida. Categoría de daño.
`probability`	`HarmProbability` Solo de salida. Niveles de probabilidad de daño en el contenido.
`probability_score`	`float` Solo de salida. Puntuación de probabilidad de daño.
`severity`	`HarmSeverity` Solo de salida. Niveles de gravedad de los daños en el contenido.
`severity_score`	`float` Solo de salida. Puntuación de gravedad de los daños.
`blocked`	`bool` Solo de salida. Indica si el contenido se ha excluido debido a esta clasificación.

HarmProbability

Niveles de probabilidad de daño en el contenido.

Enumeraciones
`HARM_PROBABILITY_UNSPECIFIED`	No se ha especificado la probabilidad de daño.
`NEGLIGIBLE`	Nivel de daño insignificante.
`LOW`	Nivel de daño bajo.
`MEDIUM`	Nivel de daño medio.
`HIGH`	Alto nivel de daño.

HarmSeverity

Niveles de gravedad del daño.

Enumeraciones
`HARM_SEVERITY_UNSPECIFIED`	Gravedad del daño sin especificar.
`HARM_SEVERITY_NEGLIGIBLE`	Nivel de gravedad de los daños insignificante.
`HARM_SEVERITY_LOW`	Nivel de gravedad de los daños bajo.
`HARM_SEVERITY_MEDIUM`	Nivel de gravedad medio.
`HARM_SEVERITY_HIGH`	Nivel de gravedad de los daños alto.

Esquema

Define la estructura y el diseño de un tipo de datos de documento.

Campos
`name`	`string` Inmutable. 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 1024 caracteres.
Campo de unión `schema`. Representación de esquemas. Se debe proporcionar `struct_schema` o `json_schema`. De lo contrario, se producirá un error `INVALID_ARGUMENT`. `schema` solo puede ser una de estas dos opciones:
`struct_schema`	`Struct` Representación estructurada del esquema.
`json_schema`	`string` Representación JSON del esquema.

SearchAddOn

Complemento que proporciona funciones adicionales para la búsqueda.

Enumeraciones
`SEARCH_ADD_ON_UNSPECIFIED`	Valor predeterminado cuando no se especifica la enumeración. No se puede usar.
`SEARCH_ADD_ON_LLM`	Complemento de modelo de lenguaje extenso.

SearchInfo

Información de búsqueda detallada.

Campos

search_query

string

La consulta de búsqueda del usuario.

Consulta la definición en SearchRequest.query.

El valor debe ser una cadena codificada en UTF-8 con un límite de 5000 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.

Se requiere al menos uno de los dos para los eventos search.search_queryPageInfo.page_category Otros tipos de eventos no deben definir este campo. De lo contrario, se devuelve un error INVALID_ARGUMENT.

order_by

string

El orden en el que se devuelven los productos, si procede.

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 1000 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.

Solo se puede definir para eventos search. Otros tipos de eventos no deben definir este campo. De lo contrario, se devuelve un error INVALID_ARGUMENT.

offset

int32

Número entero que especifica el desplazamiento actual de la paginación (la ubicación inicial indexada en 0 entre los productos que la API considera relevantes).

Consulta la definición en SearchRequest.offset.

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

Solo se puede definir para eventos search. Otros tipos de eventos no deben definir este campo. De lo contrario, se devuelve un error INVALID_ARGUMENT.

SearchLinkPromotion

El proto de promoción incluye el URI y otra información útil para mostrar la promoción.

Campos
`title`	`string` Obligatorio. Título de la promoción. Longitud máxima: 160 caracteres.
`uri`	`string` Opcional. La URL de la página que quiere promocionar el usuario. Se debe definir para la búsqueda en el sitio. En otros verticales, este paso es opcional.
`document`	`string` Opcional. El `Document` que quiere promocionar el usuario. En el caso de la búsqueda en el sitio, no definas ningún valor y solo rellena el URI. Se puede definir junto con uri.
`image_uri`	`string` Opcional. URL de la imagen en miniatura de la promoción.
`description`	`string` Opcional. 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 publicación asociada al elemento superior del control al que esté vinculada esta promoción. Esta marca solo se usa para la búsqueda básica en el sitio.

SearchRequest

Mensaje de solicitud del método SearchService.Search.

Campos
`serving_config`	`string` Obligatorio. Nombre del recurso de la configuración de servicio de 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 servicio, el conjunto de modelos que se usan para hacer la búsqueda.
`branch`	`string` Nombre de recurso de la sucursal, como `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Usa `default_branch` como ID de rama o deja este campo vacío para buscar documentos en la rama predeterminada.
`query`	`string` Consulta de búsqueda sin procesar.
`image_query`	`ImageQuery` Consulta de imagen RAW.
`page_size`	`int32` Número máximo 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 convertirán al valor máximo. Sitios web con indexación básica: Predeterminado `10` y Máximo `25`. Sitios web con indexación avanzada: Predeterminado `25` y Máximo `50`. Otros: predeterminado `50` y máximo `100`. Si este campo es negativo, se devuelve un error `INVALID_ARGUMENT`.
`page_token`	`string` Un token de página recibido de una llamada `SearchService.Search` anterior. Proporciona este elemento para obtener la siguiente página. Al hacer la paginación, todos los demás parámetros proporcionados a `SearchService.Search` deben ser los mismos que aparecen en la llamada que proporcionó el token de la página. De lo contrario, se devuelve un error `INVALID_ARGUMENT`.
`offset`	`int32` Un número entero indexado en 0 que especifica el desplazamiento actual (es decir, la ubicación del resultado inicial, entre los `Document`s que la API considera relevantes) en los resultados de búsqueda. Este campo solo se tiene en cuenta si `page_token` no está definido. Si este campo es negativo, se devuelve un error `INVALID_ARGUMENT`. Es posible que se limite un desplazamiento grande a un umbral razonable.
`one_box_page_size`	`int32` Número máximo de resultados que se devolverán para OneBox. Esto se aplica a cada tipo de OneBox de forma individual. El número predeterminado es 10.
`data_store_specs[]`	`DataStoreSpec` Especificaciones que definen los `DataStore`s concretos que se van a buscar, junto con las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en los `Engine`s con varios almacenes de datos. En el caso de los buscadores con un solo almacén de datos, deben usarse las especificaciones que se encuentran directamente en `SearchRequest`.
`filter`	`string` La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los documentos que se van a filtrar. La expresión de filtro distingue entre mayúsculas y minúsculas. Si este campo no se reconoce, se devuelve un `INVALID_ARGUMENT`. El filtrado en Vertex AI Search se realiza asignando la clave de filtro del lado izquierdo a una propiedad de clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios puede tener un campo "nombre" en su esquema. En este caso, el filtro sería el siguiente: filter --> name:'ANY("king kong")' Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtrar.
`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. Filtro que se aplica a cada solicitud de búsqueda cuando se necesita mejorar la calidad, por ejemplo, ampliando la consulta. Si una consulta no tiene una cantidad suficiente de resultados, se usará este filtro para determinar si se debe habilitar el flujo de ampliación de la consulta. El filtro original se seguirá usando en la búsqueda ampliada de la consulta. Se recomienda incluir este campo para conseguir una calidad de búsqueda alta. Para obtener más información sobre la sintaxis de los filtros, consulta `SearchRequest.filter`.
`order_by`	`string` El orden en el que se devuelven los documentos. Los documentos se pueden ordenar por un campo de un objeto `Document`. Déjalo sin definir si los resultados se ordenan por relevancia. La expresión `order_by` distingue entre mayúsculas y minúsculas. Para obtener más información sobre cómo ordenar los resultados de búsqueda de sitios web, consulta el artículo Ordenar resultados de búsqueda web. Para obtener más información sobre cómo ordenar los resultados de búsqueda de atención sanitaria, consulta el artículo Ordenar resultados de búsqueda de atención sanitaria. Si este campo no se reconoce, se devuelve un `INVALID_ARGUMENT`.
`user_info`	`UserInfo` Información sobre el usuario final. Muy recomendable para analíticas y personalización. `UserInfo.user_agent` se usa para deducir `device_type` con fines analíticos.
`language_code`	`string` Se trata del 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 consulta. Si no se especifica ningún valor, el código de idioma de la consulta se detecta automáticamente, pero puede que no sea preciso.
`facet_specs[]`	`FacetSpec` Especificaciones de facetas para la búsqueda por facetas. Si está vacío, no se devuelve ninguna faceta. Se permiten un máximo de 100 valores. De lo contrario, se devuelve un error `INVALID_ARGUMENT`.
`boost_spec`	`BoostSpec` Aumenta la especificación para destacar determinados documentos. Para obtener más información sobre el aumento, consulta Aumento.
`params`	`map<string, Value>` Parámetros de búsqueda adicionales. En el caso de la búsqueda en sitios web públicos, los valores admitidos son los siguientes: `user_country_code`: cadena. El valor predeterminado es una cadena vacía. Si se define un valor no vacío, los resultados se restringen o se impulsan en función de la ubicación proporcionada. Por ejemplo, `user_country_code: "au"` Para ver los códigos disponibles, consulta Códigos de país. `search_type`: doble. El valor predeterminado es una cadena vacía. Habilita la búsqueda de contenido que no sea de páginas web en función del 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` Especificación de ampliación de consultas que indica las condiciones en las que se produce la ampliación de consultas.
`spell_correction_spec`	`SpellCorrectionSpec` 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` Identificador único para hacer un seguimiento de los visitantes. Por ejemplo, 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 debería cambiar si el visitante inicia o cierra sesión en el sitio web. 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 devuelve un error `INVALID_ARGUMENT`.
`content_search_spec`	`ContentSearchSpec` 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 de recuperación. 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`, se utiliza `RANK_BY_EMBEDDING` de forma predeterminada. Si no se proporciona `ranking_expression_backend` o se le asigna el valor `RANK_BY_EMBEDDING`, debe ser una sola función o varias funciones unidas por el signo "+". ranking_expression = function, { " + ", function }; Funciones admitidas: double * relevance_score double * dotProduct(embedding_field_path) Variables de función: `relevance_score`: palabras clave predefinidas que se usan para medir la relevancia entre la consulta y el documento. `embedding_field_path`: el campo de inserción de documentos que se usa con el vector de inserción de consultas. `dotProduct`: función de incrustación entre `embedding_field_path` y el vector de incrustación de la consulta. Expresión de clasificación de ejemplo: Si el documento tiene un campo de inserció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` tiene el valor `RANK_BY_FORMULA`, se admiten los siguientes tipos de expresiones (y las combinaciones de esas expresiones encadenadas mediante los operadores + o ): `double` `signal` `log(signal)` `exp(signal)` `rr(signal, double > 0)`: transformación de rango recíproco con el segundo argumento como constante de denominador. `is_nan(signal)`: devuelve 0 si la señal 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)`: se ordena principalmente por el logaritmo de `keyword_similarity_score` con un ligero ajuste de `semantic_smilarity_score`. `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- ordena por el exponente de `semantic_similarity_score`. Si el valor es NaN, se sustituye por 0. También se añade 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)`: se ordena principalmente por el rango recíproco de `keyword_similarity_score` con un ligero ajuste del rango recíproco de `semantic_smilarity_score`. Se admiten las siguientes señales: `semantic_similarity_score`: ajuste de la similitud semántica que se calcula mediante las inserciones generadas por un modelo propietario de Google. Esta puntuación determina el grado de similitud semántica entre una consulta de búsqueda y 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 mediante un modelo probabilístico para estimar la probabilidad de que un documento sea pertinente para una consulta determinada. `relevance_score`: ajuste de relevancia semántica que usa un modelo propietario de Google para determinar el significado y la intención de la consulta de un usuario en el contexto del contenido de los documentos. `pctr_rank`: ajuste de la tasa de conversión prevista como uso de la clasificación. Se usa el porcentaje de clics previsto (pCTR) para medir la relevancia y el atractivo de un resultado de búsqueda desde el punto de vista del usuario. Un pCTR más alto sugiere que es más probable que el resultado satisfaga la consulta y la intención del usuario, por lo que es una señal valiosa para el ranking. `freshness_rank`: ajuste de la actualización como clasificación `document_age`: tiempo transcurrido en horas desde la última actualización del documento. Es un número de coma flotante (por ejemplo, 0,25 significa 15 minutos). `topicality_rank`: ajuste de actualidad como clasificación. Usa un modelo propio de Google para determinar la superposición basada en palabras clave entre la consulta y el documento. `base_rank`: el rango predeterminado del resultado
`ranking_expression_backend`	`RankingExpressionBackend` Opcional. Backend que se va a usar para la evaluación de la expresión de clasificación.
`safe_search`	`bool` Si quieres activar Búsqueda segura. Esta función solo está disponible para la búsqueda en sitios web.
`user_labels`	`map<string, string>` Las etiquetas de usuario aplicadas a un recurso deben cumplir los siguientes requisitos: Cada recurso puede tener varias etiquetas, hasta un máximo de 64. Cada etiqueta debe ser un par clave-valor. Las claves tienen 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 tener una longitud máxima de 63 caracteres. Las claves y los valores solo pueden contener letras en minúscula, caracteres numéricos, guiones bajos y guiones. Todos los caracteres deben usar la codificación UTF-8 y se pueden utilizar caracteres internacionales. La parte de la clave de una etiqueta debe ser única. Sin embargo, puedes usar la misma clave con varios recursos. Las claves deben empezar por una letra minúscula o un carácter internacional. Consulta más información en el documento de Google Cloud.
`natural_language_query_understanding_spec`	`NaturalLanguageQueryUnderstandingSpec` Opcional. Configuración de las funciones de comprensión de consultas en 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 hará ninguna otra consulta en lenguaje natural.
`search_as_you_type_spec`	`SearchAsYouTypeSpec` Configuración de la búsqueda a medida que se escribe. Solo se admite en el vertical `IndustryVertical.MEDIA`.
`display_spec`	`DisplaySpec` Opcional. Configuración de la función de visualización, como el resaltado de coincidencias en los resultados de búsqueda.
`session`	`string` Nombre de recurso de la sesión. Opcional. La sesión permite a los usuarios hacer llamadas a la API /search de varias fases o coordinar llamadas a la API /search y a la API /answer. Ejemplo 1 (llamadas a la API /search de varias interacciones): llama a la API /search con el ID de sesión generado en la primera llamada. En este caso, la consulta de búsqueda anterior se tiene en cuenta en la posición de la consulta. Es decir, si la primera consulta es "¿Cómo le fue a Alphabet en el 2022?". y la consulta actual es "¿Y en el 2023?", se interpretará como "¿Cómo le fue a Alphabet en el 2023?". Ejemplo 2 (coordinación entre llamadas a la API /search y llamadas a la API /answer): llama a la API /answer con el ID de sesión generado en la primera llamada. En este caso, la respuesta se genera en el contexto de los resultados de búsqueda de la primera llamada de búsqueda. La función de búsqueda multirrespuesta se encuentra en la fase de disponibilidad general privada. Usa la versión v1alpha o v1beta antes de que lancemos esta función para el público general. También puedes solicitar que se te incluya en la lista de permitidos a través del equipo de Asistencia de Google.
`session_spec`	`SessionSpec` Especificación de la sesión. Solo se puede usar cuando se ha definido `session`.
`relevance_threshold`	`RelevanceThreshold` El umbral de relevancia de los resultados de búsqueda. Se usa el umbral definido por Google, que aprovecha el equilibrio entre la precisión y la recuperación para ofrecer resultados muy precisos y una cobertura completa de la información pertinente. Esta función no está disponible para las búsquedas relacionadas con la salud.
`relevance_score_spec`	`RelevanceScoreSpec` Opcional. Especificación para devolver la puntuación de relevancia.

BoostSpec

Aumenta la especificación para destacar determinados documentos.

Campos

condition_boost_specs[]

ConditionBoostSpec

Especificaciones de la mejora de la condición. Si un documento cumple varias condiciones de las especificaciones, se aplican y se combinan de forma no lineal las puntuaciones de refuerzo de esas especificaciones. El número máximo de especificaciones es 20.

ConditionBoostSpec

El refuerzo se aplica a los documentos que cumplen una condición.

Campos

condition

string

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 la sintaxis y las limitaciones en SearchRequest.filter.

Ejemplos:

Para aumentar la relevancia de los documentos con el ID "doc_1" o "doc_2" y el color "Rojo" o "Azul", usa la siguiente consulta: (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Intensidad del aumento de la condición, que debe estar en el intervalo [-1, 1]. Un impulso negativo significa que se ha bajado de nivel. El valor predeterminado es 0,0.

Si le asignas el valor 1.0, el documento recibirá una gran promoción. Sin embargo, esto no significa necesariamente que el documento impulsado vaya a ser el resultado principal en todo momento, ni que se vayan a excluir otros documentos. Los resultados se pueden seguir mostrando aunque ninguno de ellos cumpla la condición. Además, los resultados que sean significativamente más relevantes para la consulta de búsqueda pueden seguir superando a los documentos que te interesen mucho, pero que no sean relevantes.

Si se asigna el valor -1.0, el documento se degradará considerablemente. Sin embargo, es posible que se sigan mostrando resultados muy relevantes. El documento tendrá dificultades para conseguir una posición bastante alta, pero no se le impedirá por completo.

Si se asigna el valor 0.0, no se aplica ningún aumento. Se ignora la condición de aumento. Solo se define una de las combinaciones (condición, impulso) o boost_control_spec que se indican a continuación. Si se definen ambos, se ignora el aumento global y se aplica el valor más detallado de boost_control_spec.

boost_control_spec

BoostControlSpec

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 aumento.
`attribute_type`	`AttributeType` 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_nombre especificado. En el caso de los valores numéricos, es sencillo: attribute_value = numerical_field_value. En el caso de la actualización, attribute_value = (time.now() - datetime_field_value).
`interpolation_type`	`InterpolationType` El tipo de interpolación que se aplicará para conectar los puntos de control que se indican a continuación.
`control_points[]`	`ControlPoint` Los puntos de control que se usan para definir la curva. La función monotónica (definida mediante el interpolation_type anterior) pasa por los puntos de control que se indican aquí.

AttributeType

El atributo(o la función) al que se debe aplicar la clasificación personalizada.

Enumeraciones
`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 valor_atributo (el valor x) del punto de control será el valor real del campo numérico para el que se especifica boost_amount.
`FRESHNESS`	En el caso práctico de la actualización, el valor del atributo será la duración entre la hora actual y la fecha especificada en el campo datetime. 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 es el siguiente: `[nD][T[nH][nM][nS]]`. Por ejemplo, `5D`, `3DT12H30M` y `T24H`.

ControlPoint

Los puntos de control que se usan para definir la curva. La curva definida mediante estos puntos de control solo puede ser creciente o decreciente de forma monótona(se aceptan valores constantes).

Campos

attribute_value

string

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

boost_amount

float

Valor entre -1 y 1 que se debe sumar a la puntuación si el valor_atributo se evalúa como el valor especificado anteriormente.

InterpolationType

El tipo de interpolación que se va a aplicar. El valor predeterminado será lineal (lineal a tramos).

Enumeraciones
`INTERPOLATION_TYPE_UNSPECIFIED`	No se ha especificado el tipo de interpolación. En este caso, se utiliza el valor predeterminado Lineal.
`LINEAR`	Se aplicará la interpolación lineal a tramos.

ContentSearchSpec

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 incluyen en la respuesta de búsqueda.
`summary_spec`	`SummarySpec` Si no se especifica `summarySpec`, los resúmenes no se incluirán en la respuesta de búsqueda.
`extractive_content_spec`	`ExtractiveContentSpec` Si no se proporciona ningún extractive_content_spec, no habrá ninguna respuesta extractiva en la respuesta de búsqueda.
`search_result_mode`	`SearchResultMode` Especifica el modo de resultados de búsqueda. Si no se especifica, el modo de resultado de búsqueda predeterminado es `DOCUMENTS`.
`chunk_spec`	`ChunkSpec` Especifica el spec del fragmento que se devolverá en la respuesta de búsqueda. Solo disponible si `SearchRequest.ContentSearchSpec.search_result_mode` se define como `CHUNKS`

ChunkSpec

Especifica el spec del fragmento que se devolverá en la respuesta de búsqueda. Solo disponible si SearchRequest.ContentSearchSpec.search_result_mode se define como CHUNKS

Campos

num_previous_chunks

int32

Número de fragmentos anteriores que se van a devolver del fragmento actual. El valor máximo permitido es 3. Si no se especifica, no se devolverá ningún fragmento anterior.

num_next_chunks

int32

Número de los siguientes fragmentos que se van a devolver del fragmento actual. El valor máximo permitido es 3. Si no se especifica, no se devolverán más fragmentos.

ExtractiveContentSpec

Especificación para configurar el contenido extractivo en una respuesta de búsqueda.

Campos
`max_extractive_answer_count`	`int32` Número máximo de respuestas extractivas devueltas en cada resultado de búsqueda. Una respuesta extractiva es una respuesta literal extraída del documento original, que proporciona una respuesta precisa y pertinente para el contexto de la consulta de búsqueda. Si el número de respuestas coincidentes es inferior al `max_extractive_answer_count`, devuelve todas las respuestas. De lo contrario, devuelve `max_extractive_answer_count`. Se devuelven como máximo cinco respuestas por cada `SearchResult`.
`max_extractive_segment_count`	`int32` Número máximo de segmentos extractivos devueltos en cada resultado de búsqueda. Solo se aplica si `DataStore` se define 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 relevante para la consulta de búsqueda y, por lo general, más extenso que una respuesta extractiva. El segmento se podría usar como entrada para que los LLMs generen resúmenes y respuestas. Si el número de segmentos coincidentes es inferior a `max_extractive_segment_count`, devuelve 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 de cada resultado de búsqueda. Esta función solo está disponible para los nuevos almacenes de datos o los que se hayan añadido a la lista de permitidos. Para incluir en la lista de permitidos tu almacén de datos, ponte en contacto con tu ingeniero de atención al cliente. El valor predeterminado es `false`.
`num_previous_segments`	`int32` Especifica si también se deben incluir los segmentos adyacentes de cada segmento seleccionado. Devuelve como máximo `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 resultados de búsqueda. Si no se especifica, el modo de resultado de búsqueda predeterminado es DOCUMENTS.

Enumeraciones
`SEARCH_RESULT_MODE_UNSPECIFIED`	Valor predeterminado.
`DOCUMENTS`	Devuelve los documentos de los resultados de búsqueda.
`CHUNKS`	Devuelve fragmentos en el resultado de búsqueda. Solo está disponible si se especifica `DocumentProcessingConfig.chunking_config`.

SnippetSpec

Especificación para configurar fragmentos en una respuesta de búsqueda.

Campos

max_snippet_count
(deprecated)

int32

[DEPRECATED] Este campo está obsoleto. Para controlar la devolución de fragmentos, usa el campo return_snippet. Para facilitar la compatibilidad con versiones anteriores, devolveremos el fragmento si max_snippet_count > 0.

reference_only
(deprecated)

bool

[OBSOLETO] Este campo está obsoleto y no tendrá ningún efecto en el fragmento.

return_snippet

bool

Si true, devuelve el fragmento. Si no se puede generar ningún fragmento, devolvemos el mensaje "No hay ningún fragmento disponible para esta página". También se devolverá un snippet_status con SUCCESS o NO_SNIPPET_AVAILABLE.

SummarySpec

Especificación para configurar un resumen devuelto en una respuesta de búsqueda.

Campos
`summary_result_count`	`int32` Número de resultados principales a partir de los que se generará el resumen. Si el número de resultados devueltos es inferior a `summaryResultCount`, el resumen se genera a partir de todos los resultados. Se pueden usar como máximo 10 resultados en el modo Documentos o 50 en el modo Fragmentos para generar un resumen. El modo de fragmentos se usa cuando `SearchRequest.ContentSearchSpec.search_result_mode` tiene el valor `CHUNKS`.
`include_citations`	`bool` Especifica si se deben incluir citas en el resumen. El valor predeterminado es `false`. Si este campo tiene el valor `true`, los resúmenes incluyen números de cita en el texto. Ejemplo de resumen con citas: BigQuery es la solución totalmente gestionada y sin servidor de Google Cloud para almacenar datos empresariales [1]. BigQuery es compatible con todos los tipos de datos, funciona en diferentes nubes y cuenta con capacidades de aprendizaje automático e inteligencia empresarial integradas en una plataforma unificada [2, 3]. Los números de cita hacen referencia a los resultados de búsqueda devueltos y están indexados a partir del 1. Por ejemplo, [1] significa que la frase se atribuye al primer resultado de búsqueda. [2, 3] significa que la frase se atribuye al segundo y al tercer resultado de búsqueda.
`ignore_adversarial_query`	`bool` Especifica si se deben filtrar las consultas adversarias. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar consultas adversarias. No se devuelve ningún resumen si la consulta de búsqueda se clasifica como consulta adversarial. Por ejemplo, un usuario puede hacer una pregunta sobre comentarios negativos sobre la empresa o enviar una consulta diseñada para generar contenido no seguro que infrinja las políticas. Si este campo tiene el valor `true`, no generaremos resúmenes para las consultas adversarias y devolveremos mensajes alternativos.
`ignore_non_summary_seeking_query`	`bool` Especifica si se deben filtrar las consultas que no buscan un resumen. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar las consultas que buscan un resumen. No se devuelve ningún resumen si la consulta de búsqueda se clasifica como una consulta que no busca un resumen. Por ejemplo, `why is the sky blue` y `Who is the best soccer player in the world?` son consultas que buscan un resumen, pero `SFO airport` y `world cup 2026` no. Lo más probable es que sean consultas de navegación. Si este campo tiene el valor `true`, no generaremos resúmenes para las consultas que no busquen resúmenes y devolveremos mensajes alternativos.
`ignore_low_relevant_content`	`bool` Especifica si se deben filtrar las consultas que tengan poca relevancia. El valor predeterminado es `false`. Si este campo tiene el valor `false`, se usarán todos los resultados de búsqueda, independientemente de su relevancia, para generar respuestas. Si se define como `true`, solo se generarán respuestas para las consultas con resultados de búsqueda de alta relevancia.
`ignore_jail_breaking_query`	`bool` Opcional. Especifica si se deben filtrar las consultas de jailbreak. El valor predeterminado es `false`. Google utiliza la clasificación de consultas de búsqueda para detectar consultas de jailbreak. No se devuelve ningún resumen si la consulta de búsqueda se clasifica como una consulta de jailbreak. Un usuario puede añadir instrucciones a la consulta para cambiar el tono, el estilo, el idioma o el contenido de la respuesta, o pedirle al modelo que actúe como otra entidad. Por ejemplo, "Responde con el tono del CEO de una empresa de la competencia". Si este campo tiene el valor `true`, no generaremos resúmenes para las consultas de jailbreaking y devolveremos mensajes alternativos.
`model_prompt_spec`	`ModelPromptSpec` Si se especifica, la especificación se usará para modificar la petición proporcionada al LLM.
`language_code`	`string` Código de idioma del resumen. Usa etiquetas de idioma definidas por BCP47. Nota: Esta es una función experimental.
`model_spec`	`ModelSpec` Si se especifica, la especificación se usará para modificar la especificación del modelo proporcionada al LLM.
`use_semantic_chunks`	`bool` Si es true, la respuesta se generará a partir de los fragmentos más relevantes de los primeros resultados de búsqueda. Esta función mejorará la calidad de los resúmenes. Ten en cuenta que, si esta función está habilitada, no se hará referencia a todos los resultados de búsqueda principales ni se incluirán en la lista de referencias, por lo que el índice de fuentes de las citas solo apunta a los resultados de búsqueda que aparecen en la lista de referencias.

ModelPromptSpec

Especificación de la petición que se va a usar con el modelo.

Campos

preamble

string

Texto al principio de la petición que da instrucciones al asistente. Puede consultar ejemplos en la guía del usuario.

ModelSpec

Especificación del modelo.

Campos

version

string

Versión del modelo que se ha usado para generar el resumen.

Los valores admitidos son:

stable: cadena. 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 y ciclo de vida del modelo de generación de respuestas.
preview: cadena. (Vista previa pública) Usa un modelo de vista previa. Para obtener más información, consulta Versiones y ciclo de vida del modelo de generación de respuestas.

DataStoreSpec

Estructura para definir los almacenes de datos que se van a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. De lo contrario, se devuelve 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 debe incluir el número de proyecto. No se admite el ID de proyecto en este campo.
`filter`	`string` Opcional. Especificación de filtro para filtrar documentos en el almacén de datos especificado en el campo data_store. Para obtener más información sobre los filtros, consulta Filtrar.
`boost_spec`	`BoostSpec` Opcional. Aumenta la especificación para destacar determinados documentos. Para obtener más información sobre el aumento, consulta Aumento.
`custom_search_operators`	`string` Opcional. 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, consulte SearchOperators.

DisplaySpec

Especifica las funciones que se van a mostrar, como el resaltado de coincidencias.

Campos

match_highlighting_condition

La condición en la que se debe destacar la coincidencia.

MatchHighlightingCondition

Enumeración que describe en qué condición se debe destacar la coincidencia.

Enumeraciones
`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

Especificación de una faceta para realizar una búsqueda por facetas.

Campos
`facet_key`	`FacetKey` Obligatorio. Especificación de la clave de la faceta.
`limit`	`int32` Número máximo 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 convierten en 300. En el caso de la agregación en la búsqueda de asistencia sanitaria, cuando [FacetKey.key] sea "healthcare_aggregation_key", el límite se sustituirá por 10.000 internamente, independientemente del valor definido aquí. Si este campo es negativo, se devuelve un error `INVALID_ARGUMENT`.
`excluded_filter_keys[]`	`string` Lista de claves que se excluirán al crear facetas. De forma predeterminada, `FacetKey.key` no se excluye del filtro a menos que se incluya en este campo. Si se incluye una clave de faceta en este campo, sus valores podrán aparecer como resultados de faceta aunque se hayan excluido de los resultados de búsqueda. El uso de este campo no afecta a los resultados de búsqueda que se devuelven. Por ejemplo, supongamos que hay 100 documentos con la faceta de color "Rojo" y 200 documentos con la faceta de color "Azul". Una consulta que contenga el filtro "color:ANY("Rojo")" y que tenga "color" como `FacetKey.key` devolvería de forma predeterminada solo los documentos "Rojo" en los resultados de búsqueda, así como "Rojo" con el recuento 100 como la única faceta de color. Aunque también hay documentos azules, "Azul" no se mostraría como un valor de faceta disponible. Si "color" aparece en "excludedFilterKeys", la consulta devuelve los valores de la faceta "Rojo" con el recuento 100 y "Azul" con el recuento 200, ya que la clave "color" ahora está excluida del filtro. Como este campo no afecta a los resultados de búsqueda, estos se siguen filtrando correctamente para devolver solo los documentos "Rojo". Se permiten un máximo de 100 valores. De lo contrario, se devuelve un error `INVALID_ARGUMENT`.
`enable_dynamic_position`	`bool` Habilita la posición dinámica de esta faceta. Si se define como true, 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 asigna el valor "false", la posición de esta faceta en la respuesta es la misma que en la solicitud y se clasifica antes de las facetas con la posición dinámica habilitada y de todas las facetas dinámicas. Por ejemplo, puede que siempre quiera que se devuelva la faceta de valoración en la respuesta, pero no es necesario que siempre se muestre en la parte superior. En ese caso, puedes asignar el valor true a enable_dynamic_position para que la posición de la faceta de valoración en la respuesta se determine automáticamente. Otro ejemplo, suponiendo que tiene las siguientes facetas en la solicitud: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false También tiene habilitadas las facetas dinámicas, que generan una faceta `gender`. El orden final de las facetas en la respuesta puede ser ("price", "brands", "rating", "gender") o ("price", "brands", "gender", "rating"), en función de cómo ordene la API las facetas "gender" y "rating". Sin embargo, observe que "price" y "brands" siempre se clasifican en la primera y la segunda posición, respectivamente, porque su valor de enable_dynamic_position es false.

FacetKey

Especifica cómo se calcula una faceta.

Campos
`key`	`string` Obligatorio. Claves de faceta textuales y numéricas admitidas en el objeto `Document`, sobre las que se calculan los valores de faceta. La clave de la faceta distingue entre mayúsculas y minúsculas.
`intervals[]`	`Interval` Solo se debe definir si los valores se deben agrupar en intervalos. Se debe definir para las facetas con valores numéricos. No se debe definir para las facetas con valores de texto. El número máximo de intervalos es 30.
`restricted_values[]`	`string` Solo se obtiene la faceta de los valores restringidos proporcionados. Solo se admite en campos de texto. Por ejemplo, supongamos que "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si asigna el valor "Action> 2022 " a "restricted_values", la faceta "category" solo contendrá "Action > 2022". Solo se admite en campos de texto. El máximo es 10.
`prefixes[]`	`string` Solo se obtienen los valores de faceta que empiezan por el prefijo de cadena proporcionado. Por ejemplo, supongamos que "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si se asigna el valor "Action" a "prefixes", la faceta "category" solo contendrá "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 "category" tiene tres valores: "Action > 2022", "Action > 2021" y "Sci-Fi > 2022". Si se asigna el valor "2022" a "contains", la faceta "category" solo contendrá "Action > 2022" y "Sci-Fi > 2022". Solo se admite en campos de texto. El máximo es 10.
`case_insensitive`	`bool` True para que las claves de las facetas no distingan entre mayúsculas y minúsculas al obtener valores de facetas con prefijos o que contengan un texto; false en caso contrario.
`order_by`	`string` El orden en el que se devuelven los documentos. Los valores permitidos son: "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 define, los valores de texto se ordenan de forma natural y los intervalos numéricos se ordenan según el orden que se indica en `FacetSpec.FacetKey.intervals`.

ImageQuery

Especifica la entrada de consulta de imagen.

Campos

Campo de unión image.

image solo puede ser una de estas dos opciones:

image_bytes

string

Bytes de imagen codificados en Base64. Formatos de imagen admitidos: JPEG, PNG y BMP.

NaturalLanguageQueryUnderstandingSpec

Especificación para habilitar las funciones de comprensión del lenguaje natural en las solicitudes de búsqueda.

Campos
`filter_extraction_condition`	`FilterExtractionCondition` La condición en la que se debe producir la extracción del filtro. El comportamiento predeterminado del servidor es `DISABLED`.
`geo_search_query_detection_field_names[]`	`string` Nombres de los campos que se usan para filtrar por ubicación, donde se detectan filtros de geolocalización en las consultas de búsqueda en lenguaje natural. Solo es válido cuando FilterExtractionCondition se define como `ENABLED`. Si se define este campo, se anulan los nombres de campo definidos 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. En el caso de la búsqueda estructurada de un solo almacén de datos, el valor predeterminado es `HARD_FILTER`. En las búsquedas en varios almacenes de datos, el comportamiento predeterminado es `SOFT_BOOST`. Los filtros basados en la ubicación siempre se aplican como filtros estrictos, por lo que el ajuste `SOFT_BOOST` no les afectará. Este campo solo se usa si [SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition][] tiene el valor `FilterExtractionCondition.ENABLED`.
`allowed_field_names[]`	`string` Opcional. Lista de permitidos de 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 se pueden usar para extraer filtros de lenguaje natural (pero no se garantiza que se utilicen). Si se especifica algún campo en allowed_field_names, solo los campos que estén marcados como indexables en el esquema y que se especifiquen en la lista de permitidos podrán extraerse mediante filtros de lenguaje natural. Nota: La búsqueda en varios almacenes de datos aún no se admite y se ignorará.

ExtractedFilterBehavior

Enumeración que describe cómo se aplican los filtros extraídos a la búsqueda.

Enumeraciones
`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED`	`EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` usará el comportamiento predeterminado para los filtros extraídos. En el caso de las búsquedas en un solo almacén de datos, los filtros se aplican de forma predeterminada como filtros estrictos. En el caso de la búsqueda en varios almacenes de datos, se aplican como refuerzos parciales de forma predeterminada.
`HARD_FILTER`	Aplica todos los filtros extraídos como filtros fijos en los resultados. Los resultados que no cumplan los filtros extraídos no se devolverán en el conjunto de resultados.
`SOFT_BOOST`	Aplica todos los filtros extraídos como aumentos suaves. Los resultados que cumplan los filtros se impulsarán a puestos más altos en el conjunto de resultados.

FilterExtractionCondition

Enumeración que describe en qué condición se debe producir la extracción del filtro.

Enumeraciones
`CONDITION_UNSPECIFIED`	El comportamiento predeterminado del servidor es `DISABLED`.
`DISABLED`	Inhabilita la extracción de filtros de lenguaje natural.
`ENABLED`	Habilita la extracción de filtros de lenguaje natural.

QueryExpansionSpec

Especificación para determinar en qué condiciones se debe producir la ampliación de la consulta.

Campos

condition

Condition

La condición en la que se debe producir la ampliación de la consulta. El valor predeterminado es Condition.DISABLED.

pin_unexpanded_results

bool

Si se deben fijar los resultados sin expandir. Si este campo tiene el valor true, los productos sin desplegar siempre se mostrarán en la parte superior de los resultados de búsqueda, seguidos de los resultados desplegados.

Condición

Enumeración que describe en qué condiciones se debe producir la ampliación de la consulta.

Enumeraciones
`CONDITION_UNSPECIFIED`	Condición de expansión de consulta no especificada. En este caso, el comportamiento del servidor es `Condition.DISABLED` de forma predeterminada.
`DISABLED`	Se ha inhabilitado la ampliación de consultas. Solo se utiliza la consulta de búsqueda exacta, aunque `SearchResponse.total_size` sea cero.
`AUTO`	Expansión automática de consultas creada por la API Search.

RankingExpressionBackend

Backend que se va a usar para la evaluación de la expresión de clasificación.

Enumeraciones
`RANKING_EXPRESSION_BACKEND_UNSPECIFIED`	Opción predeterminada para valores no especificados o desconocidos.
`BYOE`	Obsoleto: usa `RANK_BY_EMBEDDING` en su lugar. Clasificación por modelo de inserción personalizado, que es la forma predeterminada de evaluar la expresión de clasificación. Opción de enumación antigua. En su lugar, se debe usar `RANK_BY_EMBEDDING`. Este elemento está obsoleto.
`CLEARBOX`	Obsoleto: usa `RANK_BY_FORMULA` en su lugar. Clasificación por fórmula personalizada. Opción de enumación antigua. En su lugar, se debe usar `RANK_BY_FORMULA`. Este elemento está obsoleto.
`RANK_BY_EMBEDDING`	Clasificación por modelo de inserción personalizado, que es la forma predeterminada de evaluar la expresión de clasificación.
`RANK_BY_FORMULA`	Clasificación por fórmula personalizada.

RelevanceScoreSpec

Especificación para devolver la puntuación de relevancia del documento.

Campos

return_relevance_score

bool

Opcional. Indica si se devuelve la puntuación de relevancia de los resultados de búsqueda. Cuanto mayor sea la puntuación, más relevante será el documento para la consulta.

RelevanceThreshold

El umbral de relevancia de los resultados de búsqueda. Cuanto más alto sea el umbral de relevancia, más resultados relevantes se mostrarán y menos resultados se devolverán.

Enumeraciones
`RELEVANCE_THRESHOLD_UNSPECIFIED`	Valor predeterminado. En este caso, el comportamiento del servidor se ajusta al umbral definido por Google.
`LOWEST`	Umbral de relevancia más bajo.
`LOW`	Umbral de relevancia bajo.
`MEDIUM`	Umbral de relevancia medio.
`HIGH`	Umbral de relevancia alto.

SearchAsYouTypeSpec

Especificación de la búsqueda mientras escribes en las solicitudes de búsqueda.

Campos

condition

Condition

La condición en la que se debe producir la búsqueda a medida que se escribe. El valor predeterminado es Condition.DISABLED.

Condición

Enumeración que describe en qué condiciones se debe producir la búsqueda mientras escribes.

Enumeraciones
`CONDITION_UNSPECIFIED`	El comportamiento predeterminado del servidor es `Condition.DISABLED`.
`DISABLED`	Inhabilita la búsqueda a medida que se escribe.
`ENABLED`	Habilita la función de búsqueda a medida que se escribe.
`AUTO`	Cambio automático entre los modos de búsqueda mientras escribes y de búsqueda estándar, ideal para implementaciones de una sola API (por ejemplo, para evitar rebotes).

SessionSpec

Especificación de la sesión.

La función de búsqueda multirrespuesta se encuentra en la fase de disponibilidad general privada. Usa la versión v1alpha o v1beta antes de que lancemos esta función para el público general. También puedes solicitar que se te incluya en la lista de permitidos a través del equipo de Asistencia de Google.

Campos

query_id

string

Si se define, el resultado de búsqueda se almacena en el turno especificado por este ID de consulta.

Ejemplo: Supongamos que la sesión es la siguiente: session { name: ".../sessions/xxx" turns { query { text: "¿Qué es foo?" query_id: ".../questions/yyy" } answer: "Foo es ..." } turns { query { text: "¿Y bar?" query_id: ".../questions/zzz" } } }

El usuario puede llamar a la API /search con una solicitud como esta:

session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" }

Después, la API almacena el resultado de búsqueda asociado al último turno. El resultado de la búsqueda almacenada se puede usar en una llamada posterior a la API /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 el mismo ID de consulta.

search_result_persistence_count

int32

Número de resultados de búsqueda principales que se conservarán. Los resultados de búsqueda persistentes se pueden usar en la llamada posterior a la API /answer.

Este campo es similar al campo summary_result_count de SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count.

Un máximo de 10 resultados en el modo Documentos o 50 en el modo Fragmentos.

SpellCorrectionSpec

Especificación de la corrección ortográfica de la consulta.

Campos

mode

Mode

El modo en el que la corrección ortográfica sustituye a la consulta de búsqueda original. El valor predeterminado es Mode.AUTO.

Modo

Enumeración que describe en qué modo se debe realizar la corrección ortográfica.

Enumeraciones
`MODE_UNSPECIFIED`	Modo de corrección ortográfica no especificado. En este caso, el comportamiento del servidor es `Mode.AUTO` de forma predeterminada.
`SUGGESTION_ONLY`	La API Search intenta encontrar una sugerencia ortográfica. Si se encuentra una sugerencia, se coloca en la `SearchResponse.corrected_query`. La sugerencia ortográfica no se usará como consulta de búsqueda.
`AUTO`	Corrección ortográfica automática creada por la API Search. La búsqueda se basará en la consulta corregida, si se encuentra.

SearchResponse

Mensaje de respuesta del método SearchService.Search.

Campos
`results[]`	`SearchResult` Lista de documentos coincidentes. El orden representa la clasificación.
`facets[]`	`Facet` Resultados de las facetas solicitadas por el usuario.
`total_size`	`int32` El recuento total estimado de elementos coincidentes, independientemente de la paginación. El recuento de `results` devuelto por la paginación puede ser inferior al de `total_size` que coincida.
`attribution_token`	`string` Un token de búsqueda único. Esto debe incluirse en los `UserEvent` registros resultantes de esta búsqueda, lo que permite atribuir con precisión el rendimiento del modelo de búsqueda. Esto también ayuda a identificar una solicitud durante las situaciones de asistencia al cliente.
`redirect_uri`	`string` El URI de una página de redirección definida por el cliente. Si se activa la acción de redirección, no se realiza ninguna búsqueda y solo se definen `redirect_uri` y `attribution_token` en la respuesta.
`next_page_token`	`string` Token que se puede enviar como `SearchRequest.page_token` para obtener la siguiente página. Si se omite este campo, no hay páginas posteriores.
`corrected_query`	`string` Contiene la consulta con la ortografía corregida, si se ha encontrado. Si el tipo de corrección ortográfica es AUTOMATIC, los resultados de búsqueda se basan en corrected_query. De lo contrario, se usa la consulta original para la búsqueda.
`summary`	`Summary` Un resumen como parte de los resultados de búsqueda. Este campo solo se devuelve si se ha definido `SearchRequest.ContentSearchSpec.summary_spec`.
`query_expansion_info`	`QueryExpansionInfo` Información sobre la ampliación de la consulta de los resultados devueltos.
`session_info`	`SessionInfo` Información de la sesión. Solo se define si se proporciona `SearchRequest.session`. Consulta su descripción para obtener más información.
`search_link_promotions[]`	`SearchLinkPromotion` Promociones de búsqueda en el sitio.

Un resultado de faceta.

Campos

key

string

La clave de esta faceta. Por ejemplo, "colors" o "price". Coincide con SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

Valores de las facetas de este campo.

dynamic_facet

bool

Indica si la faceta se genera de forma dinámica.

FacetValue

Un valor de faceta que contiene nombres de valores y su recuento.

Campos
`count`	`int64` Número de elementos que tienen este valor de faceta.
Campo de unión `facet_value`. Un valor de facet que contiene valores. `facet_value` solo puede ser una de estas dos opciones:
`value`	`string` Valor de texto de una faceta, como "Negro" para la faceta "Colores".
`interval`	`Interval` Valor del intervalo de una faceta, como [10, 20) para la faceta "price". Coincide con `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Información que describe la ampliación de consultas, incluido si se ha producido o no.

Campos

expanded_query

bool

Valor booleano que describe si se ha ampliado la consulta.

pinned_result_count

int64

Número de resultados fijados. Este campo solo se definirá cuando se produzca una expansión y SearchRequest.QueryExpansionSpec.pin_unexpanded_results tenga el valor true.

SearchResult

Representa los resultados de búsqueda.

Campos
`id`	`string` `Document.id` de las búsquedas `Document`.
`document`	`Document` El fragmento de datos del documento en la respuesta de búsqueda. Solo se rellenan los campos marcados como `retrievable`.
`chunk`	`Chunk` Los datos del fragmento de la respuesta de búsqueda si `SearchRequest.ContentSearchSpec.search_result_mode` tiene el valor `CHUNKS`.
`model_scores`	`map<string, DoubleList>` Solo de salida. Google ha proporcionado las puntuaciones disponibles.
`rank_signals`	`RankSignals` Opcional. Conjunto de señales de clasificación asociadas al resultado.

RankSignals

Un conjunto de señales de ranking.

Campos
`default_rank`	`float` Opcional. El rango predeterminado del resultado.
`custom_signals[]`	`CustomSignal` Opcional. Lista de señales de clearbox personalizadas.
`keyword_similarity_score`	`float` Opcional. Ajuste de la concordancia con palabras clave.
`relevance_score`	`float` Opcional. Ajuste de la relevancia semántica.
`semantic_similarity_score`	`float` Opcional. Ajuste de la similitud semántica.
`pctr_rank`	`float` Opcional. Ajuste de la tasa de conversión estimada como un rango.
`topicality_rank`	`float` Opcional. Ajuste de la actualidad como una clasificación.
`document_age`	`float` Opcional. Antigüedad del documento en horas.
`boosting_factor`	`float` Opcional. Potenciadores personalizados combinados de un documento.

CustomSignal

Señal de clearbox personalizada representada por un par de nombre y valor.

Campos

name

string

Opcional. Nombre de la señal.

value

float

Opcional. Valor flotante que representa la señal de clasificación (por ejemplo, 1,25 para BM25).

SessionInfo

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

ID de consulta que corresponde a esta llamada a la API de búsqueda. Una sesión puede tener varias interacciones, cada una con un ID de consulta único.

Si especificas el nombre de la sesión y este ID de consulta en la llamada a la API Answer, la respuesta se generará en el contexto de los resultados de búsqueda de esta llamada de búsqueda.

Resumen

Resumen de los N resultados de búsqueda principales especificados por la especificación del resumen.

Campos
`summary_text`	`string` El contenido del resumen.
`summary_skipped_reasons[]`	`SummarySkippedReason` Motivos adicionales por los que se ha omitido el resumen. Proporciona el motivo de los casos ignorados. Si no se omite nada, este campo no se define.
`safety_attributes`	`SafetyAttributes` Colección de categorías de atributos de seguridad y sus puntuaciones de confianza asociadas.
`summary_with_metadata`	`SummaryWithMetadata` Resumen con información de metadatos.

Referencia

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

Fin del segmento atribuido (exclusivo).

sources[]

CitationSource

Fuentes de citas del segmento atribuido.

CitationMetadata

Metadatos de citas.

Campos

citations[]

Citation

Citas de segmentos.

CitationSource

Fuente de la cita.

Campos

reference_index

int64

Índice de referencia del documento de SummaryWithMetadata.references. Tiene un índice que empieza por 0 y el valor será cero si no se define el reference_index de forma explícita.

Referencia

Referencia del documento.

Campos
`title`	`string` Título del documento.
`document`	`string` Obligatorio. `Document.name` del documento. Nombre completo del recurso del documento al que se hace referencia, con el formato `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` URI de Cloud Storage o HTTP del documento.
`chunk_contents[]`	`ChunkContent` Lista de contenidos de fragmentos citados derivados del contenido del documento.

ChunkContent

Contenido de fragmento.

Campos

content

string

Divide el contenido textual en fragmentos.

page_identifier

string

Identificador de la página.

SafetyAttributes

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 asociadas al contenido generado. El orden coincide con las puntuaciones.

scores[]

float

Las puntuaciones de confianza de cada categoría. Un valor más alto significa una mayor confianza. El orden coincide con el de las categorías.

SummarySkippedReason

Enumeración de los motivos por los que se ha omitido el resumen.

Enumeraciones
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Valor predeterminado. No se ha especificado el motivo por el que se ha omitido el resumen.
`ADVERSARIAL_QUERY_IGNORED`	La consulta adversarial no distingue entre mayúsculas y minúsculas. Solo se usa cuando `SummarySpec.ignore_adversarial_query` se define como `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	La consulta que no busca resúmenes no ha distinguido entre mayúsculas y minúsculas. Google omite el resumen si la consulta es una conversación informal. Solo se usa cuando `SummarySpec.ignore_non_summary_seeking_query` se define como `true`.
`OUT_OF_DOMAIN_QUERY_IGNORED`	La consulta fuera del dominio no distingue entre mayúsculas y minúsculas. Google omite el resumen si no hay resultados de búsqueda de alta relevancia. Por ejemplo, el almacén de datos contiene información sobre la empresa A, pero la consulta del usuario hace preguntas sobre la empresa B.
`POTENTIAL_POLICY_VIOLATION`	El caso de posible infracción de las políticas. Google omite el resumen si detecta una posible infracción de las políticas. Esto incluye contenido que puede ser violento o tóxico.
`LLM_ADDON_NOT_ENABLED`	El complemento LLM no está habilitado. Google omite el resumen si el complemento LLM no está habilitado.
`NO_RELEVANT_CONTENT`	El caso de que no haya contenido relevante. Google omite el resumen si no hay contenido relevante en los resultados de búsqueda obtenidos.
`JAIL_BREAKING_QUERY_IGNORED`	La consulta para saltarse las restricciones no distinguía entre mayúsculas y minúsculas. Por ejemplo, "Responde con el tono del CEO de una empresa de la competencia". Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] se define en `true`.
`CUSTOMER_POLICY_VIOLATION`	El caso de infracción de la política de clientes. Google omite el resumen si se detecta una infracción de la política para clientes. La política la define el cliente.
`NON_SUMMARY_SEEKING_QUERY_IGNORED_V2`	La consulta que no busca una respuesta no distingue entre mayúsculas y minúsculas. Google omite el resumen si la consulta no tiene una intención clara. Solo se usa cuando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] se define como `true`.
`TIME_OUT`	El caso de tiempo de espera. Google omite el resumen si se agota el tiempo.

SummaryWithMetadata

Resumen con información de metadatos.

Campos

summary

string

Texto de resumen sin información de la cita.

citation_metadata

CitationMetadata

Metadatos de la cita del resumen proporcionado.

references[]

Reference

Referencias del documento.

SearchTier

Niveles de funciones de búsqueda. Los precios pueden variar en función del nivel. Para obtener más información, consulta la documentación sobre los precios.

Enumeraciones
`SEARCH_TIER_UNSPECIFIED`	Valor predeterminado cuando no se especifica la enumeración. No se puede usar.
`SEARCH_TIER_STANDARD`	Nivel Standard.
`SEARCH_TIER_ENTERPRISE`	Nivel Enterprise.

SearchUseCase

Define una subdivisión adicional de SolutionType. Se aplica específicamente a SOLUTION_TYPE_SEARCH.

Enumeraciones
`SEARCH_USE_CASE_UNSPECIFIED`	Valor que se usa cuando no se define. No se producirá en CSS.
`SEARCH_USE_CASE_SEARCH`	Caso práctico de búsqueda. Espera que el tráfico tenga un elemento `query` que no esté vacío.
`SEARCH_USE_CASE_BROWSE`	Consulta el caso práctico. Espera que el tráfico tenga un `query` vacío.

ServingConfig

Configura los metadatos que se usan para generar resultados de tiempo de servicio (por ejemplo, resultados de búsqueda o predicciones de recomendaciones). ServingConfig se incluye en la solicitud de búsqueda y predicción, y genera resultados.

Campos
`name`	`string` Inmutable. Nombre completo `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
`display_name`	`string` Obligatorio. Nombre visible de la configuración de servicio legible por humanos. Se usa en la interfaz de usuario de Discovery. Este campo debe ser una cadena codificada en UTF-8 con un límite de 128 caracteres. De lo contrario, se devuelve 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 servicio.
`model_id`	`string` ID del modelo que se usará en el momento de la publicación. Actualmente, solo se admiten RecommendationModels. Se puede cambiar, pero solo a un modelo compatible (por ejemplo, de CTR de otros que te pueden gustar a CVR de otros que te pueden gustar). Es obligatorio cuando `SolutionType` es `SOLUTION_TYPE_RECOMMENDATION`.
`diversity_level`	`string` Cantidad de diversidad que se debe usar en los resultados del modelo de recomendación, por ejemplo, `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 en función del tipo de modelo de recomendación. Valor predeterminado: `no-diversity`. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_RECOMMENDATION`.
`ranking_expression`	`string` La expresión de clasificación controla la clasificación personalizada de los documentos de recuperación. Para aprovechar esta función, es necesario insertar el documento. El ajuste de la expresión de clasificación de ServingConfig se aplica a todas las solicitudes de búsqueda que sirve la configuración de servicio. 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 el signo "+". ranking_expression = function, { " + ", function }; Funciones admitidas: double * relevance_score double * dotProduct(embedding_field_path) Variables de función: `relevance_score`: palabras clave predefinidas que se usan para medir la relevancia entre la consulta y el documento. `embedding_field_path`: el campo de inserción de documentos que se usa con el vector de inserción de consultas. `dotProduct`: función de inserción entre embedding_field_path y el vector de inserción de la consulta. Expresión de clasificación de ejemplo: Si el documento tiene un campo de inserció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 de salida. Marca de tiempo de creación de ServingConfig.
`update_time`	`Timestamp` Solo de salida. Marca de tiempo de la actualización de ServingConfig.
`filter_control_ids[]`	`string` Controles de filtro que se van a usar en la ruta de servicio. 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 servicio. Un máximo de 20 controles de filtros.
`boost_control_ids[]`	`string` Controles de aumento que se van a usar en la ruta de servicio. Se aplicarán todos los controles de aumento activados. Los controles de impulso deben estar en el mismo almacén de datos que la configuración de servicio. Se pueden añadir hasta 20 controles de aumento.
`redirect_control_ids[]`	`string` IDs de los controles de redirección. Solo se aplica la primera acción de redirección activada, aunque se apliquen varias. El número máximo de especificaciones es 100. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`synonyms_control_ids[]`	`string` Especificaciones de sinónimos de condiciones. Si se cumplen varias condiciones de sinónimos, se ejecutarán todos los controles de sinónimos coincidentes de la lista. El número máximo de especificaciones es 100. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`oneway_synonyms_control_ids[]`	`string` Condición de especificaciones de sinónimos unidireccionales. Si se cumplen varias condiciones de sinónimos unidireccionales, se ejecutarán todos los controles de sinónimos unidireccionales coincidentes de la lista. El número máximo de especificaciones es 100. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`dissociate_control_ids[]`	`string` La condición no asocia especificaciones. Si se cumplen varias condiciones de no asociación, se ejecutarán todos los controles de no asociación coincidentes de la lista. El orden no importa. El número máximo de especificaciones es 100. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`replacement_control_ids[]`	`string` Especificaciones de sustitución de condiciones. Se aplican según el orden de la lista. Un término que ya se ha sustituido no se puede volver a sustituir. El número máximo de especificaciones es 100. Solo se puede definir si `SolutionType` es `SOLUTION_TYPE_SEARCH`.
`ignore_control_ids[]`	`string` Condición de especificaciones de omisión. Si se cumplen varias condiciones de ignorar, se ejecutarán todos los controles de ignorar coincidentes de la lista. El orden no importa. El número máximo de especificaciones es 100.
`promote_control_ids[]`	`string` Especificaciones de la promoción de condiciones. El número máximo de especificaciones es 100.
`answer_generation_spec`	`AnswerGenerationSpec` Opcional. Especificación para la generación de respuestas.
Campo de unión `vertical_config`. Configuración específica de la vertical del sector. `vertical_config` solo puede ser una de estas dos opciones:
`media_config`	`MediaConfig` MediaConfig de la configuración de publicación.
`generic_config`	`GenericConfig` GenericConfig de la configuración de publicación.

GenericConfig

Especifica las configuraciones necesarias para la detección genérica.Actualmente, admitimos lo siguiente:

content_search_spec: 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 almacenes de datos con la búsqueda de contenido habilitada.

MediaConfig

Especifica las configuraciones necesarias para el descubrimiento de contenido multimedia. Actualmente, admitimos lo siguiente:

demote_content_watched: umbral para la degradación del contenido visto. Los clientes pueden especificar si quieren usar la degradación del contenido visto o la página de detalles vista. Si se usa la opción de degradación del contenido visto, los clientes deben especificar si los minutos o el porcentaje de contenido visto superan el umbral. Si es así, el contenido se degradará en los resultados de las recomendaciones.
promote_fresh_content: días límite para promocionar contenido nuevo. Los clientes pueden especificar si quieren usar la promoción de contenido actualizado. Si el contenido se publicó en los días límite, se promocionará en los resultados de las recomendaciones. Solo se puede definir si SolutionType es SOLUTION_TYPE_RECOMMENDATION.

Campos
`demotion_event_type`	`string` Especifica el tipo de evento que se usa para degradar el resultado de la recomendación. Valores admitidos actualmente: `view-item`: elemento visto. `media-play`: empezar o reanudar la reproducción de un vídeo, una canción, etc. `media-complete`: se ha terminado o se ha detenido a mitad de un vídeo, una canción, etc. Si no se define, no se aplicará la degradación del historial de reproducciones. Seguirá aplicándose la degradación por falta de actualización del contenido.
`demote_content_watched_past_days`	`int32` Opcional. Especifica el número de días que se deben tener en cuenta para rebajar la posición del contenido visto. Si se define en cero o no se define, se asigna el valor predeterminado de 365 días.
`content_freshness_cutoff_days`	`int32` Especifica la frecuencia de actualización del contenido que se usa para el resultado de la recomendación. El contenido se degradará si se ha publicado durante más días de los que se considera que está actualizado.
Campo de unión `demote_content_watched`. Especifica el umbral para rebajar la posición del contenido visto. Puede ser un porcentaje o un valor en minutos. Este campo debe definirse para el tipo de evento `media-complete`. `demote_content_watched` solo puede ser una de estas dos opciones:
`content_watched_percentage_threshold`	`float` Especifica el umbral del porcentaje de contenido visto para la degradación. El valor del umbral debe estar comprendido entre 0 y 1, 0 (ambos incluidos).
`content_watched_seconds_threshold`	`float` Especifica el umbral de minutos de contenido visto para la degradación.

Sesión

Definición del protocolo de sesión externa.

Campos
`name`	`string` Inmutable. Nombre completo `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
`display_name`	`string` Opcional. Nombre visible de la sesión. Este campo se usa para identificar la sesión en la interfaz de usuario. De forma predeterminada, el nombre visible es el texto de la primera consulta de la sesión.
`state`	`State` Estado de la sesión.
`user_pseudo_id`	`string` Identificador único para monitorizar a los usuarios.
`turns[]`	`Turn` Turnos.
`labels[]`	`string` Opcional. Etiquetas de la sesión. Se puede definir como filtro en ListSessionsRequest.
`start_time`	`Timestamp` Solo de salida. La hora a la que se inició la sesión.
`end_time`	`Timestamp` Solo de salida. Hora en la que finalizó la sesión.
`is_pinned`	`bool` Opcional. Si la sesión está fijada, se mostrará en la parte superior de la lista de sesiones.

Estado

Enumeración del estado de la sesión.

Enumeraciones
`STATE_UNSPECIFIED`	El estado no se ha especificado.
`IN_PROGRESS`	La sesión está abierta.

Activar

Representa una conversación, que incluye una consulta del usuario y una respuesta del servicio.

Campos
`query`	`Query` Opcional. La consulta del usuario. Puede que no se defina si este turno solo regenera una respuesta a un turno diferente.
`answer`	`string` Opcional. Nombre de recurso de la respuesta a la consulta del usuario. Solo se define si la generación de respuestas (llamada a la API /answer) se ha producido en este turno.
`assist_answer`	`string` Solo de salida. Nombre de recurso de la respuesta del Asistente a la consulta del usuario. Solo se define si se ha producido una llamada de asistencia (llamada a la API /assist) en este turno. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assist_answer}`. Para obtener todas las respuestas del Asistente de una sesión, asigna el valor true a GetSessionRequest.include_answer_details. También puedes usar la API AssistAnswerService.GetAssistAnswer para obtener un recurso AssistAnswer concreto.
`detailed_answer`	`Answer` Solo de salida. En la API `ConversationalSearchService.GetSession`, si `GetSessionRequest.include_answer_details` se establece en true, este campo se rellenará al obtener la sesión de consulta de respuesta.
`detailed_assist_answer`	`AssistAnswer` Solo de salida. En la API `ConversationalSearchService.GetSession`, si `GetSessionRequest.include_answer_details` se establece en true, este campo se rellenará al obtener la sesión del asistente.
`query_config`	`map<string, string>` Opcional. Representa los metadatos relacionados con la configuración de la consulta, como el modelo y la versión de LLM utilizados, los parámetros del modelo (temperatura, parámetros de fundamentación, etc.). El prefijo "google." está reservado para las funciones desarrolladas por Google.

SetUpDataConnectorMetadata

Este tipo no tiene campos.

Metadatos del método DataConnectorService.SetUpDataConnector.

SetUpDataConnectorRequest

Solicitud del método DataConnectorService.SetUpDataConnector.

Campos
`parent`	`string` Obligatorio. El elemento superior de `Collection`, con el formato `projects/{project}/locations/{location}`.
`collection_id`	`string` Obligatorio. El ID que se va a usar en `Collection`, que se convertirá en el componente final del nombre de recurso de `Collection`. Se crea un nuevo `Collection` como parte de la configuración de `DataConnector`. `DataConnector` es un recurso singleton de `Collection` que gestiona todos los `DataStore` de `Collection`. Este campo debe cumplir el estándar RFC-1034 y tener una longitud máxima de 63 caracteres. De lo contrario, se devuelve un error INVALID_ARGUMENT.
`collection_display_name`	`string` Obligatorio. El nombre visible de `Collection`. Debe ser legible y usarse para mostrar colecciones en el panel de control de la consola. Cadena codificada en UTF-8 con un límite de 1024 caracteres.
`data_connector`	`DataConnector` Obligatorio. El `DataConnector` para inicializar en el `Collection` recién creado.

SingleRegionKey

Metadatos de las CMEKs de una sola región.

Campos

kms_key

string

Obligatorio. Nombre del recurso de clave de KMS de una sola región que se usará para cifrar recursos projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}.

SiteSearchEngine

SiteSearchEngine captura las configuraciones persistentes de búsqueda en el sitio a nivel de DataStore. Es un valor singleton por almacén de datos.

Campos

name

string

Nombre completo del recurso del buscador del sitio. Formato: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Información de verificación de los sitios de destino 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

Hora de la última verificación del sitio.

SiteVerificationState

Estado de verificación del sitio.

Enumeraciones
`SITE_VERIFICATION_STATE_UNSPECIFIED`	El valor predeterminado es VERIFIED.
`VERIFIED`	Propiedad del sitio verificada.
`UNVERIFIED`	La verificación de la propiedad del sitio está pendiente o no se ha podido realizar.
`EXEMPTED`	Sitio exento de verificación, como un sitio web público que está abierto a todos los usuarios.

Sitemap

Un sitemap para el motor de búsqueda del sitio.

Campos
`name`	`string` Solo de salida. Nombre completo del recurso del mapa del sitio. `projects//locations//collections//dataStores//siteSearchEngine/sitemaps/*` El sufijo `sitemap_id` se genera automáticamente.
`create_time`	`Timestamp` Solo de salida. Hora de creación del sitemap.
Campo de unión `feed`. Fuentes de feeds admitidas. `feed` solo puede ser una de estas dos opciones:
`uri`	`string` URI público del sitemap, por ejemplo, `www.example.com/sitemap.xml`.

SolutionType

El tipo de solución.

Enumeraciones
`SOLUTION_TYPE_UNSPECIFIED`	Valor predeterminado.
`SOLUTION_TYPE_RECOMMENDATION`	Se usa para la IA de recomendaciones.
`SOLUTION_TYPE_SEARCH`	Se usa para la búsqueda de Discovery.
`SOLUTION_TYPE_CHAT`	Se usa en casos prácticos relacionados con el agente de IA generativa.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Se usa en casos prácticos relacionados con el agente de chat generativo. Solo se usa para el motor de chat generativo. Los almacenes de datos asociados deben registrarse con la solución `SOLUTION_TYPE_CHAT`.

SpannerSource

La fuente de Spanner para importar datos

Campos
`project_id`	`string` El ID del proyecto que contiene la fuente de Spanner. Tiene un límite de 128 caracteres. Si no se especifica, hereda el ID del proyecto de la solicitud principal.
`instance_id`	`string` Obligatorio. El ID de instancia de la tabla de Spanner de origen.
`database_id`	`string` Obligatorio. El ID de la base de datos de la tabla de Spanner de origen.
`table_id`	`string` Obligatorio. 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. Si habilitas esta opción, se te aplicará un coste adicional. En este artículo encontrarás más información.

StreamAssistRequest

Solicitud del método AssistantService.StreamAssist.

Campos
`name`	`string` Obligatorio. Nombre de recurso de `Assistant`. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
`query`	`Query` Opcional. Consulta del usuario actual. Las consultas vacías solo se admiten si se proporcionan `file_ids`. En este caso, la respuesta se generará a partir de esos archivos de contexto.
`session`	`string` Opcional. La sesión que se va a usar en la solicitud. Si se especifica, el asistente tiene acceso al historial de la sesión, y la consulta y la respuesta se almacenan ahí. Si se especifica `-` como ID de sesión o se deja vacío, se crea una sesión con un ID generado automáticamente. Formato: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
`user_metadata`	`AssistUserMetadata` Opcional. Información sobre el usuario que inicia la consulta.
`agents_spec`	`AgentsSpec` Opcional. Especificación de los agentes que se usan para atender la solicitud.
`tools_spec`	`ToolsSpec` Opcional. Especificación de las herramientas que se usan para atender la solicitud.
`generation_spec`	`GenerationSpec` Opcional. Especificación de la configuración de generación de la solicitud.

AgentsSpec

Especificación de los agentes que se usan para atender la solicitud.

Campos

agent_specs[]

AgentSpec

Opcional. Especificación de los agentes que se usan para atender la solicitud.

AgentSpec

Especificación de un agente.

Campos

agent_id

string

Obligatorio. ID para identificar el recurso de agente que sirve la solicitud.

Este campo debe cumplir la RFC-1034 y tener una longitud máxima de 63 caracteres.

GenerationSpec

Especificación de la generación del Asistente para la solicitud. Esto permite anular la configuración de generación predeterminada a nivel de motor.

Campos

model_id

string

Opcional. El valor de model_id de Vertex AI que se usa para el modelo generativo. Si no se define, se usará el modelo predeterminado del Asistente.

ToolsSpec

Especificación de las herramientas que se usan para atender la solicitud.

Campos
`vertex_ai_search_spec`	`VertexAiSearchSpec` Opcional. Especificación de la herramienta Vertex AI Search.
`web_grounding_spec`	`WebGroundingSpec` Opcional. Especificación de la herramienta de fundamentación web. Si el campo está presente, se 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. Especificación de la herramienta de generación de imágenes.
`video_generation_spec`	`VideoGenerationSpec` Opcional. Especificación de la herramienta de generación de vídeo.

ImageGenerationSpec

Este tipo no tiene campos.

Especificación de la herramienta de generación de imágenes.

VertexAiSearchSpec

Especificación de la herramienta Vertex AI Search.

Campos

data_store_specs[]

DataStoreSpec

Opcional. Especificaciones que definen los DataStore por los que se va a filtrar en una llamada de búsqueda y las configuraciones de esos almacenes de datos. Esto solo se tiene en cuenta en los Engines con varios almacenes de datos.

filter

string

Opcional. La sintaxis del filtro consta de un lenguaje de expresiones para crear un predicado a partir de uno o varios campos de los documentos que se van a filtrar. La expresión de filtro distingue entre mayúsculas y minúsculas.

Si este campo no se reconoce, se devuelve un INVALID_ARGUMENT.

El filtrado en Vertex AI Search se realiza asignando la clave de filtro del lado izquierdo a una propiedad de clave definida en el backend de Vertex AI Search. El cliente define esta asignación en su esquema. Por ejemplo, un cliente de medios puede tener un campo "nombre" en su esquema. En este caso, el filtro sería el siguiente: filter --> name:'ANY("king kong")'

Para obtener más información sobre el filtrado, incluida la sintaxis y los operadores de filtro, consulta Filtrar.

VideoGenerationSpec

Este tipo no tiene campos.

Especificación de la herramienta de generación de vídeo.

WebGroundingSpec

Este tipo no tiene campos.

Especificación de la herramienta de fundamentación web.

StreamAssistResponse

Respuesta del método AssistantService.StreamAssist.

Campos

answer

AssistAnswer

Objeto de recurso de respuesta de asistencia que contiene partes de la respuesta final del asistente a la consulta del usuario.

No se incluye si la respuesta actual no añade nada a la AssistAnswer.replies enviada anteriormente.

Consulta AssistAnswer.state para ver si se esperan más partes. Mientras el estado sea IN_PROGRESS, el campo AssistAnswer.replies de cada respuesta contendrá las respuestas (fragmentos de respuesta) que se añadirán a las recibidas en las respuestas anteriores. AssistAnswer.name no se rellenará.

Si el estado es SUCCEEDED, FAILED o SKIPPED, la respuesta es la última respuesta y AssistAnswer.name tendrá un valor.

session_info

SessionInfo

Información de la sesión. Solo se incluye en el StreamAssistResponse final de la respuesta encadenada.

assist_token

string

Un ID único global que identifica el par actual de solicitud y flujo de respuestas. Se usa para enviar comentarios y recibir asistencia.

SessionInfo

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

Periodo de vigencia de la suscripción. LINT.IfChange

Enumeraciones
`SUBSCRIPTION_TERM_UNSPECIFIED`	Valor predeterminado, no se usa.
`SUBSCRIPTION_TERM_ONE_MONTH`	1 mes.
`SUBSCRIPTION_TERM_ONE_YEAR`	1 año.
`SUBSCRIPTION_TERM_THREE_YEARS`	3 años.

SubscriptionTier

Información sobre el nivel de suscripción.

Enumeraciones
`SUBSCRIPTION_TIER_UNSPECIFIED`	Valor predeterminado.
`SUBSCRIPTION_TIER_SEARCH`	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 y asistente. Los usuarios del nivel de búsqueda + asistente pueden acceder a las funciones de búsqueda de VAIS, a las funciones de NotebookLM y a las funciones del 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 Enterprise.
`SUBSCRIPTION_TIER_EDU`	Nivel de centro educativo.
`SUBSCRIPTION_TIER_EDU_PRO`	Nivel EDU Pro.
`SUBSCRIPTION_TIER_EDU_EMERGING`	Nivel de mercado emergente de la institución educativa.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	Nivel de mercado emergente de EDU Pro.

SuggestionDenyListEntry

Entrada de la lista de denegación de sugerencias que identifica la frase que se va a bloquear de las sugerencias y la operación aplicada a la frase.

Campos

block_phrase

string

Obligatorio. Frase que se va a bloquear de las sugerencias mostradas. Puede tener un máximo de 125 caracteres.

match_operator

MatchOperator

Obligatorio. Operador de coincidencia que se va a aplicar a esta frase. Si quieres bloquear la frase exacta o cualquier sugerencia que la contenga.

MatchOperator

Operador para buscar coincidencias con las sugerencias generadas.

Enumeraciones
`MATCH_OPERATOR_UNSPECIFIED`	Valor predeterminado. No se debe usar
`EXACT_MATCH`	Si la sugerencia coincide exactamente con block_phrase, bloquéala.
`CONTAINS`	Si la sugerencia contiene la frase_bloqueada, bloquéala.

TargetSite

Sitio de destino de SiteSearchEngine.

Campos
`name`	`string` Solo de salida. Nombre de recurso completo 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 de entrada. El patrón de URI proporcionado por el usuario a partir del cual se genera el `generated_uri_pattern`.
`type`	`Type` El tipo de sitio de destino (por ejemplo, si el sitio se va a incluir o excluir).
`exact_match`	`bool` Inmutable. Si se define como "false", se genera un uri_pattern para incluir todas las páginas cuya dirección contenga el valor de provided_uri_pattern. Si se asigna el valor true, 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 utilizará el buscador.
`generated_uri_pattern`	`string` Solo de salida. Se genera automáticamente en función del valor de provided_uri_pattern.
`root_domain_uri`	`string` Solo de salida. Dominio raíz de provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Solo de salida. Estado de verificación de la propiedad y la validez del sitio.
`indexing_status`	`IndexingStatus` Solo de salida. Estado de indexación.
`update_time`	`Timestamp` Solo de salida. Hora de la última actualización del sitio de destino.
`failure_reason`	`FailureReason` Solo de salida. Motivo del error.

FailureReason

Motivos por los que no se ha podido indexar la búsqueda en el sitio.

Campos

Campo de unión failure. Motivo del error. failure solo puede ser una de estas dos opciones:

quota_failure

QuotaFailure

No se ha podido completar la acción por falta de cuota.

QuotaFailure

No se ha podido completar la acción por falta de cuota.

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

Enumeración del estado de indexación del sitio de destino.

Enumeraciones
`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 puede indexar el sitio de destino.
`SUCCEEDED`	El sitio de destino se ha indexado.
`DELETING`	El sitio de destino indexado anteriormente se ha marcado para que se elimine. Este es un estado de transición que dará lugar a lo siguiente: 1. el sitio de destino se elimina si la desindexación se realiza correctamente; 2. el estado vuelve a SUCCEEDED si la desindexación falla.
`CANCELLABLE`	El cambio de sitio de destino está pendiente, pero se puede cancelar.
`CANCELLED`	Se ha cancelado el cambio de sitio de destino.

Tipo

Tipos de sitios de destino posibles.

Enumeraciones
`TYPE_UNSPECIFIED`	Este valor no se usa. En este caso, el comportamiento del servidor es `Type.INCLUDE` de forma predeterminada.
`INCLUDE`	Incluya el sitio de destino.
`EXCLUDE`	Excluya el sitio de destino.

Cliente

Información del arrendatario de una fuente de conector. Incluye parte de la misma información almacenada en el mensaje Credential, pero se limita a lo que se necesita para proporcionar una lista de arrendatarios accesibles al usuario.

Campos

id

string

El ID de instancia del arrendatario. Por ejemplo, Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0") y Slack ("T123456").

uri

string

El URI del arrendatario, si procede. Por ejemplo, el URI de una instancia de Jira es https://my-jira-instance.atlassian.net, y un arrendatario de Slack no tiene URI.

display_name

string

Nombre visible opcional del arrendatario, como "Mi equipo de Slack".

TextInput

Define la entrada de texto.

Campos

input

string

Entrada de texto.

context

ConversationContext

Contexto de la conversación de la entrada.

TrainCustomModelMetadata

Metadatos relacionados con el progreso de la operación TrainCustomModel. Se devuelve en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

TrainCustomModelRequest

Mensaje de solicitud del método SearchTuningService.TrainCustomModel.

Campos
`data_store`	`string` Obligatorio. Nombre de 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` Modelo que se va a entrenar. Los valores admitidos son: 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 producidos durante la ingestión y el entrenamiento de los datos.
`model_id`	`string` Si no se proporciona, se generará un UUID.
Campo de unión `training_input`. Entrada de entrenamiento del modelo. `training_input` solo puede ser una de estas dos opciones:
`gcs_training_input`	`GcsTrainingInput` Entrada de entrenamiento de Cloud Storage.

GcsTrainingInput

Datos de entrada de entrenamiento de Cloud Storage.

Campos
`corpus_data_path`	`string` Los datos del corpus de Cloud Storage que se pueden asociar a los datos de entrenamiento. El formato de la ruta de datos es `gs://<bucket_to_data>/<jsonl_file_name>`. Un archivo jsonl o ndjson delimitado por líneas nuevas. En el caso del modelo de ajuste de búsqueda, cada línea debe tener _id, title y text. Ejemplo: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
`query_data_path`	`string` Los datos de consulta de GCS que se podrían asociar a los datos de entrenamiento. El formato de la ruta de datos es `gs://<bucket_to_data>/<jsonl_file_name>`. Un archivo jsonl o ndjson delimitado por líneas nuevas. En el caso del modelo de ajuste de búsqueda, cada línea debe tener el _id y el texto. Ejemplo: {"_id": "query1", "text": "example query"}
`train_data_path`	`string` Ruta de 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 búsqueda, debe tener la consulta, el ID del corpus y la puntuación como encabezado de archivo TSV. La puntuación debe ser un número de `[0, inf+)`. Cuanto mayor sea el número, más relevante será el par. Por ejemplo: `query-id\tcorpus-id\tscore` `query1\tdoc1\t1`
`test_data_path`	`string` Datos de prueba de Cloud Storage. Tiene el mismo formato que train_data_path. Si no se proporciona, se realizará una división aleatoria de 80/20 entre los datos de entrenamiento y de prueba en train_data_path.

TrainCustomModelResponse

Respuesta de TrainCustomModelRequest. Este mensaje se devuelve en el campo google.longrunning.Operations.response.

Campos
`error_samples[]`	`Status` Una muestra de los errores detectados al procesar los datos.
`error_config`	`ImportErrorConfig` Muestra el destino de los errores completos de la solicitud, si se ha definido.
`model_status`	`string` El estado del modelo preparado. Los valores posibles son: bad-data: la calidad de los datos de entrenamiento es mala. no-improvement: el ajuste no ha mejorado el rendimiento. No se implementará. En curso: se está creando la tarea de entrenamiento del modelo. Entrenamiento: el modelo se está entrenando. Evaluando: el modelo está evaluando las métricas entrenadas. Indexación: las métricas entrenadas del modelo se están indexando. Ready: el modelo está listo para servir.
`metrics`	`map<string, double>` Las métricas del modelo entrenado.
`model_name`	`string` Nombre completo de CustomTuningModel.

TransactionInfo

Una transacción representa toda la transacción de compra.

Campos
`currency`	`string` Obligatorio. Código de moneda. Usa el código ISO 4217 de tres caracteres.
`transaction_id`	`string` El ID de transacción, que tiene un límite de 128 caracteres.
`value`	`float` Obligatorio. Valor total distinto de cero asociado a la transacción. Este valor puede incluir los gastos de envío, los impuestos u otros ajustes del valor total que quiera incluir.
`tax`	`float` Todos los impuestos asociados a la transacción.
`cost`	`float` Todos los costes asociados a los productos. Pueden ser costes de fabricación, gastos de envío que no corran a cargo del usuario final o cualquier otro coste, de modo que: Beneficio = `value` - `tax` - `cost`
`discount_value`	`float` Valor total de los descuentos aplicados a esta transacción. Esta cifra debe excluirse de `TransactionInfo.value` Por ejemplo, si un usuario ha pagado `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 los beneficios se calculan de la misma forma, independientemente del valor del descuento, y que `TransactionInfo.discount_value` puede ser mayor que `TransactionInfo.value`: Beneficio = `value` - `tax` - `cost`

UpdateAclConfigRequest

Mensaje de solicitud del método UpdateAclConfig.

Campos
`acl_config`	`AclConfig`

UpdateAssistantRequest

Mensaje de solicitud del método AssistantService.UpdateAssistant.

Campos

assistant

Assistant

Obligatorio. Assistant que se va a actualizar.

El campo name del Assistant se usa para identificar el Assistant que se va a actualizar. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Si la persona que llama no tiene permiso para actualizar el Assistant, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Assistant que se va a actualizar no existe, se devuelve un error NOT_FOUND.

update_mask

Lista de campos que se van a actualizar.

UpdateCmekConfigMetadata

Metadatos relacionados con el progreso de la operación CmekConfigService.UpdateCmekConfig. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

UpdateCmekConfigRequest

Mensaje de solicitud del método UpdateCmekConfig. rpc.

Campos

config

CmekConfig

Obligatorio. El recurso CmekConfig.

set_default

bool

Define el siguiente CmekConfig como predeterminado para que se use en los recursos secundarios si no se especifica ninguno.

UpdateControlRequest

Solicitud del método UpdateControl.

Campos

control

Control

Obligatorio. El control que se va a actualizar.

update_mask

Opcional. Indica qué campos del Control proporcionado se van a actualizar. NO es posible realizar las acciones siguientes:

Control.name
Control.solution_type

Si no se define o está vacío, se actualizan todos los campos admitidos.

UpdateConversationRequest

Solicitud del método UpdateConversation.

Campos

conversation

Obligatorio. La conversación que se va a actualizar.

update_mask

Indica qué campos del Conversation proporcionado se van a actualizar. NO es posible realizar las acciones siguientes:

Conversation.name

Si no se define o está vacío, se actualizan todos los campos admitidos.

UpdateDataConnectorRequest

Mensaje de solicitud del método DataConnectorService.UpdateDataConnector.

Campos

data_connector

DataConnector

Obligatorio. DataConnector que se va a actualizar.

Si la persona que llama no tiene permiso para actualizar el DataConnector, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si no existe el DataConnector, se devuelve un error NOT_FOUND.

update_mask

Indica qué campos del DataConnector proporcionado se van a actualizar.

Entre las rutas de campo admitidas se 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 en función del tipo de conector. Por ejemplo, no todos los conectores admiten destination_configs.

Si se proporciona una ruta de campo no admitida o desconocida, la solicitud devolverá un error INVALID_ARGUMENT.

UpdateDataStoreRequest

Mensaje de solicitud del método DataStoreService.UpdateDataStore.

Campos

data_store

DataStore

Obligatorio. DataStore que se va a actualizar.

Si la persona que llama no tiene permiso para actualizar el DataStore, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el DataStore que se va a actualizar no existe, se devuelve un error NOT_FOUND.

update_mask

Indica qué campos del DataStore proporcionado se van a actualizar.

Si se proporciona un campo no admitido o desconocido, se devuelve un error INVALID_ARGUMENT.

UpdateDocumentRequest

Mensaje de solicitud del método DocumentService.UpdateDocument.

Campos

document

Obligatorio. Documento que se va a actualizar o crear.

Si la persona que llama no tiene permiso para actualizar Document, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Document que se va a actualizar no existe y allow_missing no se ha definido, se devuelve un error NOT_FOUND.

allow_missing

bool

Si se define como true y no se encuentra el Document, se creará un Document.

update_mask

Indica qué campos del documento importado proporcionado se van a actualizar. Si no se define, se actualizan todos los campos de forma predeterminada.

UpdateEngineRequest

Mensaje de solicitud del método EngineService.UpdateEngine.

Campos

engine

Engine

Obligatorio. Engine que se va a actualizar.

Si la persona que llama no tiene permiso para actualizar el Engine, independientemente de si existe o no, se devuelve un error PERMISSION_DENIED.

Si el Engine que se va a actualizar no existe, se devuelve un error NOT_FOUND.

update_mask

Indica qué campos del Engine proporcionado se van a actualizar.

Si se proporciona un campo no admitido o desconocido, se devuelve un error INVALID_ARGUMENT.

UpdateLicenseConfigRequest

Mensaje de solicitud del método LicenseConfigService.UpdateLicenseConfig.

Campos

license_config

LicenseConfig

Obligatorio. LicenseConfig que se va a actualizar.

update_mask

Opcional. Indica qué campos del LicenseConfig proporcionado se van a actualizar.

Si se proporciona un campo no admitido o desconocido, se devuelve un error INVALID_ARGUMENT.

UpdateSchemaMetadata

Metadatos de LRO de UpdateSchema.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

UpdateSchemaRequest

Mensaje de solicitud del método SchemaService.UpdateSchema.

Campos

schema

Schema

Obligatorio. Schema que se va a actualizar.

allow_missing

bool

Si se le asigna el valor true y no se encuentra el Schema, se crea un Schema. En esta situación, se ignora update_mask.

UpdateServingConfigRequest

Solicitud del método UpdateServingConfig.

Campos

serving_config

ServingConfig

Obligatorio. ServingConfig que se va a actualizar.

update_mask

Indica qué campos del ServingConfig proporcionado se van a actualizar. NO es posible realizar las acciones siguientes:

ServingConfig.name

Si no se define, se actualizan todos los campos admitidos.

UpdateSessionRequest

Solicitud del método UpdateSession.

Campos

session

Obligatorio. La sesión que se va a actualizar.

update_mask

Indica qué campos del Session proporcionado se van a actualizar. NO es posible realizar las acciones siguientes:

Session.name

Si no se define o está vacío, se actualizan todos los campos admitidos.

UpdateTargetSiteMetadata

Metadatos relacionados con el progreso de la operación SiteSearchEngineService.UpdateTargetSite. Se devolverá en el campo google.longrunning.Operation.metadata.

Campos

create_time

Hora de creación de la operación.

update_time

Hora de la última actualización de la operación. Si la operación se ha completado, también es la hora de finalización.

UpdateTargetSiteRequest

Mensaje de solicitud del método SiteSearchEngineService.UpdateTargetSite.

Campos

target_site