REST Resource: projects.locations.collections.engines

Recurso: Engine

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

Representación JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "dataStoreIds": [
    string
  ],
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "commonConfig": {
    object (CommonConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),

  // Union field engine_config can be only one of the following:
  "similarDocumentsConfig": {
    object (SimilarDocumentsEngineConfig)
  },
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of list of possible types for union field engine_config.

  // Union field engine_metadata can be only one of the following:
  "recommendationMetadata": {
    object (RecommendationMetadata)
  },
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
Campos
name

string

Inmutable. Es el identificador. Es el nombre completamente calificado del recurso del motor.

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

Formato: El motor projects/{project}/locations/{location}/collections/{collection}/engines/{engine} debe tener entre 1 y 63 caracteres, y los caracteres válidos son /[a-z0-9][a-z0-9-_]*/. De lo contrario, se muestra un error INVALID_ARGUMENT.
displayName

string

Obligatorio. Es el nombre visible del motor. Debe ser legible. Es una cadena codificada en UTF-8 con un límite de 1,024 caracteres.
createTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se creó el motor de recomendaciones.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo de la última actualización del motor de recomendaciones.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Opcional. Son los almacenes de datos asociados a este motor.

En el caso de los motores de tipo SOLUTION_TYPE_SEARCH y SOLUTION_TYPE_RECOMMENDATION, solo se pueden asociar con un máximo de un almacén de datos.

Si solutionType es SOLUTION_TYPE_CHAT, se pueden asociar varios DataStore en el mismo Collection.

Ten en cuenta que, cuando se usa en CreateEngineRequest, se debe proporcionar un ID de DataStore, ya que el sistema lo usará para las inicializaciones necesarias.
solutionType

enum (SolutionType)

Obligatorio. Son las soluciones del motor.
industryVertical

enum (IndustryVertical)

Opcional. Es la vertical de la industria que registra el motor. La restricción de la vertical de la industria del motor se basa en DataStore: La vertical del motor debe coincidir con la vertical del DataStore vinculado al motor.
commonConfig

object (CommonConfig)

Es una especificación de configuración común que especifica los metadatos del motor.
appType

enum (AppType)

Opcional. Inmutable. Es el tipo de aplicación que representa este recurso del motor. NOTA: Este es un concepto nuevo independiente del sector vertical o el tipo de solución existentes.
disableAnalytics

boolean

Opcional. Indica si se deben inhabilitar las estadísticas de las búsquedas realizadas en este motor.
features

map (key: string, value: enum (FeatureState))

Opcional. Es la configuración de funciones para que el motor habilite o inhabilite funciones. Claves admitidas:

  • *: Todos los elementos. Si está presente, se ignoran todos los demás parámetros de configuración del estado del elemento.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Es la configuración para el enfoque de facturación configurable.
Campo de unión engine_config. Son especificaciones de configuración adicionales que definen el comportamiento del motor. engine_config puede ser solo uno de los siguientes:
similarDocumentsConfig

object (SimilarDocumentsEngineConfig)

Son especificaciones de configuración adicionales para un motor de similar-items.
chatEngineConfig

object (ChatEngineConfig)

Son las configuraciones del motor de chat. Solo se aplica si solutionType es SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Son los parámetros de configuración del motor de búsqueda. Solo se aplica si solutionType es SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Son las configuraciones del motor de medios. Solo se aplica a los almacenes de datos con las verticales solutionType, SOLUTION_TYPE_RECOMMENDATION y IndustryVertical.MEDIA.
Campo de unión engine_metadata. Son los metadatos del motor para supervisar su estado. engine_metadata puede ser solo uno de los siguientes:
recommendationMetadata

object (RecommendationMetadata)

Solo salida. Es información adicional sobre un motor de recomendaciones. Solo se aplica si solutionType es SOLUTION_TYPE_RECOMMENDATION.
chatEngineMetadata

object (ChatEngineMetadata)

Solo salida. Es información adicional sobre el motor de Chat. Solo se aplica si solutionType es SOLUTION_TYPE_CHAT.

SimilarDocumentsEngineConfig

Este tipo no tiene campos.

Son especificaciones de configuración adicionales para un motor de similar-items.

ChatEngineConfig

Es la configuración de un Chat Engine.

Representación JSON 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Campos
agentCreationConfig

object (AgentCreationConfig)

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

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

boolean

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

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

AgentCreationConfig

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

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

Representación JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Campos
business

string

Nombre de la empresa, organización o cualquier otra entidad que representa el agente Se usa para la instrucción del LLM del conector de conocimiento y para la búsqueda de conocimiento.
defaultLanguageCode

string

Obligatorio. El idioma predeterminado del agente como una etiqueta de idioma. Consulta Idiomas admitidos para obtener una lista de los códigos de idioma admitidos en este momento.
timeZone

string

Obligatorio. La zona horaria del agente de la base de datos de zonas horarias, p. ej., America/New_York, Europe/Paris.
location

string

Ubicación del agente para la creación del agente. Los valores admitidos son global/us/eu. Si no se proporciona, el motor de EE.UU. creará el agente con us-central-1 de forma predeterminada, y el motor de la UE creará el agente con eu-west-1 de forma predeterminada.

SearchEngineConfig

Son las configuraciones de un motor de búsqueda.

Representación JSON 
{
  "searchTier": enum (SearchTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Campos
searchTier

enum (SearchTier)

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

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

El valor predeterminado es SearchTier.SEARCH_TIER_STANDARD si no se especifica.
searchAddOns[]

enum (SearchAddOn)

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

SearchTier

Son los niveles de las funciones de búsqueda. Los diferentes niveles pueden tener precios diferentes. Para obtener más información, consulta la documentación sobre precios.

Enums
SEARCH_TIER_UNSPECIFIED Es el valor predeterminado cuando no se especifica el enum. No se puede usar.
SEARCH_TIER_STANDARD Nivel Estándar.
SEARCH_TIER_ENTERPRISE Nivel empresarial.

SearchAddOn

Es un complemento que proporciona funcionalidad adicional para la búsqueda.

Enums
SEARCH_ADD_ON_UNSPECIFIED Es el valor predeterminado cuando no se especifica el enum. No se puede usar.
SEARCH_ADD_ON_LLM Complemento de modelo de lenguaje grande.

MediaRecommendationEngineConfig

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

Representación JSON 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Campos
type

string

Obligatorio. Es el tipo de motor, p. ej., recommended-for-you

Este campo, junto con optimizationObjective, describe los metadatos del motor que se usarán para controlar el entrenamiento y la publicación del motor.

Actualmente, los valores admitidos son recommended-for-you, others-you-may-like, more-like-this y most-popular-items.
optimizationObjective

string

Es el objetivo de optimización, p. ej., cvr

Este campo, junto con optimizationObjective, describe los metadatos del motor que se usarán para controlar el entrenamiento y la publicación del motor.

Valores admitidos actualmente: ctr, cvr.

Si no se especifica, elegimos el valor predeterminado según el tipo de motor. El valor predeterminado depende del tipo de recomendación:

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nombre y valor del umbral personalizado para el objetivo de optimización cvr. Para targetField watch-time, target_field_value debe ser un valor entero que indique el tiempo de progreso de los medios en segundos entre (0, 86400] (excluye el 0, incluye el 86400) (p.ej., 90). Para targetField watch-percentage, target_field_value debe ser un valor de número de punto flotante válido entre (0, 1.0] (excluye el 0, incluye el 1.0) (p.ej., 0.5).
trainingState

enum (TrainingState)

Es el estado de entrenamiento en el que se encuentra el motor (p.ej., TRAINING o PAUSED).

Dado que parte del costo de ejecutar el servicio es la frecuencia de entrenamiento, esto se puede usar para determinar cuándo entrenar el motor y controlar el costo. Si no se especifica, el valor predeterminado para el método engines.create es TRAINING. El valor predeterminado para el método engines.patch es mantener el estado como antes.
engineFeaturesConfig

object (EngineFeaturesConfig)

Opcional. Es la configuración de funciones adicionales del motor.

OptimizationObjectiveConfig

Es el umbral personalizado para optimizationObjective de cvr.

Representación JSON 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Campos
targetField

string

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

number

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

TrainingState

Es el estado de entrenamiento del motor.

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

EngineFeaturesConfig

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

Representación JSON 
{

  // Union field type_dedicated_config can be only one of the following:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of list of possible types for union field type_dedicated_config.
}
Campos
Campo de unión type_dedicated_config. Son los parámetros de configuración relacionados con las funciones que se aplican a un tipo específico de motores de recomendación de medios. type_dedicated_config puede ser solo uno de los siguientes:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

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

RecommendedForYouFeatureConfig

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

Representación JSON 
{
  "contextEventType": string
}
Campos
contextEventType

string

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

MostPopularFeatureConfig

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

Representación JSON 
{
  "timeWindowDays": string
}
Campos
timeWindowDays

string (int64 format)

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

RecommendationMetadata

Es información adicional sobre un motor de recomendaciones.

Representación JSON 
{
  "servingState": enum (ServingState),
  "dataState": enum (DataState),
  "lastTuneTime": string,
  "lastTrainTime": string,
  "tuningOperation": string
}
Campos
servingState

enum (ServingState)

Solo salida. Es el estado de publicación del motor: ACTIVE, NOT_ACTIVE.
dataState

enum (DataState)

Solo salida. Es el estado de los requisitos de datos para este motor: DATA_OK y DATA_ERROR.

El motor no se puede entrenar si los datos están en estado DATA_ERROR. El motor puede tener el estado DATA_ERROR incluso si el estado de servicio es ACTIVE: Los motores se entrenaron correctamente antes, pero no se pueden actualizar porque el motor subyacente ya no tiene suficientes datos para el entrenamiento.
lastTuneTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que finalizó el ajuste exitoso más reciente. Solo se aplica a los motores de recomendación de medios.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
lastTrainTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que finalizó el entrenamiento exitoso más reciente. Solo se aplica a los motores de recomendación de medios.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
tuningOperation

string

Solo salida. Es el ID de la operación de ajuste más reciente asociado al motor. Solo se aplica a los motores de recomendación de medios.

Si está presente, este ID de operación se puede usar para determinar si hay un ajuste en curso para este motor. Para verificar el estado de la operación, envía la solicitud operations.get con este ID de operación en el formato de recurso del motor. Si no se realizó ningún ajuste para este motor, la cadena estará vacía.

ServingState

Es el estado de publicación del motor de recomendaciones.

Enums
SERVING_STATE_UNSPECIFIED No se especificó el estado de publicación.
INACTIVE El motor no está publicando contenido.
ACTIVE El motor está en funcionamiento y se le pueden realizar consultas.
TUNED El motor se entrena con hiperparámetros ajustados y se puede consultar.

DataState

Describe si este motor tiene suficientes datos de entrenamiento para entrenarse de forma continua.

Enums
DATA_STATE_UNSPECIFIED Es un valor predeterminado no especificado que nunca se debe establecer de forma explícita.
DATA_OK El motor tiene suficientes datos de entrenamiento.
DATA_ERROR El motor no tiene suficientes datos de entrenamiento. Los mensajes de error se pueden consultar a través de Stackdriver.

ChatEngineMetadata

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

Representación JSON 
{
  "dialogflowAgent": string
}
Campos
dialogflowAgent

string

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

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

CommonConfig

Son configuraciones comunes para un motor.

Representación JSON 
{
  "companyName": string
}
Campos
companyName

string

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

AppType

Es la app del motor.

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

FeatureState

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

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

ConfigurableBillingApproach

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

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

Métodos

create

 Crea un Engine.

delete

 Borra un Engine.

get

 Obtienes una Engine.

getCompletionConfig

 Obtiene un CompletionConfig.

getWorkspaceSettings

 Obtiene la configuración de Workspace para el usuario final.

list

 Enumera todos los Engine asociados al proyecto.

patch

 Actualiza un Engine

pause

 Pausa el entrenamiento de un motor existente.

resume

 Reanuda el entrenamiento de un motor existente.

tune

 Ajusta un motor existente.

updateCompletionConfig

 Actualiza los CompletionConfig.