baml_client

Documentation

Index

• Variables
• func ConsumeSimpleClass(ctx context.Context, item types.SimpleClass, opts ...CallOptionFunc) (types.SimpleClass, error)
• func MakeSimpleClass(ctx context.Context, opts ...CallOptionFunc) (types.SimpleClass, error)
• type Audio
  • func NewAudioFromBase64(base64 string, mimeType *string) (Audio, error)
  • func NewAudioFromUrl(url string, mimeType *string) (Audio, error)
• type CallOptionFunc
  • func WithClient(client string) CallOptionFunc
  • func WithClientRegistry(clientRegistry *baml.ClientRegistry) CallOptionFunc
  • func WithCollector(collector baml.Collector) CallOptionFunc
  • func WithCollectors(collectors []baml.Collector) CallOptionFunc
  • func WithEnv(env map[string]string) CallOptionFunc
  • func WithExperimentalOnTick(onTick baml.TickCallback) CallOptionFunc
  • func WithOnTick(onTick baml.TickCallback) CallOptionFunc
  • func WithTags(tags map[string]string) CallOptionFunc
  • func WithTypeBuilder(tb *TypeBuilder) CallOptionFunc
• type Collector
  • func NewCollector(name string) (Collector, error)
• type Image
  • func NewImageFromBase64(base64 string, mimeType *string) (Image, error)
  • func NewImageFromUrl(url string, mimeType *string) (Image, error)
• type PDF
  • func NewPDFFromBase64(base64 string, mimeType *string) (PDF, error)
  • func NewPDFFromUrl(url string, mimeType *string) (PDF, error)
• type StreamValue
  • func (s *StreamValue[TStream, TFinal]) Final() *TFinal
  • func (s *StreamValue[TStream, TFinal]) Stream() *TStream
• type TypeBuilder
  • func NewTypeBuilder() (*TypeBuilder, error)
• type Video
  • func NewVideoFromBase64(base64 string, mimeType *string) (Video, error)
  • func NewVideoFromUrl(url string, mimeType *string) (Video, error)

Variables

var Parse = &parse{}

var ParseStream = &parse_stream{}

var Stream = &stream{}

Functions

func ConsumeSimpleClass

func ConsumeSimpleClass(ctx context.Context, item types.SimpleClass, opts ...CallOptionFunc) (types.SimpleClass, error)

func MakeSimpleClass

func MakeSimpleClass(ctx context.Context, opts ...CallOptionFunc) (types.SimpleClass, error)

Types

type Audio

type Audio = baml.Audio

func NewAudioFromBase64

func NewAudioFromBase64(base64 string, mimeType *string) (Audio, error)

func NewAudioFromUrl

func NewAudioFromUrl(url string, mimeType *string) (Audio, error)

type CallOptionFunc

type CallOptionFunc func(*callOption)

func WithClient

func WithClient(client string) CallOptionFunc

Set the client for the specific function call (shorthand for ClientRegistry with primary). If both WithClient and WithClientRegistry are used, WithClient takes precedence.

func WithClientRegistry

func WithClientRegistry(clientRegistry *baml.ClientRegistry) CallOptionFunc

Add a client registry to the specific function call.

func WithCollector

func WithCollector(collector baml.Collector) CallOptionFunc

Add collector to the specific function call.

func WithCollectors

func WithCollectors(collectors []baml.Collector) CallOptionFunc

Add multiple collectors to the specific function call.

func WithEnv

func WithEnv(env map[string]string) CallOptionFunc

Modify environment variables for the specific function call.

func WithExperimentalOnTick

func WithExperimentalOnTick(onTick baml.TickCallback) CallOptionFunc

Deprecated: Use WithOnTick instead.

func WithOnTick

func WithOnTick(onTick baml.TickCallback) CallOptionFunc

func WithTags

func WithTags(tags map[string]string) CallOptionFunc

Add tags to the specific function call.

func WithTypeBuilder

func WithTypeBuilder(tb *TypeBuilder) CallOptionFunc

type Collector

type Collector = baml.Collector

Constructors

func NewCollector

func NewCollector(name string) (Collector, error)

type Image

type Image = baml.Image

func NewImageFromBase64

func NewImageFromBase64(base64 string, mimeType *string) (Image, error)

func NewImageFromUrl

func NewImageFromUrl(url string, mimeType *string) (Image, error)

type PDF

type PDF = baml.PDF

func NewPDFFromBase64

func NewPDFFromBase64(base64 string, mimeType *string) (PDF, error)

func NewPDFFromUrl

func NewPDFFromUrl(url string, mimeType *string) (PDF, error)

type StreamValue

type StreamValue[TStream any, TFinal any] struct {
	IsError bool
	Error   error
	IsFinal bool
	// contains filtered or unexported fields
}

func (*StreamValue[TStream, TFinal]) Final

func (s *StreamValue[TStream, TFinal]) Final() *TFinal

func (*StreamValue[TStream, TFinal]) Stream

func (s *StreamValue[TStream, TFinal]) Stream() *TStream

type TypeBuilder

type TypeBuilder = type_builder.TypeBuilder

func NewTypeBuilder

func NewTypeBuilder() (*TypeBuilder, error)

type Video

type Video = baml.Video

func NewVideoFromBase64

func NewVideoFromBase64(base64 string, mimeType *string) (Video, error)

func NewVideoFromUrl

func NewVideoFromUrl(url string, mimeType *string) (Video, error)