REST Resource: projects.locations.corpora.indexes

資源：索引

索引是 Corpus 中的資源。其中包含索引版本的素材資源和註解。部署至端點後，使用者就能搜尋索引。

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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

僅供輸出。更新時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
deployedIndexes[]

object (DeployedIndexReference)

僅供輸出。已部署索引執行個體的參照。VIDEO_ON_DEMAND 叢集的索引最多只能有一個已部署的索引。IMAGE 語料庫的索引可以有多個已部署的索引。
聯集欄位 asset_filter。指定如何為這個索引選取素材資源。如未指定，預設值為 entire_corpus。UpdateIndex 中的行為：如果 update_mask 包含其中一個 asset_filter 欄位路徑，系統會使用最新的資產 (包括已分析的資料和註解) 重新建構索引。asset_filter 只能是下列其中一項：
entireCorpus

boolean

納入語料庫中的所有資產。

狀態

列舉代表索引在生命週期中可能會循環的不同狀態。

列舉
STATE_UNSPECIFIED 預設值。請勿使用。
CREATING 狀態為 CREATING。
CREATED 狀態為「CREATED」。
UPDATING 狀態為「更新中」。

DeployedIndexReference

指向 DeployedIndex。

JSON 表示法 
{
  "indexEndpoint": string
}
欄位
indexEndpoint

string

不可變動。IndexEndpoint 的資源名稱。

方法

create

 在語料庫下建立索引。

delete

 刪除單一索引。

get

 取得特定語料庫中單一索引的詳細資料。

list

 列出指定語料庫中的所有索引。

patch

 更新該語料庫下的索引。

viewAssets

 列出索引中的資產。