openai

Apr 29, 2025

Changes in this version

+ const O3

+ const O320250416

+ const O4Mini

+ const O4Mini2020416

type ChatCompletionMessage

+ ReasoningContent string

type ChatCompletionRequest

+ Prediction *Prediction

type ChatCompletionStreamChoiceDelta

+ ReasoningContent string

type CompletionRequest

+ StreamOptions *StreamOptions

type CompletionTokensDetails

+ AcceptedPredictionTokens int

+ RejectedPredictionTokens int

+ type Prediction struct

+ Content string

+ Type string

Apr 26, 2025

Changes in this version

+ const GPT4Dot1

+ const GPT4Dot120250414

+ const GPT4Dot1Mini

+ const GPT4Dot1Mini20250414

+ const GPT4Dot1Nano

+ const GPT4Dot1Nano20250414

type CreateSpeechRequest

+ Instructions string

type SpeechModel

+ const TTSModelGPT4oMini

type SpeechVoice

+ const VoiceAsh

+ const VoiceBallad

+ const VoiceCoral

+ const VoiceVerse

Mar 4, 2025

Changes in this version

+ const GPT4Dot5Preview

+ const GPT4Dot5Preview20250227

Feb 25, 2025

Changes in this version

+ const AnthropicAPIVersion

+ const ChatMessageRoleDeveloper

type APIType

+ const APITypeAnthropic

type ClientConfig

+ func DefaultAnthropicConfig(apiKey, baseURL string) ClientConfig

+ type ImageURL struct

+ Detail string

+ URL string

type MessageContent

+ ImageURL *ImageURL

Feb 6, 2025

Changes in this version

+ const O1

+ const O120241217

+ const O3Mini

+ const O3Mini20250131

+ var ErrReasoningModelLimitationsLogprobs = errors.New("this model has beta-limitations, logprobs not supported")

+ var ErrReasoningModelLimitationsOther = errors.New(...)

+ var ErrReasoningModelMaxTokensDeprecated = errors.New("this model is not supported MaxTokens, please use MaxCompletionTokens")

type ChatCompletionRequest

+ ReasoningEffort string

+ type ReasoningValidator struct

+ func NewReasoningValidator() *ReasoningValidator

+ func (v *ReasoningValidator) Validate(request ChatCompletionRequest) error

Dec 27, 2024

Changes in this version

type RunRequest

+ AdditionalMessages []ThreadMessage

Nov 30, 2024

Changes in this version

+ const GPT4o20241120

type ChatCompletionStream

+ func (stream ChatCompletionStream) RecvRaw() ([]byte, error)

type CompletionStream

+ func (stream CompletionStream) RecvRaw() ([]byte, error)

Nov 8, 2024

Changes in this version

type MessageRequest

+ Attachments []ThreadAttachment

type VectorStoreFilesList

+ FirstID *string

+ HasMore bool

+ LastID *string

Oct 29, 2024

Changes in this version

type ChatCompletionStreamChoice

+ Logprobs *ChatCompletionStreamChoiceLogprobs

type ChatCompletionStreamChoiceDelta

+ Refusal string

+ type ChatCompletionStreamChoiceLogprobs struct

+ Content []ChatCompletionTokenLogprob

+ Refusal []ChatCompletionTokenLogprob

+ type ChatCompletionTokenLogprob struct

+ Bytes []int64

+ Logprob float64

+ Token string

+ TopLogprobs []ChatCompletionTokenLogprobTopLogprob

+ type ChatCompletionTokenLogprobTopLogprob struct

+ Bytes []int64

+ Logprob float64

+ Token string

Oct 21, 2024

Changes in this version

type Assistant

+ ResponseFormat any

+ Temperature *float32

+ TopP *float32

Oct 15, 2024

Changes in this version

type ChatCompletionRequest

+ Metadata map[string]string

+ Store bool

type CompletionRequest

+ Metadata map[string]string

Oct 14, 2024

Changes in this version

+ const ModerationOmni20240926

+ const ModerationOmniLatest

type RequestError

+ Body []byte

Oct 9, 2024

Changes in this version

type ChatCompletionChoice

+ ContentFilterResults ContentFilterResults

type ChatCompletionRequest

+ MaxCompletionTokens int

type ChatCompletionResponse

+ PromptFilterResults []PromptFilterResult

type CompletionRequest

+ Store bool

type CompletionTokensDetails

+ AudioTokens int

type ContentFilterResults

+ JailBreak JailBreak

+ Profanity Profanity

+ type JailBreak struct

+ Detected bool

+ Filtered bool

+ type Profanity struct

+ Detected bool

+ Filtered bool

+ type PromptTokensDetails struct

+ AudioTokens int

+ CachedTokens int

type Usage

+ PromptTokensDetails *PromptTokensDetails

Sep 26, 2024

Changes in this version

type APIError

+ HTTPStatus string

+ type CompletionTokensDetails struct

+ ReasoningTokens int

type RequestError

+ HTTPStatus string

type RunRequest

+ ParallelToolCalls any

type Usage

+ CompletionTokensDetails *CompletionTokensDetails

Sep 20, 2024

Changes in this version

type Run

+ ParallelToolCalls any

Sep 20, 2024

Changes in this version

+ var ErrO1BetaLimitationsLogprobs = errors.New("this model has beta-limitations, logprobs not supported")

+ var ErrO1BetaLimitationsMessageTypes = errors.New(...)

+ var ErrO1BetaLimitationsOther = errors.New(...)

+ var ErrO1BetaLimitationsStreaming = errors.New("this model has beta-limitations, streaming not supported")

+ var ErrO1BetaLimitationsTools = errors.New(...)

+ var ErrO1MaxTokensDeprecated = errors.New("this model is not supported MaxTokens, please use MaxCompletionsTokens")

+ var O1SeriesModels = map[string]struct

type ChatCompletionRequest

+ MaxCompletionsTokens int

Sep 17, 2024

Changes in this version

+ const O1Mini

+ const O1Mini20240912

+ const O1Preview

+ const O1Preview20240912

Sep 11, 2024

Changes in this version

type ChatCompletionMessage

+ Refusal string

Sep 1, 2024

Changes in this version

+ const GPT4oLatest

Aug 23, 2024

Changes in this version

type Client

+ func (c *Client) DeleteMessage(ctx context.Context, threadID, messageID string) (status MessageDeletionStatus, err error)

+ type HTTPDoer interface

+ Do func(req *http.Request) (*http.Response, error)

+ type MessageDeletionStatus struct

+ Deleted bool

+ ID string

+ Object string

+ func (h *MessageDeletionStatus) GetRateLimitHeaders() RateLimitHeaders

+ func (h *MessageDeletionStatus) Header() http.Header

+ func (h *MessageDeletionStatus) SetHeader(header http.Header)

Aug 16, 2024

Changes in this version

type CompletionRequest

+ Seed *int

type FunctionDefinition

+ Strict bool

Aug 7, 2024

Changes in this version

+ const GPT4o20240806

type ChatCompletionResponseFormat

+ JSONSchema ChatCompletionResponseFormatJSONSchema

+ type ChatCompletionResponseFormatJSONSchema struct

+ Description string

+ Name string

+ Schema jsonschema.Definition

+ Strict bool

type ChatCompletionResponseFormatType

+ const ChatCompletionResponseFormatTypeJSONSchema

Jul 19, 2024

Changes in this version

+ const GPT4oMini

+ const GPT4oMini20240718

type AssistantRequest

+ ResponseFormat any

+ Temperature *float32

+ TopP *float32

type Hyperparameters

+ BatchSize any

+ LearningRateMultiplier any

+ type ThreadAttachment struct

+ FileID string

+ Tools []ThreadAttachmentTool

+ type ThreadAttachmentTool struct

+ Type string

type ThreadMessage

+ Attachments []ThreadAttachment

type ThreadMessageRole

+ const ThreadMessageRoleAssistant

Jul 12, 2024

Changes in this version

type ChatCompletionRequest

+ ParallelToolCalls any

Jun 19, 2024

Changes in this version

type Assistant

+ ToolResources *AssistantToolResource

type AssistantRequest

+ ToolResources *AssistantToolResource

type AssistantToolCodeInterpreter

+ FileIDs []string

+ type AssistantToolFileSearch struct

+ VectorStoreIDs []string

+ type AssistantToolResource struct

+ CodeInterpreter *AssistantToolCodeInterpreter

+ FileSearch *AssistantToolFileSearch

type AssistantToolType

+ const AssistantToolTypeFileSearch

type Client

+ func (c *Client) CancelVectorStoreFileBatch(ctx context.Context, vectorStoreID string, batchID string) (response VectorStoreFileBatch, err error)

+ func (c *Client) CreateVectorStore(ctx context.Context, request VectorStoreRequest) (response VectorStore, err error)

+ func (c *Client) CreateVectorStoreFile(ctx context.Context, vectorStoreID string, request VectorStoreFileRequest) (response VectorStoreFile, err error)

+ func (c *Client) CreateVectorStoreFileBatch(ctx context.Context, vectorStoreID string, request VectorStoreFileBatchRequest) (response VectorStoreFileBatch, err error)

+ func (c *Client) DeleteVectorStore(ctx context.Context, vectorStoreID string) (response VectorStoreDeleteResponse, err error)

+ func (c *Client) DeleteVectorStoreFile(ctx context.Context, vectorStoreID string, fileID string) (err error)

+ func (c *Client) ListVectorStoreFiles(ctx context.Context, vectorStoreID string, pagination Pagination) (response VectorStoreFilesList, err error)

+ func (c *Client) ListVectorStoreFilesInBatch(ctx context.Context, vectorStoreID string, batchID string, ...) (response VectorStoreFilesList, err error)

+ func (c *Client) ListVectorStores(ctx context.Context, pagination Pagination) (response VectorStoresList, err error)

+ func (c *Client) ModifyVectorStore(ctx context.Context, vectorStoreID string, request VectorStoreRequest) (response VectorStore, err error)

+ func (c *Client) RetrieveVectorStore(ctx context.Context, vectorStoreID string) (response VectorStore, err error)

+ func (c *Client) RetrieveVectorStoreFile(ctx context.Context, vectorStoreID string, fileID string) (response VectorStoreFile, err error)

+ func (c *Client) RetrieveVectorStoreFileBatch(ctx context.Context, vectorStoreID string, batchID string) (response VectorStoreFileBatch, err error)

+ type VectorStore struct

+ CreatedAt int64

+ ExpiresAfter *VectorStoreExpires

+ ExpiresAt *int

+ FileCounts VectorStoreFileCount

+ ID string

+ Metadata map[string]any

+ Name string

+ Object string

+ Status string

+ UsageBytes int

+ func (h *VectorStore) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStore) Header() http.Header

+ func (h *VectorStore) SetHeader(header http.Header)

+ type VectorStoreDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ func (h *VectorStoreDeleteResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStoreDeleteResponse) Header() http.Header

+ func (h *VectorStoreDeleteResponse) SetHeader(header http.Header)

+ type VectorStoreExpires struct

+ Anchor string

+ Days int

+ type VectorStoreFile struct

+ CreatedAt int64

+ ID string

+ Object string

+ Status string

+ UsageBytes int

+ VectorStoreID string

+ func (h *VectorStoreFile) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStoreFile) Header() http.Header

+ func (h *VectorStoreFile) SetHeader(header http.Header)

+ type VectorStoreFileBatch struct

+ CreatedAt int64

+ FileCounts VectorStoreFileCount

+ ID string

+ Object string

+ Status string

+ VectorStoreID string

+ func (h *VectorStoreFileBatch) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStoreFileBatch) Header() http.Header

+ func (h *VectorStoreFileBatch) SetHeader(header http.Header)

+ type VectorStoreFileBatchRequest struct

+ FileIDs []string

+ type VectorStoreFileCount struct

+ Cancelled int

+ Completed int

+ Failed int

+ InProgress int

+ Total int

+ type VectorStoreFileRequest struct

+ FileID string

+ type VectorStoreFilesList struct

+ VectorStoreFiles []VectorStoreFile

+ func (h *VectorStoreFilesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStoreFilesList) Header() http.Header

+ func (h *VectorStoreFilesList) SetHeader(header http.Header)

+ type VectorStoreRequest struct

+ ExpiresAfter *VectorStoreExpires

+ FileIDs []string

+ Metadata map[string]any

+ Name string

+ type VectorStoresList struct

+ FirstID *string

+ HasMore bool

+ LastID *string

+ VectorStores []VectorStore

+ func (h *VectorStoresList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *VectorStoresList) Header() http.Header

+ func (h *VectorStoresList) SetHeader(header http.Header)

Jun 13, 2024

Changes in this version

+ var ErrUploadBatchFileFailed = errors.New("upload batch file failed")

+ type Batch struct

+ CancelledAt *int

+ CancellingAt *int

+ CompletedAt *int

+ CompletionWindow string

+ CreatedAt int

+ Endpoint BatchEndpoint

+ ErrorFileID *string

+ Errors ...

+ ExpiredAt *int

+ ExpiresAt *int

+ FailedAt *int

+ FinalizingAt *int

+ ID string

+ InProgressAt *int

+ InputFileID string

+ Metadata map[string]any

+ Object string

+ OutputFileID *string

+ RequestCounts BatchRequestCounts

+ Status string

+ type BatchChatCompletionRequest struct

+ Body ChatCompletionRequest

+ CustomID string

+ Method string

+ URL BatchEndpoint

+ func (r BatchChatCompletionRequest) MarshalBatchLineItem() []byte

+ type BatchCompletionRequest struct

+ Body CompletionRequest

+ CustomID string

+ Method string

+ URL BatchEndpoint

+ func (r BatchCompletionRequest) MarshalBatchLineItem() []byte

+ type BatchEmbeddingRequest struct

+ Body EmbeddingRequest

+ CustomID string

+ Method string

+ URL BatchEndpoint

+ func (r BatchEmbeddingRequest) MarshalBatchLineItem() []byte

+ type BatchEndpoint string

+ const BatchEndpointChatCompletions

+ const BatchEndpointCompletions

+ const BatchEndpointEmbeddings

+ type BatchLineItem interface

+ MarshalBatchLineItem func() []byte

+ type BatchRequestCounts struct

+ Completed int

+ Failed int

+ Total int

+ type BatchResponse struct

+ func (h *BatchResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *BatchResponse) Header() http.Header

+ func (h *BatchResponse) SetHeader(header http.Header)

+ type ChunkingStrategy struct

+ Static *StaticChunkingStrategy

+ Type ChunkingStrategyType

+ type ChunkingStrategyType string

+ const ChunkingStrategyTypeAuto

+ const ChunkingStrategyTypeStatic

type Client

+ func (c *Client) CancelBatch(ctx context.Context, batchID string) (response BatchResponse, err error)

+ func (c *Client) CreateBatch(ctx context.Context, request CreateBatchRequest) (response BatchResponse, err error)

+ func (c *Client) CreateBatchWithUploadFile(ctx context.Context, request CreateBatchWithUploadFileRequest) (response BatchResponse, err error)

+ func (c *Client) ListBatch(ctx context.Context, after *string, limit *int) (response ListBatchResponse, err error)

+ func (c *Client) RetrieveBatch(ctx context.Context, batchID string) (response BatchResponse, err error)

+ func (c *Client) UploadBatchFile(ctx context.Context, request UploadBatchFileRequest) (File, error)

+ type CodeInterpreterToolResources struct

+ FileIDs []string

+ type CodeInterpreterToolResourcesRequest struct

+ FileIDs []string

+ type CreateBatchRequest struct

+ CompletionWindow string

+ Endpoint BatchEndpoint

+ InputFileID string

+ Metadata map[string]any

+ type CreateBatchWithUploadFileRequest struct

+ CompletionWindow string

+ Endpoint BatchEndpoint

+ Metadata map[string]any

+ type FileSearchToolResources struct

+ VectorStoreIDs []string

+ type FileSearchToolResourcesRequest struct

+ VectorStoreIDs []string

+ VectorStores []VectorStoreToolResources

+ type ListBatchResponse struct

+ Data []Batch

+ FirstID string

+ HasMore bool

+ LastID string

+ Object string

+ func (h *ListBatchResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ListBatchResponse) Header() http.Header

+ func (h *ListBatchResponse) SetHeader(header http.Header)

type ModifyThreadRequest

+ ToolResources *ToolResources

type PurposeType

+ const PurposeBatch

+ type StaticChunkingStrategy struct

+ ChunkOverlapTokens int

+ MaxChunkSizeTokens int

type Thread

+ ToolResources ToolResources

type ThreadRequest

+ ToolResources *ToolResourcesRequest

+ type ToolResources struct

+ CodeInterpreter *CodeInterpreterToolResources

+ FileSearch *FileSearchToolResources

+ type ToolResourcesRequest struct

+ CodeInterpreter *CodeInterpreterToolResourcesRequest

+ FileSearch *FileSearchToolResourcesRequest

+ type UploadBatchFileRequest struct

+ FileName string

+ Lines []BatchLineItem

+ func (r *UploadBatchFileRequest) AddChatCompletion(customerID string, body ChatCompletionRequest)

+ func (r *UploadBatchFileRequest) AddCompletion(customerID string, body CompletionRequest)

+ func (r *UploadBatchFileRequest) AddEmbedding(customerID string, body EmbeddingRequest)

+ func (r *UploadBatchFileRequest) MarshalJSONL() []byte

+ type VectorStoreToolResources struct

+ ChunkingStrategy *ChunkingStrategy

+ FileIDs []string

+ Metadata map[string]any

Jun 5, 2024

Changes in this version

+ type ReponseFormat struct

+ Type string

type RunRequest

+ ResponseFormat any

+ ToolChoice any

+ TopP *float32

type RunStatus

+ const RunStatusIncomplete

May 13, 2024

Changes in this version

+ const GPT4o

+ const GPT4o20240513

May 7, 2024

Changes in this version

type AudioRequest

+ TimestampGranularities []TranscriptionTimestampGranularity

type AudioResponse

+ Words []struct{ ... }

type ChatCompletionRequest

+ StreamOptions *StreamOptions

+ type StreamOptions struct

+ IncludeUsage bool

+ type TranscriptionTimestampGranularity string

+ const TranscriptionTimestampGranularitySegment

+ const TranscriptionTimestampGranularityWord

Apr 24, 2024

Changes in this version

type APIType

+ const APITypeCloudflareAzure

type ChatCompletionStreamResponse

+ SystemFingerprint string

type ClientConfig

+ AssistantVersion string

Apr 16, 2024

Changes in this version

+ const TruncationStrategyAuto

+ const TruncationStrategyLastMessages

type ChatCompletionStreamResponse

+ PromptFilterResults []PromptFilterResult

+ type PromptFilterResult struct

+ ContentFilterResults ContentFilterResults

+ Index int

type Run

+ MaxCompletionTokens int

+ MaxPromptTokens int

+ Temperature *float32

+ TruncationStrategy *ThreadTruncationStrategy

type RunRequest

+ MaxCompletionTokens int

+ MaxPromptTokens int

+ Temperature *float32

+ TruncationStrategy *ThreadTruncationStrategy

+ type ThreadTruncationStrategy struct

+ LastMessages *int

+ Type TruncationStrategy

+ type TruncationStrategy string

Apr 11, 2024

Changes in this version

+ const GPT4Turbo

+ const GPT4Turbo20240409

Apr 5, 2024

Changes in this version

+ type RawResponse struct

+ func (h *RawResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *RawResponse) Header() http.Header

+ func (h *RawResponse) SetHeader(header http.Header)

Mar 15, 2024

Changes in this version

type AssistantRequest

+ func (a AssistantRequest) MarshalJSON() ([]byte, error)

Mar 11, 2024

Changes in this version

type SpeechResponseFormat

+ const SpeechResponseFormatPcm

+ const SpeechResponseFormatWav

Feb 26, 2024

Changes in this version

type ResultCategories

+ Harassment bool

+ HarassmentThreatening bool

+ SelfHarmInstructions bool

+ SelfHarmIntent bool

type ResultCategoryScores

+ Harassment bool

+ HarassmentThreatening bool

+ SelfHarmInstructions bool

+ SelfHarmIntent bool

Feb 16, 2024

Changes in this version

type RunRequest

+ AdditionalInstructions string

Feb 8, 2024

Changes in this version

+ const GPT3Dot5Turbo0125

type Run

+ Usage Usage

type RunStatus

+ const RunStatusCancelled

Jan 29, 2024

Changes in this version

type EmbeddingRequest

+ Dimensions int

type EmbeddingRequestStrings

+ Dimensions int

type EmbeddingRequestTokens

+ Dimensions int

Jan 26, 2024

Changes in this version

+ const GPT4Turbo0125

+ const GPT4Turbo1106

type EmbeddingModel

+ const LargeEmbedding3

+ const SmallEmbedding3

Jan 15, 2024

Changes in this version

type ImageEditRequest

+ Model string

type ImageVariRequest

+ Model string

Jan 9, 2024

Changes in this version

type ChatCompletionChoice

+ LogProbs *LogProbs

type ChatCompletionRequest

+ LogProbs bool

+ TopLogProbs int

+ type LogProb struct

+ Bytes []byte

+ LogProb float64

+ Token string

+ TopLogProbs []TopLogProbs

+ type LogProbs struct

+ Content []LogProb

+ type TopLogProbs struct

+ Bytes []byte

+ LogProb float64

+ Token string

Nov 24, 2023

Changes in this version

+ var ErrContentFieldsMisused = errors.New("can't use both Content and MultiContent properties simultaneously")

type ChatCompletionMessage

+ MultiContent []ChatMessagePart

+ func (m *ChatCompletionMessage) UnmarshalJSON(bs []byte) error

+ func (m ChatCompletionMessage) MarshalJSON() ([]byte, error)

+ type ChatMessageImageURL struct

+ Detail ImageURLDetail

+ URL string

+ type ChatMessagePart struct

+ ImageURL *ChatMessageImageURL

+ Text string

+ Type ChatMessagePartType

+ type ChatMessagePartType string

+ const ChatMessagePartTypeImageURL

+ const ChatMessagePartTypeText

+ type ImageURLDetail string

+ const ImageURLDetailAuto

+ const ImageURLDetailHigh

+ const ImageURLDetailLow

type SpeechModel

+ const TTSModel1HD

+ const TTSModelCanary

Nov 18, 2023

Changes in this version

type Assistant

+ FileIDs []string

+ Metadata map[string]any

type AssistantsList

+ FirstID *string

+ HasMore bool

+ LastID *string

type MessagesList

+ FirstID *string

+ HasMore bool

+ LastID *string

+ Object string

type PurposeType

+ const PurposeAssistantsOutput

+ const PurposeFineTuneResults

type RunStepList

+ FirstID string

+ HasMore bool

+ LastID string

Nov 15, 2023

Changes in this version

type Client

+ func (c *Client) CreateFileBytes(ctx context.Context, request FileBytesRequest) (file File, err error)

+ type FileBytesRequest struct

+ Bytes []byte

+ Name string

+ Purpose PurposeType

+ type PurposeType string

+ const PurposeAssistants

+ const PurposeFineTune

Nov 13, 2023

Changes in this version

+ var ErrInvalidSpeechModel = errors.New("invalid speech model")

+ var ErrInvalidVoice = errors.New("invalid voice")

type Client

+ func (c *Client) CreateMessage(ctx context.Context, threadID string, request MessageRequest) (msg Message, err error)

+ func (c *Client) CreateSpeech(ctx context.Context, request CreateSpeechRequest) (response io.ReadCloser, err error)

+ func (c *Client) ListMessage(ctx context.Context, threadID string, limit *int, order *string, after *string, ...) (messages MessagesList, err error)

+ func (c *Client) ListMessageFiles(ctx context.Context, threadID, messageID string) (files MessageFilesList, err error)

+ func (c *Client) ModifyMessage(ctx context.Context, threadID, messageID string, metadata map[string]any) (msg Message, err error)

+ func (c *Client) RetrieveMessage(ctx context.Context, threadID, messageID string) (msg Message, err error)

+ func (c *Client) RetrieveMessageFile(ctx context.Context, threadID, messageID, fileID string) (file MessageFile, err error)

+ type CreateSpeechRequest struct

+ Input string

+ Model SpeechModel

+ ResponseFormat SpeechResponseFormat

+ Speed float64

+ Voice SpeechVoice

+ type ImageFile struct

+ FileID string

+ type Message struct

+ AssistantID *string

+ Content []MessageContent

+ CreatedAt int

+ FileIds []string

+ ID string

+ Metadata map[string]any

+ Object string

+ Role string

+ RunID *string

+ ThreadID string

+ func (h *Message) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Message) Header() http.Header

+ func (h *Message) SetHeader(header http.Header)

+ type MessageContent struct

+ ImageFile *ImageFile

+ Text *MessageText

+ Type string

+ type MessageFile struct

+ CreatedAt int

+ ID string

+ MessageID string

+ Object string

+ func (h *MessageFile) GetRateLimitHeaders() RateLimitHeaders

+ func (h *MessageFile) Header() http.Header

+ func (h *MessageFile) SetHeader(header http.Header)

+ type MessageFilesList struct

+ MessageFiles []MessageFile

+ func (h *MessageFilesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *MessageFilesList) Header() http.Header

+ func (h *MessageFilesList) SetHeader(header http.Header)

+ type MessageRequest struct

+ Content string

+ FileIds []string

+ Metadata map[string]any

+ Role string

+ type MessageText struct

+ Annotations []any

+ Value string

+ type MessagesList struct

+ Messages []Message

+ func (h *MessagesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *MessagesList) Header() http.Header

+ func (h *MessagesList) SetHeader(header http.Header)

+ type SpeechModel string

+ const TTSModel1

+ const TTsModel1HD

+ type SpeechResponseFormat string

+ const SpeechResponseFormatAac

+ const SpeechResponseFormatFlac

+ const SpeechResponseFormatMp3

+ const SpeechResponseFormatOpus

+ type SpeechVoice string

+ const VoiceAlloy

+ const VoiceEcho

+ const VoiceFable

+ const VoiceNova

+ const VoiceOnyx

+ const VoiceShimmer

Nov 9, 2023

Changes in this version

type Client

+ func (c *Client) CancelRun(ctx context.Context, threadID string, runID string) (response Run, err error)

+ func (c *Client) CreateRun(ctx context.Context, threadID string, request RunRequest) (response Run, err error)

+ func (c *Client) CreateThreadAndRun(ctx context.Context, request CreateThreadAndRunRequest) (response Run, err error)

+ func (c *Client) ListRunSteps(ctx context.Context, threadID string, runID string, pagination Pagination) (response RunStepList, err error)

+ func (c *Client) ListRuns(ctx context.Context, threadID string, pagination Pagination) (response RunList, err error)

+ func (c *Client) ModifyRun(ctx context.Context, threadID string, runID string, request RunModifyRequest) (response Run, err error)

+ func (c *Client) RetrieveRun(ctx context.Context, threadID string, runID string) (response Run, err error)

+ func (c *Client) RetrieveRunStep(ctx context.Context, threadID string, runID string, stepID string) (response RunStep, err error)

+ func (c *Client) SubmitToolOutputs(ctx context.Context, threadID string, runID string, ...) (response Run, err error)

+ type CreateThreadAndRunRequest struct

+ Thread ThreadRequest

+ type Pagination struct

+ After *string

+ Before *string

+ Limit *int

+ Order *string

+ type RequiredActionType string

+ const RequiredActionTypeSubmitToolOutputs

+ type Run struct

+ AssistantID string

+ CancelledAt *int64

+ CompletedAt *int64

+ CreatedAt int64

+ ExpiresAt int64

+ FailedAt *int64

+ FileIDS []string

+ ID string

+ Instructions string

+ LastError *RunLastError

+ Metadata map[string]any

+ Model string

+ Object string

+ RequiredAction *RunRequiredAction

+ StartedAt *int64

+ Status RunStatus

+ ThreadID string

+ Tools []Tool

+ func (h *Run) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Run) Header() http.Header

+ func (h *Run) SetHeader(header http.Header)

+ type RunError string

+ const RunErrorRateLimitExceeded

+ const RunErrorServerError

+ type RunLastError struct

+ Code RunError

+ Message string

+ type RunList struct

+ Runs []Run

+ func (h *RunList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *RunList) Header() http.Header

+ func (h *RunList) SetHeader(header http.Header)

+ type RunModifyRequest struct

+ Metadata map[string]any

+ type RunRequest struct

+ AssistantID string

+ Instructions *string

+ Metadata map[string]any

+ Model *string

+ Tools []Tool

+ type RunRequiredAction struct

+ SubmitToolOutputs *SubmitToolOutputs

+ Type RequiredActionType

+ type RunStatus string

+ const RunStatusCancelling

+ const RunStatusCompleted

+ const RunStatusExpired

+ const RunStatusFailed

+ const RunStatusInProgress

+ const RunStatusQueued

+ const RunStatusRequiresAction

+ type RunStep struct

+ AssistantID string

+ CancelledAt *int64

+ CompletedAt *int64

+ CreatedAt int64

+ ExpiredAt *int64

+ FailedAt *int64

+ ID string

+ LastError *RunLastError

+ Metadata map[string]any

+ Object string

+ RunID string

+ Status RunStepStatus

+ StepDetails StepDetails

+ ThreadID string

+ Type RunStepType

+ func (h *RunStep) GetRateLimitHeaders() RateLimitHeaders

+ func (h *RunStep) Header() http.Header

+ func (h *RunStep) SetHeader(header http.Header)

+ type RunStepList struct

+ RunSteps []RunStep

+ func (h *RunStepList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *RunStepList) Header() http.Header

+ func (h *RunStepList) SetHeader(header http.Header)

+ type RunStepStatus string

+ const RunStepStatusCancelling

+ const RunStepStatusCompleted

+ const RunStepStatusExpired

+ const RunStepStatusFailed

+ const RunStepStatusInProgress

+ type RunStepType string

+ const RunStepTypeMessageCreation

+ const RunStepTypeToolCalls

+ type StepDetails struct

+ MessageCreation *StepDetailsMessageCreation

+ ToolCalls *StepDetailsToolCalls

+ Type RunStepType

+ type StepDetailsMessageCreation struct

+ MessageID string

+ type StepDetailsToolCalls struct

+ ToolCalls []ToolCall

+ type SubmitToolOutputs struct

+ ToolCalls []ToolCall

+ type SubmitToolOutputsRequest struct

+ ToolOutputs []ToolOutput

type ToolCall

+ Index *int

+ type ToolOutput struct

+ Output any

+ ToolCallID string

Nov 9, 2023

Changes in this version

type ChatCompletionMessage

+ ToolCallID string

type ChatCompletionRequest

+ ToolChoice any

type ChatCompletionResponse

+ SystemFingerprint string

type Client

+ func (c *Client) CreateThread(ctx context.Context, request ThreadRequest) (response Thread, err error)

+ func (c *Client) DeleteThread(ctx context.Context, threadID string) (response ThreadDeleteResponse, err error)

+ func (c *Client) ModifyThread(ctx context.Context, threadID string, request ModifyThreadRequest) (response Thread, err error)

+ func (c *Client) RetrieveThread(ctx context.Context, threadID string) (response Thread, err error)

+ type ModifyThreadRequest struct

+ Metadata map[string]any

+ type Thread struct

+ CreatedAt int64

+ ID string

+ Metadata map[string]any

+ Object string

+ func (h *Thread) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Thread) Header() http.Header

+ func (h *Thread) SetHeader(header http.Header)

+ type ThreadDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ func (h *ThreadDeleteResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ThreadDeleteResponse) Header() http.Header

+ func (h *ThreadDeleteResponse) SetHeader(header http.Header)

+ type ThreadMessage struct

+ Content string

+ FileIDs []string

+ Metadata map[string]any

+ Role ThreadMessageRole

+ type ThreadMessageRole string

+ const ThreadMessageRoleUser

+ type ThreadRequest struct

+ Messages []ThreadMessage

+ Metadata map[string]any

type ToolCall

+ Type ToolType

+ type ToolChoice struct

+ Function ToolFunction

+ Type ToolType

Nov 8, 2023

Changes in this version

+ const CreateImageModelDallE2

+ const CreateImageModelDallE3

+ const CreateImageQualityHD

+ const CreateImageQualityStandard

+ const CreateImageSize1024x1792

+ const CreateImageSize1792x1024

+ const CreateImageStyleNatural

+ const CreateImageStyleVivid

+ type AssistantDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ func (h *AssistantDeleteResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *AssistantDeleteResponse) Header() http.Header

+ func (h *AssistantDeleteResponse) SetHeader(header http.Header)

type AssistantTool

+ Function *FunctionDefinition

+ type AssistantToolType string

+ const AssistantToolTypeCodeInterpreter

+ const AssistantToolTypeFunction

+ const AssistantToolTypeRetrieval

type ImageRequest

+ Model string

+ Quality string

+ Style string

type ImageResponseDataInner

+ RevisedPrompt string

Nov 7, 2023

Changes in this version

+ const ChatMessageRoleTool

type ChatCompletionMessage

+ ToolCalls []ToolCall

type ChatCompletionRequest

+ ToolChoiche any

+ Tools []Tool

type ChatCompletionStreamChoiceDelta

+ ToolCalls []ToolCall

type FinishReason

+ const FinishReasonToolCalls

+ type Tool struct

+ Function FunctionDefinition

+ Type ToolType

+ type ToolCall struct

+ Function FunctionCall

+ ID string

+ type ToolChoiche struct

+ Function ToolFunction

+ Type ToolType

+ type ToolFunction struct

+ Name string

+ type ToolType string

+ const ToolTypeFunction

Nov 7, 2023

Changes in this version

+ type Assistant struct

+ CreatedAt int64

+ Description *string

+ ID string

+ Instructions *string

+ Model string

+ Name *string

+ Object string

+ Tools []any

+ func (h *Assistant) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Assistant) Header() http.Header

+ func (h *Assistant) SetHeader(header http.Header)

+ type AssistantFile struct

+ AssistantID string

+ CreatedAt int64

+ ID string

+ Object string

+ func (h *AssistantFile) GetRateLimitHeaders() RateLimitHeaders

+ func (h *AssistantFile) Header() http.Header

+ func (h *AssistantFile) SetHeader(header http.Header)

+ type AssistantFileRequest struct

+ FileID string

+ type AssistantFilesList struct

+ AssistantFiles []AssistantFile

+ func (h *AssistantFilesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *AssistantFilesList) Header() http.Header

+ func (h *AssistantFilesList) SetHeader(header http.Header)

+ type AssistantRequest struct

+ Description *string

+ FileIDs []string

+ Instructions *string

+ Metadata map[string]any

+ Model string

+ Name *string

+ Tools []any

+ type AssistantTool struct

+ Type string

+ type AssistantToolCodeInterpreter struct

+ type AssistantToolFunction struct

+ Function FunctionDefinition

+ type AssistantToolRetrieval struct

+ type AssistantsList struct

+ Assistants []Assistant

+ func (h *AssistantsList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *AssistantsList) Header() http.Header

+ func (h *AssistantsList) SetHeader(header http.Header)

type ChatCompletionRequest

+ ResponseFormat ChatCompletionResponseFormat

+ Seed *int

+ type ChatCompletionResponseFormat struct

+ Type ChatCompletionResponseFormatType

+ type ChatCompletionResponseFormatType string

+ const ChatCompletionResponseFormatTypeJSONObject

+ const ChatCompletionResponseFormatTypeText

type Client

+ func (c *Client) CreateAssistant(ctx context.Context, request AssistantRequest) (response Assistant, err error)

+ func (c *Client) CreateAssistantFile(ctx context.Context, assistantID string, request AssistantFileRequest) (response AssistantFile, err error)

+ func (c *Client) DeleteAssistant(ctx context.Context, assistantID string) (response Assistant, err error)

+ func (c *Client) DeleteAssistantFile(ctx context.Context, assistantID string, fileID string) (err error)

+ func (c *Client) ListAssistantFiles(ctx context.Context, assistantID string, limit *int, order *string, ...) (response AssistantFilesList, err error)

+ func (c *Client) ListAssistants(ctx context.Context, limit *int, order *string, after *string, before *string) (reponse AssistantsList, err error)

+ func (c *Client) ModifyAssistant(ctx context.Context, assistantID string, request AssistantRequest) (response Assistant, err error)

+ func (c *Client) RetrieveAssistant(ctx context.Context, assistantID string) (response Assistant, err error)

+ func (c *Client) RetrieveAssistantFile(ctx context.Context, assistantID string, fileID string) (response AssistantFile, err error)

Nov 6, 2023

Changes in this version

+ const GPT3Dot5Turbo1106

+ const GPT4TurboPreview

+ const GPT4VisionPreview

Oct 10, 2023

Changes in this version

+ var ErrVectorLengthMismatch = errors.New("vector length mismatch")

type AudioResponse

+ func (h *AudioResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *AudioResponse) Header() http.Header

+ func (h *AudioResponse) SetHeader(header http.Header)

type ChatCompletionResponse

+ func (h *ChatCompletionResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ChatCompletionResponse) Header() http.Header

+ func (h *ChatCompletionResponse) SetHeader(header http.Header)

type CompletionResponse

+ func (h *CompletionResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *CompletionResponse) Header() http.Header

+ func (h *CompletionResponse) SetHeader(header http.Header)

type EditsResponse

+ func (h *EditsResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *EditsResponse) Header() http.Header

+ func (h *EditsResponse) SetHeader(header http.Header)

type Embedding

+ func (e *Embedding) DotProduct(other *Embedding) (float32, error)

type EmbeddingResponse

+ func (h *EmbeddingResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *EmbeddingResponse) Header() http.Header

+ func (h *EmbeddingResponse) SetHeader(header http.Header)

type EmbeddingResponseBase64

+ func (h *EmbeddingResponseBase64) GetRateLimitHeaders() RateLimitHeaders

+ func (h *EmbeddingResponseBase64) Header() http.Header

+ func (h *EmbeddingResponseBase64) SetHeader(header http.Header)

type Engine

+ func (h *Engine) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Engine) Header() http.Header

+ func (h *Engine) SetHeader(header http.Header)

type EnginesList

+ func (h *EnginesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *EnginesList) Header() http.Header

+ func (h *EnginesList) SetHeader(header http.Header)

type File

+ func (h *File) GetRateLimitHeaders() RateLimitHeaders

+ func (h *File) Header() http.Header

+ func (h *File) SetHeader(header http.Header)

type FilesList

+ func (h *FilesList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FilesList) Header() http.Header

+ func (h *FilesList) SetHeader(header http.Header)

type FineTune

+ func (h *FineTune) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTune) Header() http.Header

+ func (h *FineTune) SetHeader(header http.Header)

type FineTuneDeleteResponse

+ func (h *FineTuneDeleteResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuneDeleteResponse) Header() http.Header

+ func (h *FineTuneDeleteResponse) SetHeader(header http.Header)

type FineTuneEventList

+ func (h *FineTuneEventList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuneEventList) Header() http.Header

+ func (h *FineTuneEventList) SetHeader(header http.Header)

type FineTuneList

+ func (h *FineTuneList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuneList) Header() http.Header

+ func (h *FineTuneList) SetHeader(header http.Header)

type FineTuneModelDeleteResponse

+ func (h *FineTuneModelDeleteResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuneModelDeleteResponse) Header() http.Header

+ func (h *FineTuneModelDeleteResponse) SetHeader(header http.Header)

type FineTuningJob

+ func (h *FineTuningJob) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuningJob) Header() http.Header

+ func (h *FineTuningJob) SetHeader(header http.Header)

type FineTuningJobEventList

+ func (h *FineTuningJobEventList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *FineTuningJobEventList) Header() http.Header

+ func (h *FineTuningJobEventList) SetHeader(header http.Header)

type ImageResponse

+ func (h *ImageResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ImageResponse) Header() http.Header

+ func (h *ImageResponse) SetHeader(header http.Header)

type Model

+ func (h *Model) GetRateLimitHeaders() RateLimitHeaders

+ func (h *Model) Header() http.Header

+ func (h *Model) SetHeader(header http.Header)

type ModelsList

+ func (h *ModelsList) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ModelsList) Header() http.Header

+ func (h *ModelsList) SetHeader(header http.Header)

type ModerationResponse

+ func (h *ModerationResponse) GetRateLimitHeaders() RateLimitHeaders

+ func (h *ModerationResponse) Header() http.Header

+ func (h *ModerationResponse) SetHeader(header http.Header)

+ type RateLimitHeaders struct

+ LimitRequests int

+ LimitTokens int

+ RemainingRequests int

+ RemainingTokens int

+ ResetRequests ResetTime

+ ResetTokens ResetTime

+ type ResetTime string

+ func (r ResetTime) String() string

+ func (r ResetTime) Time() time.Time

+ type Response interface

+ SetHeader func(http.Header)

Sep 25, 2023

Changes in this version

type Client

+ func (c *Client) DeleteFineTuneModel(ctx context.Context, modelID string) (response FineTuneModelDeleteResponse, err error)

+ type FineTuneModelDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

Sep 11, 2023

Changes in this version

+ type Base64Embedding struct

+ Embedding base64String

+ Index int

+ Object string

+ type EmbeddingEncodingFormat string

+ const EmbeddingEncodingFormatBase64

+ const EmbeddingEncodingFormatFloat

type EmbeddingRequest

+ EncodingFormat EmbeddingEncodingFormat

type EmbeddingRequestStrings

+ EncodingFormat EmbeddingEncodingFormat

type EmbeddingRequestTokens

+ EncodingFormat EmbeddingEncodingFormat

+ type EmbeddingResponseBase64 struct

+ Data []Base64Embedding

+ Model EmbeddingModel

+ Object string

+ Usage Usage

+ func (r *EmbeddingResponseBase64) ToEmbeddingResponse() (EmbeddingResponse, error)

Sep 7, 2023

Changes in this version

type File

+ Status string

+ StatusDetails string

Aug 31, 2023

Changes in this version

type Client

+ func (c *Client) CancelFineTuningJob(ctx context.Context, fineTuningJobID string) (response FineTuningJob, err error)

+ func (c *Client) CreateFineTuningJob(ctx context.Context, request FineTuningJobRequest) (response FineTuningJob, err error)

+ func (c *Client) ListFineTuningJobEvents(ctx context.Context, fineTuningJobID string, ...) (response FineTuningJobEventList, err error)

+ func (c *Client) RetrieveFineTuningJob(ctx context.Context, fineTuningJobID string) (response FineTuningJob, err error)

+ type FineTuningJob struct

+ CreatedAt int64

+ FineTunedModel string

+ FinishedAt int64

+ Hyperparameters Hyperparameters

+ ID string

+ Model string

+ Object string

+ OrganizationID string

+ ResultFiles []string

+ Status string

+ TrainedTokens int

+ TrainingFile string

+ ValidationFile string

+ type FineTuningJobEvent struct

+ CreatedAt int

+ Data any

+ ID string

+ Level string

+ Message string

+ Object string

+ Type string

+ type FineTuningJobEventList struct

+ Data []FineTuneEvent

+ HasMore bool

+ Object string

+ type FineTuningJobRequest struct

+ Hyperparameters *Hyperparameters

+ Model string

+ Suffix string

+ TrainingFile string

+ ValidationFile string

+ type Hyperparameters struct

+ Epochs int

+ type ListFineTuningJobEventsParameter func(*listFineTuningJobEventsParameters)

+ func ListFineTuningJobEventsWithAfter(after string) ListFineTuningJobEventsParameter

+ func ListFineTuningJobEventsWithLimit(limit int) ListFineTuningJobEventsParameter

Aug 9, 2023

Changes in this version

type APIError

+ InnerError *InnerError

type FinishReason

+ func (r FinishReason) MarshalJSON() ([]byte, error)

+ type InnerError struct

+ Code string

+ ContentFilterResults ContentFilterResults

Jul 20, 2023

Changes in this version

+ var ErrModerationInvalidModel = errors.New(...)

type ChatCompletionStreamChoice

+ ContentFilterResults ContentFilterResults

type ChatCompletionStreamResponse

+ PromptAnnotations []PromptAnnotation

+ type ContentFilterResults struct

+ Hate Hate

+ SelfHarm SelfHarm

+ Sexual Sexual

+ Violence Violence

+ type Hate struct

+ Filtered bool

+ Severity string

+ type PromptAnnotation struct

+ ContentFilterResults ContentFilterResults

+ PromptIndex int

+ type SelfHarm struct

+ Filtered bool

+ Severity string

+ type Sexual struct

+ Filtered bool

+ Severity string

+ type Violence struct

+ Filtered bool

+ Severity string

Jul 11, 2023

Changes in this version

+ const GPT3Ada002

+ const GPT3Babbage002

+ const GPT3Curie002

+ const GPT3Davinci002

+ const GPT3Dot5TurboInstruct

Jul 5, 2023

Changes in this version

type EmbeddingRequest

+ func (r EmbeddingRequest) Convert() EmbeddingRequest

+ type EmbeddingRequestConverter interface

+ Convert func() EmbeddingRequest

+ type EmbeddingRequestStrings struct

+ Input []string

+ Model EmbeddingModel

+ User string

+ func (r EmbeddingRequestStrings) Convert() EmbeddingRequest

+ type EmbeddingRequestTokens struct

+ Input [][]int

+ Model EmbeddingModel

+ User string

+ func (r EmbeddingRequestTokens) Convert() EmbeddingRequest

Jun 21, 2023

Changes in this version

type ChatCompletionStreamChoiceDelta

+ FunctionCall *FunctionCall

+ type FunctionDefinition struct

+ Description string

+ Name string

+ Parameters any

+ type JSONSchemaDefinition struct

+ Description string

+ Enum []string

+ Items *JSONSchemaDefinition

+ Properties map[string]JSONSchemaDefinition

+ Required []string

+ Type JSONSchemaType

Jun 16, 2023

Changes in this version

type AudioResponse

+ Duration float64

+ Language string

+ Segments []struct{ ... }

+ Task string

type AudioResponseFormat

+ const AudioResponseFormatText

+ const AudioResponseFormatVerboseJSON

type JSONSchemaDefine

+ Items *JSONSchemaDefine

Jun 15, 2023

Changes in this version

+ const ChatMessageRoleFunction

+ const GPT3Dot5Turbo0613

+ const GPT3Dot5Turbo16K

+ const GPT3Dot5Turbo16K0613

+ const GPT40613

+ const GPT432K0613

type ChatCompletionMessage

+ FunctionCall *FunctionCall

type ChatCompletionRequest

+ FunctionCall string

+ Functions []*FunctionDefine

type Client

+ func (c *Client) GetFileContent(ctx context.Context, fileID string) (content io.ReadCloser, err error)

+ type FinishReason string

+ const FinishReasonContentFilter

+ const FinishReasonFunctionCall

+ const FinishReasonLength

+ const FinishReasonNull

+ const FinishReasonStop

+ type FunctionCall struct

+ Arguments string

+ Name string

+ type FunctionDefine struct

+ Description string

+ Name string

+ Parameters *FunctionParams

+ type FunctionParams struct

+ Properties map[string]*JSONSchemaDefine

+ Required []string

+ Type JSONSchemaType

+ type JSONSchemaDefine struct

+ Description string

+ Enum []string

+ Properties map[string]*JSONSchemaDefine

+ Required []string

+ Type JSONSchemaType

+ type JSONSchemaType string

+ const JSONSchemaTypeArray

+ const JSONSchemaTypeBoolean

+ const JSONSchemaTypeNull

+ const JSONSchemaTypeNumber

+ const JSONSchemaTypeObject

+ const JSONSchemaTypeString

Jun 5, 2023

Changes in this version

type AudioRequest

+ Reader io.Reader

type Client

+ func (c *Client) GetModel(ctx context.Context, modelID string) (model Model, err error)

May 10, 2023

Changes in this version

type ClientConfig

+ AzureModelMapperFunc func(model string) string

+ func (c ClientConfig) GetAzureDeploymentByModel(model string) string

May 3, 2023

Changes in this version

type ChatCompletionStreamChoiceDelta

+ Role string

Apr 30, 2023

Changes in this version

+ const ModerationText001

+ const ModerationTextLatest

+ const ModerationTextStable

type AudioRequest

+ Format AudioResponseFormat

+ func (r AudioRequest) HasJSONResponse() bool

+ type AudioResponseFormat string

+ const AudioResponseFormatJSON

+ const AudioResponseFormatSRT

+ const AudioResponseFormatVTT

Apr 19, 2023

Changes in this version

type APIError

+ HTTPStatusCode int

type ImageEditRequest

+ ResponseFormat string

type ImageVariRequest

+ ResponseFormat string

type RequestError

+ HTTPStatusCode int

Apr 14, 2023

Changes in this version

type APIError

+ func (e *APIError) UnmarshalJSON(data []byte) (err error)

Apr 8, 2023

Changes in this version

type ClientConfig

+ func (ClientConfig) String() string

Apr 4, 2023

Changes in this version

+ const AzureAPIKeyHeader

+ var ErrCompletionRequestPromptTypeNotSupported = errors.New("the type of CompletionRequest.Promp only supports string and []string")

+ type APIType string

+ const APITypeAzure

+ const APITypeAzureAD

+ const APITypeOpenAI

type ClientConfig

+ APIType APIType

+ APIVersion string

+ Engine string

+ func DefaultAzureConfig(apiKey, baseURL, engine string) ClientConfig

Apr 1, 2023

Changes in this version

type ChatCompletionStreamResponse

+ Usage Usage

Mar 20, 2023

Changes in this version

type AudioRequest

+ Language string

+ Prompt string

+ Temperature float32

Mar 18, 2023

Changes in this version

+ var ErrChatCompletionStreamNotSupported = errors.New(...)

+ var ErrCompletionStreamNotSupported = errors.New(...)

Mar 15, 2023

Changes in this version

+ const GPT4

+ const GPT40314

+ const GPT432K

+ const GPT432K0314

type Client

+ func (c *Client) CreateVariImage(ctx context.Context, request ImageVariRequest) (response ImageResponse, err error)

type FineTune

+ FineTuneEventList []FineTuneEvent

+ HyperParams FineTuneHyperParams

+ type ImageVariRequest struct

+ Image *os.File

+ N int

+ Size string

Mar 8, 2023

Changes in this version

type Client

+ func (c *Client) CancelFineTune(ctx context.Context, fineTuneID string) (response FineTune, err error)

+ func (c *Client) CreateFineTune(ctx context.Context, request FineTuneRequest) (response FineTune, err error)

+ func (c *Client) DeleteFineTune(ctx context.Context, fineTuneID string) (response FineTuneDeleteResponse, err error)

+ func (c *Client) GetFineTune(ctx context.Context, fineTuneID string) (response FineTune, err error)

+ func (c *Client) ListFineTuneEvents(ctx context.Context, fineTuneID string) (response FineTuneEventList, err error)

+ func (c *Client) ListFineTunes(ctx context.Context) (response FineTuneList, err error)

+ type FineTune struct

+ CreatedAt int

+ FineTunedModel string

+ Hyperparams FineTuneHyperParams

+ ID string

+ Model string

+ Object string

+ OrganizationID string

+ ResultFiles []File

+ Status string

+ TrainingFiles []File

+ UpdatedAt int

+ ValidationFiles []File

+ type FineTuneDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ type FineTuneEvent struct

+ CreatedAt int

+ Level string

+ Message string

+ Object string

+ type FineTuneEventList struct

+ Data []FineTuneEvent

+ Object string

+ type FineTuneHyperParams struct

+ BatchSize int

+ Epochs int

+ LearningRateMultiplier float64

+ PromptLossWeight float64

+ type FineTuneList struct

+ Data []FineTune

+ Object string

+ type FineTuneRequest struct

+ BatchSize int

+ ClassificationBetas []float32

+ ClassificationClasses int

+ ClassificationPositiveClass string

+ ComputeClassificationMetrics bool

+ Epochs int

+ LearningRateMultiplier float32

+ Model string

+ PromptLossRate float32

+ Suffix string

+ TrainingFile string

+ ValidationFile string

Mar 6, 2023

Changes in this version

+ var ErrCompletionUnsupportedModel = errors.New(...)

type ChatCompletionMessage

+ Name string

Mar 4, 2023

Changes in this version

+ const ChatMessageRoleAssistant

+ const ChatMessageRoleSystem

+ const ChatMessageRoleUser

+ const CodexCodeCushman001

+ const CodexCodeDavinci001

+ const CodexCodeDavinci002

+ const CreateImageResponseFormatB64JSON

+ const CreateImageResponseFormatURL

+ const CreateImageSize1024x1024

+ const CreateImageSize256x256

+ const CreateImageSize512x512

+ const GPT3Ada

+ const GPT3Babbage

+ const GPT3Curie

+ const GPT3CurieInstructBeta

+ const GPT3Davinci

+ const GPT3DavinciInstructBeta

+ const GPT3Dot5Turbo

+ const GPT3Dot5Turbo0301

+ const GPT3TextAda001

+ const GPT3TextBabbage001

+ const GPT3TextCurie001

+ const GPT3TextDavinci001

+ const GPT3TextDavinci002

+ const GPT3TextDavinci003

+ const Whisper1

+ var ErrChatCompletionInvalidModel = errors.New("currently, only gpt-3.5-turbo and gpt-3.5-turbo-0301 are supported")

+ var ErrTooManyEmptyStreamMessages = errors.New("stream has sent too many empty messages")

+ type APIError struct

+ Code *string

+ Message string

+ Param *string

+ StatusCode int

+ Type string

+ func (e *APIError) Error() string

+ type AudioRequest struct

+ FilePath string

+ Model string

+ type AudioResponse struct

+ Text string

+ type ChatCompletionChoice struct

+ FinishReason string

+ Index int

+ Message ChatCompletionMessage

+ type ChatCompletionMessage struct

+ Content string

+ Role string

+ type ChatCompletionRequest struct

+ FrequencyPenalty float32

+ LogitBias map[string]int

+ MaxTokens int

+ Messages []ChatCompletionMessage

+ Model string

+ N int

+ PresencePenalty float32

+ Stop []string

+ Stream bool

+ Temperature float32

+ TopP float32

+ User string

+ type ChatCompletionResponse struct

+ Choices []ChatCompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ Usage Usage

+ type ChatCompletionStream struct

+ func (stream *ChatCompletionStream) Close()

+ func (stream *ChatCompletionStream) GetResponse() *http.Response

+ func (stream *ChatCompletionStream) Recv() (response ChatCompletionStreamResponse, err error)

+ type ChatCompletionStreamChoice struct

+ Delta ChatCompletionStreamChoiceDelta

+ FinishReason string

+ Index int

+ type ChatCompletionStreamChoiceDelta struct

+ Content string

+ type ChatCompletionStreamResponse struct

+ Choices []ChatCompletionStreamChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ type Client struct

+ func NewClient(authToken string) *Client

+ func NewClientWithConfig(config ClientConfig) *Client

+ func NewOrgClient(authToken, org string) *Client

+ func (c *Client) CreateChatCompletion(ctx context.Context, request ChatCompletionRequest) (response ChatCompletionResponse, err error)

+ func (c *Client) CreateChatCompletionStream(ctx context.Context, request ChatCompletionRequest) (stream *ChatCompletionStream, err error)

+ func (c *Client) CreateCompletion(ctx context.Context, request CompletionRequest) (response CompletionResponse, err error)

+ func (c *Client) CreateCompletionStream(ctx context.Context, request CompletionRequest) (stream *CompletionStream, err error)

+ func (c *Client) CreateEditImage(ctx context.Context, request ImageEditRequest) (response ImageResponse, err error)

+ func (c *Client) CreateEmbeddings(ctx context.Context, request EmbeddingRequest) (resp EmbeddingResponse, err error)

+ func (c *Client) CreateFile(ctx context.Context, request FileRequest) (file File, err error)

+ func (c *Client) CreateImage(ctx context.Context, request ImageRequest) (response ImageResponse, err error)

+ func (c *Client) CreateTranscription(ctx context.Context, request AudioRequest) (response AudioResponse, err error)

+ func (c *Client) CreateTranslation(ctx context.Context, request AudioRequest) (response AudioResponse, err error)

+ func (c *Client) DeleteFile(ctx context.Context, fileID string) (err error)

+ func (c *Client) Edits(ctx context.Context, request EditsRequest) (response EditsResponse, err error)

+ func (c *Client) GetEngine(ctx context.Context, engineID string) (engine Engine, err error)

+ func (c *Client) GetFile(ctx context.Context, fileID string) (file File, err error)

+ func (c *Client) ListEngines(ctx context.Context) (engines EnginesList, err error)

+ func (c *Client) ListFiles(ctx context.Context) (files FilesList, err error)

+ func (c *Client) ListModels(ctx context.Context) (models ModelsList, err error)

+ func (c *Client) Moderations(ctx context.Context, request ModerationRequest) (response ModerationResponse, err error)

+ type ClientConfig struct

+ BaseURL string

+ EmptyMessagesLimit uint

+ HTTPClient *http.Client

+ OrgID string

+ func DefaultConfig(authToken string) ClientConfig

+ type CompletionChoice struct

+ FinishReason string

+ Index int

+ LogProbs LogprobResult

+ Text string

+ type CompletionRequest struct

+ BestOf int

+ Echo bool

+ FrequencyPenalty float32

+ LogProbs int

+ LogitBias map[string]int

+ MaxTokens int

+ Model string

+ N int

+ PresencePenalty float32

+ Prompt string

+ Stop []string

+ Stream bool

+ Suffix string

+ Temperature float32

+ TopP float32

+ User string

+ type CompletionResponse struct

+ Choices []CompletionChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ Usage Usage

+ type CompletionStream struct

+ func (stream *CompletionStream) Close()

+ func (stream *CompletionStream) Recv() (response CompletionResponse, err error)

+ type EditsChoice struct

+ Index int

+ Text string

+ type EditsRequest struct

+ Input string

+ Instruction string

+ Model *string

+ N int

+ Temperature float32

+ TopP float32

+ type EditsResponse struct

+ Choices []EditsChoice

+ Created int64

+ Object string

+ Usage Usage

+ type Embedding struct

+ Embedding []float64

+ Index int

+ Object string

+ type EmbeddingModel int

+ const AdaCodeSearchCode

+ const AdaCodeSearchText

+ const AdaEmbeddingV2

+ const AdaSearchDocument

+ const AdaSearchQuery

+ const AdaSimilarity

+ const BabbageCodeSearchCode

+ const BabbageCodeSearchText

+ const BabbageSearchDocument

+ const BabbageSearchQuery

+ const BabbageSimilarity

+ const CurieSearchDocument

+ const CurieSearchQuery

+ const CurieSimilarity

+ const DavinciSearchDocument

+ const DavinciSearchQuery

+ const DavinciSimilarity

+ const Unknown

+ func (e *EmbeddingModel) UnmarshalText(b []byte) error

+ func (e EmbeddingModel) MarshalText() ([]byte, error)

+ func (e EmbeddingModel) String() string

+ type EmbeddingRequest struct

+ Input []string

+ Model EmbeddingModel

+ User string

+ type EmbeddingResponse struct

+ Data []Embedding

+ Model EmbeddingModel

+ Object string

+ Usage Usage

+ type Engine struct

+ ID string

+ Object string

+ Owner string

+ Ready bool

+ type EnginesList struct

+ Engines []Engine

+ type ErrorResponse struct

+ Error *APIError

+ type File struct

+ Bytes int

+ CreatedAt int64

+ FileName string

+ ID string

+ Object string

+ Owner string

+ Purpose string

+ type FileRequest struct

+ FileName string

+ FilePath string

+ Purpose string

+ type FilesList struct

+ Files []File

+ type ImageEditRequest struct

+ Image *os.File

+ Mask *os.File

+ N int

+ Prompt string

+ Size string

+ type ImageRequest struct

+ N int

+ Prompt string

+ ResponseFormat string

+ Size string

+ User string

+ type ImageResponse struct

+ Created int64

+ Data []ImageResponseDataInner

+ type ImageResponseDataInner struct

+ B64JSON string

+ URL string

+ type LogprobResult struct

+ TextOffset []int

+ TokenLogprobs []float32

+ Tokens []string

+ TopLogprobs []map[string]float32

+ type Model struct

+ CreatedAt int64

+ ID string

+ Object string

+ OwnedBy string

+ Parent string

+ Permission []Permission

+ Root string

+ type ModelsList struct

+ Models []Model

+ type ModerationRequest struct

+ Input string

+ Model *string

+ type ModerationResponse struct

+ ID string

+ Model string

+ Results []Result

+ type Permission struct

+ AllowCreateEngine bool

+ AllowFineTuning bool

+ AllowLogprobs bool

+ AllowSampling bool

+ AllowSearchIndices bool

+ AllowView bool

+ CreatedAt int64

+ Group interface{}

+ ID string

+ IsBlocking bool

+ Object string

+ Organization string

+ type RequestError struct

+ Err error

+ StatusCode int

+ func (e *RequestError) Error() string

+ func (e *RequestError) Unwrap() error

+ type Result struct

+ Categories ResultCategories

+ CategoryScores ResultCategoryScores

+ Flagged bool

+ type ResultCategories struct

+ Hate bool

+ HateThreatening bool

+ SelfHarm bool

+ Sexual bool

+ SexualMinors bool

+ Violence bool

+ ViolenceGraphic bool

+ type ResultCategoryScores struct

+ Hate float32

+ HateThreatening float32

+ SelfHarm float32

+ Sexual float32

+ SexualMinors float32

+ Violence float32

+ ViolenceGraphic float32

+ type Usage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int