メインコンテンツまでスキップ

OpenAI Compatible Embedding（OpenAI互換Embedding）

ナレッジベースのインデックス作成とコンテキスト取得のために、OpenAI互換のembedding APIをAI agentsで利用できます。​

概要​

OpenAI Compatible Embedding connector を使用すると、OpenAI Embeddings API 形式を実装した任意の embedding model を利用できます。これは、self-hosted の embedding models や、OpenAI互換の endpoint を公開しているサードパーティの embedding provider を使いたい場合に便利です。

Embeddings は、semantic search を可能にするテキストのベクトル表現です。Squid は embeddings を使用して、AI agents に紐づけられた knowledge bases をインデックス化し、関連コンテキストを取得します。これにより、agent はあなたのデータを使って質問に回答できます。

connector のセットアップ​

OpenAI Compatible Embedding connector を追加するには、次の手順を完了してください。

  1. Squid Console に移動し、アプリケーションを選択します。
  2. Connectors タブをクリックします。
  3. Available Connectors をクリックし、OpenAI Compatible Embedding connector を見つけます。次に Add Connector をクリックします。
  4. 次の詳細を入力します。
  • Connector ID: 任意の一意な ID（例: my-embeddings）。
  • Base URL: OpenAI互換 embedding API の base URL。
  • API Key（optional）: provider が必要とする場合の認証用 API key。
  • Embedding Models: この connector を通じて利用可能な embedding models を定義する JSON 配列。各 model には次のフィールドが必要です。
FieldTypeDescription
modelNamestringAPI 呼び出しで使用される embedding model identifier
displayNamestringmodel の人間向け表示名
dimensionsnumberembedding vector の次元数。1024 または 1536 である必要があります
maxTokensnumberリクエストあたりの最大 input tokens 数

例:

[
  {
    "modelName": "text-embedding-3-small",
    "displayName": "Text Embedding 3 Small",
    "dimensions": 1536,
    "maxTokens": 8191
  }
]
  1. Add Connector をクリックします。

connector の使用​

embedding connector を使用するには、knowledge base を作成 する際に embeddingModel として指定します。connector ID、model 名、dimensions を含むオブジェクトを渡します。

Client code
await squid
  .ai()
  .knowledgeBase('my-knowledgebase')
  .upsertKnowledgeBase({
    description: 'Product documentation and FAQs',
    name: 'product-docs',
    embeddingModel: {
      integrationId: 'my-embeddings',
      model: 'text-embedding-3-small',
      dimensions: 1536,
    },
    chatModel: 'gpt-4o',
    metadataFields: [],
  });

dimensions の値は、connector セットアップで model に設定した dimensions と一致している必要があります。Squid は現在、1024 または 1536 の embedding dimensions をサポートしています。

embeddings の使用方法​

embedding connector をセットアップし、knowledge base に割り当てると、Squid は knowledge base の操作にそれを使用します。

  • Indexing: knowledge base にドキュメントを追加すると、Squid はこの connector を使ってテキストを embedding vectors に変換し、保存（storage）して後の取得に備えます。
  • Retrieval: ユーザーが AI agent に質問すると、Squid は質問を embedding に変換し、knowledge base を検索して、agent のコンテキストに含めるための意味的に最も関連性の高いコンテンツを見つけます。

embedding connector は chat model connector と併用されます。chat model が会話を扱う一方で、embedding model は裏側で knowledge base のインデックス作成と取得を担当します。