0 / 0
Retourner à la version anglaise de la documentation
ibm-watson-studio-lib pour Python
Dernière mise à jour : 04 déc. 2024
ibm-watson-studio-lib pour Python

La bibliothèque ibm-watson-studio-lib pour Python permet d'accéder aux actifs. Il peut être utilisé dans des blocs-notes créés dans l'éditeur de bloc-notes. ibm-watson-studio-lib fournit une prise en charge pour l'utilisation des actifs de données et des connexions, ainsi que des fonctionnalités de navigation pour tous les autres types d'actifs.

Remarque : la bibliothèque " ibm-watson-studio-lib pour Python est destinée à watsonx.ai Studio, anciennement connu sous le nom de Watson Studio.

Il existe deux types d'actifs de données:

  • Les actifs de données stockés font référence aux fichiers du stockage associé au projet en cours. La bibliothèque peut charger et sauvegarder ces fichiers. Pour les données supérieures à un mégaoctet, cela n'est pas recommandé. La bibliothèque requiert que les données soient conservées en mémoire dans leur intégralité, ce qui peut s'avérer inefficace lors du traitement de fichiers volumineux.
  • Les actifs de données connectés représentent les données qui doivent être accessibles via une connexion. A l'aide de la bibliothèque, vous pouvez extraire les propriétés (métadonnées) de l'actif de données connecté et de sa connexion. Les fonctions ne renvoient pas les données d'un actif de données connecté. Vous pouvez utiliser le code qui est généré pour vous lorsque vous cliquez sur Lire les données dans le panneau Fragments de code pour accéder aux données ou vous devez écrire votre propre code.
Remarque: Les fonctions ibm-watson-studio-lib ne codent pas et ne décodent pas les données lors de l'enregistrement de données dans un fichier ou de l'obtention de données à partir d'un fichier. En outre, les fonctions ibm-watson-studio-lib ne peuvent pas être utilisées pour accéder aux actifs de dossier connectés (fichiers dans un chemin d'accès au stockage de projet).

Configuration de la bibliothèque ibm-watson-studio-lib

Pour accéder aux ressources du projet à partir de votre carnet de notes, initialisez 'ibm-watson-studio-lib. La bibliothèque " ibm-watson-studio-lib pour Python est préinstallée et peut être importée directement dans un carnet dans l'éditeur de carnet.

Pour insérer le code qui vous permet d'accéder aux ressources du projet :

  1. Cliquez sur l'icône Plus dans la barre d'outils du bloc-notes, puis sur Insérer un jeton de projet.

    Si un jeton de projet existe, une cellule contenant les informations suivantes est ajoutée au bloc-notes :

    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space({"token":"<ProjectToken>"})
    

    Si le jeton de projet n'existe pas, un message d'avertissement s'affiche. Cliquez sur le lien dans le message pour être redirigé vers la page de contrôle d'accès du projet où vous pouvez créer un jeton de projet. Vous devez être éligible pour créer un jeton de projet. Pour plus d'informations, voir Ajout manuel du jeton de projet.

    Pour créer un jeton de projet :

    1. Dans l'onglet Gérer, sélectionnez la page Contrôle d'accès et cliquez sur Nouveau jeton d'accès sous Jetons d'accès.
    2. Entrez un nom, sélectionnez le rôle Éditeur pour le projet et créez un jeton.
    3. Retournez à votre bloc-notes, cliquez sur l'icône Plus dans la barre d'outils du bloc-notes, puis cliquez sur Insérer un jeton de projet.

Fonctions d'aide

Vous pouvez obtenir des informations sur les fonctions prises en charge dans la bibliothèque ibm-watson-studio-lib à l'aide d'un programme en utilisant help(wslib)ou pour une fonction individuelle en utilisant help(wslib.<function_name>, par exemple help(wslib.get_connection).

Vous pouvez utiliser la fonction d'aide wslib.show(...) pour l'impression formatée des dictionnaires Python et des listes de dictionnaires, qui sont le type de sortie de résultat commun des fonctions ibm-watson-studio-lib .

Les fonctions ibm-watson-studio-lib

La bibliothèque ibm-watson-studio-lib expose un ensemble de fonctions regroupées de la manière suivante:

Obtenir des informations sur le projet

Lors du développement de code, il se peut que vous ne connaissiez pas les noms exacts des actifs de données ou des connexions. Les fonctions suivantes fournissent des listes d'actifs, à partir desquelles vous pouvez sélectionner les actifs appropriés. Dans tous les exemples, vous pouvez utiliser wslib.show(assets) pour imprimer la liste. L'index de chaque élément est imprimé devant l'élément.

  • list_connections()

    Cette fonction renvoie une liste de connexions. La liste des connexions renvoyées n'est triée par aucun critère et peut être modifiée lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de dictionnaire à la place d'un nom à la fonction get_connection .

    Par exemple :

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space({"token":"<ProjectToken>"})
    
    assets = wslib.list_connections()
    wslib.show(assets)
    connprops = wslib.get_connection(assets[0])
    wslib.show(connprops)
    
  • list_connected_data()

    Cette fonction renvoie les actifs de données connectés. La liste des actifs de données connectés renvoyés n'est triée par aucun critère et peut être modifiée lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de dictionnaire à la place d'un nom à la fonction get_connected_data .

  • list_stored_data()

    Cette fonction renvoie une liste des actifs de données stockés (fichiers de données). La liste des actifs de données renvoyés n'est triée par aucun critère et peut être modifiée lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de dictionnaire à la place d'un nom aux fonctions load_data et save_data.

    Remarque: Une heuristique est appliquée pour distinguer les actifs de données connectés des actifs de données stockés. Toutefois, il peut arriver qu'un actif de données de type incorrect apparaisse dans les listes renvoyées.
  • wslib.here< \br>

    En utilisant ce point d'entrée, vous pouvez extraire des métadonnées sur le projet avec lequel la bibliothèque fonctionne. Le point d'entrée wslib.here fournit les fonctions suivantes:

    • get_name()

      Cette fonction renvoie le nom du projet.

    • get_description()

      Cette fonction renvoie la description du projet.

    • get_ID()

      Cette fonction renvoie l'ID du projet.

    • get_storage()

      Cette fonction renvoie des informations de stockage pour le projet.

Obtenir le jeton d'authentification

Certaines tâches nécessitent un jeton d'authentification. Par exemple, si vous souhaitez exécuter vos propres requêtes sur l'API de base commune de données et d'IA, vous avez besoin d'un jeton d'authentification.

Vous pouvez utiliser la fonction suivante pour obtenir le jeton bearer:

  • get_current_token()

Par exemple :

from ibm_watson_studio_lib import access_project_or_space
wslib = access_project_or_space({"token":"<ProjectToken>"})
token = wslib.auth.get_current_token()

Cette fonction renvoie le jeton bearer actuellement utilisé par la bibliothèque ibm-watson-studio-lib .

Extraire les données

Vous pouvez utiliser les fonctions suivantes pour extraire des données d'un actif de données stocké (un fichier) dans votre projet.

  • load_data(asset_name_or_item, attachment_type_or_item=None)

    Cette fonction charge les données d'un actif de données stocké dans une mémoire tampon BytesIO . La fonction n'est pas recommandée pour les fichiers très volumineux.

    La fonction utilise les paramètres suivants :

    • asset_name_or_item: (Obligatoire) Chaîne avec le nom d'un actif de données stocké ou d'un élément tel que ceux renvoyés par list_stored_data().

    • attachment_type_or_item: (Facultatif) Type de pièce jointe à charger. Un actif de données peut comporter plusieurs pièces jointes avec des données. Sans ce paramètre, le type de pièce jointe par défaut, à savoir data_asset , est chargé. Spécifiez ce paramètre si le type de pièce jointe n'est pas data_asset. Par exemple, si un actif de données en texte brut est associé à un profil provenant de Natural Language Analysis, il peut être chargé en tant que type de pièce jointe data_profile_nlu.

      Voici un exemple qui vous montre comment charger les données d'un actif de données:

      # Import the lib
      from ibm_watson_studio_lib import access_project_or_space
      wslib = access_project_or_space({"token":"<ProjectToken>"})
      
      # Fetch the data from a file
      my_file = wslib.load_data("MyFile.csv")
      
      # Read the CSV data file into a pandas DataFrame
      my_file.seek(0)
      import pandas as pd
      pd.read_csv(my_file, nrows=10)
      
  • download_file(asset_name_or_item, file_name=None, attachment_type_or_item=None)

    Cette fonction télécharge les données d'une ressource de données stockée et les stocke dans le fichier spécifié dans le système de fichiers de votre environnement d'exécution. Le fichier est écrasé s'il existe déjà.

    La fonction utilise les paramètres suivants :

    • asset_name_or_item: (Obligatoire) Chaîne avec le nom d'un actif de données stocké ou d'un élément tel que ceux renvoyés par list_stored_data().

    • file_name: (Facultatif) Nom du fichier dans lequel sont stockées les données téléchargées. Par défaut, il s'agit du nom de la pièce jointe de l'actif.

    • attachment_type_or_item: (Facultatif) Type de pièce jointe à télécharger. Un actif de données peut comporter plusieurs pièces jointes avec des données. Sans ce paramètre, le type de pièce jointe par défaut, à savoir data_asset , est téléchargé. Spécifiez ce paramètre si le type de pièce jointe n'est pas data_asset. Par exemple, si un actif de données en texte brut est associé à un profil provenant de Natural Language Analysis, il peut être téléchargé en tant que type de pièce jointe data_profile_nlu.

      Voici un exemple qui vous montre comment utiliser download_file pour rendre votre script Python personnalisé disponible dans votre bloc-notes:

      # Import the lib
      from ibm_watson_studio_lib import access_project_or_space
      wslib = access_project_or_space({"token":"<ProjectToken>"})
      
      # Let's assume you have a Python script "helpers.py" with helper functions on your local machine.
      # Upload the script to your project using the Data Panel on the right of the opened notebook.
      
      # Download the script to the file system of your runtime
      wslib.download_file("helpers.py")
      
      # import the required functions to use them in your notebook
      from helpers import my_func
      my_func()
      

Enregistrer les données

Les fonctions de sauvegarde des données dans le stockage de votre projet permettent d'effectuer plusieurs opérations:

  • Stocker les données dans le stockage de projet
  • Ajoutez les données en tant qu'actif de données (en créant un actif ou en écrasant un actif existant) à votre projet afin de pouvoir afficher les données dans la liste des actifs de données de votre projet.
  • Associez l'actif au fichier dans le stockage.

Vous pouvez utiliser les fonctions suivantes pour sauvegarder des données:

  • save_data(asset_name_or_item, data, overwrite=None, mime_type=None, file_name=None)

    Cette fonction sauvegarde les données en mémoire dans le stockage du projet.

    La fonction utilise les paramètres suivants :

    • asset_name_or_item: (Obligatoire) Nom de l'actif ou de l'élément de liste créé renvoyé par list_stored_data(). Vous pouvez utiliser l'élément si vous souhaitez remplacer un fichier existant.

    • data: (Obligatoire) Données à télécharger. Il peut s'agir de n'importe quel objet de type bytes-like-object, par exemple une mémoire tampon d'octets.

    • overwrite: (Facultatif) Remplace les données d'un actif de données stocké s'il existe déjà. Par défaut, la valeur est false. Si un élément d'actif est transmis à la place d'un nom, le comportement consiste à remplacer l'actif.

    • mime_type: (Facultatif) Type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe de nom d'actif. Si vous utilisez des noms d'actif sans suffixe, spécifiez le type MIME ici. Par exemple, mime_type=application/text pour les données en texte clair. Ce paramètre est ignoré lors du remplacement d'un actif.

    • file_name: (Facultatif) Nom de fichier à utiliser dans le stockage de projet. Les données sont sauvegardées dans le stockage associé au projet. Lors de la création d'un nouvel actif, le nom de fichier est dérivé du nom de l'actif, mais il peut être différent. Si vous souhaitez accéder directement au fichier, vous pouvez spécifier un nom de fichier. Ce paramètre est ignoré lors du remplacement d'un actif.

      Voici un exemple qui montre comment sauvegarder des données dans un fichier:

      # Import the lib
      from ibm_watson_studio_lib import access_project_or_space
      wslib = access_project_or_space({"token":"<ProjectToken>"})
      
      # let's assume you have the pandas DataFrame pandas_df which contains the data
      # you want to save as a csv file
      wslib.save_data("my_asset_name.csv", pandas_df.to_csv(index=False).encode())
      
      # the function returns a dict which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data
      
  • upload_file(file_path, asset_name=None, file_name=None, overwrite=False, mime_type=None) Cette fonction sauvegarde les données du système de fichiers de l'environnement d'exécution dans un fichier associé à votre projet. La fonction utilise les paramètres suivants :

    • file_path: (Obligatoire) Chemin d'accès au fichier dans le système de fichiers.

    • asset_name: (Facultatif) Nom de l'actif de données créé. Par défaut, il s'agit du nom du fichier à télécharger.

    • file_name: (Facultatif) Nom du fichier créé dans le stockage associé au projet. Par défaut, il s'agit du nom du fichier à télécharger.

    • overwrite: (Facultatif) Remplace un fichier existant dans le stockage. La valeur par défaut est false.

    • mime_type: (Facultatif) Type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe de nom d'actif. Si vous utilisez des noms d'actif sans suffixe, spécifiez le type MIME ici. Par exemple, mime_type='application/text' pour les données en texte clair. Ce paramètre est ignoré lors du remplacement d'un actif.

      Voici un exemple qui vous montre comment télécharger un fichier dans le projet:

      # Import the lib
      from ibm_watson_studio_lib import access_project_or_space
      wslib = access_project_or_space({"token":"<ProjectToken>"})
      
      # Let's assume you have downloaded a file and want to save it
      # in your project.
      import urllib.request
      urllib.request.urlretrieve("https://some/url/data_file.csv", "data_file.csv")
      wslib.upload_file("data_file.csv")
      
      # The function returns a dictionary which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data.
      

Obtenir les informations de connexion

Vous pouvez utiliser la fonction suivante pour accéder aux métadonnées de connexion d'une connexion donnée.

  • get_connection(name_or_item)

    Cette fonction renvoie les propriétés (métadonnées) d'une connexion que vous pouvez utiliser pour extraire des données de la source de données de connexion. Utilisez wslib.show(connprops) pour afficher les propriétés. La clé spéciale "." du dictionnaire renvoyé fournit des informations sur l'actif de connexion.

    La fonction utilise le paramètre obligatoire suivant:

    • name_or_item: une chaîne avec le nom d'une connexion ou un élément tel que ceux renvoyés par list_connections().

    Notez que lorsque vous utilisez des blocs-notes, vous pouvez cliquer sur Lire les données dans le panneau Fragments de code pour générer du code afin de charger des données à partir d'une connexion dans un DataFrame pandas, par exemple.

Obtenir des informations sur les données connectées

Vous pouvez utiliser la fonction suivante pour accéder aux métadonnées d'un actif de données connecté.

  • get_connected_data(name_or_item)

    Cette fonction renvoie les propriétés d'un actif de données connecté, y compris les propriétés de la connexion sous-jacente. Utilisez wslib.show() pour afficher les propriétés. La clé spéciale "." du dictionnaire renvoyé fournit des informations sur les données et les actifs de connexion.

    La fonction utilise le paramètre obligatoire suivant:

    • name_or_item: soit une chaîne avec le nom d'un actif de données connecté, soit un élément tel que ceux renvoyés par list_connected_data().

    Notez que lorsque vous utilisez des blocs-notes, vous pouvez cliquer sur Lire les données dans le panneau Fragments de code pour générer du code afin de charger les données d'un actif de données connecté dans un DataFrame pandas, par exemple.

Accéder à l'actif par ID à la place du nom

Vous devez de préférence toujours accéder aux actifs de données et aux connexions par un nom unique. Les noms d'actif ne sont pas nécessairement toujours uniques et les fonctions ibm-watson-studio-lib généreront une exception lorsqu'un nom est ambigu. Vous pouvez renommer des actifs de données dans l'interface utilisateur pour résoudre le conflit.

L'accès aux actifs à l'aide d'un ID unique est possible, mais il est déconseillé car les ID sont valides uniquement dans le projet en cours et le code est rompu lorsqu'ils sont transférés vers un autre projet. Cela peut se produire, par exemple, lorsque des projets sont exportés et réimportés. Vous pouvez obtenir l'ID d'une connexion, d'un actif de données connecté ou stocké à l'aide de la fonction de liste correspondante, par exemple list_connections().

Le point d'entrée wslib.by_id fournit les fonctions suivantes:

  • get_connection(asset_id)

    Cette fonction accède à une connexion par l'ID d'actif de connexion.

  • get_connected_data(asset_id)

    Cette fonction accède à un actif de données connecté par l'ID d'actif de données connecté.

  • load_data(asset_id, attachment_type_or_item=None)

    Cette fonction charge les données d'un actif de données stocké en transmettant l'ID d'actif. Pour une description des autres paramètres que vous pouvez transmettre, voir load_data() .

  • save_data(asset_id, data, overwrite=None, mime_type=None, file_name=None)

    Cette fonction sauvegarde les données dans un actif de données stocké en transmettant l'ID d'actif. Cela implique overwrite=True. Pour une description des autres paramètres que vous pouvez transmettre, voir save_data() .

  • download_file(asset_id, file_name=None, attachment_type_or_item=None)

    Cette fonction télécharge les données d'un actif de données stocké en transmettant l'ID d'actif. Pour une description des autres paramètres que vous pouvez transmettre, voir download_file() .

Accéder directement au stockage de projet

Vous pouvez extraire des données du stockage de projet et les stocker dans le stockage de projet sans synchroniser les actifs de projet à l'aide du point d'entrée wslib.storage.

Le point d'entrée wslib.storage fournit les fonctions suivantes:

  • fetch_data(filename)

    Cette fonction renvoie les données d'un fichier en tant que mémoire tampon BytesIO . Le fichier n'a pas besoin d'être enregistré en tant qu'actif de données.

    La fonction utilise le paramètre obligatoire suivant:

    • filename: nom du fichier dans le stockage de projet.
  • store_data(filename, data, overwrite=False)

    Cette fonction sauvegarde les données en mémoire dans le stockage, mais ne crée pas d'actif de données. La fonction renvoie un dictionnaire qui contient le nom du fichier, le chemin d'accès au fichier et des informations supplémentaires. Utilisez wslib.show() pour imprimer les informations.

    La fonction utilise les paramètres suivants :

    • filename: (Obligatoire) Nom du fichier dans le stockage du projet.
    • data: (Obligatoire) Données à sauvegarder en tant qu'objet de type octets.
    • overwrite: (Facultatif) Remplace les données d'un fichier dans le stockage s'il existe déjà. Par défaut, la valeur est false.
  • download_file(storage_filename, local_filename=None)

    Cette fonction télécharge les données dans un fichier stocké et les stocke dans le fichier local spécifié. Le fichier local est remplacé s'il existe déjà.

    La fonction utilise les paramètres suivants :

    • storage_filename: (Obligatoire) Nom du fichier dans le stockage à télécharger.
    • local_filename: (Facultatif) Nom du fichier dans le système de fichiers local de votre environnement d'exécution dans lequel télécharger le fichier. Omettez ce paramètre pour utiliser le nom du fichier de stockage.
  • register_asset(storage_path, asset_name=None, mime_type=None)

    Cette fonction enregistre le fichier dans le stockage en tant qu'actif de données dans votre projet. Cette opération échoue si un actif de données portant le même nom existe déjà.

    Vous pouvez utiliser cette fonction si vous avez de très gros fichiers que vous ne pouvez pas télécharger via save_data(). Vous pouvez télécharger des fichiers volumineux directement dans le godet IBM Cloud Object Storage de votre projet, par exemple via l'interface utilisateur, puis les enregistrer en tant que ressources de données à l'aide de 'register_asset().

    La fonction utilise les paramètres suivants :

    • storage_path: (Obligatoire) Chemin du fichier dans le stockage.
    • asset_name: (Facultatif) Nom de l'actif créé. Par défaut, il s'agit du nom de fichier.
    • mime_type: (Facultatif) Type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe de nom d'actif. Utilisez ce paramètre pour spécifier un type MIME si votre nom de fichier ne possède pas d'extension de fichier ou si vous souhaitez définir un type MIME différent.
    Remarque: Vous pouvez enregistrer un fichier plusieurs fois en tant qu'actif de données différent. La suppression de l'un de ces actifs dans le projet supprime également le fichier dans le stockage, ce qui signifie que d'autres références d'actifs au fichier peuvent être rompues.

Prise En Charge Spark

Le point d'entrée wslib.spark fournit des fonctions permettant d'accéder aux fichiers dans le stockage avec Spark. Pour obtenir de l'aide sur les fonctions disponibles, utilisez help(wslib.spark.API).

Le point d'entrée wslib.spark fournit les fonctions suivantes:

  • provide_spark_context(sc)

    Utilisez cette fonction pour activer la prise en charge de Spark.

    La fonction utilise le paramètre obligatoire suivant:

    • sc: SparkContext. Il est fourni dans l'environnement d'exécution du bloc-notes.

    L'exemple suivant montre comment configurer la prise en charge de Spark:

    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space({"token":"<ProjectToken>"})
    wslib.spark.provide_spark_context(sc)
    
  • get_data_url(asset_name)

    Cette fonction renvoie une URL permettant d'accéder à un fichier dans le stockage à partir de Spark via Hadoop.

    La fonction utilise le paramètre obligatoire suivant:

    • asset_name: nom de l'actif.
  • storage.get_data_url(file_name)

    Cette fonction renvoie une URL permettant d'accéder à un fichier dans le stockage à partir de Spark via Hadoop. La fonction attend le nom de fichier et non le nom d'actif.

    La fonction utilise le paramètre obligatoire suivant:

    • file_name: nom d'un fichier dans le stockage de projet.

Parcourir les actifs de projet

Le point d'entrée wslib.assets fournit un accès générique en lecture seule aux actifs de n'importe quel type. Pour les types d'actif sélectionnés, des fonctions dédiées fournissent des données supplémentaires. Pour obtenir de l'aide sur les fonctions disponibles, utilisez help(wslib.assets.API).

La convention d'attribution de nom suivante s'applique :

  • Les fonctions nommées list_<something> renvoient une liste de dictionnaires Python . Chaque dictionnaire représente un actif et inclut un petit ensemble de propriétés (métadonnées) qui identifie l'actif.
  • Les fonctions nommées get_<something> renvoient un dictionnaire Python unique avec les propriétés de l'actif.

Pour imprimer un dictionnaire ou une liste de dictionnaires, utilisez wslib.show().

Les fonctions attendent soit le nom d'un actif, soit un élément d'une liste comme paramètre. Par défaut, les fonctions renvoient uniquement un sous-ensemble des propriétés d'actif disponibles. En définissant le paramètre raw=True, vous pouvez obtenir l'ensemble complet des propriétés d'actif.

Le point d'entrée wslib.assets fournit les fonctions suivantes:

  • list_assets(asset_type, name=None, query=None, selector=None, raw=False)

    Cette fonction répertorie tous les actifs pour le type donné en fonction des contraintes données.

    La fonction utilise les paramètres suivants :

    • asset_type: (Obligatoire) Type des actifs à répertorier, par exemple data_asset. Pour la liste des types d'actif disponibles, voir list_asset_types() . Utilisez le type d'actif asset pour la liste de tous les actifs disponibles dans le projet.
    • name: (Facultatif) Nom de l'actif à répertorier. Utilisez ce paramètre s'il existe plusieurs actifs portant le même nom. Vous ne pouvez spécifier que name et query.
    • query: (Facultatif) Chaîne de requête transmise à l'API du tronc commun de données et d'intelligence artificielle pour la recherche d'actifs. Vous ne pouvez spécifier que name et query.
    • selector: (Facultatif) Une fonction de filtre personnalisé sur les éléments du dictionnaire d'actifs candidats. Si la fonction de sélecteur renvoie True, l'actif est inclus dans la liste des actifs renvoyés.
    • raw: (Facultatif) Renvoie toutes les métadonnées disponibles. Par défaut, le paramètre est défini sur False et seul un sous-ensemble des propriétés est renvoyé.

    Exemples d'utilisation de la fonction list_assets :

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space({"token":"<ProjectToken>"})
    
    # List all assets in the project
    all_assets = wslib.assets.list_assets("asset")
    wslib.show(all_assets)
    
    # List all data assets with name 'MyFile.csv'
    assets_by_name = wslib.assets.list_assets("data_asset", name="MyFile.csv")
    
    # List all data assets whose name starts with "MyF"
    assets_by_query = wslib.assets.list_assets("data_asset", query="asset.name:(MyF*)")
    
    # List all data assets which are larger than 1MB
    sizeFilter = lambda x: x['metadata']['size'] > 1000000
    large_assets = wslib.assets.list_assets("data_asset", selector=sizeFilter, raw=True)
    
    # List all notebooks
    notebooks = wslib.assets.list_assets("notebook")
    
  • list_asset_types(raw=False)

    Cette fonction répertorie tous les types d'actif disponibles.

    La fonction peut prendre le paramètre suivant:

    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.
  • list_datasource_types(raw=False)

    Cette fonction répertorie tous les types de source de données disponibles.

    La fonction peut prendre le paramètre suivant:

    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.
  • get_asset(name_or_item, asset_type=None, raw=False)

    La fonction renvoie les métadonnées d'un actif.

    La fonction utilise les paramètres suivants :

    • name_or_item: (Obligatoire) Nom de l'actif ou d'un élément tel que ceux renvoyés par list_assets()
    • asset_type: (Facultatif) Type de l'actif. Si le paramètre name_or_item contient une chaîne pour le nom de l'actif, la valeur asset_type est requise.
    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.

    Exemple d'utilisation des fonctions list_assets et get_asset :

    notebooks = wslib.assets.list_assets('notebook')
    wslib.show(notebooks)
    
    notebook = wslib.assets.get_asset(notebooks[0])
    wslib.show(notebook)
    
  • get_connection(name_or_item, with_datasourcetype=False, raw=False)

    Cette fonction renvoie les métadonnées d'une connexion.

    La fonction utilise les paramètres suivants :

    • name_or_item: (Obligatoire) Nom de la connexion ou d'un élément tel que ceux renvoyés par list_connections()
    • with_datasourcetype: (Facultatif) Renvoie des informations supplémentaires sur le type de source de données de la connexion.
    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.
  • get_connected_data(name_or_item, with_datasourcetype=False, raw=False)

    Cette fonction renvoie les métadonnées d'un actif de données connecté.

    La fonction utilise les paramètres suivants :

    • name_or_item: (Obligatoire) Nom de l'actif de données connecté ou d'un élément tel que ceux renvoyés par list_connected_data()
    • with_datasourcetype: (Facultatif) Renvoie des informations supplémentaires sur le type de source de données de l'actif de données connecté associé.
    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.
  • get_stored_data(name_or_item, raw=False)

    Cette fonction renvoie les métadonnées d'un actif de données stocké.

    La fonction utilise les paramètres suivants :

    • name_or_item: (Obligatoire) Nom de l'actif de données stocké ou d'un élément tel que ceux renvoyés par list_stored_data()
    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.
  • list_attachments(name_or_item_or_asset, asset_type=None, raw=False)

    Cette fonction renvoie une liste des pièces jointes d'un actif.

    La fonction utilise les paramètres suivants :

    • name_or_item_or_asset: (Obligatoire) Nom de l'actif ou d'un élément tel que ceux renvoyés par list_stored_data() ou get_asset().
    • asset_type: (Facultatif) Type de l'actif. La valeur par défaut est data_asset.
    • raw: (Facultatif) Renvoie l'ensemble complet des métadonnées. Par défaut, le paramètre est False et seul un sous-ensemble des propriétés est renvoyé.

    Exemple d'utilisation de la fonction list_attachments pour lire une pièce jointe d'un actif de données stocké:

    assets = wslib.list_stored_data()
    wslib.show(assets)
    
    asset = assets[0]
    attachments = wslib.assets.list_attachments(asset)
    wslib.show(attachments)
    buffer = wslib.load_data(asset, attachments[0])
    

Rubrique parent: Utilisation d'ibm-watson-studio-lib

Recherche et réponse à l'IA générative
Ces réponses sont générées par un modèle de langue de grande taille dans watsonx.ai en fonction du contenu de la documentation du produit. En savoir plus