# Shared Params Types
- shared.ChatModel
- shared.ComparisonFilterParam
- shared.CompoundFilterParam
- shared.FunctionDefinitionParam
- shared.FunctionParameters
- shared.Metadata
- shared.ReasoningParam
- shared.ReasoningEffort
- shared.ResponseFormatJSONObjectParam
- shared.ResponseFormatJSONSchemaParam
- shared.ResponseFormatTextParam
- shared.ResponsesModel
# Shared Response Types
- shared.ChatModel
- shared.ComparisonFilter
- shared.CompoundFilter
- shared.Metadata
- shared.Reasoning
- shared.ReasoningEffort
- shared.ResponseFormatJSONObject
- shared.ResponseFormatText
- shared.ResponsesModel
# Completions
Response Types:
- openai.Completion
- openai.CompletionChoice
- openai.CompletionUsage
Methods:
- client.Completions.New(ctx context.Context, body openai.CompletionNewParams) (openai.Completion, error)
# Chat
## Completions
Params Types:
- openai.ChatCompletionAssistantMessageParam
- openai.ChatCompletionAudioParam
- openai.ChatCompletionContentPartUnionParam
- openai.ChatCompletionContentPartImageParam
- openai.ChatCompletionContentPartInputAudioParam
- openai.ChatCompletionContentPartRefusalParam
- openai.ChatCompletionContentPartTextParam
- openai.ChatCompletionDeveloperMessageParam
- openai.ChatCompletionFunctionCallOptionParam
- openai.ChatCompletionFunctionMessageParam
- openai.ChatCompletionMessageParamUnion
- openai.ChatCompletionMessageToolCallParam
- openai.ChatCompletionNamedToolChoiceParam
- openai.ChatCompletionPredictionContentParam
- openai.ChatCompletionStreamOptionsParam
- openai.ChatCompletionSystemMessageParam
- openai.ChatCompletionToolParam
- openai.ChatCompletionToolChoiceOptionUnionParam
- openai.ChatCompletionToolMessageParam
- openai.ChatCompletionUserMessageParam
Response Types:
- openai.ChatCompletion
- openai.ChatCompletionAudio
- openai.ChatCompletionChunk
- openai.ChatCompletionDeleted
- openai.ChatCompletionMessage
- openai.ChatCompletionMessageToolCall
- openai.ChatCompletionStoreMessage
- openai.ChatCompletionTokenLogprob
Methods:
- client.Chat.Completions.New(ctx context.Context, body openai.ChatCompletionNewParams) (openai.ChatCompletion, error)
- client.Chat.Completions.Get(ctx context.Context, completionID string) (openai.ChatCompletion, error)
- client.Chat.Completions.Update(ctx context.Context, completionID string, body openai.ChatCompletionUpdateParams) (openai.ChatCompletion, error)
- client.Chat.Completions.List(ctx context.Context, query openai.ChatCompletionListParams) (pagination.CursorPage[openai.ChatCompletion], error)
- client.Chat.Completions.Delete(ctx context.Context, completionID string) (openai.ChatCompletionDeleted, error)
### Messages
Methods:
- client.Chat.Completions.Messages.List(ctx context.Context, completionID string, query openai.ChatCompletionMessageListParams) (pagination.CursorPage[openai.ChatCompletionStoreMessage], error)
# Embeddings
Params Types:
- openai.EmbeddingModel
Response Types:
- openai.CreateEmbeddingResponse
- openai.Embedding
Methods:
- client.Embeddings.New(ctx context.Context, body openai.EmbeddingNewParams) (openai.CreateEmbeddingResponse, error)
# Files
Params Types:
- openai.FilePurpose
Response Types:
- openai.FileDeleted
- openai.FileObject
Methods:
- client.Files.New(ctx context.Context, body openai.FileNewParams) (openai.FileObject, error)
- client.Files.Get(ctx context.Context, fileID string) (openai.FileObject, error)
- client.Files.List(ctx context.Context, query openai.FileListParams) (pagination.CursorPage[openai.FileObject], error)
- client.Files.Delete(ctx context.Context, fileID string) (openai.FileDeleted, error)
- client.Files.Content(ctx context.Context, fileID string) (http.Response, error)
# Images
Params Types:
- openai.ImageModel
Response Types:
- openai.Image
- openai.ImagesResponse
Methods:
- client.Images.NewVariation(ctx context.Context, body openai.ImageNewVariationParams) (openai.ImagesResponse, error)
- client.Images.Edit(ctx context.Context, body openai.ImageEditParams) (openai.ImagesResponse, error)
- client.Images.Generate(ctx context.Context, body openai.ImageGenerateParams) (openai.ImagesResponse, error)
# Audio
Params Types:
- openai.AudioModel
- openai.AudioResponseFormat
## Transcriptions
Params Types:
- openai.TranscriptionInclude
Response Types:
- openai.Transcription
- openai.TranscriptionStreamEventUnion
- openai.TranscriptionTextDeltaEvent
- openai.TranscriptionTextDoneEvent
Methods:
- client.Audio.Transcriptions.New(ctx context.Context, body openai.AudioTranscriptionNewParams) (Transcription, error)
## Translations
Response Types:
- openai.Translation
Methods:
- client.Audio.Translations.New(ctx context.Context, body openai.AudioTranslationNewParams) (Translation, error)
## Speech
Params Types:
- openai.SpeechModel
Methods:
- client.Audio.Speech.New(ctx context.Context, body openai.AudioSpeechNewParams) (http.Response, error)
# Moderations
Params Types:
- openai.ModerationImageURLInputParam
- openai.ModerationModel
- openai.ModerationMultiModalInputUnionParam
- openai.ModerationTextInputParam
Response Types:
- openai.Moderation
- openai.ModerationNewResponse
Methods:
- client.Moderations.New(ctx context.Context, body openai.ModerationNewParams) (openai.ModerationNewResponse, error)
# Models
Response Types:
- openai.Model
- openai.ModelDeleted
Methods:
- client.Models.Get(ctx context.Context, model string) (openai.Model, error)
- client.Models.List(ctx context.Context) (pagination.Page[openai.Model], error)
- client.Models.Delete(ctx context.Context, model string) (openai.ModelDeleted, error)
# FineTuning
## Methods
Params Types:
- openai.DpoHyperparameters
- openai.DpoMethodParam
- openai.ReinforcementHyperparameters
- openai.ReinforcementMethodParam
- openai.SupervisedHyperparameters
- openai.SupervisedMethodParam
Response Types:
- openai.DpoHyperparametersResp
- openai.DpoMethod
- openai.ReinforcementHyperparametersResp
- openai.ReinforcementMethod
- openai.SupervisedHyperparametersResp
- openai.SupervisedMethod
## Jobs
Response Types:
- openai.FineTuningJob
- openai.FineTuningJobEvent
- openai.FineTuningJobWandbIntegration
- openai.FineTuningJobWandbIntegrationObject
Methods:
- client.FineTuning.Jobs.New(ctx context.Context, body openai.FineTuningJobNewParams) (openai.FineTuningJob, error)
- client.FineTuning.Jobs.Get(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
- client.FineTuning.Jobs.List(ctx context.Context, query openai.FineTuningJobListParams) (pagination.CursorPage[openai.FineTuningJob], error)
- client.FineTuning.Jobs.Cancel(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
- client.FineTuning.Jobs.ListEvents(ctx context.Context, fineTuningJobID string, query openai.FineTuningJobListEventsParams) (pagination.CursorPage[openai.FineTuningJobEvent], error)
- client.FineTuning.Jobs.Pause(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
- client.FineTuning.Jobs.Resume(ctx context.Context, fineTuningJobID string) (openai.FineTuningJob, error)
### Checkpoints
Response Types:
- openai.FineTuningJobCheckpoint
Methods:
- client.FineTuning.Jobs.Checkpoints.List(ctx context.Context, fineTuningJobID string, query openai.FineTuningJobCheckpointListParams) (pagination.CursorPage[openai.FineTuningJobCheckpoint], error)
## Checkpoints
### Permissions
Response Types:
- openai.FineTuningCheckpointPermissionNewResponse
- openai.FineTuningCheckpointPermissionGetResponse
- openai.FineTuningCheckpointPermissionDeleteResponse
Methods:
- client.FineTuning.Checkpoints.Permissions.New(ctx context.Context, fineTunedModelCheckpoint string, body openai.FineTuningCheckpointPermissionNewParams) (pagination.Page[openai.FineTuningCheckpointPermissionNewResponse], error)
- client.FineTuning.Checkpoints.Permissions.Get(ctx context.Context, fineTunedModelCheckpoint string, query openai.FineTuningCheckpointPermissionGetParams) (openai.FineTuningCheckpointPermissionGetResponse, error)
- client.FineTuning.Checkpoints.Permissions.Delete(ctx context.Context, permissionID string, body openai.FineTuningCheckpointPermissionDeleteParams) (openai.FineTuningCheckpointPermissionDeleteResponse, error)
## Alpha
### Graders
Response Types:
- openai.FineTuningAlphaGraderRunResponse
- openai.FineTuningAlphaGraderValidateResponse
Methods:
- client.FineTuning.Alpha.Graders.Run(ctx context.Context, body openai.FineTuningAlphaGraderRunParams) (openai.FineTuningAlphaGraderRunResponse, error)
- client.FineTuning.Alpha.Graders.Validate(ctx context.Context, body openai.FineTuningAlphaGraderValidateParams) (openai.FineTuningAlphaGraderValidateResponse, error)
# Graders
## GraderModels
Params Types:
- openai.LabelModelGraderParam
- openai.MultiGraderParam
- openai.PythonGraderParam
- openai.ScoreModelGraderParam
- openai.StringCheckGraderParam
- openai.TextSimilarityGraderParam
Response Types:
- openai.LabelModelGrader
- openai.MultiGrader
- openai.PythonGrader
- openai.ScoreModelGrader
- openai.StringCheckGrader
- openai.TextSimilarityGrader
# VectorStores
Params Types:
- openai.AutoFileChunkingStrategyParam
- openai.FileChunkingStrategyParamUnion
- openai.StaticFileChunkingStrategyParam
- openai.StaticFileChunkingStrategyObjectParam
Response Types:
- openai.FileChunkingStrategyUnion
- openai.OtherFileChunkingStrategyObject
- openai.StaticFileChunkingStrategy
- openai.StaticFileChunkingStrategyObject
- openai.VectorStore
- openai.VectorStoreDeleted
- openai.VectorStoreSearchResponse
Methods:
- client.VectorStores.New(ctx context.Context, body openai.VectorStoreNewParams) (openai.VectorStore, error)
- client.VectorStores.Get(ctx context.Context, vectorStoreID string) (openai.VectorStore, error)
- client.VectorStores.Update(ctx context.Context, vectorStoreID string, body openai.VectorStoreUpdateParams) (openai.VectorStore, error)
- client.VectorStores.List(ctx context.Context, query openai.VectorStoreListParams) (pagination.CursorPage[openai.VectorStore], error)
- client.VectorStores.Delete(ctx context.Context, vectorStoreID string) (openai.VectorStoreDeleted, error)
- client.VectorStores.Search(ctx context.Context, vectorStoreID string, body openai.VectorStoreSearchParams) (pagination.Page[openai.VectorStoreSearchResponse], error)
## Files
Response Types:
- openai.VectorStoreFile
- openai.VectorStoreFileDeleted
- openai.VectorStoreFileContentResponse
Methods:
- client.VectorStores.Files.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileNewParams) (openai.VectorStoreFile, error)
- client.VectorStores.Files.Get(ctx context.Context, fileID string, query openai.VectorStoreFileGetParams) (openai.VectorStoreFile, error)
- client.VectorStores.Files.Update(ctx context.Context, fileID string, params openai.VectorStoreFileUpdateParams) (openai.VectorStoreFile, error)
- client.VectorStores.Files.List(ctx context.Context, vectorStoreID string, query openai.VectorStoreFileListParams) (pagination.CursorPage[openai.VectorStoreFile], error)
- client.VectorStores.Files.Delete(ctx context.Context, fileID string, body openai.VectorStoreFileDeleteParams) (openai.VectorStoreFileDeleted, error)
- client.VectorStores.Files.Content(ctx context.Context, fileID string, query openai.VectorStoreFileContentParams) (pagination.Page[openai.VectorStoreFileContentResponse], error)
## FileBatches
Response Types:
- openai.VectorStoreFileBatch
Methods:
- client.VectorStores.FileBatches.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileBatchNewParams) (openai.VectorStoreFileBatch, error)
- client.VectorStores.FileBatches.Get(ctx context.Context, batchID string, query openai.VectorStoreFileBatchGetParams) (openai.VectorStoreFileBatch, error)
- client.VectorStores.FileBatches.Cancel(ctx context.Context, batchID string, body openai.VectorStoreFileBatchCancelParams) (openai.VectorStoreFileBatch, error)
- client.VectorStores.FileBatches.ListFiles(ctx context.Context, batchID string, params openai.VectorStoreFileBatchListFilesParams) (pagination.CursorPage[openai.VectorStoreFile], error)
# Beta
# Batches
Response Types:
- openai.Batch
- openai.BatchError
- openai.BatchRequestCounts
Methods:
- client.Batches.New(ctx context.Context, body openai.BatchNewParams) (openai.Batch, error)
- client.Batches.Get(ctx context.Context, batchID string) (openai.Batch, error)
- client.Batches.List(ctx context.Context, query openai.BatchListParams) (pagination.CursorPage[openai.Batch], error)
- client.Batches.Cancel(ctx context.Context, batchID string) (openai.Batch, error)
# Uploads
Response Types:
- openai.Upload
Methods:
- client.Uploads.New(ctx context.Context, body openai.UploadNewParams) (openai.Upload, error)
- client.Uploads.Cancel(ctx context.Context, uploadID string) (openai.Upload, error)
- client.Uploads.Complete(ctx context.Context, uploadID string, body openai.UploadCompleteParams) (openai.Upload, error)
## Parts
Response Types:
- openai.UploadPart
Methods:
- client.Uploads.Parts.New(ctx context.Context, uploadID string, body openai.UploadPartNewParams) (openai.UploadPart, error)
# Responses
Params Types:
- responses.ComputerToolParam
- responses.EasyInputMessageParam
- responses.FileSearchToolParam
- responses.FunctionToolParam
- responses.ResponseComputerToolCallParam
- responses.ResponseComputerToolCallOutputScreenshotParam
- responses.ResponseFileSearchToolCallParam
- responses.ResponseFormatTextConfigUnionParam
- responses.ResponseFormatTextJSONSchemaConfigParam
- responses.ResponseFunctionToolCallParam
- responses.ResponseFunctionWebSearchParam
- responses.ResponseIncludable
- responses.ResponseInputParam
- responses.ResponseInputContentUnionParam
- responses.ResponseInputFileParam
- responses.ResponseInputImageParam
- responses.ResponseInputItemUnionParam
- responses.ResponseInputMessageContentListParam
- responses.ResponseInputTextParam
- responses.ResponseOutputMessageParam
- responses.ResponseOutputRefusalParam
- responses.ResponseOutputTextParam
- responses.ResponseReasoningItemParam
- responses.ResponseTextConfigParam
- responses.ToolUnionParam
- responses.ToolChoiceFunctionParam
- responses.ToolChoiceOptions
- responses.ToolChoiceTypesParam
- responses.WebSearchToolParam
Response Types:
- responses.ComputerTool
- responses.FileSearchTool
- responses.FunctionTool
- responses.Response
- responses.ResponseAudioDeltaEvent
- responses.ResponseAudioDoneEvent
- responses.ResponseAudioTranscriptDeltaEvent
- responses.ResponseAudioTranscriptDoneEvent
- responses.ResponseCodeInterpreterCallCodeDeltaEvent
- responses.ResponseCodeInterpreterCallCodeDoneEvent
- responses.ResponseCodeInterpreterCallCompletedEvent
- responses.ResponseCodeInterpreterCallInProgressEvent
- responses.ResponseCodeInterpreterCallInterpretingEvent
- responses.ResponseCodeInterpreterToolCall
- responses.ResponseCompletedEvent
- responses.ResponseComputerToolCall
- responses.ResponseComputerToolCallOutputItem
- responses.ResponseComputerToolCallOutputScreenshot
- responses.ResponseContentPartAddedEvent
- responses.ResponseContentPartDoneEvent
- responses.ResponseCreatedEvent
- responses.ResponseError
- responses.ResponseErrorEvent
- responses.ResponseFailedEvent
- responses.ResponseFileSearchCallCompletedEvent
- responses.ResponseFileSearchCallInProgressEvent
- responses.ResponseFileSearchCallSearchingEvent
- responses.ResponseFileSearchToolCall
- responses.ResponseFormatTextConfigUnion
- responses.ResponseFormatTextJSONSchemaConfig
- responses.ResponseFunctionCallArgumentsDeltaEvent
- responses.ResponseFunctionCallArgumentsDoneEvent
- responses.ResponseFunctionToolCall
- responses.ResponseFunctionToolCallItem
- responses.ResponseFunctionToolCallOutputItem
- responses.ResponseFunctionWebSearch
- responses.ResponseInProgressEvent
- responses.ResponseIncompleteEvent
- responses.ResponseInputContentUnion
- responses.ResponseInputFile
- responses.ResponseInputImage
- responses.ResponseInputMessageContentList
- responses.ResponseInputMessageItem
- responses.ResponseInputText
- responses.ResponseItemUnion
- responses.ResponseOutputItemUnion
- responses.ResponseOutputItemAddedEvent
- responses.ResponseOutputItemDoneEvent
- responses.ResponseOutputMessage
- responses.ResponseOutputRefusal
- responses.ResponseOutputText
- responses.ResponseReasoningItem
- responses.ResponseReasoningSummaryPartAddedEvent
- responses.ResponseReasoningSummaryPartDoneEvent
- responses.ResponseReasoningSummaryTextDeltaEvent
- responses.ResponseReasoningSummaryTextDoneEvent
- responses.ResponseRefusalDeltaEvent
- responses.ResponseRefusalDoneEvent
- responses.ResponseStatus
- responses.ResponseStreamEventUnion
- responses.ResponseTextAnnotationDeltaEvent
- responses.ResponseTextConfig
- responses.ResponseTextDeltaEvent
- responses.ResponseTextDoneEvent
- responses.ResponseUsage
- responses.ResponseWebSearchCallCompletedEvent
- responses.ResponseWebSearchCallInProgressEvent
- responses.ResponseWebSearchCallSearchingEvent
- responses.ToolUnion
- responses.ToolChoiceFunction
- responses.ToolChoiceOptions
- responses.ToolChoiceTypes
- responses.WebSearchTool
Methods:
- client.Responses.New(ctx context.Context, body responses.ResponseNewParams) (responses.Response, error)
- client.Responses.Get(ctx context.Context, responseID string, query responses.ResponseGetParams) (responses.Response, error)
- client.Responses.Delete(ctx context.Context, responseID string) error
## InputItems
Response Types:
- responses.ResponseItemList
Methods:
- client.Responses.InputItems.List(ctx context.Context, responseID string, query responses.InputItemListParams) (pagination.CursorPage[responses.ResponseItemUnion], error)