US
FR
Nous Contacter

Appels d'API

1. Description

Une fois que vous avez terminé les étapes de l'introduction au SDK d'Alteia pour les développeurs‍, vous êtes prêt à utiliser le SDK. Vous trouverez ci-dessous une liste des lignes de commande possibles avec leur utilisation prévue. Pour plus d'informations sur chaque appel, consultez la documentation de référence de l'API.

2. Liste de Commandes

Obtenir tous les projets disponibles

>>> projects = sdk.projects.search(limit=100)

Obtenir les missions d'un projet

>>> my_project = sdk.projects.search(filter={'name': {'$eq': 'My_project'}})[0]
>>> missions = sdk.missions.search(filter={'project': {'$eq': my_project.id}})

Rechercher des jeux de données liés à une mission

>>> my_mission = missions[0]
>>> datasets = sdk.datasets.search(filter={'mission': {'$eq': my_mission.id}})

Explorer les propriétés d'un jeu de données

Pour imprimer certaines propriétés d'un jeu de données:

>>> my_dataset = datasets[0]
>>> print("Name: {}".format(my_dataset.name))
>>> print("Type: {}".format(my_dataset.type))
>>> print("Creation date: {}".format(my_dataset.creation_date))

Certaines propriétés des jeux de données dépendent de leur type (image, raster, mesh, pcl, vector, file). Vous pouvez lister toutes les propriétés disponibles pour un jeu de données avec:

>>> dir(my_dataset)

Pour rechercher les fichiers liés à un jeu de données, vous pouvez lister les composants du jeu de données:

print(my_dataset.components)

Télécharger un composant de jeu de données

Pour télécharger un composant de jeu de données dans le répertoire actuel:

>>> component = my_dataset.components[0]
>>> sdk.datasets.download_component(dataset=my_dataset.id,
...                                 component=component.get("name"))

Créer un nouveau jeu de données

Pour créer un nouveau jeu de données de fichiers lié à un projet:

>>> new_dataset = sdk.datasets.create_file_dataset(name='My file dataset',
...                                                project=my_project.id)

Et télécharger un fichier:

>>> file_to_upload = "/replace/with/a/file_path.ext"
>>> sdk.datasets.upload_file(dataset=new_dataset.id,
...                          component='file',
...                          file_path=file_to_upload)

Ajouter un tag

Pour ajouter un tag sur le jeu de données créé:

>>> my_tag = sdk.tags.create(name='My tag',
...                          project=my_project.id,
...                          type='dataset',
...                          target=new_dataset.id)

Pour supprimer le tag:

>>> sdk.tags.delete(my_tag.id)

Ajouter un commentaire

Pour ajouter un commentaire sur ce jeu de données:

>>> my_comment = sdk.comments.create(text='This is my first dataset',
...                                  project=my_project.id,
...                                  type='dataset',
...                                  target=new_dataset.id)

Pour marquer tous les commentaires de ce jeu de données comme lus:

>>> sdk.comments.mark_as_read(project=my_project.id,
...                           type='dataset',
...                           target=new_dataset.id)

Ajouter une annotation

Pour ajouter une annotation à un projet. Par exemple, une annotation dont la géométrie est la boîte de délimitation du projet:

>>> a = sdk.annotations.create(project=my_project.id,
...                            geometry=my_project.real_bbox,
...                            name='Project bounding box',
...                            description='Bounding box around the project')

Cette annotation peut être supprimée avec:

>>> sdk.annotations.delete(a.id)


Cet article a-t-il répondu à vos questions ?

SUJETS CONNEXES

Cet article a-t-il répondu à vos questions ?

SUJETS CONNEXES

Franchir le pas.

Demandez une démonstration ou organisez une réunion pour discuter de vos ambitions en matière de transformation numérique.

Nous Contacter

Restez en contact avec nous.

Le monde de l'AI change rapidement. Restez informé de l'actualité de la plateforme Alteia en vous inscrivant à notre newsletter :

Vous êtes maintenant abonné à la newsletter d'Alteia.