REST Resource: projects.locations.corpora

リソース: コーパス

コーパスは、管理対象のメディア コンテンツのセットです。コーパス内のメディアは同じデータスキーマを共有します。検索は 1 つのコーパス内でも制限されます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "defaultTtl": string,
  "type": enum (Type),
  "searchCapabilitySetting": {
    object (SearchCapabilitySetting)
  }
}
フィールド
name

string

コーパスのリソース名。フォーム: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}
displayName

string

必須。UI に表示されるコーパス名。名前の長さは 32 文字までです。
description

string

省略可。コーパスの説明。最大 25,000 文字です。
defaultTtl

string (Duration format)

省略可。アセットレベルのユーザー定義 TTL がないコーパス内のすべてのアセットのデフォルトの TTL 値。STREAM_VIDEO タイプのコーパスでは必須で、最大で 10 年間の defaultTtl を指定できます。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
type

enum (Type)

省略可。コーパス内のアセットのタイプ。
searchCapabilitySetting

object (SearchCapabilitySetting)

コーパス レベルのデフォルトの検索機能の設定。

タイプ

コーパス内のアセットのタイプ。

列挙型
TYPE_UNSPECIFIED デフォルトのタイプ。使用しないでください。このデフォルト タイプを使用すると、コーパスは STREAM_VIDEO コーパスとして作成されます。
STREAM_VIDEO アセットはライブ配信動画アセットです。
IMAGE アセットは画像です。
VIDEO_ON_DEMAND アセットは動画アセットです。

SearchCapabilitySetting

検索機能を有効にする設定。

JSON 表現 
{
  "searchCapabilities": [
    {
      object (SearchCapability)
    }
  ]
}
フィールド
searchCapabilities[]

object (SearchCapability)

有効にする検索機能のメタデータ。

SearchCapability

検索機能の機能とメタデータ。

JSON 表現 
{
  "type": enum (Type)
}
フィールド
type

enum (Type)

有効にする検索機能。

タイプ

アセットに対してさまざまな検索を実行する機能。

列挙型
TYPE_UNSPECIFIED 未指定の検索機能。使用しないでください。

メソッド

analyze

 コーパスを分析します。

create

 プロジェクト内にコーパスを作成します。

delete

 コーパスが空の場合にのみ削除します。

get

 プロジェクト内のコーパスの詳細を取得します。

list

 プロジェクト内のすべてのコーパスを一覧表示します。

patch

 プロジェクト内のコーパスを更新します。

searchAssets

 メディア アセットを検索します。