Como criar um projeto de CLU

Neste artigo, saiba como configurar esses requisitos e criar um projeto.

Pré-requisitos

Antes de começar a usar a CLU, 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

Antes de começar a usar a CLU, você precisará de um recurso de Linguagem da 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.

Criar um recurso usando o portal do Azure

1. Entre no portal do Azure para criar um novo recurso de Linguagem de IA do Azure.

2. Selecione Criar um novo recurso

3. Na janela exibida, procure serviço de Linguagem

4. Escolha Criar

5. 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 para o recurso de Linguagem.
   Nome	Nome obrigatório para o recurso de linguagem
   Tipo de preço	Um dos tipos de preço com suporte para o recurso de Linguagem.

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 de Linguagem
Localização	Uma das regiões com suporte para o recurso de Linguagem.
Tipo de preço	Um dos tipos de preço com suporte para o recurso de Linguagem.

Importante

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

Conectar ao Language Studio

1. Vá para o Language Studio e entre com sua conta do Azure.

2. Na janela Escolher um recurso de linguagem que aparece, localize sua assinatura do Azure e escolha o recurso de linguagem. Se você não tiver um recurso, poderá criar um.

   Detalhes da instância	Valor obrigatório
   Assinatura do Azure	Sua assinatura do Azure.
   Grupo de recursos do Azure	O nome do grupo de recursos do Azure.
   Nome do recurso do Azure	Nome do seu recurso do Azure.
   Localização	Uma das regiões com suporte para o recurso de Linguagem. Por exemplo, "Oeste dos EUA 2".
   Tipo de preço	Um dos tipos de preço válidos para o recurso de Linguagem. Use a camada Gratuita (F0) para experimentar o serviço.

   

Criar uma projeto de conversa

Depois de ter um recurso de Linguagem associado à sua conta, crie um projeto de Compreensão da Linguagem Coloquial.

Language Studio

1. No Estúdio de Linguagem, localize a seção rotulada Compreensão de perguntas e linguagem coloquial e clique em Compreensão da linguagem coloquial.
   

2. Isso o levará à página Projetos de compreensão da linguagem coloquial. Selecione Criar novo projeto.

   

Para criar um novo projeto, você precisará fornecer os seguintes detalhes:

Valor	Descrição
Nome	Um nome para o projeto. Depois de criado, ele não pode ser alterado
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.
Habilitar vários idiomas	Se você deseja habilitar seu projeto para dar suporte a vários idiomas ao mesmo tempo.

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

APIs REST

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.
Content-Type	'application/merge-patch+json'

Corpo

Use o JSON de exemplo a seguir como seu corpo.

{
  "projectName": "{PROJECT-NAME}",
  "language": "{LANGUAGE-CODE}",
  "projectKind": "Conversation",
  "description": "Project description",
  "multilingual": true
}

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 for um projeto multilíngue, escolha o código de idioma da maioria dos enunciados.	en-us
multilingual	true	Um valor booliano que permite ter documentos em vários idiomas no conjunto de dados e, quando o modelo é implantado, é possível consultar o modelo em qualquer idioma com suporte, (não necessariamente incluído nos documentos de treinamento). Confira Suporte de idioma para saber mais sobre o suporte multilíngue.	true

Projeto de importação

Language Studio

Você pode exportar um projeto de Compreensão da Linguagem Coloquial como um arquivo JSON a qualquer momento acessando a página Projetos de conversa, 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.

Se você tiver um aplicativo LUIS existente, será possível importar o JSON do aplicativo LUIS para Reconhecimento vocal de conversação diretamente, e ele criará um projeto de conversa com todas as partes disponíveis no momento: intenções,entidades ML e enunciados. Veja o artigo de migração do LUIS para obter mais informações.

Para importar um projeto, clique no botão de seta ao lado de Criar um novo projeto e selecione Importar e, em seguida, selecione o arquivo JSON ou da Compreensão da Linguagem Coloquial do LUIS.

APIs REST

Você pode importar um JSON da CLU para o serviço

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

URL da solicitação

Use a URL a seguir ao criar sua solicitação de API. Substitua os valores do espaço reservado pelos seus.

{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 e deve corresponder ao nome do projeto no arquivo JSON que você está importando.	EmailAppDemo
{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

O corpo JSON que você envia é semelhante ao exemplo a seguir. Confira a documentação de referência para obter mais detalhes sobre o objeto JSON.

{
  "projectFileVersion": "{API-VERSION}",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "{PROJECT-NAME}",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "{LANGUAGE-CODE}"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "intent1"
      },
      {
        "category": "intent2"
      }
    ],
    "entities": [
      {
        "category": "entity1"
      }
    ],
    "utterances": [
      {
        "text": "text1",
        "dataset": "{DATASET}",
        "intent": "intent1",
        "entities": [
          {
            "category": "entity1",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "text2",
        "language": "{LANGUAGE-CODE}",
        "dataset": "{DATASET}",
        "intent": "intent2",
        "entities": []
      }
    ]
  }
}

Chave	Espaço reservado	Valor	Exemplo
{API-VERSION}	A versão da API que você está chamando.	2023-04-01
projectName	{PROJECT-NAME}	O nome do seu projeto. Esse valor diferencia maiúsculas de minúsculas.	EmailAppDemo
language	{LANGUAGE-CODE}	Uma cadeia de caracteres que especifica o código de idioma dos enunciados usados no projeto. Se for um projeto multilíngue, escolha o código de idioma da maioria dos enunciados.	en-us
multilingual	true	Um valor booliano que permite que você tenha documentos em vários idiomas em seu conjunto de dados. Quando seu modelo for implantado, você poderá consultar o modelo em qualquer idioma com suporte, incluindo os idiomas que não estão incluídos em seus documentos de treinamento.	true
dataset	{DATASET}	Confira como treinar um modelo para saber como dividir seus dados entre um conjunto de testes e um de treinamento. Os valores possíveis para esse campo são Train e Test.	Train

Após uma solicitação bem-sucedida, a resposta da API conterá um cabeçalho operation-location com uma URL que você pode usar para verificar o status do trabalho de importação. É formatado assim:

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

Exportar projeto

Language Studio

Você pode exportar um projeto de Reconhecimento vocal de conversação como um arquivo JSON a qualquer momento acessando a página projetos de conversa, selecionando um projeto e pressionando Exportar.

APIs REST

É possível exportar um projeto de Compreensão da linguagem coloquial 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 os detalhes do projeto de CLU

Language Studio

1. Acesse 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 e habilitar/desabilitar o conjunto de dados multilíngue nas configurações do projeto.

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

   

APIs REST

Para obter detalhes do projeto, 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": "Conversation",
  "projectName": "{PROJECT-NAME}",
  "multilingual": true,
  "description": "This is a sample conversation 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

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.

APIs REST

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