-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathchat.py
707 lines (570 loc) · 32.9 KB
/
chat.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import List, Union, Iterable
from typing_extensions import Literal, overload
import httpx
from ..types import chat_chat_params
from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
from .._utils import (
required_args,
maybe_transform,
async_maybe_transform,
)
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from .._streaming import Stream, AsyncStream
from .._base_client import make_request_options
from ..types.chat_completion import ChatCompletion
from ..types.chat_completion_chunk import ChatCompletionChunk
from ..types.shared_params.tool_param import ToolParam
__all__ = ["ChatResource", "AsyncChatResource"]
class ChatResource(SyncAPIResource):
@cached_property
def with_raw_response(self) -> ChatResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/writer/writer-python#accessing-raw-response-data-eg-headers
"""
return ChatResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> ChatResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/writer/writer-python#with_streaming_response
"""
return ChatResourceWithStreamingResponse(self)
@overload
def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream: Literal[False] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
stream: Literal[True],
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> Stream[ChatCompletionChunk]:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
stream: bool,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion | Stream[ChatCompletionChunk]:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@required_args(["messages", "model"], ["messages", "model", "stream"])
def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream: Literal[False] | Literal[True] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion | Stream[ChatCompletionChunk]:
return self._post(
"/v1/chat",
body=maybe_transform(
{
"messages": messages,
"model": model,
"logprobs": logprobs,
"max_tokens": max_tokens,
"n": n,
"stop": stop,
"stream": stream,
"stream_options": stream_options,
"temperature": temperature,
"tool_choice": tool_choice,
"tools": tools,
"top_p": top_p,
},
chat_chat_params.ChatChatParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ChatCompletion,
stream=stream or False,
stream_cls=Stream[ChatCompletionChunk],
)
class AsyncChatResource(AsyncAPIResource):
@cached_property
def with_raw_response(self) -> AsyncChatResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/writer/writer-python#accessing-raw-response-data-eg-headers
"""
return AsyncChatResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> AsyncChatResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/writer/writer-python#with_streaming_response
"""
return AsyncChatResourceWithStreamingResponse(self)
@overload
async def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream: Literal[False] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
async def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
stream: Literal[True],
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> AsyncStream[ChatCompletionChunk]:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
async def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
stream: bool,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion | AsyncStream[ChatCompletionChunk]:
"""Generate a chat completion based on the provided messages.
The response shown
below is for non-streaming. To learn about streaming responses, see the
[chat completion guide](/api-guides/chat-completion).
Args:
messages: An array of message objects that form the conversation history or context for
the model to respond to. The array must contain at least one message.
model: Specifies the model to be used for generating responses. The chat model is
always `palmyra-x-004` for conversational use.
stream: Indicates whether the response should be streamed incrementally as it is
generated or only returned once fully complete. Streaming can be useful for
providing real-time feedback in interactive applications.
logprobs: Specifies whether to return log probabilities of the output tokens.
max_tokens: Defines the maximum number of tokens (words and characters) that the model can
generate in the response. The default value is set to 16, but it can be adjusted
to allow for longer or shorter responses as needed.
n: Specifies the number of completions (responses) to generate from the model in a
single request. This parameter allows multiple responses to be generated,
offering a variety of potential replies from which to choose.
stop: A token or sequence of tokens that, when generated, will cause the model to stop
producing further content. This can be a single token or an array of tokens,
acting as a signal to end the output.
stream_options: Additional options for streaming.
temperature: Controls the randomness or creativity of the model's responses. A higher
temperature results in more varied and less predictable text, while a lower
temperature produces more deterministic and conservative outputs.
tool_choice: Configure how the model will call functions: `auto` will allow the model to
automatically choose the best tool, `none` disables tool calling. You can also
pass a specific previously defined function.
tools: An array of tools described to the model using JSON schema that the model can
use to generate responses. You can define your own functions or use the built-in
`graph` or `llm` tools.
top_p: Sets the threshold for "nucleus sampling," a technique to focus the model's
token generation on the most likely subset of tokens. Only tokens with
cumulative probability above this threshold are considered, controlling the
trade-off between creativity and coherence.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@required_args(["messages", "model"], ["messages", "model", "stream"])
async def chat(
self,
*,
messages: Iterable[chat_chat_params.Message],
model: str,
logprobs: bool | NotGiven = NOT_GIVEN,
max_tokens: int | NotGiven = NOT_GIVEN,
n: int | NotGiven = NOT_GIVEN,
stop: Union[List[str], str] | NotGiven = NOT_GIVEN,
stream: Literal[False] | Literal[True] | NotGiven = NOT_GIVEN,
stream_options: chat_chat_params.StreamOptions | NotGiven = NOT_GIVEN,
temperature: float | NotGiven = NOT_GIVEN,
tool_choice: chat_chat_params.ToolChoice | NotGiven = NOT_GIVEN,
tools: Iterable[ToolParam] | NotGiven = NOT_GIVEN,
top_p: float | NotGiven = NOT_GIVEN,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
) -> ChatCompletion | AsyncStream[ChatCompletionChunk]:
return await self._post(
"/v1/chat",
body=await async_maybe_transform(
{
"messages": messages,
"model": model,
"logprobs": logprobs,
"max_tokens": max_tokens,
"n": n,
"stop": stop,
"stream": stream,
"stream_options": stream_options,
"temperature": temperature,
"tool_choice": tool_choice,
"tools": tools,
"top_p": top_p,
},
chat_chat_params.ChatChatParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=ChatCompletion,
stream=stream or False,
stream_cls=AsyncStream[ChatCompletionChunk],
)
class ChatResourceWithRawResponse:
def __init__(self, chat: ChatResource) -> None:
self._chat = chat
self.chat = to_raw_response_wrapper(
chat.chat,
)
class AsyncChatResourceWithRawResponse:
def __init__(self, chat: AsyncChatResource) -> None:
self._chat = chat
self.chat = async_to_raw_response_wrapper(
chat.chat,
)
class ChatResourceWithStreamingResponse:
def __init__(self, chat: ChatResource) -> None:
self._chat = chat
self.chat = to_streamed_response_wrapper(
chat.chat,
)
class AsyncChatResourceWithStreamingResponse:
def __init__(self, chat: AsyncChatResource) -> None:
self._chat = chat
self.chat = async_to_streamed_response_wrapper(
chat.chat,
)