Resumo de métodos da API

As tabelas a seguir listam os métodos que estão disponíveis com as APIs watsonx Assistant APIs.

Métodos de tempo de execução

Método	Descrição	Versão	Referência
Criar uma sessão	Crie uma nova sessão. Uma sessão é usada para enviar a entrada do usuário para uma qualificação e receber respostas. Ela também mantém o estado da conversa.	v2	cURL nó Java python
Excluir sessão	Exclui uma sessão explicitamente antes de atingir o tempo limite.	v2	cURL nó Java python
Enviar a entrada do usuário para o assistente (stateful)	Envie a entrada do usuário para um assistente e receba uma resposta, com o estado da conversa (incluindo dados de contexto) armazenado por watsonx Assistant durante a sessão.	v2	cURL nó Java python
Enviar a entrada do usuário para o assistente (stateless)	Envie a entrada do usuário para um assistente e receba uma resposta com o estado conversacional (incluindo dados de contexto) gerenciado por seu aplicativo.	v2	cURL nó Java python

Métodos de Autoria

Método	Descrição	Versão	Referência
Listar áreas de trabalho	Lista os espaços de trabalho associados a uma instância de serviço watsonx Assistant.	v1	cURL nó Java python
Criar área de trabalho	Crie uma área de trabalho com base em objetos componentes. Você deve fornecer componentes de espaço de trabalho que definam o conteúdo do novo espaço de trabalho.	v1	cURL nó Java python
Obter informações sobre uma área de trabalho	Obtenha informações sobre uma área de trabalho, incluindo opcionalmente todo o conteúdo da área de trabalho.	v1	cURL nó Java python
Atualizar área de trabalho	Atualize uma área de trabalho existente com dados novos ou modificados. Você deve fornecer objetos componentes que definam o conteúdo do espaço de trabalho atualizado.	v1	cURL nó Java python
Excluir área de trabalho	Exclua uma área de trabalho da instância de serviço.	v1	cURL nó Java python
Listar intenções	Liste as intents para uma área de trabalho.	v1	cURL nó Java python
Criar intenção	Crie uma nova intenção.	v1	cURL nó Java python
Obter intenção	Obtenha informações sobre uma intenção, incluindo opcionalmente todo o conteúdo de intenção.	v1	cURL nó Java python
Atualizar intenção	Atualize uma intenção existente com dados novos ou modificados. Você deve fornecer objetos de componente que definam o conteúdo da intenção atualizada.	v1	cURL nó Java python
Excluir intenção	Excluir uma intenção de uma área de trabalho.	v1	cURL nó Java python
Listar exemplos de entrada do usuário	Liste os exemplos de entrada do usuário para uma intenção, incluindo opcionalmente as menções de entidade contextual.	v1	cURL nó Java python
Criar exemplo de entrada do usuário	Inclua um novo exemplo de entrada do usuário em uma intenção.	v1	cURL nó Java python
Obter exemplo de entrada do usuário	Obter informações sobre um exemplo de entrada do usuário.	v1	cURL nó Java python
Atualizar exemplo de entrada do usuário	Atualize o texto de um exemplo de entrada do usuário.	v1	cURL nó Java python
Excluir exemplo de entrada do usuário	Exclua um exemplo de entrada do usuário de uma intenção.	v1	cURL nó Java python
Listar countraexemplos	Liste os contramedidas para uma área de trabalho. Os contraexemplos são exemplos marcados como entrada irrelevante.	v1	cURL nó Java python
Criar contraexemplo	Inclua um novo contraexemplo em uma área de trabalho. Os contraexemplos são exemplos marcados como entrada irrelevante.	v1	cURL nó Java python
Obter contraexemplo	Obtenha informações sobre um contra-exemplo. Os contraexemplos são exemplos marcados como entrada irrelevante.	v1	cURL nó Java python
Atualizar contraexemplo	Atualize o texto de um contra-exemplo. Os contraexemplos são exemplos marcados como entrada irrelevante.	v1	cURL nó Java python
Excluir contraexemplo	Exclua um contra-exemplo de uma área de trabalho. Os contraexemplos são exemplos marcados como entrada irrelevante.	v1	cURL nó Java python
Listar entidades	Liste as entidades para uma área de trabalho.	v1	cURL nó Java python
Criar entidade	Crie uma nova entidade ou ative uma entidade do sistema.	v1	cURL nó Java python
Obter entidade	Obtenha informações sobre uma entidade, incluindo opcionalmente todo o conteúdo da entidade.	v1	cURL nó Java python
Atualizar entidade	Atualize uma entidade existente com dados novos ou modificados. Você deve fornecer objetos de componente que definam o conteúdo da entidade atualizada.	v1	cURL nó Java python
Excluir entidade	Exclua uma entidade de uma área de trabalho ou desative uma entidade do sistema.	v1	cURL nó Java python
Listar menções de entidade	Listar menções para uma entidade contextual. Uma menção de entidade é uma ocorrência de uma entidade contextual no contexto de um exemplo de entrada do usuário de intenção.	v1	cURL nó Java python
Listar valores de entidade	Liste os valores para uma entidade.	v1	cURL nó Java python
Incluir valor de entidade	Crie um novo valor para uma entidade.	v1	cURL nó Java python
Obter valor de entidade	Obtenha informações sobre um valor de entidade.	v1	cURL nó Java python
Atualizar valor de entidade	Atualize um valor de entidade existente com dados novos ou modificados. Você deve fornecer objetos de componente que definam o conteúdo do valor da entidade atualizada.	v1	cURL nó Java python
Excluir valor de entidade	Exclua um valor de uma entidade.	v1	cURL nó Java python
Listar sinônimos do valor de entidade	Liste os sinônimos para um valor de entidade.	v1	cURL nó Java python
Incluir sinônimo do valor de entidade	Inclua um novo sinônimo em um valor de entidade.	v1	cURL nó Java python
Obter sinônimo do valor de entidade	Obtenha informações sobre um sinônimo de um valor de entidade.	v1	cURL nó Java python
Atualizar o sinônimo do valor de entidade	Atualize um sinônimo do valor de entidade existente com o novo texto.	v1	cURL nó Java python
Excluir sinônimo do valor de entidade	Exclua um sinônimo de um valor de entidade.	v1	cURL nó Java python
Listar nós de diálogo	Liste os nós de diálogo para uma área de trabalho.	v1	cURL nó Java python
Criar nó de diálogo	Crie um novo nó de diálogo.	v1	cURL nó Java python
Obter nó de diálogo	Obtenha informações sobre um nó de diálogo.	v1	cURL nó Java python
Atualizar nó de diálogo	Atualize um nó de diálogo existente com dados novos ou modificados.	v1	cURL nó Java python
Excluir nó de diálogo	Exclua um nó de diálogo de uma área de trabalho.	v1	cURL nó Java python
Listar eventos de log em uma área de trabalho	Liste os eventos do log de uma área de trabalho específica.	v1	cURL nó Java python
Listar eventos de log em todas as áreas de trabalho	Liste os eventos dos logs de todas as áreas de trabalho na instância de serviço.	v1	cURL nó Java python
Excluir dados rotulados	Exclui todos os dados associados a um ID de cliente especificado. O método não terá efeito se nenhum dado estiver associado ao ID de cliente.	v1	cURL nó Java python