REST Resource: projects.locations.corpora.indexes

리소스: 색인

색인은 텍스트 모음의 리소스입니다. 여기에는 색인이 생성된 애셋 및 주석 버전이 포함됩니다. 엔드포인트에 배포하면 사용자가 색인을 검색할 수 있습니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "deployedIndexes": [
    {
      object (DeployedIndexReference)
    }
  ],

  // Union field asset_filter can be only one of the following:
  "entireCorpus": boolean
  // End of list of possible types for union field asset_filter.
}
필드
name

string

출력 전용입니다. 색인 리소스의 리소스 이름입니다. 형식: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}
displayName

string

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

string

선택사항입니다. 색인에 대한 설명(선택사항)입니다.
state

enum (State)

출력 전용입니다. 색인의 상태입니다.
createTime

string (Timestamp format)

출력 전용입니다. 생성 타임스탬프입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 업데이트 타임스탬프입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.
deployedIndexes[]

object (DeployedIndexReference)

출력 전용입니다. 배포된 색인 인스턴스에 대한 참조입니다. VIDEO_ON_DEMAND 자료의 색인에는 배포된 색인이 최대 1개 있을 수 있습니다. 이미지 코퍼스의 색인에는 여러 개의 배포된 색인이 있을 수 있습니다.
통합 필드 asset_filter. 이 색인에 애셋을 선택하는 방법을 지정합니다. 지정하지 않으면 기본값은 entire_corpus입니다. UpdateIndex의 동작: update_mask에 asset_filter 필드 경로 중 하나가 포함된 경우 분석된 데이터 및 주석을 포함하여 최신 저작물로 색인이 다시 빌드됩니다. asset_filter은 다음 중 하나여야 합니다.
entireCorpus

boolean

코퍼스의 모든 애셋을 포함합니다.

주

색인이 전체 기간 동안 순환할 수 있는 다양한 상태를 나타내는 열거형입니다.

열거형
STATE_UNSPECIFIED 기본값입니다. 사용해서는 안 됩니다.
CREATING CREATING 상태입니다.
CREATED CREATED 상태입니다.
UPDATING 상태가 UPDATING입니다.

DeployedIndexReference

DeployedIndex를 가리킵니다.

JSON 표현 
{
  "indexEndpoint": string
}
필드
indexEndpoint

string

변경할 수 없습니다. IndexEndpoint의 리소스 이름입니다.

메서드

create

 코퍼스 아래에 색인을 만듭니다.

delete

 단일 색인을 삭제합니다.

get

 코퍼스 아래의 단일 색인의 세부정보를 가져옵니다.

list

 지정된 자료의 모든 색인을 나열합니다.

patch

 자료 아래의 색인을 업데이트합니다.

viewAssets

 색인 내 애셋을 나열합니다.