REST Resource: projects.locations.collections.engines

Recurso: motor de pesquisa

Metadados que descrevem os parâmetros de preparação e publicaçã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),
    ...
  },
  "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

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

Este campo tem de ser uma string codificada em UTF-8 com um limite de comprimento de 1024 carateres.

Formato: o projects/{project}/locations/{location}/collections/{collection}/engines/{engine} do motor deve ter entre 1 e 63 carateres, e os carateres válidos são /[a-z0-9][a-z0-9-_]*/. Caso contrário, é devolvido um erro INVALID_ARGUMENT.
displayName

string

Obrigatório. O nome a apresentar do motor. Deve ser legível. String codificada em UTF-8 com um limite de 1024 carateres.
createTime

string (Timestamp format)

Apenas saída. Data/hora de criação do motor de recomendações.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". 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. Data/hora da última atualização do motor de recomendações.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
dataStoreIds[]

string

Opcional. Os arquivos de dados associados a este motor.

Para os tipos de motores SOLUTION_TYPE_SEARCH e SOLUTION_TYPE_RECOMMENDATION, só podem ser associados a, no máximo, um arquivo de dados.

Se solutionType for SOLUTION_TYPE_CHAT, é possível associar vários DataStores no mesmo Collection aqui.

Tenha em atenção que, quando usado em CreateEngineRequest, tem de ser fornecido um ID do DataStore, uma vez que o sistema o usa para as inicializações necessárias.
solutionType

enum (SolutionType)

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

enum (IndustryVertical)

Opcional. O vertical da indústria em que o motor se regista. A restrição do vertical da indústria de motores baseia-se no seguinte: o vertical no motor tem de corresponder ao vertical do arquivo de dados associado ao motor.DataStore
commonConfig

object (CommonConfig)

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

enum (AppType)

Opcional. Imutável. Este é o tipo de aplicação que este recurso do motor representa. NOTA: este é um novo conceito independente do vertical da indústria ou do tipo de solução existentes.
disableAnalytics

boolean

Opcional. Se as estatísticas devem ser desativadas para as pesquisas realizadas neste motor.
features

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

Opcional. Configuração de funcionalidades para o motor ativar ou desativar funcionalidades. Chaves suportadas:

  • *: todas as funcionalidades, se estiver presente, todas as outras definições de estado das funcionalidades sã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
configurableBillingApproach

enum (ConfigurableBillingApproach)

Opcional. Configuração para uma abordagem de faturação configurável.
Campo de união engine_config. Especificações de configuração adicionais que definem o comportamento do motor. engine_config só pode ser uma das seguintes opções:
similarDocumentsConfig

object (SimilarDocumentsEngineConfig)

Especificações de configuração adicionais para um motor similar-items.
chatEngineConfig

object (ChatEngineConfig)

Configurações do motor do Chat. Aplicável apenas se solutionType for SOLUTION_TYPE_CHAT.
searchEngineConfig

object (SearchEngineConfig)

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

object (MediaRecommendationEngineConfig)

Configurações do motor de multimédia. Aplicável apenas nas lojas de dados com o setor vertical solutionType SOLUTION_TYPE_RECOMMENDATION e IndustryVertical.MEDIA.
Campo de união engine_metadata. Metadados do motor para monitorizar o estado do motor. engine_metadata só pode ser uma das seguintes opções:
recommendationMetadata

object (RecommendationMetadata)

Apenas saída. Informações adicionais de um motor de recomendações. Aplicável apenas se solutionType for SOLUTION_TYPE_RECOMMENDATION.
chatEngineMetadata

object (ChatEngineMetadata)

Apenas saída. Informações adicionais do motor de chat. Aplicável apenas se solutionType for SOLUTION_TYPE_CHAT.

SimilarDocumentsEngineConfig

Este tipo não tem campos.

Especificações de configuração adicionais para um motor similar-items.

ChatEngineConfig

Configurações para um motor de chat.

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 este motor.

Tenha em atenção que estas configurações são consumidas uma vez e transmitidas ao serviço Dialogflow. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor.
allowCrossRegion

boolean

Opcional. Se a flag estiver definida como verdadeira, permitimos que o agente e o motor estejam em localizações diferentes. Caso contrário, o agente e o motor têm de estar na mesma localização. A sinalização está predefinida como false.

Tenha em atenção que os allowCrossRegion são consumidos uma vez e transmitidos ao EngineService.CreateEngine. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor.

AgentCreationConfig

Configurações para gerar um agente do Dialogflow.

Tenha em atenção que estas configurações são consumidas uma vez e transmitidas ao serviço Dialogflow. Isto significa que não podem ser obtidos através da API EngineService.GetEngine ou EngineService.ListEngines após a criação do motor.

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 GML do conetor de conhecimentos e para a pesquisa de conhecimentos.
defaultLanguageCode

string

Obrigatório. O idioma predefinido do agente como uma etiqueta de idioma. Consulte o artigo Suporte de idiomas para ver uma lista dos códigos de idiomas atualmente suportados.
timeZone

string

Obrigatório. O fuso horário do agente da base de dados de fusos horários, por exemplo: America/New_York, Europe/Paris.
location

string

Localização do agente para a criação de agentes. Valores suportados: global/us/eu. Se não for fornecido, o motor us cria o agente usando us-central-1 por predefinição; o motor eu cria o agente usando eu-west-1 por predefinição.

SearchEngineConfig

Configurações de um motor de pesquisa.

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

enum (SearchTier)

O nível da funcionalidade de pesquisa deste motor.

Os diferentes níveis podem ter preços diferentes. Para saber mais, consulte a documentação de preços.

A predefinição é SearchTier.SEARCH_TIER_STANDARD se não for especificado.
searchAddOns[]

enum (SearchAddOn)

O suplemento que este motor de pesquisa ativa.

SearchTier

Níveis de funcionalidades de pesquisa. Os diferentes níveis podem ter preços diferentes. Para saber mais, consulte a documentação de preços.

Enumerações
SEARCH_TIER_UNSPECIFIED Valor predefinido quando o enum não está especificado. Esta opção é inválida para utilização.
SEARCH_TIER_STANDARD Nível Standard.
SEARCH_TIER_ENTERPRISE Nível Enterprise.

SearchAddOn

Suplemento que oferece funcionalidades adicionais para a pesquisa.

Enumerações
SEARCH_ADD_ON_UNSPECIFIED Valor predefinido quando o enum não está especificado. Esta opção é inválida para utilização.
SEARCH_ADD_ON_LLM Suplemento de modelo de linguagem (conteúdo extenso).

MediaRecommendationEngineConfig

Especificações de configuração adicionais para um motor de recomendações de conteúdo multimé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.

Este campo, juntamente com optimizationObjective, descreve os metadados do motor a usar para controlar a preparação e a publicação do motor.

Valores atualmente suportados: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.
optimizationObjective

string

O objetivo de otimização. Por exemplo: cvr.

Este campo, juntamente com optimizationObjective, descreve os metadados do motor a usar para controlar a preparação e a publicação do motor.

Valores atualmente suportados: ctr, cvr.

Se não for especificado, escolhemos o valor predefinido com base no tipo de motor. A predefiniçã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 tem de ser um valor inteiro que indica o tempo de progresso do conteúdo multimédia em segundos entre (0, 86400] (exclui 0, inclui 86400) (por exemplo, 90). Para targetField watch-percentage, o target_field_value tem de ser um valor flutuante válido entre (0, 1,0] (exclui 0, inclui 1,0) (por exemplo, 0,5).
trainingState

enum (TrainingState)

O estado de preparação em que o motor se encontra (por exemplo, TRAINING ou PAUSED).

Uma vez que parte do custo de execução do serviço é a frequência do treino, isto pode ser usado para determinar quando treinar o motor de modo a controlar o custo. Se não for especificado: o valor predefinido para o método engines.create é TRAINING. O valor predefinido do método engines.patch é manter o estado igual ao anterior.
engineFeaturesConfig

object (EngineFeaturesConfig)

Opcional. Configuração de funcionalidades adicionais do motor

OptimizationObjectiveConfig

Limite personalizado para optimizationObjective cvr.

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

string

Obrigatório. O nome do campo a segmentar. Valores atualmente suportados: watch-percentage, watch-time.
targetFieldValueFloat

number

Obrigatório. O limite a aplicar ao alvo (por exemplo, 0,5).

TrainingState

O estado de preparação do motor.

Enumerações
TRAINING_STATE_UNSPECIFIED Estado de preparação não especificado.
PAUSED A preparação do motor está pausada.
TRAINING O motor está a ser preparado.

EngineFeaturesConfig

Mais configurações de funcionalidades do tipo de motor 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 com funcionalidades aplicadas a um tipo específico de motores de recomendações de multimédia. type_dedicated_config só pode ser uma das seguintes opções:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

Recomendado para a configuração de funcionalidades do motor.

RecommendedForYouFeatureConfig

Configurações de funcionalidades adicionais para criar um motor do tipo recommended-for-you.

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

string

O tipo de evento com o qual o motor é consultado no momento da previsão. Se estiver definido como generic, apenas view-item, media-play e media-complete são usados como context-event na preparação do motor. Se estiver definido como view-home-page, view-home-page também é usado como context-events, além de view-item, media-play e media-complete. Atualmente, suportado para o motor recommended-for-you. Valores atualmente suportados: view-home-page, generic.

MostPopularFeatureConfig

Configurações de funcionalidades necessárias para criar um motor Mais popular.

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

string (int64 format)

O período durante o qual o motor é consultado no momento da preparação e da previsão. Apenas números inteiros positivos. O valor é traduzido para os últimos X dias de eventos. Atualmente, é necessário para o motor most-popular-items.

RecommendationMetadata

Informações adicionais de um motor de recomendações.

Representação JSON 
{
  "servingState": enum (ServingState),
  "dataState": enum (DataState),
  "lastTuneTime": string,
  "lastTrainTime": string,
  "tuningOperation": string
}
Campos
servingState

enum (ServingState)

Apenas saída. O estado de publicação do motor: ACTIVE, NOT_ACTIVE.
dataState

enum (DataState)

Apenas saída. O estado dos requisitos de dados para este motor: DATA_OK e DATA_ERROR.

Não é possível treinar o motor se os dados estiverem no estado DATA_ERROR. O motor pode ter o estado DATA_ERROR, mesmo que o estado de publicação seja ACTIVE: os motores foram preparados com êxito anteriormente, mas não podem ser atualizados porque o motor subjacente já não tem dados suficientes para a preparação.
lastTuneTime

string (Timestamp format)

Apenas saída. A data/hora em que a otimização bem-sucedida mais recente terminou. Aplicável apenas em motores de recomendações de multimédia.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastTrainTime

string (Timestamp format)

Apenas saída. A data/hora em que a preparação de modelo mais recente bem-sucedida terminou. Aplicável apenas em motores de recomendações de multimédia.

Usa RFC 3339, em que o resultado gerado é sempre normalizado em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Também são aceites desvios diferentes de "Z". Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
tuningOperation

string

Apenas saída. O ID da operação de ajuste mais recente associado ao motor. Aplicável apenas em motores de recomendações de multimédia.

Se estiver presente, este ID da operação pode ser usado para determinar se existe uma otimização em curso para este motor. Para verificar o estado da operação, envie o pedido operations.get com este ID da operação no formato do recurso do motor. Se não tiver sido feita nenhuma otimização para este motor, a string está vazia.

ServingState

O estado de publicação do motor de recomendações.

Enumerações
SERVING_STATE_UNSPECIFIED Estado de publicação não especificado.
INACTIVE O motor não está a publicar anúncios.
ACTIVE O motor está a publicar anúncios e pode ser consultado.
TUNED O motor é preparado com hiperparâmetros ajustados e pode ser consultado.

DataState

Descreve se este motor tem dados de preparação suficientes para ser preparado continuamente.

Enumerações
DATA_STATE_UNSPECIFIED Valor predefinido não especificado, nunca deve ser definido explicitamente.
DATA_OK O motor tem dados de preparação suficientes.
DATA_ERROR O motor não tem dados de preparação suficientes. As mensagens de erro podem ser consultadas através do Stackdriver.

ChatEngineMetadata

Informações adicionais de um motor de chat. Os campos nesta mensagem são apenas de saída.

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

string

O nome do recurso de um agente do Dialogflow ao qual este motor do Chat se refere.

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

CommonConfig

Configurações comuns para um motor.

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

string

O nome da empresa, da empresa ou da entidade associada ao motor. A definição desta opção pode ajudar a melhorar as funcionalidades relacionadas com o MDG.

AppType

A app do motor.

Enumerações
APP_TYPE_UNSPECIFIED Todas as apps não especificadas.
APP_TYPE_INTRANET Tipo de app para a pesquisa de intranet e o Agentspace.

FeatureState

O estado da funcionalidade para o motor.

Enumerações
FEATURE_STATE_UNSPECIFIED O estado da funcionalidade não está especificado.
FEATURE_STATE_ON A funcionalidade está ativada para ser acessível.
FEATURE_STATE_OFF A funcionalidade está desativada para ficar inacessível.

ConfigurableBillingApproach

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

Enumerações
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED Valor predefinido. Para o Spark e a abordagem de faturação não configurável não Spark. Modelo de preços geral.
CONFIGURABLE_BILLING_APPROACH_ENABLED A abordagem de faturação segue as configurações especificadas pelo cliente.

Métodos

create

 Cria um Engine.

delete

 Elimina um Engine.

get

 Obtém um Engine.

getCompletionConfig

 Recebe um CompletionConfig

getWorkspaceSettings

 Obtenha as definições do Workspace para o utilizador final.

list

 Apresenta todos os Engines associados ao projeto.

patch

 Atualiza um Engine

pause

 Pausa a preparação de um motor existente.

resume

 Retoma a preparação de um motor existente.

tune

 Ajusta um motor existente.

updateCompletionConfig

 Atualiza os CompletionConfigs.