REST Resource: projects.locations.collections.indexes

리소스: 색인

색인 객체를 설명하는 메시지

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "distanceMetric": enum (DistanceMetric),
  "indexField": string,
  "filterFields": [
    string
  ],
  "storeFields": [
    string
  ],

  // Union field infra_type can be only one of the following:
  "dedicatedInfrastructure": {
    object (DedicatedInfrastructure)
  }
  // End of list of possible types for union field infra_type.

  // Union field index_type can be only one of the following:
  "denseScann": {
    object (DenseScannIndex)
  }
  // End of list of possible types for union field index_type.
}
필드
name

string

식별자. 리소스의 이름
displayName

string

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

string

선택사항입니다. 사용자가 지정한 색인 설명
labels

map (key: string, value: string)

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

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
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"입니다.
distanceMetric

enum (DistanceMetric)

선택사항입니다. 색인 생성에 사용되는 거리 측정항목입니다. 지정하지 않으면 DOT_PRODUCT로 기본 설정됩니다.
indexField

string

필수 항목입니다. 색인을 생성할 컬렉션 스키마 필드입니다.
filterFields[]

string

선택사항입니다. 빠른 ANN 인라인 필터링을 사용 설정하기 위해 색인으로 푸시할 필드입니다.
storeFields[]

string

선택사항입니다. 인라인 데이터 검색을 사용 설정하기 위해 색인에 푸시할 필드입니다.
통합 필드 infra_type. 색인의 인프라 유형입니다. infra_type은 다음 중 하나여야 합니다.
dedicatedInfrastructure

object (DedicatedInfrastructure)

선택사항입니다. 색인용 전용 인프라
통합 필드 index_type. 색인의 유형입니다. index_type은 다음 중 하나여야 합니다.
denseScann

object (DenseScannIndex)

선택사항입니다. 밀집 ScaNN 색인입니다.

DedicatedInfrastructure

색인의 전용 인프라를 나타냅니다.

JSON 표현 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
필드
autoscalingSpec

object (AutoscalingSpec)

선택사항입니다. 자동 확장 사양입니다.
mode

enum (Mode)

선택사항입니다. 전용 인프라의 모드입니다.

모드

전용 인프라의 모드입니다.

열거형
MODE_UNSPECIFIED 기본값은 PERFORMANCE_OPTIMIZED을 사용합니다.
STORAGE_OPTIMIZED 스토리지 최적화 변형입니다.
PERFORMANCE_OPTIMIZED E2 또는 이에 상응하는 계열에서 성능이 최적화되어 있습니다.

AutoscalingSpec

자동 확장 사양입니다.

JSON 표현 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
필드
minReplicaCount

integer

선택사항입니다. 최소 복제본 수입니다. 설정되지 않았거나 0로 설정된 경우 기본값은 2입니다. 1 이상이고 1000 이하이어야 합니다.
maxReplicaCount

integer

선택사항입니다. 최대 복제본 수입니다. minReplicaCount 이상이고 1000 이하이어야 합니다. v1beta 버전의 경우 설정되지 않았거나 0로 설정된 경우 기본값은 minReplicaCount와 5 중 더 큰 값입니다. 다른 모든 버전의 경우 설정되지 않았거나 0로 설정된 경우 기본값은 minReplicaCount와 2 중 더 큰 값입니다.

DenseScannIndex

밀도 높은 ScaNN 색인 구성입니다.

JSON 표현 
{
  "featureNormType": enum (FeatureNormType)
}
필드
featureNormType

enum (FeatureNormType)

선택사항입니다. 특성 정규화 유형입니다.

FeatureNormType

ScaNN 색인의 특성 정규화 유형입니다.

열거형
FEATURE_NORM_TYPE_UNSPECIFIED 지정되지 않은 기능 정규화 유형입니다.
NONE 규범이 적용되지 않았습니다.
UNIT_L2_NORM 단위 L2 norm입니다.

DistanceMetric

벡터 검색의 거리 측정항목입니다.

열거형
DISTANCE_METRIC_UNSPECIFIED 기본값, 거리 측정항목이 지정되지 않았습니다.
DOT_PRODUCT 내적 거리 측정항목입니다.
COSINE_DISTANCE 코사인 거리 측정항목입니다.

메서드

create

 특정 프로젝트와 위치에 새 색인을 만듭니다.

delete

 단일 색인을 삭제합니다.

get

 단일 색인의 세부정보를 가져옵니다.

list

 특정 프로젝트와 위치의 색인을 나열합니다.

patch

 단일 색인의 파라미터를 업데이트합니다.