baml_client

package

v0.203.0 Latest Latest Go to latest Published: Aug 1, 2025 License: Apache-2.0, Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/boundaryml/baml

Links

Documentation ¶

Index ¶

Variables
func TestAllNull(ctx context.Context, input string, opts ...CallOptionFunc) (types.NullableTypes, error)
func TestAllOptionalOmitted(ctx context.Context, input string, opts ...CallOptionFunc) (types.OptionalFields, error)
func TestMixedOptionalNullable(ctx context.Context, input string, opts ...CallOptionFunc) (types.MixedOptionalNullable, error)
func TestNullableTypes(ctx context.Context, input string, opts ...CallOptionFunc) (types.NullableTypes, error)
func TestOptionalFields(ctx context.Context, input string, opts ...CallOptionFunc) (types.OptionalFields, error)
type Audio
- func NewAudioFromBase64(base64 string, mimeType *string) (Audio, error)
- func NewAudioFromUrl(url string, mimeType *string) (Audio, error)
type 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
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 Video
- func NewVideoFromBase64(base64 string, mimeType *string) (Video, error)
- func NewVideoFromUrl(url string, mimeType *string) (Video, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Stream = &stream{}

Functions ¶

func TestAllNull ¶

func TestAllNull(ctx context.Context, input string, opts ...CallOptionFunc) (types.NullableTypes, error)

func TestAllOptionalOmitted ¶

func TestAllOptionalOmitted(ctx context.Context, input string, opts ...CallOptionFunc) (types.OptionalFields, error)

func TestMixedOptionalNullable ¶

func TestMixedOptionalNullable(ctx context.Context, input string, opts ...CallOptionFunc) (types.MixedOptionalNullable, error)

func TestNullableTypes ¶

func TestNullableTypes(ctx context.Context, input string, opts ...CallOptionFunc) (types.NullableTypes, error)

func TestOptionalFields ¶

func TestOptionalFields(ctx context.Context, input string, opts ...CallOptionFunc) (types.OptionalFields, error)

Types ¶

type Audio ¶ added in v0.203.0

type Audio = baml.Audio

func NewAudioFromBase64 ¶ added in v0.203.0

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

func NewAudioFromUrl ¶ added in v0.203.0

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

type CallOptionFunc ¶

type CallOptionFunc func(*callOption)

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 ¶ added in v0.202.0

func WithExperimentalOnTick(onTick baml.TickCallback) CallOptionFunc

type Collector ¶ added in v0.203.0

type Collector = baml.Collector

Constructors

func NewCollector ¶ added in v0.203.0

func NewCollector(name string) (Collector, error)

type Image ¶ added in v0.203.0

type Image = baml.Image

func NewImageFromBase64 ¶ added in v0.203.0

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

func NewImageFromUrl ¶ added in v0.203.0

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

type PDF ¶ added in v0.203.0

type PDF = baml.PDF

func NewPDFFromBase64 ¶ added in v0.203.0

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

func NewPDFFromUrl ¶ added in v0.203.0

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 Video ¶ added in v0.203.0

type Video = baml.Video

func NewVideoFromBase64 ¶ added in v0.203.0

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

func NewVideoFromUrl ¶ added in v0.203.0

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
stream_types
types

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