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

OpenAI Compatible Embedding

AI agent における knowledge base indexing と context retrieval に、任意の OpenAI-compatible embedding API を使用します。​

概要​

OpenAI Compatible Embedding connector を使用すると、OpenAI Embeddings API format を実装する任意の embedding model を使用できます。self-hosted embedding model や、OpenAI-compatible endpoint を公開する third-party embedding provider を使用したい場合に役立ちます。

embedding は semantic search を可能にする text の vector representation です。Squid は embedding を使用して、AI agent に接続された knowledge baseから relevant context を index・retrieve し、agent が data を使用して question に answer できるようにします。

Connector の Setup​

OpenAI Compatible Embedding connector を追加するには、以下の step を実行します。

  1. Squid Console に移動し、application を選択します。
  2. Connectors tab をクリックします。
  3. Available Connectors をクリックして OpenAI Compatible Embedding connector を見つけ、Add Connector をクリックします。
  4. 次の detail を入力します。
  • Connector ID: 任意の unique ID（例: my-embeddings）。
  • Base URL: OpenAI-compatible embedding API の base URL。
  • API Key（optional）: provider が必要とする場合の authentication 用 API key。
  • Embedding Models: この connector で利用できる embedding model を定義する JSON array。各 model には次の field が必要です。
FieldType説明
modelNamestringAPI call で使用する embedding model identifier
displayNamestringmodel の human-readable name
dimensionsnumberembedding vector の dimension 数。1024 または 1536 である必要があります
maxTokensnumberrequest ごとの maximum input token 数

例:

[
  {
    "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 name、dimension を含む object を渡します。

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-5.5',
    metadataFields: [],
  });

dimensions value は、connector setup で model に構成した dimension と一致する必要があります。Squid は現在、1024 または 1536 の embedding dimension をサポートします。

Embedding の使用方法​

embedding connector を setup して knowledge base に割り当てると、Squid は knowledge base operation に使用します。

  • Indexing: knowledge base に document を追加すると、Squid はこの connector を使用して text を embedding vector に変換し、storage と後の retrieval に使用します。
  • Retrieval: user が AI agent に question を尋ねると、Squid は question を embedding に変換し、agent context に含める最も semantically relevant な content を knowledge base から検索します。

embedding connector は chat model connector とともに機能します。chat model が conversation を処理する一方、embedding model は behind the scenes で knowledge base indexing と retrieval を処理します。