Como criar um projeto CLU

Use este artigo para saber como configurar esses requisitos e criar um projeto.

Pré-requisitos

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

Criar um novo recurso a partir do 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 que aparece, procure por Serviço de idioma

4. Selecione Criar

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

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

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	O nome do recurso Idioma
Localização	Uma região suportada para o seu recurso Idioma.
Escalão de preço	Um nível de preços suportado para o seu recurso de idioma.

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

1. Aceda ao Language Studio e inicie sessão com a sua conta do Azure.

2. Na janela Escolha um recurso de idioma que aparece, localize sua assinatura do Azure e escolha seu recurso de idioma. Se não tiver um recurso, pode criar um novo.

   Detalhe da instância	Valor obrigatório
   Subscrição do Azure	A sua subscrição do Azure.
   Grupo de recursos do Azure	Seu nome de grupo de recursos do Azure.
   Nome do recurso do Azure	Seu nome de recurso do Azure.
   Localização	Uma das regiões suportadas para o seu recurso Idioma. Por exemplo, "West US 2".
   Escalão de preço	Um dos níveis de preços válidos para o seu recurso de idioma. Você pode usar a camada Gratuito (F0) para experimentar o serviço.

   

Criar um projeto de conversação

Depois de criar um recurso de linguagem, crie um projeto de compreensão de linguagem conversacional.

Estúdio de Idiomas

1. No Language Studio, localize a seção chamada Compreender perguntas e linguagem conversacional e selecione Compreensão de linguagem conversacional.
   

2. Isso levará você à página Projetos de compreensão de linguagem conversacional. Selecione Criar novo projeto.

   

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

Valor	Descrição
Name	Um nome para o seu projeto. Uma vez criado, não pode ser alterado
Description	Descrição do projeto opcional.
Linguagem primária dos enunciados	A língua principal do seu projeto. Seus dados de treinamento devem estar principalmente neste idioma.
Ativar vários idiomas	Se você gostaria de habilitar seu projeto para suportar 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 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.
Content-Type	'aplicativo/merge-patch+json'

Corpo

Use o exemplo JSON a seguir como seu corpo.

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

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
multilingual	true	Um valor booleano que permite que você tenha documentos em vários idiomas em seu conjunto de dados e, quando seu modelo é implantado, você pode consultar o modelo em qualquer idioma suportado (não necessariamente incluído em seus documentos de treinamento). Consulte Suporte linguístico para saber mais sobre o suporte multilingue.	true

Importar projeto

Estúdio de Idiomas

Você pode exportar um projeto de Compreensão de Linguagem de Conversação como um arquivo JSON a qualquer momento, indo para a página de projetos de conversaçã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.

Se você tiver um aplicativo LUIS existente, poderá importar o JSON do aplicativo LUIS para o Entendimento de Linguagem Conversacional diretamente, e ele criará um projeto de Conversação com todas as partes que estão disponíveis no momento: Intenções, entidades de ML e enunciados. Consulte o artigo sobre migração do LUIS para obter mais informações.

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 LUIS ou Conversational Language Understanding JSON.

APIs REST

Você pode importar um JSON CLU 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 por 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 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.

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

Corpo

O corpo JSON enviado é semelhante ao exemplo a seguir. Consulte 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": []
      }
    ]
  }
}

Key	Marcador de Posição	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 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
multilingual	true	Um valor booleano que permite que você tenha documentos em vários idiomas em seu conjunto de dados. Quando o modelo é implantado, você pode consultá-lo em qualquer idioma suportado, incluindo idiomas que não estão incluídos nos documentos de treinamento.	true
dataset	{DATASET}	Veja como treinar um modelo para obter informações sobre como dividir seus dados entre um conjunto de teste e treinamento. Os valores possíveis para este campo são Train e Test.	Train

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

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

Projeto de exportação

Estúdio de Idiomas

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

APIs REST

Você pode exportar um projeto de Compreensão de Linguagem Conversacional 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.

Obter detalhes do projeto CLU

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

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

   

APIs REST

Para obter os detalhes do seu projeto, envie uma solicitação GET usando o 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": "Conversation",
  "projectName": "{PROJECT-NAME}",
  "multilingual": true,
  "description": "This is a sample conversation 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