Skip to content

Commit 39356bf

Browse files
RobertCraigieRobertCraigie
committed
docs(api): improve docstrings
1 parent f04accd commit 39356bf

30 files changed

+261
-261
lines changed

‎src/openai/resources/beta/assistants/assistants.py

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def create(
5353
timeout: float | None | NotGiven = NOT_GIVEN,
5454
) -> Assistant:
5555
"""
56-
Create an Assistant with a model and instructions.
56+
Create an assistant with a model and instructions.
5757
5858
Args:
5959
model: ID of the model to use. You can use the
@@ -62,23 +62,23 @@ def create(
6262
[Model overview](https://platform.openai.com/docs/models/overview) for
6363
descriptions of them.
6464
65-
description: The description of the Assistant. The maximum length is 512 characters.
65+
description: The description of the assistant. The maximum length is 512 characters.
6666
67-
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
68-
attached to this Assistant. There can be a maximum of 20 files attached to the
69-
Assistant. Files are ordered by their creation date in ascending order.
67+
file_ids: A list of [file](https://platform.openai.com/docs/api-reference/files) IDs
68+
attached to this assistant. There can be a maximum of 20 files attached to the
69+
assistant. Files are ordered by their creation date in ascending order.
7070
71-
instructions: The system instructions that the Assistant uses. The maximum length is 32768
71+
instructions: The system instructions that the assistant uses. The maximum length is 32768
7272
characters.
7373
7474
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
7575
for storing additional information about the object in a structured format. Keys
7676
can be a maximum of 64 characters long and values can be a maxium of 512
7777
characters long.
7878
79-
name: The name of the Assistant. The maximum length is 256 characters.
79+
name: The name of the assistant. The maximum length is 256 characters.
8080
81-
tools: A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
81+
tools: A list of tool enabled on the assistant. There can be a maximum of 128 tools per
8282
assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
8383
8484
extra_headers: Send extra headers
@@ -122,7 +122,7 @@ def retrieve(
122122
timeout: float | None | NotGiven = NOT_GIVEN,
123123
) -> Assistant:
124124
"""
125-
Retrieves an Assistant.
125+
Retrieves an assistant.
126126
127127
Args:
128128
extra_headers: Send extra headers
@@ -160,20 +160,20 @@ def update(
160160
extra_body: Body | None = None,
161161
timeout: float | None | NotGiven = NOT_GIVEN,
162162
) -> Assistant:
163-
"""Modifies an Assistant.
163+
"""Modifies an assistant.
164164
165165
Args:
166-
description: The description of the Assistant.
166+
description: The description of the assistant.
167167
168168
The maximum length is 512 characters.
169169
170170
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
171-
attached to this Assistant. There can be a maximum of 20 files attached to the
172-
Assistant. Files are ordered by their creation date in ascending order. If a
171+
attached to this assistant. There can be a maximum of 20 files attached to the
172+
assistant. Files are ordered by their creation date in ascending order. If a
173173
file was previosuly attached to the list but does not show up in the list, it
174174
will be deleted from the assistant.
175175
176-
instructions: The system instructions that the Assistant uses. The maximum length is 32768
176+
instructions: The system instructions that the assistant uses. The maximum length is 32768
177177
characters.
178178
179179
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -187,9 +187,9 @@ def update(
187187
[Model overview](https://platform.openai.com/docs/models/overview) for
188188
descriptions of them.
189189
190-
name: The name of the Assistant. The maximum length is 256 characters.
190+
name: The name of the assistant. The maximum length is 256 characters.
191191
192-
tools: A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
192+
tools: A list of tool enabled on the assistant. There can be a maximum of 128 tools per
193193
assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
194194
195195
extra_headers: Send extra headers
@@ -235,7 +235,7 @@ def list(
235235
extra_body: Body | None = None,
236236
timeout: float | None | NotGiven = NOT_GIVEN,
237237
) -> SyncCursorPage[Assistant]:
238-
"""Returns a list of Assistants.
238+
"""Returns a list of assistants.
239239
240240
Args:
241241
after: A cursor for use in pagination.
@@ -298,7 +298,7 @@ def delete(
298298
timeout: float | None | NotGiven = NOT_GIVEN,
299299
) -> AsssitantDeleted:
300300
"""
301-
Delete an Assistant.
301+
Delete an assistant.
302302
303303
Args:
304304
extra_headers: Send extra headers
@@ -346,7 +346,7 @@ async def create(
346346
timeout: float | None | NotGiven = NOT_GIVEN,
347347
) -> Assistant:
348348
"""
349-
Create an Assistant with a model and instructions.
349+
Create an assistant with a model and instructions.
350350
351351
Args:
352352
model: ID of the model to use. You can use the
@@ -355,23 +355,23 @@ async def create(
355355
[Model overview](https://platform.openai.com/docs/models/overview) for
356356
descriptions of them.
357357
358-
description: The description of the Assistant. The maximum length is 512 characters.
358+
description: The description of the assistant. The maximum length is 512 characters.
359359
360-
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
361-
attached to this Assistant. There can be a maximum of 20 files attached to the
362-
Assistant. Files are ordered by their creation date in ascending order.
360+
file_ids: A list of [file](https://platform.openai.com/docs/api-reference/files) IDs
361+
attached to this assistant. There can be a maximum of 20 files attached to the
362+
assistant. Files are ordered by their creation date in ascending order.
363363
364-
instructions: The system instructions that the Assistant uses. The maximum length is 32768
364+
instructions: The system instructions that the assistant uses. The maximum length is 32768
365365
characters.
366366
367367
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
368368
for storing additional information about the object in a structured format. Keys
369369
can be a maximum of 64 characters long and values can be a maxium of 512
370370
characters long.
371371
372-
name: The name of the Assistant. The maximum length is 256 characters.
372+
name: The name of the assistant. The maximum length is 256 characters.
373373
374-
tools: A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
374+
tools: A list of tool enabled on the assistant. There can be a maximum of 128 tools per
375375
assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
376376
377377
extra_headers: Send extra headers
@@ -415,7 +415,7 @@ async def retrieve(
415415
timeout: float | None | NotGiven = NOT_GIVEN,
416416
) -> Assistant:
417417
"""
418-
Retrieves an Assistant.
418+
Retrieves an assistant.
419419
420420
Args:
421421
extra_headers: Send extra headers
@@ -453,20 +453,20 @@ async def update(
453453
extra_body: Body | None = None,
454454
timeout: float | None | NotGiven = NOT_GIVEN,
455455
) -> Assistant:
456-
"""Modifies an Assistant.
456+
"""Modifies an assistant.
457457
458458
Args:
459-
description: The description of the Assistant.
459+
description: The description of the assistant.
460460
461461
The maximum length is 512 characters.
462462
463463
file_ids: A list of [File](https://platform.openai.com/docs/api-reference/files) IDs
464-
attached to this Assistant. There can be a maximum of 20 files attached to the
465-
Assistant. Files are ordered by their creation date in ascending order. If a
464+
attached to this assistant. There can be a maximum of 20 files attached to the
465+
assistant. Files are ordered by their creation date in ascending order. If a
466466
file was previosuly attached to the list but does not show up in the list, it
467467
will be deleted from the assistant.
468468
469-
instructions: The system instructions that the Assistant uses. The maximum length is 32768
469+
instructions: The system instructions that the assistant uses. The maximum length is 32768
470470
characters.
471471
472472
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -480,9 +480,9 @@ async def update(
480480
[Model overview](https://platform.openai.com/docs/models/overview) for
481481
descriptions of them.
482482
483-
name: The name of the Assistant. The maximum length is 256 characters.
483+
name: The name of the assistant. The maximum length is 256 characters.
484484
485-
tools: A list of tool enabled on the Assistant. There can be a maximum of 128 tools per
485+
tools: A list of tool enabled on the assistant. There can be a maximum of 128 tools per
486486
assistant. Tools can be of types `code_interpreter`, `retrieval`, or `function`.
487487
488488
extra_headers: Send extra headers
@@ -528,7 +528,7 @@ def list(
528528
extra_body: Body | None = None,
529529
timeout: float | None | NotGiven = NOT_GIVEN,
530530
) -> AsyncPaginator[Assistant, AsyncCursorPage[Assistant]]:
531-
"""Returns a list of Assistants.
531+
"""Returns a list of assistants.
532532
533533
Args:
534534
after: A cursor for use in pagination.
@@ -591,7 +591,7 @@ async def delete(
591591
timeout: float | None | NotGiven = NOT_GIVEN,
592592
) -> AsssitantDeleted:
593593
"""
594-
Delete an Assistant.
594+
Delete an assistant.
595595
596596
Args:
597597
extra_headers: Send extra headers

‎src/openai/resources/beta/assistants/files.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ def create(
4444
timeout: float | None | NotGiven = NOT_GIVEN,
4545
) -> AssistantFile:
4646
"""
47-
Create an Assistant File by attaching a
47+
Create an assistant file by attaching a
4848
[File](https://platform.openai.com/docs/api-reference/files) to an
49-
[Assistant](https://platform.openai.com/docs/api-reference/assistants).
49+
[assistant](https://platform.openai.com/docs/api-reference/assistants).
5050
5151
Args:
5252
file_id: A [File](https://platform.openai.com/docs/api-reference/files) ID (with
53-
`purpose="assistants"`) that the Assistant should use. Useful for tools like
53+
`purpose="assistants"`) that the assistant should use. Useful for tools like
5454
`retrieval` and `code_interpreter` that can access files.
5555
5656
extra_headers: Send extra headers
@@ -120,7 +120,7 @@ def list(
120120
timeout: float | None | NotGiven = NOT_GIVEN,
121121
) -> SyncCursorPage[AssistantFile]:
122122
"""
123-
Returns a list of Assistant Files.
123+
Returns a list of assistant files.
124124
125125
Args:
126126
after: A cursor for use in pagination. `after` is an object ID that defines your place
@@ -182,7 +182,7 @@ def delete(
182182
timeout: float | None | NotGiven = NOT_GIVEN,
183183
) -> FileDeleteResponse:
184184
"""
185-
Delete an Assistant File.
185+
Delete an assistant file.
186186
187187
Args:
188188
extra_headers: Send extra headers
@@ -223,13 +223,13 @@ async def create(
223223
timeout: float | None | NotGiven = NOT_GIVEN,
224224
) -> AssistantFile:
225225
"""
226-
Create an Assistant File by attaching a
226+
Create an assistant file by attaching a
227227
[File](https://platform.openai.com/docs/api-reference/files) to an
228-
[Assistant](https://platform.openai.com/docs/api-reference/assistants).
228+
[assistant](https://platform.openai.com/docs/api-reference/assistants).
229229
230230
Args:
231231
file_id: A [File](https://platform.openai.com/docs/api-reference/files) ID (with
232-
`purpose="assistants"`) that the Assistant should use. Useful for tools like
232+
`purpose="assistants"`) that the assistant should use. Useful for tools like
233233
`retrieval` and `code_interpreter` that can access files.
234234
235235
extra_headers: Send extra headers
@@ -299,7 +299,7 @@ def list(
299299
timeout: float | None | NotGiven = NOT_GIVEN,
300300
) -> AsyncPaginator[AssistantFile, AsyncCursorPage[AssistantFile]]:
301301
"""
302-
Returns a list of Assistant Files.
302+
Returns a list of assistant files.
303303
304304
Args:
305305
after: A cursor for use in pagination. `after` is an object ID that defines your place
@@ -361,7 +361,7 @@ async def delete(
361361
timeout: float | None | NotGiven = NOT_GIVEN,
362362
) -> FileDeleteResponse:
363363
"""
364-
Delete an Assistant File.
364+
Delete an assistant file.
365365
366366
Args:
367367
extra_headers: Send extra headers

‎src/openai/resources/beta/threads/messages/files.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def retrieve(
4040
timeout: float | None | NotGiven = NOT_GIVEN,
4141
) -> MessageFile:
4242
"""
43-
Retrieves a Message File.
43+
Retrieves a message file.
4444
4545
Args:
4646
extra_headers: Send extra headers
@@ -76,7 +76,7 @@ def list(
7676
extra_body: Body | None = None,
7777
timeout: float | None | NotGiven = NOT_GIVEN,
7878
) -> SyncCursorPage[MessageFile]:
79-
"""Returns a list of Message Files.
79+
"""Returns a list of message files.
8080
8181
Args:
8282
after: A cursor for use in pagination.
@@ -149,7 +149,7 @@ async def retrieve(
149149
timeout: float | None | NotGiven = NOT_GIVEN,
150150
) -> MessageFile:
151151
"""
152-
Retrieves a Message File.
152+
Retrieves a message file.
153153
154154
Args:
155155
extra_headers: Send extra headers
@@ -185,7 +185,7 @@ def list(
185185
extra_body: Body | None = None,
186186
timeout: float | None | NotGiven = NOT_GIVEN,
187187
) -> AsyncPaginator[MessageFile, AsyncCursorPage[MessageFile]]:
188-
"""Returns a list of Message Files.
188+
"""Returns a list of message files.
189189
190190
Args:
191191
after: A cursor for use in pagination.

0 commit comments

Comments
 (0)