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

Artigo
11/21/2024

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

Reconhecimento de linguagem personalizado
Respostas às perguntas
LUIS

Pré-requisitos

Para começar a usar o fluxo de trabalho de orquestração, você precisará de vários requisitos:

Uma assinatura do Azure – Crie uma gratuitamente.
Um recurso de Linguagem de IA do Azure

Criar um recurso de Linguagem

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

Observação

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

Criar um recurso usando o portal do Azure

Vá para o portal do Azure para criar um novo recurso de Linguagem da IA do Azure.
Selecione Continuar para criar o recurso
Crie um recurso de Linguagem com os detalhes a seguir.

Detalhes da instância Valor necessário

Região Uma das regiões com suporte.

Nome Um nome para o recurso de Linguagem.

Tipo de preço Um dos tipos de preços com suporte.

Detalhes da instância	Valor necessário
Região	Uma das regiões com suporte.
Nome	Um nome para o recurso de Linguagem.
Tipo de preço	Um dos tipos de preços com suporte.

Criar um novo recurso de Linguagem no Language Studio

Se for seu primeiro login, você verá uma janela no Language Studio para escolher um recurso de Linguagem existente ou criar um novo. Também é possível criar um recurso clicando no ícone de configurações no canto superior direito, selecionando Recursos e, em seguida, Criar um novo recurso.

Crie um recurso de Linguagem com os seguintes detalhes.

Detalhes da instância	Valor obrigatório
Assinatura do Azure	sua assinatura do Azure
Grupo de recursos do Azure	O grupo de recursos do Azure
Nome do recurso do Azure	O nome do recurso do Azure
Localização	Saiba mais sobre as regiões com suporte.
Tipo de preço	Saiba mais sobre os tipos de preço com suporte.

Importante

Verifique se você habilitou a Identidade Gerenciada ao criar um recurso de idioma.
Ler e confirmar aviso de IA Responsável

Para criar uma nova intenção, clique no 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 com projetos (LUIS, respostas às perguntas ou compreensão da linguagem coloquial) ou escolher a opção não.

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

Após a criação de um recurso de Linguagem, crie um projeto de fluxo de trabalho de orquestração.

Language Studio
APIs REST

No Language Studio, localize a seção denominada Reconhecer perguntas e linguagem de conversação e selecione Fluxo de trabalho de orquestração.
Você será direcionado para a página do Projeto de fluxo de trabalho de orquestração . Selecione Criar novo projeto. Para criar um projeto, você precisará fornecer os seguintes detalhes:

Valor	Descrição
Nome	Um nome para o projeto.
Descrição	Descrição do projeto opcional.
Idioma principal dos enunciados	O idioma principal do projeto. Os dados de treinamento devem estar principalmente nesse idioma.

Quando terminar, selecione Avançar e revise os detalhes. Selecione Criar projeto para concluir o processo. Agora você deve ver a tela de Compilar Esquema em seu projeto.

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

URL da solicitação

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

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

Espaço reservado	Valor	Exemplo
`{ENDPOINT}`	O ponto de extremidade para autenticação de 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.

Chave	Valor
`Ocp-Apim-Subscription-Key`	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo

Use o JSON de exemplo a seguir como seu corpo.

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

Chave	Espaço reservado	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 que especifica o código de idioma dos enunciados usados no projeto. Se o projeto for multilíngue, escolha o código de idioma da maioria dos enunciados.	`en-us`

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

Language Studio
APIs REST

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

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, clique no botão de seta ao lado de Criar um novo projeto e selecione Importar. Depois, selecione o arquivo JSON.

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

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

URL da solicitação

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

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

Espaço reservado	Valor	Exemplo
`{ENDPOINT}`	O ponto de extremidade para autenticação de 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.

Chave	Valor
`Ocp-Apim-Subscription-Key`	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo

Observação

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

Use o JSON de exemplo 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": "00001111-aaaa-2222-bbbb-3333cccc4444",
            "appVersion": "string",
            "slotName": "string"
          },
          "cluOrchestration": {
            "projectName": "string",
            "deploymentName": "string"
          },
          "qnaOrchestration": {
            "projectName": "string"
          }
        }
      }
    ],
    "utterances": [
      {
        "text": "Trying orchestration",
        "language": "{LANGUAGE-CODE}",
        "intent": "string"
      }
    ]
  }
}

Chave	Espaço reservado	Valor	Exemplo
`api-version`	`{API-VERSION}`	A versão da API que você está chamando. A versão usada aqui precisa 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 que especifica o código de idioma dos enunciados usados no projeto. Se o projeto for multilíngue, escolha o código de idioma da maioria dos enunciados.	`en-us`

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 URL, os cabeçalhos e o corpo JSON a seguir para exportar seu projeto.

URL da solicitação

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

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

Espaço reservado	Valor	Exemplo
`{ENDPOINT}`	O ponto de extremidade para autenticação de 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.

Chave	Valor
`Ocp-Apim-Subscription-Key`	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Depois de enviar sua solicitação de API, você receberá uma 202 resposta indicando êxito. Nos cabeçalhos de resposta, extraia o valor operation-location. A formatação ficará da seguinte maneira:

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

JOB-ID é usado para identificar sua solicitação, pois essa operação é assíncrona. Use essa URL para obter o JSON do projeto exportado usando o mesmo método de autenticação.

Obter detalhes do projeto de orquestração

Language Studio
APIs REST

Acesse a página de configurações do projeto no Language Studio.
Você pode ver os detalhes do projeto.
Nesta página, você pode atualizar a descrição do projeto.
Você também pode recuperar a chave de recurso primária nesta página.

Para obter detalhes do projeto de fluxo de trabalho de orquestração, envie uma solicitação GET usando a URL e os cabeçalhos a seguir. Substitua os valores do espaço reservado pelos seus.

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

Espaço reservado	Valor	Exemplo
`{ENDPOINT}`	O ponto de extremidade para autenticação de 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.

Chave	Valor
`Ocp-Apim-Subscription-Key`	A chave para o recurso. Usado para autenticação de suas solicitações de API.

Corpo da resposta

Depois de enviar a solicitação, você receberá 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 a solicitação da API, você receberá uma resposta 200 indicando o êxito e o corpo da resposta JSON com os detalhes do projeto.

Excluir projeto

Language Studio
APIs REST

Quando não precisar mais do seu projeto, poderá excluí-lo do projeto usando o Language Studio. Selecione Projetos no menu de navegação à esquerda, escolha o projeto que deseja excluir e clique em Excluir no menu superior.

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

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

URL da solicitação

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

Espaço reservado	Valor	Exemplo
`{ENDPOINT}`	O ponto de extremidade para autenticação de 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.

Chave	Valor
`Ocp-Apim-Subscription-Key`	A chave para o recurso. Usado para autenticação de suas solicitações de API.

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

Próximas etapas

Criar esquema

Compartilhar via

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

Pré-requisitos

Criar um recurso de Linguagem

Criar um recurso usando o portal do Azure

Criar um novo recurso de Linguagem no Language Studio

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

URL da solicitação

Cabeçalhos

Corpo

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

URL da solicitação

Cabeçalhos

Corpo

Exportar o projeto

URL da solicitação

Cabeçalhos

Obter detalhes do projeto de orquestração

Cabeçalhos

Corpo da resposta

Excluir projeto

URL da solicitação

Cabeçalhos

Próximas etapas

Comentários

Recursos adicionais

Compartilhar via

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

Pré-requisitos

Criar um recurso de Linguagem

Criar um recurso usando o portal do Azure

Criar um novo recurso de Linguagem no Language Studio

Conectar ao Language Studio

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

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

Exportar o projeto

Obter detalhes do projeto de orquestração

Excluir projeto

Próximas etapas

Comentários

Recursos adicionais