feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 105
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-f3bda395c29259f9059f182277574a0a665d6fd12a7d4002803cf35d045dedaf.yml
-openapi_spec_hash: 351d7b616d2d0cc2fdf8074f51187b87
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-5545d4cabf39ad53ab9333c0dbaac64f770a72ef4ea6a39341cfe93cae7641f1.yml
+openapi_spec_hash: 25ea98b6cf6b506fbea4011c78c6ff7f
 config_hash: acdf4142177ed1932c2d82372693f811

api.md

@@ -90,14 +90,21 @@ Methods:
 Types:
 
 ```python
-from asktable.types import AIMessage, Chat, ToolMessage, UserMessage, ChatRetrieveResponse
+from asktable.types import (
+    AIMessage,
+    ToolMessage,
+    UserMessage,
+    ChatCreateResponse,
+    ChatRetrieveResponse,
+    ChatListResponse,
+)
 ```
 
 Methods:
 
-- <code title="post /v1/chats">client.chats.<a href="./src/asktable/resources/chats/chats.py">create</a>(\*\*<a href="src/asktable/types/chat_create_params.py">params</a>) -> <a href="./src/asktable/types/chat.py">Chat</a></code>
+- <code title="post /v1/chats">client.chats.<a href="./src/asktable/resources/chats/chats.py">create</a>(\*\*<a href="src/asktable/types/chat_create_params.py">params</a>) -> <a href="./src/asktable/types/chat_create_response.py">ChatCreateResponse</a></code>
 - <code title="get /v1/chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">retrieve</a>(chat_id) -> <a href="./src/asktable/types/chat_retrieve_response.py">ChatRetrieveResponse</a></code>
-- <code title="get /v1/chats">client.chats.<a href="./src/asktable/resources/chats/chats.py">list</a>(\*\*<a href="src/asktable/types/chat_list_params.py">params</a>) -> <a href="./src/asktable/types/chat.py">SyncPage[Chat]</a></code>
+- <code title="get /v1/chats">client.chats.<a href="./src/asktable/resources/chats/chats.py">list</a>(\*\*<a href="src/asktable/types/chat_list_params.py">params</a>) -> <a href="./src/asktable/types/chat_list_response.py">SyncPage[ChatListResponse]</a></code>
 - <code title="delete /v1/chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">delete</a>(chat_id) -> None</code>
 
 ## Messages

src/asktable/resources/chats/chats.py

@@ -26,8 +26,9 @@
     async_to_streamed_response_wrapper,
 )
 from ...pagination import SyncPage, AsyncPage
-from ...types.chat import Chat
 from ..._base_client import AsyncPaginator, make_request_options
+from ...types.chat_list_response import ChatListResponse
+from ...types.chat_create_response import ChatCreateResponse
 from ...types.chat_retrieve_response import ChatRetrieveResponse
 
 __all__ = ["ChatsResource", "AsyncChatsResource"]
@@ -71,7 +72,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Chat:
+    ) -> ChatCreateResponse:
         """
         创建对话
 
@@ -111,7 +112,7 @@ def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Chat,
+            cast_to=ChatCreateResponse,
         )
 
     def retrieve(
@@ -158,7 +159,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> SyncPage[Chat]:
+    ) -> SyncPage[ChatListResponse]:
         """
         查询对话列表
 
@@ -177,7 +178,7 @@ def list(
         """
         return self._get_api_list(
             "/v1/chats",
-            page=SyncPage[Chat],
+            page=SyncPage[ChatListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -191,7 +192,7 @@ def list(
                     chat_list_params.ChatListParams,
                 ),
             ),
-            model=Chat,
+            model=ChatListResponse,
         )
 
     def delete(
@@ -267,7 +268,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> Chat:
+    ) -> ChatCreateResponse:
         """
         创建对话
 
@@ -307,7 +308,7 @@ async def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Chat,
+            cast_to=ChatCreateResponse,
         )
 
     async def retrieve(
@@ -354,7 +355,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
-    ) -> AsyncPaginator[Chat, AsyncPage[Chat]]:
+    ) -> AsyncPaginator[ChatListResponse, AsyncPage[ChatListResponse]]:
         """
         查询对话列表
 
@@ -373,7 +374,7 @@ def list(
         """
         return self._get_api_list(
             "/v1/chats",
-            page=AsyncPage[Chat],
+            page=AsyncPage[ChatListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -387,7 +388,7 @@ def list(
                     chat_list_params.ChatListParams,
                 ),
             ),
-            model=Chat,
+            model=ChatListResponse,
         )
 
     async def delete(

src/asktable/types/__init__.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-from .chat import Chat as Chat
 from .meta import Meta as Meta
 from .role import Role as Role
 from .entry import Entry as Entry
@@ -33,13 +32,15 @@
 from .sql_create_params import SqlCreateParams as SqlCreateParams
 from .answer_list_params import AnswerListParams as AnswerListParams
 from .chat_create_params import ChatCreateParams as ChatCreateParams
+from .chat_list_response import ChatListResponse as ChatListResponse
 from .policy_list_params import PolicyListParams as PolicyListParams
 from .role_create_params import RoleCreateParams as RoleCreateParams
 from .role_update_params import RoleUpdateParams as RoleUpdateParams
 from .ats_create_response import ATSCreateResponse as ATSCreateResponse
 from .ats_update_response import ATSUpdateResponse as ATSUpdateResponse
 from .score_create_params import ScoreCreateParams as ScoreCreateParams
 from .answer_create_params import AnswerCreateParams as AnswerCreateParams
+from .chat_create_response import ChatCreateResponse as ChatCreateResponse
 from .policy_create_params import PolicyCreateParams as PolicyCreateParams
 from .policy_update_params import PolicyUpdateParams as PolicyUpdateParams
 from .polish_create_params import PolishCreateParams as PolishCreateParams

src/asktable/types/chat_create_response.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Union, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["ChatCreateResponse"]
+
+
+class ChatCreateResponse(BaseModel):
+    id: str
+    """对话 ID"""
+
+    created_at: datetime
+    """创建时间"""
+
+    modified_at: datetime
+    """修改时间"""
+
+    project_id: str
+
+    status: Literal["active", "pending", "error", "fatal"]
+
+    status_message: Optional[str] = None
+
+    bot_id: Optional[str] = None
+    """
+    机器人 ID，如果需要使用高级功能，请使用 bot_id 来创建对话。在机器人中你可以定义
+    可以访问的数据、可以执行的任务以及是否开启调试模式等设置。
+    """
+
+    name: Optional[str] = None
+    """New name for the chat"""
+
+    role_id: Optional[str] = None
+    """
+    角色 ID，将扮演这个角色来执行对话，用于权限控制。若无，则跳过鉴权，即可查询所有
+    数据
+    """
+
+    role_variables: Optional[Dict[str, Union[str, int, bool]]] = None
+    """在扮演这个角色时需要传递的变量值，用 Key-Value 形式传递"""
+
+    user_profile: Optional[Dict[str, Union[str, int, bool]]] = None
+    """用户信息，用于在对话中传递用户的信息，用 Key-Value 形式传递"""

src/asktable/types/chat.py src/asktable/types/chat_list_response.pysrc/asktable/types/chat.py renamed to src/asktable/types/chat_list_response.py

@@ -6,10 +6,10 @@
 
 from .._models import BaseModel
 
-__all__ = ["Chat"]
+__all__ = ["ChatListResponse"]
 
 
-class Chat(BaseModel):
+class ChatListResponse(BaseModel):
     id: str
     """对话 ID"""
 

tests/api_resources/test_chats.py

@@ -9,7 +9,11 @@
 
 from asktable import Asktable, AsyncAsktable
 from tests.utils import assert_matches_type
-from asktable.types import Chat, ChatRetrieveResponse
+from asktable.types import (
+    ChatListResponse,
+    ChatCreateResponse,
+    ChatRetrieveResponse,
+)
 from asktable.pagination import SyncPage, AsyncPage
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -21,7 +25,7 @@ class TestChats:
     @parametrize
     def test_method_create(self, client: Asktable) -> None:
         chat = client.chats.create()
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_method_create_with_all_params(self, client: Asktable) -> None:
@@ -36,7 +40,7 @@ def test_method_create_with_all_params(self, client: Asktable) -> None:
                 "name": "张三",
             },
         )
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_raw_response_create(self, client: Asktable) -> None:
@@ -45,7 +49,7 @@ def test_raw_response_create(self, client: Asktable) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         chat = response.parse()
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_streaming_response_create(self, client: Asktable) -> None:
@@ -54,7 +58,7 @@ def test_streaming_response_create(self, client: Asktable) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             chat = response.parse()
-            assert_matches_type(Chat, chat, path=["response"])
+            assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -99,15 +103,15 @@ def test_path_params_retrieve(self, client: Asktable) -> None:
     @parametrize
     def test_method_list(self, client: Asktable) -> None:
         chat = client.chats.list()
-        assert_matches_type(SyncPage[Chat], chat, path=["response"])
+        assert_matches_type(SyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     def test_method_list_with_all_params(self, client: Asktable) -> None:
         chat = client.chats.list(
             page=1,
             size=1,
         )
-        assert_matches_type(SyncPage[Chat], chat, path=["response"])
+        assert_matches_type(SyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     def test_raw_response_list(self, client: Asktable) -> None:
@@ -116,7 +120,7 @@ def test_raw_response_list(self, client: Asktable) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         chat = response.parse()
-        assert_matches_type(SyncPage[Chat], chat, path=["response"])
+        assert_matches_type(SyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     def test_streaming_response_list(self, client: Asktable) -> None:
@@ -125,7 +129,7 @@ def test_streaming_response_list(self, client: Asktable) -> None:
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             chat = response.parse()
-            assert_matches_type(SyncPage[Chat], chat, path=["response"])
+            assert_matches_type(SyncPage[ChatListResponse], chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -176,7 +180,7 @@ class TestAsyncChats:
     @parametrize
     async def test_method_create(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.create()
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_method_create_with_all_params(self, async_client: AsyncAsktable) -> None:
@@ -191,7 +195,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncAsktable)
                 "name": "张三",
             },
         )
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_raw_response_create(self, async_client: AsyncAsktable) -> None:
@@ -200,7 +204,7 @@ async def test_raw_response_create(self, async_client: AsyncAsktable) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         chat = await response.parse()
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_streaming_response_create(self, async_client: AsyncAsktable) -> None:
@@ -209,7 +213,7 @@ async def test_streaming_response_create(self, async_client: AsyncAsktable) -> N
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             chat = await response.parse()
-            assert_matches_type(Chat, chat, path=["response"])
+            assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -254,15 +258,15 @@ async def test_path_params_retrieve(self, async_client: AsyncAsktable) -> None:
     @parametrize
     async def test_method_list(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.list()
-        assert_matches_type(AsyncPage[Chat], chat, path=["response"])
+        assert_matches_type(AsyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     async def test_method_list_with_all_params(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.list(
             page=1,
             size=1,
         )
-        assert_matches_type(AsyncPage[Chat], chat, path=["response"])
+        assert_matches_type(AsyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     async def test_raw_response_list(self, async_client: AsyncAsktable) -> None:
@@ -271,7 +275,7 @@ async def test_raw_response_list(self, async_client: AsyncAsktable) -> None:
         assert response.is_closed is True
         assert response.http_request.headers.get("X-Stainless-Lang") == "python"
         chat = await response.parse()
-        assert_matches_type(AsyncPage[Chat], chat, path=["response"])
+        assert_matches_type(AsyncPage[ChatListResponse], chat, path=["response"])
 
     @parametrize
     async def test_streaming_response_list(self, async_client: AsyncAsktable) -> None:
@@ -280,7 +284,7 @@ async def test_streaming_response_list(self, async_client: AsyncAsktable) -> Non
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             chat = await response.parse()
-            assert_matches_type(AsyncPage[Chat], chat, path=["response"])
+            assert_matches_type(AsyncPage[ChatListResponse], chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True