投票AIモデルへのアクセス

埋め込みと再ランク付けAPI はプレビュー段階です。機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。

MongoDB Atlasで利用可能な埋め込みと再ランク付けAPIを使用して、投票AIモデルにアクセスできます。 APIにアクセスするには、次のメソッドを使用します。

REST API: 言語に依存しないアクセス用。
Pythonクライアント: 簡単に使用できる公式クライアント。

このページでは、 APIにアクセスする方法をまとめます。レート制限や使用階層など、 APIの詳細については、 APIリファレンスを参照してください。

API キー

埋め込みと再ランク付けAPI は、 APIキーを使用して使用状況を監視し、権限を管理します。モデルAPIキーを作成および管理するには、 MongoDB Atlas UI を使用します。手順については、「モデルAPIキー」を参照してください。

REST API

次の例は、 REST API経由で埋め込みサービスを呼び出す方法を示しています。 API はcURL と、任意のプログラミング言語からのHTTPリクエストをサポートしています。

認証はモデルAPIキーを通じて処理されます。このキーは、すべてのAPIリクエストの認可ヘッダーに Bearer トークンとして含める必要があります。

詳しくは、完全なAPI仕様を参照してください。

言語

Pythonクライアント

pip を使用して公式のPythonパッケージをインストールする方法

pip install --upgrade voyageai

重要

Pythonクライアントライブラリのバージョン 0.3.7 以降を使用する必要があります。このバージョンでは、埋め込みと再ランク付けAPIのサポートが追加されています。

voyageai.Clientクラスは、Vorage のAPIを呼び出すための同期インターフェースを提供します。クライアントオブジェクトを作成し、それを使用して Vyage AIモデルにアクセスします。

例

次の例は、クライアントをカスタム設定で初期化し、埋め込みを生成する方法を示しています。

import voyageai
# Initialize the client with custom settings
vo = voyageai.Client(
    api_key="<model-api-key>",  # Or use VOYAGE_API_KEY environment variable
    max_retries=3,              # Retry up to 3 times on rate limit errors
    timeout=30                  # Timeout after 30 seconds
)
# Generate embeddings
result = vo.embed(
    texts=["MongoDB is redefining what a database is in the AI era."],
    model="voyage-4-large"
)
print(f"Embedding dimension: {len(result.embeddings[0])}")
print(f"Total tokens used: {result.total_tokens}")

次の表は、クライアントを初期化するときに渡すことができるパラメータについて説明しています。

Parameter	タイプ	必須	説明
`api_key`	文字列	No	モデルAPIキー。デフォルトはなし。指定しない場合、クライアントは次の順序でAPIキーを検索します。 `voyageai.api_key_path`、キーを含むファイルへのパス環境変数 `VOYAGE_API_KEY_PATH`。これは、次のキーを含むファイルへのパスに設定できます: `voyageai.api_key`、 mongoDB モジュールの属性で、キーを保存するために使用できます環境変数 `VOYAGE_API_KEY` 注: Pythonクライアントは、 APIキー形式に基づいて正しいAPIエンドポイントにリクエストを自動的にルーティングします。 MongoDB Atlasで作成されたモデルAPIキーは、`https://ai.mongodb.com/` エンドポイントにルーティングされます。 Vyage プラットフォームで作成されたAPIキーは、`https://api.voyageai.com/` エンドポイントにルーティングされます。この動作は、クライアントの作成時に `base_url` パラメータを設定することで上書きできます。
`max_retries`	整数	No	レート制限エラーまたは一時サーバーが使用できない場合の、各APIリクエストの最大再試行回数。デフォルトは 0 です。クライアントは、待機して再試行する戦略を使用してこのようなエラーを処理し、最大再試行制限に達したときに例外を発生させます。デフォルトでは、クライアントは再試行しません。
`timeout`	整数	No	リクエストを中止する前に、 APIからの応答を待つ最大時間（秒）。デフォルトはなし。指定されたタイムアウトを超えた場合、リクエストは終了され、タイムアウト例外が発生します。デフォルトでは、タイムアウト制約は適用できません。
`base_url`	文字列	No	APIリクエストのカスタムベースURL 。デフォルトでは、クライアントは指定されたAPIキーに基づいて正しいエンドポイントを自動的に検出します。

戻る

モデル