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)
  },
  "knowledgeGraphConfig": {
    object (KnowledgeGraphConfig)
  },
  "appType": enum (AppType),
  "disableAnalytics": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "cmekConfig": {
    object (CmekConfig)
  },
  "configurableBillingApproach": enum (ConfigurableBillingApproach),
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "observabilityConfig": {
    object (ObservabilityConfig)
  },
  "connectorTenantInfo": {
    string: string,
    ...
  },
  "agentGatewaySetting": {
    object (AgentGatewaySetting)
  },
  "marketplaceAgentVisibility": enum (MarketplaceAgentVisibility),
  "procurementContactEmails": [
    string
  ],
  "associatedAgentRegistry": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "similarDocumentsConfig": {
    object (SimilarDocumentsEngineConfig)
  },
  "chatEngineConfig": {
    object (ChatEngineConfig)
  },
  "searchEngineConfig": {
    object (SearchEngineConfig)
  },
  "mediaRecommendationEngineConfig": {
    object (MediaRecommendationEngineConfig)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "recommendationMetadata": {
    object (RecommendationMetadata)
  },
  "chatEngineMetadata": {
    object (ChatEngineMetadata)
  }
  // End of mutually exclusive fields.
}
Campos
name

string

Imutável. Identificador. O nome totalmente qualificado do recurso 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 mecanismo de recomendação 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.

Ao usar 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 de mercado de mecanismos é baseada em DataStore: o segmento de mercado no mecanismo precisa corresponder ao segmento de mercado do DataStore vinculado a ele.

commonConfig

object (CommonConfig)

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

knowledgeGraphConfig

object (KnowledgeGraphConfig)

Opcional. Configurações do Mapa de informações. Aplicável somente se solutionType for SOLUTION_TYPE_SEARCH.

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 segmento do setor ou tipo de solução atual.

disableAnalytics

boolean

Opcional. Se é necessário desativar a análise de pesquisas feitas nesse mecanismo.

features

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

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

  • *: todos os recursos, se estiverem presentes, todas as outras configurações de estado de recursos serão ignoradas.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
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.

observabilityConfig

object (ObservabilityConfig)

Opcional. Configuração de observabilidade para o mecanismo.

connectorTenantInfo

map (key: string, value: string)

Opcional. Mapeia um ID de conector (por exemplo, "hybrid-github", "shopify") para informações específicas do locatário necessárias para esse conector. A estrutura da string de informações do locatário depende do conector.

agentGatewaySetting

object (AgentGatewaySetting)

Opcional. A configuração do gateway do agente para o mecanismo.

marketplaceAgentVisibility

enum (MarketplaceAgentVisibility)

Opcional. A visibilidade dos agentes do marketplace na galeria de agentes.

procurementContactEmails[]

string

Opcional. Os e-mails dos contatos do departamento de compras.

associatedAgentRegistry

string

Apenas saída. O Agent Registry que contém os agentes, servidores MCP e ferramentas associados a esse mecanismo. Derivado do lado do servidor do registro do gateway de agente vinculado.

Especificações de configuração adicionais que definem o comportamento do mecanismo. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
similarDocumentsConfig

object (SimilarDocumentsEngineConfig)

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

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 do Media Engine. Aplicável apenas aos repositórios de dados com as categorias solutionType SOLUTION_TYPE_RECOMMENDATION e IndustryVertical.MEDIA.

Fim dos campos mutuamente exclusivos.
Metadados do mecanismo para monitorar o status dele. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
recommendationMetadata

object (RecommendationMetadata)

Apenas saída. Informações adicionais de um mecanismo de recomendação. Aplicável somente se solutionType for SOLUTION_TYPE_RECOMMENDATION.

chatEngineMetadata

object (ChatEngineMetadata)

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

Fim dos campos mutuamente exclusivos.

SimilarDocumentsEngineConfig

Esse tipo não tem campos.

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

ChatEngineConfig

Configurações para um mecanismo 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 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, America/New_York, Europe/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 de recursos 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.

Se o nível de assinatura necessário for "Pesquisa", os usuários com um nível de licença mais alto, como "Assistente", ainda poderão acessar o app independente associado a esse mecanismo.

O recurso de embasamento na Web só está disponível no app se estiver definido como SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.

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 o objetivo de otimização de CVR. 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 do 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
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "recommendedForYouConfig": {
    object (RecommendedForYouFeatureConfig)
  },
  "mostPopularConfig": {
    object (MostPopularFeatureConfig)
  }
  // End of mutually exclusive fields.
}
Campos
Configurações relacionadas a recursos aplicadas a um tipo específico de mecanismos de recomendação de mídia. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo, um dos campos será definido em uma resposta:
recommendedForYouConfig

object (RecommendedForYouFeatureConfig)

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

Fim dos campos mutuamente exclusivos.

RecommendedForYouFeatureConfig

Configurações de recursos adicionais para criar um mecanismo 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. No momento, 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 de "Mais populares".

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

string (int64 format)

A janela de tempo 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.

RecommendationMetadata

Informações adicionais de um mecanismo de recomendação.

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 veiculação do mecanismo: ACTIVE, NOT_ACTIVE.

dataState

enum (DataState)

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

O mecanismo não pode ser treinado se os dados estiverem no estado DATA_ERROR. O mecanismo pode ter o estado DATA_ERROR mesmo que o estado de veiculação seja ACTIVE: os mecanismos foram treinados com sucesso antes, mas não podem ser atualizados porque o mecanismo subjacente não tem mais dados suficientes para treinamento.

lastTuneTime

string (Timestamp format)

Apenas saída. O registro de data e hora em que a última música tocada com sucesso terminou. Aplicável somente a mecanismos de recomendação de mídia.

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

lastTrainTime

string (Timestamp format)

Apenas saída. O registro de data e hora em que o último treinamento bem-sucedido foi concluído. Aplicável somente a mecanismos de recomendação de mídia.

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

tuningOperation

string

Apenas saída. O ID da operação de ajuste mais recente associada ao motor. Aplicável somente a mecanismos de recomendação de mídia.

Caso presente, esse ID de operação pode ser usado para determinar se há algum ajuste em andamento para esse motor. Para verificar o status da operação, envie a solicitação "operations.get" com esse ID no formato de recurso do mecanismo. Se nenhuma afinação tiver sido feita neste motor, a corda está vazia.

ServingState

O estado de funcionamento do mecanismo de recomendação.

Tipos enumerados
SERVING_STATE_UNSPECIFIED Estado de serviço não especificado.
INACTIVE O motor não está funcionando.
ACTIVE O motor está em funcionamento e pode ser consultado.
TUNED O mecanismo é treinado com hiperparâmetros ajustados e pode ser consultado.

DataState

Descreve se este mecanismo possui dados de treinamento suficientes para ser treinado continuamente.

Tipos enumerados
DATA_STATE_UNSPECIFIED Valor padrão não especificado. Nunca deve ser definido explicitamente.
DATA_OK O mecanismo tem dados de treinamento suficientes.
DATA_ERROR O motor não possui dados de treinamento suficientes. As mensagens de erro podem ser consultadas pelo Stackdriver.

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.

KnowledgeGraphConfig

Mensagem de configuração do Mapa de informações.

Representação JSON
{
  "enableCloudKnowledgeGraph": boolean,
  "cloudKnowledgeGraphTypes": [
    string
  ],
  "enablePrivateKnowledgeGraph": boolean,
  "privateKnowledgeGraphTypes": [
    string
  ],
  "featureConfig": {
    object (FeatureConfig)
  }
}
Campos
enableCloudKnowledgeGraph

boolean

Define se o Mapa de Informações do Cloud será ativado para o mecanismo.

O padrão é "false" se não for especificado.

cloudKnowledgeGraphTypes[]

string

Especifique os tipos de entidade a serem compatíveis.

enablePrivateKnowledgeGraph

boolean

Se o Mapa de informações particulares deve ser ativado para o mecanismo.

O padrão é "false" se não for especificado.

privateKnowledgeGraphTypes[]

string

Especifique os tipos de entidade a serem compatíveis.

featureConfig

object (FeatureConfig)

Opcional. Configuração de recursos para o Mapa de informações.

FeatureConfig

Configuração de recursos para o Mapa de informações.

Representação JSON
{
  "disablePrivateKgQueryUnderstanding": boolean,
  "disablePrivateKgEnrichment": boolean,
  "disablePrivateKgAutoComplete": boolean,
  "disablePrivateKgQueryUiChips": boolean
}
Campos
disablePrivateKgQueryUnderstanding

boolean

Se a compreensão de consultas particulares do KG para o mecanismo deve ser desativada.

O padrão é "false" se não for especificado.

disablePrivateKgEnrichment

boolean

Se a opção de desativar o enriquecimento do KG privado para o mecanismo.

O padrão é "false" se não for especificado.

disablePrivateKgAutoComplete

boolean

Se a opção de preenchimento automático do KG particular para o mecanismo deve ser desativada.

O padrão é "false" se não for especificado.

disablePrivateKgQueryUiChips

boolean

Se os ícones da interface de consulta do KG particular devem ser desativados.

O padrão é "false" se não for especificado.

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 está 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 a abordagem de faturamento não configurável do Spark e de outros produtos. 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.

AgentGatewaySetting

Configuração do Gateway de Agente, que pode ser anexada a recursos do Gemini Enterprise para controle de saída de agentes do Gemini Enterprise para agentes e ferramentas fora do Gemini Enterprise.

Representação JSON
{
  "defaultEgressAgentGateway": {
    object (AgentGatewayReference)
  }
}
Campos
defaultEgressAgentGateway

object (AgentGatewayReference)

Opcional. O gateway de agente de saída padrão a ser usado quando essa configuração é aplicada a um recurso do Gemini Enterprise.

O modo de implantação precisa ser GOOGLE_MANAGED, e o caminho de acesso governado precisa ser AGENT_TO_ANYWHERE.

AgentGatewayReference

Referência a um recurso de Gateway de Agente.

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

string

Obrigatório. Imutável. O nome do recurso do gateway do agente.

Formato esperado: projects/{projectNumber}/locations/{location}/agentGateways/{agent_gateway}.

MarketplaceAgentVisibility

Representa quais agentes do marketplace estão visíveis para qualquer usuário na galeria de agentes.

Tipos enumerados
MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED O valor padrão é MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED.
SHOW_AVAILABLE_AGENTS_ONLY Somente os agentes disponíveis para uso pelo usuário ficam visíveis.
SHOW_AGENTS_ALREADY_INTEGRATED Mostrar agentes do Marketplace a que o usuário ainda não tem acesso, mas que estão integrados ao mecanismo. Esse nível também inclui todos os agentes visíveis com SHOW_AVAILABLE_AGENTS_ONLY.
SHOW_AGENTS_ALREADY_PURCHASED Mostra todos os agentes visíveis com SHOW_AGENTS_ALREADY_INTEGRATED, além dos agentes já comprados pelo projeto/organização, mesmo que não estejam integrados ao mecanismo no momento.
SHOW_ALL_AGENTS Todos os agentes no marketplace ficam visíveis, independente do status de acesso ou compra. Esse nível abrange todos os agentes mostrados nos níveis anteriores.

Métodos

create

Cria um Engine.

delete

Exclui um Engine.

get

Recebe um Engine.

getCompletionConfig

Recebe um CompletionConfig

getIamPolicy

Recebe a política de controle de acesso do IAM para um Engine.

getWorkspaceSettings

Recebe as configurações do Workspace para o usuário final.

list

Lista todos os Engines associados ao projeto.

patch

Atualiza um Engine.

pause

Pausa o treinamento de um Engine.

resume

Retoma o treinamento de um Engine atual.

setIamPolicy

Define a política de controle de acesso do IAM para um Engine.

tune

Ajusta um Engine atual.

updateCompletionConfig

Atualiza os CompletionConfigs.