REST Resource: projects.locations.collections.engines

Recurso: Engine

Metadatos que describen los parámetros de entrenamiento y servicio 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:
  "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:
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of list of possible types for union field engine_metadata.
}
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.
displayName

string

Obligatorio. Nombre visible del motor. Debe ser legible. Cadena codificada en UTF-8 con un límite de 1024 caracteres.
createTime

string (Timestamp format)

Solo de salida. Marca de tiempo de la creación del motor de recomendaciones.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "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 de salida. Marca de tiempo de la última actualización de Recommendation Engine.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
dataStoreIds[]

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 solutionType es SOLUTION_TYPE_CHAT, se pueden asociar varios DataStores 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. Las soluciones del motor.
industryVertical

enum (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.
commonConfig

object (CommonConfig)

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 de motor. NOTA: Se trata de un concepto nuevo que no depende del vertical del sector ni del tipo de solución.
disableAnalytics

boolean

Opcional. Indica si se deben inhabilitar las analíticas de las búsquedas realizadas en este buscador.
features

map (key: string, value: enum (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
configurableBillingApproach

enum (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:
chatEngineConfig

object (ChatEngineConfig)

Configuraciones de Chat Engine. Solo se aplica si solutionType es SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Configuraciones del buscador. Solo se aplica si solutionType es SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Configuraciones de Media Engine. Solo se aplica a los almacenes de datos de los verticales solutionType 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:
chatEngineMetadata

object (ChatEngineMetadata)

Solo de salida. Información adicional sobre el motor de chat. Solo se aplica si solutionType es SOLUTION_TYPE_CHAT.

ChatEngineConfig

Configuraciones de un Chat Engine.

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

object (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.
allowCrossRegion

boolean

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 allowCrossRegion 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.

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.

Representación JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
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.
defaultLanguageCode

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.
timeZone

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.

SearchEngineConfig

Configuraciones de un buscador.

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

enum (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.
searchAddOns[]

enum (SearchAddOn)

El complemento que habilita este buscador.

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.

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.

MediaRecommendationEngineConfig

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. El tipo de motor. Por ejemplo: recommended-for-you.

Este campo, junto con optimizationObjective, 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.
optimizationObjective

string

El objetivo de optimización. Por ejemplo: cvr.

Este campo, junto con optimizationObjective, 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
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nombre y valor del umbral personalizado para cvr optimizationObjective. En el caso de targetField 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 targetField 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).
trainingState

enum (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 engines.create es TRAINING. El valor predeterminado del método engines.patch es mantener el estado igual que antes.
engineFeaturesConfig

object (EngineFeaturesConfig)

Opcional. Configuración de funciones adicionales del motor.

OptimizationObjectiveConfig

Umbral personalizado para el campo cvr optimizationObjective.

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

string

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

number

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

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.

EngineFeaturesConfig

Más configuraciones 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. 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:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

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

RecommendedForYouFeatureConfig

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

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

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.

MostPopularFeatureConfig

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

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

string (int64 format)

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.

ChatEngineMetadata

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

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

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.

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

string

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

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.

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.

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.

Métodos

create

 Crea un Engine.

delete

 Elimina un Engine.

get

 Obtiene un Engine.

list

 Lista todos los Engines asociados al proyecto.

patch

 Actualiza un Engine.

pause

 Pausa el entrenamiento de un buscador.

resume

 Reanuda el entrenamiento de un motor.

tune

 Ajusta un buscador.