feat(api): manual updates (#29)

Author: stainless-app[bot]

api.md

@@ -93,13 +93,13 @@ Methods:
 Types:
 
 ```python
-from asktable.types import ChatOut, ChatListResponse
+from asktable.types import ChatCreateResponse, ChatRetrieveResponse, ChatListResponse
 ```
 
 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_out.py">ChatOut</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_out.py">ChatOut</a></code>
+- <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_create_response.py">ChatCreateResponse</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_list_response.py">ChatListResponse</a></code>
 - <code title="delete /chats/{chat_id}">client.chats.<a href="./src/asktable/resources/chats/chats.py">delete</a>(chat_id) -> None</code>
 

src/asktable/resources/chats/chats.py

@@ -29,8 +29,9 @@
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.chat_out import ChatOut
 from ...types.chat_list_response import ChatListResponse
+from ...types.chat_create_response import ChatCreateResponse
+from ...types.chat_retrieve_response import ChatRetrieveResponse
 
 __all__ = ["ChatsResource", "AsyncChatsResource"]
 
@@ -73,7 +74,7 @@ def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ChatOut:
+    ) -> ChatCreateResponse:
         """
         创建对话
 
@@ -113,7 +114,7 @@ def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=ChatOut,
+            cast_to=ChatCreateResponse,
         )
 
     def retrieve(
@@ -126,7 +127,7 @@ def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ChatOut:
+    ) -> ChatRetrieveResponse:
         """
         获取某个对话
 
@@ -146,7 +147,7 @@ def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=ChatOut,
+            cast_to=ChatRetrieveResponse,
         )
 
     def list(
@@ -268,7 +269,7 @@ async def create(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ChatOut:
+    ) -> ChatCreateResponse:
         """
         创建对话
 
@@ -308,7 +309,7 @@ async def create(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=ChatOut,
+            cast_to=ChatCreateResponse,
         )
 
     async def retrieve(
@@ -321,7 +322,7 @@ async def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> ChatOut:
+    ) -> ChatRetrieveResponse:
         """
         获取某个对话
 
@@ -341,7 +342,7 @@ async def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=ChatOut,
+            cast_to=ChatRetrieveResponse,
         )
 
     async def list(

src/asktable/types/__init__.py

@@ -5,7 +5,6 @@
 from .role import Role as Role
 from .shared import Policy as Policy, Message as Message, AnswerModel as AnswerModel
 from .chat_bot import ChatBot as ChatBot
-from .chat_out import ChatOut as ChatOut
 from .document import Document as Document
 from .data_source import DataSource as DataSource
 from .ext_api_model import ExtAPIModel as ExtAPIModel
@@ -28,13 +27,15 @@
 from .role_create_params import RoleCreateParams as RoleCreateParams
 from .role_list_response import RoleListResponse as RoleListResponse
 from .role_update_params import RoleUpdateParams as RoleUpdateParams
+from .chat_create_response import ChatCreateResponse as ChatCreateResponse
 from .extapi_create_params import ExtapiCreateParams as ExtapiCreateParams
 from .extapi_list_response import ExtapiListResponse as ExtapiListResponse
 from .extapi_update_params import ExtapiUpdateParams as ExtapiUpdateParams
 from .policy_create_params import PolicyCreateParams as PolicyCreateParams
 from .policy_list_response import PolicyListResponse as PolicyListResponse
 from .policy_update_params import PolicyUpdateParams as PolicyUpdateParams
 from .answer_data_source_out import AnswerDataSourceOut as AnswerDataSourceOut
+from .chat_retrieve_response import ChatRetrieveResponse as ChatRetrieveResponse
 from .datasource_list_params import DatasourceListParams as DatasourceListParams
 from .datasource_create_params import DatasourceCreateParams as DatasourceCreateParams
 from .datasource_list_response import DatasourceListResponse as DatasourceListResponse

src/asktable/types/chat_out.py …c/asktable/types/chat_create_response.pysrc/asktable/types/chat_out.py renamed to src/asktable/types/chat_create_response.py src/asktable/types/chat_out.py renamed to src/asktable/types/chat_create_response.py

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

src/asktable/types/chat_retrieve_response.py

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Union, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["ChatRetrieveResponse"]
+
+
+class ChatRetrieveResponse(BaseModel):
+    id: str
+    """对话 ID"""
+
+    created_at: datetime
+    """创建时间"""
+
+    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 ChatOut, ChatListResponse
+from asktable.types import (
+    ChatListResponse,
+    ChatCreateResponse,
+    ChatRetrieveResponse,
+)
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
@@ -20,7 +24,7 @@ class TestChats:
     @parametrize
     def test_method_create(self, client: Asktable) -> None:
         chat = client.chats.create()
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_method_create_with_all_params(self, client: Asktable) -> None:
@@ -35,7 +39,7 @@ def test_method_create_with_all_params(self, client: Asktable) -> None:
                 "name": "张三",
             },
         )
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_raw_response_create(self, client: Asktable) -> None:
@@ -44,7 +48,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(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     def test_streaming_response_create(self, client: Asktable) -> None:
@@ -53,7 +57,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(ChatOut, chat, path=["response"])
+            assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -62,7 +66,7 @@ def test_method_retrieve(self, client: Asktable) -> None:
         chat = client.chats.retrieve(
             "chat_id",
         )
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     def test_raw_response_retrieve(self, client: Asktable) -> None:
@@ -73,7 +77,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(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     def test_streaming_response_retrieve(self, client: Asktable) -> None:
@@ -84,7 +88,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(ChatOut, chat, path=["response"])
+            assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -173,7 +177,7 @@ class TestAsyncChats:
     @parametrize
     async def test_method_create(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.create()
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_method_create_with_all_params(self, async_client: AsyncAsktable) -> None:
@@ -188,7 +192,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncAsktable)
                 "name": "张三",
             },
         )
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_raw_response_create(self, async_client: AsyncAsktable) -> None:
@@ -197,7 +201,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(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
     @parametrize
     async def test_streaming_response_create(self, async_client: AsyncAsktable) -> None:
@@ -206,7 +210,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(ChatOut, chat, path=["response"])
+            assert_matches_type(ChatCreateResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True
 
@@ -215,7 +219,7 @@ async def test_method_retrieve(self, async_client: AsyncAsktable) -> None:
         chat = await async_client.chats.retrieve(
             "chat_id",
         )
-        assert_matches_type(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     async def test_raw_response_retrieve(self, async_client: AsyncAsktable) -> None:
@@ -226,7 +230,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(ChatOut, chat, path=["response"])
+        assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
     @parametrize
     async def test_streaming_response_retrieve(self, async_client: AsyncAsktable) -> None:
@@ -237,7 +241,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(ChatOut, chat, path=["response"])
+            assert_matches_type(ChatRetrieveResponse, chat, path=["response"])
 
         assert cast(Any, response.is_closed) is True