0 / 0
Go back to the English version of the documentation
ibm-watson-studio-lib for R
Last updated: 10 sie 2023
ibm-watson-studio-lib for R

Biblioteka ibm-watson-studio-lib dla R umożliwia dostęp do zasobów aplikacyjnych. Może być używany w notebookach, które są tworzone w edytorze notatnika lub w programie RStudio w projekcie. Produkt ibm-watson-studio-lib umożliwia pracę z zasobami danych i połączeniami, a także funkcje przeglądania dla wszystkich innych typów zasobów.

Istnieją dwa rodzaje zasobów danych:

  • przechowywane zasoby danych odnoszą się do plików w pamięci masowej powiązanej z bieżącym projektem. Biblioteka może załadować i zapisać te pliki. W przypadku danych większych niż jeden megabajt nie jest to zalecane. Biblioteka wymaga, aby dane były przechowywane w pamięci w całości, co może być nieefektywne podczas przetwarzania wielkich zbiorów danych.
  • Połączone zasoby danych reprezentują dane, które muszą być dostępne za pośrednictwem połączenia. Za pomocą biblioteki można pobrać właściwości (metadane) połączonego zasobu danych i jego połączenie. Funkcje te nie zwracają danych połączonego zasobu danych. Można użyć kodu wygenerowanego dla użytkownika po kliknięciu opcji Odczyt danych na panelu kodu fragmenty kodu w celu uzyskania dostępu do danych lub należy napisać własny kod.
Uwaga: funkcje ` ibm-watson-studio-lib ` nie kodują ani dekodują danych podczas zapisywania danych w pliku lub pobierania danych z pliku. Dodatkowo funkcje ` ibm-watson-studio-lib ` nie mogą być używane do uzyskiwania dostępu do połączonych zasobów folderów (plików znajdujących się na ścieżce do pamięci masowej projektu).

Konfigurowanie biblioteki produktu ibm-watson-studio-lib

Biblioteka ibm-watson-studio-lib dla R jest wstępnie zainstalowana i może być importowana bezpośrednio w notatniku w edytorze notatnika. Aby użyć biblioteki ibm-watson-studio-lib w notatniku, potrzebny jest identyfikator projektu i znacznik projektu.

Aby wstawić znacznik projektu do notatnika:

  1. Kliknij ikonę Więcej na pasku narzędzi notatnika, a następnie kliknij opcję Wstaw znacznik projektu.

    Jeśli znacznik projektu istnieje, do notatnika zostanie dodana komórka z następującymi informacjami:

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

    <ProjectToken> jest wartością znacznika projektu.

    Jeśli w komunikacie powiedziano, że nie istnieje znacznik projektu, należy kliknąć odsyłacz w komunikacie, który ma zostać przekierowany do strony Kontrola dostępu projektu, w której można utworzyć znacznik projektu. Aby utworzyć znacznik projektu, należy kwalifikować się do niego. Szczegółowe informacje na ten temat zawiera sekcja Ręczne dodawanie znacznika projektu.

    Aby utworzyć znacznik projektu:

    1. Na karcie Zarządzanie wybierz stronę Kontrola dostępu , a następnie kliknij opcję Nowy znacznik dostępu w obszarze Znaczniki dostępu.
    2. Wprowadź nazwę, wybierz rolę Edytujący dla projektu, a następnie utwórz znacznik.
    3. Wróć do notatnika, kliknij ikonę Więcej na pasku narzędzi notatnika, a następnie kliknij opcję Wstaw znacznik projektu.

Funkcje produktu ibm-watson-studio-lib

Biblioteka ibm-watson-studio-lib prezentuje zestaw funkcji, które są pogrupowane w następujący sposób:

Pobierz informacje o projekcie

Podczas programowania kodu można nie znać dokładnych nazw zasobów danych lub połączeń. Poniższe funkcje udostępniają listy zasobów aplikacyjnych, z których można wybierać odpowiednie zasoby. Na wszystkich przykładach można użyć programu wslib$show(assets) do ładnego wydrukowania listy. Indeks każdego elementu jest drukowany z przodu elementu.

  • list_connections()

    Ta funkcja zwraca listę połączeń. Lista zwróconych połączeń nie jest sortowana według żadnego kryterium i może ulec zmianie po ponownym wywołaniu funkcji. Istnieje możliwość przekazania pozycji listy zamiast nazwy 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()

    Ta funkcja zwraca połączone zasoby danych. Lista zwróconych zasobów danych połączonych nie jest sortowana według żadnego kryterium i może ulec zmianie po ponownym wywołaniu funkcji. Zamiast nazwy do funkcji get_connected_data można przekazać element listy zamiast nazwy.

  • list_stored_data()

    Ta funkcja zwraca listę zapisanych zasobów danych (plików danych). Lista zwróconych zasobów danych nie jest sortowana według żadnego kryterium i może ulec zmianie po ponownym wywołaniu funkcji. Zamiast nazwy do funkcji load_data i save_data można przekazać element listy zamiast nazwy.

    Uwaga: heurystyczny jest stosowany w celu odróżnienia zasobów powiązanych danych i przechowywanych zasobów danych. Mogą jednak wystąpić sytuacje, w których zasób danych o niewłaściwym typie pojawia się na zwróconych listach.
  • wslib$here Korzystając z tego punktu wejścia, można pobrać metadane dotyczące projektu, z którym pracuje biblioteka. Punkt wejścia wslib$here udostępnia następujące funkcje:

    • get_name()

      Ta funkcja zwraca nazwę projektu.

    • get_description()

      Ta funkcja zwraca opis projektu.

    • get_ID()

      Ta funkcja zwraca identyfikator projektu.

    • get_storage()

      Ta funkcja zwraca informacje o pamięci masowej dla projektu.

Pobieranie znacznika uwierzytelniania

Niektóre zadania wymagają znacznika uwierzytelniania. Na przykład, jeśli użytkownik chce uruchomić własne żądania w interfejsie Watson Data API, potrzebny jest znacznik uwierzytelniania.

Aby uzyskać znacznik na okaziciela, można użyć następującej funkcji:

  • get_current_token()

Na przykład:

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

Ta funkcja zwraca znacznik nośnika, który jest obecnie używany przez bibliotekę ibm-watson-studio-lib .

Pobierz dane

Do pobrania danych z przechowywanego zasobu danych (pliku) w projekcie można użyć następujących funkcji.

  • load_data(asset_name_or_item, attachment_type_or_item = NULL)

    Ta funkcja ładuje dane zapisanego zasobu danych do buforu bajtów. Funkcja nie jest zalecana w przypadku bardzo dużych plików.

    Funkcja przyjmuje następujące parametry:

    • asset_name_or_item: (wymagane) Łańcuch o nazwie składowanego zasobu danych lub element podobny do zwróconego przez produkt list_stored_data().

    • attachment_type_or_item: (opcjonalnie) Typ załącznika do załadowania. Zasób danych może mieć więcej niż jeden załącznik z danymi. Bez tego parametru jest ładowany domyślny typ załącznika, a mianowicie data_asset . Należy określić ten parametr, jeśli typem załącznika nie jest data_asset. Jeśli na przykład zasób danych tekstowych w postaci zwykłego tekstu ma dołączony profil z analizy języka naturalnego, można go załadować jako typ załącznika data_profile_nlu.

      Poniżej przedstawiono przykład, który przedstawia sposób ładowania danych zasobu danych:

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

    Ta funkcja pobiera dane z przechowywanego zasobu danych i zapisuje je w podanym pliku w systemie plików środowiska wykonawczego. Plik zostanie nadpisany, jeśli już istnieje.

    Funkcja przyjmuje następujące parametry:

    • asset_name_or_item: (wymagane) Łańcuch o nazwie składowanego zasobu danych lub element podobny do zwróconego przez produkt list_stored_data().

    • file_name: (opcjonalnie) Nazwa pliku, w którym przechowywane są pobrane dane. Domyślnie jest to nazwa załącznika zasobu.

    • attachment_type_or_item: (opcjonalnie) Typ załącznika do pobrania. Zasób danych może mieć więcej niż jeden załącznik z danymi. Bez tego parametru jest pobierany domyślny typ załącznika, czyli data_asset . Należy określić ten parametr, jeśli typem załącznika nie jest data_asset. Na przykład, jeśli zasób danych tekstowych w postaci zwykłego tekstu ma dołączony profil z analizy języka naturalnego, może to zostać obniżone jako typ załącznika data_profile_nlu.

      Poniżej przedstawiono przykład, w którym można użyć programu download_file w celu udostępnienia niestandardowego skryptu R dostępnego w notatniku:

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

Zapisz dane

Funkcje służące do przechowywania danych w pamięci masowej projektu umożliwiają wykonywanie wielu czynności:

  • Przechowywanie danych w pamięci masowej projektu
  • Dodaj dane jako zasób danych (przez utworzenie zasobu lub nadpisanie istniejącego zasobu) do projektu, aby można było zobaczyć dane na liście zasobów danych w projekcie.
  • Powiąż zasób z plikiem w pamięci masowej.

Aby zapisać dane, można użyć następujących funkcji:

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

    Ta funkcja zapisuje dane w pamięci do pamięci masowej projektu.

    Funkcja przyjmuje następujące parametry:

    • asset_name_or_item: (wymagane) Nazwa utworzonego zasobu lub pozycji listy, która jest zwracana przez program list_stored_data(). Elementu można użyć, jeśli ma zostać nadpisany istniejący plik.

    • data: (wymagane) Dane do przesłania. Oczekiwany typ danych to raw.

    • overwrite: (Opcjonalnie) Nadpisuje dane zapisanego zasobu danych, jeśli już istnieje. Wartość domyślna to false. Jeśli pozycja zasobu jest przekazywana zamiast nazwy, zachowanie to spowoduje nadpisanie zasobu.

    • mime_type: (opcjonalnie) Typ MIME dla utworzonego zasobu. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu aplikacyjnego. Jeśli używane są nazwy zasobów bez przyrostka, należy określić typ MIME tutaj. Na przykład mime_type=application/text dla danych zwykłego tekstu. Ten parametr jest ignorowany w przypadku nadpisania zasobu aplikacyjnego.

    • file_name: (opcjonalnie) Nazwa pliku, który ma być używany w pamięci masowej projektu. Dane są zapisywane w pamięci masowej powiązanej z projektem. Podczas tworzenia nowego zasobu nazwa pliku jest uzyskiwaana na podstawie nazwy zasobu aplikacyjnego, ale może być inna. Jeśli chcesz uzyskać bezpośredni dostęp do pliku, możesz podać nazwę pliku. Ten parametr jest ignorowany w przypadku nadpisania zasobu aplikacyjnego.

      Poniżej przedstawiono przykład, w którym można zapisać dane w pliku:

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

    Ta funkcja zapisuje dane w systemie plików w środowisku wykonawczym do pliku powiązanego z projektem.

    Funkcja przyjmuje następujące parametry:

    • file_path: (wymagane) Ścieżka do pliku w systemie plików.

    • asset_name: (opcjonalnie) Nazwa utworzonego zasobu danych. Domyślnie jest to nazwa pliku, który ma zostać przesłany.

    • file_name: (opcjonalnie) Nazwa pliku, który jest tworzony w pamięci masowej powiązanej z projektem. Domyślnie jest to nazwa pliku, który ma zostać przesłany.

    • overwrite: (opcjonalnie) Nadpisuje istniejący plik w pamięci masowej. Wartość domyślna to false.

    • mime_type: (opcjonalnie) Typ MIME dla utworzonego zasobu. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu aplikacyjnego. Jeśli używane są nazwy zasobów bez przyrostka, należy określić typ MIME tutaj. Na przykład mime_type='application/text' dla danych zwykłego tekstu. Ten parametr jest ignorowany w przypadku nadpisania zasobu aplikacyjnego.

      Poniżej przedstawiono przykład, który pokazuje, jak można przesłać plik 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.
      

Pobierz informacje o połączeniu

Aby uzyskać dostęp do metadanych połączenia danego połączenia, można użyć następującej funkcji.

  • get_connection(name_or_item)

    Ta funkcja zwraca właściwości (metadane) połączenia, którego można użyć w celu pobrania danych ze źródła danych połączenia. Aby wyświetlić właściwości, należy użyć programu wslib$show(connprops) . Klucz specjalny "." w zwracanej pozycji listy zawiera informacje na temat zasobu połączenia.

    Funkcja przyjmuje następujący wymagany parametr:

    • name_or_item: łańcuch o nazwie połączenia lub element podobny do zwróconego przez program list_connections().

    Należy zwrócić uwagę, że podczas pracy z notatkami można kliknąć opcję Odczyt danych na panelu fragmenty kodu, aby wygenerować kod w celu załadowania danych z połączenia do pandas DataFrame , na przykład.

Pobierz informacje o połączonym danych

Aby uzyskać dostęp do metadanych połączonego zasobu danych, można użyć następującej funkcji.

  • get_connected_data(name_or_item)

    Ta funkcja zwraca właściwości połączonego zasobu danych, łącznie z właściwościami połączenia bazowego. Aby wyświetlić właściwości, należy użyć programu wslib$show() . Klucz specjalny "." na zwróconej liście udostępnia informacje na temat danych i zasobów aplikacyjnych połączenia.

    Funkcja przyjmuje następujący wymagany parametr:

    • name_or_item: łańcuch o nazwie połączonego zasobu danych lub element podobny do zwróconego przez program list_connected_data().

    Należy zwrócić uwagę, że podczas pracy z notatkami można kliknąć opcję Czytaj dane na panelu fragmenty kodu, aby wygenerować kod w celu załadowania danych z połączonego zasobu danych do pandas DataFrame , na przykład.

Uzyskaj dostęp do zasobu aplikacyjnego według identyfikatora, a nie nazwy

Najlepiej zawsze uzyskiwać dostęp do zasobów danych i połączeń za pomocą unikalnej nazwy. Nazwy zasobów aplikacyjnych nie zawsze zawsze są unikalne, a funkcje produktu ibm-watson-studio-lib podnoszą wyjątek, gdy nazwa jest niejednoznaczna. Istnieje możliwość zmiany nazwy zasobów danych w interfejsie użytkownika w celu rozstrzygnięcia konfliktu.

Uzyskiwanie dostępu do zasobów za pomocą unikalnego identyfikatora jest możliwe, ale nie jest zalecane, ponieważ identyfikatory są poprawne tylko w bieżącym projekcie i będą zerwać kod po przesłaniu do innego projektu. Może to zdarzyć się na przykład wtedy, gdy projekty są eksportowane i ponownie importowane. Identyfikator połączenia, połączonego lub przechowywanego zasobu danych można uzyskać za pomocą odpowiedniej funkcji listy, na przykład list_connections().

Punkt wejścia wslib$by_id udostępnia następujące funkcje:

  • get_connection(asset_id)

    Ta funkcja uzyskuje dostęp do połączenia za pomocą identyfikatora zasobu połączenia.

  • get_connected_data(asset_id)

    Ta funkcja uzyskuje dostęp do połączonego zasobu danych przez powiązany identyfikator zasobu danych.

  • load_data(asset_id, attachment_type_or_item = NULL)

    Ta funkcja ładuje dane z przechowywanego zasobu danych, przekazując identyfikator zasobu. load_data() zawiera opis innych parametrów, które można przekazać.

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

    Ta funkcja zapisuje dane do przechowywanego zasobu danych, przekazując identyfikator zasobu. Oznacza to overwrite=TRUE. Opis innych parametrów, które można przekazać, zawiera sekcja save_data() .

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

    Ta funkcja pobiera dane z zapisywanego zasobu danych, przekazując identyfikator zasobu. Opis innych parametrów, które można przekazać, zawiera sekcja download_file() .

Dostęp do pamięci masowej projektu bezpośrednio

Można pobierać dane z pamięci masowej projektu i zapisywać dane w pamięci masowej projektu bez synchronizacji zasobów aplikacyjnych projektu przy użyciu punktu wejścia wslib$storage.

Punkt wejścia wslib$storage udostępnia następujące funkcje:

  • fetch_data(filename)

    Ta funkcja zwraca dane w pliku jako bufor bajtów. Plik nie musi być zarejestrowany jako zasób danych.

    Funkcja przyjmuje następujący wymagany parametr:

    • filename: nazwa pliku w projekcie.
  • store_data(filename, data, overwrite = FALSE)

    Ta funkcja zapisuje dane w pamięci do pamięci masowej, ale nie tworzy nowego zasobu danych. Funkcja zwraca listę zawierającą nazwę pliku, ścieżkę do pliku oraz dodatkowe informacje. Aby wydrukować informacje, należy użyć programu Use wslib$show() .

    Funkcja przyjmuje następujące parametry:

    • filename: (wymagane) Nazwa pliku w pamięci masowej projektu.
    • data: (wymagane) Dane, które mają zostać zapisane jako surowiec.
    • overwrite: (Opcjonalnie) Nadpisuje dane pliku w pamięci masowej, jeśli już istnieje. Domyślnie wartość ta jest ustawiona na false.
  • download_file(storage_filename, local_filename = NULL)

    Ta funkcja pobiera dane z pliku w pamięci masowej i zapisuje je w podanym pliku lokalnym. Plik lokalny zostanie nadpisany, jeśli już istnieje.

    Funkcja przyjmuje następujące parametry:

    • storage_filename: (wymagane) Nazwa pliku w pamięci masowej do pobrania.
    • local_filename: (opcjonalnie) Nazwa pliku w lokalnym systemie plików środowiska wykonawczego, do którego został pobrany plik. Pomiń ten parametr, aby użyć nazwy pliku pamięci masowej.
  • register_asset(storage_path, asset_name = NULL, mime_type = NULL)

    Ta funkcja rejestruje plik w pamięci masowej jako zasób danych w projekcie. Ta operacja nie powiedzie się, jeśli zasób danych o takiej samej nazwie już istnieje. Funkcji tej można użyć, jeśli masz bardzo duże pliki, których nie możesz przesłać za pomocą save_data (). Duże pliki można przesyłać bezpośrednio do zasobnika IBM Cloud Object Storage projektu, na przykład za pośrednictwem interfejsu użytkownika, a następnie zarejestrować je jako zasoby danych przy użyciu produktu register_asset().

    Funkcja przyjmuje następujące parametry:

    • storage_path: (wymagane) Ścieżka do pliku w pamięci masowej.
    • asset_name: (opcjonalnie) Nazwa utworzonego zasobu. Domyślnie jest to nazwa pliku.
    • mime_type: (opcjonalnie) Typ MIME dla utworzonego zasobu. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu aplikacyjnego. Ten parametr służy do określania typu MIME, jeśli nazwa pliku nie ma rozszerzenia nazwy pliku lub jeśli ma być ustawiony inny typ MIME.
    Uwaga: Można zarejestrować plik kilka razy, jako inny zasób danych. Usunięcie jednego z tych zasobów aplikacyjnych w projekcie powoduje również usunięcie pliku w pamięci masowej, co oznacza, że inne odwołania do tego pliku mogą zostać zerwane.

Obsługa iskra

Punkt wejścia wslib$spark udostępnia funkcje umożliwiające dostęp do plików w pamięci masowej za pomocą Spark.

Punkt wejścia wslib$spark udostępnia następujące funkcje:

  • provide_spark_context(sc)

    Użyj tej funkcji, aby włączyć obsługę Spark.

    Funkcja przyjmuje następujący wymagany parametr:

    • sc: obiekt SparkContext. Jest ona udostępniana w środowisku wykonawczym notatnika.

      W poniższym przykładzie przedstawiono sposób konfigurowania obsługi Spark:

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

    Ta funkcja zwraca adres URL w celu uzyskania dostępu do pliku w pamięci masowej ze Spark za pośrednictwem Hadoop.

    Funkcja przyjmuje następujący wymagany parametr:

    • asset_name: Nazwa zasobu aplikacyjnego.
  • storage.get_data_url(file_name)

    Ta funkcja zwraca adres URL w celu uzyskania dostępu do pliku w pamięci masowej ze Spark za pośrednictwem Hadoop. Funkcja oczekuje nazwy pliku, a nie nazwy zasobu aplikacyjnego.

    Funkcja przyjmuje następujący wymagany parametr:

    • file_name: nazwa pliku w pamięci masowej projektu.

Przeglądaj zasoby aplikacyjne projektu

Punkt wejścia wslib$assets udostępnia ogólny, tylko do odczytu dostęp do zasobów dowolnego typu. W przypadku wybranych typów zasobów dostępne są funkcje dedykowane, które udostępniają dodatkowe dane.

Obowiązują następujące konwencje nazewnictwa:

  • Funkcje o nazwie list_<something> zwracają listę nazwanych list. Każda z zawartych list reprezentuje jeden zasób i zawiera niewielki zestaw właściwości (metadanych), który identyfikuje zasób.
  • Funkcje o nazwie get_<something> zwracają pojedynczą nazwaną listę z właściwościami dla zasobu.

Aby wydrukować listę lub listę nazwanych list, należy użyć opcji wslib$show().

Funkcje oczekują albo nazwy zasobu, albo pozycji z listy jako parametru. Domyślnie funkcje zwracają tylko podzbiór dostępnych właściwości zasobu. Ustawiając parametr raw_info=TRUE, można uzyskać pełny zestaw właściwości zasobu aplikacyjnego.

Punkt wejścia wslib$assets udostępnia następujące funkcje:

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

    Ta funkcja wyświetla listę wszystkich zasobów dla danego typu w odniesieniu do podanych ograniczeń.

    Funkcja przyjmuje następujące parametry:

    • asset_type: (wymagane) Typ zasobów do wyświetlenia, na przykład data_asset. Listę dostępnych typów zasobów można znaleźć w sekcji list_asset_types() . Użyj typu zasobu asset , aby wyświetlić listę wszystkich dostępnych zasobów aplikacyjnych w projekcie.

    • name: (opcjonalnie) Nazwa zasobu do wyświetlenia. Tego parametru należy użyć, jeśli istnieje więcej niż jeden zasób o tej samej nazwie. Można podać tylko name i query.

    • query: (opcjonalnie) Łańcuch zapytania przekazywany do funkcji API Watson Data w celu wyszukania zasobów aplikacyjnych. Można podać tylko name i query.

    • selector: (opcjonalnie) niestandardowa funkcja filtrowania dla pozycji listy zasobów kandydujących. Jeśli funkcja selektora zwraca wartość TRUE, zasób jest uwzględniany w zwróconej liście zasobów aplikacyjnych.

    • raw_info: (opcjonalnie) Zwraca wszystkie dostępne metadane. Domyślnie parametr jest ustawiony na wartość FALSE , a zwracany jest tylko podzbiór właściwości.

      Przykłady użycia funkcji 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)

    Ta funkcja wyświetla listę wszystkich dostępnych typów zasobów.

    Funkcja może przyjąć następujący parametr:

    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.
  • list_datasource_types(raw_info = FALSE)

    Ta funkcja zawiera listę wszystkich dostępnych typów źródeł danych.

    Funkcja może przyjąć następujący parametr:

    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.
  • get_asset(name_or_item, asset_type=None, raw_info = FALSE)

    Funkcja zwraca metadane zasobu.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) Nazwa zasobu lub pozycja taka jak zwracana przez produkt list_assets()

    • asset_type: (opcjonalnie) Typ zasobu. Jeśli parametr name_or_item zawiera łańcuch dla nazwy zasobu, ustawienie asset_type jest wymagane.

    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.

      Przykład użycia funkcji list_assets i 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)

    Ta funkcja zwraca metadane połączenia.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) Nazwa połączenia lub element podobny do zwróconego przez list_connections()
    • with_datasourcetype: (opcjonalnie) Zwraca dodatkowe informacje na temat typu źródła danych połączenia.
    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.
  • get_connected_data(name_or_item, with_datasourcetype=False, raw_info = FALSE)

    Ta funkcja zwraca metadane połączonego zasobu danych.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) Nazwa podłączonego zasobu danych lub element podobny do zwróconego przez list_connected_data()
    • with_datasourcetype: (opcjonalnie) Zwraca dodatkowe informacje na temat typu źródła danych powiązanego połączonego zasobu danych.
    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.
  • get_stored_data(name_or_item, raw_info = FALSE)

    Ta funkcja zwraca metadane składowanego zasobu danych.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) Nazwa przechowywanego zasobu danych lub element podobny do zwróconego przez list_stored_data()
    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.
  • list_attachments(name_or_item_or_asset, asset_type=None, raw_info = FALSE)

    Ta funkcja zwraca listę załączników do zasobu aplikacyjnego.

    Funkcja przyjmuje następujące parametry:

    • name_or_item_or_asset: (wymagane) Nazwa zasobu lub pozycja taka jak zwracana przez produkt list_stored_data() lub get_asset().

    • asset_type: (opcjonalnie) Typ zasobu. Domyślnie jest to typ data_asset.

    • raw_info: (opcjonalnie) Zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość FALSE , a zwracany jest tylko podzbiór właściwości.

      Przykład użycia funkcji list_attachments do odczytu załącznika z zapisywanego zasobu danych:

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

Temat nadrzędny: Korzystanie z biblioteki ibm-watson-studio-lib

Generative AI search and answer
These answers are generated by a large language model in watsonx.ai based on content from the product documentation. Learn more