Skip to content

Commit 156d518

Browse files
stainless-app[bot]stainless-app[bot]
committed
docs: split api.md by standalone resources
1 parent 72e1e15 commit 156d518

11 files changed

Lines changed: 397 additions & 387 deletions

File tree

‎api.md‎

Lines changed: 4 additions & 378 deletions
Large diffs are not rendered by default.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ format = { chain = [
8484
# run formatting again to fix any inconsistencies when imports are stripped
8585
"format:ruff",
8686
]}
87-
"format:docs" = "python scripts/utils/ruffen-docs.py README.md api.md"
87+
"format:docs" = "bash -c 'python scripts/utils/ruffen-docs.py README.md $(find . -type f -name api.md)'"
8888
"format:ruff" = "ruff format"
8989

9090
"lint" = { chain = [

‎src/openai/_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@
6363
from .resources.models import Models, AsyncModels
6464
from .resources.videos import Videos, AsyncVideos
6565
from .resources.batches import Batches, AsyncBatches
66-
from .resources.webhooks import Webhooks, AsyncWebhooks
6766
from .resources.beta.beta import Beta, AsyncBeta
6867
from .resources.chat.chat import Chat, AsyncChat
6968
from .resources.embeddings import Embeddings, AsyncEmbeddings
@@ -74,6 +73,7 @@
7473
from .resources.skills.skills import Skills, AsyncSkills
7574
from .resources.uploads.uploads import Uploads, AsyncUploads
7675
from .resources.realtime.realtime import Realtime, AsyncRealtime
76+
from .resources.webhooks.webhooks import Webhooks, AsyncWebhooks
7777
from .resources.responses.responses import Responses, AsyncResponses
7878
from .resources.containers.containers import Containers, AsyncContainers
7979
from .resources.fine_tuning.fine_tuning import FineTuning, AsyncFineTuning

‎src/openai/_module_client.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
from .resources.models import Models
1212
from .resources.videos import Videos
1313
from .resources.batches import Batches
14-
from .resources.webhooks import Webhooks
1514
from .resources.beta.beta import Beta
1615
from .resources.chat.chat import Chat
1716
from .resources.embeddings import Embeddings
@@ -22,6 +21,7 @@
2221
from .resources.skills.skills import Skills
2322
from .resources.uploads.uploads import Uploads
2423
from .resources.realtime.realtime import Realtime
24+
from .resources.webhooks.webhooks import Webhooks
2525
from .resources.responses.responses import Responses
2626
from .resources.containers.containers import Containers
2727
from .resources.fine_tuning.fine_tuning import FineTuning

‎src/openai/resources/conversations/api.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Conversations
2+
3+
Types:
4+
5+
```python
6+
from openai.types.conversations import (
7+
ComputerScreenshotContent,
8+
Conversation,
9+
ConversationDeleted,
10+
ConversationDeletedResource,
11+
Message,
12+
SummaryTextContent,
13+
TextContent,
14+
InputTextContent,
15+
OutputTextContent,
16+
RefusalContent,
17+
InputImageContent,
18+
InputFileContent,
19+
)
20+
```
21+
22+
Methods:
23+
24+
- <code title="post /conversations">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">create</a>(\*\*<a href="src/openai/types/conversations/conversation_create_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
25+
- <code title="get /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">retrieve</a>(conversation_id) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
26+
- <code title="post /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">update</a>(conversation_id, \*\*<a href="src/openai/types/conversations/conversation_update_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
27+
- <code title="delete /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">delete</a>(conversation_id) -> <a href="./src/openai/types/conversations/conversation_deleted_resource.py">ConversationDeletedResource</a></code>
28+
29+
## Items
30+
31+
Types:
32+
33+
```python
34+
from openai.types.conversations import ConversationItem, ConversationItemList
35+
```
36+
37+
Methods:
38+
39+
- <code title="post /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">create</a>(conversation_id, \*\*<a href="src/openai/types/conversations/item_create_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item_list.py">ConversationItemList</a></code>
40+
- <code title="get /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">retrieve</a>(item_id, \*, conversation_id, \*\*<a href="src/openai/types/conversations/item_retrieve_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item.py">ConversationItem</a></code>
41+
- <code title="get /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">list</a>(conversation_id, \*\*<a href="src/openai/types/conversations/item_list_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item.py">SyncConversationCursorPage[ConversationItem]</a></code>
42+
- <code title="delete /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">delete</a>(item_id, \*, conversation_id) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>

‎src/openai/resources/realtime/api.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Realtime
2+
3+
Types:
4+
5+
```python
6+
from openai.types.realtime import (
7+
AudioTranscription,
8+
ConversationCreatedEvent,
9+
ConversationItem,
10+
ConversationItemAdded,
11+
ConversationItemCreateEvent,
12+
ConversationItemCreatedEvent,
13+
ConversationItemDeleteEvent,
14+
ConversationItemDeletedEvent,
15+
ConversationItemDone,
16+
ConversationItemInputAudioTranscriptionCompletedEvent,
17+
ConversationItemInputAudioTranscriptionDeltaEvent,
18+
ConversationItemInputAudioTranscriptionFailedEvent,
19+
ConversationItemInputAudioTranscriptionSegment,
20+
ConversationItemRetrieveEvent,
21+
ConversationItemTruncateEvent,
22+
ConversationItemTruncatedEvent,
23+
ConversationItemWithReference,
24+
InputAudioBufferAppendEvent,
25+
InputAudioBufferClearEvent,
26+
InputAudioBufferClearedEvent,
27+
InputAudioBufferCommitEvent,
28+
InputAudioBufferCommittedEvent,
29+
InputAudioBufferDtmfEventReceivedEvent,
30+
InputAudioBufferSpeechStartedEvent,
31+
InputAudioBufferSpeechStoppedEvent,
32+
InputAudioBufferTimeoutTriggered,
33+
LogProbProperties,
34+
McpListToolsCompleted,
35+
McpListToolsFailed,
36+
McpListToolsInProgress,
37+
NoiseReductionType,
38+
OutputAudioBufferClearEvent,
39+
RateLimitsUpdatedEvent,
40+
RealtimeAudioConfig,
41+
RealtimeAudioConfigInput,
42+
RealtimeAudioConfigOutput,
43+
RealtimeAudioFormats,
44+
RealtimeAudioInputTurnDetection,
45+
RealtimeClientEvent,
46+
RealtimeConversationItemAssistantMessage,
47+
RealtimeConversationItemFunctionCall,
48+
RealtimeConversationItemFunctionCallOutput,
49+
RealtimeConversationItemSystemMessage,
50+
RealtimeConversationItemUserMessage,
51+
RealtimeError,
52+
RealtimeErrorEvent,
53+
RealtimeFunctionTool,
54+
RealtimeMcpApprovalRequest,
55+
RealtimeMcpApprovalResponse,
56+
RealtimeMcpListTools,
57+
RealtimeMcpProtocolError,
58+
RealtimeMcpToolCall,
59+
RealtimeMcpToolExecutionError,
60+
RealtimeMcphttpError,
61+
RealtimeResponse,
62+
RealtimeResponseCreateAudioOutput,
63+
RealtimeResponseCreateMcpTool,
64+
RealtimeResponseCreateParams,
65+
RealtimeResponseStatus,
66+
RealtimeResponseUsage,
67+
RealtimeResponseUsageInputTokenDetails,
68+
RealtimeResponseUsageOutputTokenDetails,
69+
RealtimeServerEvent,
70+
RealtimeSession,
71+
RealtimeSessionCreateRequest,
72+
RealtimeToolChoiceConfig,
73+
RealtimeToolsConfig,
74+
RealtimeToolsConfigUnion,
75+
RealtimeTracingConfig,
76+
RealtimeTranscriptionSessionAudio,
77+
RealtimeTranscriptionSessionAudioInput,
78+
RealtimeTranscriptionSessionAudioInputTurnDetection,
79+
RealtimeTranscriptionSessionCreateRequest,
80+
RealtimeTruncation,
81+
RealtimeTruncationRetentionRatio,
82+
ResponseAudioDeltaEvent,
83+
ResponseAudioDoneEvent,
84+
ResponseAudioTranscriptDeltaEvent,
85+
ResponseAudioTranscriptDoneEvent,
86+
ResponseCancelEvent,
87+
ResponseContentPartAddedEvent,
88+
ResponseContentPartDoneEvent,
89+
ResponseCreateEvent,
90+
ResponseCreatedEvent,
91+
ResponseDoneEvent,
92+
ResponseFunctionCallArgumentsDeltaEvent,
93+
ResponseFunctionCallArgumentsDoneEvent,
94+
ResponseMcpCallArgumentsDelta,
95+
ResponseMcpCallArgumentsDone,
96+
ResponseMcpCallCompleted,
97+
ResponseMcpCallFailed,
98+
ResponseMcpCallInProgress,
99+
ResponseOutputItemAddedEvent,
100+
ResponseOutputItemDoneEvent,
101+
ResponseTextDeltaEvent,
102+
ResponseTextDoneEvent,
103+
SessionCreatedEvent,
104+
SessionUpdateEvent,
105+
SessionUpdatedEvent,
106+
TranscriptionSessionUpdate,
107+
TranscriptionSessionUpdatedEvent,
108+
)
109+
```
110+
111+
## ClientSecrets
112+
113+
Types:
114+
115+
```python
116+
from openai.types.realtime import (
117+
RealtimeSessionClientSecret,
118+
RealtimeSessionCreateResponse,
119+
RealtimeTranscriptionSessionCreateResponse,
120+
RealtimeTranscriptionSessionTurnDetection,
121+
ClientSecretCreateResponse,
122+
)
123+
```
124+
125+
Methods:
126+
127+
- <code title="post /realtime/client_secrets">client.realtime.client_secrets.<a href="./src/openai/resources/realtime/client_secrets.py">create</a>(\*\*<a href="src/openai/types/realtime/client_secret_create_params.py">params</a>) -> <a href="./src/openai/types/realtime/client_secret_create_response.py">ClientSecretCreateResponse</a></code>
128+
129+
## Calls
130+
131+
Methods:
132+
133+
- <code title="post /realtime/calls">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">create</a>(\*\*<a href="src/openai/types/realtime/call_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
134+
- <code title="post /realtime/calls/{call_id}/accept">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">accept</a>(call_id, \*\*<a href="src/openai/types/realtime/call_accept_params.py">params</a>) -> None</code>
135+
- <code title="post /realtime/calls/{call_id}/hangup">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">hangup</a>(call_id) -> None</code>
136+
- <code title="post /realtime/calls/{call_id}/refer">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">refer</a>(call_id, \*\*<a href="src/openai/types/realtime/call_refer_params.py">params</a>) -> None</code>
137+
- <code title="post /realtime/calls/{call_id}/reject">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">reject</a>(call_id, \*\*<a href="src/openai/types/realtime/call_reject_params.py">params</a>) -> None</code>

‎src/openai/resources/responses/api.md‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
# Responses
2+
3+
Types:
4+
5+
```python
6+
from openai.types.responses import (
7+
ApplyPatchTool,
8+
CompactedResponse,
9+
ComputerTool,
10+
ContainerAuto,
11+
ContainerNetworkPolicyAllowlist,
12+
ContainerNetworkPolicyDisabled,
13+
ContainerNetworkPolicyDomainSecret,
14+
ContainerReference,
15+
CustomTool,
16+
EasyInputMessage,
17+
FileSearchTool,
18+
FunctionShellTool,
19+
FunctionTool,
20+
InlineSkill,
21+
InlineSkillSource,
22+
LocalEnvironment,
23+
LocalSkill,
24+
Response,
25+
ResponseApplyPatchToolCall,
26+
ResponseApplyPatchToolCallOutput,
27+
ResponseAudioDeltaEvent,
28+
ResponseAudioDoneEvent,
29+
ResponseAudioTranscriptDeltaEvent,
30+
ResponseAudioTranscriptDoneEvent,
31+
ResponseCodeInterpreterCallCodeDeltaEvent,
32+
ResponseCodeInterpreterCallCodeDoneEvent,
33+
ResponseCodeInterpreterCallCompletedEvent,
34+
ResponseCodeInterpreterCallInProgressEvent,
35+
ResponseCodeInterpreterCallInterpretingEvent,
36+
ResponseCodeInterpreterToolCall,
37+
ResponseCompactionItem,
38+
ResponseCompactionItemParam,
39+
ResponseCompletedEvent,
40+
ResponseComputerToolCall,
41+
ResponseComputerToolCallOutputItem,
42+
ResponseComputerToolCallOutputScreenshot,
43+
ResponseContainerReference,
44+
ResponseContent,
45+
ResponseContentPartAddedEvent,
46+
ResponseContentPartDoneEvent,
47+
ResponseConversationParam,
48+
ResponseCreatedEvent,
49+
ResponseCustomToolCall,
50+
ResponseCustomToolCallInputDeltaEvent,
51+
ResponseCustomToolCallInputDoneEvent,
52+
ResponseCustomToolCallOutput,
53+
ResponseError,
54+
ResponseErrorEvent,
55+
ResponseFailedEvent,
56+
ResponseFileSearchCallCompletedEvent,
57+
ResponseFileSearchCallInProgressEvent,
58+
ResponseFileSearchCallSearchingEvent,
59+
ResponseFileSearchToolCall,
60+
ResponseFormatTextConfig,
61+
ResponseFormatTextJSONSchemaConfig,
62+
ResponseFunctionCallArgumentsDeltaEvent,
63+
ResponseFunctionCallArgumentsDoneEvent,
64+
ResponseFunctionCallOutputItem,
65+
ResponseFunctionCallOutputItemList,
66+
ResponseFunctionShellCallOutputContent,
67+
ResponseFunctionShellToolCall,
68+
ResponseFunctionShellToolCallOutput,
69+
ResponseFunctionToolCall,
70+
ResponseFunctionToolCallItem,
71+
ResponseFunctionToolCallOutputItem,
72+
ResponseFunctionWebSearch,
73+
ResponseImageGenCallCompletedEvent,
74+
ResponseImageGenCallGeneratingEvent,
75+
ResponseImageGenCallInProgressEvent,
76+
ResponseImageGenCallPartialImageEvent,
77+
ResponseInProgressEvent,
78+
ResponseIncludable,
79+
ResponseIncompleteEvent,
80+
ResponseInput,
81+
ResponseInputAudio,
82+
ResponseInputContent,
83+
ResponseInputFile,
84+
ResponseInputFileContent,
85+
ResponseInputImage,
86+
ResponseInputImageContent,
87+
ResponseInputItem,
88+
ResponseInputMessageContentList,
89+
ResponseInputMessageItem,
90+
ResponseInputText,
91+
ResponseInputTextContent,
92+
ResponseItem,
93+
ResponseLocalEnvironment,
94+
ResponseMcpCallArgumentsDeltaEvent,
95+
ResponseMcpCallArgumentsDoneEvent,
96+
ResponseMcpCallCompletedEvent,
97+
ResponseMcpCallFailedEvent,
98+
ResponseMcpCallInProgressEvent,
99+
ResponseMcpListToolsCompletedEvent,
100+
ResponseMcpListToolsFailedEvent,
101+
ResponseMcpListToolsInProgressEvent,
102+
ResponseOutputAudio,
103+
ResponseOutputItem,
104+
ResponseOutputItemAddedEvent,
105+
ResponseOutputItemDoneEvent,
106+
ResponseOutputMessage,
107+
ResponseOutputRefusal,
108+
ResponseOutputText,
109+
ResponseOutputTextAnnotationAddedEvent,
110+
ResponsePrompt,
111+
ResponseQueuedEvent,
112+
ResponseReasoningItem,
113+
ResponseReasoningSummaryPartAddedEvent,
114+
ResponseReasoningSummaryPartDoneEvent,
115+
ResponseReasoningSummaryTextDeltaEvent,
116+
ResponseReasoningSummaryTextDoneEvent,
117+
ResponseReasoningTextDeltaEvent,
118+
ResponseReasoningTextDoneEvent,
119+
ResponseRefusalDeltaEvent,
120+
ResponseRefusalDoneEvent,
121+
ResponseStatus,
122+
ResponseStreamEvent,
123+
ResponseTextConfig,
124+
ResponseTextDeltaEvent,
125+
ResponseTextDoneEvent,
126+
ResponseUsage,
127+
ResponseWebSearchCallCompletedEvent,
128+
ResponseWebSearchCallInProgressEvent,
129+
ResponseWebSearchCallSearchingEvent,
130+
SkillReference,
131+
Tool,
132+
ToolChoiceAllowed,
133+
ToolChoiceApplyPatch,
134+
ToolChoiceCustom,
135+
ToolChoiceFunction,
136+
ToolChoiceMcp,
137+
ToolChoiceOptions,
138+
ToolChoiceShell,
139+
ToolChoiceTypes,
140+
WebSearchPreviewTool,
141+
WebSearchTool,
142+
)
143+
```
144+
145+
Methods:
146+
147+
- <code title="post /responses">client.responses.<a href="./src/openai/resources/responses/responses.py">create</a>(\*\*<a href="src/openai/types/responses/response_create_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
148+
- <code title="get /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">retrieve</a>(response_id, \*\*<a href="src/openai/types/responses/response_retrieve_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
149+
- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
150+
- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/openai/resources/responses/responses.py">cancel</a>(response_id) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
151+
- <code title="post /responses/compact">client.responses.<a href="./src/openai/resources/responses/responses.py">compact</a>(\*\*<a href="src/openai/types/responses/response_compact_params.py">params</a>) -> <a href="./src/openai/types/responses/compacted_response.py">CompactedResponse</a></code>
152+
153+
## InputItems
154+
155+
Types:
156+
157+
```python
158+
from openai.types.responses import ResponseItemList
159+
```
160+
161+
Methods:
162+
163+
- <code title="get /responses/{response_id}/input_items">client.responses.input_items.<a href="./src/openai/resources/responses/input_items.py">list</a>(response_id, \*\*<a href="src/openai/types/responses/input_item_list_params.py">params</a>) -> <a href="./src/openai/types/responses/response_item.py">SyncCursorPage[ResponseItem]</a></code>
164+
165+
## InputTokens
166+
167+
Types:
168+
169+
```python
170+
from openai.types.responses import InputTokenCountResponse
171+
```
172+
173+
Methods:
174+
175+
- <code title="post /responses/input_tokens">client.responses.input_tokens.<a href="./src/openai/resources/responses/input_tokens.py">count</a>(\*\*<a href="src/openai/types/responses/input_token_count_params.py">params</a>) -> <a href="./src/openai/types/responses/input_token_count_response.py">InputTokenCountResponse</a></code>

0 commit comments

Comments
 (0)