mirror of
https://github.com/openai/openai-go.git
synced 2026-04-01 00:57:11 +09:00
82 KiB
82 KiB
Shared Params Types
- shared.ChatModel
- shared.ComparisonFilterParam
- shared.CompoundFilterParam
- shared.FunctionDefinitionParam
- shared.FunctionParameters
- shared.MetadataParam
- shared.ReasoningEffort
- shared.ResponseFormatJSONObjectParam
- shared.ResponseFormatJSONSchemaParam
- shared.ResponseFormatTextParam
Shared Response Types
- shared.ErrorObject
- shared.FunctionDefinition
- shared.FunctionParameters
- shared.Metadata
- shared.ResponseFormatJSONObject
- shared.ResponseFormatJSONSchema
- shared.ResponseFormatText
Completions
Response Types:
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:
Response Types:
Methods:
client.Embeddings.New(ctx context.Context, body openai.EmbeddingNewParams) (openai.CreateEmbeddingResponse, error)
Files
Params Types:
Response Types:
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:
Response Types:
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:
Transcriptions
Response Types:
Methods:
client.Audio.Transcriptions.New(ctx context.Context, body openai.AudioTranscriptionNewParams) (Transcription, error)
Translations
Response Types:
Methods:
client.Audio.Translations.New(ctx context.Context, body openai.AudioTranslationNewParams) (Translation, error)
Speech
Params Types:
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:
Methods:
client.Moderations.New(ctx context.Context, body openai.ModerationNewParams) (openai.ModerationNewResponse, error)
Models
Response Types:
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
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)
Checkpoints
Response Types:
Methods:
client.FineTuning.Jobs.Checkpoints.List(ctx context.Context, fineTuningJobID string, query openai.FineTuningJobCheckpointListParams) (pagination.CursorPage[openai.FineTuningJobCheckpoint], error)
VectorStores
Params Types:
- openai.AutoFileChunkingStrategyParam
- openai.FileChunkingStrategyParamUnion
- openai.StaticFileChunkingStrategyParam
- openai.StaticFileChunkingStrategyObjectParam
Response Types:
- openai.FileChunkingStrategy
- 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:
Methods:
client.VectorStores.Files.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileNewParams) (openai.VectorStoreFile, error)client.VectorStores.Files.Get(ctx context.Context, vectorStoreID string, fileID string) (openai.VectorStoreFile, error)client.VectorStores.Files.Update(ctx context.Context, vectorStoreID string, fileID string, body 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, vectorStoreID string, fileID string) (openai.VectorStoreFileDeleted, error)client.VectorStores.Files.Content(ctx context.Context, vectorStoreID string, fileID string) (pagination.Page[openai.VectorStoreFileContentResponse], error)
FileBatches
Response Types:
Methods:
client.VectorStores.FileBatches.New(ctx context.Context, vectorStoreID string, body openai.VectorStoreFileBatchNewParams) (openai.VectorStoreFileBatch, error)client.VectorStores.FileBatches.Get(ctx context.Context, vectorStoreID string, batchID string) (openai.VectorStoreFileBatch, error)client.VectorStores.FileBatches.Cancel(ctx context.Context, vectorStoreID string, batchID string) (openai.VectorStoreFileBatch, error)client.VectorStores.FileBatches.ListFiles(ctx context.Context, vectorStoreID string, batchID string, query openai.VectorStoreFileBatchListFilesParams) (pagination.CursorPage[openai.VectorStoreFile], error)
Beta
Assistants
Params Types:
- openai.AssistantToolUnionParam
- openai.CodeInterpreterToolParam
- openai.FileSearchToolParam
- openai.FunctionToolParam
Response Types:
- openai.Assistant
- openai.AssistantDeleted
- openai.AssistantStreamEvent
- openai.AssistantTool
- openai.CodeInterpreterTool
- openai.FileSearchTool
- openai.FunctionTool
Methods:
client.Beta.Assistants.New(ctx context.Context, body openai.BetaAssistantNewParams) (openai.Assistant, error)client.Beta.Assistants.Get(ctx context.Context, assistantID string) (openai.Assistant, error)client.Beta.Assistants.Update(ctx context.Context, assistantID string, body openai.BetaAssistantUpdateParams) (openai.Assistant, error)client.Beta.Assistants.List(ctx context.Context, query openai.BetaAssistantListParams) (pagination.CursorPage[openai.Assistant], error)client.Beta.Assistants.Delete(ctx context.Context, assistantID string) (openai.AssistantDeleted, error)
Threads
Params Types:
- openai.AssistantResponseFormatOptionUnionParam
- openai.AssistantToolChoiceParam
- openai.AssistantToolChoiceFunctionParam
- openai.AssistantToolChoiceOptionUnionParam
Response Types:
- openai.AssistantResponseFormatOptionUnion
- openai.AssistantToolChoice
- openai.AssistantToolChoiceFunction
- openai.AssistantToolChoiceOptionUnion
- openai.Thread
- openai.ThreadDeleted
Methods:
client.Beta.Threads.New(ctx context.Context, body openai.BetaThreadNewParams) (openai.Thread, error)client.Beta.Threads.Get(ctx context.Context, threadID string) (openai.Thread, error)client.Beta.Threads.Update(ctx context.Context, threadID string, body openai.BetaThreadUpdateParams) (openai.Thread, error)client.Beta.Threads.Delete(ctx context.Context, threadID string) (openai.ThreadDeleted, error)client.Beta.Threads.NewAndRun(ctx context.Context, body openai.BetaThreadNewAndRunParams) (openai.Run, error)
Runs
Response Types:
Methods:
client.Beta.Threads.Runs.New(ctx context.Context, threadID string, params openai.BetaThreadRunNewParams) (openai.Run, error)client.Beta.Threads.Runs.Get(ctx context.Context, threadID string, runID string) (openai.Run, error)client.Beta.Threads.Runs.Update(ctx context.Context, threadID string, runID string, body openai.BetaThreadRunUpdateParams) (openai.Run, error)client.Beta.Threads.Runs.List(ctx context.Context, threadID string, query openai.BetaThreadRunListParams) (pagination.CursorPage[openai.Run], error)client.Beta.Threads.Runs.Cancel(ctx context.Context, threadID string, runID string) (openai.Run, error)client.Beta.Threads.Runs.SubmitToolOutputs(ctx context.Context, threadID string, runID string, body openai.BetaThreadRunSubmitToolOutputsParams) (openai.Run, error)
Steps
Params Types:
Response Types:
- openai.CodeInterpreterLogs
- openai.CodeInterpreterOutputImage
- openai.CodeInterpreterToolCall
- openai.CodeInterpreterToolCallDelta
- openai.FileSearchToolCall
- openai.FileSearchToolCallDelta
- openai.FunctionToolCall
- openai.FunctionToolCallDelta
- openai.MessageCreationStepDetails
- openai.RunStep
- openai.RunStepDelta
- openai.RunStepDeltaEvent
- openai.RunStepDeltaMessageDelta
- openai.ToolCall
- openai.ToolCallDelta
- openai.ToolCallDeltaObject
- openai.ToolCallsStepDetails
Methods:
client.Beta.Threads.Runs.Steps.Get(ctx context.Context, threadID string, runID string, stepID string, query openai.BetaThreadRunStepGetParams) (openai.RunStep, error)client.Beta.Threads.Runs.Steps.List(ctx context.Context, threadID string, runID string, query openai.BetaThreadRunStepListParams) (pagination.CursorPage[openai.RunStep], error)
Messages
Params Types:
- openai.ImageFileParam
- openai.ImageFileContentBlockParam
- openai.ImageURLParam
- openai.ImageURLContentBlockParam
- openai.MessageContentPartParamUnion
- openai.TextContentBlockParam
Response Types:
- openai.Annotation
- openai.AnnotationDelta
- openai.FileCitationAnnotation
- openai.FileCitationDeltaAnnotation
- openai.FilePathAnnotation
- openai.FilePathDeltaAnnotation
- openai.ImageFile
- openai.ImageFileContentBlock
- openai.ImageFileDelta
- openai.ImageFileDeltaBlock
- openai.ImageURL
- openai.ImageURLContentBlock
- openai.ImageURLDelta
- openai.ImageURLDeltaBlock
- openai.Message
- openai.MessageContent
- openai.MessageContentDelta
- openai.MessageDeleted
- openai.MessageDelta
- openai.MessageDeltaEvent
- openai.RefusalContentBlock
- openai.RefusalDeltaBlock
- openai.Text
- openai.TextContentBlock
- openai.TextDelta
- openai.TextDeltaBlock
Methods:
client.Beta.Threads.Messages.New(ctx context.Context, threadID string, body openai.BetaThreadMessageNewParams) (openai.Message, error)client.Beta.Threads.Messages.Get(ctx context.Context, threadID string, messageID string) (openai.Message, error)client.Beta.Threads.Messages.Update(ctx context.Context, threadID string, messageID string, body openai.BetaThreadMessageUpdateParams) (openai.Message, error)client.Beta.Threads.Messages.List(ctx context.Context, threadID string, query openai.BetaThreadMessageListParams) (pagination.CursorPage[openai.Message], error)client.Beta.Threads.Messages.Delete(ctx context.Context, threadID string, messageID string) (openai.MessageDeleted, error)
Batches
Response Types:
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:
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:
Methods:
client.Uploads.Parts.New(ctx context.Context, uploadID string, body openai.UploadPartNewParams) (openai.UploadPart, error)