Skip to main content

メッセージ (非推奨)

このトピックでは、アシスタント API の Message クラスを使用して、メッセージを作成、リスト表示、取得、変更する方法について説明します。

アシスタント API は非推奨になりました。代替として Responses API に移行してください。Responses API には、複数の組み込みツールが含まれており、マルチターンのコンテキスト管理をサポートしています。

関数名

タイプ

create

メッセージクラスの作成

retrieve

メッセージクラスの取得

modify

メッセージクラスの変更

list

メッセージクラスのリスト表示

メッセージの作成

  • HTTP
  • SDK
コード例
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。

string

はい

content

メッセージのコンテンツ。

string

はい

role

メッセージを提供するエンティティのロール。`user` のみがサポートされています。

string

いいえ

metadata

その他の関連情報。

string

いいえ

レスポンス
{
    "id": "message_f1933671-19e1-4162-ad25-7326165123e1",
    "object": "thread.message",
    "created_at": 1711508433283,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "incomplete_details": {},
    "completed_at": null,
    "incomplete_at": null,
    "assistant_id": "",
    "run_id": "",
    "file_ids": [],
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Who are you",
                "annotations": []
            }
        }
    ],
    "metadata": {},
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "b3ad40b9-f052-9665-a064-dab11c34625f"
}
レスポンスパラメーターメッセージオブジェクトが返されます。レスポンスには、リクエストパラメーターに加えて、以下のフィールドが含まれます：
  • id：メッセージ ID。
  • request_id：リクエスト ID。

メッセージのリスト

  • HTTP
  • SDK
コード例
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。

string

はい

limit

メッセージ数

integer

いいえ

order

作成時間によるソート順：`asc` または `desc`。

string

いいえ (デフォルト：`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": {},
            "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"
}
レスポンスパラメーターメッセージオブジェクトのリストが返されます。レスポンスには、元のリクエストパラメーターに加えて、以下の追加フィールドが含まれます：
  • 複数のメッセージのリスト。

メッセージの取得

  • HTTP
  • SDK
コード例
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。

string

はい

message_id

取得するメッセージの ID。

string

はい

レスポンス
{
    "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": {},
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "4d5ce962-91c3-9edb-87f7-00bbf985135e"
}
レスポンスパラメーター取得されたメッセージオブジェクトが返されます。レスポンスには、リクエストパラメーターに加えて、以下のフィールドが含まれます：
  • id：メッセージ ID
  • request_id：リクエスト ID。

メッセージの変更

  • HTTP
  • SDK
コード例
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。

string

はい

message_id

変更するメッセージの ID。

string

はい

metadata

メタデータ。

dict

レスポンス
{
    "id": "message_ea26d29d-4509-490e-98e9-9f6238bd821b",
    "object": "thread.message",
    "created_at": 1711508622598,
    "thread_id": "thread_e99a9fe7-0433-426f-98ad-a5139c36579c",
    "incomplete_details": {},
    "completed_at": null,
    "incomplete_at": null,
    "assistant_id": "",
    "run_id": "",
    "file_ids": [],
    "role": "user",
    "content": [
        {
            "type": "text",
            "text": {
                "value": "Hello",
                "annotations": []
            }
        }
    ],
    "metadata": {
        "modified": "true",
        "user": "abc123"
    },
    "name": "",
    "plugin_call": {},
    "tool_calls": [],
    "status": "",
    "request_id": "7877b011-cb94-9df1-9add-dc42b7d611f6"
}
出力パラメーター変更されたメッセージオブジェクトが返されます。レスポンスには、リクエストパラメーターに加えて、以下のフィールドが含まれます：
  • id：メッセージ ID
  • request_id：リクエスト ID。

エラーコード

アシスタント API の呼び出しが失敗し、エラーメッセージが返された場合は、エラーメッセージをご参照の上、問題を解決してください。