La bibliothèque " ibm-watson-studio-lib
de R permet d'accéder aux actifs. Il peut être utilisé dans les carnets créés dans l'éditeur de carnets ou dans RStudio dans un projet. ibm-watson-studio-lib
permet de travailler avec des données et des connexions, ainsi que de naviguer dans tous les autres types de données.
Il existe deux types de données :
- Les données stockées font référence aux fichiers stockés associés au projet en cours. La bibliothèque peut charger et enregistrer ces fichiers. Pour les données de plus d'un mégaoctet, cela n'est pas recommandé. La bibliothèque exige que les données soient conservées en mémoire dans leur intégralité, ce qui peut s'avérer inefficace lors du traitement d'énormes ensembles de données.
- Les données connectées représentent les données auxquelles il faut accéder par le biais d'une connexion. La bibliothèque permet d'extraire les propriétés (métadonnées) de la ressource de données connectée et de sa connexion. Les fonctions ne renvoient pas les données d'une ressource connectée. Vous pouvez utiliser le code généré pour vous lorsque vous cliquez sur Lire les données dans le panneau Extraits de code pour accéder aux données ou vous devez écrire votre propre code.
ibm-watson-studio-lib
n'encodent ni ne décodent 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 ressources des dossiers connectés (fichiers sur un chemin d'accès au stockage du projet).Mise en place de la bibliothèque " ibm-watson-studio-lib
La bibliothèque " ibm-watson-studio-lib
pour R est préinstallée et peut être importée directement dans un carnet dans l'éditeur de carnet. Pour utiliser la bibliothèque ibm-watson-studio-lib
dans votre bloc-notes, vous avez besoin de l'ID du projet et du jeton de projet.
Pour insérer le jeton du projet dans le bloc-notes :
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 :
library(ibmWatsonStudioLib) wslib <- access_project_or_space(list("token"="<ProjectToken>"))
<ProjectToken>
est la valeur du jeton de projet.Si un message vous dit qu'aucun jeton de projet n'existe, cliquez sur le lien dans le message à rediriger vers la page Contrôle d'accès du projet dans laquelle 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 :
- 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.
- Entrez un nom, sélectionnez le rôle Éditeur pour le projet et créez un jeton.
- 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.
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
- Obtenir un jeton d'authentification
- Extraire les données
- Sauvegarde des données
- Obtenir des informations sur la connexion
- Obtenir des informations sur les données connectées
- Accéder aux biens par leur identifiant plutôt que par leur nom
- Accéder directement à l'espace de stockage du projet
- Soutien à l'étincelle
- Parcourir les actifs du projet
Obtenir des informations sur le projet
Lorsque vous développez du code, il se peut que vous ne connaissiez pas les noms exacts des données ou des connexions. Les fonctions suivantes fournissent des listes de biens, à partir desquelles vous pouvez sélectionner ceux qui vous intéressent. Dans tous les exemples, vous pouvez utiliser 'wslib$show(assets)
pour imprimer la liste. L'index de chaque article est imprimé devant l'article.
list_connections()
Cette fonction renvoie une liste des connexions. La liste des connexions renvoyées n'est triée selon aucun critère et peut changer lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de liste au lieu d'un nom à "
get_connection function
.# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("token"="<ProjectToken>")) assets <- wslib$list_connections() wslib$show(assets) connprops <- wslib$get_connection(assets[0])
list_connected_data()
Cette fonction renvoie les données connectées. La liste des ressources de données connectées renvoyées n'est triée selon aucun critère et peut changer lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de liste au lieu d'un nom à la fonction "
get_connected_data
.list_stored_data()
Cette fonction renvoie une liste des données stockées (fichiers de données). La liste des données renvoyées n'est triée selon aucun critère et peut changer lorsque vous appelez à nouveau la fonction. Vous pouvez transmettre un élément de liste au lieu d'un nom aux fonctions "
load_data
et "save_data
Note : Une heuristique est appliquée pour faire la distinction entre les données connectées et les données stockées. Toutefois, il peut arriver qu'une donnée de type incorrect apparaisse dans les listes renvoyées.wslib$here
<\br>En utilisant ce point d'entrée, vous pouvez récupérer des métadonnées sur le projet avec lequel la librairie travaille. 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'identifiant du projet.
get_storage()
Cette fonction renvoie des informations sur le stockage du projet.
Obtenir un 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 du porteur :
get_current_token()
Par exemple :
library("ibmWatsonStudioLib")
wslib <- access_project_or_space(list("token"="<ProjectToken>"))
token <- wslib$auth$get_current_token()
Cette fonction renvoie le jeton porteur actuellement utilisé par la bibliothèque " ibm-watson-studio-lib
Extraire les données
Vous pouvez utiliser les fonctions suivantes pour récupérer des données à partir d'une ressource de données stockée (un fichier) dans votre projet.
load_data(asset_name_or_item, attachment_type_or_item = NULL)
Cette fonction charge les données d'une ressource stockée dans un tampon d'octets. Cette fonction n'est pas recommandée pour les fichiers très volumineux.
La fonction utilise les paramètres suivants :
asset_name_or_item
: (Obligatoire) Soit une chaîne avec le nom d'une donnée stockée, soit un élément tel que ceux renvoyés par 'list_stored_data()
.attachment_type_or_item
: (Facultatif) Type de pièce jointe à charger. Une ressource de données peut avoir plus d'une pièce jointe contenant des données. Sans ce paramètre, le type de pièce jointe par défaut, à savoir "data_asset
, est chargé. Indiquer ce paramètre si le type de pièce jointe n'est pas "data_asset
. Par exemple, si une ressource de données en texte brut est accompagnée d'un profil d'analyse du langage naturel, celui-ci peut être chargé en tant que pièce jointe de type "data_profile_nlu
.Voici un exemple qui montre comment charger les données d'une ressource de données :
# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("token"="<ProjectToken>")) # Fetch the data from a file my_file <- wslib$load_data("MyFile.csv") # Read the CSV data file into a data frame df <- read.csv(text = rawToChar(my_file)) head(df)
download_file(asset_name_or_item, file_name = NULL, attachment_type_or_item = NULL)
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 système d'exécution. Le fichier est écrasé s'il existe déjà.
La fonction utilise les paramètres suivants :
asset_name_or_item
: (Obligatoire) Soit une chaîne avec le nom d'une donnée stockée, soit un élément tel que ceux renvoyés par 'list_stored_data()
.file_name
: (Facultatif) Le nom du fichier dans lequel les données téléchargées sont stockées. Par défaut, il s'agit du nom de la pièce jointe de l'actif.attachment_type_or_item
: (Facultatif) Le type de pièce jointe à télécharger. Une ressource de données peut avoir plus d'une pièce jointe contenant des données. Sans ce paramètre, le type de pièce jointe par défaut, à savoir "data_asset
, est téléchargé. Indiquer ce paramètre si le type de pièce jointe n'est pas "data_asset
. Par exemple, si une ressource de données en texte brut est accompagnée d'un profil d'analyse du langage naturel, celui-ci peut être téléchargé en tant que pièce jointe de type "data_profile_nlu
.Voici un exemple qui vous montre comment utiliser '
download_file
pour rendre votre script R personnalisé disponible dans votre notebook :# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("token"="<ProjectToken>")) # Let's assume you have a R script "helpers.R" with helper functions on your local machine. # Upload the script to your project using the Data Panel on the right. # Download the script to the file system of your runtime wslib$download_file("helpers.R") # Source the script to use the contained functions, e.g. ‘my_func’, in your notebook. source("helpers.R") my_func()
Sauvegarde des données
Les fonctions permettant de stocker des données dans votre mémoire de projet ont plusieurs fonctions :
- Stocker les données dans la mémoire du projet
- Ajoutez les données en tant que ressource (en créant une ressource ou en remplaçant une ressource existante) à votre projet afin que vous puissiez voir les données dans la liste des ressources de votre projet.
- Associer le bien au fichier dans le stockage.
Vous pouvez utiliser les fonctions suivantes pour enregistrer des données :
save_data(asset_name_or_item, data, overwrite = NULL, mime_type = NULL, file_name = NULL)
Cette fonction permet d'enregistrer les données en mémoire dans la mémoire du projet.
La fonction utilise les paramètres suivants :
asset_name_or_item
: (Obligatoire) Le nom de l'actif créé ou de l'élément de liste renvoyé par 'list_stored_data()
. Vous pouvez utiliser cet élément si vous souhaitez écraser un fichier existant.data
: (Obligatoire) Les données à télécharger. Le type de données attendu est "raw
.overwrite
: (Facultatif) Remplace les données d'un actif de données stocké s'il existe déjà. Prend par défaut la valeur False. Si un élément d'actif est transmis au lieu d'un nom, le comportement est d'écraser l'actif.mime_type
: (Facultatif) Le type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe du nom de l'actif. Si vous utilisez des noms d'actifs sans suffixe, indiquez ici le type MIME. Par exemple, "mime_type=application/text
pour les données en texte brut. Ce paramètre est ignoré lors de l'écrasement d'un poste.file_name
: (Facultatif) Le nom du fichier à utiliser dans le stockage du projet. Les données sont enregistrées dans la mémoire associée au projet. Lors de la création d'un nouveau bien, le nom du fichier est dérivé du nom du bien, mais 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 de l'écrasement d'un poste.Voici un exemple qui montre comment enregistrer des données dans un fichier :
# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("token"="<ProjectToken>")) # let's assume you have a data frame df which contains the data # you want to save as a csv file csv <- capture.output(write.csv(df, row.names=FALSE), type="output") csv_raw <- charToRaw(paste0(csv, collapse='\n')) wslib$save_data("my_asset_name.csv", csv_raw) # the function returns a list which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data
upload_file(file_path, asset_name = NULL, file_name = NULL, overwrite = FALSE, mime_type = NULL)
Cette fonction permet d'enregistrer les données du système de fichiers dans le temps 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) Le nom de l'actif de données qui est créé. Par défaut, il s'agit du nom du fichier à télécharger.file_name
: (Facultatif) Le nom du fichier qui est créé dans l'espace de stockage associé au projet. Par défaut, il s'agit du nom du fichier à télécharger.overwrite
: (Facultatif) écrase un fichier existant dans le stockage. Prend par défaut la valeur False.mime_type
: (Facultatif) Le type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe du nom de l'actif. Si vous utilisez des noms d'actifs sans suffixe, indiquez ici le type MIME. Par exemple, "mime_type='application/text'
pour les données en texte brut. Ce paramètre est ignoré lors de l'écrasement d'un poste.Voici un exemple qui montre comment vous pouvez télécharger un fichier dans le projet :
# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("token"="<ProjectToken>")) # Let's assume you have downloaded a file and want to save it # in your project. download.file("https://some/url/data_file.csv", "data_file.csv") wslib$upload_file("data_file.csv") # The function returns a list which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data.
Obtenir des informations sur la 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 la connexion. Utilisez '
wslib$show(connprops)
pour voir les propriétés. La clé spéciale ""."
de l'élément de liste renvoyé fournit des informations sur le bien de connexion.La fonction prend le paramètre obligatoire suivant :
name_or_item
: Soit une chaîne avec le nom d'une connexion, soit un élément comme ceux renvoyés par 'list_connections()
.
Notez que lorsque vous travaillez avec des notebooks, vous pouvez cliquer sur Read data dans le panneau Code snippets 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'une ressource de données connectée.
get_connected_data(name_or_item)
Cette fonction renvoie les propriétés d'une ressource de données connectée, y compris les propriétés de la connexion sous-jacente. Utilisez '
wslib$show()
pour voir les propriétés. La clé spéciale ""."
de la liste renvoyée fournit des informations sur les données et les actifs de connexion.La fonction prend le paramètre obligatoire suivant :
name_or_item
: soit une chaîne de caractères contenant le nom d'une ressource de données connectée, soit un élément tel que ceux renvoyés par "list_connected_data()
.
Notez que lorsque vous travaillez avec des carnets de notes, vous pouvez cliquer sur Read data dans le panneau Code snippets pour générer du code afin de charger des données à partir d'une ressource de données connectée dans un DataFrame pandas par exemple.
Accéder à un bien par son identifiant au lieu de son nom
Il est préférable de toujours accéder aux données et aux connexions par un nom unique. Les noms des actifs ne sont pas nécessairement toujours uniques et les fonctions " ibm-watson-studio-lib
soulèveront une exception si un nom est ambigu. Vous pouvez renommer les ressources de données dans l'interface utilisateur pour résoudre le conflit.
Il est possible d'accéder aux biens par un identifiant unique, mais cela est déconseillé car les identifiants ne sont valables que dans le projet en cours et casseront le code s'ils sont transférés dans 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'une ressource connectée ou stockée en utilisant 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 permet d'accéder à une connexion par le biais de l'identifiant de la connexion.
get_connected_data(asset_id)
Cette fonction permet d'accéder à une ressource de données connectée par le biais de l'identifiant de la ressource de données connectée.
load_data(asset_id, attachment_type_or_item = NULL)
Cette fonction charge les données d'une ressource stockée en transmettant l'identifiant de la ressource. Voir '
load_data()
pour une description des autres paramètres que vous pouvez passer.save_data(asset_id, data, overwrite = NULL, mime_type = NULL, file_name = NULL)
Cette fonction permet d'enregistrer des données dans un stock de données en transmettant l'identifiant du stock. Cela implique "
overwrite=TRUE
. Voir 'save_data()
pour une description des autres paramètres que vous pouvez passer.download_file(asset_id, file_name = NULL, attachment_type_or_item = NULL)
Cette fonction télécharge les données d'une ressource stockée en transmettant l'identifiant de la ressource. Voir '
download_file()
pour une description des autres paramètres que vous pouvez passer.
Accéder directement à l'espace de stockage du projet
Vous pouvez extraire des données de la mémoire du projet et stocker des données dans la mémoire du projet sans synchroniser les actifs du projet en utilisant le 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 sous la forme d'un tampon d'octets. Le fichier n'a pas besoin d'être enregistré en tant qu'actif de données.
La fonction prend le paramètre obligatoire suivant :
filename
: Le nom du fichier dans le projet.
store_data(filename, data, overwrite = FALSE)
Cette fonction permet de sauvegarder les données en mémoire, mais ne crée pas de nouvelles données. La fonction renvoie une liste contenant le nom du fichier, le chemin d'accès au fichier et des informations supplémentaires. Utilisez "
Use wslib$show()
pour imprimer les informations.La fonction utilise les paramètres suivants :
filename
: (Obligatoire) Le nom du fichier dans l'espace de stockage du projet.data
: (obligatoire) Données à enregistrer en tant qu'objet brut.overwrite
: (Facultatif) écrase les données d'un fichier dans le stockage s'il existe déjà. Par défaut, cette valeur est fixée à false.
download_file(storage_filename, local_filename = NULL)
Cette fonction télécharge les données d'un fichier stocké et les stocke dans le fichier local spécifié. Le fichier local est écrasé s'il existe déjà.
La fonction utilise les paramètres suivants :
storage_filename
: (Obligatoire) Le nom du fichier en mémoire à télécharger.local_filename
: (Facultatif) Le nom du fichier dans le système de fichiers local de votre runtime dans lequel le fichier doit être téléchargé. Omettre ce paramètre pour utiliser le nom du fichier de stockage.
register_asset(storage_path, asset_name = NULL, mime_type = NULL)
Cette fonction enregistre le fichier stocké en tant qu'actif de données dans votre projet. Cette opération échoue si une ressource 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 d'accès au fichier stocké.asset_name
: (Facultatif) Le nom de l'actif créé. Par défaut, il s'agit du nom du fichier.mime_type
: (Facultatif) Le type MIME de l'actif créé. Par défaut, le type MIME est déterminé à partir du suffixe du nom de l'actif. Utilisez ce paramètre pour spécifier un type MIME si votre nom de fichier n'a pas d'extension 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 à ce fichier peuvent être interrompues.
Soutien à l'étincelle
Le point d'entrée " wslib$spark
fournit des fonctions permettant d'accéder aux fichiers stockés avec Spark.
Le point d'entrée " wslib$spark
fournit les fonctions suivantes :
provide_spark_context(sc)
Cette fonction permet d'activer le support Spark.
La fonction prend le paramètre obligatoire suivant :
sc : Le SparkContext. Il est fourni dans le runtime du notebook.
L'exemple suivant montre comment configurer la prise en charge de Spark :
library(ibmWatsonStudioLib) wslib <- access_project_or_space(list("token"="<ProjectToken>")) wslib$spark$provide_spark_context(sc)
get_data_url(asset_name)
Cette fonction renvoie une URL permettant d'accéder à un fichier stocké par Spark via Hadoop.
La fonction prend 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 stocké par Spark via Hadoop. La fonction attend le nom du fichier et non le nom de l'actif.
La fonction prend le paramètre obligatoire suivant :
file_name
: Le nom d'un fichier dans le stockage du projet.
Parcourir les actifs du projet
Le point d'entrée " wslib$assets
fournit un accès générique, en lecture seule, aux actifs de tout type. Pour certains types d'actifs, il existe des fonctions dédiées qui fournissent des données supplémentaires.
La convention d'attribution de nom suivante s'applique :
- Les fonctions nommées "
list_<something>
renvoient une liste de listes nommées. Chaque liste contenue représente un bien et comprend un petit ensemble de propriétés (métadonnées) qui identifient le bien. - Les fonctions nommées "
get_<something>
renvoient une liste nommée unique contenant les propriétés de l'actif.
Pour imprimer une liste ou une liste de listes nommées, utilisez 'wslib$show()
.
Les fonctions attendent comme paramètre soit le nom d'un bien, soit un élément d'une liste. Par défaut, les fonctions ne renvoient qu'un sous-ensemble des propriétés disponibles. En définissant le paramètre " raw_info=TRUE
, vous pouvez obtenir l'ensemble des propriétés de l'actif.
Le point d'entrée " wslib$assets
fournit les fonctions suivantes :
list_assets(asset_type, name = NULL, query = NULL, selector = NULL, raw_info = FALSE)
Cette fonction dresse la liste de tous les actifs du type donné en fonction des contraintes données.
La fonction utilise les paramètres suivants :
asset_type
: (Obligatoire) Le type d'actifs à répertorier, par exemple "data_asset
". Voir "list_asset_types()
pour une liste des types d'actifs disponibles. Utilisez le type de bien "asset
pour obtenir la liste de tous les biens disponibles dans le projet.name
: (Facultatif) Le nom du bien à répertorier. Utilisez ce paramètre s'il existe plusieurs biens 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 filtrage personnalisée sur les éléments de la liste des biens candidats. Si la fonction de sélection renvoie "TRUE
, le bien est inclus dans la liste des biens renvoyée.raw_info
: (Facultatif) Renvoie toutes les métadonnées disponibles. Par défaut, le paramètre est fixé à "FALSE
et seul un sous-ensemble des propriétés est renvoyé.Exemples d'utilisation de la fonction "
list_assets
# Import the lib library("ibmWatsonStudioLib") wslib <- access_project_or_space(list("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 <- function(asset) asset$metadata$size > 1000000 large_assets <- wslib$assets$list_assets("data_asset", selector = sizeFilter, raw_info = TRUE) wslib$show(large_assets) # List all notebooks notebooks <- wslib$assets$list_assets("notebook")
list_asset_types(raw_info = FALSE)
Cette fonction répertorie tous les types d'actifs disponibles.
La fonction peut prendre les paramètres suivants :
raw_info
: (Facultatif) Renvoie l'ensemble 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_info = FALSE)
Cette fonction répertorie tous les types de sources de données disponibles.
La fonction peut prendre les paramètres suivants :
raw_info
: (Facultatif) Renvoie l'ensemble 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_info = FALSE)
La fonction renvoie les métadonnées d'un bien.
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) Le type de l'actif. Si le paramètre "name_or_item
contient une chaîne de caractères pour le nom de l'actif, le paramètre "asset_type
est requis.raw_info
: (Facultatif) Renvoie l'ensemble 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[[1]]) wslib$show(notebook)
get_connection(name_or_item, with_datasourcetype=False, raw_info = FALSE)
Cette fonction renvoie les métadonnées d'une connexion.
La fonction utilise les paramètres suivants :
name_or_item
: (Obligatoire) Le nom de la connexion ou 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_info
: (Facultatif) Renvoie l'ensemble 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_info = FALSE)
Cette fonction renvoie les métadonnées d'une ressource de données connectée.
La fonction utilise les paramètres suivants :
name_or_item
: (Required) The name of the connected data asset or an item like those returned bylist_connected_data()
with_datasourcetype
: (Facultatif) Renvoie des informations supplémentaires sur le type de source de données du bien connecté associé.raw_info
: (Facultatif) Renvoie l'ensemble 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_info = FALSE)
Cette fonction renvoie les métadonnées d'une donnée stockée.
La fonction utilise les paramètres suivants :
name_or_item
: (Obligatoire) Nom de la ressource de données stockée ou d'un élément tel que ceux renvoyés par "list_stored_data()
"raw_info
: (Facultatif) Renvoie l'ensemble 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_info = FALSE)
Cette fonction renvoie une liste des pièces jointes d'une immobilisation.
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) Le type de l'actif. Par défaut, il s'agit du type "data_asset
.raw_info
: (Facultatif) Renvoie l'ensemble 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'une donnée stockée :assets <- wslib$list_stored_data() wslib$show(assets) asset <- assets[[1]] attachments <- wslib$assets$list_attachments(asset) wslib$show(attachments) buffer <- wslib$load_data(asset, attachments[[1]])
Sujet parent : Utiliser ibm-watson-studio-lib