c63a5cfe-b235-4fbe-8bbb-82a9e02a482a-python 0.1.0a7__py3-none-any.whl → 0.1.0a9__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a7.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a9.dist-info}/METADATA +1 -1
- {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a7.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a9.dist-info}/RECORD +15 -13
- gradientai/_client.py +4 -0
- gradientai/_streaming.py +40 -3
- gradientai/_version.py +1 -1
- gradientai/resources/agents/chat/completions.py +530 -5
- gradientai/resources/chat/completions.py +532 -5
- gradientai/types/agents/chat/__init__.py +1 -0
- gradientai/types/agents/chat/agent_chat_completion_chunk.py +93 -0
- gradientai/types/agents/chat/completion_create_params.py +23 -8
- gradientai/types/chat/__init__.py +1 -0
- gradientai/types/chat/chat_completion_chunk.py +93 -0
- gradientai/types/chat/completion_create_params.py +23 -8
- {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a7.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a9.dist-info}/WHEEL +0 -0
- {c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a7.dist-info → c63a5cfe_b235_4fbe_8bbb_82a9e02a482a_python-0.1.0a9.dist-info}/licenses/LICENSE +0 -0
@@ -3,11 +3,12 @@
|
|
3
3
|
from __future__ import annotations
|
4
4
|
|
5
5
|
from typing import Dict, List, Union, Iterable, Optional
|
6
|
+
from typing_extensions import Literal, overload
|
6
7
|
|
7
8
|
import httpx
|
8
9
|
|
9
10
|
from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
|
10
|
-
from ...._utils import maybe_transform, async_maybe_transform
|
11
|
+
from ...._utils import required_args, maybe_transform, async_maybe_transform
|
11
12
|
from ...._compat import cached_property
|
12
13
|
from ...._resource import SyncAPIResource, AsyncAPIResource
|
13
14
|
from ...._response import (
|
@@ -16,9 +17,11 @@ from ...._response import (
|
|
16
17
|
async_to_raw_response_wrapper,
|
17
18
|
async_to_streamed_response_wrapper,
|
18
19
|
)
|
20
|
+
from ...._streaming import Stream, AsyncStream
|
19
21
|
from ...._base_client import make_request_options
|
20
22
|
from ....types.agents.chat import completion_create_params
|
21
23
|
from ....types.agents.chat.completion_create_response import CompletionCreateResponse
|
24
|
+
from ....types.agents.chat.agent_chat_completion_chunk import AgentChatCompletionChunk
|
22
25
|
|
23
26
|
__all__ = ["CompletionsResource", "AsyncCompletionsResource"]
|
24
27
|
|
@@ -43,6 +46,7 @@ class CompletionsResource(SyncAPIResource):
|
|
43
46
|
"""
|
44
47
|
return CompletionsResourceWithStreamingResponse(self)
|
45
48
|
|
49
|
+
@overload
|
46
50
|
def create(
|
47
51
|
self,
|
48
52
|
*,
|
@@ -57,7 +61,7 @@ class CompletionsResource(SyncAPIResource):
|
|
57
61
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
58
62
|
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
59
63
|
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
60
|
-
stream: Optional[
|
64
|
+
stream: Optional[Literal[False]] | NotGiven = NOT_GIVEN,
|
61
65
|
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
62
66
|
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
63
67
|
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
@@ -153,6 +157,262 @@ class CompletionsResource(SyncAPIResource):
|
|
153
157
|
|
154
158
|
timeout: Override the client-level default timeout for this request, in seconds
|
155
159
|
"""
|
160
|
+
...
|
161
|
+
|
162
|
+
@overload
|
163
|
+
def create(
|
164
|
+
self,
|
165
|
+
*,
|
166
|
+
messages: Iterable[completion_create_params.Message],
|
167
|
+
model: str,
|
168
|
+
stream: Literal[True],
|
169
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
170
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
171
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
172
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
173
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
174
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
175
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
176
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
177
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
178
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
179
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
180
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
181
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
182
|
+
user: str | NotGiven = NOT_GIVEN,
|
183
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
184
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
185
|
+
extra_headers: Headers | None = None,
|
186
|
+
extra_query: Query | None = None,
|
187
|
+
extra_body: Body | None = None,
|
188
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
189
|
+
) -> Stream[AgentChatCompletionChunk]:
|
190
|
+
"""
|
191
|
+
Creates a model response for the given chat conversation.
|
192
|
+
|
193
|
+
Args:
|
194
|
+
messages: A list of messages comprising the conversation so far.
|
195
|
+
|
196
|
+
model: Model ID used to generate the response.
|
197
|
+
|
198
|
+
stream: If set to true, the model response data will be streamed to the client as it is
|
199
|
+
generated using server-sent events.
|
200
|
+
|
201
|
+
frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
202
|
+
existing frequency in the text so far, decreasing the model's likelihood to
|
203
|
+
repeat the same line verbatim.
|
204
|
+
|
205
|
+
logit_bias: Modify the likelihood of specified tokens appearing in the completion.
|
206
|
+
|
207
|
+
Accepts a JSON object that maps tokens (specified by their token ID in the
|
208
|
+
tokenizer) to an associated bias value from -100 to 100. Mathematically, the
|
209
|
+
bias is added to the logits generated by the model prior to sampling. The exact
|
210
|
+
effect will vary per model, but values between -1 and 1 should decrease or
|
211
|
+
increase likelihood of selection; values like -100 or 100 should result in a ban
|
212
|
+
or exclusive selection of the relevant token.
|
213
|
+
|
214
|
+
logprobs: Whether to return log probabilities of the output tokens or not. If true,
|
215
|
+
returns the log probabilities of each output token returned in the `content` of
|
216
|
+
`message`.
|
217
|
+
|
218
|
+
max_completion_tokens: The maximum number of completion tokens that may be used over the course of the
|
219
|
+
run. The run will make a best effort to use only the number of completion tokens
|
220
|
+
specified, across multiple turns of the run.
|
221
|
+
|
222
|
+
max_tokens: The maximum number of tokens that can be generated in the completion.
|
223
|
+
|
224
|
+
The token count of your prompt plus `max_tokens` cannot exceed the model's
|
225
|
+
context length.
|
226
|
+
|
227
|
+
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
|
228
|
+
for storing additional information about the object in a structured format, and
|
229
|
+
querying for objects via API or the dashboard.
|
230
|
+
|
231
|
+
Keys are strings with a maximum length of 64 characters. Values are strings with
|
232
|
+
a maximum length of 512 characters.
|
233
|
+
|
234
|
+
n: How many chat completion choices to generate for each input message. Note that
|
235
|
+
you will be charged based on the number of generated tokens across all of the
|
236
|
+
choices. Keep `n` as `1` to minimize costs.
|
237
|
+
|
238
|
+
presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
239
|
+
whether they appear in the text so far, increasing the model's likelihood to
|
240
|
+
talk about new topics.
|
241
|
+
|
242
|
+
stop: Up to 4 sequences where the API will stop generating further tokens. The
|
243
|
+
returned text will not contain the stop sequence.
|
244
|
+
|
245
|
+
stream_options: Options for streaming response. Only set this when you set `stream: true`.
|
246
|
+
|
247
|
+
temperature: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
248
|
+
make the output more random, while lower values like 0.2 will make it more
|
249
|
+
focused and deterministic. We generally recommend altering this or `top_p` but
|
250
|
+
not both.
|
251
|
+
|
252
|
+
top_logprobs: An integer between 0 and 20 specifying the number of most likely tokens to
|
253
|
+
return at each token position, each with an associated log probability.
|
254
|
+
`logprobs` must be set to `true` if this parameter is used.
|
255
|
+
|
256
|
+
top_p: An alternative to sampling with temperature, called nucleus sampling, where the
|
257
|
+
model considers the results of the tokens with top_p probability mass. So 0.1
|
258
|
+
means only the tokens comprising the top 10% probability mass are considered.
|
259
|
+
|
260
|
+
We generally recommend altering this or `temperature` but not both.
|
261
|
+
|
262
|
+
user: A unique identifier representing your end-user, which can help DigitalOcean to
|
263
|
+
monitor and detect abuse.
|
264
|
+
|
265
|
+
extra_headers: Send extra headers
|
266
|
+
|
267
|
+
extra_query: Add additional query parameters to the request
|
268
|
+
|
269
|
+
extra_body: Add additional JSON properties to the request
|
270
|
+
|
271
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
272
|
+
"""
|
273
|
+
...
|
274
|
+
|
275
|
+
@overload
|
276
|
+
def create(
|
277
|
+
self,
|
278
|
+
*,
|
279
|
+
messages: Iterable[completion_create_params.Message],
|
280
|
+
model: str,
|
281
|
+
stream: bool,
|
282
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
283
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
284
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
285
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
286
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
287
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
288
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
289
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
290
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
291
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
292
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
293
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
294
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
295
|
+
user: str | NotGiven = NOT_GIVEN,
|
296
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
297
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
298
|
+
extra_headers: Headers | None = None,
|
299
|
+
extra_query: Query | None = None,
|
300
|
+
extra_body: Body | None = None,
|
301
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
302
|
+
) -> CompletionCreateResponse | Stream[AgentChatCompletionChunk]:
|
303
|
+
"""
|
304
|
+
Creates a model response for the given chat conversation.
|
305
|
+
|
306
|
+
Args:
|
307
|
+
messages: A list of messages comprising the conversation so far.
|
308
|
+
|
309
|
+
model: Model ID used to generate the response.
|
310
|
+
|
311
|
+
stream: If set to true, the model response data will be streamed to the client as it is
|
312
|
+
generated using server-sent events.
|
313
|
+
|
314
|
+
frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
315
|
+
existing frequency in the text so far, decreasing the model's likelihood to
|
316
|
+
repeat the same line verbatim.
|
317
|
+
|
318
|
+
logit_bias: Modify the likelihood of specified tokens appearing in the completion.
|
319
|
+
|
320
|
+
Accepts a JSON object that maps tokens (specified by their token ID in the
|
321
|
+
tokenizer) to an associated bias value from -100 to 100. Mathematically, the
|
322
|
+
bias is added to the logits generated by the model prior to sampling. The exact
|
323
|
+
effect will vary per model, but values between -1 and 1 should decrease or
|
324
|
+
increase likelihood of selection; values like -100 or 100 should result in a ban
|
325
|
+
or exclusive selection of the relevant token.
|
326
|
+
|
327
|
+
logprobs: Whether to return log probabilities of the output tokens or not. If true,
|
328
|
+
returns the log probabilities of each output token returned in the `content` of
|
329
|
+
`message`.
|
330
|
+
|
331
|
+
max_completion_tokens: The maximum number of completion tokens that may be used over the course of the
|
332
|
+
run. The run will make a best effort to use only the number of completion tokens
|
333
|
+
specified, across multiple turns of the run.
|
334
|
+
|
335
|
+
max_tokens: The maximum number of tokens that can be generated in the completion.
|
336
|
+
|
337
|
+
The token count of your prompt plus `max_tokens` cannot exceed the model's
|
338
|
+
context length.
|
339
|
+
|
340
|
+
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
|
341
|
+
for storing additional information about the object in a structured format, and
|
342
|
+
querying for objects via API or the dashboard.
|
343
|
+
|
344
|
+
Keys are strings with a maximum length of 64 characters. Values are strings with
|
345
|
+
a maximum length of 512 characters.
|
346
|
+
|
347
|
+
n: How many chat completion choices to generate for each input message. Note that
|
348
|
+
you will be charged based on the number of generated tokens across all of the
|
349
|
+
choices. Keep `n` as `1` to minimize costs.
|
350
|
+
|
351
|
+
presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
352
|
+
whether they appear in the text so far, increasing the model's likelihood to
|
353
|
+
talk about new topics.
|
354
|
+
|
355
|
+
stop: Up to 4 sequences where the API will stop generating further tokens. The
|
356
|
+
returned text will not contain the stop sequence.
|
357
|
+
|
358
|
+
stream_options: Options for streaming response. Only set this when you set `stream: true`.
|
359
|
+
|
360
|
+
temperature: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
361
|
+
make the output more random, while lower values like 0.2 will make it more
|
362
|
+
focused and deterministic. We generally recommend altering this or `top_p` but
|
363
|
+
not both.
|
364
|
+
|
365
|
+
top_logprobs: An integer between 0 and 20 specifying the number of most likely tokens to
|
366
|
+
return at each token position, each with an associated log probability.
|
367
|
+
`logprobs` must be set to `true` if this parameter is used.
|
368
|
+
|
369
|
+
top_p: An alternative to sampling with temperature, called nucleus sampling, where the
|
370
|
+
model considers the results of the tokens with top_p probability mass. So 0.1
|
371
|
+
means only the tokens comprising the top 10% probability mass are considered.
|
372
|
+
|
373
|
+
We generally recommend altering this or `temperature` but not both.
|
374
|
+
|
375
|
+
user: A unique identifier representing your end-user, which can help DigitalOcean to
|
376
|
+
monitor and detect abuse.
|
377
|
+
|
378
|
+
extra_headers: Send extra headers
|
379
|
+
|
380
|
+
extra_query: Add additional query parameters to the request
|
381
|
+
|
382
|
+
extra_body: Add additional JSON properties to the request
|
383
|
+
|
384
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
385
|
+
"""
|
386
|
+
...
|
387
|
+
|
388
|
+
@required_args(["messages", "model"], ["messages", "model", "stream"])
|
389
|
+
def create(
|
390
|
+
self,
|
391
|
+
*,
|
392
|
+
messages: Iterable[completion_create_params.Message],
|
393
|
+
model: str,
|
394
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
395
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
396
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
397
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
398
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
399
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
400
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
401
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
402
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
403
|
+
stream: Optional[Literal[False]] | Literal[True] | NotGiven = NOT_GIVEN,
|
404
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
405
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
406
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
407
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
408
|
+
user: str | NotGiven = NOT_GIVEN,
|
409
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
410
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
411
|
+
extra_headers: Headers | None = None,
|
412
|
+
extra_query: Query | None = None,
|
413
|
+
extra_body: Body | None = None,
|
414
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
415
|
+
) -> CompletionCreateResponse | Stream[AgentChatCompletionChunk]:
|
156
416
|
return self._post(
|
157
417
|
"/chat/completions"
|
158
418
|
if self._client._base_url_overridden
|
@@ -177,12 +437,16 @@ class CompletionsResource(SyncAPIResource):
|
|
177
437
|
"top_p": top_p,
|
178
438
|
"user": user,
|
179
439
|
},
|
180
|
-
completion_create_params.
|
440
|
+
completion_create_params.CompletionCreateParamsStreaming
|
441
|
+
if stream
|
442
|
+
else completion_create_params.CompletionCreateParamsNonStreaming,
|
181
443
|
),
|
182
444
|
options=make_request_options(
|
183
445
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
184
446
|
),
|
185
447
|
cast_to=CompletionCreateResponse,
|
448
|
+
stream=stream or False,
|
449
|
+
stream_cls=Stream[AgentChatCompletionChunk],
|
186
450
|
)
|
187
451
|
|
188
452
|
|
@@ -206,6 +470,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
|
|
206
470
|
"""
|
207
471
|
return AsyncCompletionsResourceWithStreamingResponse(self)
|
208
472
|
|
473
|
+
@overload
|
209
474
|
async def create(
|
210
475
|
self,
|
211
476
|
*,
|
@@ -220,7 +485,7 @@ class AsyncCompletionsResource(AsyncAPIResource):
|
|
220
485
|
n: Optional[int] | NotGiven = NOT_GIVEN,
|
221
486
|
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
222
487
|
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
223
|
-
stream: Optional[
|
488
|
+
stream: Optional[Literal[False]] | NotGiven = NOT_GIVEN,
|
224
489
|
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
225
490
|
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
226
491
|
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
@@ -316,6 +581,262 @@ class AsyncCompletionsResource(AsyncAPIResource):
|
|
316
581
|
|
317
582
|
timeout: Override the client-level default timeout for this request, in seconds
|
318
583
|
"""
|
584
|
+
...
|
585
|
+
|
586
|
+
@overload
|
587
|
+
async def create(
|
588
|
+
self,
|
589
|
+
*,
|
590
|
+
messages: Iterable[completion_create_params.Message],
|
591
|
+
model: str,
|
592
|
+
stream: Literal[True],
|
593
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
594
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
595
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
596
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
597
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
598
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
599
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
600
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
601
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
602
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
603
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
604
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
605
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
606
|
+
user: str | NotGiven = NOT_GIVEN,
|
607
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
608
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
609
|
+
extra_headers: Headers | None = None,
|
610
|
+
extra_query: Query | None = None,
|
611
|
+
extra_body: Body | None = None,
|
612
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
613
|
+
) -> AsyncStream[AgentChatCompletionChunk]:
|
614
|
+
"""
|
615
|
+
Creates a model response for the given chat conversation.
|
616
|
+
|
617
|
+
Args:
|
618
|
+
messages: A list of messages comprising the conversation so far.
|
619
|
+
|
620
|
+
model: Model ID used to generate the response.
|
621
|
+
|
622
|
+
stream: If set to true, the model response data will be streamed to the client as it is
|
623
|
+
generated using server-sent events.
|
624
|
+
|
625
|
+
frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
626
|
+
existing frequency in the text so far, decreasing the model's likelihood to
|
627
|
+
repeat the same line verbatim.
|
628
|
+
|
629
|
+
logit_bias: Modify the likelihood of specified tokens appearing in the completion.
|
630
|
+
|
631
|
+
Accepts a JSON object that maps tokens (specified by their token ID in the
|
632
|
+
tokenizer) to an associated bias value from -100 to 100. Mathematically, the
|
633
|
+
bias is added to the logits generated by the model prior to sampling. The exact
|
634
|
+
effect will vary per model, but values between -1 and 1 should decrease or
|
635
|
+
increase likelihood of selection; values like -100 or 100 should result in a ban
|
636
|
+
or exclusive selection of the relevant token.
|
637
|
+
|
638
|
+
logprobs: Whether to return log probabilities of the output tokens or not. If true,
|
639
|
+
returns the log probabilities of each output token returned in the `content` of
|
640
|
+
`message`.
|
641
|
+
|
642
|
+
max_completion_tokens: The maximum number of completion tokens that may be used over the course of the
|
643
|
+
run. The run will make a best effort to use only the number of completion tokens
|
644
|
+
specified, across multiple turns of the run.
|
645
|
+
|
646
|
+
max_tokens: The maximum number of tokens that can be generated in the completion.
|
647
|
+
|
648
|
+
The token count of your prompt plus `max_tokens` cannot exceed the model's
|
649
|
+
context length.
|
650
|
+
|
651
|
+
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
|
652
|
+
for storing additional information about the object in a structured format, and
|
653
|
+
querying for objects via API or the dashboard.
|
654
|
+
|
655
|
+
Keys are strings with a maximum length of 64 characters. Values are strings with
|
656
|
+
a maximum length of 512 characters.
|
657
|
+
|
658
|
+
n: How many chat completion choices to generate for each input message. Note that
|
659
|
+
you will be charged based on the number of generated tokens across all of the
|
660
|
+
choices. Keep `n` as `1` to minimize costs.
|
661
|
+
|
662
|
+
presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
663
|
+
whether they appear in the text so far, increasing the model's likelihood to
|
664
|
+
talk about new topics.
|
665
|
+
|
666
|
+
stop: Up to 4 sequences where the API will stop generating further tokens. The
|
667
|
+
returned text will not contain the stop sequence.
|
668
|
+
|
669
|
+
stream_options: Options for streaming response. Only set this when you set `stream: true`.
|
670
|
+
|
671
|
+
temperature: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
672
|
+
make the output more random, while lower values like 0.2 will make it more
|
673
|
+
focused and deterministic. We generally recommend altering this or `top_p` but
|
674
|
+
not both.
|
675
|
+
|
676
|
+
top_logprobs: An integer between 0 and 20 specifying the number of most likely tokens to
|
677
|
+
return at each token position, each with an associated log probability.
|
678
|
+
`logprobs` must be set to `true` if this parameter is used.
|
679
|
+
|
680
|
+
top_p: An alternative to sampling with temperature, called nucleus sampling, where the
|
681
|
+
model considers the results of the tokens with top_p probability mass. So 0.1
|
682
|
+
means only the tokens comprising the top 10% probability mass are considered.
|
683
|
+
|
684
|
+
We generally recommend altering this or `temperature` but not both.
|
685
|
+
|
686
|
+
user: A unique identifier representing your end-user, which can help DigitalOcean to
|
687
|
+
monitor and detect abuse.
|
688
|
+
|
689
|
+
extra_headers: Send extra headers
|
690
|
+
|
691
|
+
extra_query: Add additional query parameters to the request
|
692
|
+
|
693
|
+
extra_body: Add additional JSON properties to the request
|
694
|
+
|
695
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
696
|
+
"""
|
697
|
+
...
|
698
|
+
|
699
|
+
@overload
|
700
|
+
async def create(
|
701
|
+
self,
|
702
|
+
*,
|
703
|
+
messages: Iterable[completion_create_params.Message],
|
704
|
+
model: str,
|
705
|
+
stream: bool,
|
706
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
707
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
708
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
709
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
710
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
711
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
712
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
713
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
714
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
715
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
716
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
717
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
718
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
719
|
+
user: str | NotGiven = NOT_GIVEN,
|
720
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
721
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
722
|
+
extra_headers: Headers | None = None,
|
723
|
+
extra_query: Query | None = None,
|
724
|
+
extra_body: Body | None = None,
|
725
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
726
|
+
) -> CompletionCreateResponse | AsyncStream[AgentChatCompletionChunk]:
|
727
|
+
"""
|
728
|
+
Creates a model response for the given chat conversation.
|
729
|
+
|
730
|
+
Args:
|
731
|
+
messages: A list of messages comprising the conversation so far.
|
732
|
+
|
733
|
+
model: Model ID used to generate the response.
|
734
|
+
|
735
|
+
stream: If set to true, the model response data will be streamed to the client as it is
|
736
|
+
generated using server-sent events.
|
737
|
+
|
738
|
+
frequency_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on their
|
739
|
+
existing frequency in the text so far, decreasing the model's likelihood to
|
740
|
+
repeat the same line verbatim.
|
741
|
+
|
742
|
+
logit_bias: Modify the likelihood of specified tokens appearing in the completion.
|
743
|
+
|
744
|
+
Accepts a JSON object that maps tokens (specified by their token ID in the
|
745
|
+
tokenizer) to an associated bias value from -100 to 100. Mathematically, the
|
746
|
+
bias is added to the logits generated by the model prior to sampling. The exact
|
747
|
+
effect will vary per model, but values between -1 and 1 should decrease or
|
748
|
+
increase likelihood of selection; values like -100 or 100 should result in a ban
|
749
|
+
or exclusive selection of the relevant token.
|
750
|
+
|
751
|
+
logprobs: Whether to return log probabilities of the output tokens or not. If true,
|
752
|
+
returns the log probabilities of each output token returned in the `content` of
|
753
|
+
`message`.
|
754
|
+
|
755
|
+
max_completion_tokens: The maximum number of completion tokens that may be used over the course of the
|
756
|
+
run. The run will make a best effort to use only the number of completion tokens
|
757
|
+
specified, across multiple turns of the run.
|
758
|
+
|
759
|
+
max_tokens: The maximum number of tokens that can be generated in the completion.
|
760
|
+
|
761
|
+
The token count of your prompt plus `max_tokens` cannot exceed the model's
|
762
|
+
context length.
|
763
|
+
|
764
|
+
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
|
765
|
+
for storing additional information about the object in a structured format, and
|
766
|
+
querying for objects via API or the dashboard.
|
767
|
+
|
768
|
+
Keys are strings with a maximum length of 64 characters. Values are strings with
|
769
|
+
a maximum length of 512 characters.
|
770
|
+
|
771
|
+
n: How many chat completion choices to generate for each input message. Note that
|
772
|
+
you will be charged based on the number of generated tokens across all of the
|
773
|
+
choices. Keep `n` as `1` to minimize costs.
|
774
|
+
|
775
|
+
presence_penalty: Number between -2.0 and 2.0. Positive values penalize new tokens based on
|
776
|
+
whether they appear in the text so far, increasing the model's likelihood to
|
777
|
+
talk about new topics.
|
778
|
+
|
779
|
+
stop: Up to 4 sequences where the API will stop generating further tokens. The
|
780
|
+
returned text will not contain the stop sequence.
|
781
|
+
|
782
|
+
stream_options: Options for streaming response. Only set this when you set `stream: true`.
|
783
|
+
|
784
|
+
temperature: What sampling temperature to use, between 0 and 2. Higher values like 0.8 will
|
785
|
+
make the output more random, while lower values like 0.2 will make it more
|
786
|
+
focused and deterministic. We generally recommend altering this or `top_p` but
|
787
|
+
not both.
|
788
|
+
|
789
|
+
top_logprobs: An integer between 0 and 20 specifying the number of most likely tokens to
|
790
|
+
return at each token position, each with an associated log probability.
|
791
|
+
`logprobs` must be set to `true` if this parameter is used.
|
792
|
+
|
793
|
+
top_p: An alternative to sampling with temperature, called nucleus sampling, where the
|
794
|
+
model considers the results of the tokens with top_p probability mass. So 0.1
|
795
|
+
means only the tokens comprising the top 10% probability mass are considered.
|
796
|
+
|
797
|
+
We generally recommend altering this or `temperature` but not both.
|
798
|
+
|
799
|
+
user: A unique identifier representing your end-user, which can help DigitalOcean to
|
800
|
+
monitor and detect abuse.
|
801
|
+
|
802
|
+
extra_headers: Send extra headers
|
803
|
+
|
804
|
+
extra_query: Add additional query parameters to the request
|
805
|
+
|
806
|
+
extra_body: Add additional JSON properties to the request
|
807
|
+
|
808
|
+
timeout: Override the client-level default timeout for this request, in seconds
|
809
|
+
"""
|
810
|
+
...
|
811
|
+
|
812
|
+
@required_args(["messages", "model"], ["messages", "model", "stream"])
|
813
|
+
async def create(
|
814
|
+
self,
|
815
|
+
*,
|
816
|
+
messages: Iterable[completion_create_params.Message],
|
817
|
+
model: str,
|
818
|
+
frequency_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
819
|
+
logit_bias: Optional[Dict[str, int]] | NotGiven = NOT_GIVEN,
|
820
|
+
logprobs: Optional[bool] | NotGiven = NOT_GIVEN,
|
821
|
+
max_completion_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
822
|
+
max_tokens: Optional[int] | NotGiven = NOT_GIVEN,
|
823
|
+
metadata: Optional[Dict[str, str]] | NotGiven = NOT_GIVEN,
|
824
|
+
n: Optional[int] | NotGiven = NOT_GIVEN,
|
825
|
+
presence_penalty: Optional[float] | NotGiven = NOT_GIVEN,
|
826
|
+
stop: Union[Optional[str], List[str], None] | NotGiven = NOT_GIVEN,
|
827
|
+
stream: Optional[Literal[False]] | Literal[True] | NotGiven = NOT_GIVEN,
|
828
|
+
stream_options: Optional[completion_create_params.StreamOptions] | NotGiven = NOT_GIVEN,
|
829
|
+
temperature: Optional[float] | NotGiven = NOT_GIVEN,
|
830
|
+
top_logprobs: Optional[int] | NotGiven = NOT_GIVEN,
|
831
|
+
top_p: Optional[float] | NotGiven = NOT_GIVEN,
|
832
|
+
user: str | NotGiven = NOT_GIVEN,
|
833
|
+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
834
|
+
# The extra values given here take precedence over values defined on the client or passed to this method.
|
835
|
+
extra_headers: Headers | None = None,
|
836
|
+
extra_query: Query | None = None,
|
837
|
+
extra_body: Body | None = None,
|
838
|
+
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
839
|
+
) -> CompletionCreateResponse | AsyncStream[AgentChatCompletionChunk]:
|
319
840
|
return await self._post(
|
320
841
|
"/chat/completions"
|
321
842
|
if self._client._base_url_overridden
|
@@ -340,12 +861,16 @@ class AsyncCompletionsResource(AsyncAPIResource):
|
|
340
861
|
"top_p": top_p,
|
341
862
|
"user": user,
|
342
863
|
},
|
343
|
-
completion_create_params.
|
864
|
+
completion_create_params.CompletionCreateParamsStreaming
|
865
|
+
if stream
|
866
|
+
else completion_create_params.CompletionCreateParamsNonStreaming,
|
344
867
|
),
|
345
868
|
options=make_request_options(
|
346
869
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
347
870
|
),
|
348
871
|
cast_to=CompletionCreateResponse,
|
872
|
+
stream=stream or False,
|
873
|
+
stream_cls=AsyncStream[AgentChatCompletionChunk],
|
349
874
|
)
|
350
875
|
|
351
876
|
|