Method: projects.locations.collections.dataStores.customModels.list

모든 맞춤 모델의 목록을 가져옵니다.

HTTP 요청

GET https://discoveryengine.googleapis.com/v1alpha/{dataStore=projects/*/locations/*/collections/*/dataStores/*}/customModels

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
dataStore

string

필수 항목입니다. 상위 데이터 스토어의 리소스 이름입니다(예: projects/*/locations/global/collections/default_collection/dataStores/default_data_store). 이 필드는 모델을 가져올 데이터 저장소를 식별하는 데 사용됩니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

SearchTuningService.ListCustomModels 메서드의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "models": [
    {
      object (CustomTuningModel)
    }
  ]
}
필드
models[]

object (CustomTuningModel)

맞춤 조정 모델 목록입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

dataStore 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.dataStores.listCustomModels

자세한 내용은 IAM 문서를 참조하세요.

CustomTuningModel

맞춤 조정된 모델을 설명하는 메타데이터입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "modelVersion": string,
  "modelState": enum (ModelState),
  "createTime": string,
  "trainingStartTime": string,
  "metrics": {
    string: number,
    ...
  },
  "errorMessage": string
}
필드
name

string

필수 항목입니다. 모델의 정규화된 리소스 이름입니다.

형식은 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/customTuningModels/{custom_tuning_model}입니다.

모델은 40자 제한이 있는 영숫자 문자열이어야 합니다.
displayName

string

모델의 표시 이름입니다.
modelVersion

string (int64 format)

모델의 버전입니다.
modelState

enum (ModelState)

모델의 상태입니다 (예: TRAINING 또는 TRAINING_FAILED).
createTime
(deprecated)

string (Timestamp format)

지원 중단됨: 모델이 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
trainingStartTime

string (Timestamp format)

모델 학습이 시작된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
metrics

map (key: string, value: number)

학습된 모델의 측정항목입니다.
errorMessage

string

현재 모델 상태가 INPUT_VALIDATION_FAILED인 경우에만 채워집니다.

ModelState

모델의 상태입니다.

열거형
MODEL_STATE_UNSPECIFIED 기본값
TRAINING_PAUSED 모델이 일시중지된 학습 상태입니다.
TRAINING 모델이 현재 학습 중입니다.
TRAINING_COMPLETE 모델이 학습을 완료했습니다.
READY_FOR_SERVING 모델이 서빙할 준비가 되었습니다.
TRAINING_FAILED 모델 학습에 실패했습니다.
NO_IMPROVEMENT 모델 학습이 완료되었지만 측정항목이 개선되지 않았습니다.
INPUT_VALIDATION_FAILED 입력 데이터 유효성 검사에 실패했습니다. 모델 학습이 시작되지 않았습니다.