GenerateAIAgentCall - Intelligent Media Services: Central de Documentação do Alibaba Cloud

Cria uma instância de agente e retorna o canal, o nome de usuário e o token para ingressar no canal.

Descrição da operação

Esta API cria uma instância de agente usando o ID do agente de IA (AIAgentId) especificado. Você pode usar as informações na resposta para ingressar no canal correspondente e iniciar uma sessão com o agente.

Importante

Certifique-se de que o ID do agente de IA especificado seja válido e configure os parâmetros opcionais conforme necessário.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ice:GenerateAIAgentCall

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AIAgentId	string	Sim	O ID do agente de IA.	39f8e0bc005e4f309379701645f4****
Expire	integer	Não	Opcional. O tempo de expiração do token em segundos. Valor padrão: 3600. Intervalo de valores: 0 a 604800.	3600
UserId	string	Não	O nome de usuário no canal. Se você não especificar um nome de usuário, um será gerado automaticamente. O nome de usuário pode ter até 64 caracteres.	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	Não	Esta configuração é mesclada com a configuração do modelo de agente no console. Se você omitir este parâmetro, o agente usará a configuração padrão do console. Nota A configuração do modelo de agente. Este parâmetro foi descontinuado. Use o parâmetro AgentConfig em seu lugar.
UserData	string	Não	Os dados do usuário.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	Não	Um identificador exclusivo para a sessão. Se não for fornecido, uma nova sessão será criada.	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	Não	A configuração do modelo de agente. A configuração fornecida é mesclada com a configuração do modelo de agente no console. Se você omitir este parâmetro, o agente usará a configuração padrão do console. Nota Compatibilidade com TemplateConfig: os campos em AgentConfig têm precedência. Se um campo for especificado em TemplateConfig, mas não em AgentConfig, o sistema usará o valor de TemplateConfig. Recomendamos o uso de AgentConfig em vez de TemplateConfig.
ChatSyncConfig	object	Não	A configuração de sincronização de chat.
IMAIAgentId	string	Não	O ID do agente de mensagens instantâneas (IM).	****005e4f309379701645f4**
ReceiverId	string	Não	O ID de usuário do destinatário.	4167626d312034b2b1c3b7f2f3e41884

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
AIAgentUserId	string	O nome do agente no canal do Alibaba Real-time Communication (ARTC).	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	O ID do canal ARTC.	70f22d5784194938a7e387052f2b3208
InstanceId	string	O ID da instância de agente gerada.	39f8e0bc005e4f309379701645f4****
RequestId	string	O ID da solicitação.	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	O token ARTC do lado do cliente.	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	O nome de usuário no canal ARTC.	user123
AvatarUserId	string	O ID de usuário do avatar no canal.	avatar_39f8e0bc005e4f309379701645f4****

Exemplos

Resposta de sucesso

JSON formato

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123",
  "AvatarUserId": "avatar_39f8e0bc005e4f309379701645f4****"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.