R용 ' ibm-watson-studio-lib
' 라이브러리는 에셋에 대한 액세스를 제공합니다. 노트북 편집기에서 만든 노트북이나 프로젝트의 RStudio에서 사용할 수 있습니다. ibm-watson-studio-lib
데이터 자산 및 연결 작업은 물론 다른 모든 자산 유형에 대한 검색 기능을 지원합니다.
데이터 자산에는 두 가지 종류가 있습니다:
- 저장된 데이터 자산은 현재 프로젝트와 연결된 스토리지의 파일을 의미합니다. 라이브러리에서 이러한 파일을 로드하고 저장할 수 있습니다. 1메가바이트보다 큰 데이터의 경우 이 방법을 권장하지 않습니다. 라이브러리는 데이터 전체를 메모리에 보관해야 하므로 대용량 데이터 세트를 처리할 때 비효율적일 수 있습니다.
- 연결된 데이터 자산은 연결을 통해 액세스해야 하는 데이터를 나타냅니다. 라이브러리를 사용하면 연결된 데이터 자산의 속성(메타데이터)과 해당 연결을 검색할 수 있습니다. 이 함수는 연결된 데이터 자산의 데이터를 반환하지 않습니다. 코드 조각 패널에서 데이터 읽기를 클릭하면 자동으로 생성되는 코드를 사용하여 데이터에 액세스하거나 직접 코드를 작성해야 합니다.
ibm-watson-studio-lib
' 함수는 파일에 데이터를 저장하거나 파일에서 데이터를 가져올 때 데이터를 인코딩하거나 디코딩하지 않습니다. 또한 ' ibm-watson-studio-lib
' 기능은 연결된 폴더 자산(프로젝트 저장소 경로에 있는 파일)에 액세스하는 데 사용할 수 없습니다.' ibm-watson-studio-lib
라이브러리 설정
R용 ' ibm-watson-studio-lib
' 라이브러리는 사전 설치되어 있으며 노트북 편집기에서 노트북으로 바로 가져올 수 있습니다. 노트북에서 ibm-watson-studio-lib
라이브러리를 사용하려면 프로젝트의 ID 및 프로젝트 토큰이 필요합니다.
사용자의 노트북에 프로젝트 토큰을 삽입하려면 다음을 수행하십시오.
노트북 도구 모음에서 추가 아이콘을 클릭한 후 프로젝트 토큰 삽입을 클릭하십시오.
프로젝트 토큰이 존재하면 다음 정보와 함께 셀이 노트북에 추가됩니다.
library(ibmWatsonStudioLib) wslib <- access_project_or_space(list("token"="<ProjectToken>"))
<ProjectToken>
'은 프로젝트 토큰의 값입니다.프로젝트 토큰이 없다는 메시지가 표시되면 메시지의 링크를 클릭하여 프로젝트 토큰을 작성할 수 있는 프로젝트의 액세스 제어 페이지로 경로 재지정됩니다. 프로젝트 토큰을 작성할 수 있어야 합니다. 자세한 내용은 수동으로 프로젝트 토큰 추가를 참조하십시오.
프로젝트 토큰을 작성하려면 다음을 수행하십시오.
- 관리 탭에서 액세스 제어 페이지를 선택하고 액세스 토큰 아래에서 새 액세스 토큰을 클릭하십시오.
- 이름을 입력하고, 프로젝트의 편집기 역할을 선택한 후 토큰을 작성하십시오.
- 노트북으로 돌아가 노트북 도구 모음에서 추가 아이콘을 클릭한 후 프로젝트 토큰 삽입을 클릭하십시오.
ibm-watson-studio-lib
함수
' ibm-watson-studio-lib
' 라이브러리는 다음과 같은 방식으로 그룹화된 함수 집합을 노출합니다:
- 프로젝트 정보 얻기
- 인증 토큰 받기
- 데이터 페치
- 데이터 저장
- 연결 정보 얻기
- 연결된 데이터 정보 가져오기
- 이름 대신 ID로 자산에 액세스
- 프로젝트 저장소에 직접 액세스
- 스파크 지원
- 프로젝트 자산 찾아보기
프로젝트 정보 얻기
코드를 개발하는 동안 데이터 자산이나 연결의 정확한 이름을 모를 수도 있습니다. 다음 기능은 에셋 목록을 제공하며, 이 목록에서 관련 에셋을 선택할 수 있습니다. 모든 예제에서 ' wslib$show(assets)
'을 사용하여 목록을 예쁘게 인쇄할 수 있습니다. 각 항목의 색인은 항목 앞에 인쇄됩니다.
list_connections()
이 함수는 연결 목록을 반환합니다. 반환된 연결 목록은 기준별로 정렬되지 않으며 함수를 다시 호출할 때 변경될 수 있습니다. '
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()
이 함수는 연결된 데이터 자산을 반환합니다. 반환된 연결된 데이터 자산 목록은 기준별로 정렬되지 않으며 함수를 다시 호출하면 변경될 수 있습니다. '
get_connected_data
' 함수에 이름 대신 목록 항목을 전달할 수 있습니다.list_stored_data()
이 함수는 저장된 데이터 자산(데이터 파일)의 목록을 반환합니다. 반환된 데이터 자산 목록은 기준별로 정렬되지 않으며 함수를 다시 호출하면 변경될 수 있습니다. '
load_data
' 및 'save_data
' 함수에 이름 대신 목록 항목을 전달할 수 있습니다.참고: 연결된 데이터 자산과 저장된 데이터 자산을 구분하기 위해 휴리스틱이 적용됩니다. 그러나 반환된 목록에 잘못된 종류의 데이터 자산이 표시되는 경우가 있을 수 있습니다.wslib$here
<\br> 이 진입점을 사용하면 라이브러리가 작업 중인 프로젝트에 대한 메타데이터를 검색할 수 있습니다. 엔트리 포인트 'wslib$here
'은 다음과 같은 기능을 제공합니다:get_name()
이 함수는 프로젝트의 이름을 리턴합니다.
get_description()
이 함수는 프로젝트의 설명을 리턴합니다.
get_ID()
이 함수는 프로젝트의 ID를 반환합니다.
get_storage()
이 함수는 프로젝트의 저장소 정보를 반환합니다.
인증 토큰 받기
일부 작업에는 인증 토큰이 필요합니다. 예를 들어, 데이터 및 AI 공통 코어 API에 대해 자체 요청을 실행하려면 인증 토큰이 필요합니다.
다음 함수를 사용하여 무기명 토큰을 가져올 수 있습니다:
get_current_token()
예를 들어,
library("ibmWatsonStudioLib")
wslib <- access_project_or_space(list("token"="<ProjectToken>"))
token <- wslib$auth$get_current_token()
이 함수는 현재 ' ibm-watson-studio-lib
' 라이브러리에서 사용 중인 무기명 토큰을 반환합니다.
데이터 페치
다음 함수를 사용하여 프로젝트에 저장된 데이터 자산(파일)에서 데이터를 가져올 수 있습니다.
load_data(asset_name_or_item, attachment_type_or_item = NULL)
이 함수는 저장된 데이터 자산의 데이터를 바이트 버퍼에 로드합니다. 이 기능은 매우 큰 파일에는 권장되지 않습니다.
함수는 다음 매개변수를 사용합니다.
asset_name_or_item
: (필수) 저장된 데이터 자산의 이름이 포함된 문자열 또는 'list_stored_data()
'에서 반환된 것과 같은 항목입니다.attachment_type_or_item
' : (선택 사항) 로드할 첨부 파일 유형입니다. 데이터 자산에는 데이터 첨부 파일이 두 개 이상 있을 수 있습니다. 이 매개변수가 없으면 기본 첨부 파일 유형인 'data_asset
'이 로드됩니다. 첨부 파일 유형이 'data_asset
'이 아닌 경우 이 매개변수를 지정합니다. 예를 들어 일반 텍스트 데이터 자산에 자연어 분석에서 첨부된 프로필이 있는 경우 첨부 파일 유형 'data_profile_nlu
'로 로드할 수 있습니다.다음은 데이터 자산의 데이터를 로드하는 방법을 보여주는 예제입니다:
# 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)
이 함수는 저장된 데이터 자산의 데이터를 다운로드하여 런타임의 파일 시스템에 있는 지정된 파일에 저장합니다. 파일이 이미 있는 경우 겹쳐씁니다.
함수는 다음 매개변수를 사용합니다.
asset_name_or_item
: (필수) 저장된 데이터 자산의 이름이 포함된 문자열 또는 'list_stored_data()
'에서 반환된 것과 같은 항목입니다.file_name
: (선택 사항) 다운로드한 데이터가 저장되는 파일 이름입니다. 기본값은 에셋의 첨부 파일 이름으로 설정됩니다.attachment_type_or_item
' : (선택 사항) 다운로드할 첨부 파일 유형입니다. 데이터 자산에는 데이터 첨부 파일이 두 개 이상 있을 수 있습니다. 이 매개변수가 없으면 기본 첨부 파일 유형인 'data_asset
'이 다운로드됩니다. 첨부 파일 유형이 'data_asset
'이 아닌 경우 이 매개변수를 지정합니다. 예를 들어 일반 텍스트 데이터 자산에 자연어 분석에서 첨부된 프로필이 있는 경우, 첨부 파일 유형 'data_profile_nlu
'로 로드하여 다운로드할 수 있습니다.다음은 '
download_file
'을 사용해 노트북에서 사용자 지정 R 스크립트를 사용할 수 있게 만드는 방법을 보여주는 예시입니다:# 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()
데이터 저장
프로젝트 저장소에 데이터를 저장하는 함수는 여러 가지 일을 합니다:
- 프로젝트 저장소에 데이터 저장
- 프로젝트의 데이터 자산 목록에서 데이터를 볼 수 있도록 데이터를 데이터 자산으로 프로젝트에 추가(자산을 만들거나 기존 자산을 덮어쓰는 방법)합니다.
- 에셋을 스토리지의 파일과 연결합니다.
다음 함수를 사용하여 데이터를 저장할 수 있습니다:
save_data(asset_name_or_item, data, overwrite = NULL, mime_type = NULL, file_name = NULL)
이 기능은 메모리에 있는 데이터를 프로젝트 저장소에 저장합니다.
함수는 다음 매개변수를 사용합니다.
asset_name_or_item
' : (필수) 'list_stored_data()
'가 반환하는 생성된 에셋 또는 목록 항목의 이름입니다. 기존 파일을 덮어쓰고 싶은 경우 이 항목을 사용할 수 있습니다.data
' : (필수) 업로드할 데이터입니다. 예상 데이터 유형은 'raw
' 입니다.overwrite
: (선택 사항) 저장된 데이터 자산의 데이터가 이미 있는 경우 덮어씁니다. 기본값은 False입니다. 이름 대신 에셋 항목이 전달되면 에셋을 덮어쓰는 동작이 수행됩니다.mime_type
' : (선택 사항) 생성된 에셋의 MIME 유형입니다. 기본적으로 MIME 유형은 에셋 이름 접미사에서 결정됩니다. 접미사 없이 에셋 이름을 사용하는 경우 여기에 MIME 유형을 지정합니다. 예를 들어 일반 텍스트 데이터의 경우 'mime_type=application/text
'입니다. 이 매개변수는 에셋을 덮어쓸 때 무시됩니다.file_name
: (선택 사항) 프로젝트 저장소에 사용할 파일 이름입니다. 데이터는 프로젝트와 연결된 저장소에 저장됩니다. 새 에셋을 만들 때 파일 이름은 에셋 이름에서 파생되지만 다를 수 있습니다. 파일에 직접 액세스하려면 파일 이름을 지정하면 됩니다. 이 매개변수는 에셋을 덮어쓸 때 무시됩니다.다음은 파일에 데이터를 저장하는 방법을 보여주는 예제입니다:
# 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)
이 함수는 런타임에 파일 시스템의 데이터를 프로젝트와 연결된 파일에 저장합니다.
함수는 다음 매개변수를 사용합니다.
file_path
: (필수) 파일 시스템에 있는 파일의 경로입니다.asset_name
: (선택 사항) 생성되는 데이터 자산의 이름입니다. 기본값은 업로드할 파일의 이름입니다.file_name
: (선택 사항) 프로젝트와 연결된 스토리지에 생성되는 파일 이름입니다. 기본값은 업로드할 파일의 이름입니다.overwrite
' : (선택 사항) 저장소에 있는 기존 파일을 덮어씁니다. 기본값은 False입니다.mime_type
' : (선택 사항) 생성된 에셋의 MIME 유형입니다. 기본적으로 MIME 유형은 에셋 이름 접미사에서 결정됩니다. 접미사 없이 에셋 이름을 사용하는 경우 여기에 MIME 유형을 지정합니다. 예를 들어 일반 텍스트 데이터의 경우 'mime_type='application/text'
'입니다. 이 매개변수는 에셋을 덮어쓸 때 무시됩니다.다음은 프로젝트에 파일을 업로드하는 방법을 보여주는 예제입니다:
# 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.
연결 정보 얻기
다음 함수를 사용하여 지정된 연결의 연결 메타데이터에 액세스할 수 있습니다.
get_connection(name_or_item)
이 함수는 연결 데이터 소스에서 데이터를 가져오는 데 사용할 수 있는 연결의 속성(메타데이터)을 반환합니다. '
wslib$show(connprops)
'을 사용하여 속성을 확인합니다. 반환된 목록 항목의 특수 키 '"."
'은 연결 자산에 대한 정보를 제공합니다.이 함수에는 다음과 같은 필수 매개 변수가 필요합니다:
name_or_item
: 연결 이름이 포함된 문자열 또는 'list_connections()
'에서 반환된 것과 같은 항목입니다.
Note that when you work with notebooks, you can click 데이터 읽기 on the Code snippets panel to generate code to load data from a connection into a pandas DataFrame for example.
연결된 데이터 정보 가져오기
다음 기능을 사용하여 연결된 데이터 자산의 메타데이터에 액세스할 수 있습니다.
get_connected_data(name_or_item)
이 함수는 기본 연결의 속성을 포함하여 연결된 데이터 자산의 속성을 반환합니다. '
wslib$show()
'을 사용하여 속성을 확인합니다. 반환된 목록의 특수 키 '"."
'은 데이터 및 연결 자산에 대한 정보를 제공합니다.이 함수에는 다음과 같은 필수 매개 변수가 필요합니다:
name_or_item
: 연결된 데이터 자산의 이름이 포함된 문자열 또는 'list_connected_data()
'에서 반환된 것과 같은 항목입니다.
노트북으로 작업할 때 코드 조각 패널에서 데이터 읽기를 클릭하여 연결된 데이터 자산의 데이터를 판다 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 = NULL)
이 함수는 에셋 ID를 전달하여 저장된 데이터 에셋의 데이터를 로드합니다. 전달할 수 있는 다른 매개변수에 대한 설명은 '
load_data()
'을 참조하세요.save_data(asset_id, data, overwrite = NULL, mime_type = NULL, file_name = NULL)
이 함수는 에셋 ID를 전달하여 저장된 데이터 에셋에 데이터를 저장합니다. 이는 '
overwrite=TRUE
을 의미합니다. 전달할 수 있는 다른 매개변수에 대한 설명은 'save_data()
'을 참조하세요.download_file(asset_id, file_name = NULL, attachment_type_or_item = NULL)
이 함수는 에셋 ID를 전달하여 저장된 데이터 에셋의 데이터를 다운로드합니다. 전달할 수 있는 다른 매개변수에 대한 설명은 '
download_file()
'을 참조하세요.
프로젝트 저장소에 직접 액세스
프로젝트 저장소에서 데이터를 가져오고 프로젝트 에셋을 동기화하지 않고도 프로젝트 저장소에 데이터를 저장할 수 있는 엔트리 포인트 wslib$storage를 사용할 수 있습니다.
엔트리 포인트 ' wslib$storage
'은 다음과 같은 기능을 제공합니다:
fetch_data(filename)
이 함수는 파일의 데이터를 바이트 버퍼로 반환합니다. 파일을 데이터 자산으로 등록할 필요는 없습니다.
이 함수에는 다음과 같은 필수 매개 변수가 필요합니다:
filename
: 프로젝트에 있는 파일 이름입니다.
store_data(filename, data, overwrite = FALSE)
이 함수는 메모리에 있는 데이터를 스토리지에 저장하지만 새 데이터 자산을 생성하지는 않습니다. 이 함수는 파일 이름, 파일 경로 및 추가 정보가 포함된 목록을 반환합니다. '
Use wslib$show()
'을 사용하여 정보를 인쇄합니다.함수는 다음 매개변수를 사용합니다.
filename
: (필수) 프로젝트 저장소에 있는 파일 이름입니다.data
' : (필수) 원시 객체로 저장할 데이터입니다.overwrite
: (선택 사항) 스토리지에 파일이 이미 있는 경우 해당 파일의 데이터를 덮어씁니다. 기본적으로 이 값은 false로 설정되어 있습니다.
download_file(storage_filename, local_filename = NULL)
이 함수는 스토리지의 파일에 있는 데이터를 다운로드하여 지정된 로컬 파일에 저장합니다. 로컬 파일이 이미 있는 경우 덮어씁니다.
함수는 다음 매개변수를 사용합니다.
storage_filename
' : (필수) 다운로드할 저장소의 파일 이름입니다.local_filename
: (선택 사항) 런타임의 로컬 파일 시스템에서 파일을 다운로드할 파일 이름입니다. 저장소 파일 이름을 사용하려면 이 매개변수를 생략하세요.
register_asset(storage_path, asset_name = NULL, mime_type = NULL)
이 기능은 스토리지에 있는 파일을 프로젝트의 데이터 자산으로 등록합니다. 같은 이름의 데이터 자산이 이미 존재하는 경우 이 작업은 실패합니다. Save_data()를 통해 업로드할 수 없는 매우 큰 파일이 있는 경우 이 함수를 사용할 수 있습니다. 예를 들어 UI를 통해 프로젝트의 IBM Cloud Object Storage 버킷에 대용량 파일을 직접 업로드한 다음 '
register_asset()
을 사용하여 데이터 자산으로 등록할 수 있습니다.함수는 다음 매개변수를 사용합니다.
storage_path
: (필수) 저장소에 있는 파일의 경로입니다.asset_name
: (선택 사항) 생성된 에셋의 이름입니다. 기본값은 파일 이름입니다.mime_type
' : (선택 사항) 생성된 에셋의 MIME 유형입니다. 기본적으로 MIME 유형은 에셋 이름 접미사에서 결정됩니다. 파일 이름에 파일 확장자가 없거나 다른 MIME 유형을 설정하려는 경우 이 매개변수를 사용하여 MIME 유형을 지정합니다.
참고: 파일을 다른 데이터 자산으로 여러 번 등록할 수 있습니다. 프로젝트에서 이러한 에셋 중 하나를 삭제하면 저장소에 있는 파일도 삭제되므로 파일에 대한 다른 에셋 참조가 손상될 수 있습니다.
스파크 지원
엔트리 포인트 ' wslib$spark
'은 Spark로 스토리지의 파일에 액세스하는 기능을 제공합니다.
엔트리 포인트 ' wslib$spark
'은 다음과 같은 기능을 제공합니다:
provide_spark_context(sc)
이 기능을 사용하여 스파크 지원을 활성화합니다.
이 함수에는 다음과 같은 필수 매개 변수가 필요합니다:
sc: SparkContext. 노트북 런타임에 제공됩니다.
다음 예에서는 Spark 지원을 설정하는 방법을 보여 줍니다:
library(ibmWatsonStudioLib) wslib <- access_project_or_space(list("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
'은 모든 유형의 에셋에 대한 일반 읽기 전용 액세스를 제공합니다. 일부 자산 유형에는 추가 데이터를 제공하는 전용 기능이 있습니다.
다음 이름 지정 규칙이 적용됩니다.
- '
list_<something>
'이라는 이름의 함수는 명명된 목록의 목록을 반환합니다. 포함된 각 목록은 하나의 자산을 나타내며 자산을 식별하는 작은 속성 집합(메타데이터)을 포함합니다. - '
get_<something>
'이라는 이름의 함수는 에셋의 속성이 포함된 단일 명명된 목록을 반환합니다.
목록 또는 명명된 목록의 목록을 예쁘게 인쇄하려면 ' wslib$show()
' 을 사용합니다.
이 함수는 에셋의 이름 또는 목록의 항목을 매개변수로 사용합니다. 기본적으로 함수는 사용 가능한 에셋 프로퍼티의 하위 집합만 반환합니다. 매개변수 ' raw_info=TRUE
'을 설정하면 전체 에셋 속성 세트를 가져올 수 있습니다.
엔트리 포인트 ' wslib$assets
'은 다음과 같은 기능을 제공합니다:
list_assets(asset_type, name = NULL, query = NULL, selector = NULL, raw_info = FALSE)
이 함수는 주어진 제약 조건과 관련하여 주어진 유형에 대한 모든 에셋을 나열합니다.
함수는 다음 매개변수를 사용합니다.
asset_type
: (필수) 나열할 에셋의 유형(예: 'data_asset
). 사용 가능한 에셋 유형 목록은 'list_asset_types()
'을 참조하세요. 프로젝트에서 사용 가능한 모든 에셋의 목록은 에셋 유형 'asset
'을 사용합니다.name
: (선택 사항) 나열할 에셋의 이름입니다. 같은 이름의 에셋이 두 개 이상 존재하는 경우 이 매개변수를 사용합니다. 'name
'과 'query
' 중 하나만 지정할 수 있습니다.query
: (선택 사항) 에셋 검색을 위해 데이터 및 AI 공통 코어 API에 전달되는 쿼리 문자열입니다. 'name
'과 'query
' 중 하나만 지정할 수 있습니다.selector
: (선택 사항) 후보 자산 목록 항목에 대한 사용자 지정 필터 기능입니다. 선택기 함수가 'TRUE
'을 반환하면 해당 에셋은 반환된 에셋 목록에 포함됩니다.raw_info
: (선택 사항) 사용 가능한 모든 메타데이터를 반환합니다. 기본적으로 매개 변수는 'FALSE
'로 설정되어 있으며 속성의 하위 집합만 반환됩니다.'
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)
이 기능은 사용 가능한 모든 에셋 유형을 나열합니다.
이 함수는 다음 매개변수를 사용할 수 있습니다:
raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.
list_datasource_types(raw_info = FALSE)
이 함수는 사용 가능한 모든 데이터 소스 유형을 나열합니다.
이 함수는 다음 매개변수를 사용할 수 있습니다:
raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.
get_asset(name_or_item, asset_type=None, raw_info = FALSE)
이 함수는 에셋의 메타데이터를 반환합니다.
함수는 다음 매개변수를 사용합니다.
name_or_item
' : (필수) 에셋의 이름 또는 'list_assets()
'가 반환한 것과 같은 항목입니다asset_type
: (선택 사항) 에셋의 유형입니다. 매개변수 'name_or_item
'에 에셋 이름에 대한 문자열이 포함된 경우 'asset_type
'를 설정해야 합니다.raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.'
list_assets
' 및 '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)
이 함수는 연결의 메타데이터를 반환합니다.
함수는 다음 매개변수를 사용합니다.
name_or_item
' : (필수) 연결 이름 또는 'list_connections()
'가 반환한 것과 같은 항목입니다with_datasourcetype
: (선택 사항) 연결의 데이터 소스 유형에 대한 추가 정보를 반환합니다.raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.
get_connected_data(name_or_item, with_datasourcetype=False, raw_info = FALSE)
이 함수는 연결된 데이터 자산의 메타데이터를 반환합니다.
함수는 다음 매개변수를 사용합니다.
name_or_item
' : (필수) 연결된 데이터 자산의 이름 또는 'list_connected_data()
'가 반환한 것과 같은 항목입니다with_datasourcetype
: (선택 사항) 연결된 연결된 데이터 자산의 데이터 소스 유형에 대한 추가 정보를 반환합니다.raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.
get_stored_data(name_or_item, raw_info = FALSE)
이 함수는 저장된 데이터 자산의 메타데이터를 반환합니다.
함수는 다음 매개변수를 사용합니다.
name_or_item
' : (필수) 저장된 데이터 자산의 이름 또는 'list_stored_data()
'가 반환한 것과 같은 항목입니다raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.
list_attachments(name_or_item_or_asset, asset_type=None, raw_info = FALSE)
이 함수는 자산의 첨부 파일 목록을 반환합니다.
함수는 다음 매개변수를 사용합니다.
name_or_item_or_asset
: (필수) 에셋의 이름 또는 'list_stored_data()
' 또는 'get_asset()
'에서 반환한 것과 같은 항목입니다.asset_type
: (선택 사항) 에셋의 유형입니다. 기본값은 'data_asset
입니다.raw_info
' : (선택 사항) 메타데이터의 전체 세트를 반환합니다. 기본적으로 매개변수는 'FALSE
'이며 속성의 하위 집합만 반환됩니다.'
list_attachments
' 기능을 사용하여 저장된 데이터 자산의 첨부파일을 읽는 예시입니다: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]])
상위 주제: Ibm-watson-studio-lib 사용