feat(api): api update (#86)

Author: stainless-app[bot]

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 90
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-586c22698d9426ab1fe711547b39043914c00ab6a65ef836cb6f4610fb723e86.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/datamini%2Fasktable-bb6c8be98a7d3c5109b7def15a21653d7bade60a2b6939157361c3fe9ef049d9.yml

api.md

@@ -103,13 +103,20 @@ Methods:
 Types:
 
 ```python
-from asktable.types import AIMessage, Chat, ToolMessage, UserMessage, ChatSendMessageResponse
+from asktable.types import (
+    AIMessage,
+    Chat,
+    ToolMessage,
+    UserMessage,
+    ChatRetrieveResponse,
+    ChatSendMessageResponse,
+)
 ```
 
 Methods:
 
 - <code title="post /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="get /chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">retrieve</a>(chat_id) -> <a href="./src/asktable/types/chat.py">Chat</a></code>
+- <code title="get /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 /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="delete /chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">delete</a>(chat_id) -> None</code>
 - <code title="post /chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">send_message</a>(chat_id, \*\*<a href="src/asktable/types/chat_send_message_params.py">params</a>) -> <a href="./src/asktable/types/chat_send_message_response.py">ChatSendMessageResponse</a></code>

src/asktable/resources/chats/chats.py

@@ -31,6 +31,7 @@
 from ...pagination import SyncPage, AsyncPage
 from ...types.chat import Chat
 from ..._base_client import AsyncPaginator, make_request_options
+from ...types.chat_retrieve_response import ChatRetrieveResponse
 from ...types.chat_send_message_response import ChatSendMessageResponse
 
 __all__ = ["ChatsResource", "AsyncChatsResource"]
@@ -127,7 +128,7 @@ def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Chat:
+    ) -> ChatRetrieveResponse:
         """
         获取某个对话
 
@@ -147,7 +148,7 @@ def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Chat,
+            cast_to=ChatRetrieveResponse,
         )
 
     def list(
@@ -366,7 +367,7 @@ async def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Chat:
+    ) -> ChatRetrieveResponse:
         """
         获取某个对话
 
@@ -386,7 +387,7 @@ async def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Chat,
+            cast_to=ChatRetrieveResponse,
         )
 
     def list(

src/asktable/types/__init__.py

@@ -35,6 +35,7 @@
 from .training_list_params import TrainingListParams as TrainingListParams
 from .entry_with_definition import EntryWithDefinition as EntryWithDefinition
 from .score_create_response import ScoreCreateResponse as ScoreCreateResponse
+from .chat_retrieve_response import ChatRetrieveResponse as ChatRetrieveResponse
 from .datasource_list_params import DatasourceListParams as DatasourceListParams
 from .training_create_params import TrainingCreateParams as TrainingCreateParams
 from .training_delete_params import TrainingDeleteParams as TrainingDeleteParams

src/asktable/types/chat_retrieve_response.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Union, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["ChatRetrieveResponse"]
+
+
+class ChatRetrieveResponse(BaseModel):
+    id: str
+    """对话 ID"""
+
+    created_at: datetime
+    """创建时间"""
+
+    datasource_ids: List[str]
+
+    modified_at: datetime
+    """修改时间"""
+
+    project_id: str
+
+    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, str]] = None
+    """用户信息，用于在对话中传递用户的信息，用 Key-Value 形式传递"""

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, ChatSendMessageResponse
+from asktable.types import (
+    Chat,
+    ChatRetrieveResponse,
+    ChatSendMessageResponse,
+)
 from asktable.pagination import SyncPage, AsyncPage
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
@@ -63,7 +67,7 @@ def test_method_retrieve(self, client: Asktable) -> None:
         chat = client.chats.retrieve(
             "chat_id",
         )
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     def test_raw_response_retrieve(self, client: Asktable) -> None:
@@ -74,7 +78,7 @@ def test_raw_response_retrieve(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(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     def test_streaming_response_retrieve(self, client: Asktable) -> None:
@@ -85,7 +89,7 @@ def test_streaming_response_retrieve(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(ChatRetrieveResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -258,7 +262,7 @@ async def test_method_retrieve(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.retrieve(
             "chat_id",
         )
-        assert_matches_type(Chat, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     async def test_raw_response_retrieve(self, async_client: AsyncAsktable) -> None:
@@ -269,7 +273,7 @@ async def test_raw_response_retrieve(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(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     async def test_streaming_response_retrieve(self, async_client: AsyncAsktable) -> None:
@@ -280,7 +284,7 @@ async def test_streaming_response_retrieve(self, async_client: AsyncAsktable) ->
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
 
             chat = await response.parse()
-            assert_matches_type(Chat, chat, path=["response"])
+            assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True