プレビュー

この機能は パブリック プレビュー 段階であり、 us-east1 と us-central1でサポートされています。

基盤モデルの REST API リファレンス

この記事では、Databricks 基盤APIsとそれらがサポートするモデルの一般的な API 情報を提供します。 基盤モデルAPI既存のプロジェクトの移行を容易にするために、OpenAI の REST API と同様になるように設計されています。

エンドポイント

プロビジョニングされたスループットエンドポイントは 、API または Serving UI を使用して作成できます。 これらのエンドポイントは、両方の提供モデルが同じ API 形式を公開している限り、A/B テストのエンドポイントごとに複数のモデルもサポートします。 たとえば、両方のモデルが埋め込みモデルであるとします。

使い方

応答には、要求と応答のトークンの数を報告する usage サブメッセージが含まれます。 このサブメッセージの形式は、すべてのタスクタイプで同じです。

フィールド

タイプ

説明

completion_tokens

Integer

生成されたトークンの数。 埋め込み応答には含まれません。

prompt_tokens

Integer

入力プロンプトからのトークンの数。

total_tokens

Integer

トークンの合計数。

埋め込みタスク

埋め込みタスクは、入力文字列を埋め込みベクトルにマップします。 各要求で多くの入力をまとめてバッチ処理できます。 エンドポイント パラメーターのクエリについては、 POST /serving-endpoints/{name}/invocations を参照してください。

埋め込みリクエスト

フィールド

タイプ

説明

input

文字列 または List[文字列]

必須です。 埋め込む入力テキスト。 文字列または文字列のリストを指定できます。

instruction

String

埋め込みモデルに渡す省略可能な命令。

手順はオプションであり、モデルに大きく依存します。 たとえば、BGEの著者は、チャンクのインデックス作成時に命令を使わず、検索クエリには命令 "Represent this sentence for searching relevant passages:" を使用することを推奨しています。 Instructor-XLなどの他のモデルは、幅広い命令文字列をサポートしています。

埋め込み応答

フィールド

タイプ

説明

id

String

埋め込みの一意の識別子。

object

String

オブジェクトの種類。 "list"と同じです。

model

String

埋め込みの作成に使用された埋め込みモデルの名前。

data

埋め込みオブジェクト

埋め込みオブジェクト。

usage

使用量

トークン使用状況メタデータ。

EmbeddingObject

フィールド

タイプ

説明

object

String

オブジェクトの種類。 "embedding"と同じです。

index

Integer

モデルによって生成された埋め込みの一覧にある埋め込みのインデックス。

embedding

一覧[フロート]

埋め込みベクトル。 各モデルは固定サイズのベクトル (BGE-Large の場合は 1024) を返します