Python 用の ibm-watson-studio-lib

プロジェクトまたはスペース情報の取得

コードの開発中は、 データ資産 または接続の正確な名前が分からない場合があります。 以下の機能は、 資産 のリストを提供します。このリストから、関連するものを選択できます。 すべての例で、 wslib.show(assets) を使用してリストを整形印刷できます。 各項目のインデックスが項目の前に印刷されます。

• list_connections()

  この関数は、接続のリストを返します。 戻される接続のリストは、何らかの基準によってソートされず、関数を再度呼び出すと変わる可能性があります。 get_connection 関数に、名前の代わりにディクショナリー項目を渡すことができます。 例:

  # Import the lib
  from ibm_watson_studio_lib import access_project_or_space
  wslib = access_project_or_space()
  
  assets = wslib.list_connections()
  wslib.show(assets)
  connprops = wslib.get_connection(assets[0])
  wslib.show(connprops)
  

• list_connected_data()

  この関数は、接続済みの データ資産 を返します。 返される接続済み データ資産 のリストは、何らかの基準でソートされず、関数を再度呼び出すと変わる可能性があります。 get_connected_data 関数に、名前の代わりにディクショナリー項目を渡すことができます。

• list_stored_data()

  この関数は、保管されている データ資産 (データ・ファイル) のリストを返します。 返される データ資産 のリストは、何らかの基準でソートされず、関数を再度呼び出すと変わる可能性があります。 load_data 関数および save_data 関数に、名前の代わりにディクショナリー項目を渡すことができます。

  注: 接続済み データ資産 と保管済み データ資産 を区別するためにヒューリスティックが適用されます。 ただし、戻されたリストに、不適切な種類の データ資産 が表示される場合があります。

• wslib.here<\\br>

  このエントリー・ポイントを使用すると、 lib が処理しているプロジェクトまたはスペースに関するメタデータを取得できます。 エントリー・ポイント wslib.here は、以下の機能を提供します。

  • get_name()

    この関数は、プロジェクトまたはスペースの名前を返します。

  • get_description()

    この関数は、プロジェクトまたはスペースの説明を返します。

  • get_ID()

    この関数は、プロジェクトまたはスペースの ID を返します。

  • get_storage()

    この関数は、プロジェクトまたはスペースのストレージ情報を返します。

認証トークンの取得

一部のタスクでは、認証トークンが必要です。 例えば、 Data and AI Common Core API に対して独自の要求を実行する場合は、認証トークンが必要です。

以下の関数を使用して、ベアラー・トークンを取得できます。

• get_current_token()

例:

from ibm_watson_studio_lib import access_project_or_space
wslib = access_project_or_space()
token = wslib.auth.get_current_token()

この関数は、 ibm-watson-studio-lib ライブラリーによって現在使用されているベアラー・トークンを返します。

データの取り出し

以下の関数を使用して、ワークスペース内の保管済み データ資産 (ファイル) からデータをフェッチできます。

• load_data(asset_name_or_item, attachment_type_or_item=None)

  この関数は、保管されている データ資産 のデータを BytesIO バッファーにロードします。 この関数は、非常に大きなファイルには推奨されません。

  この関数は、以下のパラメーターを取ります。

  • asset_name_or_item: (必須) ストア・ データ資産 の名前を含むストリング、または list_stored_data() によって返されるような項目のいずれか。

  • attachment_type_or_item: (オプション) ロードする添付ファイルのタイプ。 データ資産 は、データを含む複数の添付ファイルを持つことができます。 このパラメーターが指定されない場合、デフォルトの添付タイプ (つまり、 data_asset) がロードされます。 添付タイプが data_asset でない場合は、このパラメーターを指定します。 例えば、プレーン・テキストの データ資産 に自然言語分析からのプロファイルが添付されている場合、これを添付ファイル・タイプ data_profile_nlu としてロードできます。

    データ資産 のデータをロードする方法を示す例を以下に示します。

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space()
    
    # 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)

  この関数は、保管されている データ資産 のデータをダウンロードし、ランタイムのファイル・システム内の指定されたファイルに保管します。 このファイルが既に存在している場合は、上書きされます。

  この関数は、以下のパラメーターを取ります。

  • asset_name_or_item: (必須) ストア・ データ資産 の名前を含むストリング、または list_stored_data() によって返されるような項目のいずれか。

  • file_name: (オプション) ダウンロードしたデータを保管するファイルの名前。 デフォルトでは、 資産 の添付ファイル名が使用されます。

  • attachment_type_or_item: (オプション) ダウンロードする添付ファイルのタイプ。 データ資産 は、データを含む複数の添付ファイルを持つことができます。 このパラメーターが指定されない場合、デフォルトの添付ファイル・タイプ (つまり、 data_asset) がダウンロードされます。 添付タイプが data_asset でない場合は、このパラメーターを指定します。 例えば、プレーン・テキストの データ資産 に自然言語分析からのプロファイルが添付されている場合、これは添付タイプ data_profile_nlu としてダウンロードできます。

    download_file を使用してカスタム・ Python ・スクリプトをノートブックで使用できるようにする方法を示す例を以下に示します。

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space()
    
    # 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()
    

データの保存

プロジェクト・ストレージにデータを保存する関数は、複数のことを行います。

• プロジェクト・ストレージにデータを保管する
• データ資産 としてデータをワークスペース (例えば、プロジェクト) に追加し (資産 を作成するか、既存の 資産 を上書き)、ワークスペースの データ資産 リストにデータを表示できるようにします。
• 資産 をストレージ内のファイルに関連付けます。

以下の関数を使用して、データを保存できます。

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

  この関数は、メモリー内のデータをワークスペースに保存します。

  この関数は、以下のパラメーターを取ります。

  • asset_name_or_item: (必須) list_stored_data() によって返される、作成された 資産 またはリスト項目の名前。 既存のファイルを上書きする場合は、この項目を使用できます。

  • data: (必須) アップロードするデータ。 これは、 bytes-like-object タイプの任意のオブジェクト (例えば、バイト・バッファー) にすることができます。

  • overwrite: (オプション) 既に存在する場合に、保管されている データ資産 のデータを上書きします。 デフォルトでは、これは false に設定されています。 名前の代わりに 資産 項目が渡されると、 資産 が上書きされます。

  • mime_type: (オプション) 作成される 資産 の MIME タイプ。 デフォルトでは、 MIME タイプは 資産 名の接尾部から判別されます。 資産 名を接尾部なしで使用する場合は、ここで MIME タイプを指定します。 例えば、プレーン・テキスト・データの場合は mime_type=application/text です。 資産 を上書きする場合、このパラメーターは無視されます。

  • file_name: (オプション) ワークスペース・ストレージで使用されるファイル名。 データは、ワークスペースに関連付けられたストレージに保存されます。 新規 資産 を作成する場合、ファイル名は 資産 名から派生しますが、異なる場合があります。 ファイルに直接アクセスする場合は、ファイル名を指定できます。 資産 を上書きする場合、このパラメーターは無視されます。

    次に、データをファイルに保存する方法を示す例を示します。

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space()
    
    # 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) この関数は、ランタイムのファイル・システム内のデータを、ワークスペース (例えば、プロジェクト) に関連付けられたファイルに保存します。 この関数は、以下のパラメーターを取ります。

  • file_path: (必須) ファイル・システム内のファイルへのパス。

  • asset_name: (オプション) 作成される データ資産 の名前。 デフォルトでは、アップロードされるファイルの名前になります。

  • file_name: (オプション) ワークスペースに関連付けられたストレージ内に作成されるファイルの名前。 デフォルトでは、アップロードされるファイルの名前になります。

  • overwrite: (オプション) ストレージ内の既存のファイルを上書きします。 デフォルトは false です。

  • mime_type: (オプション) 作成される 資産 の MIME タイプ。 デフォルトでは、 MIME タイプは 資産 名の接尾部から判別されます。 資産 名を接尾部なしで使用する場合は、ここで MIME タイプを指定します。 例えば、プレーン・テキスト・データの場合は mime_type='application/text' です。 資産 を上書きする場合、このパラメーターは無視されます。

    以下に、ファイルをワークスペースにアップロードする方法を示す例を示します。

    # Import the lib
    from ibm_watson_studio_lib import access_project_or_space
    wslib = access_project_or_space()
    
    # 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.
    # The value `input_file_copied` tells you, if the file has been copied to project # storage.
    # If the value is true, you can savely delete the local input file.
    # If the value is false, you should not delete the input file because it already
    # exists in the mounted project storage. Deleting the file
    # from the mounted project storage will corrupt the created asset.
    # The return value can be passed to load_data() to read back the data.
    

接続情報の取得

以下の関数を使用して、指定された接続の接続メタデータにアクセスできます。

• get_connection(name_or_item)

  この関数は、接続データ・ソースからデータを取り出すために使用できる接続のプロパティー (メタデータ) を返します。 wslib.show(connprops) を使用して、プロパティーを表示します。 戻されたディクショナリー内の特殊キー "." は、接続 資産 に関する情報を提供します。

  この関数は、以下の必須パラメーターを取ります。

  • name_or_item: 接続の名前を含むストリング、または list_connections() によって返されるような項目。

  ノートブックで作業する場合、「コード・スニペット」ペインの データの読み取り をクリックすると、例えば、接続から pandas DataFrame にデータをロードするためのコードを生成できます。

接続済みデータ情報の取得

以下の関数を使用して、接続された データ資産 のメタデータにアクセスできます。

• get_connected_data(name_or_item)

  この関数は、基礎となる接続のプロパティーを含め、接続済みの データ資産 のプロパティーを返します。 wslib.show() を使用して、プロパティーを表示します。 返されるディクショナリー内の特殊キー "." は、データと接続 資産 に関する情報を提供します。

  この関数は、以下の必須パラメーターを取ります。

  • name_or_item: 接続されている データ資産 の名前を含むストリング、または list_connected_data() によって返されるような項目のいずれか。

  ノートブックで作業する場合、「コード・スニペット」ペインの データの読み取り をクリックすると、例えば、接続された データ資産 から pandas DataFrame にデータをロードするためのコードを生成できます。

名前ではなく ID による 資産 へのアクセス

データ資産 と接続には、常に固有の名前でアクセスすることをお勧めします。 資産 名は必ずしも常に固有であるとは限らず、 ibm-watson-studio-lib 関数は、名前があいまいな場合に例外を発生させます。 データ資産 の名前を UI で変更して、競合を解決できます。

固有 ID による 資産 へのアクセスは可能ですが、 ID は現行ワークスペースでのみ有効であり、別のワークスペースに転送するとコードが壊れるため、推奨されません。 これは、例えば、プロジェクトがエクスポートされて再インポートされた場合、またはノートブックまたは 資産 がプロジェクトからスペースにプロモートされた場合に発生する可能性があります。 接続、接続済み データ資産、または保管済み の ID は、対応するリスト関数 (例えば list_connections()) を使用して取得できます。

エントリー・ポイント wslib.by_id は、以下の機能を提供します。

• get_connection(asset_id)

  この関数は、接続 資産 ID によって接続にアクセスします。

• get_connected_data(asset_id)

  この関数は、接続済み データ資産 ID によって接続済み データ資産 にアクセスします。

• load_data(asset_id, attachment_type_or_item=None)

  この関数は、 資産 ID を渡すことによって、保管されている データ資産 のデータをロードします。 渡すことができる他のパラメーターの説明については、 load_data() を参照してください。

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

  この関数は、 資産 ID を渡すことによって、データを保管済み データ資産 に保存します。 これは、 overwrite=True を暗黙に示します。 渡すことができる他のパラメーターの説明については、 save_data() を参照してください。

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

  この関数は、 資産 ID を渡すことによって、保管されている データ資産 のデータをダウンロードします。 渡すことができる他のパラメーターの説明については、 download_file() を参照してください。

マウントされたプロジェクト・ストレージの処理

コードが実行されているランタイムは、エントリー・ポイント wslib.mount を使用して、 データ資産 をマウントされたファイル・システム内のプレーン・ファイルとして使用可能にすることができます。 例えば、プロジェクトまたはスペースのストレージは、ノートブック・ランタイムにマウントされます。 この場合、 データ資産 へのアクセスは、内容をコピーする代わりにファイルから直接読み取ることにより、より効率的に行うことができます。

mount.is_available() 関数が True を返した場合、以下の関数を使用できます。 関数が False を返し、 データ資産 が含まれているファイル・システムがマウントされていない場合は、 データのフェッチ および データの保存 で説明されている関数を使用してデータを処理できます。

• is_available()

  この関数は、プロジェクト・ストレージがローカル・ファイル・システム内のマウントとして使用可能かどうかを検査します。

• get_base_dir()

  この関数は、ローカル・ファイル・システム内の データ資産 フォルダーへの絶対パスを返します。

• get_data_path(asset_name_or_item)

  この関数は、ローカル・ファイル・システム内の データ資産 によって参照されるファイルの絶対パスを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item: (必須) ストア・ データ資産 の名前を含むストリング、または list_stored_data() によって返されるような項目のいずれか。

• register_asset(file_path, asset_name=None, mime_type=None)

  この関数は、ローカル・マウント内のファイルをプロジェクトまたはスペース内の データ資産 として登録します。 同じ名前の データ資産 が既に存在する場合、この操作は失敗します。

  この関数は、以下のパラメーターを取ります。

  • file_path: (必須) ローカルにマウントされたプロジェクトまたはスペース・ストレージ内のファイルへの絶対パス。
  • asset_name: (オプション) 作成された 資産 の名前。 デフォルトでは、ファイル名が使用されます。
  • mime_type: (オプション) 作成される 資産 の MIME タイプ。 デフォルトでは、 MIME タイプは 資産 名の接尾部から判別されます。 ファイル名にファイル拡張子がない場合、または別の MIME タイプを設定する場合は、このパラメーターを使用して MIME タイプを指定します。

  以下の例は、マウントされたプロジェクト・ストレージにファイルを 資産 として登録する方法を示しています。

  # Import the lib
  from ibm_watson_studio_lib import access_project_or_space
  wslib = access_project_or_space()
  
  # Let's assume you have a really large file that you cannot
  # upload to your project via 'save_data()' or 'upload_file()',
  # because those methods require the data to fit into memory.
  my_large_file = "my_large_file.csv"
  
  # Move the file to the data assets folder in the
  # mounted project storage:
  data_asset_folder = wslib.mount.get_base_dir()
  import os, shutil
  target_path = os.path.join(data_asset_folder, my_large_file)
  shutil.move(my_large_file, target_path)
  
  # Register the file as data asset
  wslib.mount.register_asset(target_path, asset_name="LargeFile.csv")
  
  # the function returns a dict which contains the asset_name, asset_id, file_name and additional information upon successful creation of the data asset.
  

  注: ファイルは、異なる データ資産 として複数回登録できます。 プロジェクト・インターフェースでこれらの 資産 の 1 つを削除すると、ストレージ内のファイルも削除されます。これは、そのファイルへの他の 資産 参照が壊れている可能性があることを意味します。

プロジェクト・ストレージへの直接アクセス

エントリー・ポイント wslib.storage を使用してプロジェクト・ 資産 を同期させることなく、プロジェクト・ストレージからデータをフェッチしたり、プロジェクト・ストレージにデータを保管したりすることができます。

プロジェクトまたはスペースのストレージはノートブック・ランタイムにマウントされ、通常はエントリー・ポイント wslib.mount およびファイル・システム操作を使用してストレージにアクセスします。

エントリー・ポイント wslib.storage は、以下の機能を提供します。

• fetch_data(filename)

  この関数は、ファイル内のデータを BytesIO バッファーとして返します。 ファイルは、 データ資産 として登録する必要はありません。

  この関数は、以下の必須パラメーターを取ります。

  • filename: ワークスペース・ストレージ内のファイルの名前。

• store_data(filename, data, overwrite=False)

  この関数は、メモリー内のデータをストレージに保存しますが、新しい データ資産 は作成しません。 この関数は、ファイル名、ファイル・パス、および追加情報を含むディクショナリーを返します。 wslib.show() を使用して情報を印刷します。

  この関数は、以下のパラメーターを取ります。

  • filename: (必須) ワークスペース・ストレージ内のファイルの名前。
  • data: (必須) バイト型オブジェクトとして保存するデータ。
  • overwrite: (オプション) ストレージ内にファイルが既に存在する場合に、そのファイルのデータを上書きします。 デフォルトでは、これは false に設定されています。

• download_file(storage_filename, local_filename=None)

  この関数は、ストレージ内のファイルにデータをダウンロードし、指定されたローカル・ファイルに保管します。 ローカル・ファイルが既に存在する場合、そのファイルは上書きされます。

  この関数は、以下のパラメーターを取ります。

  • storage_filename: (必須) ストレージ内のダウンロードするファイルの名前。
  • local_filename: (オプション) ファイルのダウンロード先となるランタイムのローカル・ファイル・システム内のファイルの名前。 ストレージ・ファイル名を使用するには、このパラメーターを省略します。

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

  この関数は、ストレージ内のファイルをワークスペース内の データ資産 として登録します。 同じ名前の データ資産 が既に存在する場合、この操作は失敗します。

  この関数は、以下のパラメーターを取ります。

  • storage_path: (必須) ストレージ内のファイルのパス。
  • asset_name: (オプション) 作成された 資産 の名前。 デフォルトでは、ファイル名が使用されます。
  • mime_type: (オプション) 作成される 資産 の MIME タイプ。 デフォルトでは、 MIME タイプは 資産 名の接尾部から判別されます。 ファイル名にファイル拡張子がない場合、または別の MIME タイプを設定する場合は、このパラメーターを使用して MIME タイプを指定します。
  注: ファイルは、異なる データ資産 として複数回登録できます。 プロジェクト内のこれらの 資産 の 1 つを削除すると、ストレージ内のファイルも削除されます。これは、そのファイルへの他の 資産 参照が壊れている可能性があることを意味します。

プロジェクト 資産 の参照

エントリー・ポイント wslib.assets は、任意のタイプの 資産 への汎用の読み取り専用アクセスを提供します。 選択した 資産 ・タイプには、追加データを提供する専用の機能があります。 使用可能な関数に関するヘルプを表示するには、 help(wslib.assets.API) を使用します。

以下の命名規則が適用されます。

• list_<something> という名前の関数は、 Python 辞書のリストを返します。 各ディクショナリーは 1 つの 資産 を表し、 資産 を識別する一連の小規模なプロパティー (メタデータ) を含んでいます。
• get_<something> という名前の関数は、 資産 のプロパティーを含む単一の Python ディクショナリーを返します。

ディクショナリーまたはディクショナリーのリストを整形印刷するには、 wslib.show() を使用します。

これらの関数は、パラメーターとして 資産 の名前またはリストからの項目のいずれかを予期します。 デフォルトでは、関数は、使用可能な 資産 プロパティーのサブセットのみを返します。 パラメーター raw=True を設定すると、 資産 プロパティーの完全なセットを取得できます。

エントリー・ポイント wslib.assets は、以下の機能を提供します。

• list_assets(asset_type, name=None, query=None, selector=None, raw=False)

  この関数は、指定された制約に従って、指定されたタイプのすべての 資産 をリストします。

  この関数は、以下のパラメーターを取ります。

  • asset_type: (必須) リストする 資産 のタイプ (例: data_asset)。 使用可能な 資産 ・タイプのリストについては、 list_asset_types() を参照してください。 ワークスペース内の使用可能なすべての 資産 のリストには、 資産 ・タイプ asset を使用してください。
  • name: (オプション) リストする 資産 の名前。 同じ名前の 資産 が複数存在する場合は、このパラメーターを使用します。 name または query のいずれかのみを指定できます。
  • query: (オプション) 資産 を検索するために Data and AI Common Core API に渡される クエリー ストリング。 name または query のいずれかのみを指定できます。
  • selector: (オプション) 候補の 資産 辞書項目に対するカスタム・フィルター関数。 セレクター関数が True を返す場合、 資産 は、返される 資産 リストに含まれます。
  • raw: (オプション) 使用可能なすべてのメタデータを返します。 デフォルトでは、このパラメーターは False に設定され、プロパティーのサブセットのみが返されます。

  list_assets 関数の使用例:

  # Import the lib
  from ibm_watson_studio_lib import access_project_or_space
  wslib = access_project_or_space()
  
  # List all assets in the project or space
  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 1 MB
  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)

  この関数は、使用可能なすべての 資産 ・タイプをリストします。

  この関数は、以下のパラメーターを取ることができます。

  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

• list_datasource_types(raw=False)

  この関数は、使用可能なすべてのデータ・ソース・タイプをリストします。

  この関数は、以下のパラメーターを取ることができます。

  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

• get_asset(name_or_item, asset_type=None, raw=False)

  この関数は、 資産 のメタデータを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item: (必須) 資産 の名前、または list_assets() によって返されるような項目の名前
  • asset_type: (オプション) 資産 のタイプ。 パラメーター name_or_item に 資産 の名前のストリングが含まれている場合は、 asset_type を設定する必要があります。
  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

  list_assets 関数と 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)

  この関数は、接続のメタデータを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item: (必須) 接続の名前、または list_connections() から返される項目の名前。
  • with_datasourcetype: (オプション) 接続のデータ・ソース・タイプに関する追加情報を返します。
  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

• get_connected_data(name_or_item, with_datasourcetype=False, raw=False)

  この関数は、接続された データ資産 のメタデータを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item: (必須) 接続済みの データ資産 または list_connected_data() によって返されるような項目の名前
  • with_datasourcetype: (オプション) 関連付けられた接続済み データ資産 のデータ・ソース・タイプに関する追加情報を返します。
  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

• get_stored_data(name_or_item, raw=False)

  この関数は、保管されている データ資産 のメタデータを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item: (必須) 保管されている データ資産 の名前、または list_stored_data() によって返されるような項目の名前
  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

• list_attachments(name_or_item_or_asset, asset_type=None, raw=False)

  この関数は、 資産 の添付ファイルのリストを返します。

  この関数は、以下のパラメーターを取ります。

  • name_or_item_or_asset: (必須) 資産 の名前、または list_stored_data() や get_asset() などの項目の名前。
  • asset_type: (オプション) 資産 のタイプ。 デフォルトでは、タイプ data_asset になります。
  • raw: (オプション) メタデータの完全なセットを返します。 デフォルトでは、このパラメーターは False で、一部のプロパティーのみが返されます。

  list_attachments 関数を使用して、保管された データ資産 の添付ファイルを読み取る例:

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