Skip to content

chore(realtime): update docstrings #1964

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 69
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-0d64ca9e45f51b4279f87b205eeb3a3576df98407698ce053f2e2302c1c08df1.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai-a39aca84ed97ebafb707ebd5221e2787c5a42ff3d98f2ffaea8a0dcd84cbcbcb.yml
5 changes: 3 additions & 2 deletions src/openai/types/beta/realtime/conversation_item_content.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
class ConversationItemContent(BaseModel):
id: Optional[str] = None
"""
ID of a previous conversation item (like a model response), used for
`item_reference` content types.
ID of a previous conversation item to reference (for `item_reference` content
types in `response.create` events). These can reference both client and server
created items.
"""

audio: Optional[str] = None
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@
class ConversationItemContentParam(TypedDict, total=False):
id: str
"""
ID of a previous conversation item (like a model response), used for
`item_reference` content types.
ID of a previous conversation item to reference (for `item_reference` content
types in `response.create` events). These can reference both client and server
created items.
"""

audio: str
Expand Down
3 changes: 2 additions & 1 deletion src/openai/types/beta/realtime/response_create_event.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ class Response(BaseModel):
tool_choice: Optional[str] = None
"""How the model chooses tools.

Options are `auto`, `none`, `required`, or specify a function.
Options are `auto`, `none`, `required`, or specify a function, like
`{"type": "function", "function": {"name": "my_function"}}`.
"""

tools: Optional[List[ResponseTool]] = None
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ class Response(TypedDict, total=False):
tool_choice: str
"""How the model chooses tools.

Options are `auto`, `none`, `required`, or specify a function.
Options are `auto`, `none`, `required`, or specify a function, like
`{"type": "function", "function": {"name": "my_function"}}`.
"""

tools: Iterable[ResponseTool]
Expand Down