バージョン: User Guides (Cloud)

[説明] このページは機械翻訳された日本語版です。内容に誤りがございましたら、報告していただけると助かります。

スキーマの説明

スキーマはコレクションのデータ構造を定義します。コレクションを作成する前に、そのスキーマの設計を練る必要があります。このページでは、コレクションスキーマを理解し、独自の例となるスキーマを設計する方法を説明します。

概要

Zilliz Cloudでは、コレクションスキーマはリレーショナルデータベースのテーブルのように機能し、Zilliz Cloudがコレクション内のデータをどのように整理するかを定義します。

設計の良いスキーマは不可欠であり、データモデルを抽象化し、検索を通じてビジネス目標を達成できるかどうかを決定します。さらに、コレクションに挿入されるすべてのデータ行がスキーマに従わなければならないため、データの一貫性と長期的な品質を維持するのに役立ちます。技術的な観点から見ると、定義の良いスキーマは、よく整理されたカラムデータストレージとよりクリーンなインデックス構造をもたらし、検索パフォーマンスを向上させます。

コレクションスキーマには、主キー、少なくとも1つのベクトルフィールド、およびいくつかのスカラーフィールドがあります。以下の図は、記事をスキーマフィールドのリストにマッピングする方法を示しています。

RoJFbyTsuoY8mHxoBBicgBH9nTc

検索システムのデータモデル設計には、ビジネスニーズの分析と情報をスキーマで表現されたデータモデルに抽象化することが含まれます。例えば、テキストの一部を検索するには、リテラル文字列を「埋め込み」によってベクトルに変換し、ベクトル検索を可能にする必要があります。この基本的な要件に加えて、発行日時や著者などの他のプロパティを保存することが必要な場合があります。このメタデータにより、セマンティック検索をフィルタリングによって洗練させ、特定の日付以降に発行されたテキストや特定の著者のテキストのみを返すことができます。また、メインテキストとともにこれらのスカラー値を取得して、アプリケーションで検索結果をレンダリングすることもできます。これらのテキスト断片を整理するには、それぞれに一意の識別子を割り当てる必要があります。これは整数または文字列として表現されます。これらの要素は、洗練された検索ロジックを実現するために不可欠です。

設計の良いスキーマを作成する方法については、スキーマ設計ハンズオンを参照してください。

スキーマの作成

以下のコードスニペットは、スキーマを作成する方法を示しています。

Python
Java
NodeJS
Go
cURL

from pymilvus import MilvusClient, DataType

schema = MilvusClient.create_schema()

import io.milvus.v2.service.collection.request.CreateCollectionReq;

CreateCollectionReq.CollectionSchema schema = client.createSchema();

import { MilvusClient, DataType } from "@zilliz/milvus2-sdk-node";

const schema = []

import "github.com/milvus-io/milvus/client/v2/entity"

schema := entity.NewSchema()

export schema='{
    "fields": []
}'

主フィールドの追加

コレクションの主フィールドは、エンティティを一意に識別します。これはInt64またはVarCharの値のみを受け入れます。以下のコードスニペットは、主フィールドを追加する方法を示しています。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_id",
    datatype=DataType.INT64,
    is_primary=True,
    auto_id=False,
)

import io.milvus.v2.common.DataType;
import io.milvus.v2.service.collection.request.AddFieldReq; 

schema.addField(AddFieldReq.builder()
        .fieldName("my_id")
        .dataType(DataType.Int64)
        .isPrimaryKey(true)
        .autoID(false)
        .build());

schema.push({
    name: "my_id",
    data_type: DataType.Int64,
    is_primary_key: true,
    autoID: false
});

schema.WithField(entity.NewField().WithName("my_id").
    WithDataType(entity.FieldTypeInt64).
    WithIsPrimaryKey(true).
    WithIsAutoID(false),
)

export primaryField='{
    "fieldName": "my_id",
    "dataType": "Int64",
    "isPrimary": true
}'

export schema='{
    \"autoID\": false,
    \"fields\": [
        $primaryField
    ]
}'

フィールドを追加する際には、is_primaryプロパティをTrueに設定して、フィールドを明示的に主フィールドとして定義できます。主フィールドはデフォルトでInt64の値を受け入れます。この場合、主フィールド値は12345のような整数である必要があります。主フィールドでVarCharの値を使用することを選択した場合、値はmy_entity_1234のような文字列である必要があります。

また、autoIdプロパティをTrueに設定して、Zilliz Cloudがデータ挿入時に主フィールド値を自動的に割り当てるようにすることもできます。

詳細については、主フィールド & AutoIdを参照してください。

ベクトルフィールドの追加

ベクトルフィールドは、さまざまなスパースおよびデンスベクトル埋め込みを受け入れます。Zilliz Cloudでは、1つのコレクションに4つのベクトルフィールドを追加できます。以下のコードスニペットは、ベクトルフィールドを追加する方法を示しています。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_vector",
    datatype=DataType.FLOAT_VECTOR,
    dim=5
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_vector")
        .dataType(DataType.FloatVector)
        .dimension(5)
        .build());

schema.push({
    name: "my_vector",
    data_type: DataType.FloatVector,
    dim: 5
});

schema.WithField(entity.NewField().WithName("my_vector").
    WithDataType(entity.FieldTypeFloatVector).
    WithDim(5),
)

export vectorField='{
    "fieldName": "my_vector",
    "dataType": "FloatVector",
    "elementTypeParams": {
        "dim": 5
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField
    ]
}"

上記のコードスニペットのdimパラメータは、ベクトルフィールドに保持されるベクトル埋め込みの次元数を示します。FLOAT_VECTOR値は、ベクトルフィールドが32ビット浮動小数点数のリストを保持することを示しており、通常は対数の逆数を表すために使用されます。これに加えて、Zilliz Cloudは以下のタイプのベクトル埋め込みもサポートしています。

FLOAT16_VECTOR

このタイプのベクトルフィールドは、16ビット半精度浮動小数点数のリストを保持し、通常はメモリや帯域幅が制限されたディープラーニングやGPUベースのコンピューティングのシナリオに適用されます。
BFLOAT16_VECTOR

このタイプのベクトルフィールドは、Float32と同じ指数範囲を持つが精度が低い16ビット浮動小数点数のリストを保持します。このタイプのデータはディープラーニングのシナリオで一般的に使用され、精度に大きく影響を与えることなくメモリ使用量を削減します。
BINARY_VECTOR

このタイプのベクトルフィールドは、0と1のリストを保持します。これらは、画像処理や情報検索のシナリオでデータを表すためのコンパクトな特徴量として機能します。
SPARSE_FLOAT_VECTOR

このタイプのベクトルフィールドは、非ゼロ数値とそのシーケンス番号のリストを保持して、スパースベクトル埋め込みを表します。

スカラーフィールドの追加

一般的なケースでは、スカラーフィールドを使用して、Zilliz Cloudクラスターに保存されたベクトル埋め込みのメタデータを保存し、メタデータフィルタリング付きのANN検索を実行して検索結果の正確性を向上させることができます。Zilliz Cloudは、VarChar、Boolean、Int、Float、Doubleを含む複数のスカラーフィールドタイプをサポートしています。

文字列フィールドの追加

Zilliz Cloudクラスターでは、VarCharフィールドを使用して文字列を保存できます。VarCharフィールドの詳細については、文字列フィールドを参照してください。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_varchar",
    datatype=DataType.VARCHAR,
    max_length=512
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_varchar")
        .dataType(DataType.VarChar)
        .maxLength(512)
        .build());

schema.push({
    name: "my_varchar",
    data_type: DataType.VarChar,
    max_length: 512
});

schema.WithField(entity.NewField().WithName("my_varchar").
    WithDataType(entity.FieldTypeVarChar).
    WithMaxLength(512),
)

export varCharField='{
    "fieldName": "my_varchar",
    "dataType": "VarChar",
    "elementTypeParams": {
        "max_length": 512
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField
    ]
}"

数値フィールドの追加

Zilliz Cloudがサポートしている数値のタイプは、Int8、Int16、Int32、Int64、Float、およびDoubleです。数値フィールドの詳細については、数値フィールドを参照してください。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_int64",
    datatype=DataType.INT64,
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_int64")
        .dataType(DataType.Int64)
        .build());

schema.push({
    name: "my_int64",
    data_type: DataType.Int64,
});

schema.WithField(entity.NewField().WithName("my_int64").
    WithDataType(entity.FieldTypeInt64),
)

export int64Field='{
    "fieldName": "my_int64",
    "dataType": "Int64"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field
    ]
}"

真偽値フィールドの追加

Zilliz Cloudは真偽値フィールドをサポートしています。以下のコードスニペットは、真偽値フィールドを追加する方法を示しています。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_bool",
    datatype=DataType.BOOL,
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_bool")
        .dataType(DataType.Bool)
        .build());

schema.push({
    name: "my_bool",
    data_type: DataType.Boolean,
});

schema.WithField(entity.NewField().WithName("my_bool").
    WithDataType(entity.FieldTypeBool),
)

export boolField='{
    "fieldName": "my_bool",
    "dataType": "Boolean"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField
    ]
}"

複合フィールドの追加

Milvusでは、複合フィールドはJSONフィールドのキーまたはArrayフィールドのインデックスのように、より小さなサブフィールドに分割できるフィールドです。

JSONフィールドの追加

JSONフィールドは通常、半構造化されたJSONデータを保存します。JSONフィールドの詳細については、JSONフィールドを参照してください。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_json",
    datatype=DataType.JSON,
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_json")
        .dataType(DataType.JSON)
        .build());

schema.push({
    name: "my_json",
    data_type: DataType.JSON,
});

schema.WithField(entity.NewField().WithName("my_json").
    WithDataType(entity.FieldTypeJSON),
)

export jsonField='{
    "fieldName": "my_json",
    "dataType": "JSON"
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField,
        $jsonField
    ]
}"

配列フィールドの追加

配列フィールドは、要素のリストを保存します。配列フィールド内のすべての要素のデータ型は同じである必要があります。配列フィールドの詳細については、配列フィールドを参照してください。

Python
Java
NodeJS
Go
cURL

schema.add_field(
    field_name="my_array",
    datatype=DataType.ARRAY,
    element_type=DataType.VARCHAR,
    max_capacity=5,
    max_length=512,
)

schema.addField(AddFieldReq.builder()
        .fieldName("my_array")
        .dataType(DataType.Array)
        .elementType(DataType.VarChar)
        .maxCapacity(5)
        .maxLength(512)
        .build());

schema.push({
    name: "my_array",
    data_type: DataType.Array,
    element_type: DataType.VarChar,
    max_capacity: 5,
    max_length: 512
});

schema.WithField(entity.NewField().WithName("my_array").
    WithDataType(entity.FieldTypeArray).
    WithElementType(entity.FieldTypeInt64).
    WithMaxLength(512).
    WithMaxCapacity(5),
)

export arrayField='{
    "fieldName": "my_array",
    "dataType": "Array",
    "elementDataType": "VarChar",
    "elementTypeParams": {
        "max_length": 512
    }
}'

export schema="{
    \"autoID\": false,
    \"fields\": [
        $primaryField,
        $vectorField,
        $varCharField,
        $int64Field,
        $boolField,
        $jsonField,
        $arrayField
    ]
}"

概要​

スキーマの作成​

主フィールドの追加​

ベクトルフィールドの追加​

スカラーフィールドの追加​

文字列フィールドの追加​

数値フィールドの追加​

真偽値フィールドの追加​

複合フィールドの追加​

JSONフィールドの追加​

配列フィールドの追加​

概要