0 / 0
Go back to the English version of the documentation
ibm-watson-studio-lib dla Python
Last updated: 03 lis 2023
ibm-watson-studio-lib dla Python

Biblioteka ibm-watson-studio-lib dla języka Python zapewnia dostęp do zasobów. Można go używać w notatnikach, które są tworzone w edytorze notatników. Produkt ibm-watson-studio-lib zapewnia obsługę pracy 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:

  • Zapisane 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 dużych zestawów danych.
  • Połączone zasoby danych reprezentują dane, do których należy uzyskać dostęp za pośrednictwem połączenia. Za pomocą biblioteki można pobrać właściwości (metadane) podłączonego zasobu danych i jego połączenia. Funkcje nie zwracają danych podłączonego zasobu danych. W celu uzyskania dostępu do danych można użyć kodu wygenerowanego po kliknięciu opcji Odczytaj dane w panelu Fragmenty kodu lub napisać własny kod.
Uwaga: Funkcje ` ibm-watson-studio-lib ` nie kodują ani nie dekodują danych podczas zapisywania lub pobierania danych z pliku. Dodatkowo funkcje ` ibm-watson-studio-lib ` nie mogą być używane do uzyskania dostępu do zasobów folderu (plików w ścieżce do pamięci masowej projektu).

Konfigurowanie biblioteki ibm-watson-studio-lib

Biblioteka ibm-watson-studio-lib dla Python jest wstępnie zainstalowana i może zostać zaimportowana bezpośrednio do notatnika 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 dodawana jest komórka z następującymi informacjami:

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

    <ProjectToken> jest wartością znacznika projektu.

    Jeśli w komunikacie zostanie wyświetlona informacja, że nie istnieje znacznik projektu, należy kliknąć odsyłacz w komunikacie, aby przejść do strony Kontrola dostępu projektu, na której można utworzyć znacznik projektu. Użytkownik musi być uprawniony do tworzenia znacznika projektu. Szczegółowe informacje na ten temat zawiera sekcja Ręczne dodawanie znacznika projektu.

    Aby utworzyć znacznik projektu:

    1. Na karcie Zarządzaj wybierz stronę Kontrola dostępu i kliknij opcję Nowy token dostępu w obszarze Tokeny dostępu.
    2. Wprowadź nazwę, wybierz rolę Edytujący dla projektu i 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 programu pomocy

Informacje o obsługiwanych funkcjach w bibliotece ibm-watson-studio-lib można uzyskać programowo przy użyciu funkcji help(wslib)lub dla pojedynczej funkcji przy użyciu funkcji help(wslib.<function_name>, na przykład help(wslib.get_connection).

Funkcji pomocniczej wslib.show(...) można użyć do formatowania drukowania słowników Python i list słowników, które są typowym typem wyniku funkcji ibm-watson-studio-lib .

Funkcje ibm-watson-studio-lib

Biblioteka ibm-watson-studio-lib udostępnia zestaw funkcji pogrupowanych w następujący sposób:

Pobierz informacje o projekcie

Podczas tworzenia kodu może nie być znana dokładna nazwa zasobów danych lub połączeń. Poniższe funkcje udostępniają listy zasobów, z których można wybrać odpowiednie zasoby. We wszystkich przykładach do wydrukowania listy można użyć programu wslib.show(assets) . Indeks każdego elementu jest drukowany przed elementem.

  • 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. Do funkcji get_connection można przekazać element słownika zamiast nazwy.

    Na przykład:

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

    Ta funkcja zwraca połączone zasoby danych. Lista zwróconych połączonych zasobów danych nie jest sortowana według żadnego kryterium i może ulec zmianie po ponownym wywołaniu funkcji. Do funkcji get_connected_data można przekazać element słownika 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. Do funkcji load_data i save_datamożna przekazać element słownika zamiast nazwy.

    Uwaga: W celu odróżnienia połączonych zasobów danych od zapisanych zasobów danych stosowana jest heurystyka. Mogą jednak wystąpić przypadki, w których zasób danych niewłaściwego rodzaju 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.

Pobierz znacznik uwierzytelniania

Niektóre zadania wymagają znacznika uwierzytelniania. Na przykład, aby uruchomić własne żądania dla interfejsu Watson Data API, potrzebny jest znacznik uwierzytelniania.

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

  • get_current_token()

Na przykład:

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

Ta funkcja zwraca token posiadacza, który jest obecnie używany przez bibliotekę ibm-watson-studio-lib .

Pobierz dane

Aby pobrać dane z zasobu danych (pliku) zapisanego w projekcie, można użyć następujących funkcji.

  • load_data(asset_name_or_item, attachment_type_or_item=None)

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

    Funkcja przyjmuje następujące parametry:

    • asset_name_or_item: (wymagane) albo łańcuch z nazwą zapisanego zasobu danych, albo element podobny do zwracanego przez 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 ładowany jest domyślny typ załącznika, czyli data_asset . Ten parametr należy określić, jeśli typem załącznika nie jest data_asset. Jeśli na przykład do zasobu danych zwykłego tekstu dołączono profil z analizy języka naturalnego, można go załadować jako typ załącznika data_profile_nlu.

      Poniżej przedstawiono przykład, w jaki sposób można załadować dane zasobu danych:

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

    Ta funkcja pobiera dane zapisanego zasobu danych i zapisuje je w określonym 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) albo łańcuch z nazwą zapisanego zasobu danych, albo element podobny do zwracanego przez list_stored_data().

    • file_name: (opcjonalnie) nazwa pliku, w którym są zapisywane pobrane dane. Wartością domyślną jest 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 pobierany jest domyślny typ załącznika, czyli data_asset . Ten parametr należy określić, jeśli typem załącznika nie jest data_asset. Na przykład, jeśli do zasobu danych zwykłego tekstu przyłączony jest profil z analizy języka naturalnego, może on zostać przekodowany jako załącznik typu data_profile_nlu.

      Poniżej przedstawiono przykład, w jaki sposób można użyć programu download_file do udostępnienia niestandardowego skryptu Python w notatniku:

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

Zapisz dane

Funkcje zapisywania danych w pamięci masowej projektu wykonują wiele czynności:

  • Zapisz dane w pamięci masowej projektu
  • Dodaj dane jako zasób danych (przez utworzenie zasobu aplikacyjnego lub nadpisanie istniejącego zasobu aplikacyjnego) do projektu, aby wyświetlić dane na liście zasobów danych w projekcie.
  • Powiąż zasób z plikiem w pamięci masowej.

Do składowania danych można użyć następujących funkcji:

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

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

    Funkcja przyjmuje następujące parametry:

    • asset_name_or_item: (wymagane) nazwa utworzonego zasobu aplikacyjnego lub pozycji listy, która jest zwracana przez produkt list_stored_data(). Elementu można użyć, aby nadpisać istniejący plik.

    • data: (wymagane) dane do przesłania. Może to być dowolny obiekt typu bytes-like-object, na przykład bufor bajtowy.

    • overwrite: (Opcjonalnie) Nadpisuje dane zapisanego zasobu danych, jeśli taki zasób już istnieje. Domyślnie jest to wartość false. Jeśli element zasobu aplikacyjnego zostanie przekazany zamiast nazwy, zachowanie polega na zastąpieniu zasobu aplikacyjnego.

    • mime_type: (Opcjonalnie) Typ MIME dla utworzonego zasobu aplikacyjnego. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu. Jeśli używane są nazwy zasobów bez przyrostka, w tym miejscu należy określić typ MIME. Na przykład mime_type=application/text dla danych zwykłego tekstu. Ten parametr jest ignorowany podczas nadpisywania 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 aplikacyjnego nazwa pliku jest określana na podstawie nazwy zasobu aplikacyjnego, ale może być inna. Aby uzyskać bezpośredni dostęp do pliku, można podać jego nazwę. Ten parametr jest ignorowany podczas nadpisywania zasobu aplikacyjnego.

      Poniżej przedstawiono przykład, w jaki sposób można zapisać dane w pliku:

      # Import the lib
      from ibm_watson_studio_lib import access_project_or_space
      wslib = access_project_or_space({"token":"<ProjectToken>"})
      
      # let's assume you have the pandas DataFrame pandas_df which contains the data
      # you want to save as a csv file
      wslib.save_data("my_asset_name.csv", pandas_df.to_csv(index=False).encode())
      
      # the function returns a dict which contains the asset_name, asset_id, file_name and additional information upon successful saving of the data
      
  • upload_file(file_path, asset_name=None, file_name=None, overwrite=False, mime_type=None) 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 tworzonego zasobu danych. Wartością domyślną jest nazwa pliku, który ma zostać przesłany.

    • file_name(Opcjonalnie) Nazwa pliku utworzonego w pamięci masowej powiązanej z projektem. Wartością domyślną jest 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 aplikacyjnego. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu. Jeśli używane są nazwy zasobów bez przyrostka, w tym miejscu należy określić typ MIME. Na przykład mime_type='application/text' dla danych zwykłego tekstu. Ten parametr jest ignorowany podczas nadpisywania zasobu aplikacyjnego.

      Poniżej przedstawiono przykład, w jaki sposób można przesłać plik do projektu:

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

Pobierz informacje o połączeniu

Aby uzyskać dostęp do metadanych 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ć do pobrania danych ze źródła danych połączenia. Użyj wslib.show(connprops) , aby wyświetlić właściwości. Klucz specjalny "." w zwróconym słowniku udostępnia informacje o zasobie połączenia.

    Funkcja przyjmuje następujący wymagany parametr:

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

    Należy zauważyć, że podczas pracy z notatnikami można kliknąć opcję Odczytaj dane na panelu Fragmenty kodu, aby wygenerować kod w celu załadowania danych z połączenia do pandy DataFrame .

Pobierz informacje o połączonych danych

Aby uzyskać dostęp do metadanych podłą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, w tym właściwości połączenia bazowego. Użyj wslib.show() , aby wyświetlić właściwości. Klucz specjalny "." w zwróconym słowniku udostępnia informacje o danych i zasobach połączenia.

    Funkcja przyjmuje następujący wymagany parametr:

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

    Należy zauważyć, że podczas pracy z notatnikami można kliknąć opcję Odczytaj dane w panelu Fragmenty kodu, aby wygenerować kod w celu załadowania danych z połączonego zasobu danych do pandy DataFrame .

Uzyskaj dostęp do zasobu aplikacyjnego według identyfikatora zamiast nazwy

Zaleca się, aby zawsze mieć dostęp do zasobów danych i połączeń przy użyciu unikalnej nazwy. Nazwy zasobów aplikacyjnych nie zawsze muszą być unikalne, a funkcje ibm-watson-studio-lib będą zgłaszać wyjątek, gdy nazwa będzie niejednoznaczna. Aby rozwiązać konflikt, można zmienić nazwy zasobów danych w interfejsie użytkownika.

Uzyskiwanie dostępu do zasobów aplikacyjnych przy użyciu unikalnego identyfikatora jest możliwe, ale nie jest zalecane, ponieważ identyfikatory są poprawne tylko w bieżącym projekcie i spowoduje uszkodzenie kodu podczas przesyłania do innego projektu. Może się to zdarzyć na przykład wtedy, gdy projekty są eksportowane i ponownie importowane. Identyfikator połączenia, połączonego lub zapisanego 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 przy użyciu identyfikatora zasobu połączenia.

  • get_connected_data(asset_id)

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

  • load_data(asset_id, attachment_type_or_item=None)

    Ta funkcja ładuje dane zapisanego zasobu danych, przekazując identyfikator zasobu. Opis innych parametrów, które można przekazać, znajduje się w sekcji load_data() .

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

    Ta funkcja zapisuje dane w zapisanym zasobie danych, przekazując identyfikator zasobu. Oznacza to, że overwrite=True. Opis innych parametrów, które można przekazać, znajduje się w sekcji save_data() .

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

    Ta funkcja pobiera dane zapisanego zasobu danych, przekazując identyfikator zasobu. Opis innych parametrów, które można przekazać, znajduje się w sekcji download_file() .

Bezpośredni dostęp do pamięci masowej projektu

Istnieje możliwość pobrania danych z pamięci masowej projektu i zapisania ich w pamięci masowej projektu bez synchronizowania 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 BytesIO . Plik nie musi być zarejestrowany jako zasób danych.

    Funkcja przyjmuje następujący wymagany parametr:

    • filename: nazwa pliku w pamięci masowej projektu.
  • store_data(filename, data, overwrite=False)

    Ta funkcja zapisuje dane w pamięci masowej, ale nie tworzy nowego zasobu danych. Funkcja zwraca słownik zawierający nazwę pliku, ścieżkę do pliku i dodatkowe informacje. Aby wydrukować informacje, należy użyć komendy 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 obiekt podobny do obiektu bajtowego.
    • overwrite: (Opcjonalnie) Nadpisuje dane pliku w pamięci masowej, jeśli plik już istnieje. Domyślnie jest to wartość false.
  • download_file(storage_filename, local_filename=None)

    Ta funkcja pobiera dane z pliku w pamięci masowej i zapisuje je w określonym 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, który ma zostać pobrany.
    • local_filename(Opcjonalnie) Nazwa pliku w lokalnym systemie plików środowiska wykonawczego, do którego plik ma zostać pobrany. Pomiń ten parametr, aby użyć nazwy zbioru pamięci.
  • register_asset(storage_path, asset_name=None, mime_type=None)

    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.

    Tej funkcji można użyć, jeśli istnieją bardzo duże pliki, których nie można przesłać za pomocą funkcji save_data (). Duże pliki można przesłać bezpośrednio do zasobnika projektu IBM Cloud Object Storage , na przykład za pośrednictwem interfejsu użytkownika, a następnie można je zarejestrować jako zasoby danych przy użyciu programu 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 aplikacyjnego. Wartością domyślną jest nazwa pliku.
    • mime_type: (Opcjonalnie) Typ MIME dla utworzonego zasobu aplikacyjnego. Domyślnie typ MIME jest określany na podstawie przyrostka nazwy zasobu. Ten parametr służy do określania typu MIME, jeśli nazwa pliku nie ma rozszerzenia lub jeśli ma zostać ustawiony inny typ MIME.
    Uwaga: Plik można zarejestrować 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 Spark

Punkt wejścia wslib.spark udostępnia funkcje dostępu do plików w pamięci masowej za pomocą programu Spark. Aby uzyskać informacje pomocnicze na temat dostępnych funkcji, należy użyć programu help(wslib.spark.API).

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

  • provide_spark_context(sc)

    Ta funkcja służy do włączania obsługi produktu Spark.

    Funkcja przyjmuje następujący wymagany parametr:

    • sc: SparkContext. Jest on udostępniany w środowisku wykonawczym notatnika.

    Poniższy przykład przedstawia sposób konfigurowania obsługi Spark:

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

    Ta funkcja zwraca adres URL w celu uzyskania dostępu do pliku w pamięci masowej z programu 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 z programu 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ądanie zasobów aplikacyjnych projektu

Punkt wejścia wslib.assets zapewnia ogólny dostęp tylko do odczytu do zasobów dowolnego typu. Dla wybranych typów zasobów istnieją dedykowane funkcje udostępniające dodatkowe dane. Aby uzyskać pomoc na temat dostępnych funkcji, należy użyć programu help(wslib.assets.API).

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

  • Funkcje o nazwie list_<something> zwracają listę słowników Python . Każdy słownik reprezentuje jeden zasób i zawiera niewielki zestaw właściwości (metadanych), które identyfikują zasób.
  • Funkcje o nazwie get_<something> zwracają pojedynczy słownik Python z właściwościami zasobu.

Aby wydrukować słownik lub listę słowników, należy użyć funkcji wslib.show().

Funkcje oczekują nazwy zasobu lub elementu z listy jako parametru. Domyślnie funkcje zwracają tylko podzbiór dostępnych właściwości zasobów. Ustawiając parametr raw=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=None, query=None, selector=None, raw=False)

    Ta funkcja wyświetla wszystkie zasoby aplikacyjne dla danego typu z uwzględnieniem podanych ograniczeń.

    Funkcja przyjmuje następujące parametry:

    • asset_type: (wymagane) typ zasobów aplikacyjnych do wyświetlenia, na przykład data_asset. Listę dostępnych typów zasobów aplikacyjnych zawiera sekcja list_asset_types() . Użyj typu zasobu aplikacyjnego asset , aby wyświetlić listę wszystkich zasobów aplikacyjnych dostępnych w projekcie.
    • name: (opcjonalnie) nazwa zasobu aplikacyjnego do wyświetlenia. Tego parametru należy użyć, jeśli istnieje więcej niż jeden zasób o takiej samej nazwie. Można podać tylko wartości name i query.
    • query: (Opcjonalnie) Łańcuch zapytania, który jest przekazywany do interfejsu API Watson Data w celu wyszukiwania zasobów. Można podać tylko wartości name i query.
    • selector: (Opcjonalnie) Funkcja filtru niestandardowego dla elementów słownika zasobów kandydackich. Jeśli funkcja selektora zwróci wartość True, zasób aplikacyjny zostanie uwzględniony na zwróconej liście zasobów aplikacyjnych.
    • raw: (Opcjonalnie) Zwraca wszystkie dostępne metadane. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.

    Przykłady użycia funkcji list_assets :

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

    Ta funkcja wyświetla wszystkie dostępne typy zasobów.

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

    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.
  • list_datasource_types(raw=False)

    Ta funkcja wyświetla wszystkie dostępne typy źródeł danych.

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

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

    Funkcja zwraca metadane zasobu.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) nazwa zasobu aplikacyjnego lub elementu podobnego do zwróconego przez list_assets()
    • asset_type: (opcjonalnie) typ zasobu. Jeśli parametr name_or_item zawiera łańcuch określający nazwę zasobu aplikacyjnego, wymagane jest ustawienie parametru asset_type .
    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i 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[0])
    wslib.show(notebook)
    
  • get_connection(name_or_item, with_datasourcetype=False, raw=False)

    Ta funkcja zwraca metadane połączenia.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) nazwa połączenia lub elementu podobnego do zwróconego przez list_connections()
    • with_datasourcetype: (Opcjonalnie) Zwraca dodatkowe informacje o typie źródła danych połączenia.
    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.
  • get_connected_data(name_or_item, with_datasourcetype=False, raw=False)

    Ta funkcja zwraca metadane podłączonego zasobu danych.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) nazwa połączonego zasobu danych lub elementu podobnego do zwróconego przez list_connected_data()
    • with_datasourcetype: (Opcjonalnie) Zwraca dodatkowe informacje o typie źródła danych powiązanego połączonego zasobu danych.
    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.
  • get_stored_data(name_or_item, raw=False)

    Ta funkcja zwraca metadane zapisanego zasobu danych.

    Funkcja przyjmuje następujące parametry:

    • name_or_item: (wymagane) nazwa zapisanego zasobu danych lub elementu podobnego do zwróconego przez list_stored_data()
    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.
  • list_attachments(name_or_item_or_asset, asset_type=None, raw=False)

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

    Funkcja przyjmuje następujące parametry:

    • name_or_item_or_asset: (wymagane) nazwa zasobu aplikacyjnego lub elementu podobnego do zwróconego przez produkt list_stored_data() lub get_asset().
    • asset_type: (opcjonalnie) typ zasobu. Wartością domyślną jest typ data_asset.
    • raw: (opcjonalnie) zwraca pełny zestaw metadanych. Domyślnie parametr ma wartość False i zwracany jest tylko podzbiór właściwości.

    Przykład użycia funkcji list_attachments do odczytania załącznika zapisanego zasobu danych:

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

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