Implementar um modelo

Quando estiver satisfeito com o desempenho do seu modelo, ele estará pronto para ser implantado e interrogue-o para obter previsões de declarações. A implantação de um modelo o torna disponível para uso por meio da API de previsão.

Pré-requisitos

Para obter mais informações, consulteCiclo de vida de desenvolvimento do projeto.

Implementar o modelo

Depois de rever o desempenho do modelo e decidir que pode ser usado no seu ambiente, precisa de o atribuir a uma implementação para poder consultá-lo. A atribuição do modelo a uma implantação o torna disponível para uso por meio da API de previsão. Recomendamos criar uma implantação nomeada production à qual atribua o melhor modelo que tenha construído até agora e utilizá-lo no seu sistema. Você pode criar outra implantação chamada staging à qual você pode atribuir o modelo em que está trabalhando no momento para poder testá-la. Você pode ter um máximo de 10 implantações em seu projeto.

Enviar tarefa 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 compreensão de linguagem conversacional.

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 a 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.

Chave 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 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 o seu pedido de API, recebe uma 202 resposta a indicar sucesso. Nos cabeçalhos de resposta, extraia o valor operation-location 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 estado da tarefa de implementação

Quando se envia uma solicitação de implantação bem-sucedida, a URL completa da solicitação para verificar o estado da tarefa (incluindo o seu ponto de extremidade, o nome do projeto e o ID da tarefa) está contida no cabeçalho da operation-location resposta.

Use a seguinte solicitação GET para obter o status do seu trabalho de implantação. Substitua os valores de substituição por 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 a 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. 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 seu recurso. Usado para autenticar suas solicitações de API.

Organismo de resposta

Depois de enviar a solicitação, você receberá a seguinte resposta. Continue a interrogar este ponto de extremidade até que o parâmetro de status mude para "concluído".

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

Troca de implementações

Depois de concluir o teste de um modelo atribuído a uma implantação, convém atribuí-lo a outra implantação. A troca de implantações envolve:

  • Tomar o modelo atribuído à primeira implantação e atribuí-lo à segunda implantação.
  • pegar o modelo atribuído à segunda implantação e atribuí-lo à primeira implantação.

Por exemplo, pode trocar as suas production e staging quando quiser pegar no modelo atribuído a staging e atribuí-lo a production.

Crie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para iniciar uma tarefa de troca de implementações.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/deployments/:swap?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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 seu recurso. Usado para autenticar suas solicitações de API.

Corpo do Pedido

{
  "firstDeploymentName": "{FIRST-DEPLOYMENT-NAME}",
  "secondDeploymentName": "{SECOND-DEPLOYMENT-NAME}"
}
Chave Marcador de Posição valor Exemplo
nomePrimeiraImplementação {FIRST-DEPLOYMENT-NAME} O nome da sua primeira implantação. Esse valor diferencia maiúsculas de minúsculas. production
NomeDoSegundoDesdobramento {SECOND-DEPLOYMENT-NAME} O nome da sua segunda implementação. Esse valor diferencia maiúsculas de minúsculas. staging

Depois de enviar o seu pedido de API, recebe uma 202 resposta a indicar sucesso.

Excluir implantação

Crie uma solicitação DELETE usando a seguinte URL, cabeçalhos e corpo JSON para excluir uma implantação de compreensão de linguagem conversacional.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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 para 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.

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

Depois de enviar o seu pedido de API, recebe uma 202 resposta a indicar sucesso, o que significa que a sua implementação é eliminada.

Atribuir recursos de implantação

Você pode implantar seu projeto em várias regiões atribuindo diferentes recursos de idioma que existem em regiões diferentes.

A atribuição de recursos de implantação programaticamente requer autenticação do Microsoft Entra**. O Microsoft Entra ID é usado para confirmar que tem acesso aos recursos que pretende atribuir ao seu projeto para implementação multi-região. Para usar programáticamente a autenticação Microsoft Entra ao fazer chamadas REST API, consulte a documentação de autenticação do Foundry Tools.

Atribuir recurso

Envie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para atribuir recursos de implantação.

URL do Pedido

Use a seguinte URL ao criar sua solicitação de API. Substitua os valores de substituição por seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/resources/:assign?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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. 2022-10-01-preview

Cabeçalhos

Use autenticação do Microsoft Entra para autenticar esta API.

Corpo

Use o exemplo JSON seguinte como o seu conteúdo.

{
  "resourcesMetadata": [
    {
      "azureResourceId": "{AZURE-RESOURCE-ID}",
      "customDomain": "{CUSTOM-DOMAIN}",
      "region": "{REGION-CODE}"
    }
  ]
}
Chave Marcador de Posição valor Exemplo
azureResourceId {AZURE-RESOURCE-ID} O caminho de ID de recurso completo que você deseja atribuir. Pode ser encontrado no portal do Azure na guia Propriedades do recurso, dentro do campo ID do Recurso. /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource
customDomain {CUSTOM-DOMAIN} O subdomínio personalizado do recurso que você deseja atribuir. Encontrado no portal do Azure na guia Chaves e Ponto de Extremidade do recurso, que faz parte do campo Ponto de Extremidade na URL https://<your-custom-subdomain>.cognitiveservices.azure.com/ contosoresource
region {REGION-CODE} Um código de região que especifica a região do recurso que você deseja atribuir. Encontrado no portal do Azure na guia Chaves e Endpoint do recurso, como parte do campo Local/Região. eastus

Obter o status do recurso atribuído

Use a seguinte solicitação GET para obter o estado da sua tarefa de atribuição de recursos de implementação. Substitua os valores de substituição por seus próprios valores.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/resources/assign/jobs/{JOB-ID}?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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
{JOB-ID} O ID do trabalho para obter o status de implantação atribuído. Está no operation-location valor do cabeçalho que recebeste da API em resposta ao teu pedido de atribuição de recursos de implementação. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} A versão da API que você está chamando. 2022-10-01-preview

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave 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, recebe a seguinte resposta. Continue a interrogar este ponto de extremidade até que o parâmetro de status mude para "concluído".

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

Cancelar a atribuição de recursos de implantação

Ao desatribuir ou remover um recurso de implementação de um projeto, também se apagam todas as implementações que são implementadas na região do recurso.

Cancelar atribuição de recurso

Envie uma solicitação POST usando a seguinte URL, cabeçalhos e corpo JSON para cancelar a atribuição ou remover recursos de implantação do seu projeto.

URL do Pedido

Use a seguinte URL ao criar sua solicitação de API. Substitua os valores de substituição por seus próprios valores.

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/resources/:unassign?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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. 2022-10-01-preview

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

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

Corpo

Use o exemplo JSON seguinte como o seu conteúdo.

{
  "assignedResourceIds": [
    "{AZURE-RESOURCE-ID}"
  ]
}
Chave Marcador de Posição valor Exemplo
assignedResourceIds {AZURE-RESOURCE-ID} O caminho completo do ID de recurso que pretendes desassociar. Encontrado no portal do Azure na guia Propriedades do recurso como o campo ID do Recurso. /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/resourceGroups/ContosoResourceGroup/providers/Microsoft.CognitiveServices/accounts/ContosoResource

Obter o status de recurso não atribuído

Use o seguinte pedido GET para obter o estado da sua tarefa de liberação de recursos de implantação. Substitua os valores de substituição por seus próprios valores.

URL do Pedido

{ENDPOINT}/language/authoring/analyze-conversations/projects/{PROJECT-NAME}/resources/unassign/jobs/{JOB-ID}?api-version={API-VERSION}
Marcador de Posição valor Exemplo
{ENDPOINT} O ponto de extremidade para autenticar a 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
{JOB-ID} O ID do trabalho para obter o status de implantação atribuído. Está no valor do cabeçalho operation-location que recebeu da API em resposta ao seu pedido de desatribuição de recurso de implementação. xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
{API-VERSION} A versão da API que você está chamando. 2022-10-01-preview

Cabeçalhos

Use o cabeçalho a seguir para autenticar sua solicitação.

Chave 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, recebe a seguinte resposta. Continue a interrogar este ponto de extremidade até que o parâmetro de status mude para "concluído".

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

Próximos passos