Jina AI 埋め込み

このドキュメントでは、TiDB CloudでJina AI埋め込みモデルと自動埋め込みを使用してテキスト クエリによるセマンティック検索を実行する方法について説明します。

注記：

自動埋め込みは、AWS でホストされているTiDB Cloud Starter クラスターでのみ使用できます。

利用可能なモデル

Jina AI は、検索、RAG、エージェント アプリケーション向けに、高性能、マルチモーダル、多言語のロングコンテキスト埋め込みを提供します。

ご自身のJina AI APIキー（BYOK）をお持ちいただければ、すべてのJina AIモデルをjina_ai/プレフィックスでご利用いただけます。例：

jina-embeddings-v4

• 名前: jina_ai/jina-embeddings-v4
• 寸法: 2048
• 距離計量：コサイン、L2
• 最大入力テキストトークン数: 32,768
• 価格：Jina AIによる請求
• TiDB Cloudがホスト: ❌
• 鍵をご持参ください: ✅

jina-embeddings-v3

• 名前: jina_ai/jina-embeddings-v3
• 寸法: 1024
• 距離計量：コサイン、L2
• 最大入力テキストトークン数: 8,192
• 価格：Jina AIによる請求
• TiDB Cloudがホスト: ❌
• 鍵をご持参ください: ✅

利用可能なモデルの完全なリストについては、 Jina AI ドキュメント参照してください。

使用例

この例では、ベクター テーブルを作成し、ドキュメントを挿入し、Jina AI 埋め込みモデルを使用して類似性検索を実行する方法を示します。

ステップ1: データベースに接続する

from pytidb import TiDBClient

tidb_client = TiDBClient.connect(
    host="{gateway-region}.prod.aws.tidbcloud.com",
    port=4000,
    username="{prefix}.root",
    password="{password}",
    database="{database}",
    ensure_db=True,
)

mysql -h {gateway-region}.prod.aws.tidbcloud.com \
    -P 4000 \
    -u {prefix}.root \
    -p{password} \
    -D {database}

ステップ2: APIキーを設定する

ジナAIプラットフォームから API キーを作成し、独自のキー (BYOK) を持って埋め込みサービスを使用します。

tidb_client.configure_embedding_provider(
    provider="jina_ai",
    api_key="{your-jina-api-key}",
)

SET @@GLOBAL.TIDB_EXP_EMBED_JINA_AI_API_KEY = "{your-jina-api-key}";

ステップ3: ベクターテーブルを作成する

jina_ai/jina-embeddings-v4モデルを使用して 2048 次元のベクトルを生成するベクトル フィールドを持つテーブルを作成します。

from pytidb.schema import TableModel, Field
from pytidb.embeddings import EmbeddingFunction
from pytidb.datatype import TEXT

class Document(TableModel):
    __tablename__ = "sample_documents"
    id: int = Field(primary_key=True)
    content: str = Field(sa_type=TEXT)
    embedding: list[float] = EmbeddingFunction(
        model_name="jina_ai/jina-embeddings-v4"
    ).VectorField(source_field="content")

table = tidb_client.create_table(schema=Document, if_exists="overwrite")

CREATE TABLE sample_documents (
    `id`        INT PRIMARY KEY,
    `content`   TEXT,
    `embedding` VECTOR(2048) GENERATED ALWAYS AS (EMBED_TEXT(
        "jina_ai/jina-embeddings-v4",
        `content`
    )) STORED
);

ステップ4: テーブルにデータを挿入する

documents = [
    Document(id=1, content="Java: Object-oriented language for cross-platform development."),
    Document(id=2, content="Java coffee: Bold Indonesian beans with low acidity."),
    Document(id=3, content="Java island: Densely populated, home to Jakarta."),
    Document(id=4, content="Java's syntax is used in Android apps."),
    Document(id=5, content="Dark roast Java beans enhance espresso blends."),
]
table.bulk_insert(documents)

INSERT INTO sample_documents (id, content)
VALUES
    (1, "Java: Object-oriented language for cross-platform development."),
    (2, "Java coffee: Bold Indonesian beans with low acidity."),
    (3, "Java island: Densely populated, home to Jakarta."),
    (4, "Java's syntax is used in Android apps."),
    (5, "Dark roast Java beans enhance espresso blends.");

ステップ5: 類似文書を検索する

results = table.search("How to start learning Java programming?") \
    .limit(2) \
    .to_list()
print(results)

SELECT
    `id`,
    `content`,
    VEC_EMBED_COSINE_DISTANCE(embedding, "How to start learning Java programming?") AS _distance
FROM sample_documents
ORDER BY _distance ASC
LIMIT 2;

+------+----------------------------------------------------------------+
| id   | content                                                        |
+------+----------------------------------------------------------------+
|    1 | Java: Object-oriented language for cross-platform development. |
|    4 | Java's syntax is used in Android apps.                         |
+------+----------------------------------------------------------------+

オプション

Jina AIオプションすべて、 EMBED_TEXT()関数のadditional_json_optionsパラメータを介してサポートされます。

例: パフォーマンス向上のため「下流タスク」を指定する

CREATE TABLE sample (
  `id`        INT,
  `content`   TEXT,
  `embedding` VECTOR(2048) GENERATED ALWAYS AS (EMBED_TEXT(
                "jina_ai/jina-embeddings-v4",
                `content`,
                '{"task": "retrieval.passage", "task@search": "retrieval.query"}'
              )) STORED
);

例: 代替ディメンションを使用する

CREATE TABLE sample (
  `id`        INT,
  `content`   TEXT,
  `embedding` VECTOR(768) GENERATED ALWAYS AS (EMBED_TEXT(
                "jina_ai/jina-embeddings-v3",
                `content`,
                '{"dimensions":768}'
              )) STORED
);

利用可能なすべてのオプションについては、 Jina AI ドキュメント参照してください。

参照

• 自動埋め込みの概要
• ベクトル検索
• ベクトル関数と演算子
• ハイブリッド検索