cohere-python

1
# This file was auto-generated by Fern from our API Definition.
2

3
import typing
4

5
try:
6
    from typing import NotRequired  # type: ignore
7
except ImportError:
8
    from typing_extensions import NotRequired  # type: ignore
9

10

11
class RequestOptions(typing.TypedDict):
12
    """
13
    Additional options for request-specific configuration when calling APIs via the SDK.
14
    This is used primarily as an optional final parameter for service functions.
15

16
    Attributes:
17
        - timeout_in_seconds: int. The number of seconds to await an API call before timing out.
18

19
        - max_retries: int. The max number of retries to attempt if the API call fails.
20

21
        - additional_headers: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's header dict
22

23
        - additional_query_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's query parameters dict
24

25
        - additional_body_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's body parameters dict
26
    """
27

28
    timeout_in_seconds: NotRequired[int]
29
    max_retries: NotRequired[int]
30
    additional_headers: NotRequired[typing.Dict[str, typing.Any]]
31
    additional_query_parameters: NotRequired[typing.Dict[str, typing.Any]]
32
    additional_body_parameters: NotRequired[typing.Dict[str, typing.Any]]
33