Gestion des versions d'API du service

Les demandes d'API nécessitent un paramètre de version qui prend une date au format version=YYYY-MM-DD. Chaque fois qu'une modification d'API incompatible avec les versions antérieures se produit, une nouvelle version mineure de l'API est publiée.

Envoyez le paramètre de version avec chaque demande d'API. Le service utilise la version d'API correspondant à la date que vous spécifiez ou la toute dernière version avant cette date. Ne laissez pas la date du jour par défaut. Indiquez à la place une date correspondant à une version compatible avec votre application et ne la changez pas tant que votre application n'est pas prête pour une version ultérieure.

La version actuelle est 2023-03-31.

Obtention de l'ID de votre projet IBM Cloud

Ces informations s'appliquent à IBM Cloud uniquement.

Pour utiliser l'API, vous devez construire l' URL e à utiliser dans vos requêtes. De nombreuses méthodes d'API requièrent l'ID de projet.

1. Dans la IBM Cloud, développez AI/Machine Learning, puis recherchez la page de service pour votre instance de service Discovery.

2. Dans la section Credentials, copiez l' URL. Vous spécifiez cette valeur en tant que {url} dans vos demandes d'API.

3. Lorsque vous êtes sur cette page, copiez la clé d'API. Vous spécifiez cette valeur comme l' {apikey}.

4. Ouvrez votre projet dans Discovery, puis accédez à la page Intégrer et déployer > Informations sur l'API.

5. Copiez l'ID de projet. Vous spécifiez cette valeur comme l' {project_id}.

   Si vous utilisez un projet Content Mining, restez sur la page Partager le lien. Dans la zone location du navigateur Web, copiez l' URL commençant par /projects. Par exemple, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. L'ID spécifié après le segment /projects/ de l' URL est votre ID de projet.

6. Construisez une requête URL en utilisant les identifiants que vous avez copiés.

   Par exemple, la demande suivante répertorie les collections du projet:

   curl -X {request_method} -u "apikey:{apikey}" \
   "{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"
   

Pour obtenir le {collection_id}, vous pouvez utiliser la méthode d'API List collections. Vous pouvez également ouvrir la collection dans l'interface utilisateur du produit, puis copier l'ID collection, qui s'affiche après le segment /collections/ de la page URL, à partir de la zone d'emplacement du navigateur Web.

Utilisation de l'API IBM Cloud Pak for DataIBM Software Hub

Ces informations s'appliquent à Discovery for Cloud Pak for Data uniquement.

Pour utiliser l'API, vous devez construire l' URL e à utiliser dans vos requêtes.

1. Dans le menu principal du client Web, développez Services, puis cliquez sur Instances.

2. Recherchez votre instance, puis cliquez dessus pour ouvrir sa page récapitulative.

3. Accédez à la section Informations d'accès de la page, puis copiez l' URL. Vous spécifiez cette valeur comme {url}.

4. Copiez également le jeton bearer. Vous devez le transmettre lors d'un appel d'API.

5. A partir de l'instance d'application lancée, accédez à la page Intégrer et déployer > Informations sur l'API.

6. Copiez l'ID de projet. Vous spécifierez cette valeur en tant qu' {project_id}.

   Si vous utilisez un projet Content Mining, restez sur la page Partager le lien. Dans la zone location du navigateur Web, copiez l' URL commençant par /projects. Par exemple, projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta. L'ID spécifié après le segment /projects/ de l' URL est votre ID de projet.

7. Construisez une requête URL en utilisant les identifiants que vous avez copiés.

   Par exemple, la demande suivante répertorie les collections du projet:

   curl -H "Authorization: Bearer {token}" \
   "{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"
   

Le jeton bearer généré pour un administrateur peut accéder à n'importe quelle instance quels que soient les paramètres d'accès configurés pour l'instance.

Le jeton porteur expire après 12 heures. Pour plus d'informations sur la personnalisation de la longueur d'une session, voir Définition du délai d'inactivité de la session.

Etapes suivantes

Un développeur peut apporter les améliorations suivantes:

• Utilisez l'API pour définir des requêtes plus complexes avec le langage de requête de reconnaissance.
• Indiquez le document exact à renvoyer en réponse à une requête spécifique avec des curations.
• Traitez les documents sans les stocker dans une collection en utilisant l'API Analyze.
• Envoyez un événement de webhook lorsque le statut des documents ingérés devient available ou failed à l'aide de l'API de webhook de statut de document.