API de Criação

  • Artigo

A API de Criação de respostas a perguntas personalizadas é usada para automatizar tarefas comuns, como adicionar novos pares de respostas a perguntas, bem como criar, publicar e manter projetos.

Nota

A funcionalidade de criação está disponível por meio da API REST e do SDK de Criação (visualização). Este artigo fornece exemplos de como usar a API REST com cURL. Para obter a documentação completa de todos os parâmetros e funcionalidades disponíveis, consulte o conteúdo de referência da API REST.

Pré-requisitos

  • A versão atual do cURL. Várias opções de linha de comando são usadas neste artigo, que são anotadas na documentação do cURL.
  • Os comandos neste artigo foram projetados para serem executados em um shell Bash. Esses comandos nem sempre funcionarão em um prompt de comando do Windows ou no PowerShell sem modificação. Se você não tiver um shell Bash instalado localmente, poderá usar o ambiente bash do Azure Cloud Shell.

Criar um projeto

Para criar um projeto programaticamente:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo a>Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se o exemplo anterior fosse seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo a>Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
NEW-PROJECT-NAME O nome do seu novo projeto personalizado de resposta a perguntas.

Você também pode ajustar valores adicionais, como o idioma do projeto, a resposta padrão dada quando nenhuma resposta pode ser encontrada que atenda ou exceda o limite de confiança e se esse recurso de idioma suportará vários idiomas.

Exemplo de consulta

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "description": "proj1 is a test project.",
      "language": "en",
      "settings": {
        "defaultAnswer": "No good match found for your question in the project."
      },
      "multilingualResource": true
    }
  }'  'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{NEW-PROJECT-NAME}?api-version=2021-10-01'

Resposta de exemplo

{
 "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "multilingualResource": true,
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
 }
}

Excluir projeto

Para excluir um projeto programaticamente:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se o exemplo anterior fosse seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de excluir.

Exemplo de consulta

curl -X DELETE -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

Uma chamada bem-sucedida para excluir um projeto resulta em um Operation-Location cabeçalho sendo retornado, que pode ser usado para verificar o status do trabalho de projeto de exclusão. Na maioria dos nossos exemplos, não precisamos olhar para os cabeçalhos de resposta e, portanto, não os exibimos. Para recuperar os cabeçalhos de resposta, nosso comando curl usa -i. Sem esse parâmetro antes do endereço do ponto final, a resposta a esse comando apareceria vazia como se nenhuma resposta ocorresse.

Resposta de exemplo

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 324
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:56:18 GMT

Se o projeto já foi excluído ou não pôde ser encontrado, você receberá uma mensagem como:

{
  "error": {
    "code": "ProjectNotFound",
    "message": "The specified project was not found.",
    "details": [
      {
        "code": "ProjectNotFound",
        "message": "{GUID}"
      }
    ]
  }
}

Obter status de exclusão do projeto

Para verificar o status da sua solicitação de projeto de exclusão:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo a>Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de verificar no status da implantação.
JOB-ID Quando você exclui um projeto programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de operation-location exclusão. O JOB-ID é o guid no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/deletion-jobs/{JOB-ID}?api-version=2021-10-01'

Resposta de exemplo

{
  "createdDateTime": "2021-11-23T20:56:18+00:00",
  "expirationDateTime": "2021-11-24T02:56:18+00:00",
  "jobId": "GUID",
  "lastUpdatedDateTime": "2021-11-23T20:56:18+00:00",
  "status": "succeeded"
}

Obter configurações do projeto

Para recuperar informações sobre um determinado projeto, atualize os seguintes valores na consulta abaixo:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto sobre o qual você gostaria de recuperar informações.

Exemplo de consulta


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}?api-version=2021-10-01'

Resposta de exemplo

 {
    "200": {
      "headers": {},
      "body": {
        "projectName": "proj1",
        "description": "proj1 is a test project.",
        "language": "en",
        "settings": {
          "defaultAnswer": "No good match found for your question in the project."
        },
        "createdDateTime": "2021-05-01T15:13:22Z",
        "lastModifiedDateTime": "2021-05-01T15:13:22Z",
        "lastDeployedDateTime": "2021-05-01T15:13:22Z"
      }
    }
  }

Obter pares de respostas a perguntas

Para recuperar pares de respostas a perguntas e informações relacionadas para um determinado projeto, atualize os seguintes valores na consulta abaixo:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto para o qual você gostaria de recuperar todos os pares de perguntas e respostas.

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

Resposta de exemplo

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "id": 1,
            "answer": "ans1",
            "source": "source1",
            "questions": [
              "question 1.1",
              "question 1.2"
            ],
            "metadata": {
              "k1": "v1",
              "k2": "v2"
            },
            "dialog": {
              "isContextOnly": false,
              "prompts": [
                {
                  "displayOrder": 1,
                  "qnaId": 11,
                  "displayText": "prompt 1.1"
                },
                {
                  "displayOrder": 2,
                  "qnaId": 21,
                  "displayText": "prompt 1.2"
                }
              ]
            },
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          },
          {
            "id": 2,
            "answer": "ans2",
            "source": "source2",
            "questions": [
              "question 2.1",
              "question 2.2"
            ],
            "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
          }
        ]
      }
    }
  }

Obter fontes

Para recuperar as fontes e informações relacionadas para um determinado projeto, atualize os seguintes valores na consulta abaixo:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto para o qual você gostaria de recuperar todas as informações de origem.

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT_NAME}/sources?api-version=2021-10-01'

Resposta de exemplo

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "displayName": "source1",
            "sourceUri": "https://video2.skills-academy.com/azure/ai-services/qnamaker/overview/overview",
            "sourceKind": "url",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          },
          {
            "displayName": "source2",
            "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf",
            "sourceKind": "file",
            "contentStructureKind": "unstructured",
            "lastUpdatedDateTime": "2021-05-01T15:13:22Z"
          }
        ]
      }
    }
  }

Obter sinónimos

Para recuperar sinônimos e informações relacionadas para um determinado projeto, atualize os seguintes valores na consulta abaixo:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto para o qual você gostaria de recuperar informações de sinônimo.

Exemplo de consulta


curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

Resposta de exemplo

 {
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "alterations": [
              "qnamaker",
              "qna maker"
            ]
          },
          {
            "alterations": [
              "botframework",
              "bot framework"
            ]
          }
        ]
      }
    }
  }

Implantar projeto

Para implantar um projeto na produção, atualize os seguintes valores na consulta abaixo:

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de implantar na produção.

Exemplo de consulta

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production?api-version=2021-10-01'

Uma chamada bem-sucedida para implantar um projeto resulta em um Operation-Location cabeçalho sendo retornado que pode ser usado para verificar o status do trabalho de implantação. Na maioria dos nossos exemplos, não precisamos olhar para os cabeçalhos de resposta e, portanto, não os exibimos. Para recuperar os cabeçalhos de resposta, nosso comando curl usa -i. Sem esse parâmetro antes do endereço do ponto final, a resposta a esse comando apareceria vazia como se nenhuma resposta ocorresse.

Resposta de exemplo

0HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 31
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 20:35:00 GMT

Obter o status de implantação do projeto

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de verificar no status da implantação.
JOB-ID Quando você implanta um projeto programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de operation-location implantação. O JOB-ID é o guid no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments/production/jobs/{JOB-ID}?api-version=2021-10-01'

Resposta de exemplo

    {
    "200": {
      "headers": {},
      "body": {
        "errors": [],
        "createdDateTime": "2021-05-01T17:21:14Z",
        "expirationDateTime": "2021-05-01T17:21:14Z",
        "jobId": "{JOB-ID-GUID}",
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "status": "succeeded"
      }
    }
  }

Exportar metadados e ativos do projeto

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de exportar.

Exemplo de consulta

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{exportAssetTypes": ["qnas","synonyms"]}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:export?api-version=2021-10-01&format=tsv'

Resposta de exemplo

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/export/jobs/{JOB-ID_GUID}
x-envoy-upstream-service-time: 214
apim-request-id:
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Tue, 23 Nov 2021 21:24:03 GMT

Verificar o estado de exportação

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de verificar no status de exportação.
JOB-ID Quando você exporta operation-location um projeto programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de exportação. O JOB-ID é o guid no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID}?api-version=2021-10-01'

Resposta de exemplo

{
  "createdDateTime": "2021-11-23T21:24:03+00:00",
  "expirationDateTime": "2021-11-24T03:24:03+00:00",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-11-23T21:24:08+00:00",
  "status": "succeeded",
  "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"
}

Se você tentar acessar o resultUrl diretamente, você receberá um erro 404. Você deve anexar ?api-version=2021-10-01 ao caminho para torná-lo acessível por uma solicitação autenticada: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Importar projeto

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino da importação.
FILE-URI-PATH Quando você exporta um projeto programaticamente e, em seguida, verifica o status da exportação a resultUrl é gerada como parte da resposta. Por exemplo: "resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result" você pode usar o resultUrl com a versão da API anexada como um arquivo de origem para importar um projeto de: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01.

Exemplo de consulta

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
      "fileUri": "FILE-URI-PATH"
  }' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/:import?api-version=2021-10-01&format=tsv'

Uma chamada bem-sucedida para importar um projeto resulta em um Operation-Location cabeçalho sendo retornado, que pode ser usado para verificar o status do trabalho de importação. Em muitos dos nossos exemplos, não precisávamos olhar para os cabeçalhos de resposta e, portanto, não os exibimos. Para recuperar os cabeçalhos de resposta, nosso comando curl usa -i. Sem esse parâmetro adicional antes do endereço do ponto final, a resposta a esse comando apareceria vazia como se nenhuma resposta ocorresse.

Resposta de exemplo

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/import/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 417
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 00:35:11 GMT

Verificar o status da importação

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino da importação.
JOB-ID Quando você importa um projeto programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de operation-location exportação. O JOB-ID é o GUID no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME/import/jobs/{JOB-ID-GUID}?api-version=2021-10-01'

Exemplo de resposta de consulta

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "JOB-ID-GUID",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

Listar implantações

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto para o qual você gostaria de gerar uma lista de implantação.

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/deployments?api-version=2021-10-01'

Resposta de exemplo

[
  {
    "deploymentName": "production",
    "lastDeployedDateTime": "2021-10-26T15:12:02Z"
  }
]

Listar Projetos

Recupere uma lista de todos os projetos de resposta a perguntas aos quais sua conta tem acesso.

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects?api-version=2021-10-01'

Resposta de exemplo

{
  "value": [
    {
      "projectName": "Sample-project",
      "description": "My first question answering project",
      "language": "en",
      "multilingualResource": false,
      "createdDateTime": "2021-10-07T04:51:15Z",
      "lastModifiedDateTime": "2021-10-27T00:42:01Z",
      "lastDeployedDateTime": "2021-11-24T01:34:18Z",
      "settings": {
        "defaultAnswer": "No good match found in KB"
      }
    }
  ]
}

Fontes de atualização

Neste exemplo, adicionaremos uma nova fonte a um projeto existente. Você também pode substituir e excluir fontes existentes com esse comando, dependendo do tipo de operações que você passa como parte do corpo da consulta.

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto onde você gostaria de atualizar fontes.
METHOD PATCH

Exemplo de consulta

curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
  {
    "op": "add",
    "value": {
      "displayName": "source5",
      "sourceKind": "url",
      "sourceUri": "https://download.microsoft.com/download/7/B/1/7B10C82E-F520-4080-8516-5CF0D803EEE0/surface-book-user-guide-EN.pdf",
      "sourceContentStructureKind": "semistructured"
    }
  }
]'  -i '{LanguageServiceName}.cognitiveservices.azure.com//language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01'

Uma chamada bem-sucedida para atualizar uma fonte resulta em um Operation-Location cabeçalho sendo retornado que pode ser usado para verificar o status do trabalho de importação. Em muitos dos nossos exemplos, não precisávamos olhar para os cabeçalhos de resposta e, portanto, nem sempre os exibimos. Para recuperar os cabeçalhos de resposta, nosso comando curl usa -i. Sem esse parâmetro antes do endereço do ponto final, a resposta a esse comando apareceria vazia como se nenhuma resposta ocorresse.

Resposta de exemplo

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/sources/jobs/{JOB_ID_GUID}
x-envoy-upstream-service-time: 412
apim-request-id: dda23d2b-f110-4645-8bce-1a6f8d504b33
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 02:47:53 GMT

Obter o status da fonte de atualização

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo a>Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino da importação.
JOB-ID Quando você atualiza uma fonte programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de fonte de operation-location atualização. O JOB-ID é o GUID no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/sources/jobs/{JOB-ID}?api-version=2021-10-01'

Resposta de exemplo

{
  "createdDateTime": "2021-11-24T02:47:53+00:00",
  "expirationDateTime": "2021-11-24T08:47:53+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T02:47:56+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"
}

Atualizar pares de perguntas e respostas

Neste exemplo, adicionaremos um par de respostas a perguntas a uma fonte existente. Você também pode modificar ou excluir pares de respostas de perguntas existentes com essa consulta, dependendo da operação passada no corpo da consulta. Se você não tiver uma fonte nomeada source5, esta consulta de exemplo falhará. Você pode ajustar o valor de origem no corpo da consulta para uma fonte que existe para seu projeto de destino.

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino da importação. 
curl -X PATCH -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '[
    {
        "op": "add",
        "value":{
            "id": 1,
            "answer": "The latest question answering docs are on https://video2.skills-academy.com",
            "source": "source5",
            "questions": [
                "Where do I find docs for question answering?"
            ],
            "metadata": {},
            "dialog": {
                "isContextOnly": false,
                "prompts": []
            }
        }
    }
]'  -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas?api-version=2021-10-01'

Uma chamada bem-sucedida para atualizar um par de perguntas e respostas resulta no retorno de um Operation-Location cabeçalho que pode ser usado para verificar o status do trabalho de atualização. Em muitos dos nossos exemplos, não precisávamos olhar para os cabeçalhos de resposta e, portanto, nem sempre os exibimos. Para recuperar os cabeçalhos de resposta, nosso comando curl usa -i. Sem esse parâmetro antes do endereço do ponto final, a resposta a esse comando apareceria vazia como se nenhuma resposta ocorresse.

Resposta de exemplo

HTTP/2 202
content-length: 0
operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/Sample-project/qnas/jobs/{JOB-ID-GUID}
x-envoy-upstream-service-time: 507
apim-request-id: 
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:16:01 GMT

Obter status de pares de respostas a perguntas atualizadas

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino para as atualizações de pares de respostas à pergunta.
JOB-ID Quando você atualiza um par de respostas a perguntas programaticamente, um JOB-ID é gerado como parte do cabeçalho de resposta à solicitação de operation-location atualização. O JOB-ID é o GUID no final do operation-location. Por exemplo: operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}

Exemplo de consulta

curl -X GET -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '' 'https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/qnas/jobs/{JOB-ID}?api-version=2021-10-01'

Resposta de exemplo

  "createdDateTime": "2021-11-24T03:16:01+00:00",
  "expirationDateTime": "2021-11-24T09:16:01+00:00",
  "jobId": "{JOB-ID-GUID}",
  "lastUpdatedDateTime": "2021-11-24T03:16:06+00:00",
  "status": "succeeded",
  "resultUrl": "/knowledgebases/Sample-project"

Atualizar sinónimos

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de adicionar sinônimos.

Exemplo de consulta

curl -X PUT -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
"value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/synonyms?api-version=2021-10-01'

Resposta de exemplo

0HTTP/2 200
content-length: 17
content-type: application/json; charset=utf-8
x-envoy-upstream-service-time: 39
apim-request-id: 5deb2692-dac8-43a8-82fe-36476e407ef6
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 03:59:09 GMT

{
  "value": []
}

Atualizar feedback de aprendizagem ativa

Nome da variável Valor
ENDPOINT Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. Um exemplo de ponto de extremidade é: https://southcentralus.api.cognitive.microsoft.com/. Se este fosse o seu ponto de extremidade no exemplo de código abaixo, você só precisaria adicionar a parte específica da southcentral região, pois o restante do caminho do ponto de extremidade já está presente.
API-KEY Este valor pode ser encontrado na secção Chaves e Ponto Final ao examinar o recurso no portal do Azure. Você pode usar Key1 ou Key2. Sempre ter duas chaves válidas permite uma rotação segura de chaves com zero tempo de inatividade. Como alternativa, você pode encontrar o valor na pergunta do Language Studio>respondendo>a Implantar projeto>Obter URL de previsão. O valor da chave faz parte da solicitação de exemplo.
PROJECT-NAME O nome do projeto que você gostaria de ser o destino para as atualizações de feedback de aprendizagem ativa.

Exemplo de consulta

curl -X POST -H "Ocp-Apim-Subscription-Key: {API-KEY}" -H "Content-Type: application/json" -d '{
records": [
    {
      "userId": "user1",
      "userQuestion": "hi",
      "qnaId": 1
    },
    {
      "userId": "user1",
      "userQuestion": "hello",
      "qnaId": 2
    }
  ]
}' -i 'https://{ENDPOINT}.api.cognitive.microsoft.com/language/query-knowledgebases/projects/{PROJECT-NAME}/feedback?api-version=2021-10-01'

Resposta de exemplo

HTTP/2 204
x-envoy-upstream-service-time: 37
apim-request-id: 92225e03-e83f-4c7f-b35a-223b1b0f29dd
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-content-type-options: nosniff
date: Wed, 24 Nov 2021 04:02:56 GMT