r"""Create a chat completion Sends a request for a model response for the given chat conversation. Supports both streaming and non-streaming modes. :param messages: List of messages for the conversation :param http_referer: The app identifier should be your app's URL and is
(
self,
*,
messages: Union[
Iterable[components.ChatMessages],
Iterable[components.ChatMessagesTypedDict],
],
http_referer: Optional[str] = None,
x_open_router_title: Optional[str] = None,
x_open_router_categories: Optional[str] = None,
x_open_router_metadata: Optional[components.MetadataLevel] = None,
cache_control: Optional[
Union[
components.AnthropicCacheControlDirective,
components.AnthropicCacheControlDirectiveTypedDict,
]
] = None,
debug: Optional[
Union[components.ChatDebugOptions, components.ChatDebugOptionsTypedDict]
] = None,
frequency_penalty: OptionalNullable[float] = UNSET,
image_config: Optional[
Union[
Mapping[str, components.ImageConfig],
Mapping[str, components.ImageConfigTypedDict],
]
] = None,
logit_bias: OptionalNullable[Mapping[str, float]] = UNSET,
logprobs: OptionalNullable[bool] = UNSET,
max_completion_tokens: OptionalNullable[int] = UNSET,
max_tokens: OptionalNullable[int] = UNSET,
metadata: Optional[Mapping[str, str]] = None,
min_p: OptionalNullable[float] = UNSET,
modalities: Optional[Iterable[components.Modality]] = None,
model: Optional[str] = None,
models: Optional[Iterable[str]] = None,
parallel_tool_calls: OptionalNullable[bool] = UNSET,
plugins: Optional[
Union[
Iterable[components.ChatRequestPlugin],
Iterable[components.ChatRequestPluginTypedDict],
]
] = None,
presence_penalty: OptionalNullable[float] = UNSET,
provider: OptionalNullable[
Union[
components.ProviderPreferences, components.ProviderPreferencesTypedDict
]
] = UNSET,
reasoning: Optional[
Union[
components.ChatRequestReasoning,
components.ChatRequestReasoningTypedDict,
]
] = None,
reasoning_effort: OptionalNullable[
components.ChatRequestReasoningEffort
] = UNSET,
repetition_penalty: OptionalNullable[float] = UNSET,
response_format: Optional[
Union[components.ResponseFormat, components.ResponseFormatTypedDict]
] = None,
seed: OptionalNullable[int] = UNSET,
service_tier: OptionalNullable[components.ChatRequestServiceTier] = UNSET,
session_id: Optional[str] = None,
stop: OptionalNullable[
Union[components.Stop, components.StopTypedDict]
] = UNSET,
stop_server_tools_when: Optional[
Union[
Iterable[components.StopServerToolsWhenCondition],
Iterable[components.StopServerToolsWhenConditionTypedDict],
]
] = None,
stream: Union[Literal[False], None] = None,
stream_options: OptionalNullable[
Union[components.ChatStreamOptions, components.ChatStreamOptionsTypedDict]
] = UNSET,
temperature: OptionalNullable[float] = UNSET,
tool_choice: Optional[
Union[components.ChatToolChoice, components.ChatToolChoiceTypedDict]
] = None,
tools: Optional[
Union[
Iterable[components.ChatFunctionTool],
Iterable[components.ChatFunctionToolTypedDict],
]
] = None,
top_a: OptionalNullable[float] = UNSET,
top_k: OptionalNullable[int] = UNSET,
top_logprobs: OptionalNullable[int] = UNSET,
top_p: OptionalNullable[float] = UNSET,
trace: Optional[
Union[components.TraceConfig, components.TraceConfigTypedDict]
] = None,
user: Optional[str] = None,
retries: OptionalNullable[utils.RetryConfig] = UNSET,
server_url: Optional[str] = None,
timeout_ms: Optional[int] = None,
http_headers: Optional[Mapping[str, str]] = None,
)
| 22 | class Chat(BaseSDK): |
| 23 | @overload |
| 24 | def send( |
| 25 | self, |
| 26 | *, |
| 27 | messages: Union[ |
| 28 | Iterable[components.ChatMessages], |
| 29 | Iterable[components.ChatMessagesTypedDict], |
| 30 | ], |
| 31 | http_referer: Optional[str] = None, |
| 32 | x_open_router_title: Optional[str] = None, |
| 33 | x_open_router_categories: Optional[str] = None, |
| 34 | x_open_router_metadata: Optional[components.MetadataLevel] = None, |
| 35 | cache_control: Optional[ |
| 36 | Union[ |
| 37 | components.AnthropicCacheControlDirective, |
| 38 | components.AnthropicCacheControlDirectiveTypedDict, |
| 39 | ] |
| 40 | ] = None, |
| 41 | debug: Optional[ |
| 42 | Union[components.ChatDebugOptions, components.ChatDebugOptionsTypedDict] |
| 43 | ] = None, |
| 44 | frequency_penalty: OptionalNullable[float] = UNSET, |
| 45 | image_config: Optional[ |
| 46 | Union[ |
| 47 | Mapping[str, components.ImageConfig], |
| 48 | Mapping[str, components.ImageConfigTypedDict], |
| 49 | ] |
| 50 | ] = None, |
| 51 | logit_bias: OptionalNullable[Mapping[str, float]] = UNSET, |
| 52 | logprobs: OptionalNullable[bool] = UNSET, |
| 53 | max_completion_tokens: OptionalNullable[int] = UNSET, |
| 54 | max_tokens: OptionalNullable[int] = UNSET, |
| 55 | metadata: Optional[Mapping[str, str]] = None, |
| 56 | min_p: OptionalNullable[float] = UNSET, |
| 57 | modalities: Optional[Iterable[components.Modality]] = None, |
| 58 | model: Optional[str] = None, |
| 59 | models: Optional[Iterable[str]] = None, |
| 60 | parallel_tool_calls: OptionalNullable[bool] = UNSET, |
| 61 | plugins: Optional[ |
| 62 | Union[ |
| 63 | Iterable[components.ChatRequestPlugin], |
| 64 | Iterable[components.ChatRequestPluginTypedDict], |
| 65 | ] |
| 66 | ] = None, |
| 67 | presence_penalty: OptionalNullable[float] = UNSET, |
| 68 | provider: OptionalNullable[ |
| 69 | Union[ |
| 70 | components.ProviderPreferences, components.ProviderPreferencesTypedDict |
| 71 | ] |
| 72 | ] = UNSET, |
| 73 | reasoning: Optional[ |
| 74 | Union[ |
| 75 | components.ChatRequestReasoning, |
| 76 | components.ChatRequestReasoningTypedDict, |
| 77 | ] |
| 78 | ] = None, |
| 79 | reasoning_effort: OptionalNullable[ |
| 80 | components.ChatRequestReasoningEffort |
| 81 | ] = UNSET, |
no test coverage detected