Visão geral da API do watsonx Assistant

É possível usar as APIs de REST do watsonx Assistant e os SDKs correspondentes para desenvolver aplicativos que interagem com o serviço.

Aplicativos clientes

Para criar um assistente virtual ou outro aplicativo cliente que se comunique com um assistente em tempo de execução, use a API v2. É possível desenvolver um cliente voltado ao cliente que pode ser implementado para uso de produção, um aplicativo que intermede a comunicação entre um assistente e outro serviço ou um aplicativo de teste.

Usando a API de tempo de execução da v2 para se comunicar com seu assistente, seu aplicativo pode aproveitar os recursos a seguir:

  • Gerenciamento de estado automático. A API de tempo de execução v2 gerencia cada sessão com um usuário, armazenando e mantendo todos os dados de contexto de que o assistente precisa para uma conversa completa.

  • Facilidade de implementar assistentes. Além de suportar clientes customizados, um assistente pode ser facilmente implementado em canais de sistema de mensagens populares, como o Slack e o Facebook Messenger.

  • Versionamento. Você pode salvar um instantâneo de seu conteúdo e vincular seu assistente a essa versão específica. Em seguida, é possível continuar atualizando sua versão de desenvolvimento sem afetar o assistente de produção.

  • Recursos de procura. A API de tempo de execução v2 pode ser usada para receber respostas da integração de procura. Quando uma consulta é enviada que seu assistente não pode responder, a integração de procura pode localizar a melhor resposta das origens de dados configuradas.

Para obter mais informações, consulte o watsonx Assistant v2 referência de API.

A API v1 watsonx Assistant suporta o método /message que envia a entrada do usuário diretamente para o espaço de trabalho usado por uma caixa de diálogo. A API de tempo de execução v1 é suportada principalmente para fins de compatibilidade. Ao usar o método /message da v1, deve-se implementar o próprio gerenciamento de estado e não será possível aproveitar o versionamento ou qualquer um dos outros recursos de um assistente.

Aplicativos de criação

A API v1 fornece métodos que permitem que um aplicativo crie ou modifique habilidades de diálogo, como uma alternativa para criar uma habilidade graficamente usando a interface de usuário clássica Watson Assistant. Um aplicativo de criação usa a API para criar e modificar qualificações, intenções, entidades, nós de diálogo e outros artefatos que constituem uma qualificação de diálogo. Para obter mais informações, consulte a Referência da API v1.

Os métodos de criação v1 criam e modificam espaços de trabalho em vez de habilidades. Uma área de trabalho é um contêiner para os dados de diálogo e de treinamento (como intenções e entidades) dentro de uma qualificação de diálogo. Se você criar um novo espaço de trabalho usando a API, ele aparecerá como uma nova habilidade de diálogo na interface de usuário clássica Watson Assistant.

Para obter uma lista dos métodos de API disponíveis, consulte Resumo de métodos de API.