core

Documentation

Index

• type Generative
• type Platform
  • func (p Platform) IsValid() bool
  • func (p Platform) String() string
• type Response
• type Usage

Types

type Generative

type Generative interface {
	// CreateCompletion is an API call to create a completion.
	Completion(ctx context.Context, content string) (resp *Response, err error)
	// GetSummaryPrefix is an API call to get a summary prefix using function call.
	GetSummaryPrefix(ctx context.Context, content string) (resp *Response, err error)
}

type Platform

type Platform string

const (
	OpenAI Platform = "openai"
	Azure  Platform = "azure"
	Gemini Platform = "gemini"
)

func (Platform) IsValid

func (p Platform) IsValid() bool

IsValid returns true if the Platform is valid.

func (Platform) String

func (p Platform) String() string

String returns the string representation of the Platform.

type Response

type Response struct {
	Content string
	Usage   Usage
}

type Usage

type Usage struct {
	PromptTokens     int
	CompletionTokens int
	TotalTokens      int
}