REST Resource: projects.locations.collections

リソース: Collection

Collection オブジェクトについて説明するメッセージ

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "schema": {
    object
  },
  "vectorSchema": {
    string: {
      object (VectorField)
    },
    ...
  },
  "dataSchema": {
    object
  }
}
フィールド
name

string

識別子。リソースの名前
displayName

string

省略可。ユーザー指定のコレクションの表示名
description

string

省略可。ユーザーが指定したコレクションの説明
createTime

string (Timestamp format)

出力専用。[出力専用] 作成タイムスタンプ

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。[出力専用] 更新タイムスタンプ

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

省略可。Key-Value ペアとしてのラベル。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
schema
(deprecated)

object (Struct format)

省略可。非推奨: データの JSON スキーマ。代わりに dataSchema を使用してください。
vectorSchema

map (key: string, value: object (VectorField))

省略可。ベクトル フィールドのスキーマ。このスキーマのベクトル フィールドのみが検索可能になります。フィールド名には、英数字、アンダースコア、ハイフンのみを使用できます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
dataSchema

object (Struct format)

省略可。データの JSON スキーマ。フィールド名には、英数字、アンダースコア、ハイフンのみを使用できます。

VectorField

ベクトル フィールドについて説明するメッセージ。

JSON 表現 
{

  // Union field vector_type_config can be only one of the following:
  "denseVector": {
    object (DenseVectorField)
  },
  "sparseVector": {
    object (SparseVectorField)
  }
  // End of list of possible types for union field vector_type_config.
}
フィールド
共用体フィールド vector_type_config。ベクトル型の構成。vector_type_config は次のいずれかになります。
denseVector

object (DenseVectorField)

密ベクトル フィールド。
sparseVector

object (SparseVectorField)

スパース ベクトル フィールド。

DenseVectorField

密ベクトル フィールドについて説明するメッセージ。

JSON 表現 
{
  "dimensions": integer,
  "vertexEmbeddingConfig": {
    object (VertexEmbeddingConfig)
  }
}
フィールド
dimensions

integer

ベクトル フィールドの次元。
vertexEmbeddingConfig

object (VertexEmbeddingConfig)

省略可。ベクトル フィールドのエンベディングを生成するための構成。指定しない場合、DataObject にエンベディング フィールドを設定する必要があります。

VertexEmbeddingConfig

Vertex AI Embeddings API を使用してベクトル フィールドのエンベディングを生成するための構成を説明するメッセージ。

JSON 表現 
{
  "modelId": string,
  "textTemplate": string,
  "taskType": enum (EmbeddingTaskType)
}
フィールド
modelId

string

必須。必須: 使用するエンベディング モデルの ID。サポートされているモデルの一覧については、https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models をご覧ください。
textTemplate

string

必須。必須: モデルへの入力のテキスト テンプレート。テンプレートには、DataObject のフィールドへの参照を 1 つ以上含める必要があります。例:「映画のタイトル: {title} ---- 映画のプロット: {plot}」。
taskType

enum (EmbeddingTaskType)

必須。必須: エンベディングのタスクタイプ。

EmbeddingTaskType

エンベディングが使用されるタスクを表します。

列挙型
EMBEDDING_TASK_TYPE_UNSPECIFIED タスクタイプが指定されていません。
RETRIEVAL_QUERY 指定したテキストが検索 / 取得設定のクエリであることを指定します。
RETRIEVAL_DOCUMENT 指定したテキストが検索対象のコーパスのドキュメントであることを指定します。
SEMANTIC_SIMILARITY 指定したテキストが STS で使用されることを指定します。
CLASSIFICATION 指定されたテキストを分類することを指定します。
CLUSTERING エンベディングをクラスタリングに使用することを指定します。
QUESTION_ANSWERING エンベディングを質問応答に使用することを指定します。
FACT_VERIFICATION エンベディングを事実確認に使用することを指定します。
CODE_RETRIEVAL_QUERY エンベディングをコード取得に使用することを指定します。

SparseVectorField

この型にはフィールドがありません。

スパース ベクトル フィールドについて説明するメッセージ。

メソッド

create

 指定されたプロジェクトとロケーションに新しい Collection を作成します。

delete

 1 つのコレクションを削除します。

exportDataObjects

 Collection から DataObject をエクスポートする長時間実行オペレーションを開始します。

get

 1 つの Collection の詳細を取得します。

importDataObjects

 DataObject を Collection にインポートする長時間実行オペレーションを開始します。

list

 指定されたプロジェクトとロケーションの Collection を一覧表示します。

patch

 単一のコレクションのパラメータを更新します。