instructor

package

Go to main page

Versions in this module

v1

v1.0.2

Jan 3, 2025

Changes in this version

+ const DefaultVerbose

v1.0.1

Jan 3, 2025

Changes in this version

type Instructor

+ Verbose func() bool

type InstructorAnthropic

+ func (i *InstructorAnthropic) Verbose() bool

type InstructorCohere

+ func (i *InstructorCohere) Verbose() bool

type InstructorOpenAI

+ func (i *InstructorOpenAI) Verbose() bool

type Options

+ func WithVerbose() Options

v1.0.0

Jan 3, 2025

Changes in this version

+ const DefaultMaxRetries

+ const DefaultValidator

+ const WRAPPER_END

+ func JSONSchema(t reflect.Type) *jsonschema.Schema

+ type Function struct

+ Function FunctionDefinition

+ Type string

+ type FunctionDefinition struct

+ Description string

+ Name string

+ Parameters *jsonschema.Schema

+ func ToFunctionSchema(tType reflect.Type, tSchema *jsonschema.Schema) []FunctionDefinition

+ type Instructor interface

+ MaxRetries func() int

+ Mode func() Mode

+ Provider func() Provider

+ Validate func() bool

+ type InstructorAnthropic struct

+ func FromAnthropic(client *anthropic.Client, opts ...Options) *InstructorAnthropic

+ func (i *InstructorAnthropic) CreateMessages(ctx context.Context, request anthropic.MessagesRequest, responseType any) (response anthropic.MessagesResponse, err error)

+ func (i *InstructorAnthropic) MaxRetries() int

+ func (i *InstructorAnthropic) Mode() string

+ func (i *InstructorAnthropic) Provider() string

+ func (i *InstructorAnthropic) Validate() bool

+ type InstructorCohere struct

+ func FromCohere(client *cohere.Client, opts ...Options) *InstructorCohere

+ func (i *InstructorCohere) Chat(ctx context.Context, request *cohere.ChatRequest, response any, ...) (*cohere.NonStreamedChatResponse, error)

+ func (i *InstructorCohere) ChatStream(ctx context.Context, request *cohere.ChatStreamRequest, responseType any, ...) (<-chan any, error)

+ func (i *InstructorCohere) MaxRetries() int

+ func (i *InstructorCohere) Mode() string

+ func (i *InstructorCohere) Provider() string

+ func (i *InstructorCohere) Validate() bool

+ type InstructorOpenAI struct

+ func FromOpenAI(client *openai.Client, opts ...Options) *InstructorOpenAI

+ func (i *InstructorOpenAI) CreateChatCompletion(ctx context.Context, request openai.ChatCompletionRequest, responseType any) (response openai.ChatCompletionResponse, err error)

+ func (i *InstructorOpenAI) CreateChatCompletionStream(ctx context.Context, request openai.ChatCompletionRequest, responseType any) (stream <-chan any, err error)

+ func (i *InstructorOpenAI) MaxRetries() int

+ func (i *InstructorOpenAI) Mode() Mode

+ func (i *InstructorOpenAI) Provider() Provider

+ func (i *InstructorOpenAI) Validate() bool

+ type Mode = string

+ const ModeDefault

+ const ModeJSON

+ const ModeJSONSchema

+ const ModeJSONStrict

+ const ModeMarkdownJSON

+ const ModeToolCall

+ const ModeToolCallStrict

+ type Options struct

+ MaxRetries *int

+ Mode *Mode

+ func WithMaxRetries(maxRetries int) Options

+ func WithMode(mode Mode) Options

+ func WithValidation() Options

+ type Provider = string

+ const ProviderAnthropic

+ const ProviderCohere

+ const ProviderOpenAI

+ type ResponseFormatSchemaWrapper struct

+ AdditionalProperties bool

+ Definitions *jsonschema.Definitions

+ Properties *jsonschema.Definitions

+ Required []string

+ Type string

+ type Schema struct

+ Functions []FunctionDefinition

+ String string

+ func NewSchema(t reflect.Type) (*Schema, error)

+ func (s *Schema) NameFromRef() string

+ type StreamWrapper struct

+ Items []T

+ type UsageSum struct

+ InputTokens int

+ OutputTokens int

+ TotalTokens int

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