cohere

Documentation

Index

• Variables
• type LLM
  • func New(opts ...Option) (*LLM, error)
  • func (o *LLM) Call(ctx context.Context, prompt string, options ...llms.CallOption) (string, error)
  • func (o *LLM) Generate(ctx context.Context, prompts []string, options ...llms.CallOption) ([]*llms.Generation, error)
  • func (o *LLM) GeneratePrompt(ctx context.Context, promptValues []schema.PromptValue, ...) (llms.LLMResult, error)
  • func (o *LLM) GetNumTokens(text string) int
• type Option
  • func WithBaseURL(baseURL string) Option
  • func WithModel(model string) Option
  • func WithToken(token string) Option

Variables

var (
	ErrEmptyResponse = errors.New("no response")
	ErrMissingToken  = errors.New("missing the COHERE_API_KEY key, set it in the COHERE_API_KEY environment variable")

	ErrUnexpectedResponseLength = errors.New("unexpected length of response")
)

Types

type LLM

type LLM struct {
	CallbacksHandler callbacks.Handler
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) (*LLM, error)

func (*LLM) Call

func (o *LLM) Call(ctx context.Context, prompt string, options ...llms.CallOption) (string, error)

func (*LLM) Generate

func (o *LLM) Generate(ctx context.Context, prompts []string, options ...llms.CallOption) ([]*llms.Generation, error)

func (*LLM) GeneratePrompt

func (o *LLM) GeneratePrompt(
	ctx context.Context,
	promptValues []schema.PromptValue,
	options ...llms.CallOption,
) (llms.LLMResult, error)

func (*LLM) GetNumTokens

func (o *LLM) GetNumTokens(text string) int

type Option

type Option func(*options)

func WithBaseURL

func WithBaseURL(baseURL string) Option

WithBaseURL passes the Cohere base url to the client. If not set, the base url is read from the COHERE_BASE_URL environment variable. If still not set in ENV VAR COHERE_BASE_URL, then the default value is https://api.cohere.ai is used.

func WithModel

func WithModel(model string) Option

WithModel passes the Cohere model to the client. If not set, the model is read from the COHERE_MODEL environment variable.

func WithToken

func WithToken(token string) Option

WithToken passes the Cohere API token to the client. If not set, the token is read from the COHERE_API_KEY environment variable.