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

Important

ベータ版では、新しい Unity AI Gateway エクスペリエンスを利用できます。 新しい Unity AI ゲートウェイは、強化された機能を備えた LLM エンドポイントとコーディング エージェントを管理するためのエンタープライズ コントロール プレーンです。 Unity AI Gateway を使用した AI ガバナンスに関する説明をご覧ください。

この記事では、Databricks Foundation Model API とそれらがサポートするモデルに関する一般的な API 情報を提供します。 Foundation Model API は、既存のプロジェクトの移行を容易にするために、OpenAI の REST API と同様に設計されています。 トークンごとの支払いスループット エンドポイントとプロビジョニング済みスループット エンドポイントはどちらも、同じ REST API 要求形式を受け入れます。

エンドポイント

Foundation Model API では、トークンごとの支払いエンドポイントとプロビジョニングされたスループット エンドポイントがサポートされます。

事前構成済みエンドポイントは、トークンごとの支払いサポートモデルごとにワークスペースで使用でき、ユーザーは HTTP POST 要求を使用してこれらのエンドポイントと対話できます。 サポートされているモデルについては、Model Serving でサポートされている基礎モデルを参照してください。

プロビジョニングされたスループット エンドポイントは、API またはサービス UI を使用して作成できます。 これらのエンドポイントは、両方の提供されるモデルが同じ API 形式を公開している限り、A/B テスト用にエンドポイントごとに複数のモデルをサポートします。 たとえば、両方のモデルがチャット モデルです。 エンドポイント構成パラメーター POST /api/2.0/serving-endpoints を参照してください。

要求と応答では JSON が使用されます。正確な JSON 構造は、エンドポイントのタスクの種類によって異なります。 チャットエンドポイントと完了エンドポイントは、ストリーミング応答をサポートします。

使用法

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

フィールド タイプ 説明
completion_tokens 整数 生成されたトークンの数。 埋め込み応答には含まれません。
prompt_tokens 整数 入力プロンプトからのトークンの数。
total_tokens 整数 トークンの合計数。
reasoning_tokens 整数 思考トークンの数。 推論モデルにのみ適用されます。

databricks-meta-llama-3-3-70b-instruct のようなモデルの場合、ユーザー プロンプトは、モデルに渡される前にプロンプト テンプレートを使用して変換されます。 トークンごとの支払いエンドポイントの場合は、システム プロンプトも追加される場合があります。 prompt_tokens には、サーバーによって追加されたすべてのテキストが含まれています。

Responses API

Important

この Responses API リファレンスは、OpenAI モデルに適用されます。 Anthropic Claude、Google Gemini、または Databricks でホストされるオープン モデルで Responses 要求形式を使用するには、「Open Responses API を使用してモデルにクエリを実行する」を参照してください。

Responses API を使用すると、モデルとの複数ターンの会話が可能になります。 チャットの完了とは異なり、Responses API はinputではなくmessagesを使用します。

応答 API 要求

フィールド 既定値 タイプ 説明
model 糸 必須。 応答の生成に使用されるモデル ID。
input String または List[ResponsesInput] 必須。 応答の生成に使用される、モデルへのテキスト、画像、またはファイルの入力。 messagesとは異なり、このフィールドではinputを使用して会話コンテンツを指定します。
instructions null 糸 モデルのコンテキストに挿入されるシステム (または開発者) メッセージ。
max_output_tokens null null。制限なし、または 0 より大きい整数を意味します 表示される出力トークンや推論トークンなど、応答用に生成できるトークンの数の上限。
temperature 1.0 [0,2] の浮動小数点数 サンプリング温度。 0 は決定論的であり、値が大きいほどランダム性が高くなります。
top_p 1.0 (0,1] の浮動小数点数 核サンプリングに使用される確率しきい値。
stream false ブール値 true に設定すると、サーバー送信イベントを使用して生成されるときに、モデル応答データがクライアントにストリーミングされます。
stream_options null StreamOptions ストリーミング応答のオプション。 stream: true に設定した場合はこれのみを設定します。
text null TextConfig モデルからのテキスト応答の構成オプション。 プレーン テキストまたは構造化された JSON データを指定できます。
reasoning null ReasoningConfig gpt-5 および o シリーズ モデルの推論構成。
tool_choice "auto" 文字列または ToolChoiceObject 応答を生成するときに使用するツール (またはツール) をモデルで選択する方法。 モデルが呼び出すことができるツールを指定する方法については、 tools パラメーターを参照してください。
tools null リスト[ToolObject] 応答の生成中にモデルが呼び出す可能性があるツールの配列。 注: コード インタープリターと Web 検索ツールは、Databricks ではサポートされていません。
parallel_tool_calls true ブール値 モデルがツール呼び出しを並列で実行できるようにするかどうかを指定します。
max_tool_calls null 0 より大きい整数 応答で処理できる組み込みツールへの呼び出しの合計数。
metadata null オブジェクト オブジェクトにアタッチできる 16 個のキーと値のペアのセット。
prompt_cache_key null 糸 同様の要求の応答をキャッシュしてキャッシュ ヒット 率を最適化するために使用されます。 user フィールドを置き換えます。
prompt_cache_retention null 糸 プロンプト キャッシュの保持ポリシー。 "24h"に設定すると、拡張プロンプト キャッシュが有効になります。このキャッシュされたプレフィックスは、最大 24 時間まで、より長くアクティブな状態を維持します。
safety_identifier null 糸 使用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される安定した識別子。
user null 糸 非推奨。 代わりに、safety_identifier および prompt_cache_key を使用してください。
truncation null 糸 モデルの応答に使用する切り捨て戦略。
top_logprobs null 整数 0 から 20 までの整数値を指定します。これは、各トークンの位置において、最も出現確率の高いトークンをいくつ返すかを表します。各トークンには、それぞれ関連するログ確率が付与されます。
include null List[String] モデル応答に含める追加の出力データを指定します。
prompt null オブジェクト プロンプト テンプレートとその変数への参照。

サポートされていないパラメーター: 次のパラメーターは Databricks ではサポートされておらず、指定すると 400 エラーが返されます。

  • background - バックグラウンド処理はサポートされていません
  • store - 保存された応答はサポートされていません
  • conversation - Conversation API はサポートされていません
  • service_tier - サービス レベルの選択は Databricks によって管理されます

ResponsesInput

input フィールドは、ロールとコンテンツを含む文字列または入力メッセージ オブジェクトのリストを受け入れます。

フィールド タイプ 説明
role 糸 必須。 メッセージ作成者の役割。 "user" または "assistant" を指定できます。
content String または List[ResponsesContentBlock] 必須。 文字列またはコンテンツ ブロックの配列としてのメッセージの内容。

ResponsesContentBlock

コンテンツ ブロックは、入力メッセージと出力メッセージ内のコンテンツの種類を定義します。 コンテンツ ブロックの種類は、 type フィールドによって決まります。

InputText
フィールド タイプ 説明
type 糸 必須。 "input_text"である必要があります。
text 糸 必須。 テキスト コンテンツ。
OutputText
フィールド タイプ 説明
type 糸 必須。 "output_text"である必要があります。
text 糸 必須。 テキスト コンテンツ。
annotations リスト[オブジェクト] テキスト コンテンツの省略可能な注釈。
InputImage
フィールド タイプ 説明
type 糸 必須。 "input_image"である必要があります。
image_url 糸 必須。 イメージの URL または base64 でエンコードされたデータ URI。
InputFile
フィールド タイプ 説明
type 糸 必須。 "input_file"である必要があります。
file_id 糸 アップロードされたファイルを使用している場合のファイル識別子。
filename 糸 ファイルの名前。
file_data 糸 形式プレフィックスを持つ Base64 でエンコードされたデータ URI。 たとえば、PDF ファイルでは形式 data:application/pdf;base64,<base64 data>が使用されます。
FunctionCall
フィールド タイプ 説明
type 糸 必須。 "function_call"である必要があります。
id 糸 必須。 関数呼び出しの一意識別子。
call_id 糸 必須。 呼び出し識別子。
name 糸 必須。 呼び出される関数の名前。
arguments オブジェクト/文字列 必須。 JSON オブジェクトまたは文字列としての関数引数。
FunctionCallOutput
フィールド タイプ 説明
type 糸 必須。 "function_call_output"である必要があります。
call_id 糸 必須。 この出力が対応する呼び出し識別子。
output String/オブジェクト 必須。 関数は、文字列または JSON オブジェクトとして出力されます。
CustomToolCall

カスタム ツールが呼び出されたときに、応答 output 配列で返されます。 関数呼び出しとは異なり、カスタム ツール呼び出しは JSON inputではなくプレーン テキスト argumentsを返します。

フィールド タイプ 説明
type 糸 必須。 "custom_tool_call"である必要があります。
id 糸 必須。 このカスタム ツール呼び出しに対する一意 識別子。
call_id 糸 必須。 呼び出し識別子。
name 糸 必須。 呼び出されるカスタム ツールの名前。
input 糸 必須。 (JSON ではなく) プレーン テキストとしてのツール入力。
status 糸 ツール呼び出しの状態。 次のいずれか: completed、 in_progress。
CustomToolCallOutput

この入力の種類を使用して、カスタム ツールが複数ターンの会話でモデルにコールバックした結果を提供します。

フィールド タイプ 説明
type 糸 必須。 "custom_tool_call_output"である必要があります。
call_id 糸 必須。 この出力が対応する呼び出し識別子。
output 糸 必須。 文字列としてのカスタム ツールの出力。

StreamOptions

ストリーミング応答の構成。 stream: true の場合のみ使用されます。

フィールド タイプ 説明
include_usage ブール値 true の場合は、ストリームにトークンの使用状況情報を含めます。 既定値は false です。

TextConfig

構造化された出力を含むテキスト出力の構成。

フィールド タイプ 説明
format ResponsesFormatObject テキスト出力の書式指定。

ResponsesFormatObject

テキスト応答の出力形式を指定します。

フィールド タイプ 説明
type 糸 必須。 形式の種類: プレーン テキストの "text" 、JSON の "json_object" 、または構造化 JSON の "json_schema" 。
json_schema オブジェクト の場合、必要です。 出力の構造を定義する JSON スキーマ オブジェクト。

json_schema オブジェクトの構造は、Chat Completions API に記載されている JsonSchemaObject と同じです。

ReasoningConfig

推論モデル (o シリーズおよび gpt-5 モデル) での推論動作の構成。

フィールド タイプ 説明
effort 糸 推論の努力レベル: "low"、"medium"、または"high"。 既定値は "medium" です。
encrypted_content 糸 ステートレス モードの暗号化された推論コンテンツ。 以前の応答でモデルによって提供されます。

ToolObject

Azure Databricks での Function の呼び出しを参照してください。

注

Responses API では、 function、 custom、 mcp、 image_generation、 shellのツールの種類がサポートされています。 カスタム ツールと文法ベースの出力形式は、GPT-5 シリーズ モデル (gpt-5、 gpt-5.1、 gpt-5.2) でのみ使用できます。

フィールド タイプ 説明
type 糸 必須。 ツールの種類。 サポートされている値については、上記の注を参照してください。
function FunctionObject type が function の場合に必要です。 ツールに関連付けられている関数定義。
name 糸 type が custom の場合に必要です。 カスタム ツールの名前。
description 糸 type が custom の場合に必要です。 カスタム ツールの動作の説明。
format CustomFormat Optional. typeがcustom場合は、出力形式を指定します。 既定値は {"type": "text"} です。 構造化された出力に {"type": "grammar", "definition": "<grammar>", "syntax": "lark"} を使用することもできます。 GPT-5 シリーズ モデルでのみサポートされます。

CustomToolObject

カスタム ツールを使用すると、モデルは JSON 形式の関数引数ではなく任意の文字列出力を返すことができます。 これは、コードの生成、パッチの適用、または構造化された JSON が不要なその他のユース ケースに役立ちます。

注

カスタム ツールは、応答 API を介して GPT-5 シリーズ モデル (gpt-5、 gpt-5.1、 gpt-5.2) でのみサポートされます。

カスタム ツールの例:

{
  "type": "custom",
  "name": "code_exec",
  "description": "Executes arbitrary Python code. Return only valid Python code."
}

文法を使用したカスタム ツールの例:

{
  "type": "custom",
  "name": "apply_patch",
  "description": "Apply a patch to create or modify files.",
  "format": {
    "type": "grammar",
    "definition": "start: begin_patch hunk end_patch\nbegin_patch: \"*** Begin Patch\" LF\n...",
    "syntax": "lark"
  }
}

カスタム ツールが呼び出されると、応答には JSON custom_tool_callではなくプレーン テキスト inputを含むarguments出力項目が含まれます。

CustomFormat

文法ベースの出力形式は、GPT-5 シリーズ モデルでのみサポートされます。

フィールド タイプ 説明
type 糸 必須。 プレーン テキスト出力の場合は "text" 、文法に制約のある出力の場合は "grammar" 。
definition 糸 type が "grammar" の場合に必要です。 Lark 構文を使用した文法定義文字列。
syntax 糸 type が "grammar" の場合に必要です。 文法構文。 現在、"lark" のみがサポートされています。

FunctionObject

フィールド タイプ 説明
name 糸 必須。 呼び出す関数の名前。
description オブジェクト 必須。 関数の詳細な説明。 モデルでは、この説明を使用して、プロンプトに対する関数の関連性を理解し、より高い精度でツール呼び出しを生成します。
parameters オブジェクト 有効な JSON スキーマ オブジェクトとして記述された、関数が受け入れるパラメーター。 ツールが呼び出された場合、ツール呼び出しは指定された JSON スキーマに適合します。 パラメーターを省略すると、パラメーターのない関数が定義されます。 properties の数は 15 キーに制限されています。
strict ブール値 関数呼び出しの生成時に厳密なスキーマ準拠を有効にするかどうか。 trueに設定すると、モデルはスキーマ フィールドで定義されている正確なスキーマに従います。 strict が true されている場合は、JSON スキーマのサブセットのみがサポートされます

ToolChoiceObject

Azure Databricks での Function の呼び出しを参照してください。

フィールド タイプ 説明
type 糸 必須。 強制するツールの種類。 サポートされている値は、 ToolObject のツールの種類 ( "function"、 "custom"など) と一致します。
function オブジェクト type が "function" の場合に必要です。 フォームのオブジェクト{"name": "my_function"}"my_function"は、 フィールドの tools の名前です。
name 糸 type が "custom" の場合に必要です。 強制するカスタム ツールの名前。 GPT-5 シリーズ モデルでのみサポートされます。

応答のAPIレスポンス

ストリーミング以外の要求の場合、応答は 1 つの応答オブジェクトです。 ストリーミング要求の場合、応答は各イベントが応答チャンクである text/event-stream です。

フィールド タイプ 説明
id 糸 応答の一意識別子。 注: Databricks では、セキュリティのためにこの ID が暗号化されます。
object 糸 オブジェクトの種類。 "response"に等しい。
created_at 整数 応答が作成されたときの Unix タイムスタンプ (秒単位)。
status 糸 応答の状態。 次のいずれか: completed、 failed、 in_progress、 cancelled、 queued、または incomplete。
model 糸 応答の生成に使用されるモデル バージョン。
output リスト[ResponsesMessage] モデルによって生成される出力。通常はメッセージ オブジェクトを含みます。
usage 使用方法 トークンの使用メタデータ。
error エラー 応答が失敗した場合のエラー情報。
incomplete_details 不完全な詳細 応答が不完全である理由の詳細 (該当する場合)。
instructions 糸 要求に記載されている手順。
max_output_tokens 整数 要求で指定された最大出力トークン。
temperature Float 生成に使用される温度。
top_p Float 生成に使用されるtop_p値。
tools リスト[ToolObject] 要求で指定されたツール。
tool_choice 文字列または ToolChoiceObject リクエストからのツール選択の設定。
parallel_tool_calls ブール値 並列ツール呼び出しが有効になっているかどうか。
store ブール値 応答が格納されたかどうか。
metadata オブジェクト 応答に添付されたメタデータ。

ResponsesMessage

モデルの応答コンテンツを含む output フィールド内のメッセージ オブジェクト。

フィールド タイプ 説明
id 糸 必須。 メッセージのユニーク識別子。
role 糸 必須。 メッセージのロール。 "user" または "assistant" のいずれかです。
content リスト[ResponsesContentBlock] 必須。 メッセージ内のコンテンツブロック。
status 糸 メッセージ処理の状態。
type 糸 必須。 オブジェクトの種類。 "message"に等しい。

Error

応答が失敗したときのエラー情報。

フィールド タイプ 説明
code 糸 必須。 エラー コード。
message 糸 必須。 人間が判読できるエラー メッセージ。
param 糸 エラーの原因となったパラメーター (該当する場合)。
type 糸 必須。 エラーの種類。

IncompleteDetails

応答が不完全である理由の詳細。

フィールド タイプ 説明
reason 糸 必須。 応答が不完全である理由。

Chat Completions API（チャット完了API）

Chat Completions API を使用すると、モデルとの複数ターンの会話が可能になります。 モデル応答は、会話内の次の assistant メッセージを提供します。 エンドポイント パラメーターの問い合わせ方法については、「POST /serving-endpoints/{name}/invocations」を参照してください。

チャット要求

フィールド 既定値 タイプ 説明
messages ChatMessage リスト 必須。 現在の会話を表すメッセージの一覧。
max_tokens null null。制限なし、または 0 より大きい整数を意味します 生成するトークンの最大数。
stream true ブール値 要求の部分的な結果を許可するために、応答をクライアントにストリーム配信します。 このパラメーターが要求に含まれている場合、応答は標準 サーバー送信イベントを使用して送信されます。
temperature 1.0 [0,2] の浮動小数点数 サンプリング温度。 0 は決定論的であり、値が大きいほどランダム性が高くなります。
top_p 1.0 (0,1] の浮動小数点数 核サンプリングに使用される確率しきい値。
top_k null null。制限なし、または 0 より大きい整数を意味します 上位 k フィルター処理に使用する可能性が最も高い k 個のトークンの数を定義します。 出力を決定論的にするには、この値を 1 に設定します。
stop [] 文字列またはリスト[文字列] stop 内のいずれかのシーケンスが検出されると、モデルはさらなるトークンの生成を停止します。
n 1 0 より大きい整数 この API は、n が指定された場合に、n 個の独立したチャット入力候補を返します。 推論の効率を高め、コストを削減するために、同じ入力で複数の入力候補を生成するワークロードに推奨されます。 プロビジョニングされたスループット エンドポイントでのみ使用できます。
tool_choice none 文字列または ToolChoiceObject tools フィールドと組み合わせてのみ使用します。 tool_choice では、auto、required、noneなど、さまざまなキーワード文字列がサポートされています。 auto は、使用に関連する (ある場合) ツールをモデルに決定させることを意味します。 autoでは、tools内のどのツールも関連しているとモデルが信じていない場合、モデルはツール呼び出しの代わりに標準アシスタント メッセージを生成します。 required は、モデルが tools で最も関連性の高いツールを選択し、ツール呼び出しを生成する必要があることを意味します。 none は、モデルがツール呼び出しを生成せず、代わりに標準のアシスタント メッセージを生成する必要があることを意味します。 toolsで定義されている特定のツールを使用してツール呼び出しを強制するには、ToolChoiceObjectを使用します。 既定では、tools フィールドに tool_choice = "auto" が設定されます。 それ以外の場合、tools フィールドの既定値は tool_choice = "none"
tools null ToolObject モデルが呼び出すことができる tools の一覧。 現在、function は唯一サポートされている tool 型であり、最大 32 個の関数がサポートされています。
response_format null ResponseFormatObject モデルが出力する必要がある形式を指定するオブジェクト。 使用できる型は、text、json_schema、または json_object
{ "type": "json_schema", "json_schema": {...} } に設定すると、構造化された出力が有効になり、指定された JSON スキーマにモデルが確実に従います。
{ "type": "json_object" } に設定すると、モデルによって生成される応答は有効な JSON になりますが、応答が特定のスキーマに従っているわけではありません。
logprobs false ブール値 このパラメーターは、サンプリングされるトークンのログ確率を指定するかどうかを示します。
top_logprobs null 整数 このパラメーターは、サンプリング ステップごとにログ確率を返す可能性が最も高いトークン候補の数を制御します。 0 ~ 20 にすることができます。 このフィールドを使用する場合は、logprobs は true でなければなりません。
reasoning_effort "medium" 糸 応答を生成するときにモデルが適用する必要がある推論作業のレベルを制御します。 使用できる値は、 "low"、 "medium"、または "high"です。 推論作業が多いほど、より思慮深く正確な応答が得られますが、待機時間とトークンの使用が増加する可能性があります。 このパラメーターは、 databricks-gpt-oss-120b や databricks-gpt-oss-20bを含む限られたモデル セットでのみ受け入れられます。

ChatMessage

フィールド タイプ 説明
role 糸 必須。 メッセージの作成者の役割。 "system"、"user"、"assistant"、または "tool"することができます。
content 糸 メッセージの内容。 ツールの呼び出しを伴わないチャット タスクに必要な。
tool_calls ToolCall の一覧 モデルによって生成された tool_calls の一覧。 role を "assistant" として持ち、content フィールドの指定がないことが必要です。
tool_call_id 糸 role が "tool" である場合、メッセージの応答対象の ToolCall に関連する ID。 その他の role オプションの場合は空にする必要があります。

system ロールは、会話の最初のメッセージとして 1 回だけ使用できます。 モデルの既定のシステム プロンプトをオーバーライドします。

ToolCall

モデルによるツールコールアクションの提案。 Azure Databricks での Function の呼び出しを参照してください。

フィールド タイプ 説明
id 糸 必須。 このツールの提案呼び出しに対する一意の識別子。
type 糸 必須。 "function" のみがサポートされています。
function 関数呼び出し完了 必須。 モデルによって提案される関数呼び出し。
cache_control 糸 要求のキャッシュを有効にします。 このパラメーターは、 Databricks でホストされる Claude モデルでのみ受け入れられます。 例については、「 プロンプトキャッシュ」 を参照してください。

FunctionCallCompletion

フィールド タイプ 説明
name 糸 必須。 モデルが推奨する関数の名前。
arguments オブジェクト 必須。 シリアル化された JSON ディクショナリとしての関数の引数。

注: ToolChoiceObject、 ToolObject、および FunctionObject は 、Responses API セクション で定義され、両方の API 間で共有されます。

ResponseFormatObject

Azure Databricks の Structured 出力を参照してください。

フィールド タイプ 説明
type 糸 必須。 定義されている応答形式の型。 非構造化テキストの text、非構造化 JSON オブジェクトの json_object、または特定のスキーマに準拠する JSON オブジェクトの json_schema。
json_schema JsonSchemaObject 必須。 type が json_schema に設定されている場合に準拠する JSON スキーマ

JsonSchemaObject

Azure Databricks の Structured 出力を参照してください。

フィールド タイプ 説明
name 糸 必須。 応答形式の名前。
description 糸 応答形式の説明で、モデルがその形式でどのように応答するかを決定するために使用されます。
schema オブジェクト 必須。 JSON スキーマ オブジェクトとして記述された応答形式のスキーマ。
strict ブール値 出力の生成時に厳密なスキーマ準拠を有効にするかどうかを指定します。 trueに設定すると、モデルはスキーマ フィールドで定義されている正確なスキーマに従います。 strict が true されている場合は、JSON スキーマのサブセットのみがサポートされます

チャット応答

ストリーミング以外の要求の場合、応答は 1 つのチャット完了オブジェクトです。 ストリーミング要求の場合、応答は各イベントが完了チャンク オブジェクトである text/event-stream です。 完了オブジェクトとチャンク オブジェクトの最上位レベルの構造はほぼ同じです。異なる型を持つのは choices だけです。

フィールド タイプ 説明
id 糸 チャット入力候補の一意識別子。
choices List[ChatCompletionChoice] または List[ChatCompletionChunk] (ストリーミング) チャット完了テキストの一覧。 n パラメーターが指定されている場合は、n 選択肢が返されます。
object 糸 オブジェクトの種類。 非ストリーミングの場合は "chat.completions"、ストリーミングの場合は "chat.completion.chunk" のいずれかと等しくなります。
created 整数 チャット入力候補が生成された時間 (秒単位)。
model 糸 応答の生成に使用されるモデル バージョン。
usage 使用方法 トークンの使用メタデータ。 ストリーミング応答に存在しない可能性があります。

ChatCompletionChoice

フィールド タイプ 説明
index 整数 生成された選択肢の一覧内の選択肢のインデックス。
message ChatMessage モデルによって返されるチャット完了メッセージ。 ロールは assistant になります。
finish_reason 糸 モデルがトークンの生成を停止した理由。
extra_fields 糸 外部モデル プロバイダーの独自モデルを使用する場合、プロバイダーの API に応答に追加のメタデータが含まれる場合があります。 Databricks はこれらの応答をフィルター処理し、プロバイダーの元のフィールドのサブセットのみを返します。 safetyRatingは、現時点でサポートされている唯一の追加フィールドです。詳細については、Gemini のドキュメントを参照してください。

ChatCompletionChunk

フィールド タイプ 説明
index 整数 生成された選択肢の一覧内の選択肢のインデックス。
delta ChatMessage モデルから生成されたストリーミング応答のチャット完了メッセージの一部。 最初のチャンクのみ、role が設定されていることが保証されます。
finish_reason 糸 モデルがトークンの生成を停止した理由。 最後のチャンクにのみ、これが設定されます。

埋め込み API

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

埋め込み要求

フィールド タイプ 説明
input 文字列またはリスト[文字列] 必須。 埋め込む入力テキスト。 文字列または文字列のリストを指定できます。
instruction 糸 埋め込みモデルに渡す省略可能な命令。
dimensions 整数 Optional. 結果として出力される埋め込みに必要なディメンションの数。 32 から 1024 までの 2 の累乗である必要があります。 databricks-qwen3-embedding-0-6bでのみサポートされます。

命令は省略可能であり、モデル固有のものです。 たとえば、BGE 作成者はチャンクのインデックスを作成するときに命令を推奨せず、取得クエリに命令 "Represent this sentence for searching relevant passages:" を使用することをお勧めします。 Qwen3-Embedding の作成者は、取得クエリに対しては"Given a web search query, retrieve relevant passages that answer the query"のようなタスク固有の命令を推奨していますが、取得ドキュメントを埋め込む場合には命令を付けないことを推奨しています。 Instructor-XL などの他のモデルでは、さまざまな命令文字列がサポートされています。

埋め込み応答

フィールド タイプ 説明
id 糸 埋め込みの一意識別子。
object 糸 オブジェクトの種類。 "list"に等しい。
model 糸 埋め込みの作成に使用される埋め込みモデルの名前。
data 埋め込みオブジェクト 埋め込みオブジェクト。
usage 使用方法 トークンの使用メタデータ。

EmbeddingObject

フィールド タイプ 説明
object 糸 オブジェクトの種類。 "embedding"に等しい。
index 整数 モデルによって生成された埋め込みの一覧内の埋め込みのインデックス。
embedding リスト[浮動小数点数] 埋め込みベクター。 各モデルは固定サイズ ベクトルを返します (BGE-Largeの場合は 1024)

Completions API

テキスト補完タスクは、1 つのプロンプトに対する応答を生成するためのタスクです。 チャットとは異なり、このタスクはバッチ入力をサポートしています。複数の独立したプロンプトを 1 つの要求で送信できます。 エンドポイント パラメーターの問い合わせ方法については、「POST /serving-endpoints/{name}/invocations」を参照してください。

入力候補要求

フィールド 既定値 タイプ 説明
prompt 文字列またはリスト[文字列] 必須。 モデルのプロンプト。
max_tokens null null。制限なし、または 0 より大きい整数を意味します 生成するトークンの最大数。
stream true ブール値 要求の部分的な結果を許可するために、応答をクライアントにストリーム配信します。 このパラメーターが要求に含まれている場合、応答は標準 サーバー送信イベントを使用して送信されます。
temperature 1.0 [0,2] の浮動小数点数 サンプリング温度。 0 は決定論的であり、値が大きいほどランダム性が高くなります。
top_p 1.0 (0,1] の浮動小数点数 核サンプリングに使用される確率しきい値。
top_k null null。制限なし、または 0 より大きい整数を意味します 上位 k フィルター処理に使用する可能性が最も高い k 個のトークンの数を定義します。 出力を決定論的にするには、この値を 1 に設定します。
error_behavior "error" "truncate" または "error" タイムアウトとコンテキスト長を超えたエラーの場合。 "truncate" (できるだけ多くのトークンを返す) と "error" (エラーを返す) のいずれか。 このパラメーターは、トークン エンドポイントあたりの支払いによってのみ受け入れられます。
n 1 0 より大きい整数 この API は、n が指定された場合に、n 個の独立したチャット入力候補を返します。 推論の効率を高め、コストを削減するために、同じ入力で複数の入力候補を生成するワークロードに推奨されます。 プロビジョニングされたスループット エンドポイントでのみ使用できます。
stop [] 文字列またはリスト[文字列] stop 内のいずれかのシーケンスが検出されると、モデルはさらなるトークンの生成を停止します。
suffix "" 糸 すべての完了の末尾に追加される文字列。
echo false ブール値 入力候補と共にプロンプトを返します。
use_raw_prompt trueプロビジョニング済みスループットの場合や、falseトークン毎に支払う場合に ブール値 true場合は、変換を行わずに prompt をモデルに直接渡します。 デフォルトでは、プロビジョニングされたスループット エンドポイントでは true に設定され、トークンごとの支払いエンドポイントでは false に設定されます。

入力候補の応答

フィールド タイプ 説明
id 糸 テキスト入力候補の一意識別子。
choices CompletionChoice テキスト入力候補のリスト。 渡されるすべてのプロンプトについて、n が指定されている場合、n 選択肢が生成されます。 既定の n は 1 です。
object 糸 オブジェクトの種類。 "text_completion" と等しい
created 整数 完了が生成された時間 (秒単位)。
usage 使用方法 トークンの使用メタデータ。

CompletionChoice

フィールド タイプ 説明
index 整数 要求中のプロンプトのインデックス。
text 糸 生成された入力候補。
finish_reason 糸 モデルがトークンの生成を停止した理由。

その他のリソース

  • Last updated on