Exportar e importar

Esta página descreve como exportar e importar aplicativos de agente e ferramentas individuais.

Exportação e importação de agentes

É possível exportar e importar aplicativos de agente:

  1. Abra o console do CX Agent Studio.
  2. Selecione o projeto. A lista de aplicativos de agente do projeto será mostrada.
  3. Clique no menu de contexto do aplicativo e selecione "Importar" ou "Exportar".

Arquivo de ambiente

Ao exportar um aplicativo de agente, um arquivo chamado environment.json é incluído no diretório raiz do arquivo baixado. Esse arquivo ajuda a gerenciar configurações específicas do ambiente para o aplicativo, como buckets do Cloud Storage, endpoints de serviço e URIs do repositório de dados.

O uso desse arquivo para exportações e importações tem as seguintes vantagens:

  • Portabilidade aprimorada:transfira aplicativos de agente entre diferentes projetos ou ambientes (por exemplo, do desenvolvimento para a produção) modificando um único arquivo.
  • Configuração centralizada:todas as principais dependências externas são listadas em um só lugar, simplificando o gerenciamento e oferecendo uma visão geral clara.
  • Erros reduzidos:minimiza o risco de erros em comparação com a edição manual de configurações em vários arquivos de recursos.
  • Compatível com automação:o formato JSON permite atualizar configurações de maneira programática usando scripts como parte de um pipeline de CI/CD.

Para atualizar configurações específicas do ambiente:

  1. Exportar:baixe o aplicativo de agente exportado e extraia-o.
  2. Modificar:abra o arquivo environment.json localizado no diretório raiz. Modifique os valores das dependências para corresponder às configurações do ambiente de destino.
  3. Importar:compacte todo o diretório, incluindo o arquivo environment.json modificado, em um novo arquivo zip. Importe esse novo arquivo para o ambiente de destino. O sistema aplica os valores atualizados de environment.json.

Detalhes do arquivo de ambiente

O arquivo environment.json funciona como um manifesto central para dependências externas que podem mudar entre diferentes ambientes (por exemplo, desenvolvimento, teste e produção).

Ao exportar um aplicativo de agente, o sistema identifica campos específicos do ambiente nos recursos do aplicativo. Em vez de codificar esses valores, o sistema os extrai e os coloca no arquivo environment.json. Os valores são organizados pelo tipo e nome do recurso. Nos arquivos de manifesto de recursos originais, esses valores extraídos são substituídos por uma variável de marcador, $env_var.

Ao importar o aplicativo de agente, o sistema lê o arquivo environment.json. Ele encontra os marcadores $env_var nos manifestos de recursos e os substitui pelos valores correspondentes do arquivo environment.json. Esse processo configura o aplicativo para o novo ambiente.

Os campos a seguir são gerenciados no arquivo environment.json:

  • ApiKeyConfig.key_name
  • ApiKeyConfig.api_key_secret_version
  • AudioRecordingConfig.gcs_bucket
  • BoostSpecs.data_stores
  • ConnectorTool.connection
  • DataStore.name
  • EngineSource.engine
  • FileSearchTool.file_corpus
  • OAuthConfig.client_secret_version
  • OAuthConfig.token_endpoint
  • OpenApiToolset.url (extraído automaticamente de OpenApiToolset.open_api_schema)
  • ServiceAccountAuthConfig.service_account
  • VertexAiRagRetrievalTool.RagResource.rag_corpus
  • VertexAiRagRetrievalTool.RagResource.rag_file_ids

Exportação e importação de ferramentas

É possível exportar e importar ferramentas individuais. Essa funcionalidade oferece duas novas opções no painel "Ferramenta": Importar e Exportar.

  • Exportar:baixe o conteúdo da ferramenta como um arquivo JSON para sua máquina local ou para o Cloud Storage.
  • Importar:use arquivos JSON locais ou arquivos JSON armazenados no Cloud Storage para criar novas ferramentas ou atualizar as atuais.

Exportar uma ferramenta

Para exportar uma ferramenta:

  1. Abra o console do CX Agent Studio e selecione o projeto e o agente.
  2. Abra o painel Ferramenta.
  3. Clique no menu de contexto da ferramenta que você quer exportar.
  4. Selecione Exportar.
  5. Na caixa de diálogo, escolha uma das seguintes opções:
    • Baixar:salva o arquivo JSON na sua máquina local.
    • Cloud Storage:salva o arquivo JSON em um URI do Cloud Storage especificado.

Importar uma ferramenta

Há dois fluxos de trabalho para importar uma ferramenta:

Importar para substituir

Use essa opção para modificar uma ferramenta atual. O arquivo JSON importado precisa corresponder ao mesmo tipo de ferramenta que a atual.

  1. Abra o console do CX Agent Studio e selecione o projeto e o agente.
  2. Abra o painel Ferramenta.
  3. Clique no menu de contexto da ferramenta que você quer atualizar.
  4. Selecione Importar para substituir.
  5. Na caixa de diálogo, escolha uma das seguintes opções:
    • Fazer upload do JSON:selecione um arquivo JSON na sua máquina local.
    • Cloud Storage:insira o URI de um arquivo JSON no Cloud Storage.

Importar como novo

Use essa opção para criar uma nova ferramenta.

  1. Abra o console do CX Agent Studio e selecione o projeto e o agente.
  2. Abra o painel Criar ferramenta.
  3. Selecione Importar como novo.
  4. Na caixa de diálogo, escolha uma das seguintes opções:
    • Fazer upload do JSON:selecione um arquivo JSON na sua máquina local.
    • Cloud Storage:insira o URI de um arquivo JSON no Cloud Storage.