アシスタント API メッセージの作成、リスト、変更 - Model Studio

このトピックでは、Assistant API の Message クラスについて説明し、メッセージの作成、一覧表示、取得、および変更方法について説明します。

関数名	種類
create	メッセージクラスを作成します。
retrieve	メッセージクラスを取得します。
modify	メッセージクラスを変更します。
list	メッセージクラスを一覧表示します。

メッセージを作成する

HTTP

サンプルコード

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "role": "user",
    "content": "Who are you",
    "metadata": {}
}'

リクエストパラメーター

パラメーター	説明	タイプ	必須
thread id	メッセージが渡されるスレッドの ID。	str	はい
content	メッセージの詳細。	str	はい
role	メッセージのロール。 user のみがサポートされています。	str	いいえ
metadata	その他の関連情報。	str	いいえ

サンプルレスポンス

{
    "id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "object": "thread.message",
    "created_at": 1711508433283,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "assistant_id": "",
    "run_id": "",
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Who are you",
                "annotations": []
            }
        }
    ],
    "metadata": {},
    "from": "",
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": {},
    "request_id": "b3ad40b9-f052-9665-a064-dab11c34625f"
}

レスポンスパラメーター

出力はメッセージオブジェクトで、入力パラメーターに加えて次のフィールドが含まれています。

id: メッセージ ID。
request_id: リクエスト ID。

SDK

サンプルコード

Python

from dashscope import Messages
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'
msg = Messages.create(
    'the_thread_id',
    # 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    content='The message content.',
    role='user',
    metadata={'key': 'value'}
)

Java

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.threads.messages.Messages;
import com.alibaba.dashscope.threads.messages.TextMessageParam;
import com.alibaba.dashscope.threads.messages.ThreadMessage;
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 {
        // スレッドへのメッセージを作成する
        Messages messages = new Messages();
        TextMessageParam param = TextMessageParam.builder()
                // 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: apiKey("sk-xxx")
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .role("user")
                .content("How to make delicious beef and potato stew?")
                .build();
        ThreadMessage message = messages.create("threadId", param);
    }
}

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
thread_id	str	-	スレッド ID。
content	str	-	メッセージの内容。
role	str	'user'	メッセージのロール。デフォルト値は user です。
metadata	Dict	なし	メッセージに関連付けられたキーと値の情報。
workspace	str	なし	Model Studio のワークスペース ID。このパラメーターは、api_key がサブワークスペース API キーの場合にのみ必須です。
api_key	str	なし	Model Studio のAPI キーです。 API キーを環境変数として設定することを推奨します。

サンプルレスポンス

結果はメッセージオブジェクトです。以下のコードは、内容を JSON フォーマットで示しています。

{
    "assistant_id": "",
    "content": [
        {
            "text": {
                "value": "sdhafjdasf"
            },
            "type": "text"
        }
    ],
    "created_at": 1711345341301,
    "display": true,
    "from": "",
    "gmt_crete": "2024-03-25 13:42:21",
    "gmt_update": "2024-03-25 13:42:21",
    "id": "message_05494921-a646-484e-85fc-76329acba842",
    "metadata": {
        "key": "value"
    },
    "name": "",
    "object": "thread.message",
    "plugin_call": {},
    "request_id": "631de0b3-7e50-9c9e-8444-0924d1b7e7a5",
    "role": "user",
    "run_id": "",
    "status": {},
    "status_code": 200,
    "thread_id": "thread_f1e7737e-b045-479f-99d1-510db49d535b",
    "tool_calls": []
}

レスポンスパラメーター

パラメーター	タイプ	説明
status_code	int	HTTP ステータスコード。値 200 は、呼び出しが成功したことを示します。その他の値は、呼び出しが失敗したことを示します。
id	str	メッセージ ID。UUID 文字列です。
content	List[dict]	メッセージの内容。
content.type	str	コンテンツタイプ。例: text。
content.text	dict	コンテンツ。
content.text.value	str	コンテンツのテキスト値。
metadata	Dict	このメッセージに関連付けられているキーと値の情報。
tool_calls	Dict	ツール呼び出しに関する情報。
plugin_call	Dict	プラグイン呼び出しに関する情報。
created_at	タイムスタンプ	アシスタントが作成された時刻。
gmt_created	datetime	2024-03-22 17:12:31
gmt_modified	datetime	2024-03-22 17:12:31
code	str	リクエストが失敗したことを示します。このパラメーターはエラーコードを示します。リクエストが成功した場合は、このパラメーターは無視されます。 Python SDK の場合のみ返されます。
message	str	リクエストが失敗したことを示します。このパラメーターは、失敗の詳細を示します。リクエストが成功した場合は、このパラメーターは無視されます。 Python SDK の場合のみ返されます。

メッセージを一覧表示する

HTTP

サンプルコード

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages?limit=2&order=desc' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

リクエストパラメーター

パラメーター	説明	タイプ	必須
thread id	メッセージが渡されるスレッドの ID。	str	はい
limit	返すメッセージの数。	int	いいえ
order	メッセージが作成時刻でソートされる順序。昇順または降順を指定できます。	str	いいえ (デフォルト値は "desc")

サンプルレスポンス

{
    "object": "list",
    "data": [
        {
            "id": "message_f1933671-19e1-4162-ad25-7326165123e1",
            "object": "thread.message",
            "created_at": 1711508433283,
            "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
            "assistant_id": "",
            "run_id": "",
            "role": "user",
            "content": [
                {
                    "type": "text",
                    "text": {
                        "value": "Who are you",
                        "annotations": []
                    }
                }
            ],
            "metadata": {},
            "from": "",
            "name": "",
            "plugin_call": {},
            "tool_calls": [],
            "status": {}
        }
    ],
    "first_id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "last_id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "has_more": false,
    "request_id": "78f7d607-4a9a-90c6-8040-d3f81c84d60a"
}

レスポンスパラメーター

出力はメッセージオブジェクトのリストで、ユーザー入力パラメーターに加えて追加のフィールドが含まれています。

複数のメッセージのリスト。

SDK

サンプルコード

Python

from dashscope import Messages
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

messages = Messages.list(
    'thread_id',
    # 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    limit=1,
    order='desc'
)

Java

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.threads.messages.Messages;
import com.alibaba.dashscope.threads.messages.ThreadMessage;
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 {
        Messages messages = new Messages();
        // 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: apiKey("sk-xxx")
        GeneralListParam listThreadMessages = GeneralListParam.builder()
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        ListResult<ThreadMessage> message = messages.list("threadId", listThreadMessages);
    }
}

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
thread_id	str	-	クエリするスレッドの ID。
limit	int	なし	取得するメッセージの数。
order	str	なし	created_at でメッセージをソートする順序。
workspace	str	なし	Model Studio のワークスペース ID。このパラメーターは、api_key がサブワークスペース API キーの場合にのみ必須です。
api_key	str	なし	Model Studio のAPI キー。 API キーを環境変数として設定することをお勧めします。

レスポンスパラメーター

パラメーター	タイプ	説明
has_more	bool	取得するメッセージがさらに存在するかどうかを示します。
last_id	str	返されたリストの最後のメッセージの ID。
first_id	str	返されたリストの最初のメッセージの ID。
data	list[Message]	メッセージオブジェクトのリスト。

メッセージを取得する

HTTP

サンプルコード

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages/message_ea26d29d-4509-490e-98e9-9f6238bd821b' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY"

リクエストパラメーター

パラメーター	説明	タイプ	必須
thread id	取得するメッセージが渡されるスレッドの ID。	str	はい
message_id	取得するメッセージの ID。	str	はい

サンプルレスポンス

{
    "id": "message_ea26d29d-4509-490e-98e9-9f6238bd821b",
    "object": "thread.message",
    "created_at": 1711508622598,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "assistant_id": "",
    "run_id": "",
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Hello",
                "annotations": []
            }
        }
    ],
    "metadata": {},
    "from": "",
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": {},
    "request_id": "4d5ce962-91c3-9edb-87f7-00bbf985135e"
}

レスポンスパラメーター

出力は取得されたメッセージオブジェクトで、次のフィールドが含まれています。

id: message_id
request_id: リクエスト ID。

SDK

サンプルコード

Python

from dashscope import Messages
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

message = Messages.retrieve(
    'message_id',
    # 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='thread_id'
)

Java

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.threads.messages.Messages;
import com.alibaba.dashscope.threads.messages.ThreadMessage;
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 {
        Messages messages = new Messages();
        // 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: apiKey("sk-xxx")
        String apiKey = System.getenv("DASHSCOPE_API_KEY");
        ThreadMessage message = messages.retrieve("threadId", "messageId", apiKey);
    }
}

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
message_id	str	-	クエリするメッセージの ID。
thread_id	str	-	クエリするメッセージが属するスレッドの ID。
workspace	str	なし	Model Studio のワークスペース ID。このパラメーターは、api_key がサブワークスペース API キーの場合にのみ必須です。
api_key	str	なし	Model Studio のAPI キー。 API キーを環境変数として設定することをお勧めします。

レスポンスパラメーター

create のレスポンスパラメーターを参照してください。

メッセージを変更する

HTTP

サンプルコード

curl --location 'https://dashscope-intl.aliyuncs.com/api/v1/threads/thread_e99a9fe7-0433-426f-98ad-a5139c36579c/messages/message_ea26d29d-4509-490e-98e9-9f6238bd821b' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DASHSCOPE_API_KEY" \
--data '{
    "metadata": {
        "modified": "true",
        "user": "abc123"
    }
}'

リクエストパラメーター

パラメーター	説明	タイプ	必須
thread_id	変更するスレッドの ID。	str	はい
message_id	変更するメッセージの ID。	str	はい
metadata	メタデータ。	dict

サンプルレスポンス

{
    "id": "message_ea26d29d-4509-490e-98e9-9f6238bd821b",
    "object": "thread.message",
    "created_at": 1711508622598,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "assistant_id": "",
    "run_id": "",
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Hello",
                "annotations": []
            }
        }
    ],
    "metadata": {
        "modified": "true",
        "user": "abc123"
    },
    "from": "",
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": {},
    "request_id": "7877b011-cb94-9df1-9add-dc42b7d611f6"
}

レスポンスパラメーター

出力は変更されたメッセージオブジェクトで、入力パラメーターに加えて次のフィールドが含まれています。

id: メッセージ ID。
request_id: リクエスト ID。

SDK

サンプルコード

Python

from dashscope import Messages
import dashscope
import os

dashscope.base_http_api_url = 'https://dashscope-intl.aliyuncs.com/api/v1'

thread = Messages.update(
    'message_id',
    # 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: api_key="sk-xxx"
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    thread_id='the_message_thread_id',
    metadata={'key': 'value'}
)

Java

import java.util.Collections;
import com.alibaba.dashscope.common.UpdateMetadataParam;
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.threads.messages.Messages;
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 {
        Messages messages = new Messages();
        // 環境変数を最初に設定することをお勧めします。環境変数を設定していない場合は、次の行を Model Studio API キーに置き換えます: apiKey("sk-xxx")
        UpdateMetadataParam updateMetadataParam = UpdateMetadataParam.builder()
                .metadata(Collections.singletonMap("key", "value"))
                .apiKey(System.getenv("DASHSCOPE_API_KEY"))
                .build();
        messages.update("thread_id", "message_Id", updateMetadataParam);
    }
}

リクエストパラメーター

パラメーター	タイプ	デフォルト値	説明
message_id	str	-	更新するメッセージの ID。
thread_id	str	-	更新するメッセージが属するスレッドの ID。
metadata	Dict	なし	スレッドに関連付けられた情報。
workspace	str	なし	Model Studio のワークスペース ID。このパラメーターは、api_key がサブワークスペース API キーの場合にのみ必須です。
api_key	str	なし	Model Studio の API キー。 API キーを環境変数として設定することをお勧めします。

レスポンスパラメーター

create のレスポンスパラメーターを参照してください。

エラーコード

呼び出しが失敗してエラーメッセージが返された場合は、トラブルシューティングのためにエラーメッセージを参照してください。