Python 용 ibm-watson-studio-lib
라이브러리는 자산에 대한 액세스를 제공합니다. 노트북 편집기에서 작성된 노트북에서 사용할 수 있습니다. ibm-watson-studio-lib
에서는 데이터 자산 및 연결에 대한 작업과 기타 모든 자산 유형에 대한 찾아보기 기능을 지원합니다.
ibm-watson-studio-lib
' 라이브러리는 이전에 Watson Studio 알려진 watsonx.ai Studio용입니다.다음과 같은 두 가지 유형의 데이터 자산이 있습니다.
- 저장된 데이터 자산 은 현재 프로젝트와 연관된 스토리지의 파일을 참조합니다. 라이브러리는 이러한 파일을 로드하고 저장할 수 있습니다. 1MB보다 큰 데이터의 경우에는 권장되지 않습니다. 라이브러리에서는 데이터 전체를 메모리에 보관해야 합니다. 이는 대용량 데이터 세트를 처리할 때 비효율적일 수 있습니다.
- 연결된 데이터 자산 은 연결을 통해 액세스해야 하는 데이터를 나타냅니다. 라이브러리를 사용하여 연결된 데이터 자산 및 해당 연결의 특성 (메타데이터) 을 검색할 수 있습니다. 함수는 연결된 데이터 자산의 데이터를 리턴하지 않습니다. 코드 스니펫 분할창에서 데이터 읽기 를 클릭하여 데이터에 액세스할 때 생성된 코드를 사용하거나 사용자 고유의 코드를 작성해야 합니다.
ibm-watson-studio-lib
함수는 파일에 데이터를 저장하거나 파일에서 데이터를 가져올 때 데이터를 인코딩하거나 디코딩하지 않습니다. 또한 ibm-watson-studio-lib
기능을 사용하여 연결된 폴더 자산 (프로젝트 스토리지의 경로에 있는 파일) 에 액세스할 수 없습니다.ibm-watson-studio-lib
라이브러리 설정
노트북에서 프로젝트 에셋에 액세스하려면 ' ibm-watson-studio-lib
'을 초기화합니다. Python ' ibm-watson-studio-lib
' 라이브러리는 사전 설치되어 있으며 노트북 편집기의 노트북에서 직접 가져올 수 있습니다.
프로젝트 에셋에 액세스할 수 있는 코드를 삽입합니다:
노트북 도구 모음에서 추가 아이콘을 클릭한 후 프로젝트 토큰 삽입을 클릭하십시오.
프로젝트 토큰이 존재하면 다음 정보와 함께 셀이 노트북에 추가됩니다.
from ibm_watson_studio_lib import access_project_or_space wslib = access_project_or_space({"token":"<ProjectToken>"})
프로젝트 토큰이 존재하지 않으면 경고 메시지가 표시됩니다. 메시지의 링크를 클릭하면 프로젝트 토큰을 만들 수 있는 프로젝트의 액세스 제어 페이지로 리디렉션됩니다. 프로젝트 토큰을 작성할 수 있어야 합니다. 자세한 내용은 수동으로 프로젝트 토큰 추가를 참조하십시오.
프로젝트 토큰을 작성하려면 다음을 수행하십시오.
- 관리 탭에서 액세스 제어 페이지를 선택하고 액세스 토큰 아래에서 새 액세스 토큰을 클릭하십시오.
- 이름을 입력하고, 프로젝트의 편집기 역할을 선택한 후 토큰을 작성하십시오.
- 노트북으로 돌아가 노트북 도구 모음에서 추가 아이콘을 클릭한 후 프로젝트 토큰 삽입을 클릭하십시오.
헬퍼 기능
help(wslib)
를 사용하여 ibm-watson-studio-lib
라이브러리에서 지원되는 함수에 대한 정보를 프로그래밍 방식으로 가져오거나 help(wslib.<function_name>
를 사용하여 개별 함수에 대한 정보를 얻을 수 있습니다 (예: help(wslib.get_connection)
).
ibm-watson-studio-lib
함수의 공통 결과 출력 유형인 Python 사전 및 사전 목록의 형식화된 인쇄를 위해 헬퍼 함수 wslib.show(...)
를 사용할 수 있습니다.
ibm-watson-studio-lib
함수
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({"token":"<ProjectToken>"}) 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()
이 함수는 프로젝트에 대한 스토리지 정보를 리턴합니다.
인증 토큰 가져오기
일부 태스크에는 인증 토큰이 필요합니다. 예를 들어, 데이터 및 AI 공통 코어 API에 대해 자체 요청을 실행하려면 인증 토큰이 필요합니다.
다음 함수를 사용하여 베어러 토큰을 가져올 수 있습니다.
get_current_token()
예를 들어,
from ibm_watson_studio_lib import access_project_or_space
wslib = access_project_or_space({"token":"<ProjectToken>"})
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({"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)
이 함수는 저장된 데이터 자산의 데이터를 다운로드하고 런타임의 파일 시스템에서 지정된 파일에 저장합니다. 파일이 이미 있는 경우 겹쳐씁니다.
함수는 다음 매개변수를 사용합니다.
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({"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()
데이터 저장
프로젝트 스토리지에 데이터를 저장하는 기능은 다음과 같은 여러 작업을 수행합니다.
- 프로젝트 스토리지에 데이터 저장
- 프로젝트의 데이터 자산 목록에서 데이터를 볼 수 있도록 프로젝트에 데이터 자산으로 데이터를 추가하십시오 (자산을 작성하거나 기존 자산을 겹쳐씀).
- 자산을 스토리지의 파일과 연관시키십시오.
다음 기능을 사용하여 데이터를 저장할 수 있습니다.
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({"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)
이 기능은 런타임 시 파일 시스템의 데이터를 프로젝트와 연관된 파일에 저장합니다. 함수는 다음 매개변수를 사용합니다.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({"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.
연결 정보 가져오기
다음 함수를 사용하여 지정된 연결의 연결 메타데이터에 액세스할 수 있습니다.
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가 현재 프로젝트에서만 유효하고 다른 프로젝트로 전송될 때 코드가 중단되므로 권장되지 않습니다. 이는 예를 들어, 프로젝트를 내보내고 다시 가져올 때 발생할 수 있습니다. 해당 목록 함수 (예: list_connections()
) 를 사용하여 연결, 연결 또는 저장된 데이터 자산의 ID를 가져올 수 있습니다.
시작점 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.storage
를 사용하여 프로젝트 자산을 동기화하지 않고 프로젝트 스토리지에서 데이터를 페치하고 프로젝트 스토리지에 데이터를 저장할 수 있습니다.
시작점 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)
이 함수는 스토리지의 파일을 프로젝트의 데이터 자산으로 등록합니다. 동일한 이름의 데이터 자산이 이미 있는 경우 이 조작이 실패합니다.
Save_data()를 통해 업로드할 수 없는 매우 큰 파일이 있는 경우 이 함수를 사용할 수 있습니다. 예를 들어 UI를 통해 프로젝트의 IBM Cloud Object Storage 버킷에 대용량 파일을 직접 업로드한 다음 '
register_asset()
을 사용하여 데이터 자산으로 등록할 수 있습니다.함수는 다음 매개변수를 사용합니다.
storage_path
: (필수) 스토리지에 있는 파일의 경로입니다.asset_name
: (선택사항) 작성된 자산의 이름입니다. 기본값은 파일 이름입니다.mime_type
: (선택사항) 작성된 자산의 MIME 유형입니다. 기본적으로 MIME 유형은 자산 이름 접미부에서 판별됩니다. 파일 이름에 파일 확장자가 없거나 다른 MIME 유형을 설정하려는 경우 MIME 유형을 지정하려면 이 매개변수를 사용하십시오.
주: 파일을 여러 번 다른 데이터 자산으로 등록할 수 있습니다. 프로젝트에서 해당 자산 중 하나를 삭제하면 스토리지의 파일도 삭제됩니다. 이는 파일에 대한 다른 자산 참조가 손상될 수 있음을 의미합니다.
Spark 지원
시작점 wslib.spark
는 Spark를 사용하여 스토리지의 파일에 액세스하기 위한 기능을 제공합니다. 사용 가능한 함수에 대한 도움말 정보를 얻으려면 help(wslib.spark.API)
를 사용하십시오.
시작점 wslib.spark
는 다음 기능을 제공합니다.
provide_spark_context(sc)
Spark 지원을 사용으로 설정하려면 이 함수를 사용하십시오.
함수는 다음과 같은 필수 매개변수를 사용합니다.
- sc: SparkContext. 이는 노트북 런타임에서 제공됩니다.
다음 예는 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)
이 함수는 Hadoop을 통해 Spark의 스토리지에 있는 파일에 액세스하기 위한 URL을 리턴합니다.
함수는 다음과 같은 필수 매개변수를 사용합니다.
asset_name
: 자산의 이름입니다.
storage.get_data_url(file_name)
이 함수는 Hadoop을 통해 Spark의 스토리지에 있는 파일에 액세스하기 위한 URL을 리턴합니다. 함수는 자산 이름이 아닌 파일 이름을 예상합니다.
함수는 다음과 같은 필수 매개변수를 사용합니다.
file_name
: 프로젝트 스토리지에 있는 파일의 이름입니다.
프로젝트 자산 찾아보기
시작점 wslib.assets
는 모든 유형의 자산에 대한 일반적인 읽기 전용 액세스를 제공합니다. 선택한 자산 유형의 경우 추가 데이터를 제공하는 전용 기능이 있습니다. 사용 가능한 함수에 대한 도움말을 보려면 help(wslib.assets.API)
를 사용하십시오.
다음 이름 지정 규칙이 적용됩니다.
list_<something>
라는 함수는 Python 사전의 목록을 리턴합니다. 각 사전은 하나의 자산을 나타내며 자산을 식별하는 작은 특성 (메타데이터) 세트를 포함합니다.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
: (선택 사항) 에셋 검색을 위해 데이터 및 AI 공통 코어 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({"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)
이 기능은 사용 가능한 모든 자산 유형을 나열합니다.
함수는 다음 매개변수를 사용할 수 있습니다.
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])
상위 주제: ibm-watson-studio-lib 사용