Création d’API

Article
12/19/2023

L’API de création de réponses aux questions personnalisées est utilisée pour automatiser des tâches courantes telles que l’ajout de paires question/réponse, ainsi que la création, la publication et la maintenance de projets.

Remarque

La fonctionnalité de création est disponible via l’API REST et le Kit de développement logiciel (SDK) de création (préversion). Cet article fournit des exemples d’utilisation de l’API REST avec cURL. Pour obtenir une documentation complète sur l’ensemble des paramètres et fonctionnalités disponibles, consultez le contenu de la référence sur l’API REST.

Prérequis

Version actuelle de cURL. Plusieurs commutateurs de ligne de commande sont utilisés dans cet article, qui sont indiqués dans la documentation cURL.
Les commandes présentées dans cet article sont conçues pour être exécutées dans un interpréteur de commandes Bash. Elles ne fonctionneront pas toujours dans une invite de commandes Windows ou dans PowerShell sans modification. Si vous n’avez pas d’interpréteur de commandes Bash installé localement, vous pouvez utiliser l’environnement Bash d’Azure Cloud Shell.

Créer un projet

Pour créer un projet par programme :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. Si l’exemple précédent était votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`NEW-PROJECT-NAME`	Nom de votre nouveau projet de réponses aux questions personnalisées.

Vous pouvez également ajuster des valeurs supplémentaires telles que le langage du projet, la réponse par défaut donnée quand aucune réponse n’est trouvée, qui atteigne ou dépasse le seuil de confiance, et si cette ressource de langue prendra en charge plusieurs langues.

Exemple de requête

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'

Exemple de réponse

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

Supprime le projet

Pour supprimer un projet par programme :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. Si l’exemple précédent était votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez supprimer.

Exemple de requête

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'

Un appel réussi à la suppression d’un projet entraîne Operation-Location le retour d’un en-tête utilisable pour vérifier l’état du travail de suppression de projet. Dans la plupart de nos exemples, nous n’avons pas eu besoin d’examiner les en-têtes de réponse et ne les avons donc pas affichés. Pour récupérer les en-têtes de réponse utilisés, notre commande curl utilise -i. Sans ce paramètre précédant l’adresse du point de terminaison, la réponse à cette commande apparaîtrait vide comme s’il n’y avait aucune réponse.

Exemple de réponse

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

Si le projet a déjà été supprimé ou est introuvable, un message s’affiche, semblable à celui-ci :

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

Récupérer l’état de suppression du projet

Pour vérifier l’état de votre demande de suppression de projet :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet dont vous souhaitez vérifier l’état de déploiement.
`JOB-ID`	Lorsque vous supprimez un projet par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande de suppression. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deletion-jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse

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

Obtient les paramètres du projet

Pour récupérer des informations sur un projet donné, mettez à jour les valeurs suivantes dans la requête ci-dessous :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet sur lequel vous souhaitez récupérer des informations.

Exemple de requête


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'

Exemple de réponse

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

Obtenir les paires question-réponse

Pour récupérer les paires question-réponse et les informations associées pour un projet donné, mettez à jour les valeurs suivantes dans la requête ci-dessous :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet pour lequel vous souhaitez récupérer toutes les paires question-réponse.

Exemple de requête

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'

Exemple de réponse

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

Obtenir les sources

Pour récupérer les sources et les informations associées pour un projet donné, mettez à jour les valeurs suivantes dans la requête ci-dessous :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet sur lequel vous souhaitez récupérer toutes les informations sources.

Exemple de requête

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'

Exemple de réponse

{
    "200": {
      "headers": {},
      "body": {
        "value": [
          {
            "displayName": "source1",
            "sourceUri": "https://learn.microsoft.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"
          }
        ]
      }
    }
  }

Obtenir les synonymes

Pour récupérer les synonymes et les informations associées pour un projet donné, mettez à jour les valeurs suivantes dans la requête ci-dessous :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet pour lequel vous souhaitez récupérer des informations de synonymes.

Exemple de requête


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'

Exemple de réponse

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

Déployer le projet

Pour déployer un projet en production, mettez à jour les valeurs suivantes dans la requête ci-dessous :

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez déployer en production.

Exemple de requête

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'

Un appel réussi au déploiement d’un projet entraîne le retour d’un en-tête Operation-Location utilisable pour vérifier l’état du travail de déploiement de projet. Dans la plupart de nos exemples, nous n’avons pas eu besoin d’examiner les en-têtes de réponse et ne les avons donc pas affichés. Pour récupérer les en-têtes de réponse utilisés, notre commande curl utilise -i. Sans ce paramètre précédant l’adresse du point de terminaison, la réponse à cette commande apparaîtrait vide comme s’il n’y avait aucune réponse.

Exemple de réponse

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

Récupérer l’état de déploiement du projet

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet dont vous souhaitez vérifier l’état de déploiement.
`JOB-ID`	Lorsque vous déployez un projet par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande de déploiement. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/deployments/production/jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse

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

Exporter les métadonnées et ressources du projet

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez exporter.

Exemple de requête

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'

Exemple de réponse

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

Vérifier l’état de l’exportation

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet dont vous souhaitez vérifier l’état de l’exportation.
`JOB-ID`	Lorsque vous exportez un projet par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande d’exportation. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/export/jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse

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

Si vous essayez d’accéder directement à resultUrl, vous obtenez une erreur 404. Vous devez ajouter ?api-version=2021-10-01 au chemin d’accès pour le rendre accessible par une demande authentifiée : https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01

Importer le projet

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour l’importation.
`FILE-URI-PATH`	Lorsque vous exportez un projet par programme, puis vérifiez l’état de l’exportation, une `resultUrl` est générée dans la réponse. Par exemple : `"resultUrl": "https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result"`. Vous pouvez utiliser la resultUrl avec la version d’API ajoutée en tant fichier source à partir duquel importer un projet : `https://southcentralus.api.cognitive.microsoft.com:443/language/query-knowledgebases/projects/sample-proj1/export/jobs/{JOB-ID_GUID}/result?api-version=2021-10-01`.

Exemple de requête

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'

Un appel réussi à l’importation d’un projet entraîne le retour d’un en-tête Operation-Location utilisable pour vérifier l’état du travail d’importation. Dans bon nombre de nos exemples, nous n’avons pas eu besoin d’examiner les en-têtes de réponse et ne les avons donc pas affichés. Pour récupérer les en-têtes de réponse utilisés, notre commande curl utilise -i. Sans ce paramètre supplémentaire précédant l’adresse du point de terminaison, la réponse à cette commande apparaîtrait vide comme s’il n’y avait aucune réponse.

Exemple de réponse

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

Vérifier l'état de l'importation

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour l’importation.
`JOB-ID`	Lorsque vous importez un projet par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande d’exportation. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/import/jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse de requête

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

Répertorier les déploiements

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet pour lesquels vous souhaitez générer une liste de déploiement.

Exemple de requête

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'

Exemple de réponse

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

Répertorier les projets

Récupérez une liste de tous les projets de réponse aux questions auxquels votre compte a accès.

Nom de la variable Valeur

ENDPOINT Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : https://southcentralus.api.cognitive.microsoft.com/. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de southcentral spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.

API-KEY Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.

Exemple de requête

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'

Exemple de réponse

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

Mettre à jour les sources

Dans cet exemple, nous allons ajouter une nouvelle source à un projet existant. Vous pouvez également remplacer et supprimer des sources existantes à l’aide de cette commande en fonction du type d’opérations que vous transmettez dans le corps de votre requête.

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet dans lequel vous souhaitez mettre à jour des sources.
`METHOD`	PATCH

Exemple de requête

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'

Un appel réussi à la mise à jour d’une source entraîne le retour d’un en-tête Operation-Location utilisable pour vérifier l’état du travail d’importation. Dans bon nombre de nos exemples, nous n’avons pas eu besoin d’examiner les en-têtes de réponse et ne les avons donc toujours pas affichés. Pour récupérer les en-têtes de réponse utilisés, notre commande curl utilise -i. Sans ce paramètre précédant l’adresse du point de terminaison, la réponse à cette commande apparaîtrait vide comme s’il n’y avait aucune réponse.

Exemple de réponse

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

Obtenir l’état de mise à jour de la source

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour l’importation.
`JOB-ID`	Lorsque vous mettez à jour une source par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande de mise à jour de la source. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/sources/jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse

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

Mettre à jour les paires question-réponse

Dans cet exemple, nous allons ajouter une paire question-réponse à une source existante. Vous pouvez également modifier ou supprimer des paires question-réponse existantes avec cette requête en fonction de l’opération que vous transmettez dans le corps de la requête. Si vous n’avez pas de source nommée source5, cet exemple de requête échoue. Vous pouvez ajuster la valeur source dans le corps de la requête à une source existant pour votre projet cible.

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour l’importation.

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://learn.microsoft.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'

Un appel réussi à la mise à jour d’une paire question-réponse entraîne le retour d’un en-tête Operation-Location utilisable pour vérifier l’état du travail de mise à jour. Dans bon nombre de nos exemples, nous n’avons pas eu besoin d’examiner les en-têtes de réponse et ne les avons donc toujours pas affichés. Pour récupérer les en-têtes de réponse utilisés, notre commande curl utilise -i. Sans ce paramètre précédant l’adresse du point de terminaison, la réponse à cette commande apparaîtrait vide comme s’il n’y avait aucune réponse.

Exemple de réponse

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

Obtenir l’état de mise à jour des paires question-réponse

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour les mises à jour de paires question-réponse.
`JOB-ID`	Lorsque vous mettez à jour une paire question-réponse par programme, un `JOB-ID` est généré dans l’en-tête de réponse `operation-location` à la demande de mise à jour. Le `JOB-ID` est le GUID à la fin de l’`operation-location`. Par exemple : `operation-location: https://southcentralus.api.cognitive.microsoft.com/language/query-knowledgebases/projects/sample-proj1/qnas/jobs/{THIS GUID IS YOUR JOB ID}`

Exemple de requête

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'

Exemple de réponse

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

Mettre à jour les synonymes

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet auquel vous souhaitez ajouter des synonymes.

Exemple de requête

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'

Exemple de réponse

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

Mettre à jour les commentaires d’apprentissage actif

Nom de la variable	Valeur
`ENDPOINT`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. Voici un exemple de point de terminaison : `https://southcentralus.api.cognitive.microsoft.com/`. S’il s’agissait de votre point de terminaison dans l’exemple de code ci-dessous, vous devriez uniquement ajouter la portion de `southcentral` spécifique de la région, car le reste du chemin d’accès du point de terminaison est déjà présent.
`API-KEY`	Cette valeur se trouve dans la section Clés et point de terminaison quand vous examinez votre ressource à partir du portail Azure. Vous pouvez utiliser Key1 ou Key2. L’utilisation systématique de deux clés valides permet une rotation des clé sécurisée sans temps d’arrêt. Vous pouvez également trouver la valeur dans Language Studio>Réponses aux questions>Déployer un projet>Obtenir une URL de prédiction. La valeur de clé fait partie de l’exemple de demande.
`PROJECT-NAME`	Nom du projet que vous souhaitez définir comme destination pour les mises à jour de commentaires d’apprentissage actif.

Exemple de requête

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'

Exemple de réponse

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

Share via

Création d’API

Prérequis

Créer un projet

Exemple de requête

Exemple de réponse

Supprime le projet

Exemple de requête

Exemple de réponse

Récupérer l’état de suppression du projet

Exemple de requête

Exemple de réponse

Obtient les paramètres du projet

Exemple de requête

Exemple de réponse

Obtenir les paires question-réponse

Exemple de requête

Exemple de réponse

Obtenir les sources

Exemple de requête

Exemple de réponse

Obtenir les synonymes

Exemple de requête

Exemple de réponse

Déployer le projet

Exemple de requête

Exemple de réponse

Récupérer l’état de déploiement du projet

Exemple de requête

Exemple de réponse

Exporter les métadonnées et ressources du projet

Exemple de requête

Exemple de réponse

Vérifier l’état de l’exportation

Exemple de requête

Exemple de réponse

Importer le projet

Exemple de requête

Exemple de réponse

Vérifier l'état de l'importation

Exemple de requête

Exemple de réponse de requête

Répertorier les déploiements

Exemple de requête

Exemple de réponse

Répertorier les projets

Exemple de requête

Exemple de réponse

Mettre à jour les sources

Exemple de requête

Exemple de réponse

Obtenir l’état de mise à jour de la source

Exemple de requête

Exemple de réponse

Mettre à jour les paires question-réponse

Exemple de réponse

Obtenir l’état de mise à jour des paires question-réponse

Exemple de requête

Exemple de réponse

Mettre à jour les synonymes

Exemple de requête

Exemple de réponse

Mettre à jour les commentaires d’apprentissage actif

Exemple de requête

Exemple de réponse

Ressources supplémentaires