🌿 Fern Regeneration -- July 16, 2024 (#540)

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>

Author: fern-api[bot]

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cohere"
-version = "5.5.8"
+version = "5.6.0"
 description = ""
 readme = "README.md"
 authors = []

pyproject.toml

@@ -15,6 +15,8 @@
     ChatRequestCitationQuality,
     ChatRequestConnectorsSearchOptions,
     ChatRequestPromptTruncation,
+    ChatRequestResponseFormat,
+    ChatRequestResponseFormatType,
     ChatSearchQueriesGenerationEvent,
     ChatSearchQuery,
     ChatSearchResult,
@@ -26,6 +28,8 @@
     ChatStreamRequestCitationQuality,
     ChatStreamRequestConnectorsSearchOptions,
     ChatStreamRequestPromptTruncation,
+    ChatStreamRequestResponseFormat,
+    ChatStreamRequestResponseFormatType,
     ChatStreamStartEvent,
     ChatTextGenerationEvent,
     ChatToolCallsChunkEvent,
@@ -100,8 +104,8 @@
     NotImplementedErrorBody,
     OAuthAuthorizeResponse,
     ParseInfo,
+    RerankDocument,
     RerankRequestDocumentsItem,
-    RerankRequestDocumentsItemText,
     RerankResponse,
     RerankResponseResultsItem,
     RerankResponseResultsItemDocument,
@@ -181,6 +185,8 @@
     "ChatRequestCitationQuality",
     "ChatRequestConnectorsSearchOptions",
     "ChatRequestPromptTruncation",
+    "ChatRequestResponseFormat",
+    "ChatRequestResponseFormatType",
     "ChatSearchQueriesGenerationEvent",
     "ChatSearchQuery",
     "ChatSearchResult",
@@ -192,6 +198,8 @@
     "ChatStreamRequestCitationQuality",
     "ChatStreamRequestConnectorsSearchOptions",
     "ChatStreamRequestPromptTruncation",
+    "ChatStreamRequestResponseFormat",
+    "ChatStreamRequestResponseFormatType",
     "ChatStreamStartEvent",
     "ChatTextGenerationEvent",
     "ChatToolCallsChunkEvent",
@@ -280,8 +288,8 @@
     "NotImplementedErrorBody",
     "OAuthAuthorizeResponse",
     "ParseInfo",
+    "RerankDocument",
     "RerankRequestDocumentsItem",
-    "RerankRequestDocumentsItemText",
     "RerankResponse",
     "RerankResponseResultsItem",
     "RerankResponseResultsItemDocument",

src/cohere/__init__.py

@@ -25,7 +25,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.5.8",
+            "X-Fern-SDK-Version": "5.6.0",
         }
         if self._client_name is not None:
             headers["X-Client-Name"] = self._client_name

src/cohere/base_client.py

@@ -58,7 +58,7 @@ def get(self, model: str, *, request_options: typing.Optional[RequestOptions] =
             token="YOUR_TOKEN",
         )
         client.models.get(
-            model="model",
+            model="command-r",
         )
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -254,7 +254,7 @@ async def get(self, model: str, *, request_options: typing.Optional[RequestOptio
             token="YOUR_TOKEN",
         )
         await client.models.get(
-            model="model",
+            model="command-r",
         )
         """
         _response = await self._client_wrapper.httpx_client.request(

src/cohere/core/client_wrapper.py

@@ -14,6 +14,8 @@
 from .chat_request_citation_quality import ChatRequestCitationQuality
 from .chat_request_connectors_search_options import ChatRequestConnectorsSearchOptions
 from .chat_request_prompt_truncation import ChatRequestPromptTruncation
+from .chat_request_response_format import ChatRequestResponseFormat
+from .chat_request_response_format_type import ChatRequestResponseFormatType
 from .chat_search_queries_generation_event import ChatSearchQueriesGenerationEvent
 from .chat_search_query import ChatSearchQuery
 from .chat_search_result import ChatSearchResult
@@ -25,6 +27,8 @@
 from .chat_stream_request_citation_quality import ChatStreamRequestCitationQuality
 from .chat_stream_request_connectors_search_options import ChatStreamRequestConnectorsSearchOptions
 from .chat_stream_request_prompt_truncation import ChatStreamRequestPromptTruncation
+from .chat_stream_request_response_format import ChatStreamRequestResponseFormat
+from .chat_stream_request_response_format_type import ChatStreamRequestResponseFormatType
 from .chat_stream_start_event import ChatStreamStartEvent
 from .chat_text_generation_event import ChatTextGenerationEvent
 from .chat_tool_calls_chunk_event import ChatToolCallsChunkEvent
@@ -97,8 +101,8 @@
 from .not_implemented_error_body import NotImplementedErrorBody
 from .o_auth_authorize_response import OAuthAuthorizeResponse
 from .parse_info import ParseInfo
+from .rerank_document import RerankDocument
 from .rerank_request_documents_item import RerankRequestDocumentsItem
-from .rerank_request_documents_item_text import RerankRequestDocumentsItemText
 from .rerank_response import RerankResponse
 from .rerank_response_results_item import RerankResponseResultsItem
 from .rerank_response_results_item_document import RerankResponseResultsItemDocument
@@ -147,6 +151,8 @@
     "ChatRequestCitationQuality",
     "ChatRequestConnectorsSearchOptions",
     "ChatRequestPromptTruncation",
+    "ChatRequestResponseFormat",
+    "ChatRequestResponseFormatType",
     "ChatSearchQueriesGenerationEvent",
     "ChatSearchQuery",
     "ChatSearchResult",
@@ -158,6 +164,8 @@
     "ChatStreamRequestCitationQuality",
     "ChatStreamRequestConnectorsSearchOptions",
     "ChatStreamRequestPromptTruncation",
+    "ChatStreamRequestResponseFormat",
+    "ChatStreamRequestResponseFormatType",
     "ChatStreamStartEvent",
     "ChatTextGenerationEvent",
     "ChatToolCallsChunkEvent",
@@ -232,8 +240,8 @@
     "NotImplementedErrorBody",
     "OAuthAuthorizeResponse",
     "ParseInfo",
+    "RerankDocument",
     "RerankRequestDocumentsItem",
-    "RerankRequestDocumentsItemText",
     "RerankResponse",
     "RerankResponseResultsItem",
     "RerankResponseResultsItemDocument",

src/cohere/models/client.py

@@ -2,4 +2,4 @@
 
 import typing
 
-ChatRequestCitationQuality = typing.Union[typing.Literal["fast", "accurate"], typing.Any]
+ChatRequestCitationQuality = typing.Union[typing.Literal["fast", "accurate", "off"], typing.Any]

src/cohere/types/__init__.py

@@ -19,7 +19,7 @@ class ChatRequestConnectorsSearchOptions(UncheckedBaseModel):
     deterministically, such that repeated requests with the same
     seed and parameters should return the same result. However,
     determinism cannot be totally guaranteed.
-    Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker, Private Deployments
+    Compatible Deployments: Cohere Platform, Azure, AWS Sagemaker/Bedrock, Private Deployments
     """
 
     def json(self, **kwargs: typing.Any) -> str:

src/cohere/types/chat_request_citation_quality.py

@@ -0,0 +1,63 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+from ..core.datetime_utils import serialize_datetime
+from ..core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .chat_request_response_format_type import ChatRequestResponseFormatType
+
+
+class ChatRequestResponseFormat(UncheckedBaseModel):
+    """
+    Configuration for forcing the model output to adhere to the specified format. Supported on [Command R](https://docs.cohere.com/docs/command-r), [Command R+](https://docs.cohere.com/docs/command-r-plus) and newer models.
+
+    The model can be forced into outputting JSON objects (with up to 5 levels of nesting) by setting `{ "type": "json_object" }`.
+
+    A [JSON Schema](https://json-schema.org/) can optionally be provided, to ensure a specific structure.
+
+    **Note**: When using `{ "type": "json_object" }` your `message` should always explicitly instruct the model to generate a JSON (eg: _"Generate a JSON ..."_) . Otherwise the model may end up getting stuck generating an infinite stream of characters and eventually run out of context length.
+    """
+
+    type: ChatRequestResponseFormatType = pydantic_v1.Field()
+    """
+    When set to JSON, the model will return valid JSON. Note that running out of tokens will result in an invalid JSON.
+    """
+
+    schema_: typing.Optional[typing.Dict[str, typing.Any]] = pydantic_v1.Field(alias="schema", default=None)
+    """
+    [BETA] A JSON schema object that the output will adhere to. There are some restrictions we have on the schema, refer to [our guide]() for more information.
+    Example (required name and age object):
+    
+    ```json
+    {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string" },
+        "age": { "type": "integer" }
+      },
+      "required": ["name", "age"]
+    }
+    ```
+    """
+
+    def json(self, **kwargs: typing.Any) -> str:
+        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        return super().json(**kwargs_with_defaults)
+
+    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
+        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
+
+        return deep_union_pydantic_dicts(
+            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}