View Source API Reference OpenAI REST API Client v1.0.0

This library provides types and functions for working with OpenAI’s RESTful, streaming, and realtime APIs, making it easy to interact with the OpenAI platform.

Provides struct and type for a AdminApiKey

Provides struct and type for a AdminApiKey.List

Provides struct and type for a AdminApiKey.Owner

Provides struct and type for a Assistant

Provides struct and type for a Assistant.CreateRequest

Provides struct and type for a Assistant.CreateRequest.ToolResources

Provides struct and type for a Assistant.CreateRequest.ToolResources.CodeInterpreter

Provides struct and type for a Assistant.DeleteResponse

Provides struct and type for a Assistant.ListResponse

Provides struct and type for a Assistant.NamedToolChoice

Provides struct and type for a Assistant.NamedToolChoiceFunction

Provides struct and type for a Assistant.Tool.Code

Provides struct and type for a Assistant.Tool.FileSearch

Provides struct and type for a Assistant.Tool.FileSearch.FileSearch

Provides struct and type for a Assistant.Tool.FileSearch.TypeOnly

Provides struct and type for a Assistant.Tool.Function

Provides struct and type for a Assistant.Tool.Outputs.RunSubmitRequest

Provides struct and type for a Assistant.Tool.Outputs.RunSubmitRequest.ToolOutputs

Provides struct and type for a Assistant.Tool.Resources

Provides struct and type for a Assistant.Tool.Resources.CodeInterpreter

Provides struct and type for a Assistant.Tool.Resources.FileSearch

Provides struct and type for a Assistant.UpdateRequest

Provides struct and type for a Assistant.UpdateRequest.ToolResources

Provides struct and type for a Assistant.UpdateRequest.ToolResources.CodeInterpreter

Provides struct and type for a Assistant.UpdateRequest.ToolResources.FileSearch

Provides API endpoints related to assistants

Provides API endpoints related to audio

Provides struct and type for a Audio.Speech.CreateRequest

Provides struct and type for a Audio.Transcription.CreateRequest

Provides struct and type for a Audio.Transcription.CreateResponse.Json

Provides struct and type for a Audio.Transcription.CreateResponse.JsonLogprobs

Provides struct and type for a Audio.Transcription.CreateResponse.VerboseJson

Provides struct and type for a Audio.Transcription.Segment

Provides struct and type for a Audio.Transcription.Text.DeltaEvent

Provides struct and type for a Audio.Transcription.Text.DeltaEvent.Logprobs

Provides struct and type for a Audio.Transcription.Text.DoneEvent

Provides struct and type for a Audio.Transcription.Text.DoneEvent.Logprobs

Provides struct and type for a Audio.Transcription.Word

Provides struct and type for a Audio.Translation.CreateRequest

Provides struct and type for a Audio.Translation.CreateResponse.Json

Provides struct and type for a Audio.Translation.CreateResponse.VerboseJson

Provides struct and type for a AuditLog

Provides struct and type for a AuditLog.Actor

Provides struct and type for a AuditLog.Actor.ApiKey

Provides struct and type for a AuditLog.Actor.ServiceAccount

Provides struct and type for a AuditLog.Actor.Session

Provides struct and type for a AuditLog.Actor.User

Provides struct and type for a AuditLog.ApiKey.Created

Provides struct and type for a AuditLog.ApiKey.Created.Data

Provides struct and type for a AuditLog.ApiKey.Deleted

Provides struct and type for a AuditLog.ApiKey.Updated

Provides struct and type for a AuditLog.ApiKey.Updated.ChangesRequested

Provides struct and type for a AuditLog.Certificate.Activated

Provides struct and type for a AuditLog.Certificate.Activated.Certificate

Provides struct and type for a AuditLog.Certificate.Created

Provides struct and type for a AuditLog.Certificate.Deactivated

Provides struct and type for a AuditLog.Certificate.Deactivated.Certificate

Provides struct and type for a AuditLog.Certificate.Deleted

Provides struct and type for a AuditLog.Certificate.Updated

Provides struct and type for a AuditLog.CheckpointPermission.Created

Provides struct and type for a AuditLog.CheckpointPermission.Created.Data

Provides struct and type for a AuditLog.CheckpointPermission.Deleted

Provides struct and type for a AuditLog.Invite.Accepted

Provides struct and type for a AuditLog.Invite.Deleted

Provides struct and type for a AuditLog.Invite.Sent

Provides struct and type for a AuditLog.Invite.SentData

Provides struct and type for a AuditLog.ListResponse

Provides struct and type for a AuditLog.LoginFailed

Provides struct and type for a AuditLog.LogoutFailed

Provides struct and type for a AuditLog.Organization.Updated

Provides struct and type for a AuditLog.Organization.Updated.ChangesRequested

Provides struct and type for a AuditLog.Organization.Updated.ChangesRequestedSettings

Provides struct and type for a AuditLog.Project

Provides struct and type for a AuditLog.Project.Archived

Provides struct and type for a AuditLog.Project.Created

Provides struct and type for a AuditLog.Project.Created.Data

Provides struct and type for a AuditLog.Project.Updated

Provides struct and type for a AuditLog.Project.Updated.ChangesRequested

Provides struct and type for a AuditLog.RateLimit.Deleted

Provides struct and type for a AuditLog.RateLimit.Updated

Provides struct and type for a AuditLog.RateLimit.Updated.ChangesRequested

Provides struct and type for a AuditLog.ServiceAccount.Created

Provides struct and type for a AuditLog.ServiceAccount.CreatedData

Provides struct and type for a AuditLog.ServiceAccount.Deleted

Provides struct and type for a AuditLog.ServiceAccount.Updated

Provides struct and type for a AuditLog.ServiceAccount.UpdatedChangesRequested

Provides struct and type for a AuditLog.User.Added

Provides struct and type for a AuditLog.User.Added.Data

Provides struct and type for a AuditLog.User.Deleted

Provides struct and type for a AuditLog.User.Updated

Provides struct and type for a AuditLog.User.Updated.ChangesRequested

Provides API endpoint related to audit logs

Provides API endpoints related to batch

Provides struct and type for a Batch.Errors

Provides struct and type for a Batch.ErrorsData

Provides struct and type for a Batch.ListResponse

Provides struct and type for a Batch.RequestCounts

Provides struct and type for a Certificate

Provides struct and type for a Certificate.CertificateDetails

Provides struct and type for a Certificate.DeleteResponse

Provides struct and type for a Certificate.ListResponse

Provides struct and type for a Certificate.ToggleRequest

Provides struct and type for a Certificate.UpdateRequest

Provides struct and type for a Certificate.UploadRequest

Provides API endpoints related to certificates

Provides API endpoints related to chat

Provides struct and type for a Chat.Completion.CreateRequest

Provides struct and type for a Chat.Completion.CreateRequest.Audio

Provides struct and type for a Chat.Completion.CreateRequest.LogitBias

Provides struct and type for a Chat.Completion.CreateResponse

Provides struct and type for a Chat.Completion.CreateResponse.Choice

Provides struct and type for a Chat.Completion.CreateResponse.Choice.Logprobs

Provides struct and type for a Chat.Completion.Deleted

Provides struct and type for a Chat.Completion.Function

Provides struct and type for a Chat.Completion.FunctionCallOption

Provides struct and type for a Chat.Completion.List

Provides struct and type for a Chat.Completion.MessageList

Provides struct and type for a Chat.Completion.MessageListData

Provides struct and type for a Chat.Completion.MessageTool.Call

Provides struct and type for a Chat.Completion.MessageTool.CallChunk

Provides struct and type for a Chat.Completion.MessageTool.CallChunkFunction

Provides struct and type for a Chat.Completion.MessageTool.CallFunction

Provides struct and type for a Chat.Completion.NamedTool.Choice

Provides struct and type for a Chat.Completion.NamedTool.ChoiceFunction

Provides struct and type for a Chat.Completion.PredictionContent

Provides struct and type for a Chat.Completion.Request.AssistantMessage

Provides struct and type for a Chat.Completion.Request.AssistantMessageAudio

Provides struct and type for a Chat.Completion.Request.AssistantMessageFunctionCall

Provides struct and type for a Chat.Completion.Request.DeveloperMessage

Provides struct and type for a Chat.Completion.Request.FunctionMessage

Provides struct and type for a Chat.Completion.Request.SystemMessage

Provides struct and type for a Chat.Completion.Request.ToolMessage

Provides struct and type for a Chat.Completion.Request.UserMessage

Provides struct and type for a Chat.Completion.Response.Message

Provides struct and type for a Chat.Completion.Stream.CreateResponse

Provides struct and type for a Chat.Completion.Stream.CreateResponse.Choice

Provides struct and type for a Chat.Completion.Stream.CreateResponse.ChoiceLogprobs

Provides struct and type for a Chat.Completion.Stream.Options

Provides struct and type for a Chat.Completion.Stream.ResponseDelta

Provides struct and type for a Chat.Completion.Stream.ResponseDelta.FunctionCall

Provides struct and type for a Chat.Completion.TokenLogprob

Provides struct and type for a Chat.Completion.TokenLogprobTopLogprobs

Provides struct and type for a Chat.Completion.Tool

Provides struct and type for a Chat.Message

Module responsible for making requests to the OpenAI API. And transforming the response to the expected response type.

Module for transforming lists to expected types.

Module for transforming streaming responses.

Provides struct and type for a Client.Stream.Error

Module for transforming maps to expected structs.

Module for transforming values to expected types.

Provides struct and type for a Completion.CreateRequest

Provides struct and type for a Completion.CreateRequest.LogitBias

Provides struct and type for a Completion.CreateResponse

Provides struct and type for a Completion.CreateResponse.Choice

Provides struct and type for a Completion.CreateResponse.Choice.Logprobs

Provides struct and type for a Completion.CreateResponse.Choice.LogprobsTopLogprobs

Provides struct and type for a Completion.Usage

Provides struct and type for a Completion.UsageCompletionTokensDetails

Provides struct and type for a Completion.UsagePromptTokensDetails

Provides API endpoint related to completions

Module responsible for managing the configuration of the OpenAI API client.

Provides struct and type for a Embedding

Provides struct and type for a Embedding.CreateRequest

Provides struct and type for a Embedding.CreateResponse

Provides struct and type for a Embedding.CreateResponse.Usage

Provides API endpoint related to embeddings

Provides struct and type for generic Error

Provides struct and type for a ErrorResponse

Provides struct and type for a Eval

Provides struct and type for a Eval.ApiError

Provides struct and type for a Eval.Completions.RunDataSource.Create

Provides struct and type for a Eval.Completions.RunDataSource.CreateSamplingParams

Provides struct and type for a Eval.CustomDataSource.Config

Provides struct and type for a Eval.CustomDataSource.Config.Create

Provides struct and type for a Eval.InputMessage.ItemReference

Provides struct and type for a Eval.InputMessage.Simple

Provides struct and type for a Eval.InputMessage.Template

Provides struct and type for a Eval.Item

Provides struct and type for a Eval.Jsonl.File.ContentSource

Provides struct and type for a Eval.Jsonl.File.ContentSource.Content

Provides struct and type for a Eval.Jsonl.File.IdSource

Provides struct and type for a Eval.Jsonl.RunDataSource.Create

Provides struct and type for a Eval.LabelModelGrader

Provides struct and type for a Eval.LabelModelGrader.Create

Provides struct and type for a Eval.List

Provides struct and type for a Eval.LogsDataSource.Config.Create

Provides struct and type for a Eval.PythonGrader

Provides struct and type for a Eval.RequestCreate

Provides struct and type for a Eval.Responses.RunDataSource.Create

Provides struct and types for a Eval.Responses.RunDataSource.CreateInputMessage

Provides struct and type for a Eval.Responses.RunDataSource.CreateSamplingParams

Provides struct and type for a Eval.Responses.Source

Provides struct and type for a Eval.Run

Provides struct and type for a Eval.Run.CreateRequest

Provides struct and type for a Eval.Run.List

Provides struct and type for a Eval.Run.OutputItem

Provides struct and type for a Eval.Run.OutputItem.List

Provides struct and type for a Eval.Run.OutputItem.Sample

Provides struct and type for a Eval.Run.OutputItem.Sample.Input

Provides struct and type for a Eval.Run.OutputItem.Sample.Output

Provides struct and type for a Eval.Run.OutputItem.Sample.Usage

Provides struct and type for a Eval.Run.PerModelUsage

Provides struct and type for a Eval.Run.PerTestingCriteriaResult

Provides struct and type for a Eval.Run.ResultCounts

Provides struct and type for a Eval.ScoreModelGrader

Provides struct and type for a Eval.StoredCompletions.DataSourceConfig

Provides struct and type for a Eval.StoredCompletions.Source

Provides struct and type for a Eval.StringCheckGrader

Provides struct and type for a Eval.TextSimilarityGrader

Provides API endpoints related to evals

Provides struct and type for a File

Provides struct and type for a File.CitationBody

Provides struct and type for a File.CreateRequest

Provides struct and type for a File.DeleteResponse

Provides struct and type for a File.ListResponse

Provides struct and type for a File.Path

Provides API endpoints related to files

Provides API endpoints related to fine tuning

Provides struct and type for a FineTuning.CheckpointPermission

Provides struct and type for a FineTuning.CheckpointPermission.CreateRequest

Provides struct and type for a FineTuning.CheckpointPermission.DeleteResponse

Provides struct and type for a FineTuning.CheckpointPermission.ListResponse

Provides struct and type for a FineTuning.DPOMethod

Provides struct and type for a FineTuning.DPOMethod.Hyperparameters

Provides struct and type for a FineTuning.Integration

Provides struct and type for a FineTuning.Integration.Wandb

Provides struct and type for a FineTuning.Job

Provides struct and type for a FineTuning.Job.Checkpoint

Provides struct and type for a FineTuning.Job.Checkpoint.ListResponse

Provides struct and type for a FineTuning.Job.Checkpoint.Metrics

Provides struct and type for a FineTuning.Job.CreateRequest

Provides struct and type for a FineTuning.Job.CreateRequest.Hyperparameters

Provides struct and type for a FineTuning.Job.CreateRequest.Integrations

Provides struct and type for a FineTuning.Job.CreateRequest.IntegrationsWandb

Provides struct and type for a FineTuning.Job.Error

Provides struct and type for a FineTuning.Job.Event

Provides struct and type for a FineTuning.Job.Event.ListResponse

Provides struct and type for a FineTuning.Job.Hyperparameters

Provides struct and type for a FineTuning.Job.ListResponse

Provides struct and type for a FineTuning.Method

Provides struct and type for a FineTuning.SupervisedMethod

Provides struct and type for a FineTuning.SupervisedMethod.Hyperparameters

Provides struct and type for a Function

Provides struct and type for a Image

Provides struct and type for a Image.CreateRequest

Provides struct and type for a Image.EditCreateRequest

Provides struct and type for a Image.Response

Provides struct and type for a Image.Response.Usage

Provides struct and type for a Image.Response.UsageInputTokensDetails

Provides struct and type for a Image.VariationCreateRequest

Provides API endpoints related to images

Provides struct and type for a Invite

Provides struct and type for a Invite.DeleteResponse

Provides struct and type for a Invite.ListResponse

Provides struct and type for a Invite.Projects

Provides struct and type for a Invite.Request

Provides struct and type for a Invite.RequestProjects

Provides API endpoints related to invites

Provides struct and type for a Message

Provides struct and type for a Message.Attachment

Provides struct and type for a Message.Content.Image.File

Provides struct and type for a Message.Content.Image.FileImageFile

Provides struct and type for a Message.Content.Image.Url

Provides struct and type for a Message.Content.Image.UrlImageUrl

Provides struct and type for a Message.Content.Refusal

Provides struct and type for a Message.Content.Text

Provides struct and type for a Message.Content.Text.AnnotationsFileCitation

Provides struct and type for a Message.Content.Text.AnnotationsFileCitationFileCitation

Provides struct and type for a Message.Content.Text.AnnotationsFilePath

Provides struct and type for a Message.Content.Text.AnnotationsFilePathFilePath

Provides struct and type for a Message.Content.Text.Text

Provides struct and type for a Message.CreateRequest

Provides struct and type for a Message.CreateRequest.Attachment

Provides struct and type for a Message.DeleteResponse

MessageDeltaObject: type: object title: Message delta object description: |

MessageDeltaContentImageFileObject: title: Image file type: object description: References an image File in the content of a message. properties

Provides struct and type for a Message.Delta.Content.Image.FileImageFile

MessageDeltaContentImageUrlObject: title: Image URL type: object description: References an image URL in the content of a message. properties

Provides struct and type for a Message.Delta.Content.Image.UrlImageUrl

MessageDeltaContentTextObject: title: Text type: object description: The text content that is part of a message. properties

MessageDeltaContentTextAnnotationsFileCitationObject: title: File citation type: object description: A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files. properties

Provides struct and type for a Message.Delta.Content.Text.Annotations.FileCitation.FileCitation

MessageDeltaContentTextAnnotationsFilePathObject: title: File path type: object description: A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file. properties

Provides struct and type for a Message.Delta.Content.Text.Annotations.FilePath.FilePath

Provides struct and type for a Message.Delta.Content.Text.Text

Provides struct and type for a Message.Delta.Delta

Provides struct and type for a Message.IncompleteDetails

Provides struct and type for a Message.ListResponse

Provides struct and type for a Message.UpdateRequest

Provides struct and type for a Metadata

Mocks for Assistant schema

Mocks for audio related responses.

Mocks for batch related responses.

Mocks for chat completion related responses.

Mocks for completion related responses.

Mocks for embedding related responses.

Mocks for file related responses.

Mocks for fine tuning related responses.

Mocks for function related responses.

Mocks for image related responses.

Mocks for message related responses.

Mocks for message delta related responses.

Mocks for model related responses.

Mocks for moderation related responses.

Mocks for run related responses.

Mocks for run step delta related responses.

Mocks for thread related responses.

Mocks for truncation related responses.

Mocks for vector store related responses.

Mocks for vector store file related responses.

Mocks for vector store file batch related responses.

Provides struct and type for a Model

Provides struct and type for a Model.DeleteResponse

Provides struct and type for a Model.ListResponse

Provides API endpoints related to models

Provides struct and type for a Moderation.CreateRequest

Provides struct and type for a Moderation.CreateResponse

Provides struct and type for a Moderation.CreateResponse.Result

Provides struct and type for a Moderation.CreateResponse.Result.Categories

Provides struct and type for a Moderation.CreateResponse.Result.CategoryAppliedInputTypes

Provides struct and type for a Moderation.CreateResponse.Result.CategoryScores

Provides API endpoint related to moderations

Provides API endpoints related to operations

Provides struct and type for a Project

Provides struct and type for a Project.ApiKey

Provides struct and type for a Project.ApiKey.DeleteResponse

Provides struct and type for a Project.ApiKey.ListResponse

Provides struct and type for a Project.ApiKey.Owner

Provides struct and type for a Project.CreateRequest

Provides struct and type for a Project.ListResponse

Provides struct and type for a Project.RateLimit

Provides struct and type for a Project.RateLimitListResponse

Provides struct and type for a Project.RateLimitUpdateRequest

Provides struct and type for a Project.ServiceAccount

Provides struct and type for a Project.ServiceAccount.ApiKey

Provides struct and type for a Project.ServiceAccount.CreateRequest

Provides struct and type for a Project.ServiceAccount.CreateResponse

Provides struct and type for a Project.ServiceAccount.DeleteResponse

Provides struct and type for a Project.ServiceAccount.ListResponse

Provides struct and type for a Project.UpdateRequest

Provides struct and type for a Project.User

Provides struct and type for a Project.User.CreateRequest

Provides struct and type for a Project.User.DeleteResponse

Provides struct and type for a Project.User.ListResponse

Provides struct and type for a Project.User.UpdateRequest

Provides API endpoints related to projects

Provides API endpoints related to realtime

Provides struct and type for a Realtime.Session.CreateRequest

Provides struct and type for a Realtime.Session.CreateRequest.InputAudioNoiseReduction

Provides struct and type for a Realtime.Session.CreateRequest.InputAudioTranscription

Provides struct and type for a Realtime.Session.CreateRequest.Tool

Provides struct and type for a Realtime.Session.CreateRequest.TurnDetection

Provides struct and type for a Realtime.Session.CreateResponse

Provides struct and type for a Realtime.Session.CreateResponse.ClientSecret

Provides struct and type for a Realtime.Session.CreateResponse.InputAudioTranscription

Provides struct and type for a Realtime.Session.CreateResponse.Tool

Provides struct and type for a Realtime.Session.CreateResponse.TurnDetection

Provides struct and type for a Realtime.TranscriptionSession.CreateRequest

Provides struct and type for a Realtime.TranscriptionSession.CreateRequest.InputAudioNoiseReduction

Provides struct and type for a Realtime.TranscriptionSession.CreateRequest.InputAudioTranscription

Provides struct and type for a Realtime.TranscriptionSession.CreateRequest.TurnDetection

Provides struct and type for a Realtime.TranscriptionSession.CreateResponse

Provides struct and type for a Realtime.TranscriptionSession.CreateResponse.ClientSecret

Provides struct and type for a Realtime.TranscriptionSession.CreateResponse.InputAudioTranscription

Provides struct and type for a Realtime.TranscriptionSession.CreateResponse.TurnDetection

Provides struct and type for a ResError

Provides struct and type for a Response

Provides struct and type for a Response.Audio.DeltaEvent

Provides struct and type for a Response.Audio.DoneEvent

Provides struct and type for a Response.Audio.Transcript.DeltaEvent

Provides struct and type for a Response.Audio.Transcript.DoneEvent

Provides struct and type for a Response.CodeInterpreter.Call.Code.DeltaEvent

Provides struct and type for a Response.CodeInterpreter.Call.Code.DoneEvent

Provides struct and type for a Response.CodeInterpreter.Call.CompletedEvent

Provides struct and type for a Response.CodeInterpreter.Call.InProgressEvent

Provides struct and type for a Response.CodeInterpreter.Call.InterpretingEvent

Provides struct and type for a Response.CodeInterpreter.FileOutput

Provides struct and type for a Response.CodeInterpreter.FileOutputFile

Provides struct and type for a Response.CodeInterpreter.TextOutput

Provides struct and type for a Response.CodeInterpreter.ToolCall

Provides struct and type for a Response.CompletedEvent

Provides struct and type for a Response.Computer.Click

Provides struct and type for a Response.Computer.Coordinate

Provides struct and type for a Response.Computer.DoubleClick

Provides struct and type for a Response.Computer.Drag

Provides struct and type for a Response.Computer.KeyPress

Provides struct and type for a Response.Computer.Move

Provides struct and type for a Response.Computer.Screenshot

Provides struct and type for a Response.Computer.ScreenshotImage

Provides struct and type for a Response.Computer.Scroll

Provides struct and type for a Response.Computer.ToolCall

Provides struct and type for a Response.Computer.ToolCall.OutputResource

Provides struct and type for a Response.Computer.ToolCall.SafetyCheck

Provides struct and type for a Response.Computer.Type

Provides struct and type for a Response.Computer.UsePreviewTool

Provides struct and type for a Response.Computer.Wait

Provides struct and type for a Response.ContentPart.AddedEvent

Provides struct and type for a Response.ContentPart.DoneEvent

Provides struct and type for a Response.Create

Provides struct and type for a Response.CreatedEvent

Provides struct and type for a Response.Error

Provides struct and type for a Response.ErrorEvent

Provides struct and type for a Response.FailedEvent

Provides struct and type for a Response.FileSearch.Call.CompletedEvent

Provides struct and type for a Response.FileSearch.Call.InProgressEvent

Provides struct and type for a Response.FileSearch.Call.SearchingEvent

Provides struct and type for a Response.FileSearch.RankingOptions

Provides struct and type for a Response.FileSearch.Tool

Provides struct and type for a Response.FileSearch.Tool.Call

Provides struct and type for a Response.FileSearch.Tool.CallResult

Provides struct and type for a Response.FileSearch.Tool.RankingOptions

Provides struct and type for a Response.Format.Json

Provides struct and type for a Response.Format.JsonSchema

Provides struct and type for a Response.Format.Text

Provides struct and type for a Response.Function.Call.ArgumentsDeltaEvent

Provides struct and type for a Response.Function.Call.ArgumentsDoneEvent

Provides struct and type for a Response.Function.Tool

Provides struct and type for a Response.Function.ToolCall

Provides struct and type for a Response.Function.ToolCall.OutputResource

Provides struct and type for a Response.Function.ToolCall.Resource

Provides struct and type for a Response.Function.ToolParameters

Provides struct and type for a Response.InProgressEvent

Provides struct and type for a Response.IncompleteDetails

Provides struct and type for a Response.IncompleteEvent

Provides struct and type for a Response.Input.FileContent

Provides struct and type for a Response.Input.ImageContent

Provides struct and type for a Response.Input.MessageEasy

Provides struct and type for a Response.Input.MessageResource

Provides struct and type for a Response.Input.TextContent

Provides struct and type for a Response.ItemList

Provides struct and type for a Response.JSONSchema

Provides struct and type for a Response.Output.Item.AddedEvent

Provides struct and type for a Response.Output.Item.DoneEvent

Provides struct and type for a Response.Output.Message

Provides struct and type for a Response.Output.Text

Provides struct and type for a Response.Output.TextContent

Provides struct and type for a Response.Reasoning

Provides struct and type for a Response.Reasoning.Item

Provides struct and type for a Response.Reasoning.Item.Summary

Provides struct and type for a Response.Reasoning.Summary.Part.AddedEvent

Provides struct and type for a Response.Reasoning.Summary.Part.AddedEventPart

Provides struct and type for a Response.Reasoning.Summary.Part.DoneEvent

Provides struct and type for a Response.Reasoning.Summary.Part.DoneEventPart

Provides struct and type for a Response.Reasoning.Summary.Text.DeltaEvent

Provides struct and type for a Response.Reasoning.Summary.Text.DoneEvent

Provides struct and type for a Response.Refusal.Content

Provides struct and type for a Response.Refusal.DeltaEvent

Provides struct and type for a Response.Refusal.DoneEvent

Provides struct and type for a Response.Text.AnnotationDeltaEvent

Provides struct and type for a Response.Text.DeltaEvent

Provides struct and type for a Response.Text.DoneEvent

Provides struct and type for a Response.UrlCitationBody

Provides struct and type for a Response.Usage

Provides struct and type for a Response.Usage.InputTokensDetails

Provides struct and type for a Response.Usage.OutputTokensDetails

Provides struct and type for a Response.WebSearch

Provides struct and type for a Response.WebSearch.Call.CompletedEvent

Provides struct and type for a Response.WebSearch.Call.InProgressEvent

Provides struct and type for a Response.WebSearch.Call.SearchingEvent

Provides struct and type for a Response.WebSearch.Location

Provides struct and type for a Response.WebSearch.PreviewTool

Provides struct and type for a Response.WebSearch.ToolCall

Provides struct and type for a Response.WebSearch.UserLocation

Provides API endpoints related to responses

Provides struct and type for a Run

Provides struct and type for a Run.CompletionUsage

Provides struct and type for a Run.CreateRequest

Provides struct and type for a Run.IncompleteDetails

Provides struct and type for a Run.LastError

Provides struct and type for a Run.ListResponse

Provides struct and type for a Run.RequiredAction

Provides struct and type for a Run.RequiredAction.SubmitToolOutputs

Provides struct and type for a Run.Step

Provides struct and type for a Run.Step.CompletionUsage

RunStepDeltaObject: type: object title: Run step delta object description: |

Provides struct and type for a Run.Step.Delta.Delta

Provides struct and type for a Run.Step.Delta.Step.DetailsMessageCreation

Provides struct and type for a Run.Step.Delta.Step.DetailsMessageCreationMessageCreation

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCalls

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCode

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeCodeInterpreter

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutput

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputImage

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputImageImage

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsCodeOutputLogs

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsFileSearch

Provides struct and type for a Run.Step.Delta.Step.DetailsToolCallsFunction

Provides struct and type for a Run.Step.DetailsMessageCreation

Provides struct and type for a Run.Step.DetailsMessageCreationMessageCreation

Provides struct and type for a Run.Step.DetailsToolCalls

Provides struct and type for a Run.Step.DetailsToolCallsCode

Provides struct and type for a Run.Step.DetailsToolCallsCodeCodeInterpreter

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputImage

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputImageImage

Provides struct and type for a Run.Step.DetailsToolCallsCodeOutputLogs

Provides struct and type for a Run.Step.DetailsToolCallsFileSearch

Provides struct and type for a Run.Step.DetailsToolCallsFileSearchFileSearch

Provides struct and type for a Run.Step.DetailsToolCallsFileSearchRankingOptions

Provides struct and type for a Run.Step.DetailsToolCallsFileSearchResult

Provides struct and type for a Run.Step.DetailsToolCallsFileSearchResultContent

Provides struct and type for a Run.Step.DetailsToolCallsFunction

Provides struct and type for a Run.Step.DetailsToolCallsFunctionFunction

Provides struct and type for a Run.Step.LastError

Provides struct and type for a Run.Step.ListResponse

Provides struct and type for a Run.ToolCall

Provides struct and type for a Run.ToolCall.Function

Provides struct and type for a Run.UpdateRequest

Provides struct and type for a TextResponseFormatJsonSchema

Provides struct and type for a Thread

Provides struct and type for a Thread.CreateAndRunRequest

Provides struct and type for a Thread.CreateAndRunRequest.ToolResources

Provides struct and type for a Thread.CreateAndRunRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.CreateAndRunRequest.ToolResourcesFileSearch

Provides struct and type for a Thread.CreateRequest

Provides struct and type for a Thread.CreateRequest.ToolResources

Provides struct and type for a Thread.CreateRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.DeleteResponse

Provides struct and type for a Thread.ToolResources

Provides struct and type for a Thread.ToolResources.CodeInterpreter

Provides struct and type for a Thread.ToolResources.FileSearch

Provides struct and type for a Thread.UpdateRequest

Provides struct and type for a Thread.UpdateRequest.ToolResources

Provides struct and type for a Thread.UpdateRequest.ToolResourcesCodeInterpreter

Provides struct and type for a Thread.UpdateRequest.ToolResourcesFileSearch

Provides struct and type for a Tool.Choice.Function

Provides struct and type for a Tool.Choice.Types

Provides struct and type for a Tool.Filter.Comparison

Provides struct and type for a Tool.Filter.Compound

Provides struct and type for a Truncation

Provides struct and type for a Upload

Provides struct and type for a Upload.AddPartRequest

Provides struct and type for a Upload.CompleteRequest

Provides struct and type for a Upload.CreateRequest

Provides struct and type for a Upload.Part

Provides API endpoints related to uploads

Provides API endpoints related to usage

Provides struct and type for a Usage.AudioSpeeches.Result

Provides struct and type for a Usage.AudioTranscriptions.Result

Provides struct and type for a Usage.CodeInterpreterSessions.Result

Provides struct and type for a Usage.Completions.Result

Provides struct and type for a Usage.Costs.Result

Provides struct and type for a Usage.Costs.ResultAmount

Provides struct and type for a Usage.Embeddings.Result

Provides struct and type for a Usage.Image.Result

Provides struct and type for a Usage.Moderations.Result

Provides struct and type for a Usage.Response

Provides struct and type for a Usage.TimeBucket

Provides struct and type for a Usage.VectorStore.Result

Provides struct and type for a User

Provides struct and type for a User.ApproximateLocation

Provides struct and type for a User.DeleteResponse

Provides struct and type for a User.ListResponse

Provides struct and type for a User.Role.UpdateRequest

Provides API endpoints related to users

Provides struct and type for a VectorStore

Provides struct and type for a VectorStore.CreateRequest

Provides struct and type for a VectorStore.DeleteResponse

Provides struct and type for a VectorStore.ExpirationAfter

Provides struct and type for a VectorStore.File

Provides struct and type for a VectorStore.File.Attributes

Provides struct and type for a VectorStore.File.AttributesUpdateRequest

Provides struct and type for a VectorStore.File.Batch

Provides struct and type for a VectorStore.File.Batch.CreateRequest

Provides struct and type for a VectorStore.File.Batch.FileCounts

Provides struct and type for a VectorStore.File.ChunkingStrategy.Auto.RequestParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Other.ResponseParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static.RequestParam

Provides struct and type for a VectorStore.File.ChunkingStrategy.Static.ResponseParam

Provides struct and type for a VectorStore.File.ContentResponse

Provides struct and type for a VectorStore.File.ContentResponseData

Provides struct and type for a VectorStore.File.Counts

Provides struct and type for a VectorStore.File.CreateRequest

Provides struct and type for a VectorStore.File.DeleteResponse

Provides struct and type for a VectorStore.File.LastError

Provides struct and type for a VectorStore.File.ListResponse

Provides struct and type for a VectorStore.ListResponse

Provides struct and type for a VectorStore.SearchRequest

Provides struct and type for a VectorStore.SearchRequest.RankingOptions

Provides struct and type for a VectorStore.SearchResult.Content

Provides struct and type for a VectorStore.SearchResult.Item

Provides struct and type for a VectorStore.SearchResult.Page

Provides struct and type for a VectorStore.UpdateRequest

Provides API endpoints related to vector stores