🌿 Fern Regeneration -- October 30, 2024 (#597)

* SDK regeneration * Fixes --------- Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Billy Trend <[email protected]>
cohere-ai · Nov 1, 2024 · 2a7f5c0 · 2a7f5c0
1 parent f31b9a5
commit 2a7f5c0
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 27 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cohere"
-version = "5.11.2"
+version = "5.11.3"
 description = ""
 readme = "README.md"
 authors = []

diff --git a/reference.md b/reference.md
@@ -2319,7 +2319,7 @@ client.check_api_key()
 <dl>
 <dd>
 
-Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
 Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
 </dd>
@@ -2599,7 +2599,7 @@ Defaults to `0.75`. min value of `0.01`, max value of `0.99`.
 <dl>
 <dd>
 
-Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
 Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
 </dd>

diff --git a/src/cohere/__init__.py b/src/cohere/__init__.py
@@ -25,6 +25,7 @@
     ChatContentStartEventDeltaMessage,
     ChatContentStartEventDeltaMessageContent,
     ChatDataMetrics,
+    ChatDebugEvent,
     ChatDocument,
     ChatFinishReason,
     ChatMessage,
@@ -104,6 +105,7 @@
     DatasetPart,
     DatasetType,
     DatasetValidationStatus,
+    DebugStreamedChatResponse,
     DeleteConnectorResponse,
     DetokenizeResponse,
     Document,
@@ -297,6 +299,7 @@
     "ChatContentStartEventDeltaMessage",
     "ChatContentStartEventDeltaMessageContent",
     "ChatDataMetrics",
+    "ChatDebugEvent",
     "ChatDocument",
     "ChatFinishReason",
     "ChatMessage",
@@ -386,6 +389,7 @@
     "DatasetsGetResponse",
     "DatasetsGetUsageResponse",
     "DatasetsListResponse",
+    "DebugStreamedChatResponse",
     "DeleteConnectorResponse",
     "DetokenizeResponse",
     "Document",

diff --git a/src/cohere/core/client_wrapper.py b/src/cohere/core/client_wrapper.py
@@ -24,7 +24,7 @@ def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "cohere",
-            "X-Fern-SDK-Version": "5.11.2",
+            "X-Fern-SDK-Version": "5.11.3",
         }
         if self._client_name is not None:
             headers["X-Client-Name"] = self._client_name

diff --git a/src/cohere/types/__init__.py b/src/cohere/types/__init__.py
@@ -26,6 +26,7 @@
 from .chat_content_start_event_delta_message import ChatContentStartEventDeltaMessage
 from .chat_content_start_event_delta_message_content import ChatContentStartEventDeltaMessageContent
 from .chat_data_metrics import ChatDataMetrics
+from .chat_debug_event import ChatDebugEvent
 from .chat_document import ChatDocument
 from .chat_finish_reason import ChatFinishReason
 from .chat_message import ChatMessage
@@ -170,6 +171,7 @@
 from .source import DocumentSource, Source, ToolSource
 from .streamed_chat_response import (
     CitationGenerationStreamedChatResponse,
+    DebugStreamedChatResponse,
     SearchQueriesGenerationStreamedChatResponse,
     SearchResultsStreamedChatResponse,
     StreamEndStreamedChatResponse,
@@ -245,6 +247,7 @@
     "ChatContentStartEventDeltaMessage",
     "ChatContentStartEventDeltaMessageContent",
     "ChatDataMetrics",
+    "ChatDebugEvent",
     "ChatDocument",
     "ChatFinishReason",
     "ChatMessage",
@@ -324,6 +327,7 @@
     "DatasetPart",
     "DatasetType",
     "DatasetValidationStatus",
+    "DebugStreamedChatResponse",
     "DeleteConnectorResponse",
     "DetokenizeResponse",
     "Document",

diff --git a/src/cohere/types/chat_debug_event.py b/src/cohere/types/chat_debug_event.py
@@ -0,0 +1,18 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .chat_stream_event import ChatStreamEvent
+import typing
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+import pydantic
+
+
+class ChatDebugEvent(ChatStreamEvent):
+    prompt: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow")  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            smart_union = True
+            extra = pydantic.Extra.allow
diff --git a/src/cohere/types/streamed_chat_response.py b/src/cohere/types/streamed_chat_response.py
@@ -157,6 +157,23 @@ class Config:
             extra = pydantic.Extra.allow
 
 
+class DebugStreamedChatResponse(UncheckedBaseModel):
+    """
+    StreamedChatResponse is returned in streaming mode (specified with `stream=True` in the request).
+    """
+
+    event_type: typing.Literal["debug"] = "debug"
+    prompt: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow")  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            smart_union = True
+            extra = pydantic.Extra.allow
+
+
 StreamedChatResponse = typing_extensions.Annotated[
     typing.Union[
         StreamStartStreamedChatResponse,
@@ -167,6 +184,7 @@ class Config:
         ToolCallsGenerationStreamedChatResponse,
         StreamEndStreamedChatResponse,
         ToolCallsChunkStreamedChatResponse,
+        DebugStreamedChatResponse,
     ],
     UnionMetadata(discriminant="event_type"),
 ]
diff --git a/src/cohere/v2/client.py b/src/cohere/v2/client.py
@@ -73,7 +73,7 @@ def chat_stream(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.Iterator[StreamedChatResponseV2]:
         """
-        Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+        Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
         Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
 
@@ -401,7 +401,7 @@ def chat(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ChatResponse:
         """
-        Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+        Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
         Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
 
@@ -1124,7 +1124,7 @@ async def chat_stream(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.AsyncIterator[StreamedChatResponseV2]:
         """
-        Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+        Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
         Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.
 
@@ -1460,7 +1460,7 @@ async def chat(
         request_options: typing.Optional[RequestOptions] = None,
     ) -> ChatResponse:
         """
-        Generates a message from the model in response to a provided conversation. To learn more about the features of the Chat API follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
+        Generates a text response to a user message and streams it down, token by token. To learn how to use the Chat API with streaming follow our [Text Generation guides](https://docs.cohere.com/v2/docs/chat-api).
 
         Follow the [Migration Guide](https://docs.cohere.com/v2/docs/migrating-v1-to-v2) for instructions on moving from API v1 to API v2.