Guia de início rápido: fluxo de trabalho de orquestração

Artigo
09/02/2024

Use este artigo para começar a usar projetos de fluxo de trabalho do Orchestration usando o Language Studio e a API REST. Siga estes passos para experimentar um exemplo.

Pré-requisitos

Subscrição do Azure - Crie uma gratuitamente.
Um projeto de compreensão de linguagem conversacional.

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

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 grupo de recursos do Azure.
Nome do recurso do Azure	Seu nome de recurso do Azure.
Location	Um local válido para seu recurso do Azure. Por exemplo, "West US 2".
Escalão de preço	Uma camada de preços suportada para o seu recurso do Azure. Você pode usar a camada Gratuito (F0) para experimentar o serviç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. Um projeto é uma área de trabalho para criar seus modelos de ML personalizados com base em seus dados. O seu projeto só pode ser acedido por si e por outras pessoas que tenham acesso ao recurso linguístico que está a ser utilizado.

Para este início rápido, conclua o guia de início rápido de compreensão de linguagem conversacional para criar um projeto de compreensão de linguagem conversacional que será usado posteriormente.

No Language Studio, localize a seção Compreender perguntas e linguagem de conversação e selecione Fluxo de trabalho de orquestração.
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.

Criar o esquema

Depois de concluir o início rápido de compreensão de linguagem conversacional e criar um projeto de orquestração, a próxima etapa é adicionar intenções.

Para se conectar ao projeto de compreensão de linguagem conversacional criado anteriormente:

Na página de esquema de compilação em seu projeto de orquestração, selecione Adicionar para adicionar uma intenção.
Na janela que aparece, dê um nome à sua intenção.
Selecione Sim, quero conectá-lo a um projeto existente.
Na lista suspensa de serviços conectados, selecione Compreensão de linguagem conversacional.
Na lista suspensa de nome do projeto, selecione seu projeto de compreensão de linguagem conversacional.
Selecione Adicionar intenção para criar sua intenção.

Preparar o modelo

Para treinar um modelo, você precisa começar um trabalho de treinamento. O resultado de um trabalho de treinamento bem-sucedido é o seu modelo treinado.

Para começar a treinar o seu modelo a partir do Language Studio:

Selecione Trabalhos de treinamento no menu do lado esquerdo.
Selecione Iniciar um trabalho de treinamento no menu superior.
Selecione Treinar um novo modelo e digite o nome do modelo na caixa de texto. Você também pode substituir um modelo existente selecionando essa opção e escolhendo o modelo que deseja substituir no menu suspenso. A substituição de um modelo treinado é irreversível, mas não afetará os modelos implantados até que você implante o novo modelo.

Se você habilitou seu projeto para dividir manualmente seus dados ao marcar seus enunciados, você verá duas opções de divisão de dados:
- Dividir automaticamente o conjunto de testes dos dados de treinamento: Seus enunciados marcados serão divididos aleatoriamente entre os conjuntos de treinamento e teste, de acordo com as porcentagens que você escolher. A divisão percentual padrão é de 80% para treinamento e 20% para testes. Para alterar esses valores, escolha qual conjunto deseja alterar e digite o novo valor.
Nota

Se você escolher a opção Dividir automaticamente o conjunto de testes dos dados de treinamento , somente os enunciados em seu conjunto de treinamento serão divididos de acordo com as porcentagens fornecidas.
- Use uma divisão manual de dados de treinamento e teste: atribua cada enunciado ao conjunto de treinamento ou teste durante a etapa de marcação do projeto.
Nota

A opção Usar uma divisão manual de dados de treinamento e teste só será habilitada se você adicionar enunciados ao conjunto de testes na página de dados da tag. Caso contrário, será desativado.
Selecione o botão Trem .

Nota

Apenas trabalhos de formação concluídos com sucesso gerarão modelos.
O treinamento pode levar algum tempo entre alguns minutos e algumas horas com base no tamanho dos dados marcados.
Só pode ter um trabalho de preparação em execução de cada vez. Você não pode iniciar outro trabalho de treinamento no mesmo projeto até que o trabalho em execução seja concluído.

Implementar o modelo

Geralmente, depois de treinar um modelo, você revisaria seus detalhes de avaliação. Neste início rápido, você apenas implantará seu modelo e o disponibilizará para experimentar no Language Studio, ou poderá chamar a API de previsão.

Para implantar seu modelo a partir do Language Studio:

Selecione Implantando um modelo no menu do lado esquerdo.
Selecione Adicionar implantação para iniciar um novo trabalho de implantação.
Selecione Criar nova implantação para criar uma nova implantação e atribuir um modelo treinado na lista suspensa abaixo. Você também pode substituir uma implantação existente selecionando essa opção e selecionando o modelo treinado que deseja atribuir a ela na lista suspensa abaixo.

Nota

A substituição de uma implantação existente não requer alterações na chamada da API de previsão, mas os resultados obtidos serão baseados no modelo recém-atribuído.
Se você estiver conectando um ou mais aplicativos LUIS ou projetos de compreensão de linguagem conversacional, precisará especificar o nome da implantação.
- Nenhuma configuração é necessária para respostas a perguntas personalizadas ou intenções desvinculadas.
- Os projetos LUIS devem ser publicados no slot configurado durante a implantação do Orchestration, e os KBs de resposta a perguntas personalizadas também devem ser publicados em seus slots de produção.
Selecione Implantar para enviar seu trabalho de implantação
Depois que a implantação for bem-sucedida, uma data de expiração aparecerá ao lado dela. A expiração da implantação é quando o modelo implantado não estará disponível para ser usado para previsão, o que normalmente acontece doze meses após a expiração de uma configuração de treinamento.

Modelo de teste

Depois que o modelo for implantado, você poderá começar a usá-lo para fazer previsões por meio da API de Previsão. Para este início rápido, você usará o Language Studio para enviar um enunciado, obter previsões e visualizar os resultados.

Para testar o seu modelo a partir do Language Studio

Selecione Testando implantações no menu do lado esquerdo.
Selecione o modelo que deseja testar. Você só pode testar modelos atribuídos a implantações.
Na lista suspensa Nome da implantação, selecione o nome da implantação.
Na caixa de texto, insira um enunciado para testar.
No menu superior, selecione Executar o teste.
Depois de executar o teste, você verá a resposta do modelo no resultado. Você pode exibir os resultados na visualização de cartões de entidades ou visualizá-los no formato JSON.

Clean up resources (Limpar recursos)

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.

Pré-requisitos

Subscrição do Azure - Crie uma gratuitamente.

Criar um recurso de idioma a partir do portal do Azure

Criar um novo recurso a partir do portal do Azure

Vá para o portal do Azure para criar um novo recurso de linguagem de IA do Azure.
Selecione Continuar para criar seu recurso
Crie um recurso de idioma com os seguintes detalhes.

Detalhe da instância Valor obrigatório

País/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.

Detalhe da instância	Valor obrigatório
País/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.

Obtenha suas chaves de recursos e ponto de extremidade

Vá para a página de visão geral do recurso no portal do Azure.
No menu do lado esquerdo, selecione Teclas e Ponto de extremidade. Você usará o ponto de extremidade e a chave para as solicitações de API

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

Para este início rápido, conclua o início rápido da CLU para criar um projeto CLU a ser usado no fluxo de trabalho de orquestração.

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"
 }

Chave	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`

Criar o esquema

Depois de concluir o início rápido da CLU e criar um projeto de orquestração, a próxima etapa é adicionar intenções.

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"
      }
    ]
  }
}

Chave	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`

Preparar o modelo

Para treinar um modelo, você precisa começar um trabalho de treinamento. O resultado de um trabalho de treinamento bem-sucedido é o seu modelo treinado.

Crie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para enviar um trabalho de treinamento.

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}/:train?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.

Corpo do pedido

Use o seguinte objeto em sua solicitação. O modelo será nomeado MyModel assim que o treinamento for concluído.

{
  "modelLabel": "{MODEL-NAME}",
  "trainingMode": "standard",
  "trainingConfigVersion": "{CONFIG-VERSION}",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

Chave	Marcador de Posição	valor	Exemplo
`modelLabel`	`{MODEL-NAME}`	O nome do seu modelo.	`Model1`
`trainingMode`	`standard`	Modo de treino. Apenas um modo de treinamento está disponível em orquestração, que é `standard`.	`standard`
`trainingConfigVersion`	`{CONFIG-VERSION}`	A versão do modelo de configuração de treinamento. Por padrão, a versão mais recente do modelo é usada.	`2022-05-01`
`kind`	`percentage`	Métodos de divisão. Os valores possíveis são `percentage` ou `manual`. Veja como treinar um modelo para obter mais informações.	`percentage`
`trainingSplitPercentage`	`80`	Porcentagem dos dados marcados a serem incluídos no conjunto de treinamento. O valor recomendado é `80`.	`80`
`testingSplitPercentage`	`20`	Porcentagem dos dados marcados a serem incluídos no conjunto de testes. O valor recomendado é `20`.	`20`

Nota

O trainingSplitPercentage e testingSplitPercentage só são necessários se Kind for definido como percentage e a soma de ambas as percentagens deve ser igual a 100.

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}/train/jobs/{JOB-ID}?api-version={API-VERSION}

Você pode usar essa URL para obter o status do trabalho de treinamento.

Obter Estado do Treino

O treino pode demorar entre 10 e 30 minutos. Você pode usar a solicitação a seguir para continuar pesquisando o status do trabalho de treinamento até que ele seja concluído com êxito.

Use a seguinte solicitação GET para obter o status do progresso do treinamento do seu modelo. Substitua os valores de espaço reservado abaixo pelos seus próprios valores.

URL do Pedido

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

Marcador de Posição	valor	Exemplo
`{YOUR-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`
`{JOB-ID}`	O ID para localizar o status de treinamento do seu modelo. Isso está no valor do `location` cabeçalho que você recebeu quando enviou seu trabalho de treinamento.	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx`
`{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. Continue pesquisando este ponto de extremidade até que o parâmetro de status mude para "bem-sucedido".

{
  "result": {
    "modelLabel": "{MODEL-LABEL}",
    "trainingConfigVersion": "{TRAINING-CONFIG-VERSION}",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "xxxxxx-xxxxx-xxxxxx-xxxxxx",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Key	valor	Exemplo
`modelLabel`	O nome do modelo	`Model1`
`trainingConfigVersion`	A versão de configuração de treinamento. Por padrão, a versão mais recente é usada.	`2022-05-01`
`startDateTime`	O tempo de treinamento começou	`2022-04-14T10:23:04.2598544Z`
`status`	O estatuto do trabalho de formação	`running`
`estimatedEndDateTime`	Tempo estimado para a conclusão do trabalho de formação	`2022-04-14T10:29:38.2598544Z`
`jobId`	O seu ID de trabalho de formação	`xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx`
`createdDateTime`	Data e hora de criação de emprego de formação	`2022-04-14T10:22:42Z`
`lastUpdatedDateTime`	Data e hora da última atualização do trabalho de formação	`2022-04-14T10:23:45Z`
`expirationDateTime`	Data e hora de expiração do trabalho de treinamento	`2022-04-14T10:22:42Z`

Implementar o modelo

Geralmente, depois de treinar um modelo, você revisaria seus detalhes de avaliação. Neste início rápido, você apenas implantará seu modelo e chamará a API de previsão para consultar os resultados.

Enviar trabalho de implantação

Crie uma solicitação PUT usando a seguinte URL, cabeçalhos e corpo JSON para começar a implantar um modelo de fluxo de trabalho de orquestração.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-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`
`{DEPLOYMENT-NAME}`	O nome da sua implantação. Esse valor diferencia maiúsculas de minúsculas.	`staging`
`{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 do Pedido

{
  "trainedModelLabel": "{MODEL-NAME}",
}

Chave	Marcador de Posição	valor	Exemplo
trainedModelLabel	`{MODEL-NAME}`	O nome do modelo que será atribuído à sua implantação. Você só pode atribuir modelos treinados com sucesso. Esse valor diferencia maiúsculas de minúsculas.	`myModel`

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}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}

Você pode usar essa URL para obter o status do trabalho de implantação.

Obter o status do trabalho de implantação

Use a seguinte solicitação GET para obter o status do seu trabalho de implantação. Substitua os valores de espaço reservado abaixo pelos seus próprios valores.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?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`
`{DEPLOYMENT-NAME}`	O nome da sua implantação. Esse valor diferencia maiúsculas de minúsculas.	`staging`
`{JOB-ID}`	O ID para localizar o status de treinamento do seu modelo. Isso está no valor do `location` cabeçalho que você recebeu da API em resposta à sua solicitação de implantação de modelo.	`xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx`
`{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. Continue pesquisando este ponto de extremidade até que o parâmetro de status mude para "bem-sucedido".

{
    "jobId":"{JOB-ID}",
    "createdDateTime":"{CREATED-TIME}",
    "lastUpdatedDateTime":"{UPDATED-TIME}",
    "expirationDateTime":"{EXPIRATION-TIME}",
    "status":"running"
}

Modelo de consulta

Depois que o modelo for implantado, você poderá começar a usá-lo para fazer previsões por meio da API de previsão.

Quando a implantação for bem-sucedida, você poderá começar a consultar seu modelo implantado para obter previsões.

Crie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para começar a testar um modelo de fluxo de trabalho de orquestração.

URL do Pedido

{ENDPOINT}/language/:analyze-conversations?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`
`{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 do Pedido

{
  "kind": "Conversation",
  "analysisInput": {
    "conversationItem": {
      "text": "Text1",
      "participantId": "1",
      "id": "1"
    }
  },
  "parameters": {
    "projectName": "{PROJECT-NAME}",
    "deploymentName": "{DEPLOYMENT-NAME}",
    "directTarget": "qnaProject",
    "targetProjectParameters": {
      "qnaProject": {
        "targetProjectKind": "QuestionAnswering",
        "callingOptions": {
          "context": {
            "previousUserQuery": "Meet Surface Pro 4",
            "previousQnaId": 4
          },
          "top": 1,
          "question": "App Service overview"
        }
      }
    }
  }
}

Organismo de resposta

Depois de enviar o pedido, você receberá a seguinte resposta para a previsão!

{
  "kind": "ConversationResult",
  "result": {
    "query": "App Service overview",
    "prediction": {
      "projectKind": "Orchestration",
      "topIntent": "qnaTargetApp",
      "intents": {
        "qnaTargetApp": {
          "targetProjectKind": "QuestionAnswering",
          "confidenceScore": 1,
          "result": {
            "answers": [
              {
                "questions": [
                  "App Service overview"
                ],
                "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.",
                "confidenceScore": 0.7384000000000001,
                "id": 1,
                "source": "https://learn.microsoft.com/azure/app-service/overview",
                "metadata": {},
                "dialog": {
                  "isContextOnly": false,
                  "prompts": []
                }
              }
            ]
          }
        }
      }
    }
  }
}

Clean up resources (Limpar recursos)

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.

Próximos passos

Saiba mais sobre fluxos de trabalho de orquestração

Partilhar via

Guia de início rápido: fluxo de trabalho de orquestração

Pré-requisitos

Iniciar sessão no Language Studio

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

Criar o esquema

Preparar o modelo

Implementar o modelo

Modelo de teste

Clean up resources (Limpar recursos)

Pré-requisitos

Criar um recurso de idioma a partir do portal do Azure

Criar um novo recurso a partir do portal do Azure

Obtenha suas chaves de recursos e ponto de extremidade

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

URL do Pedido

Cabeçalhos

Corpo

Criar o esquema

URL do Pedido

Cabeçalhos

Corpo

Preparar o modelo

URL do Pedido

Cabeçalhos

Corpo do pedido

Obter Estado do Treino

URL do Pedido

Cabeçalhos

Organismo de resposta

Implementar o modelo

Enviar trabalho de implantação

URL do Pedido

Cabeçalhos

Corpo do Pedido

Obter o status do trabalho de implantação

URL do Pedido

Cabeçalhos

Organismo de resposta

Modelo de consulta

URL do Pedido

Cabeçalhos

Corpo do Pedido

Organismo de resposta

Clean up resources (Limpar recursos)

URL do Pedido

Cabeçalhos

Próximos passos

Comentários

Recursos adicionais