REST Resource: projects.locations.collections

리소스: Collection

Collection 객체를 설명하는 메시지

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
필드
name

string

식별자. 리소스의 이름
displayName

string

선택사항입니다. 사용자가 지정한 컬렉션의 표시 이름
description

string

선택사항입니다. 사용자가 지정한 컬렉션 설명
createTime

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"입니다.
updateTime

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"입니다.
labels

map (key: string, value: string)

(선택사항) 키-값 쌍인 라벨입니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
schema
(deprecated)

object (Struct format)

선택사항입니다. 지원 중단됨: 데이터용 JSON 스키마 대신 dataSchema를 사용하세요.
vectorSchema

map (key: string, value: object (VectorField))

선택사항입니다. 벡터 필드의 스키마입니다. 이 스키마의 벡터 필드만 검색할 수 있습니다. 필드 이름에는 영숫자 문자, 밑줄, 하이픈만 포함해야 합니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
dataSchema

object (Struct format)

선택사항입니다. 데이터의 JSON 스키마입니다. 필드 이름에는 영숫자 문자, 밑줄, 하이픈만 포함해야 합니다.

VectorField

벡터 필드를 설명하는 메시지입니다.

JSON 표현 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
필드
통합 필드 vector_type_config. 벡터 유형 구성입니다. vector_type_config은 다음 중 하나여야 합니다.
denseVector

object (DenseVectorField)

밀도 벡터 필드입니다.
sparseVector

object (SparseVectorField)

희소 벡터 필드입니다.

DenseVectorField

밀집 벡터 필드를 설명하는 메시지입니다.

JSON 표현 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
필드
dimensions

integer

벡터 필드의 차원입니다.
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

선택사항입니다. 벡터 필드의 임베딩을 생성하기 위한 구성입니다. 지정하지 않으면 DataObject에 삽입 필드를 채워야 합니다.

VertexEmbeddingConfig

Vertex AI 임베딩 API를 사용하여 벡터 필드의 임베딩을 생성하기 위한 구성을 설명하는 메시지입니다.

JSON 표현 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
필드
modelId

string

필수 항목입니다. 필수: 사용할 임베딩 모델의 ID입니다. 지원되는 모델 목록은 https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models를 참고하세요.
textTemplate

string

필수 항목입니다. 필수: 모델 입력의 텍스트 템플릿입니다. 템플릿에는 DataObject의 필드에 대한 참조가 하나 이상 포함되어야 합니다.예를 들면 다음과 같습니다. '영화 제목: {title} ---- 영화 줄거리: {plot}'
taskType

enum (EmbeddingTaskType)

필수 항목입니다. 필수: 임베딩의 태스크 유형입니다.

EmbeddingTaskType

임베딩이 사용될 작업을 나타냅니다.

열거형
EMBEDDING_TASK_TYPE_UNSPECIFIED 지정되지 않은 작업 유형입니다.
RETRIEVAL_QUERY 지정된 텍스트가 검색/가져오기 설정의 쿼리임을 지정합니다.
RETRIEVAL_DOCUMENT 지정된 텍스트가 검색 중인 코퍼스의 문서임을 지정합니다.
SEMANTIC_SIMILARITY 지정된 텍스트를 STS에 사용하도록 지정합니다.
CLASSIFICATION 지정된 텍스트가 분류됨을 지정합니다.
CLUSTERING 클러스터링에 임베딩을 사용하도록 지정합니다.
QUESTION_ANSWERING 질문 답변에 임베딩을 사용하도록 지정합니다.
FACT_VERIFICATION 사실 확인에 임베딩을 사용하도록 지정합니다.
CODE_RETRIEVAL_QUERY 코드 검색에 임베딩을 사용하도록 지정합니다.

SparseVectorField

이 유형에는 필드가 없습니다.

희소 벡터 필드를 설명하는 메시지입니다.

메서드

create

 특정 프로젝트와 위치에 새 컬렉션을 만듭니다.

delete

 단일 컬렉션을 삭제합니다.

exportDataObjects

 컬렉션에서 DataObject를 내보내는 장기 실행 작업을 시작합니다.

get

 단일 컬렉션의 세부정보를 가져옵니다.

importDataObjects

 Collection으로 DataObject를 가져오는 장기 실행 작업을 시작합니다.

list

 특정 프로젝트와 위치의 컬렉션을 나열합니다.

patch

 단일 컬렉션의 파라미터를 업데이트합니다.