executePrompt (referência da API do cliente) (versão prévia)

Importante

• Esse é um recurso de visualização.
• Os recursos de versão preliminar não foram criados para uso em ambientes de produção e podem ter funcionalidade restrita. Esses recursos estão sujeitos a termos de uso suplementares e são disponibilizados antes de um lançamento oficial, de maneira que os clientes possam ter acesso antecipado e fazer comentários.

Executa um tópico do Microsoft Copilot Studio com base nas consultas de gatilho registradas no tópico. Retorna a matriz do tipo MCSResponse.

Sintaxe

Xrm.Copilot.executePrompt(promptText).then(successCallback, errorCallback);

Parâmetros

Nome do parâmetro	Tipo	Obrigatório	Description
promptText	cadeia	Yes	O texto registrado como uma consulta de gatilho no tópico do MCS.
successCallback	Função	Yes	Uma função a ser chamada quando a operação for bem-sucedida.
errorCallback	Função	Yes	Uma função a ser chamada quando a operação falhar.

Valor de retorno

Uma matriz de MCSResponse

Example

No Microsoft Copilot Studio, um tópico é disparado por consultas como "olá" ou "oi". Quando executePrompt executado com promptText correspondente, ele ativa o tópico e retorna uma atividade de mensagem com o texto de resposta.

const response = await Xrm.Copilot.executePrompt("hello"); 

Resposta

Este é um exemplo da resposta que pode ser retornada.

[
    {
        "type": "message",
        "timestamp": "2025-02-05T16:46:07.7799759+00:00",
        "replyToId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "attachments": [],
        "textFormat": "markdown",
        "text": "Hello, how can I help you today?",
        "speak": "Hello, <break strength=\"medium\" /> how can I help?"
    }
]

Artigos relacionados

Xrm.Copilot (referência da API do Cliente)