Guia de início rápido: fluxo de trabalho de orquestração
Use este artigo para iniciar os projetos de fluxos de trabalho de orquestração usando o Language Studio e a API REST. Siga estas etapas para testar um exemplo.
Pré-requisitos
- Assinatura do Azure – crie uma gratuitamente.
- Um projeto para compreensão da linguagem coloquial.
Conectar ao Language Studio
Vá para o Language Studio e entre com sua conta do Azure.
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 Seu grupo de recursos do Azure. Nome do recurso do Azure Nome do seu recurso do Azure. Localização Um local válido para o recurso do Azure. Por exemplo, “Oeste dos EUA 2”. Tipo de preço Um tipo de preço com suporte para o recurso do Azure. Use a camada Gratuita (F0) para experimentar o serviç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. Um projeto é uma área de trabalho para a criação de modelos de ML personalizados com base em seus dados. Seu projeto só pode ser acessado por você e por outras pessoas que têm acesso ao recurso de idioma sendo usado.
Para este início rápido, conclua o início rápido de compreensão da linguagem coloquial para criar um projeto de compreensão da linguagem coloquial que será usado posteriormente.
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.
Criar esquema
Depois de concluir o início rápido da Compreensão da linguagem coloquial e criar um projeto de orquestração, a próxima etapa é adicionar intenções.
Para se conectar ao projeto de compreensão da linguagem coloquial criada anteriormente:
- Na página de esquema de build do seu projeto de orquestração, selecione Adicionar para adicionar uma intenção.
- Na janela exibida, dê um nome à intenção.
- Selecione Sim, quero conectá-la a um projeto existente.
- Na lista suspensa de serviços conectados, selecione Compreensão da linguagem coloquial.
- Na lista suspensa do nomes do projeto, selecione seu projeto de compreensão da linguagem coloquial.
- Selecione Adicionar intenção para criar sua intenção.
Treinar seu modelo
Para treinar um modelo, você precisa iniciar um trabalho de treinamento. A saída de um trabalho de treinamento bem-sucedido é seu modelo treinado.
Para começar a treinar o modelo no Language Studio:
Selecione Trabalhos de treinamento no menu à esquerda.
Selecione Iniciar um trabalho de treinamento no menu superior.
Selecione Treinar um novo modelo e digite o nome do modelo na caixa de texto. Também é possível substituir um modelo existente selecionando essa opção e escolhendo o modelo que você 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 os dados ao marcar os enunciados, verá duas opções de divisão de dados:
- Dividir automaticamente o conjunto de teste nos dados de treinamento: os enunciados marcados serão divididos aleatoriamente entre os conjuntos de treinamento e de teste, de acordo com os percentuais escolhidos. A divisão percentual padrão é de 80% para treinamento e 20% para teste. Para alterar esses valores, escolha o conjunto que deseja alterar e insira o novo valor.
Observação
Se você escolher a opção Dividir automaticamente o conjunto de testes nos dados de treinamento, somente os enunciados no conjunto de treinamento serão divididos de acordo com os percentuais fornecidos.
- 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.
Observação
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 marcação. Caso contrário, ela será desabilitada.
Selecione o botão Treinar.
Observação
- Somente os trabalhos de treinamento concluídos com êxito vão gerar modelos.
- O treinamento pode levar de alguns minutos a algumas horas, de acordo com o tamanho dos dados marcados.
- É possível ter um trabalho de treinamento em execução por vez. Não é possível iniciar outro trabalho de treinamento no mesmo projeto enquanto o trabalho em execução não for concluído.
Implantar o seu modelo
Geralmente, após treinar um modelo, você poderá examinar os detalhes da avaliação. Neste início rápido, você apenas implantará o modelo e o disponibilizará para ser experimentado no Language Studio ou você poderá chamar a API de previsão.
Para implantar o modelo por meio do Language Studio:
Selecione Implantar um modelo no menu à esquerda.
Selecione Adicionar implantação para iniciar um novo trabalho de implantação.
Selecione Criar implantação para criar uma 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 escolhendo o modelo treinado que deseja atribuir na lista suspensa abaixo.
Observação
A substituição de uma implantação existente não exige alterações na chamada à 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 da linguagem coloquial, será necessário especificar o nome da implantação.
Nenhuma configuração é necessária nas respostas às perguntas personalizadas ou intenções desvinculadas.
Os projetos LUIS devem ser publicados no slot configurado durante a implantação de orquestração, e os kbs de respostas às perguntas personalizadas também devem ser publicados em seus slots de produção.
Selecione Implantar para enviar o trabalho de implantação
Depois que a implantação for realizada com sucesso, uma data de validade será exibida. A expiração da implantação consiste no momento em que o modelo implantado não estará disponível para ser usado para previsão, o que normalmente acontece 12 meses após a expiração de uma configuração de treinamento.
Testar o modelo
Depois que o modelo for implantado, você poderá começar a usá-lo para fazer previsões por meio da API de Previsão. Neste início rápido, você usará o Language Studio para enviar um enunciado, obter previsões e visualizar os resultados.
Para testar seu modelo do Language Studio
Selecione Testar implantações no menu à esquerda.
Selecione o modelo que deseja testar. Você só pode testar modelos atribuídos a implantações.
Na lista suspensa de nome da implantação, selecione o nome da sua implantação.
Na caixa de texto, insira um enunciado para testar.
No menu superior, selecione Executar o teste.
Após executar o teste, você deverá ver a resposta do modelo no resultado. É possível exibir os resultados no modo de exibição de cartões de entidades ou então exibi-los no formato JSON.
Limpar os recursos
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.
Pré-requisitos
- Assinatura do Azure – crie uma gratuitamente.
Criar um recurso de linguagem pelo portal do Azure
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.
Obter suas chaves de recurso e ponto de extremidade
No portal do Azure, vá para a página de visão geral do recurso.
No menu do lado esquerdo, selecione Chaves 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
Após a criação de um recurso de linguagem, crie um projeto de fluxo de trabalho de orquestração. Um projeto é uma área de trabalho para a criação de modelos de ML personalizados com base em seus dados. Seu projeto só pode ser acessado por você e por outras pessoas que têm acesso ao recurso de idioma sendo usado.
Para este início rápido, conclua o início rápido da CLU para criar um projeto de CLU a ser usado no fluxo de trabalho de orquestração.
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 |
Criar 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 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 |
Treinar seu modelo
Para treinar um modelo, você precisa iniciar um trabalho de treinamento. A saída de um trabalho de treinamento bem-sucedido é seu modelo treinado.
Crie uma solicitação POST usando a URL, os cabeçalhos e o corpo JSON a seguir para enviar um trabalho de treinamento.
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}/:train?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. |
Corpo da solicitação
Use o seguinte objeto em sua solicitação. O modelo será nomeado MyModel
quando o treinamento for concluído.
{
"modelLabel": "{MODEL-NAME}",
"trainingMode": "standard",
"trainingConfigVersion": "{CONFIG-VERSION}",
"evaluationOptions": {
"kind": "percentage",
"testingSplitPercentage": 20,
"trainingSplitPercentage": 80
}
}
Chave | Espaço reservado | Valor | Exemplo |
---|---|---|---|
modelLabel |
{MODEL-NAME} |
O nome do seu Modelo. | Model1 |
trainingMode |
standard |
Modo de treinamento. Apenas um modo de treinamento está disponível na orquestração, que é standard . |
standard |
trainingConfigVersion |
{CONFIG-VERSION} |
A versão do modelo de configuração de treinamento. Por padrão, a versão do modelo mais recente do modelo é usada. | 2022-05-01 |
kind |
percentage |
Métodos de divisão. Os possíveis valores são percentage ou manual . Confira como treinar um modelo para obter mais informações. |
percentage |
trainingSplitPercentage |
80 |
Porcentual dos dados marcados a serem incluídos no conjunto de treinamentos. O valor recomendado é 80 . |
80 |
testingSplitPercentage |
20 |
Porcentual dos dados marcados a serem incluídos no conjunto de teste. O valor recomendado é 20 . |
20 |
Observação
trainingSplitPercentage
e testingSplitPercentage
serão necessários somente se Kind
for definido como percentage
, sendo que a soma de ambos os percentuais deverá ser igual a 100.
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}/train/jobs/{JOB-ID}?api-version={API-VERSION}
É possível usar essa URL para obter o status do trabalho de treinamento.
Obter Status de Treinamento
O treinamento pode levar entre dez e 30 minutos. Você pode usar a solicitação a seguir para continuar sondando 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 processo de treinamento do modelo. Substitua os valores dos espaços reservados abaixo pelos seus próprios valores.
URL da solicitação
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/train/jobs/{JOB-ID}?api-version={API-VERSION}
Espaço reservado | Valor | Exemplo |
---|---|---|
{YOUR-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 |
{JOB-ID} |
A ID para localização do status de treinamento do modelo. Isso está no valor de cabeçalho location recebido quando você 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.
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. Continue sondando esse 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"
}
Chave | Valor | Exemplo |
---|---|---|
modelLabel |
O nome do modelo | Model1 |
trainingConfigVersion |
A versão da configuração de treinamento. Por padrão, a versão mais recente é usada. | 2022-05-01 |
startDateTime |
A hora de início do treinamento | 2022-04-14T10:23:04.2598544Z |
status |
O status do trabalho de treinamento | running |
estimatedEndDateTime |
Tempo estimado para o término do trabalho de treinamento | 2022-04-14T10:29:38.2598544Z |
jobId |
ID do trabalho de treinamento | xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx |
createdDateTime |
Data e hora de criação do trabalho de treinamento | 2022-04-14T10:22:42Z |
lastUpdatedDateTime |
Data e hora da última atualização do trabalho de treinamento | 2022-04-14T10:23:45Z |
expirationDateTime |
Data e hora de validade do trabalho de treinamento | 2022-04-14T10:22:42Z |
Implantar o seu modelo
Geralmente, após treinar um modelo, você poderá examinar os detalhes da 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çãoPUT usando a URL, os cabeçalhos e o corpo JSON a seguir para começar a implantar um modelo do fluxo de trabalho de orquestração.
URL da solicitação
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-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 |
{DEPLOYMENT-NAME} |
O nome da 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.
Chave | Valor |
---|---|
Ocp-Apim-Subscription-Key |
A chave para o recurso. Usado para autenticação de suas solicitações de API. |
Corpo da solicitação
{
"trainedModelLabel": "{MODEL-NAME}",
}
Chave | Espaço reservado | Valor | Exemplo |
---|---|---|---|
trainedModelLabel | {MODEL-NAME} |
O nome do modelo que será atribuído à 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 ê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}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version={API-VERSION}
Use essa URL para obter o status do trabalho de implantação.
Obter status do trabalho de implantação
Use a solicitação GET a seguir para obter o status do trabalho de implantação. Substitua os valores dos espaços reservados abaixo pelos seus próprios valores.
URL da solicitação
{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?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 |
{DEPLOYMENT-NAME} |
O nome da implantação. Esse valor diferencia maiúsculas de minúsculas. | staging |
{JOB-ID} |
A ID para localização do status de treinamento do modelo. Encontre-a no valor de cabeçalho location que você recebeu da API em resposta à 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.
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. Continue sondando esse 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.
Se a implantação for bem-sucedida, você poderá começar a consultar seu modelo implantado para obter previsões.
Crie uma solicitaçãoPOST usando a URL, os cabeçalhos e o corpo JSON a seguir para começar a testar um modelo do fluxo de trabalho de orquestração.
URL da solicitação
{ENDPOINT}/language/:analyze-conversations?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 |
{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 solicitação
{
"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"
}
}
}
}
}
Corpo da resposta
Depois de enviar a solicitação, 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": []
}
}
]
}
}
}
}
}
}
Limpar os recursos
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.