R용 ibm-watson-studio-lib

R에 대한 ibm-watson-studio-lib 라이브러리는 자산에 대한 액세스를 제공합니다. 노트북 편집기에서 만든 노트북이나 프로젝트의 RStudio 만든 노트북 또는 배포 공간으로 승격된 노트북에서 사용할 수 있습니다. ibm-watson-studio-lib 에서는 데이터 자산 및 연결에 대한 작업과 기타 모든 자산 유형에 대한 찾아보기 기능을 지원합니다.

다음과 같은 두 가지 유형의 데이터 자산이 있습니다.

  • 저장된 데이터 자산은 현재 작업 공간과 연관된 저장소 내의 파일을 의미합니다. 라이브러리는 이러한 파일을 로드하고 저장할 수 있습니다. 1MB보다 큰 데이터의 경우에는 권장되지 않습니다. 라이브러리에서는 데이터 전체를 메모리에 보관해야 합니다. 이는 대용량 데이터 세트를 처리할 때 비효율적일 수 있습니다.
  • 연결된 데이터 자산 은 연결을 통해 액세스해야 하는 데이터를 나타냅니다. 라이브러리를 사용하여 연결된 데이터 자산 및 해당 연결의 특성 (메타데이터) 을 검색할 수 있습니다. 함수는 연결된 데이터 자산의 데이터를 리턴하지 않습니다. 코드 스니펫 패널에서 데이터 읽기 를 클릭하여 데이터에 액세스할 때 생성되는 코드를 사용하거나 사용자 고유의 코드를 작성해야 합니다.
참고: ibm-watson-studio-lib 함수는 파일에 데이터를 저장하거나 파일에서 데이터를 가져올 때 데이터를 인코딩하거나 디코딩하지 않습니다. 또한 ibm-watson-studio-lib 기능을 사용하여 연결된 폴더 자산 (프로젝트 스토리지의 경로에 있는 파일) 에 액세스할 수 없습니다.

ibm-watson-studio-lib 라이브러리 설정

노트북에서 ibm-watson-studio-lib 를 사용하는 경우 실행되는 프로젝트 또는 공간이 자동으로 판별됩니다.

다음 import문을 사용하여 ibm-watson-studio-lib를 설정하십시오.

library("ibmWatsonStudioLib")
wslib <- access_project_or_space()

ibm-watson-studio-lib 함수

ibm-watson-studio-lib 라이브러리는 다음과 같은 방법으로 그룹화된 함수 세트를 표시합니다.

프로젝트 또는 공간 정보 가져오기

코드를 개발하는 동안 데이터 자산 또는 연결의 정확한 이름을 모를 수 있습니다. 다음 기능은 관련 자산을 선택할 수 있는 자산 목록을 제공합니다. 모든 예제에서 wslib$show(assets) 를 사용하여 목록을 적절히 인쇄할 수 있습니다. 각 항목의 색인이 항목 앞에 인쇄됩니다.

  • list_connections()

    이 함수는 연결 목록을 리턴합니다. 리턴된 연결 목록은 기준에 따라 정렬되지 않으며 함수를 다시 호출할 때 변경될 수 있습니다. 이름 대신 목록 항목을 get_connection function에 전달할 수 있습니다. 예를 들어, 다음과 같습니다.

    # Import the lib
library("ibmWatsonStudioLib")
wslib <- access_project_or_space()

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 이 진입점을 사용하면 라이브러리가 작업 중인 프로젝트 또는 공간에 대한 메타데이터를 가져올 수 있습니다. 시작점 wslib$here 는 다음 기능을 제공합니다.

    • get_name()

      이 함수는 프로젝트 또는 공간의 이름을 리턴합니다.

    • get_description()

      이 함수는 프로젝트 또는 공간에 대한 설명을 리턴합니다.

    • get_ID()

      이 함수는 프로젝트 또는 공간의 ID를 리턴합니다.

    • get_storage()

      이 함수는 프로젝트 또는 공간에 대한 스토리지 정보를 리턴합니다.

인증 토큰 가져오기

일부 태스크에는 인증 토큰이 필요합니다. 예를 들어, 데이터 및 AI 공통 코어 API에 대해 자체 요청을 실행하려면 인증 토큰이 필요합니다.

다음 함수를 사용하여 베어러 토큰을 가져올 수 있습니다.

  • get_current_token()

예를 들어, 다음과 같습니다.

library("ibmWatsonStudioLib")
wslib <- access_project_or_space()
token <- wslib$auth$get_current_token()

이 함수는 현재 ibm-watson-studio-lib 라이브러리에서 사용되는 베어러 토큰을 리턴합니다.

노트북, 스크립트 및 R Shiny 앱의 데이터 및 AI 공통 코어 API에서 사용하기 위해 환경 변수 USER_ACCESS_TOKEN을 통해 인증 토큰을 가져오는 옵션은 더 이상 사용되지 않으며 향후 릴리스에서 제거될 예정입니다.

데이터 페치

워크스페이스 내 저장된 데이터 자산(파일)에서 데이터를 가져오려면 다음 함수를 사용할 수 있습니다.

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

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

# 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 of the opened notebook.

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

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

# 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.
# 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는 현재 작업 공간에서만 유효하며 다른 작업 공간으로 이동 시 코드가 중단될 수 있습니다. 예를 들어, 프로젝트를 내보내고 다시 가져오거나 노트북 또는 자산이 프로젝트에서 공간으로 승격될 때 이러한 상황이 발생할 수 있습니다. 해당 목록 함수 (예: 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.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 = NULL, mime_type = NULL)

    이 함수는 로컬 마운트의 파일을 프로젝트 또는 공간의 데이터 자산으로 등록합니다. 동일한 이름의 데이터 자산이 이미 있는 경우 이 조작이 실패합니다.

    함수는 다음 매개변수를 사용합니다.

    • file_path: (필수) 로컬로 마운트된 프로젝트 또는 공간 스토리지에 있는 파일의 절대 경로입니다.

    • asset_name: (선택사항) 작성된 자산의 이름입니다. 기본값은 파일 이름입니다.

    • mime_type: (선택사항) 작성된 자산의 MIME 유형입니다. 기본적으로 MIME 유형은 자산 이름 접미부에서 판별됩니다. 파일 이름에 파일 확장자가 없거나 다른 MIME 유형을 설정하려는 경우 MIME 유형을 지정하려면 이 매개변수를 사용하십시오.

      다음 예제는 마운트된 프로젝트 스토리지에서 파일을 자산으로 등록하는 방법을 보여줍니다.

      # Import the lib
library("ibmWatsonStudioLib")
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"

# Copy the file to the data assets folder in the
# mounted project storage:
data_asset_folder <- wslib$mount$get_base_dir()
target_path <- file.path(data_asset_folder, my_large_file)
file.copy(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 list which contains the asset_name, asset_id, file_name and additional information upon successful creation of the data asset.
    주: 파일을 여러 번 다른 데이터 자산으로 등록할 수 있습니다. 프로젝트 인터페이스에서 이러한 자산 중 하나를 삭제하면 스토리지의 파일도 삭제됩니다. 이는 파일에 대한 다른 자산 참조가 손상될 수 있음을 의미합니다.

프로젝트 스토리지에 직접 액세스

시작점 wslib$storage를 사용하여 프로젝트 자산을 동기화하지 않고 프로젝트 스토리지에서 데이터를 페치하고 프로젝트 스토리지에 데이터를 저장할 수 있습니다.

프로젝트 또는 공간 스토리지는 노트북 런타임에 마운트되며, 일반적으로 엔트리 wslib$mount 포인트와 파일 시스템 작업을 통해 스토리지에 접근하게 됩니다.

시작점 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)

    이 기능은 파일을 저장소에 데이터 자산으로 등록하여 작업 공간에 추가합니다. 동일한 이름의 데이터 자산이 이미 있는 경우 이 조작이 실패합니다.

    함수는 다음 매개변수를 사용합니다.

    • storage_path: (필수) 스토리지에 있는 파일의 경로입니다.
    • asset_name: (선택사항) 작성된 자산의 이름입니다. 기본값은 파일 이름입니다.
    • mime_type: (선택사항) 작성된 자산의 MIME 유형입니다. 기본적으로 MIME 유형은 자산 이름 접미부에서 판별됩니다. 파일 이름에 파일 확장자가 없거나 다른 MIME 유형을 설정하려는 경우 MIME 유형을 지정하려면 이 매개변수를 사용하십시오.
    주: 파일을 여러 번 다른 데이터 자산으로 등록할 수 있습니다. 프로젝트에서 해당 자산 중 하나를 삭제하면 스토리지의 파일도 삭제됩니다. 이는 파일에 대한 다른 자산 참조가 손상될 수 있음을 의미합니다.

프로젝트 자산 찾아보기

시작점 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 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 <- 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]])