File size: 8,197 Bytes
cbc00ce | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | # -*- coding: utf-8 -*-
# Copyright (c) Alibaba, Inc. and its affiliates.
from typing import Dict, List, Optional
from dashscope.client.base_api import (
CreateMixin,
GetStatusMixin,
ListObjectMixin,
UpdateMixin,
)
from dashscope.common.error import InputRequired
from dashscope.threads.thread_types import ThreadMessage, ThreadMessageList
__all__ = ["Messages"]
class Messages(CreateMixin, ListObjectMixin, GetStatusMixin, UpdateMixin):
SUB_PATH = "messages" # useless
@classmethod
# pylint: disable=dangerous-default-value
def call( # type: ignore[override]
cls,
thread_id: str,
*,
content: str,
role: str = "user",
file_ids: List[str] = [],
metadata: Optional[object] = None,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessage:
"""Create message of thread.
Args:
thread_id (str): The thread id.
content (str): The message content.
role (str, optional): The message role. Defaults to 'user'.
file_ids (List[str], optional):
The file_ids include in message. Defaults to [].
metadata (Optional[object], optional):
The custom key/value pairs. Defaults to None.
workspace (str, optional):
The DashScope workspace id. Defaults to None.
api_key (str, optional): The DashScope api key. Defaults to None.
Returns:
ThreadMessage: The `ThreadMessage` object.
"""
return cls.create(
thread_id,
content=content,
role=role,
file_ids=file_ids,
metadata=metadata,
workspace=workspace,
**kwargs,
)
@classmethod
# pylint: disable=dangerous-default-value
def create(
cls,
thread_id: str,
*,
content: str,
role: str = "user",
file_ids: List[str] = [],
metadata: Optional[object] = None,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessage:
"""Create message of thread.
Args:
thread_id (str): The thread id.
content (str): The message content.
role (str, optional): The message role. Defaults to 'user'.
file_ids (List[str], optional):
The file_ids include in message. Defaults to [].
metadata (Optional[object], optional):
The custom key/value pairs. Defaults to None.
workspace (str, optional):
The DashScope workspace id. Defaults to None.
api_key (str, optional): The DashScope api key. Defaults to None.
Returns:
ThreadMessage: The `ThreadMessage` object.
"""
cls.SUB_PATH = f"{thread_id}/messages"
data = {}
if not thread_id or not content:
raise InputRequired("thread_id and content are required!")
data["content"] = content
data["role"] = role
if metadata:
data["metadata"] = metadata
if file_ids:
data["file_ids"] = file_ids
response = super().call(
data=data,
path=f"threads/{thread_id}/messages",
api_key=api_key,
flattened_output=True,
workspace=workspace,
**kwargs,
)
return ThreadMessage(**response)
@classmethod
def retrieve(
cls,
message_id: str,
*,
thread_id: str,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessage:
"""Get the `ThreadMessage`.
Args:
thread_id (str): The thread id.
message_id (str): The message id.
workspace (str): The dashscope workspace id.
api_key (str, optional): The api key. Defaults to None.
Returns:
ThreadMessage: The `ThreadMessage` object.
"""
return cls.get(
message_id,
thread_id=thread_id,
workspace=workspace,
api_key=api_key,
**kwargs,
)
@classmethod
def get( # type: ignore[override]
cls,
message_id: str,
*,
thread_id: str,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessage:
"""Get the `ThreadMessage`.
Args:
thread_id (str): The thread id.
message_id (str): The message id.
workspace (str): The dashscope workspace id.
api_key (str, optional): The api key. Defaults to None.
Returns:
ThreadMessage: The `ThreadMessage` object.
"""
if not message_id or not thread_id:
raise InputRequired("thread id, message id are required!")
response = super().get(
message_id,
path=f"threads/{thread_id}/messages/{message_id}",
workspace=workspace,
api_key=api_key,
flattened_output=True,
**kwargs,
)
return ThreadMessage(**response)
@classmethod
def list( # type: ignore[override]
cls,
thread_id: str,
*,
limit: int = None,
order: str = None,
after: str = None,
before: str = None,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessageList:
"""List message of the thread.
Args:
thread_id (str): The thread id.
limit (int, optional):
How many assistant to retrieve. Defaults to None.
order (str, optional): Sort order by created_at. Defaults to None.
after (str, optional): Assistant id after. Defaults to None.
before (str, optional): Assistant id before. Defaults to None.
workspace (str, optional):
The DashScope workspace id. Defaults to None.
api_key (str, optional): Your DashScope api key. Defaults to None.
Returns:
ThreadMessageList: The `ThreadMessageList` object.
"""
if not thread_id:
raise InputRequired("thread id is required!")
response = super().list(
limit=limit,
order=order,
after=after,
before=before,
path=f"threads/{thread_id}/messages",
workspace=workspace,
api_key=api_key,
flattened_output=True,
**kwargs,
)
return ThreadMessageList(**response)
@classmethod
def update( # type: ignore[override]
cls,
message_id: str,
*,
thread_id: str,
metadata: Dict = None,
workspace: str = None,
api_key: str = None,
**kwargs,
) -> ThreadMessage:
"""Update an message of the thread.
Args:
thread_id (str): The thread id.
message_id (str): The message id.
content (str): The message content.
role (str, optional): The message role. Defaults to 'user'.
file_ids (List[str], optional):
The file_ids include in message. Defaults to [].
metadata (Optional[object], optional):
The custom key/value pairs. Defaults to None.
workspace (str, optional):
The DashScope workspace id. Defaults to None.
api_key (str, optional): The DashScope api key. Defaults to None.
Returns:
ThreadMessage: The `ThreadMessage` object.
"""
if not thread_id or not message_id:
raise InputRequired("thread id and message id are required!")
response = super().update(
target=message_id,
json={"metadata": metadata},
path=f"threads/{thread_id}/messages/{message_id}",
api_key=api_key,
workspace=workspace,
flattened_output=True,
method="post",
**kwargs,
)
return ThreadMessage(**response)
|