Spécification d'un ID client

Pour associer un ID client aux données, incluez l'en-tête X-Watson-Metadata dans la demande qui transmet les informations. Vous transmettez la chaîne customer_id={id} en tant qu'argument de l'en-tête. L'exemple suivant associe l'ID client my_customer_ID aux données transmises avec une demande POST /v1/synthesize :

IBM Cloud

curl -X POST -u "apikey:{apikey}" \
--header "X-Watson-Metadata: customer_id=my_customer_ID" \
--header "Content-Type: application/json" \
--header "Accept: audio/wav" \
--data "{\"text\":\"hello world\"}" \
--output hello_world.wav \
"{url}/v1/synthesize"

IBM Cloud Pak for Data IBM Software Hub

curl -X POST \
--header "Authorization: Bearer {token}"\
--header "X-Watson-Metadata: customer_id=my_customer_ID" \
--header "Content-Type: application/json" \
--header "Accept: audio/wav" \
--data "{\"text\":\"hello world\"}" \
--output hello_world.wav \
"{url}/v1/synthesize"

Un ID client peut inclure tous les caractères à l'exception du point-virgule (;) et du signe égal (=). Spécifiez une chaîne aléatoire ou générique pour l'ID client. Ne spécifiez pas une chaîne contenant des renseignements personnels identifiables, comme une adresse e-mail ou un ID Twitter, par exemple. Vous pouvez spécifiez différents ID client avec différentes demandes. Un ID client que vous spécifiez est associé à l'instance du service dont les données d'identification sont utilisées avec la demande ; seules les données d'identification de cette instance du service peuvent supprimer les données associées à l'ID.

Utilisez l'en-tête X-Watson-Metadata avec les méthodes suivantes :

• Avec les demandes HTTP :

  • POST /v1/synthesize
  • GET /v1/synthesize

  L'ID client est associé aux données envoyées avec la demande.

• Avec les demandes WebSocket :

  • /v1/synthesize

  Vous spécifiez l'ID client avec le paramètre de requête x-watson-metadata pour associer l'ID aux données envoyées avec la demande. Vous devez coder l'argument dans le paramètre de requête en codage URL, par exemple, customer_id%3dmy_customer_ID.

• Avec les demandes d'ajout de mots personnalisés à des modèles personnalisés :

  • POST /v1/customizations/{customization_id}
  • POST /v1/customizations/{customization_id}/words
  • PUT /v1/customizations/{customization_id}/words/{word}

  L'ID client est associé aux mots personnalisés ajoutés ou mis à jour par la demande.

Suppression de données

Pour supprimer toutes les données associées à un ID client, utilisez la méthode DELETE /v1/user_data. Vous transmettez la chaîne customer_id={id} en tant que paramètre de requête avec la demande. L'exemple suivant supprime toutes les données de l'ID client my_customer_ID :

IBM Cloud

curl -X DELETE -u "apikey:{apikey}" \
"{url}/v1/user_data?customer_id=my_customer_ID"

IBM Cloud Pak for Data IBM Software Hub

curl -X DELETE \
--header "Authorization: Bearer {token}" \
"{url}/v1/user_data?customer_id=my_customer_ID"

La méthode /v1/user_data supprime toutes les données associées à l'ID client spécifié, quelle que soit la méthode utilisée pour ajouter les informations. La méthode n'a aucun effet si aucune donnée n'est associée à l'ID client. Vous devez émettre la demande avec les données d'identification de l'instance du service ayant servi à associer l'ID client aux données.