core

type Action ¶

type Action[In, Out, Stream any] struct {
	// contains filtered or unexported fields
}

An Action is a named, observable operation. It consists of a function that takes an input of type I and returns an output of type O, optionally streaming values of type S incrementally by invoking a callback. It optionally has other metadata, like a description and JSON Schemas for its input and output.

Each time an Action is run, it results in a new trace span.

func DefineAction[In, Out any](
	provider, name string,
	atype atype.ActionType,
	metadata map[string]any,
	fn func(context.Context, In) (Out, error),
) *Action[In, Out, struct{}]

func DefineActionInRegistry[In, Out, Stream any](
	r *registry.Registry,
	provider, name string,
	atype atype.ActionType,
	metadata map[string]any,
	inputSchema *jsonschema.Schema,
	fn Func[In, Out, Stream],
) *Action[In, Out, Stream]

func DefineActionWithInputSchema[Out any](
	provider, name string,
	atype atype.ActionType,
	metadata map[string]any,
	inputSchema *jsonschema.Schema,
	fn func(context.Context, any) (Out, error),
) *Action[any, Out, struct{}]

func DefineCustomAction[In, Out, Stream any](provider, name string, metadata map[string]any, fn Func[In, Out, Stream]) *Action[In, Out, Stream]

func DefineStreamingAction[In, Out, Stream any](
	provider, name string,
	atype atype.ActionType,
	metadata map[string]any,
	fn Func[In, Out, Stream],
) *Action[In, Out, Stream]

func LookupActionFor[In, Out, Stream any](typ atype.ActionType, provider, name string) *Action[In, Out, Stream]

func (a *Action[I, O, S]) Desc() action.Desc

func (a *Action[In, Out, Stream]) Name() string

func (a *Action[In, Out, Stream]) Run(ctx context.Context, input In, cb func(context.Context, Stream) error) (output Out, err error)

func (a *Action[In, Out, Stream]) RunJSON(ctx context.Context, input json.RawMessage, cb func(context.Context, json.RawMessage) error) (json.RawMessage, error)

func (a *Action[In, Out, Stream]) SetTracingState(tstate *tracing.State)

type FileFlowStateStore ¶

type FileFlowStateStore struct {
	// contains filtered or unexported fields
}

A FileFlowStateStore is a FlowStateStore that writes flowStates to files.

func NewFileFlowStateStore(dir string) (*FileFlowStateStore, error)

func (s *FileFlowStateStore) Load(ctx context.Context, id string, pfs any) error

func (s *FileFlowStateStore) Save(ctx context.Context, id string, fs base.FlowStater) error

type FlowStateStore ¶

type FlowStateStore interface {
	// Save saves the FlowState to the store, overwriting an existing one.
	Save(ctx context.Context, id string, fs base.FlowStater) error
	// Load reads the FlowState with the given ID from the store.
	// It returns an error that is fs.ErrNotExist if there isn't one.
	// pfs must be a pointer to a flowState[I, O] of the correct type.
	Load(ctx context.Context, id string, pfs any) error
}

A FlowStateStore stores flow states. Every flow state has a unique string identifier. A durable FlowStateStore is necessary for durable flows.

type Func ¶

type Func[In, Out, Stream any] func(context.Context, In, func(context.Context, Stream) error) (Out, error)

Func is the type of function that Actions and Flows execute. It takes an input of type Int and returns an output of type Out, optionally streaming values of type Stream incrementally by invoking a callback. If the StreamingCallback is non-nil and the function supports streaming, it should stream the results by invoking the callback periodically, ultimately returning with a final return value. Otherwise, it should ignore the StreamingCallback and just return a result.