Obtener información sobre el proyecto

Al desarrollar código, es posible que no conozca los nombres exactos de los activos de datos o las conexiones. Las siguientes funciones proporcionan listas de activos, de las que puede seleccionar los que le interesen. En todos los ejemplos, puede utilizar ' wslib$show(assets) ' para imprimir la lista. El índice de cada artículo se imprime delante del mismo.

• list_connections()

  Esta función devuelve una lista de las conexiones. La lista de conexiones devuelta no está ordenada por ningún criterio y puede cambiar al volver a llamar a la función. Puede pasar un elemento de lista en lugar de un nombre a ' 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()

  Esta función devuelve los activos de datos conectados. La lista de activos de datos conectados devuelta no está ordenada por ningún criterio y puede cambiar al volver a llamar a la función. Puede pasar un elemento de lista en lugar de un nombre a la función ' get_connected_data '.

• list_stored_data()

  Esta función devuelve una lista de los activos de datos almacenados (archivos de datos). La lista de activos de datos devueltos no está ordenada por ningún criterio y puede cambiar al volver a llamar a la función. Puede pasar un elemento de lista en lugar de un nombre a las funciones ' load_data y ' save_data '.

  Nota: Se aplica una heurística para distinguir entre activos de datos conectados y activos de datos almacenados. Sin embargo, puede darse el caso de que en las listas devueltas aparezca un activo de datos del tipo incorrecto.

• wslib$here<\br> Mediante el uso de este punto de entrada, puede recuperar metadatos sobre el proyecto que la lib está trabajando. El punto de entrada ' wslib$here ' proporciona las siguientes funciones:

  • get_name()

    Esta función devuelve el nombre del proyecto.

  • get_description()

    Esta función devuelve la descripción del proyecto.

  • get_ID()

    Esta función devuelve el ID del proyecto.

  • get_storage()

    Esta función devuelve información sobre el almacenamiento del proyecto.

Obtener token de autenticación

Algunas tareas requieren un token de autenticación. Por ejemplo, si desea ejecutar sus propias solicitudes en la API básica común de datos e inteligencia artificial, necesita un token de autenticación.

Puede utilizar la siguiente función para obtener el token de portador:

• get_current_token()

Por ejemplo:

library("ibmWatsonStudioLib")
wslib <- access_project_or_space(list("token"="<ProjectToken>"))
token <- wslib$auth$get_current_token()

Esta función devuelve el token portador que utiliza actualmente la biblioteca ' ibm-watson-studio-lib '.

Captar datos

Puede utilizar las siguientes funciones para obtener datos de un activo de datos almacenado (un archivo) en su proyecto.

• load_data(asset_name_or_item, attachment_type_or_item = NULL)

  Esta función carga los datos de un activo de datos almacenados en un búfer de bytes. Esta función no se recomienda para archivos muy grandes.

  La función toma los parámetros siguientes:

  • asset_name_or_item: (Obligatorio) O bien una cadena con el nombre de un activo de datos almacenado o bien un elemento como los devueltos por ' list_stored_data().

  • attachment_type_or_item: (Opcional) Tipo de anexo a cargar. Un activo de datos puede tener más de un anexo con datos. Sin este parámetro, se carga el tipo de archivo adjunto por defecto, es decir, ' data_asset. Especifique este parámetro si el tipo de archivo adjunto no es ' data_asset. Por ejemplo, si un activo de datos de texto sin formato tiene un perfil adjunto del Análisis del Lenguaje Natural, éste puede cargarse como adjunto de tipo ' data_profile_nlu.

    He aquí un ejemplo que muestra cómo cargar los datos de un activo de datos:

    # 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)

  Esta función descarga los datos de un activo de datos almacenados y los almacena en el archivo especificado en el sistema de archivos de su tiempo de ejecución. El archivo se sobrescribe si ya existe.

  La función toma los parámetros siguientes:

  • asset_name_or_item: (Obligatorio) O bien una cadena con el nombre de un activo de datos almacenado o bien un elemento como los devueltos por ' list_stored_data().

  • file_name: (Opcional) El nombre del archivo en el que se almacenan los datos descargados. Por defecto es el nombre del archivo adjunto del activo.

  • attachment_type_or_item: (Opcional) El tipo de archivo adjunto que se va a descargar. Un activo de datos puede tener más de un anexo con datos. Sin este parámetro, se descarga el tipo de archivo adjunto por defecto, es decir, " data_asset. Especifique este parámetro si el tipo de archivo adjunto no es ' data_asset. Por ejemplo, si un activo de datos de texto sin formato tiene un perfil adjunto del Análisis del Lenguaje Natural, éste puede descargarse cargado como archivo adjunto de tipo " data_profile_nlu.

    Aquí tienes un ejemplo que te muestra cómo puedes usar ' download_file para hacer que tu script R personalizado esté disponible en tu cuaderno:

    # 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()
    

Guardar datos

Las funciones para almacenar datos en el almacén de tu proyecto hacen múltiples cosas:

• Almacenar los datos en la memoria del proyecto
• Añada los datos como un activo de datos (creando un activo o sobrescribiendo un activo existente) a su proyecto para que pueda ver los datos en la lista de activos de datos de su proyecto.
• Asociar el activo con el archivo en el almacenamiento.

Puedes utilizar las siguientes funciones para guardar datos:

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

  Esta función guarda los datos de la memoria en el almacén de proyectos.

  La función toma los parámetros siguientes:

  • asset_name_or_item: (Obligatorio) Nombre del activo o elemento de lista creado que devuelve " list_stored_data(). Puede utilizar este elemento si desea sobrescribir un archivo existente.

  • data: (Obligatorio) Los datos a cargar. El tipo de dato esperado es ' raw.

  • overwrite: (Opcional) Sobrescribe los datos de un activo de datos almacenado si ya existe. El valor predeterminado es Falso. Si se pasa un elemento de activo en lugar de un nombre, el comportamiento es sobrescribir el activo.

  • mime_type: (Opcional) El tipo MIME para el activo creado. Por defecto, el tipo MIME se determina a partir del sufijo del nombre del activo. Si utiliza nombres de activos sin sufijo, especifique aquí el tipo MIME. Por ejemplo, " mime_type=application/text " para datos de texto sin formato. Este parámetro se ignora al sobrescribir un activo.

  • file_name: (Opcional) El nombre del archivo que se utilizará en el almacenamiento del proyecto. Los datos se guardan en el almacén asociado al proyecto. Al crear un nuevo activo, el nombre del archivo se deriva del nombre del activo, pero puede ser diferente. Si desea acceder directamente al archivo, puede especificar un nombre de archivo. Este parámetro se ignora al sobrescribir un activo.

    He aquí un ejemplo que muestra cómo guardar datos en un archivo:

    # 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)

  Esta función guarda los datos del sistema de archivos en tiempo de ejecución en un archivo asociado a su proyecto.

  La función toma los parámetros siguientes:

  • file_path: (Obligatorio) La ruta al archivo en el sistema de archivos.

  • asset_name: (Opcional) El nombre del activo de datos que se crea. Por defecto es el nombre del archivo que se va a cargar.

  • file_name: (Opcional) El nombre del archivo que se crea en el almacenamiento asociado al proyecto. Por defecto es el nombre del archivo que se va a cargar.

  • overwrite: (Opcional) Sobrescribe un archivo existente en el almacenamiento. El valor predeterminado es Falso.

  • mime_type: (Opcional) El tipo MIME para el activo creado. Por defecto, el tipo MIME se determina a partir del sufijo del nombre del activo. Si utiliza nombres de activos sin sufijo, especifique aquí el tipo MIME. Por ejemplo, " mime_type='application/text' " para datos de texto sin formato. Este parámetro se ignora al sobrescribir un activo.

    He aquí un ejemplo que muestra cómo puede cargar un archivo en el proyecto:

    # 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.
    

Obtener información de conexión

Puede utilizar la siguiente función para acceder a los metadatos de conexión de una conexión determinada.

• get_connection(name_or_item)

  Esta función devuelve las propiedades (metadatos) de una conexión que puede utilizar para obtener datos del origen de datos de la conexión. Utilice ' wslib$show(connprops) ' para ver las propiedades. La clave especial " "." " del elemento de lista devuelto proporciona información sobre el activo de conexión.

  La función toma el siguiente parámetro requerido:

  • 'name_or_item: O bien una cadena con el nombre de una conexión o bien un elemento como los devueltos por ' list_connections().

  Tenga en cuenta que cuando trabaja con cuadernos, puede hacer clic en Leer datos en el panel Fragmentos de código para generar código para cargar datos de una conexión en un DataFrame de pandas, por ejemplo.

Obtener información de datos conectados

Puede utilizar la siguiente función para acceder a los metadatos de un activo de datos conectado.

• get_connected_data(name_or_item)

  Esta función devuelve las propiedades de un activo de datos conectado, incluidas las propiedades de la conexión subyacente. Utilice ' wslib$show() ' para ver las propiedades. La clave especial " "." " de la lista devuelta proporciona información sobre los datos y los activos de conexión.

  La función toma el siguiente parámetro requerido:

  • 'name_or_item: O bien una cadena con el nombre de un activo de datos conectado o bien un elemento como los devueltos por ' list_connected_data().

  Tenga en cuenta que cuando trabaja con cuadernos, puede hacer clic en Leer datos en el panel Fragmentos de código para generar código para cargar datos de un activo de datos conectado en un DataFrame de pandas, por ejemplo.

Acceso a los activos por ID en lugar de por nombre

Es preferible que siempre acceda a los activos de datos y a las conexiones por un nombre único. Los nombres de los activos no siempre son necesariamente únicos y las funciones ' ibm-watson-studio-lib ' lanzarán una excepción cuando un nombre sea ambiguo. Puede cambiar el nombre de los activos de datos en la interfaz de usuario para resolver el conflicto.

Es posible acceder a los activos mediante un ID único, pero se desaconseja, ya que los ID sólo son válidos en el proyecto actual y romperán el código cuando se transfieran a un proyecto diferente. Esto puede ocurrir, por ejemplo, cuando los proyectos se exportan y se vuelven a importar. Puede obtener el ID de una conexión, de un activo de datos conectado o almacenado utilizando la función de lista correspondiente, por ejemplo " list_connections().

El punto de entrada ' wslib$by_id ' proporciona las siguientes funciones:

• get_connection(asset_id)

  Esta función accede a una conexión por el ID del activo de conexión.

• get_connected_data(asset_id)

  Esta función accede a un activo de datos conectado mediante el ID del activo de datos conectado.

• load_data(asset_id, attachment_type_or_item = NULL)

  Esta función carga los datos de un activo de datos almacenado pasándole el ID del activo. Vea ' load_data() ' para una descripción de los otros parámetros que puede pasar.

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

  Esta función guarda datos en un activo de datos almacenado pasándole el ID del activo. Esto implica " overwrite=TRUE. Consulte ' save_data() ' para ver una descripción de los demás parámetros que puede pasar.

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

  Esta función descarga los datos de un activo de datos almacenado pasando el ID del activo. Consulte ' download_file() ' para ver una descripción de los demás parámetros que puede pasar.

Acceda directamente al almacenamiento del proyecto

Puede obtener datos del almacén del proyecto y almacenarlos en él sin sincronizar los activos del proyecto utilizando el punto de entrada wslib$storage.

El punto de entrada ' wslib$storage ' proporciona las siguientes funciones:

• fetch_data(filename)

  Esta función devuelve los datos de un fichero como un búfer de bytes. No es necesario registrar el fichero como activo de datos.

  La función toma el siguiente parámetro requerido:

  • filename: El nombre del archivo en el proyecto.

• store_data(filename, data, overwrite = FALSE)

  Esta función guarda los datos de la memoria en el almacenamiento, pero no crea un nuevo activo de datos. La función devuelve una lista que contiene el nombre del archivo, la ruta del archivo e información adicional. Utilice ' Use wslib$show() ' para imprimir la información.

  La función toma los parámetros siguientes:

  • filename: (Obligatorio) El nombre del archivo en el almacén del proyecto.
  • data: (Obligatorio) Los datos a guardar como objeto sin procesar.
  • overwrite: (Opcional) Sobrescribe los datos de un archivo en almacenamiento si ya existe. Por defecto, este valor es falso.

• download_file(storage_filename, local_filename = NULL)

  Esta función descarga los datos de un fichero almacenado y los almacena en el fichero local especificado. El archivo local se sobrescribe si ya existía.

  La función toma los parámetros siguientes:

  • storage_filename: (Obligatorio) Nombre del archivo almacenado que se va a descargar.
  • local_filename: (Opcional) El nombre del archivo en el sistema de archivos local de su tiempo de ejecución para descargar el archivo. Omita este parámetro para utilizar el nombre del archivo de almacenamiento.

• register_asset(storage_path, asset_name = NULL, mime_type = NULL)

  Esta función registra el archivo almacenado como un activo de datos en su proyecto. Esta operación falla si ya existe un activo de datos con el mismo nombre. Puede utilizar esta función si tiene archivos muy grandes que no puede cargar mediante save_data(). Puede cargar archivos grandes directamente en el bucket de IBM Cloud Object Storage de su proyecto, por ejemplo a través de la interfaz de usuario, y luego registrarlos como activos de datos mediante register_asset().

  La función toma los parámetros siguientes:

  • storage_path: (Obligatorio) La ruta del archivo almacenado.
  • asset_name: (Opcional) El nombre del activo creado. Por defecto es el nombre del archivo.
  • mime_type: (Opcional) El tipo MIME para el activo creado. Por defecto, el tipo MIME se determina a partir del sufijo del nombre del activo. Utilice este parámetro para especificar un tipo MIME si su nombre de archivo no tiene una extensión de archivo o si desea establecer un tipo MIME diferente.
  Nota: Puede registrar un archivo varias veces como un activo de datos diferente. Al eliminar uno de esos activos en el proyecto, también se elimina el archivo almacenado, lo que significa que otras referencias de activos al archivo podrían romperse.

Soporte Spark

El punto de entrada ' wslib$spark ' proporciona funciones para acceder a archivos almacenados con Spark.

El punto de entrada ' wslib$spark ' proporciona las siguientes funciones:

• provide_spark_context(sc)

  Utilice esta función para activar la compatibilidad con Spark.

  La función toma el siguiente parámetro requerido:

  • sc: El SparkContext. Se proporciona en el tiempo de ejecución del cuaderno.

    El siguiente ejemplo muestra cómo configurar el soporte de Spark:

    library(ibmWatsonStudioLib)
    wslib <- access_project_or_space(list("token"="<ProjectToken>"))
    wslib$spark$provide_spark_context(sc)
    

• get_data_url(asset_name)

  Esta función devuelve una URL para acceder a un archivo en almacenamiento desde Spark a través de Hadoop.

  La función toma el siguiente parámetro requerido:

  • asset_name: El nombre del activo.

• storage.get_data_url(file_name)

  Esta función devuelve una URL para acceder a un archivo en almacenamiento desde Spark a través de Hadoop. La función espera el nombre del archivo y no el nombre del activo.

  La función toma el siguiente parámetro requerido:

  • file_name: El nombre de un archivo en el almacén del proyecto.

Examinar los activos del proyecto

El punto de entrada ' wslib$assets ' proporciona acceso genérico de sólo lectura a activos de cualquier tipo. Para determinados tipos de activos, existen funciones específicas que proporcionan datos adicionales.

Se aplican los convenios de denominación siguientes:

• Las funciones denominadas ' list_<something> ' devuelven una lista de listas denominadas. Cada lista contenida representa un activo e incluye un pequeño conjunto de propiedades (metadatos) que lo identifican.
• Las funciones denominadas ' get_<something> ' devuelven una única lista con las propiedades del activo.

Para imprimir una lista o varias listas con nombre, utilice ' wslib$show().

Las funciones esperan como parámetro el nombre de un bien o un elemento de una lista. Por defecto, las funciones sólo devuelven un subconjunto de las propiedades disponibles de los activos. Estableciendo el parámetro ' raw_info=TRUE, puede obtener el conjunto completo de propiedades de los activos.

El punto de entrada ' wslib$assets ' proporciona las siguientes funciones:

• list_assets(asset_type, name = NULL, query = NULL, selector = NULL, raw_info = FALSE)

  Esta función enumera todos los activos para el tipo dado con respecto a las restricciones dadas.

  La función toma los parámetros siguientes:

  • asset_type: (Obligatorio) El tipo de los activos a listar, por ejemplo ' data_asset. Consulte " list_asset_types() " para obtener una lista de los tipos de activos disponibles. Utilice el tipo de activo ' asset ' para la lista de todos los activos disponibles en el proyecto.

  • name: (Opcional) El nombre del activo a listar. Utilice este parámetro si existe más de un activo con el mismo nombre. Sólo puede especificar " name " y " query.

  • query: (Opcional) Cadena de consulta que se pasa a la API común de datos y IA para buscar activos. Sólo puede especificar " name " y " query.

  • selector: (Opcional) Una función de filtro personalizada en los elementos de la lista de activos candidatos. Si la función de selección devuelve " TRUE", el bien se incluye en la lista de bienes devuelta.

  • raw_info: (Opcional) Devuelve todos los metadatos disponibles. Por defecto, el parámetro se establece en ' FALSE y sólo se devuelve un subconjunto de las propiedades.

    Ejemplos de utilización de la función " 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)

  Esta función enumera todos los tipos de activos disponibles.

  La función puede tomar el siguiente parámetro:

  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

• list_datasource_types(raw_info = FALSE)

  Esta función enumera todos los tipos de fuentes de datos disponibles.

  La función puede tomar el siguiente parámetro:

  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

• get_asset(name_or_item, asset_type=None, raw_info = FALSE)

  La función devuelve los metadatos de un activo.

  La función toma los parámetros siguientes:

  • name_or_item: (Obligatorio) El nombre del activo o un elemento como los devueltos por " list_assets()

  • asset_type: (Opcional) Tipo de activo. Si el parámetro " name_or_item " contiene una cadena para el nombre del activo, es necesario establecer " asset_type ".

  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

    Ejemplo de utilización de las funciones " list_assets " y " 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)

  Esta función devuelve los metadatos de una conexión.

  La función toma los parámetros siguientes:

  • name_or_item: (Obligatorio) El nombre de la conexión o un elemento como los devueltos por " list_connections()
  • with_datasourcetype: (Opcional) Devuelve información adicional sobre el tipo de fuente de datos de la conexión.
  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

• get_connected_data(name_or_item, with_datasourcetype=False, raw_info = FALSE)

  Esta función devuelve los metadatos de un activo de datos conectado.

  La función toma los parámetros siguientes:

  • name_or_item: (Obligatorio) El nombre del activo de datos conectado o un elemento como los devueltos por " list_connected_data()
  • with_datasourcetype: (Opcional) Devuelve información adicional sobre el tipo de fuente de datos del activo de datos conectado asociado.
  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

• get_stored_data(name_or_item, raw_info = FALSE)

  Esta función devuelve los metadatos de un activo de datos almacenado.

  La función toma los parámetros siguientes:

  • name_or_item: (Obligatorio) El nombre del activo de datos almacenado o un elemento como los devueltos por " list_stored_data()
  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

• list_attachments(name_or_item_or_asset, asset_type=None, raw_info = FALSE)

  Esta función devuelve una lista de los archivos adjuntos de un activo.

  La función toma los parámetros siguientes:

  • name_or_item_or_asset: (Obligatorio) Nombre del activo o de un elemento como los devueltos por " list_stored_data() o " get_asset().

  • asset_type: (Opcional) Tipo de activo. Por defecto es del tipo ' data_asset.

  • raw_info: (Opcional) Devuelve el conjunto completo de metadatos. Por defecto, el parámetro es ' FALSE y sólo se devuelve un subconjunto de las propiedades.

    Ejemplo de utilización de la función " list_attachments " para leer un anexo de un activo de datos almacenado:

    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]])
    

Tema principal: Uso de ibm-watson-studio-lib