openai

package module

Go to main page

Versions in this module

v1

v1.1.2

Jan 10, 2024

Changes in this version

type ChatCompletionStreamResponse

+ ExtraData string

+ ExtraType string

v1.1.1

Dec 11, 2023

Changes in this version

type ChatCompletionRequest

+ ResponseFormat map[string]string

v1.1.0

Nov 26, 2023

v1.0.11

Nov 26, 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

v1.0.10

Nov 21, 2023

v1.0.9

Nov 21, 2023

v1.0.8

Nov 21, 2023

Changes in this version

+ type ChatCompletionStreamError struct

+ Code int

+ Message string

type ChatCompletionStreamResponse

+ Error ChatCompletionStreamError

v1.0.7

Nov 8, 2023

Changes in this version

+ const AzureAPIKeyHeader

+ const ChatMessageRoleAssistant

+ const ChatMessageRoleFunction

+ const ChatMessageRoleSystem

+ const ChatMessageRoleUser

+ const CodexCodeCushman001

+ const CodexCodeDavinci001

+ const CodexCodeDavinci002

+ const CreateImageResponseFormatB64JSON

+ const CreateImageResponseFormatURL

+ const CreateImageSize1024x1024

+ const CreateImageSize256x256

+ const CreateImageSize512x512

+ const GPT3Ada

+ const GPT3Ada002

+ const GPT3Babbage

+ const GPT3Babbage002

+ const GPT3Curie

+ const GPT3Curie002

+ const GPT3CurieInstructBeta

+ const GPT3Davinci

+ const GPT3Davinci002

+ const GPT3DavinciInstructBeta

+ const GPT3Dot5Turbo

+ const GPT3Dot5Turbo0301

+ const GPT3Dot5Turbo0613

+ const GPT3Dot5Turbo16K

+ const GPT3Dot5Turbo16K0613

+ const GPT3Dot5TurboInstruct

+ const GPT3TextAda001

+ const GPT3TextBabbage001

+ const GPT3TextCurie001

+ const GPT3TextDavinci001

+ const GPT3TextDavinci002

+ const GPT3TextDavinci003

+ const GPT4

+ const GPT40314

+ const GPT40613

+ const GPT432K

+ const GPT432K0314

+ const GPT432K0613

+ const ModerationText001

+ const ModerationTextLatest

+ const ModerationTextStable

+ const Whisper1

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

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

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

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

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

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

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

+ type APIError struct

+ Code any

+ HTTPStatusCode int

+ InnerError *InnerError

+ Message string

+ Param *string

+ Type string

+ func (e *APIError) Error() string

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

+ type APIType string

+ const APITypeAzure

+ const APITypeAzureAD

+ const APITypeOpenAI

+ type AudioRequest struct

+ FilePath string

+ Format AudioResponseFormat

+ Language string

+ Model string

+ Prompt string

+ Reader io.Reader

+ Temperature float32

+ func (r AudioRequest) HasJSONResponse() bool

+ type AudioResponse struct

+ Duration float64

+ Language string

+ Segments []struct{ ... }

+ Task string

+ Text string

+ type AudioResponseFormat string

+ const AudioResponseFormatJSON

+ const AudioResponseFormatSRT

+ const AudioResponseFormatText

+ const AudioResponseFormatVTT

+ const AudioResponseFormatVerboseJSON

+ type ChatCompletionChoice struct

+ FinishReason FinishReason

+ Index int

+ Message ChatCompletionMessage

+ type ChatCompletionMessage struct

+ Content string

+ FunctionCall *FunctionCall

+ Name string

+ Role string

+ type ChatCompletionRequest struct

+ FrequencyPenalty *float32

+ FunctionCall any

+ Functions []FunctionDefinition

+ 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

+ type ChatCompletionStreamChoice struct

+ ContentFilterResults ContentFilterResults

+ Delta ChatCompletionStreamChoiceDelta

+ FinishReason FinishReason

+ Index int

+ type ChatCompletionStreamChoiceDelta struct

+ Content string

+ FunctionCall *FunctionCall

+ Role string

+ type ChatCompletionStreamResponse struct

+ Choices []ChatCompletionStreamChoice

+ Created int64

+ ID string

+ Model string

+ Object string

+ PromptAnnotations []PromptAnnotation

+ type Client struct

+ func NewClient(authToken string) *Client

+ func NewClientWithConfig(config ClientConfig) *Client

+ func NewOrgClient(authToken, org string) *Client

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

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

+ 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, conv EmbeddingRequestConverter) (res EmbeddingResponse, err error)

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

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

+ func (c *Client) CreateFineTuningJob(ctx context.Context, request FineTuningJobRequest) (response FineTuningJob, 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) CreateVariImage(ctx context.Context, request ImageVariRequest) (response ImageResponse, err error)

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

+ func (c *Client) DeleteFineTune(ctx context.Context, fineTuneID string) (response FineTuneDeleteResponse, 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) GetFileContent(ctx context.Context, fileID string) (content io.ReadCloser, err error)

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

+ func (c *Client) GetModel(ctx context.Context, modelID string) (model Model, 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) ListFineTuneEvents(ctx context.Context, fineTuneID string) (response FineTuneEventList, err error)

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

+ func (c *Client) ListFineTuningJobEvents(ctx context.Context, fineTuningJobID string, ...) (response FineTuningJobEventList, 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)

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

+ type ClientConfig struct

+ APIType APIType

+ APIVersion string

+ AzureModelMapperFunc func(model string) string

+ BaseURL string

+ EmptyMessagesLimit uint

+ HTTPClient *http.Client

+ HTTPReferer string

+ OrgID string

+ func DefaultAzureConfig(apiKey, baseURL string) ClientConfig

+ func DefaultConfig(authToken string) ClientConfig

+ func (ClientConfig) String() string

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

+ 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 any

+ 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

+ type ContentFilterResults struct

+ Hate Hate

+ SelfHarm SelfHarm

+ Sexual Sexual

+ Violence Violence

+ 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 []float32

+ 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 any

+ Model string

+ User string

+ func (r EmbeddingRequest) Convert() EmbeddingRequest

+ type EmbeddingRequestConverter interface

+ Convert func() EmbeddingRequest

+ type EmbeddingRequestStrings struct

+ Input []string

+ Model string

+ User string

+ func (r EmbeddingRequestStrings) Convert() EmbeddingRequest

+ type EmbeddingRequestTokens struct

+ Input [][]int

+ Model string

+ User string

+ func (r EmbeddingRequestTokens) Convert() EmbeddingRequest

+ type EmbeddingResponse struct

+ Data []Embedding

+ Model string

+ 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 FineTune struct

+ CreatedAt int64

+ FineTuneEventList []FineTuneEvent

+ FineTunedModel string

+ HyperParams FineTuneHyperParams

+ ID string

+ Model string

+ Object string

+ OrganizationID string

+ ResultFiles []File

+ Status string

+ TrainingFiles []File

+ UpdatedAt int64

+ ValidationFiles []File

+ type FineTuneDeleteResponse struct

+ Deleted bool

+ ID string

+ Object string

+ type FineTuneEvent struct

+ CreatedAt int64

+ 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

+ 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 FinishReason string

+ const FinishReasonContentFilter

+ const FinishReasonFunctionCall

+ const FinishReasonLength

+ const FinishReasonNull

+ const FinishReasonStop

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

+ type FunctionCall struct

+ Arguments string

+ Name string

+ type FunctionDefine = FunctionDefinition

+ type FunctionDefinition struct

+ Description string

+ Name string

+ Parameters any

+ type Hate struct

+ Filtered bool

+ Severity string

+ type Hyperparameters struct

+ Epochs int

+ type ImageEditRequest struct

+ Image *os.File

+ Mask *os.File

+ N int

+ Prompt string

+ ResponseFormat 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 ImageVariRequest struct

+ Image *os.File

+ N int

+ ResponseFormat string

+ Size string

+ type InnerError struct

+ Code string

+ ContentFilterResults ContentFilterResults

+ type ListFineTuningJobEventsParameter func(*listFineTuningJobEventsParameters)

+ func ListFineTuningJobEventsWithAfter(after string) ListFineTuningJobEventsParameter

+ func ListFineTuningJobEventsWithLimit(limit int) ListFineTuningJobEventsParameter

+ 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 PromptAnnotation struct

+ ContentFilterResults ContentFilterResults

+ PromptIndex int

+ type RequestError struct

+ Err error

+ HTTPStatusCode 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 SelfHarm struct

+ Filtered bool

+ Severity string

+ type Sexual struct

+ Filtered bool

+ Severity string

+ type StreamReader struct

+ EmptyMessagesLimit uint

+ ErrAccumulator utils.ErrorAccumulator

+ Reader *bufio.Reader

+ Response *http.Response

+ Unmarshaler utils.Unmarshaler

+ func (stream *StreamReader[T]) Close()

+ func (stream *StreamReader[T]) Recv() (response T, err error)

+ type Streamable interface

+ type Usage struct

+ CompletionTokens int

+ PromptTokens int

+ TotalTokens int

+ type Violence struct

+ Filtered bool

+ Severity string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL