openai
Version:
The official TypeScript library for the OpenAI API
170 lines (155 loc) • 14.3 kB
Markdown
# Responses
Types:
- <code><a href="./src/resources/responses/responses.ts">ApplyPatchTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">CompactedResponse</a></code>
- <code><a href="./src/resources/responses/responses.ts">ComputerTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">ContainerAuto</a></code>
- <code><a href="./src/resources/responses/responses.ts">ContainerNetworkPolicyAllowlist</a></code>
- <code><a href="./src/resources/responses/responses.ts">ContainerNetworkPolicyDisabled</a></code>
- <code><a href="./src/resources/responses/responses.ts">ContainerNetworkPolicyDomainSecret</a></code>
- <code><a href="./src/resources/responses/responses.ts">ContainerReference</a></code>
- <code><a href="./src/resources/responses/responses.ts">CustomTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">EasyInputMessage</a></code>
- <code><a href="./src/resources/responses/responses.ts">FileSearchTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">FunctionShellTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">FunctionTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">InlineSkill</a></code>
- <code><a href="./src/resources/responses/responses.ts">InlineSkillSource</a></code>
- <code><a href="./src/resources/responses/responses.ts">LocalEnvironment</a></code>
- <code><a href="./src/resources/responses/responses.ts">LocalSkill</a></code>
- <code><a href="./src/resources/responses/responses.ts">Response</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseApplyPatchToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseApplyPatchToolCallOutput</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseAudioDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseAudioDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseAudioTranscriptDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseAudioTranscriptDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterCallCodeDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterCallCodeDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterCallCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterCallInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterCallInterpretingEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCodeInterpreterToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCompactionItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCompactionItemParam</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseComputerToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseComputerToolCallOutputItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseComputerToolCallOutputScreenshot</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseContainerReference</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseContentPartAddedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseContentPartDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseConversationParam</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCreatedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCallInputDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCallInputDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseCustomToolCallOutput</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseError</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseErrorEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFailedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFileSearchCallCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFileSearchCallInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFileSearchCallSearchingEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFileSearchToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFormatTextConfig</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFormatTextJSONSchemaConfig</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionCallArgumentsDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionCallArgumentsDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionCallOutputItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionCallOutputItemList</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionShellCallOutputContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionShellToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionShellToolCallOutput</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionToolCall</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionToolCallItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionToolCallOutputItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseFunctionWebSearch</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseImageGenCallCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseImageGenCallGeneratingEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseImageGenCallInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseImageGenCallPartialImageEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseIncludable</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseIncompleteEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInput</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputAudio</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputFile</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputFileContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputImage</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputImageContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputMessageContentList</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputMessageItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputText</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseInputTextContent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseLocalEnvironment</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpCallArgumentsDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpCallArgumentsDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpCallCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpCallFailedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpCallInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpListToolsCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpListToolsFailedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseMcpListToolsInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputAudio</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputItemAddedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputItemDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputMessage</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputRefusal</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputText</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseOutputTextAnnotationAddedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponsePrompt</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseQueuedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningItem</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryPartAddedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryPartDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryTextDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningSummaryTextDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningTextDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseReasoningTextDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseRefusalDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseRefusalDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseStatus</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseStreamEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseTextConfig</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseTextDeltaEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseTextDoneEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseUsage</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseWebSearchCallCompletedEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseWebSearchCallInProgressEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponseWebSearchCallSearchingEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponsesClientEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">ResponsesServerEvent</a></code>
- <code><a href="./src/resources/responses/responses.ts">SkillReference</a></code>
- <code><a href="./src/resources/responses/responses.ts">Tool</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceAllowed</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceApplyPatch</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceCustom</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceFunction</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceMcp</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceOptions</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceShell</a></code>
- <code><a href="./src/resources/responses/responses.ts">ToolChoiceTypes</a></code>
- <code><a href="./src/resources/responses/responses.ts">WebSearchPreviewTool</a></code>
- <code><a href="./src/resources/responses/responses.ts">WebSearchTool</a></code>
Methods:
- <code title="post /responses">client.responses.<a href="./src/resources/responses/responses.ts">create</a>({ ...params }) -> Response</code>
- <code title="get /responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">retrieve</a>(responseID, { ...params }) -> Response</code>
- <code title="delete /responses/{response_id}">client.responses.<a href="./src/resources/responses/responses.ts">delete</a>(responseID) -> void</code>
- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/resources/responses/responses.ts">cancel</a>(responseID) -> Response</code>
- <code title="post /responses/compact">client.responses.<a href="./src/resources/responses/responses.ts">compact</a>({ ...params }) -> CompactedResponse</code>
## InputItems
Types:
- <code><a href="./src/resources/responses/input-items.ts">ResponseItemList</a></code>
Methods:
- <code title="get /responses/{response_id}/input_items">client.responses.inputItems.<a href="./src/resources/responses/input-items.ts">list</a>(responseID, { ...params }) -> ResponseItemsPage</code>
## InputTokens
Types:
- <code><a href="./src/resources/responses/input-tokens.ts">InputTokenCountResponse</a></code>
Methods:
- <code title="post /responses/input_tokens">client.responses.inputTokens.<a href="./src/resources/responses/input-tokens.ts">count</a>({ ...params }) -> InputTokenCountResponse</code>