Získat informace o projektu

Během vývoje kódu možná nebudete znát přesné názvy datových aktiv nebo připojení. Následující funkce poskytují seznamy aktiv, ze kterých si můžete vybrat ty relevantní. Ve všech příkladech je možné seznam vytisknout pomocí produktu wslib$show(assets) . Rejstřík každé položky je vytištěn před položkou.

• list_connections()

  Tato funkce vrací seznam připojení. Seznam vrácených připojení není řazen podle žádného kritéria a může se změnit, když znovu zavoláte funkci. Položku seznamu můžete předat namísto názvu do produktu 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()

  Tato funkce vrací připojená datová aktiva. Seznam vrácených připojených datových aktiv není řazen podle žádného kritéria a lze jej změnit, když znovu zavoláte funkci. Položku seznamu můžete předat místo názvu do funkce produktu get_connected_data .

• list_stored_data()

  Tato funkce vrací seznam uložených datových aktiv (datových souborů). Seznam vrácených datových aktiv není řazen podle žádného kritéria a lze jej změnit, když znovu zavoláte funkci. Položku seznamu můžete předat místo názvu do funkcí load_data a save_data .

  Poznámka: Heuristika se používá pro rozlišení mezi spojenými daty a uloženými daty. Mohou však nastat případy, kdy se v vrácených seznamech objeví datové aktivum chybného druhu.

• wslib$here Pomocí tohoto vstupního bodu je možné načíst metadata o projektu, se kterým pracuje knihovna. Vstupní bod wslib$here poskytuje následující funkce:

  • get_name()

    Tato funkce vrací název projektu.

  • get_description()

    Tato funkce vrací popis projektu.

  • get_ID()

    Tato funkce vrací ID projektu.

  • get_storage()

    Tato funkce vrací informace o úložišti pro projekt.

Získat token ověření

Některé úlohy vyžadují token ověření. Chcete-li například spouštět vlastní požadavky na rozhraní Watson Data API, potřebujete token ověření.

K získání tokenu nositele můžete použít následující funkci:

• get_current_token()

Například:

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

Tato funkce vrací token držitele, který je aktuálně používán knihovnou ibm-watson-studio-lib .

Načtení dat

K načtení dat z uloženého datového aktiva (souboru) ve vašem projektu můžete použít následující funkce.

• load_data(asset_name_or_item, attachment_type_or_item = NULL)

  Tato funkce načte data z uloženého datového aktiva do vyrovnávací paměti bajtů. Tato funkce se nedoporučuje pro velké soubory.

  Funkce přijímá následující parametry:

  • asset_name_or_item: (Povinné) Buď řetězec s názvem uloženého datového aktiva nebo položka, jako jsou ty, které vrátil list_stored_data().

  • attachment_type_or_item: (Volitelné) Typ přílohy, který má být načten. Datové aktivum může mít více než jednu přílohu s daty. Bez tohoto parametru je načten výchozí typ připojení, konkrétně data_asset . Tento parametr zadejte v případě, že typ připojení není data_asset. Pokud má například datové aktivum prostého textu připojený profil z Analýza přirozeného jazyka, lze jej načíst jako typ přílohy data_profile_nlu.

    Zde je příklad, který ukazuje, jak načíst data datového aktiva:

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

  Tato funkce stáhne data z uloženého datového aktiva a uloží ji do uvedeného souboru v systému souborů vašeho běhového prostředí. Soubor se přepíše, pokud již existuje.

  Funkce přijímá následující parametry:

  • asset_name_or_item: (Povinné) Buď řetězec s názvem uloženého datového aktiva nebo položka, jako jsou ty, které vrátil list_stored_data().

  • file_name: (Volitelné) Název souboru, do kterého je uložena stažená data. Výchozí hodnota je název přílohy aktiva.

  • attachment_type_or_item: (Volitelné) Typ přílohy, který má být stažen. Datové aktivum může mít více než jednu přílohu s daty. Bez tohoto parametru se stáhne výchozí typ připojení, konkrétně data_asset . Tento parametr zadejte v případě, že typ připojení není data_asset. Pokud má například datové aktivum v prostém textu připojený profil z Analýza přirozeného jazyka, lze jej naložit načíst jako typ přílohy data_profile_nlu.

    Zde je příklad, který vám ukáže, jak můžete použít produkt download_file k vytvoření vlastního skriptu R, který je k dispozici ve vašem notebooku:

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

uložit data

Funkce pro ukládání dat do úložiště projektu dělají více věcí:

• Uložit data do úložiště projektu
• Přidejte data jako datové aktivum (vytvořením aktiva nebo přepsáním existujícího aktiva) do vašeho projektu, abyste si mohli prohlédnout data v seznamu datových aktiv ve svém projektu.
• Přidružte aktivum k souboru v úložišti.

K ukládání dat můžete použít následující funkce:

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

  Tato funkce ukládá data v paměti do úložiště projektu.

  Funkce přijímá následující parametry:

  • asset_name_or_item: (Povinné) Název vytvořeného aktiva nebo položky seznamu, který je vrácen produktem list_stored_data(). Tuto položku můžete použít, chcete-li přepsat existující soubor.

  • data: (Povinné) Data k odeslání. Očekávaný datový typ je raw.

  • overwrite: (Volitelné) Přepíše data uloženého aktiva dat, pokud již existuje. Výchozí hodnota je false. Je-li místo názvu předána položka aktiva, chování přepíše aktivum.

  • mime_type: (Volitelné) Typ MIME pro vytvořené aktivum. Při výchozím nastavení je typ MIME určen z přípony názvu aktiva. Použijete-li názvy aktiv bez přípony, zadejte zde typ MIME. Například mime_type=application/text pro data prostého textu. Tento parametr se ignoruje při přepsání aktiva.

  • file_name: (Volitelné) Název souboru, který má být použit v úložišti projektu. Data se uloží do úložiště přidruženého k projektu. Když vytváříte nové aktivum, název souboru je odvozen od názvu aktiva, ale může být odlišný. Chcete-li k souboru přistoupit přímo, můžete zadat název souboru. Tento parametr se ignoruje při přepsání aktiva.

    Zde je příklad, který ukazuje, jak uložit data do souboru:

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

  Tato funkce ukládá data v systému souborů v běhovém prostředí do souboru, který je přidružen k vašemu projektu.

  Funkce přijímá následující parametry:

  • file_path: (požadováno) Cesta k souboru v systému souborů.

  • asset_name: (Volitelné) Název datového aktiva, které se vytvoří. Výchozí hodnota je název souboru, který má být odeslán.

  • file_name: (Volitelné) Název souboru, který je vytvořen v úložišti přidruženém k projektu. Výchozí hodnota je název souboru, který má být odeslán.

  • overwrite: (Volitelné) Přepíše existující soubor v paměti. Výchozí hodnota je false.

  • mime_type: (Volitelné) Typ MIME pro vytvořené aktivum. Při výchozím nastavení je typ MIME určen z přípony názvu aktiva. Použijete-li názvy aktiv bez přípony, zadejte zde typ MIME. Například mime_type='application/text' pro data prostého textu. Tento parametr se ignoruje při přepsání aktiva.

    Zde je příklad, který ukazuje, jak můžete odeslat soubor do projektu:

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

Získat informace o připojení

Pro přístup k metadatům připojení daného připojení můžete použít následující funkci.

• get_connection(name_or_item)

  Tato funkce vrací vlastnosti (metadata) připojení, které můžete použít k načtení dat ze zdroje dat připojení. Chcete-li zobrazit vlastnosti, použijte volbu wslib$show(connprops) . Speciální klíč "." v navrácené položce seznamu poskytuje informace o aktivu připojení.

  Funkce má následující povinný parametr:

  • name_or_item: Buď řetězec s názvem připojení, nebo položkou, jako např. s názvem, který vrací list_connections().

  Všimněte si, že když pracujete s přenosnými počítači, můžete klepnout na tlačítko Číst data na panelu Úseky kódu, abyste vygenerovali kód pro načtení dat z připojení do pandmas například DataFrame .

Získat informace o připojených datech

Pro přístup k metadatům připojeného datového aktiva můžete použít následující funkci.

• get_connected_data(name_or_item)

  Tato funkce vrací vlastnosti připojeného datového aktiva, včetně vlastností podkladového připojení. Chcete-li zobrazit vlastnosti, použijte volbu wslib$show() . Speciální klíč "." na vraceném seznamu poskytuje informace o datech a aktivech připojení.

  Funkce má následující povinný parametr:

  • name_or_item: Buď řetězec s názvem připojeného datového aktiva nebo položka, jako jsou ty vrácené produktem list_connected_data().

  Všimněte si, že když pracujete s přenosnými počítači, můžete klepnout na tlačítko Číst data na panelu Úseky kódu, abyste vygenerovali kód pro načtení dat z připojeného datového aktiva do pandmas například DataFrame .

Přistoupit k aktivu podle ID namísto názvu

Měli byste přednostně vždy přistupovat k datovým aktivům a připojení pomocí jedinečného názvu. Názvy aktiv nemusí být vždy jedinečné a funkce produktu ibm-watson-studio-lib vyvolají výjimku, je-li název nejednoznačný. V uživatelském rozhraní můžete přejmenovat data aktiv, abyste konflikt vyřešili.

Přístup k aktivům pomocí jedinečného ID je možný, ale je nevhodný, protože ID jsou platná pouze v aktuálním projektu a při přenosu na jiný projekt budou zlomit kód. To se může stát například při exportu projektů a jejich opětovaném importu. ID připojení, připojeného nebo uloženého datového aktiva můžete získat pomocí příslušné funkce seznamu, například list_connections().

Vstupní bod wslib$by_id poskytuje následující funkce:

• get_connection(asset_id)

  Tato funkce přistupuje k připojení pomocí ID aktiva připojení.

• get_connected_data(asset_id)

  Tato funkce přistupuje k propojenému datovému aktivu s pomocí ID připojeného datového aktiva.

• load_data(asset_id, attachment_type_or_item = NULL)

  Tato funkce načte data z uloženého datového aktiva předáním ID aktiva. Popis dalších parametrů, které můžete předat, najdete v části load_data() .

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

  Tato funkce uloží data do uloženého datového aktiva předáním ID aktiva. To znamená overwrite=TRUE. Popis dalších parametrů, které můžete předat, viz save_data() .

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

  Tato funkce stáhne data z uloženého datového aktiva předáním ID aktiva. Popis dalších parametrů, které můžete předat, viz download_file() .

Přístup k úložišti projektu přímo

Můžete načítat data z úložiště projektu a ukládat data do úložiště projektu, aniž byste synchronizovali aktiva projektu pomocí vstupního bodu wslib$storage.

Vstupní bod wslib$storage poskytuje následující funkce:

• fetch_data(filename)

  Tato funkce vrací data v souboru jako vyrovnávací paměť bajtů. Soubor nemusí být registrován jako datové aktivum.

  Funkce má následující povinný parametr:

  • filename: Název souboru v projektu.

• store_data(filename, data, overwrite = FALSE)

  Tato funkce ukládá data v paměti do paměti, ale nevytvoří nové datové aktivum. Funkce vrátí seznam, který obsahuje název souboru, cestu k souboru a další informace. K vytištění informací použijte příkaz Use wslib$show() .

  Funkce přijímá následující parametry:

  • filename: (Povinné) Název souboru v úložišti projektu.
  • data: (Required). Data, která se mají uložit jako prvotní objekt.
  • overwrite: (Volitelné) Přepíše data souboru v paměti, pokud již existuje. Při výchozím nastavení je tato hodnota nastavena na hodnotu false.

• download_file(storage_filename, local_filename = NULL)

  Tato funkce stahuje data do souboru v paměti a ukládá je do zadaného lokálního souboru. Lokální soubor se přepíše, pokud již existuje.

  Funkce přijímá následující parametry:

  • storage_filename: (Povinné) Název souboru v paměti, který se má stáhnout.
  • local_filename: (Volitelné) Název souboru v lokálním systému souborů vašeho běhového prostředí, do kterého má být načten soubor. Chcete-li použít název souboru úložiště, vynechte tento parametr.

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

  Tato funkce zaregistruje soubor v úložišti jako datové aktivum ve vašem projektu. Tato operace selže, pokud aktivum dat se stejným názvem již existuje. Tuto funkci můžete použít, pokud máte velmi rozsáhlé soubory, které nelze odeslat prostřednictvím save_data (). Velké soubory můžete odeslat přímo do sektoru projektu IBM Cloud Object Storage , například prostřednictvím uživatelského rozhraní, a poté je registrovat jako datová aktiva pomocí produktu register_asset().

  Funkce přijímá následující parametry:

  • storage_path: (Povinné) Cesta k souboru v paměti.
  • asset_name: (Volitelné) Název vytvořeného aktiva. Výchozí hodnota je název souboru.
  • mime_type: (Volitelné) Typ MIME pro vytvořené aktivum. Při výchozím nastavení je typ MIME určen z přípony názvu aktiva. Tento parametr použijte k určení typu MIME, pokud váš název souboru nemá příponu souboru nebo chcete-li nastavit jiný typ MIME.
  Pozn.: Můžete registrovat soubor několikrát, jako jiné datové aktivum. Odstranění jednoho z těchto aktiv v projektu také odstraní soubor v paměti, což znamená, že ostatní odkazy na aktivum na soubor mohou být přerušeny.

Podpora parku Spark

Vstupní bod wslib$spark poskytuje funkce pro přístup k souborům v úložišti se Spark.

Vstupní bod wslib$spark poskytuje následující funkce:

• provide_spark_context(sc)

  Použijte tuto funkci, chcete-li povolit podporu produktu Spark.

  Funkce má následující povinný parametr:

  • sc: SparkContext. Je k dispozici v rámci běhového prostředí notebooku.

    Následující příklad ukazuje, jak nastavit podporu produktu Spark:

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

• get_data_url(asset_name)

  Tato funkce vrací adresu URL pro přístup k souboru v úložišti ze Spark přes Hadoop.

  Funkce má následující povinný parametr:

  • asset_name: Název aktiva.

• storage.get_data_url(file_name)

  Tato funkce vrací adresu URL pro přístup k souboru v úložišti ze Spark přes Hadoop. Funkce očekává název souboru a ne název aktiva.

  Funkce má následující povinný parametr:

  • file_name: Název souboru v úložišti projektu.

Procházet aktiva projektu

Vstupní bod wslib$assets poskytuje generický přístup jen pro čtení k aktivům libovolného typu. Pro vybrané typy aktiv jsou k dispozici vyhrazené funkce, které poskytují další data.

Platí následující konvence pojmenování:

• Funkce s názvem list_<something> vrací seznam pojmenovaných seznamů. Každý obsažený seznam znázorňuje jedno aktivum a zahrnuje malou sadu vlastností (metadata), která identifikuje aktivum.
• Funkce s názvem get_<something> vrací jeden pojmenovaný seznam s vlastnostmi pro aktivum.

Chcete-li vytisknout seznam nebo seznam pojmenovaných seznamů, použijte příkaz wslib$show().

Funkce očekávají buď název aktiva, nebo položku ze seznamu jako parametr. Ve výchozím nastavení funkce vrací pouze podmnožinu dostupných vlastností aktiv. Nastavením parametru raw_info=TRUEmůžete získat úplnou sadu vlastností aktiv.

Vstupní bod wslib$assets poskytuje následující funkce:

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

  Tato funkce vypíše všechna aktiva pro daný typ s ohledem na daná omezení.

  Funkce přijímá následující parametry:

  • asset_type: (Required) Typ aktiv, která se mají zobrazit, například data_asset. Seznam dostupných typů aktiv viz list_asset_types() . Použijte typ aktiva asset , chcete-li zobrazit seznam všech dostupných aktiv v projektu.

  • name: (Volitelné) Název aktiva, které chcete vypsat. Tento parametr použijte, pokud existuje více než jedno aktivum se stejným názvem. Můžete zadat pouze name a query.

  • query: (Volitelné) Řetězec dotazu předaný do rozhraní API produktu Watson pro hledání aktiv. Můžete zadat pouze name a query.

  • selector: (Volitelné) Funkce vlastního filtru na kandidátních položkách seznamu aktiv. Pokud funkce selektoru vrátí hodnotu TRUE, je aktivum zahrnuto do seznamu vrácených aktiv.

  • raw_info: (Volitelné) Vrátí všechna dostupná metadata. Při výchozím nastavení je parametr nastaven na hodnotu FALSE a je vrácena pouze část vlastností.

    Příklady použití funkce 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)

  Tato funkce zobrazí seznam všech dostupných typů aktiv.

  Funkce může mít následující parametr:

  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

• list_datasource_types(raw_info = FALSE)

  Tato funkce vypíše všechny dostupné typy zdrojů dat.

  Funkce může mít následující parametr:

  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

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

  Funkce vrátí metadata aktiva.

  Funkce přijímá následující parametry:

  • name_or_item: (Povinné) Název aktiva nebo položky, jako jsou ty, které vrátil list_assets() .

  • asset_type: (Volitelné) Typ aktiva. Pokud parametr name_or_item obsahuje řetězec pro název aktiva, je nastavení asset_type povinné.

  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

    Příklad použití funkcí list_assets a 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)

  Tato funkce vrací metadata připojení.

  Funkce přijímá následující parametry:

  • name_or_item: (Povinné) Název připojení nebo položky jako např. vrácené uživatelem list_connections()
  • with_datasourcetype: (Volitelné) Vrátí další informace o typu zdroje dat připojení.
  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

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

  Tato funkce vrací metadata připojeného datového aktiva.

  Funkce přijímá následující parametry:

  • name_or_item: (Povinné) Název připojeného datového aktiva nebo položky, jako jsou ty, které vrátil list_connected_data()
  • with_datasourcetype: (Volitelné) Vrátí další informace o typu zdroje dat přidruženého připojeného datového aktiva.
  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

• get_stored_data(name_or_item, raw_info = FALSE)

  Tato funkce vrací metadata uloženého aktiva dat.

  Funkce přijímá následující parametry:

  • name_or_item: (Povinné) Název uloženého datového aktiva nebo položky, jako jsou například vrácené produktem list_stored_data() .
  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

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

  Tato funkce vrací seznam příloh aktiva.

  Funkce přijímá následující parametry:

  • name_or_item_or_asset: (Povinné) Název aktiva nebo položky, jako jsou ty, které byly vráceny list_stored_data() nebo get_asset().

  • asset_type: (Volitelné) Typ aktiva. Výchozí hodnota je typ data_asset.

  • raw_info: (Volitelné) Vrátí úplnou sadu metadat. Při výchozím nastavení je parametr FALSE a je vrácena pouze část vlastností.

    Příklad použití funkce list_attachments ke čtení přílohy uloženého datového aktiva:

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

Nadřízené téma: Použití ibm-watson-studio-lib