Skip to content

Commit 7b26bd3

Browse files
docs: update comment
1 parent f2d096f commit 7b26bd3

2 files changed

Lines changed: 8 additions & 16 deletions

File tree

src/openai/resources/chat/completions/completions.py

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1346,12 +1346,10 @@ def list(
13461346
13471347
limit: Number of Chat Completions to retrieve.
13481348
1349-
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
1350-
for storing additional information about the object in a structured format, and
1351-
querying for objects via API or the dashboard.
1349+
metadata:
1350+
A list of metadata keys to filter the Chat Completions by. Example:
13521351
1353-
Keys are strings with a maximum length of 64 characters. Values are strings with
1354-
a maximum length of 512 characters.
1352+
`metadata[key1]=value1&metadata[key2]=value2`
13551353
13561354
model: The model used to generate the Chat Completions.
13571355
@@ -2832,12 +2830,10 @@ def list(
28322830
28332831
limit: Number of Chat Completions to retrieve.
28342832
2835-
metadata: Set of 16 key-value pairs that can be attached to an object. This can be useful
2836-
for storing additional information about the object in a structured format, and
2837-
querying for objects via API or the dashboard.
2833+
metadata:
2834+
A list of metadata keys to filter the Chat Completions by. Example:
28382835
2839-
Keys are strings with a maximum length of 64 characters. Values are strings with
2840-
a maximum length of 512 characters.
2836+
`metadata[key1]=value1&metadata[key2]=value2`
28412837
28422838
model: The model used to generate the Chat Completions.
28432839

src/openai/types/chat/completion_list_params.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,9 @@ class CompletionListParams(TypedDict, total=False):
1818
"""Number of Chat Completions to retrieve."""
1919

2020
metadata: Optional[Metadata]
21-
"""Set of 16 key-value pairs that can be attached to an object.
21+
"""A list of metadata keys to filter the Chat Completions by. Example:
2222
23-
This can be useful for storing additional information about the object in a
24-
structured format, and querying for objects via API or the dashboard.
25-
26-
Keys are strings with a maximum length of 64 characters. Values are strings with
27-
a maximum length of 512 characters.
23+
`metadata[key1]=value1&metadata[key2]=value2`
2824
"""
2925

3026
model: str

0 commit comments

Comments
 (0)