アシスタント API を使用して、アシスタントの作成、一覧表示、取得、更新、および削除を行います。
特徴:アシスタント API の機能および基本的な使い方について詳しくは、「アシスタント API の概要」をご参照ください。
永続性:すべてのアシスタントインスタンスは Alibaba Cloud Model Studio サーバー上に保存され、有効期限はありません。アシスタント ID(assistant.id)を指定することで、任意のアシスタントを取得できます。
エージェントアプリケーションとアシスタントは、いずれもモデルアプリケーションの一種ですが、機能および使い方に違いがあります。
-
エージェントアプリケーション:コンソールでのみ作成、表示、更新、および削除が可能であり、アプリケーション呼び出し API を使用して呼び出します。
-
アシスタント:アシスタント API のみを使用して、作成、表示、更新、削除、および呼び出しが可能です。
アシスタントの作成
新しいアシスタントを作成します。
HTTP
コード例
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
"model": "qwen-max",
"name": "インテリジェントアシスタント",
"description": "これはインテリジェントアシスタントです。",
"instructions": "ユーザーのクエリに基づいて異なるツールを呼び出し、応答を提供するインテリジェントアシスタントです。必要に応じてツールを使用してください。",
"tools": [
{
"type": "code_interpreter"
}
],
"metadata": {}
}'
リクエストパラメーター
|
パラメーター名 |
説明 |
パラメータータイプ |
必須 |
|
model |
アシスタントが使用するモデル名。 |
string |
はい |
|
name |
アシスタント名。 |
str |
いいえ |
|
description |
アシスタントの説明。 |
string |
いいえ |
|
instructions |
システムプロンプト。 |
str |
いいえ |
|
tools |
アシスタントが呼び出せるツール。 カスタムプラグインへの認証情報を渡すには:
|
Optional[List[Dict]] |
いいえ(デフォルト:[]) |
|
metadata |
追加で格納する情報。 |
Dict |
いいえ |
|
temperature |
ランダム性および多様性を制御します。 |
float |
いいえ |
|
top_p |
核サンプリングの確率しきい値。 |
float |
いいえ |
|
top_k |
サンプリング対象となる候補セットのサイズ。 |
integer |
いいえ |
レスポンス例
{
"id": "asst_49079f4b-d1e8-4015-a12e-2dcdd1f18d84",
"object": "assistant",
"created_at": 1711713885724,
"model": "qwen-max",
"name": "インテリジェントアシスタント",
"description": "これはインテリジェントアシスタントです。",
"instructions": "あなたはインテリジェントアシスタントです。ユーザーのニーズに応じてさまざまなツールを呼び出して回答を提供できます。必要に応じてツールを使用してください。",
"tools": [
{
"type": "code_interpreter"
}
],
"metadata": {},
"temperature": null,
"top_p": null,
"top_k": null,
"max_tokens": null,
"request_id": "b1778226-3865-9006-9e95-56329a710322"
}
出力パラメーター
アシスタントオブジェクト です。
SDK
コード例
from dashscope import Assistants
import os
import dashscope
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.create(
# API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
api_key=os.getenv("DASHSCOPE_API_KEY"),
# この例では qwen-max を使用しています。必要に応じて他のモデル名に置き換えられます。利用可能なモデルの一覧については、https://www.alibabacloud.com/help/ja/model-studio/getting-started/models をご参照ください。
model='qwen-max',
name='スマートヘルパー',
description='ツールヘルパー。',
instructions='役立つアシスタントです。質問を受けた際には、可能な限りツールを使用してください。',
tools=[{
'type': 'search'
}, {
'type': 'function',
'function': {
'name': 'big_add',
'description': '数値の加算',
'parameters': {
'type': 'object',
'properties': {
'left': {
'type': 'integer',
'description': '左側のオペレーター'
},
'right': {
'type': 'integer',
'description': '右側のオペレーター。'
}
},
'required': ['left', 'right']
}
}
}],
)
print(assistant)
import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.AssistantParam;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import java.lang.System;
import com.alibaba.dashscope.utils.JsonUtils;
import com.alibaba.dashscope.utils.Constants;
public class Main {
static {
Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
}
public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
Assistants assistants = new Assistants();
// アシスタントパラメーターを構築
AssistantParam param = AssistantParam.builder()
// この例では qwen-max を使用しています。必要に応じて他のモデル名に置き換えられます。利用可能なモデルの一覧については、https://www.alibabacloud.com/help/ja/model-studio/getting-started/models をご参照ください。
.model("qwen-max")
.name("インテリジェントガイド")
.description("スマートガイド")
.instructions("役立つアシスタントです。")
// API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
.apiKey(System.getenv("DASHSCOPE_API_KEY"))
.build();
Assistant assistant = assistants.create(param);
System.out.println(JsonUtils.toJson(assistant));
// アシスタントを使用
}
}リクエストパラメーター
|
パラメーター |
タイプ |
デフォルト値 |
説明 |
|
model |
string |
- |
アシスタントが使用するモデル名。 |
|
name |
string |
- |
アシスタント名。 |
|
description |
string |
- |
アシスタントの説明。 |
|
instructions |
string |
- |
アシスタントの機能/命令。 |
|
tools |
array |
[] |
アシスタントが使用するツール。 説明
カスタムツールへの認証情報を渡します。
アシスタントがプラグインを要求すると、プラグイン呼び出しのヘッダーにベアラートークンが |
|
metadata |
object |
なし |
アシスタントのメタデータ。 |
|
workspace |
string |
なし |
ワークスペース ID。サブワークスペースの API キーを使用する場合にのみ必須です。 |
|
api_key |
string |
なし |
Model Studio API キー。環境変数として設定することを推奨します。環境変数としての設定方法をご参照ください。 |
レスポンス例
{
"tools":[
{
"type":"search"
},
{
"function":{
"name":"big_add",
"description":"数値の加算",
"parameters":{
"type":"object",
"properties":{
"left":{
"type":"integer",
"description":"左側のオペレーター"
},
"right":{
"type":"integer",
"description":"右側のオペレーター。"
}
},
"required":[
"left",
"right"
]
}
},
"type":"function"
}
],
"id":"asst_714cac72-81b2-49bf-a75d-c575b90a9398",
"object":"assistant",
"created_at":1726033638848,
"model":"qwen-max",
"name":"スマートヘルパー",
"description":"ツールヘルパー。",
"instructions":"役立つアシスタントです。質問を受けた際には、可能な限りツールを使用してください。",
"file_ids":[
],
"metadata":{
},
"temperature":"None",
"top_p":"None",
"top_k":"None",
"max_tokens":"None",
"request_id":"00f5962e-8d9f-92fd-9320-3173fa1525d6",
"status_code":200
}
レスポンスパラメーター
|
フィールド |
タイプ |
説明 |
|
status_code |
integer |
HTTP ステータスコード。200 = 成功、その他の値 = 失敗。 |
|
name |
string |
アシスタント名。 |
|
id |
string |
アシスタント ID(UUID 文字列)。 |
|
model |
string |
モデル名。 |
|
description |
string |
アシスタントの説明。 |
|
instructions |
string |
アシスタントの命令。 |
|
metadata |
object |
アシスタントのメタデータ。 |
|
tools |
array |
アシスタントが使用できるツール。 |
|
created_at |
integer |
作成タイムスタンプ。 |
|
code |
string |
エラーコード(失敗時のみ、Python SDK のみ)。 |
|
message |
string |
詳細なエラーメッセージ(失敗時のみ、Python SDK のみ)。 |
アシスタントの一覧表示
すべてのアシスタントを一覧表示します。
HTTP
コード例
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants?limit=2&order=desc' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
リクエストパラメーター
|
パラメーター |
入力パラメーター |
タイプ |
必須 |
|
limit |
返されるアシスタントの数。 |
int |
いいえ |
|
order |
作成時刻による並べ替え(asc または desc)。 |
string |
いいえ(デフォルト: |
レスポンス例
{
"object": "list",
"data": [
{
"id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
"object": "assistant",
"created_at": 1711435564909,
"model": "qwen-max",
"name": "インテリジェントアシスタント",
"description": "これはインテリジェントアシスタントです。",
"instructions": "あなたはインテリジェントアシスタントです。ユーザーのニーズに応じてさまざまなツールを呼び出して回答を提供できます。必要に応じてツールを使用してください。",
"tools": [
{
"type": "search"
},
{
"type": "text_to_image"
},
{
"type": "code_interpreter"
}
],
"metadata": {}
},
{
"id": "asst_7af23142-52bc-4218-aa98-dfdb1128f19c",
"object": "assistant",
"created_at": 1711422620443,
"model": "qwen-max",
"name": "役立つアシスタント",
"description": "",
"instructions": "役立つアシスタントです。",
"tools": [
{
"type": "text_to_image"
}
],
"file_ids": [],
"metadata": {}
}
],
"first_id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
"last_id": "asst_7af23142-52bc-4218-aa98-dfdb1128f19c",
"has_more": true,
"request_id": "bc257359-ce86-9547-98be-d804effba8d1"
}
レスポンスパラメーター
アシスタントオブジェクト のリストを返します。
SDK
コード例
import dashscope
from dashscope import Assistants
import os
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.list(
# API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
api_key=os.getenv("DASHSCOPE_API_KEY"),
limit=1,
order='desc'
)import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.common.GeneralListParam;
import com.alibaba.dashscope.common.ListResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
public class Main {
static {
Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
}
public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
Assistants assistants = new Assistants();
GeneralListParam listParam = GeneralListParam.builder()
// API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
.apiKey(System.getenv("DASHSCOPE_API_KEY"))
.limit(10l)
.build();
ListResult<Assistant> assistant = assistants.list(listParam);
}
}リクエストパラメーター
|
パラメーター |
タイプ |
デフォルト値 |
説明 |
|
limit |
string |
なし |
返されるアシスタントの数(省略時はサーバーのデフォルト値が使用されます)。 |
|
order |
string |
なし |
並べ替え順序:`desc`(降順)または `asc`(昇順)。省略時はサーバーのデフォルト値が使用されます。 |
|
workspace |
string |
なし |
ワークスペース ID。サブワークスペースの API キーを使用する場合にのみ必須です。 |
|
api_key |
string |
なし |
Model Studio API キー。環境変数として設定することを推奨します。環境変数としての設定方法をご参照ください。 |
レスポンスパラメーター
|
フィールド名 |
タイプ |
説明 |
|
has_more |
boolean |
さらにデータが利用可能かどうか。 |
|
last_id |
string |
リスト内の最後のアシスタント ID。 |
|
first_id |
string |
リスト内の最初のアシスタント ID。 |
|
data |
array |
アシスタントオブジェクトのリスト。 |
|
object |
string |
`data` フィールドのデータ形式(例: |
|
request_id |
string |
リクエスト ID。 |
|
status_code |
integer |
リクエストのステータスコード。 |
アシスタントの取得
HTTP
コード例
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
リクエストパラメーター
|
入力パラメーター名 |
入力パラメーターの説明 |
タイプ |
必須 |
|
assistant_id |
取得するアシスタント ID。 |
string |
はい |
レスポンス例
{
"id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
"object": "assistant",
"created_at": 1711435564909,
"model": "qwen-max",
"name": "インテリジェントアシスタント",
"description": "これはインテリジェントアシスタントです。",
"instructions": "あなたはインテリジェントアシスタントです。ユーザーのニーズに応じてさまざまなツールを呼び出して回答を提供できます。必要に応じてツールを使用してください。",
"tools": [
{
"type": "search"
},
{
"type": "text_to_image"
},
{
"type": "code_interpreter"
}
],
"metadata": {},
"request_id": "f0ec05b0-8813-984c-81b5-1166ae3478d1"
}
レスポンスパラメーター
取得したアシスタントオブジェクト を返します。
SDK
コード例
from dashscope import Assistants
import dashscope
import os
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistant = Assistants.retrieve(
assistant_id='your_assistant_id',
# API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
api_key=os.getenv("DASHSCOPE_API_KEY")
)
print(assistant)
import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
public class Main {
static {
Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
}
public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
Assistants assistants = new Assistants();
// API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
String apiKey = System.getenv("DASHSCOPE_API_KEY");
Assistant assistant = assistants.retrieve("assistant_id", apiKey);
}
}
リクエストパラメーター
|
パラメーター |
タイプ |
デフォルト値 |
説明 |
|
assistant_id |
string |
- |
取得するアシスタント ID。 |
|
workspace |
string |
なし |
ワークスペース ID。サブワークスペースの API キーを使用する場合にのみ必須です。 |
|
api_key |
string |
なし |
Model Studio API キー。環境変数として設定することを推奨します。環境変数としての設定方法をご参照ください。 |
レスポンスパラメーター
詳細については、「アシスタントオブジェクト」をご参照ください。
アシスタントの更新
HTTP
コード例
curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
"instructions": "検索アシスタントです。",
"name": "新規アプリケーション - アシスタント API",
"description": "",
"model": "qwen-max"
}'
リクエストパラメーター
|
入力パラメーター名 |
説明 |
パラメータータイプ |
必須 |
|
assistant_id |
更新するアシスタント ID。 |
string |
はい |
|
* |
その他の任意のパラメーター。 |
string |
いいえ |
|
model |
アシスタントが使用するモデル名。 |
string |
はい |
|
name |
アシスタント名。 |
string |
いいえ |
|
description |
アシスタントの説明。 |
string |
いいえ |
|
instructions |
システムプロンプト。 |
str |
いいえ |
|
tools |
アシスタントが呼び出せるツール。 |
Optional[List[Dict]] |
いいえ(デフォルト:[]) |
|
metadata |
追加で格納する情報。 |
Dict |
いいえ |
レスポンス例
{
"id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
"object": "assistant",
"created_at": 1711435564909,
"model": "qwen-max",
"name": "新規アプリケーション - アシスタント API",
"description": "",
"instructions": "検索アシスタントです。",
"tools": [
{
"type": "search"
},
{
"type": "text_to_image"
},
{
"type": "code_interpreter"
}
],
"metadata": {},
"request_id": "b0993831-a98b-9e71-b235-75174df9046e"
}
出力パラメーター
更新されたアシスタントオブジェクト を返します。
SDK
コード例
from dashscope import Assistants
import dashscope
import os
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.update(
'assistant_id',
model='new_model_name',
# API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
api_key=os.getenv("DASHSCOPE_API_KEY")
)
import com.alibaba.dashscope.assistants.Assistant;
import com.alibaba.dashscope.assistants.AssistantParam;
import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
public class Main {
static {
Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
}
public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
Assistants assistants = new Assistants();
AssistantParam param = AssistantParam.builder()
.model("qwen-max")
.name("インテリジェントガイド")
.description("スマートガイド")
.instructions("役立つアシスタントです。質問を受けた際には、可能な限りツールを使用してください。")
// API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
.apiKey(System.getenv("DASHSCOPE_API_KEY"))
.build();
Assistant assistant = assistants.update("assistant_id", param);
}
}リクエストパラメーター
|
パラメーター |
タイプ |
デフォルト値 |
説明 |
|
assistant_id |
string |
- |
更新するアシスタント ID。 |
|
model |
string |
- |
アシスタントが使用するモデル名。 |
|
name |
string |
なし |
アシスタント名。 |
|
description |
string |
なし |
アシスタントの説明。 |
|
instructions |
string |
なし |
アシスタントの命令。 |
|
tools |
array |
[] |
アシスタントが使用できるツール。 |
|
metadata |
object |
なし |
アシスタントのメタデータ。 |
|
workspace |
string |
なし |
ワークスペース ID。サブワークスペースの API キーを使用する場合にのみ必須です。 |
|
api_key |
string |
なし |
Model Studio API キー。環境変数として設定することを推奨します。環境変数としての設定方法をご参照ください。 |
レスポンスパラメーター
詳細については、「アシスタントオブジェクト」をご参照ください。
アシスタントの削除
HTTP
コード例
curl --location --request DELETE 'https://dashscope-intl.aliyuncs.com/api/v1/assistants/asst_0678aa33-43e2-4268-95e6-b0010f9f7937' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"
リクエストパラメーター
|
入力パラメーター名 |
説明 |
パラメータータイプ |
必須 |
|
assistant_id |
削除するアシスタント ID。 |
str |
はい |
レスポンス例
{
"id": "asst_0678aa33-43e2-4268-95e6-b0010f9f7937",
"object": "assistant.deleted",
"deleted": true,
"request_id": "6af9320f-0430-9d01-b92f-d1beb6424dc5"
}
レスポンスパラメーター
削除ステータス。
SDK
コード例
from dashscope import Assistants
import dashscope
import os
dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
assistants = Assistants.delete(
'assistant_id',
# API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
api_key=os.getenv("DASHSCOPE_API_KEY")
)import com.alibaba.dashscope.assistants.Assistants;
import com.alibaba.dashscope.common.DeletionStatus;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.InvalidateParameter;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
public class Main {
static {
Constants.baseHttpApiUrl="https://dashscope-intl.aliyuncs.com/api/v1";
}
public static void main(String[] args) throws ApiException, NoApiKeyException, InputRequiredException, InvalidateParameter, InterruptedException {
Assistants assistants = new Assistants();
// API キーを環境変数として設定します。環境変数を設定しない場合は、次の行を Model Studio API キー(例:api_key="sk-xxx")に置き換えてください。
String apiKey = System.getenv("DASHSCOPE_API_KEY");
DeletionStatus assistant = assistants.delete("assistant_id", apiKey);
}
}リクエストパラメーター
|
パラメーター |
タイプ |
デフォルト値 |
説明 |
|
assistant_id |
string |
- |
削除するアシスタント ID。 |
|
workspace |
string |
なし |
ワークスペース ID。サブワークスペースの API キーを使用する場合にのみ必須です。 |
|
api_key |
string |
なし |
Model Studio API キー。環境変数として設定することを推奨します。環境変数としての設定方法をご参照ください。 |
レスポンスパラメーター
|
フィールド名 |
タイプ |
説明 |
|
id |
string |
削除されたオブジェクトの ID。 |
|
object |
string |
オブジェクトタイプ(例: |
|
deleted |
boolean |
削除が成功したかどうか。 |
|
request_id |
string |
リクエスト ID。 |
|
status_code |
integer |
リクエストのステータスコード。 |
アシスタントオブジェクト
モデルを呼び出し、ツールを使用できるアシスタントを表します。
アシスタントオブジェクトの例
{
"id": "asst_49079f4b-d1e8-4015-a12e-2dcdd1f18d84",
"object": "assistant",
"created_at": 1711713885724,
"model": "qwen-max",
"name": "インテリジェントアシスタント",
"description": "これはインテリジェントアシスタントです。",
"instructions": "あなたはインテリジェントアシスタントです。ユーザーのニーズに応じてさまざまなツールを呼び出して回答を提供できます。必要に応じてツールを使用してください。",
"tools": [
{
"type": "code_interpreter"
}
],
"metadata": {},
"temperature": null,
"top_p": null,
"top_k": null,
"max_tokens": null,
"request_id": "b1778226-3865-9006-9e95-56329a710322"
}
|
パラメーター |
データ型 |
説明 |
|
id |
string |
アシスタント ID。 |
|
object |
string |
オブジェクトタイプ(常に |
|
created_at |
integer |
作成タイムスタンプ(UNIX、ミリ秒)。 |
|
model |
string |
モデル名。利用可能なモデルについては、「アシスタント API の概要」または「モデル一覧」をご参照ください。 |
|
name |
string |
アシスタント名。 |
|
description |
string |
アシスタントの説明。 |
|
instructions |
string |
アシスタントの命令。 |
|
tools |
array |
アシスタントで有効化されたツール(公式プラグイン、RAG、または関数呼び出し)。 |
|
metadata |
dict |
アシスタントに関する追加の構造化情報。 |
|
temperature |
float |
サンプリング温度(0~2)。高い値(例:1.0)ほどランダム性が高まり、低い値(例:0.2)ほど決定論的になります。 |
|
top_p |
float |
Nucleus サンプリング: 確率の累積値が `top_p` になるまでのトークンを考慮します (例: 0.1 = 上位 10%)。これか |
|
top_k |
integer |
確率に基づいて上位 `k` トークンからサンプリングします。 |
|
max_tokens |
integer |
応答ごとの最大トークン数。 |
|
request_id |
string |
API 呼び出し識別子。 |
エラーコード
失敗した呼び出しについては、「エラーメッセージ」をご参照ください。