Como criar projetos no fluxo de trabalho de orquestração

O fluxo de trabalho de orquestração permite criar projetos que conectam seus aplicativos a:

• Compreensão de Linguagem Personalizada
• Respostas a Perguntas
• LUIS

Pré-requisitos

Antes de começar a usar o fluxo de trabalho de orquestração, você precisará de várias coisas:

• Uma assinatura do Azure - Crie uma gratuitamente.
• Um recurso de linguagem de IA do Azure

Criar um recurso de idioma

Antes de começar a usar o fluxo de trabalho de orquestração, você precisará de um recurso da Linguagem de IA do Azure.

Nota

• Você precisa ter uma função de proprietário atribuída no grupo de recursos para criar um recurso de idioma.
• Se você estiver planejando usar a resposta a perguntas, será necessário habilitar a resposta a perguntas na criação de recursos

Criar um novo recurso a partir do portal do Azure

1. Vá para o portal do Azure para criar um novo recurso de linguagem de IA do Azure.

2. Selecione Continuar para criar seu recurso

3. Crie um recurso de idioma com os seguintes detalhes.

   Detalhe da instância	Valor obrigatório
   Região	Uma das regiões apoiadas.
   Nome	Um nome para o seu recurso de idioma.
   Escalão de preço	Um dos níveis de preços suportados.

Criar um novo recurso de idioma a partir do Language Studio

Se for a primeira vez que inicia sessão, verá uma janela no Language Studio que lhe permitirá escolher um recurso de Idioma existente ou criar um novo. Também pode criar um recurso clicando no ícone de definições no canto superior direito, selecionando Recursos e, em seguida, clicando em Criar um novo recurso.

Crie um recurso de idioma com os seguintes detalhes.

Detalhe da instância	Valor obrigatório
Subscrição do Azure	a subscrição do Azure
Grupo de recursos do Azure	Seu grupo de recursos do Azure
Nome do recurso do Azure	Seu nome de recurso do Azure
Localização	Saiba mais sobre as regiões suportadas.
Escalão de preço	Saiba mais sobre os níveis de preços suportados.

Importante

• Certifique-se de habilitar a Identidade Gerenciada ao criar um recurso de Idioma.
• Leia e confirme o aviso de IA responsável

Iniciar sessão no Language Studio

Para criar uma nova intenção, selecione o botão +Adicionar e comece dando um nome à sua intenção. Você verá duas opções, para se conectar a um projeto ou não. Você pode se conectar a projetos (LUIS, resposta a perguntas ou compreensão de linguagem conversacional) ou escolher a opção não .

Criar um projeto de fluxo de trabalho de orquestração

Depois de criar um recurso de linguagem, crie um projeto de fluxo de trabalho de orquestração.

Estúdio de Idiomas

1. No Language Studio, localize a seção Compreender perguntas e linguagem de conversação e selecione Fluxo de trabalho de orquestração.

   

2. Isso levará você à página do projeto de fluxo de trabalho Orchestration. Selecione Criar novo projeto. Para criar um projeto, você precisará fornecer os seguintes detalhes:

Valor	Descrição
Name	Um nome para o seu projeto.
Description	Descrição do projeto opcional.
Enunciados língua principal	A língua principal do seu projeto. Seus dados de treinamento devem estar principalmente neste idioma.

Quando terminar, selecione Avançar e revise os detalhes. Selecione criar projeto para concluir o processo. Agora você deve ver a tela Build Schema em seu projeto.

APIs REST

Envie uma solicitação PATCH usando a seguinte URL, cabeçalhos e corpo JSON para criar um novo projeto.

URL do Pedido

Use a seguinte URL ao criar sua solicitação de API. Substitua os valores de espaço reservado abaixo pelos seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de Posição	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando.	2023-04-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Key	valor
Ocp-Apim-Subscription-Key	A chave para o seu recurso. Usado para autenticar suas solicitações de API.

Corpo

Use o exemplo JSON a seguir como seu corpo.

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Orchestration",
  "description": "Project description"
 }

Key	Marcador de Posição	Valor	Exemplo
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	EmailApp
language	{LANGUAGE-CODE}	Uma cadeia de caracteres especificando o código de idioma para os enunciados usados em seu projeto. Se o seu projeto for multilingue, escolha o código linguístico da maioria dos enunciados.	en-us

Importar um projeto de fluxo de trabalho de orquestração

Estúdio de Idiomas

Você pode exportar um projeto de fluxo de trabalho de orquestração como um arquivo JSON a qualquer momento, indo para a página de projetos de fluxo de trabalho de orquestração, selecionando um projeto e, no menu superior, clicando em Exportar.

Esse projeto pode ser reimportado como um novo projeto. Se você importar um projeto com exatamente o mesmo nome, ele substituirá os dados do projeto pelos dados do projeto recém-importado.

Para importar um projeto, selecione o botão de seta ao lado de Criar um novo projeto e selecione Importar e, em seguida, selecione o arquivo JSON.

APIs REST

Você pode importar um JSON de fluxo de trabalho de orquestração para o serviço

Envie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para importar seu projeto.

URL do Pedido

Use a seguinte URL ao criar sua solicitação de API. Substitua os valores de espaço reservado abaixo pelos seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:import?api-version={API-VERSION}

Marcador de Posição	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando.	2023-04-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Key	valor
Ocp-Apim-Subscription-Key	A chave para o seu recurso. Usado para autenticar suas solicitações de API.

Corpo

Nota

Cada intenção deve ser apenas de um tipo de (CLU, LUIS e qna)

Use o exemplo JSON a seguir como seu corpo.

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Orchestration",
    "settings": {
      "confidenceThreshold": 0
    },
    "projectName": "{PROJECT-NAME}",
    "description": "Project description",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Orchestration",
    "intents": [
      {
        "category": "string",
        "orchestration": {
          "kind": "luis",
          "luisOrchestration": {
            "appId": "00000000-0000-0000-0000-000000000000",
            "appVersion": "string",
            "slotName": "string"
          },
          "cluOrchestration": {
            "projectName": "string",
            "deploymentName": "string"
          },
          "qnaOrchestration": {
            "projectName": "string"
          }
        }
      }
    ],
    "utterances": [
      {
        "text": "Trying orchestration",
        "language": "{LANGUAGE-CODE}",
        "intent": "string"
      }
    ]
  }
}

Key	Marcador de Posição	Valor	Exemplo
api-version	{API-VERSION}	A versão da API que você está chamando. A versão usada aqui deve ser a mesma versão da API na URL.	2022-03-01-preview
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	EmailApp
language	{LANGUAGE-CODE}	Uma cadeia de caracteres especificando o código de idioma para os enunciados usados em seu projeto. Se o seu projeto for multilingue, escolha o código linguístico da maioria dos enunciados.	en-us

Projeto de exportação

Estúdio de Idiomas

Você pode exportar um projeto de fluxo de trabalho de orquestração como um arquivo JSON a qualquer momento, indo para a página de projetos de fluxo de trabalho de orquestração, selecionando um projeto e pressionando Exportar.

APIs REST

Você pode exportar um projeto de fluxo de trabalho de orquestração como um arquivo JSON a qualquer momento.

Crie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para exportar seu projeto.

URL do Pedido

Use a seguinte URL ao criar sua solicitação de API. Substitua os valores de espaço reservado abaixo pelos seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/:export?stringIndexType=Utf16CodeUnit&api-version={API-VERSION}

Marcador de Posição	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	EmailApp
{API-VERSION}	A versão da API que você está chamando.	2023-04-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Key	valor
Ocp-Apim-Subscription-Key	A chave para o seu recurso. Usado para autenticar suas solicitações de API.

Depois de enviar sua solicitação de API, você receberá uma 202 resposta indicando sucesso. Nos cabeçalhos de resposta, extraia o operation-location valor. Será formatado da seguinte forma:

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

JOB-ID é utilizado para identificar o seu pedido, uma vez que esta operação é assíncrona. Use essa URL para obter o JSON do projeto exportado, usando o mesmo método de autenticação.

Obtenha detalhes do projeto de orquestração

Estúdio de Idiomas

1. Vá para a página de configurações do projeto no Language Studio.

2. Você pode ver os detalhes do projeto.

3. Nesta página você pode atualizar a descrição do projeto.

4. Você também pode recuperar sua chave primária de recurso nesta página.

   

APIs REST

Para obter os detalhes de um projeto de fluxo de trabalho de orquestração, envie uma solicitação GET usando a seguinte URL e cabeçalhos. Substitua os valores de espaço reservado por seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de Posição	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando.	2023-04-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Key	valor
Ocp-Apim-Subscription-Key	A chave para o seu recurso. Usado para autenticar suas solicitações de API.

Organismo de resposta

Depois de enviar o pedido, obterá a seguinte resposta.

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "Orchestration",
  "projectName": "{PROJECT-NAME}",
  "description": "This is a sample orchestration project.",
  "language": "{LANGUAGE-CODE}"
}

Depois de enviar sua solicitação de API, você receberá uma resposta indicando o sucesso e o 200 corpo da resposta JSON com os detalhes do seu projeto.

Excluir projeto

Estúdio de Idiomas

Quando você não precisar mais do seu projeto, poderá excluí-lo usando o Language Studio. Selecione Projetos no menu de navegação esquerdo, selecione o projeto que deseja excluir e selecione Excluir no menu superior.

APIs REST

Quando você não precisar mais do seu projeto, poderá excluí-lo usando as APIs.

Crie uma solicitação DELETE usando a seguinte URL, cabeçalhos e corpo JSON para excluir um projeto de compreensão de linguagem conversacional.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}?api-version={API-VERSION}

Marcador de Posição	Valor	Exemplo
{ENDPOINT}	O ponto de extremidade para autenticar sua solicitação de API.	https://<your-custom-subdomain>.cognitiveservices.azure.com
{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	myProject
{API-VERSION}	A versão da API que você está chamando.	2023-04-01

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Key	valor
Ocp-Apim-Subscription-Key	A chave para o seu recurso. Usado para autenticar suas solicitações de API.

Depois de enviar sua solicitação de API, você receberá uma 202 resposta indicando sucesso, o que significa que seu projeto foi excluído.

Passos Seguintes

Criar o esquema