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

Inicia uma instância de agente de IA configurada no IMS.

Descrição da operação

Você pode usar esta API para iniciar uma instância de agente de IA configurada e adicioná-la a um chat. Especifique o ID do agente (AIAgentId), a configuração de tempo de execução (RuntimeConfig) e, opcionalmente, uma configuração de modelo (TemplateConfig) e dados definidos pelo usuário (UserData). Após a instância do agente ser iniciada com sucesso, a API retorna um InstanceId exclusivo para rastreamento ou operações futuras.

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:StartAIAgentInstance

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AIAgentId	string	Sim	O ID do agente configurado no console do IMS.	39f8e0bc005e4f309379701645f4****
RuntimeConfig	AIAgentRuntimeConfig	Sim	A configuração necessária para o agente em tempo de execução.
AgentConfig	AIAgentConfig	Não	A configuração de modelo do agente. Os valores fornecidos são mesclados com a configuração de modelo definida no console. Se você omitir este parâmetro, o agente usará sua configuração padrão do console. Nota Este campo é compatível com TemplateConfig. Os campos em AgentConfig têm precedência. Se TemplateConfig contiver campos não definidos em AgentConfig, esses campos serão usados. Use AgentConfig em vez de TemplateConfig.
UserData	string	Não	Dados definidos pelo usuário.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	Não	Um identificador exclusivo para a sessão de chat. Este parâmetro é opcional.	f213fbc005e4f309379701645f4****
ChatSyncConfig	object	Não	A configuração de sincronização do histórico de chat.
IMAIAgentId	string	Não	O ID do agente de IM.	****005e4f309379701645f4**
ReceiverId	string	Não	O ID do usuário receptor.	4167626d312034b2b1c3b7f2f3e41884
TemplateConfig `deprecated`	AIAgentTemplateConfig	Não	A configuração de modelo do agente. Os valores fornecidos são mesclados com a configuração de modelo definida no console. Se você omitir este parâmetro, o agente usará sua configuração padrão do console. Nota A configuração de modelo do agente. Este campo está obsoleto. Consulte o campo AgentConfig.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	7B117AF5-2A16-412C-B127-FA6175ED1AD0
InstanceId	string	O ID exclusivo da instância do agente.	39f8e0bc005e4f309379701645f4****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "InstanceId": "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.