Instalando a extensão para o Visual Studio Code

watsonx Code Assistant

Crie uma chave de API e adicione a extensão " watsonx Code Assistant ao seu editor " Visual Studio Code da Microsoft.

Compatibilidade

A extensão é compatível com Visual Studio Code 1.101 e posterior, usando a versão Node.js 22.15 ou posterior.

Para verificar sua versão Node.js em Visual Studio Code, clique no menu Code (Código ) e selecione About Visual Studio Code. Certifique-se de que Node.js seja a versão 22.15 ou posterior.

Não há suporte para a instalação da extensão em um contêiner de desenvolvimento.

Sistemas operacionais:

  • macOS
  • Windows 11
  • Fedora Linux 41
  • Red Hat Enterprise Linux 8
  • Ubuntu 20.04

Criar uma chave de API em IBM Cloud

Em vez de um nome de usuário e senha, cada desenvolvedor usa uma chave de API pessoal para fazer login.

Para criar uma chave API:

  1. Faça login em IBM Cloud API Keys.

    Certifique-se de que esteja usando a conta IBM Cloud na qual a instância de watsonx Code Assistant da sua organização está provisionada.

  2. Clique em Criar.

  3. Digite " IBM watsonx Code Assistant API key como o nome de sua chave de API. Opcionalmente, insira uma descrição.

  4. Clique em Criar.

  5. Clique em Download ou Copiar e armazene a chave da API em um local seguro.

    A chave fica disponível por apenas 296 segundos. Guarde-o onde você possa encontrá-lo mais tarde.

Instalar a extensão

Escolha a instalação para o plano que você está usando.

Descrições dos planos
Plano Descrição Nome da extensão Suporte ao idioma de exibição
Plano Trial Avaliação limitada e sem custo com bate-papo de IA generativa integrado para código. watsonx Code Assistant Inglês (en), japonês (ja), coreano (ko)
Plano Essentials IA generativa integrada para sugestões de código, explicações de código, documentação de código e testes de unidade. watsonx Code Assistant Inglês (en), japonês (ja), coreano (ko)
Plano Standard Todos os recursos do plano Essentials, além dos recursos de modernização do Java empresarial, explicação aprimorada do código, geração aprimorada de testes unitários e geração aumentada de recuperação (RAG).

Para a instalação do plano Standard, duas entradas aparecem em seu painel Visual Studio Code Extensions, uma para watsonx Code Assistant e outra para watsonx Code Assistant for Enterprise Java Applications. As duas extensões são dependências para essa instalação. É necessária a versão 1.6.2 ou posterior de watsonx Code Assistant e a versão 1.1.0 ou posterior de watsonx Code Assistant for Enterprise Java Applications.		 watsonx Code Assistant for Enterprise Java Applications Somente em inglês (en)

Para obter detalhes completos do plano, consulte:

No Visual Studio Marketplace

Para instalar a partir do Visual Studio Marketplace:

  1. Escolha a instalação para o plano que você está usando.

  2. Clique em Install (Instalar ) na página do Marketplace.

  3. No Visual Studio Code, clique em Install (Instalar ) na extensão.

Do editor do site Visual Studio Code

Para instalar a partir do editor Visual Studio Code:

  1. Em seu editor de Visual Studio Code, clique no ícone Extensões.

  2. Escolha a instalação para o plano que você está usando:

    • Plano Trial Plano Essentials Para instalar os planos Trial e Essentials, procure por ' watsonx Code Assistant.
    • Plano padrão Para instalar o plano padrão, pesquise watsonx Code Assistant for Enterprise Java Applications.

  3. Selecione a extensão de que você precisa e clique em Install (Instalar ).

Abra a extensão

Para abrir watsonx Code Assistant:

  1. Clique no ícone watsonx Code Assistant watsonx Code Assistant ícone.

  2. Clique em Log in with your API key (Fazer login com sua chave de API) e insira sua chave de API IBM watsonx Code Assistant.

    Se sua conta estiver associada a mais de um data center IBM Cloud, escolha também o local.

Configure seu ambiente Java corporativo

Plano Standard Se você estiver usando o plano Standard e quiser trabalhar com aplicativos Java corporativos, precisará configurar seu ambiente. Para obter mais informações, consulte Configuração de seu ambiente Java corporativo.

Atualizar as configurações de proxy do site HTTP

Se a sua organização usa um servidor proxy HTTP, é necessário atualizar as configurações do Visual Studio Code para que ele possa se conectar corretamente. Você pode receber erros de console quando tentar se conectar e essa configuração estiver ausente.

  1. Abra a configuração http.proxy em Visual Studio Code settings.
  2. Digite o endereço URL de seu servidor proxy HTTP no formato https://proxy_server:port. Talvez você precise incluir informações de autenticação, como http://user:pass@proxy_server:port.

Configuração da verificação para certificados personalizados

Se o servidor proxy usar certificados personalizados, você precisará configurar a verificação para Visual Studio Code. Siga estas etapas:

Para exportar o certificado SSL do servidor:

  1. Use Google Chrome para abrir sua instância watsonx Code Assistant em IBM Cloud.

  2. Clique no ícone Exibir informações do site ao lado do endereço da Web no navegador.

  3. Clique em Connection is secure (A conexão é segura ) e, em seguida, clique em Certificate is valid (O certificado é válido ) para abrir o Certificate Viewer (Visualizador de certificados).

  4. Clique em Details (Detalhes ), selecione o certificado do proxy e clique em Export (Exportar ).

Para configurar para MacOS:

  1. Use o Spotlight para procurar e abrir o Keychain Access.

  2. Clique em System (Sistema ) e, em seguida, na guia Certificates (Certificados ).

  3. Arraste o arquivo de certificado para a guia Certificados.

  4. Clique com o botão direito do mouse no certificado e clique em Obter informações.

  5. Na seção Trust (Confiança), defina When using this certificate (Ao usar este certificado) como Always Trust.

  6. Reinicie a extensão para aplicar as alterações. Você deve conseguir fazer login usando sua chave de API.

Para configurar para o Windows:

  1. Abra o Microsoft Management Console.

  2. Abra Certificados (Computador local) > Autoridades de certificação raiz confiáveis > Certificados.

  3. Clique com o botão direito do mouse em Certificados, clique em Todas as tarefas e selecione Importar.

  4. Clique em Details (Detalhes ), selecione o certificado do proxy e clique em Export (Exportar ).

  5. Reinicie o site Visual Studio Code e a extensão watsonx Code Assistant para aplicar as alterações. Você deve conseguir fazer login usando sua chave de API.

Proteja sua configuração

IBM watsonx Code Assistant não fornece controles de segurança adicionais. Siga estas etapas para proteger adequadamente sua configuração.

Seu ambiente do Visual Studio Code

Aplique todas as atualizações do site Visual Studio Code para garantir que você tenha as mais recentes correções de segurança e de bugs. Para obter mais informações, consulte a documentação da Microsoft.

Os registros de extensão watsonx Code Assistant são armazenados em arquivos *.log em ' <your home directory>/.wca. Esses arquivos não são criptografados, a não ser pela criptografia fornecida pelo seu sistema de arquivos. Proteja os registros contra acesso indevido.

Armazenamento de conversas de bate-papo

IBM watsonx Code Assistant armazena todo o histórico de conversas de bate-papo localmente no sistema de arquivos em <your home directory>/.wca/chat.db, em um formato de banco de dados definido por SQLite. IBM watsonx Code Assistant não compartilha essas conversas com ninguém. Esse arquivo não é criptografado, a não ser pela criptografia fornecida pelo seu sistema de arquivos. Proteja esse arquivo contra acesso indevido.

Dados de telemetria

IBM watsonx Code Assistant não coleta nenhum dado de telemetria. Em geral, watsonx Code Assistant não envia nenhum dado que processa para terceiros, inclusive para IBM.

Como fazer logout de sua chave de API

Se necessário, você pode fazer logout da sua chave de API. Fazer logout e reinserir sua chave de API pode ajudar a resolver qualquer problema de autenticação que você encontrar.

Para fazer logout:

  1. No Visual Studio Code, clique no ícone Accounts (Contas ).

  2. Clique na configuração Your Name (Chave de API WCA) e, em seguida, clique em Sign out (Sair).

Usar a exibição de saída para ver os detalhes da atividade

Você pode usar a exibição de saída do Visual Studio Code para ver detalhes sobre o que a extensão está fazendo e registrando, e verificar se há erros.

Para abrir a visualização de Saída:

  1. No Visual Studio Code, clique em Exibir e, em seguida, clique em Saída.

  2. Na exibição Saída, use a lista suspensa para selecionar WCA ou WCA Language Server. Ambos fornecem mais detalhes sobre o que a extensão está fazendo.

Para ajustar a exibição de saída e o registro para a extensão do Visual Studio Code:

  1. No Visual Studio Code, abra as configurações de extensão para watsonx Code Assistant.

  2. Em Wca: Log level (Nível de registro ), mude do padrão INFO para outra configuração, como WARN.

Desativar ou desinstalar a extensão

Se necessário, você pode desativar a extensão e mantê-la instalada, ou pode desinstalá-la completamente.

Para desativar ou desinstalar a extensão:

  1. No Visual Studio Code, clique no ícone Extensões para abrir o painel.

  2. Clique na extensão watsonx Code Assistant.

  3. Clique em Disable (Desativar ) ou Uninstall (Desinstalar).

Alteração do idioma do visor

A extensão watsonx Code Assistant está disponível em inglês (en), japonês (ja) e coreano (ko).

A extensão watsonx Code Assistant for Enterprise Java Applications está disponível somente em inglês (en).

Para alterar o idioma do visor:

  1. Em Visual Studio Code, clique em View (Exibir ) e, em seguida, clique em Command Palette (Paleta de comandos ).

  2. Procure por display e clique em Configure Display Language (Configurar idioma de exibição ).

  3. Escolha entre inglês (en), japonês (ja) ou coreano (ko).

Para obter mais informações, consulte Idioma de exibição na documentação do site Visual Studio Code.