チャット完了

チャット完了APIは、与えられた会話に基づいて応答を生成します。テキストベースとマルチモーダルの両方の入力をサポートしています。

詳細についてはテキスト生成機能のドキュメントをご参照ください。

エンドポイント

POST https://api.sambanova.ai/v1/chat/completions

リクエストパラメータ

以下の表は、チャット完了リクエストを行うために必要なパラメータ、パラメータタイプ、および説明を示しています。

必須パラメータ

パラメータ	タイプ	説明
`model`	String	クエリを実行するモデルの名前。サポートされているモデルリストをご参照ください。
`messages`	Array	会話履歴。各メッセージには`role`と`content`があります。メッセージオブジェクトの構造を参照してください。

メッセージオブジェクトの構造

配列内の各メッセージオブジェクトはmessagesで構成されていますroleとcontent。

フィールド	タイプ	説明
`role`	String	メッセージ作成者の役割。選択肢：`system`、`user`、または`assistant`。
`content`	Mixed	メッセージの内容。テキストのみのメッセージの場合は文字列、マルチモーダルコンテンツの場合は配列。例を参照：文字列コンテンツとマルチモーダルコンテンツ。

文字列コンテンツの例

"content": "Answer the question in a couple sentences."

マルチモーダルコンテンツの例

[
  { "type": "text", "text": "What's in this image?" },
  { "type": "image_url", "image_url": { "url": "base64 encoded string of image" } }
]

オプションパラメータ

以下の表は、モデルの動作を微調整するために使用できるオプションパラメータを示しています。パラメータタイプ、説明、およびデフォルト値を確認できます。

パラメータ	タイプ	説明	値
`max_tokens`	Integer	生成するトークンの最大数。モデルのコンテキスト長によって制限されます。	なし
`temperature`	Float	応答のランダム性を制御します。値が高いほどランダム性が増加します。	`0`から`1`
`top_p`	Float	トークン選択確率を調整し、動的な応答生成を確保します。	`0`から`1`
`top_k`	Integer	トークン選択肢の数を制限します。	`1`から`100`
`stop`	String, array, null	APIが応答生成を停止すべき最大4つのシーケンスを指定します。これは出力の長さを制御するのに役立ちます。	Default: `null`
`stream`	Boolean, null	に設定すると、ストリーミング応答が有効になります`true`。`false`の場合、完了後に完全な応答が返されます。	Default: `false`
`stream_options`	Object, null	追加のストリーミングオプションを指定します（`stream: true`の場合のみ）。利用可能なオプション：`include_usage: boolean`。	Default: `null`

関数呼び出しパラメータ

関数呼び出しをサポートするモデルには、以下の3つのパラメータが使用可能です。これらのパラメータと対応モデルについての詳細は関数呼び出しページでご確認いただけます。

パラメータ	タイプ	説明	値
`tools`	Array	モデルが呼び出せる外部ツールを定義します（現在は関数のみサポート）。ツールパラメータの使用法表を参照。	なし
`response_format`	Object	出力が有効なJSONであることを保証します。`{ "type": "json_object" }`を構造化された応答に使用します。	なし
`tool_choice`	String, object	ツールの使用を制御します（`auto`、`required`、または特定の関数）。tool_choice値表を参照してください。	Default: `auto`

toolsパラメータの使用例

以下の表はtoolsパラメータの構造を説明しています。

タイプ	オブジェクトフィールド	説明
Function	`name`（`string`）	呼び出す関数の名前。
	`description`（`string`）	関数の機能に関する簡単な説明。
	`parameters`（`object`）	関数パラメータを定義します。
	`parameters.type`（`string`）	パラメータオブジェクトのデータ型（常に`"object"`）。
	`parameters.properties`（`object`）	関数パラメータとそのプロパティを定義します。
	`parameters.properties.<param_name>`（`object`）	各関数パラメータは以下のオブジェクトとして定義されます：`type`（データ型）と`description`（パラメータの説明）。
	`parameters.required`（`array`）	関数に必要な必須パラメータのリスト。

tool choiceの許容値

以下の表はtool_choiceパラメータがモデルの外部関数との相互作用をどのように制御するかを示しています。

値	説明
`auto`	モデルはメッセージの生成または関数の呼び出しを選択します。これは`tool_choice`が指定されていない場合のデフォルトの動作です。
`required`	モデルに関数呼び出しを強制します。モデルは常に1つ以上の関数を呼び出すように選択します。

リクエスト例

以下はテキストモデルのストリーミングレスポンスのリクエストボディのサンプルです。

Example text model request

{
   "messages": [
      {"role": "system", "content": "Answer the question in a couple sentences."},
      {"role": "user", "content": "Share a happy story with me"}
   ],
   "max_tokens": 800,
   "stop": ["[INST", "[INST]", "[/INST]", "[/INST]"],
   "model": "Meta-Llama-3.1-8B-Instruct",
   "stream": true, 
   "stream_options": {"include_usage": true}
}

レスポンス形式の例

APIはチャット完了オブジェクト、またはリクエストがストリーミングされている場合はチャット完了チャンクオブジェクトのシーケンスを返します。