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

出力専用。Index リソースのリソース名。形式: 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 つだけです。IMAGE コーパスのインデックスには、複数のデプロイ済みインデックスを含めることができます。
共用体フィールド 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

 1 つのインデックスを削除します。

get

 コーパス内の単一のインデックスの詳細を取得します。

list

 指定されたコーパス内のすべてのインデックスを一覧表示します。

patch

 コーパスのインデックスを更新します。

viewAssets

 インデックス内のアセットを一覧表示します。