REST Resource: projects.locations.collections.engines

Recurso: Engine

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

Representação 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),
    ...
  },
  "cmekConfig": {
    object (CmekConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },

  // 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

Imutável. Identificador. O nome do recurso totalmente qualificado do mecanismo.

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

Formato: o mecanismo projects/{project}/locations/{location}/collections/{collection}/engines/{engine} precisa ter de 1 a 63 caracteres, e os caracteres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, um erro INVALID_ARGUMENT será retornado.
displayName

string

Obrigatório. O nome de exibição do mecanismo. Precisa ser legível. String codificada em UTF-8 com limite de 1.024 caracteres.
createTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do Recommendation Engine.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Opcional. Os repositórios de dados associados a esse mecanismo.

Para mecanismos do tipo SOLUTION_TYPE_SEARCH e SOLUTION_TYPE_RECOMMENDATION, é possível associar apenas um repositório de dados.

Se solutionType for SOLUTION_TYPE_CHAT, vários DataStores no mesmo Collection poderão ser associados aqui.

Quando usado em CreateEngineRequest, um ID do DataStore precisa ser fornecido, já que o sistema o usa para inicializações necessárias.
solutionType

enum (SolutionType)

Obrigatório. As soluções do mecanismo.
industryVertical

enum (IndustryVertical)

Opcional. O segmento do setor que o mecanismo registra. A restrição do segmento do setor de mecanismos é baseada em DataStore: o segmento do setor no mecanismo precisa corresponder ao segmento do setor do DataStore vinculado a ele.
commonConfig

object (CommonConfig)

Especificação de configuração comum que especifica os metadados do mecanismo.
appType

enum (AppType)

Opcional. Imutável. Este é o tipo de aplicativo que esse recurso do mecanismo representa. OBSERVAÇÃO: esse é um novo conceito independente do setor vertical ou tipo de solução atual.
disableAnalytics

boolean

Opcional. Se os dados de análise das pesquisas feitas nesse mecanismo serão desativados.
features

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

Opcional. Configuração de recursos para o mecanismo ativar ou desativar recursos. Chaves compatíveis:

  • *: todos os recursos, se estiverem presentes, todas as outras configurações de estado de recurso serão ignoradas.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
cmekConfig

object (CmekConfig)

Apenas saída. Informações relacionadas à CMEK para o mecanismo.
configurableBillingApproach

enum (ConfigurableBillingApproach)

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

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

Opcional. Mapeia um nome de modelo para a configuração específica dele para esse mecanismo. Isso permite que os usuários administradores ativem/desativem modelos individuais. Isso armazena apenas modelos cujos estados são substituídos pelo administrador.

Quando o estado não é especificado ou modelConfigs está vazio para esse modelo, o sistema decide se ele deve estar disponível ou não com base na configuração padrão. Por exemplo, um modelo de prévia precisa ser desativado por padrão se o administrador não tiver escolhido ativá-lo.
Campo de união engine_config. Especificações de configuração adicionais que definem o comportamento do mecanismo. engine_config pode ser apenas de um dos tipos a seguir:
chatEngineConfig

object (ChatEngineConfig)

Configurações do Chat Engine. Aplicável somente se solutionType for SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

Configurações do mecanismo de pesquisa. Aplicável somente se solutionType for SOLUTION_TYPE_SEARCH.
mediaRecommendationEngineConfig

object (MediaRecommendationEngineConfig)

Configurações para o Media Engine. Aplicável apenas aos repositórios de dados com as categorias solutionType SOLUTION_TYPE_RECOMMENDATION e IndustryVertical.MEDIA.
Campo de união engine_metadata. Metadados do mecanismo para monitorar o status dele. engine_metadata pode ser apenas de um dos tipos a seguir:
chatEngineMetadata

object (ChatEngineMetadata)

Apenas saída. Outras informações sobre o Chat Engine. Aplicável somente se solutionType for SOLUTION_TYPE_CHAT.

ChatEngineConfig

Configurações para um Chat Engine.

Representação JSON 
{
  "agentCreationConfig": {
    object (AgentCreationConfig)
  },
  "dialogflowAgentToLink": string,
  "allowCrossRegion": boolean
}
Campos
agentCreationConfig

object (AgentCreationConfig)

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

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

boolean

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

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

AgentCreationConfig

Configurações para gerar um agente do Dialogflow.

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

Representação JSON 
{
  "business": string,
  "defaultLanguageCode": string,
  "timeZone": string,
  "location": string
}
Campos
business

string

Nome da empresa, organização ou outra entidade que o agente representa. Usado para o comando do LLM do conector de conhecimento e para a pesquisa de conhecimento.
defaultLanguageCode

string

Obrigatório. O idioma padrão do agente como uma tag de idioma. Para uma lista dos códigos de idioma compatíveis atualmente, consulte o Suporte de idioma.
timeZone

string

Obrigatório. O fuso horário do agente do banco de dados de fuso horário, por exemplo, América/Nova_York, Europa/Paris.
location

string

Local do agente para criação de agentes. Valores aceitos: global/us/eu. Se não for fornecido, o mecanismo dos EUA vai criar o agente usando "us-central-1" por padrão, e o mecanismo da UE vai criar o agente usando "eu-west-1" por padrão.

SearchEngineConfig

Configurações para um mecanismo de pesquisa.

Representação JSON 
{
  "searchTier": enum (SearchTier),
  "requiredSubscriptionTier": enum (SubscriptionTier),
  "searchAddOns": [
    enum (SearchAddOn)
  ]
}
Campos
searchTier

enum (SearchTier)

O nível do recurso de pesquisa deste mecanismo.

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

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

enum (SubscriptionTier)

Opcional. O nível de assinatura necessário deste mecanismo.

Não é possível modificá-los depois da criação do mecanismo. Se o nível de assinatura necessário for "Pesquisa", o usuário com um nível de licença mais alto, como "Assistente", ainda poderá acessar o app independente associado a esse mecanismo.
searchAddOns[]

enum (SearchAddOn)

O complemento que esse mecanismo de pesquisa ativa.

SearchTier

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

Tipos enumerados
SEARCH_TIER_UNSPECIFIED Valor padrão quando a enumeração não é especificada. Isso é inválido para uso.
SEARCH_TIER_STANDARD Nível Standard.
SEARCH_TIER_ENTERPRISE Nível Enterprise.

SearchAddOn

Complemento que oferece mais funcionalidades para a pesquisa.

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

MediaRecommendationEngineConfig

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

Representação JSON 
{
  "type": string,
  "optimizationObjective": string,
  "optimizationObjectiveConfig": {
    object (OptimizationObjectiveConfig)
  },
  "trainingState": enum (TrainingState),
  "engineFeaturesConfig": {
    object (EngineFeaturesConfig)
  }
}
Campos
type

string

Obrigatório. O tipo de motor. Por exemplo, recommended-for-you.

Esse campo, junto com optimizationObjective, descreve os metadados do mecanismo a serem usados para controlar o treinamento e a veiculação do mecanismo.

Valores aceitos no momento: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
optimizationObjective

string

O objetivo da otimização, por exemplo, cvr.

Esse campo, junto com optimizationObjective, descreve os metadados do mecanismo a serem usados para controlar o treinamento e a veiculação do mecanismo.

Valores aceitos no momento: ctr, cvr.

Se não for especificado, vamos escolher o padrão com base no tipo de mecanismo. O padrão depende do tipo de recomendação:

recommended-for-you => ctr

others-you-may-like => ctr
optimizationObjectiveConfig

object (OptimizationObjectiveConfig)

Nome e valor do limite personalizado para cvr optimizationObjective. Para targetField watch-time, target_field_value precisa ser um valor inteiro que indica o tempo de progresso da mídia em segundos entre (0, 86400] (exclui 0, inclui 86400). Por exemplo, 90). Para targetField watch-percentage, o target_field_value precisa ser um valor de ponto flutuante válido entre (0, 1.0] (exclui 0, inclui 1.0) (por exemplo, 0,5).
trainingState

enum (TrainingState)

O estado de treinamento em que o mecanismo está (por exemplo, TRAINING ou PAUSED).

Como parte do custo de execução do serviço é a frequência do treinamento, isso pode ser usado para determinar quando treinar o mecanismo e controlar o custo. Se não for especificado, o valor padrão para o método engines.create será TRAINING. O valor padrão do método engines.patch é manter o estado igual ao anterior.
engineFeaturesConfig

object (EngineFeaturesConfig)

Opcional. Configuração de recursos adicionais do mecanismo.

OptimizationObjectiveConfig

Limite personalizado para cvr optimizationObjective.

Representação JSON 
{
  "targetField": string,
  "targetFieldValueFloat": number
}
Campos
targetField

string

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

number

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

TrainingState

O estado de treinamento do mecanismo.

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

EngineFeaturesConfig

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

Representação 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ão type_dedicated_config. Configurações relacionadas a recursos aplicadas a um tipo específico de mecanismos de recomendação de mídia. type_dedicated_config pode ser apenas de um dos tipos a seguir:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

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

RecommendedForYouFeatureConfig

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

Representação JSON 
{
  "contextEventType": string
}
Campos
contextEventType

string

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

MostPopularFeatureConfig

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

Representação JSON 
{
  "timeWindowDays": string
}
Campos
timeWindowDays

string (int64 format)

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

ChatEngineMetadata

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

Representação JSON 
{
  "dialogflowAgent": string
}
Campos
dialogflowAgent

string

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

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

CommonConfig

Configurações comuns para um Engine.

Representação JSON 
{
  "companyName": string
}
Campos
companyName

string

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

AppType

O app do mecanismo.

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

FeatureState

O estado do recurso para o mecanismo.

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

ConfigurableBillingApproach

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

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

ModelState

O status do modelo para o mecanismo.

Tipos enumerados
MODEL_STATE_UNSPECIFIED O estado do modelo não foi especificado.
MODEL_ENABLED O modelo foi ativado pelo administrador.
MODEL_DISABLED O modelo foi desativado pelo administrador.

Métodos

create

 Cria uma Engine.

delete

 Exclui um Engine.

get

 Recebe um Engine.

list

 Lista todos os Engines associados ao projeto.

patch

 Atualiza um Engine.