engine

Documentation

Index

• Constants
• func FormatRunSummary(env envs.Environment, run flows.RunSummary) string
• func NewSessionAssets(env envs.Environment, source assets.Source, migrationConfig *migrations.Config) (flows.SessionAssets, error)
• func NewStep(r flows.Run, n flows.Node, arrivedOn time.Time) flows.Step
• func ReadRunSummary(sessionAssets flows.SessionAssets, data []byte, missing assets.MissingCallback) (flows.RunSummary, error)
• type AirtimeServiceFactory
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() flows.Engine
  • func (b *Builder) WithAirtimeServiceFactory(f AirtimeServiceFactory) *Builder
  • func (b *Builder) WithCheckSendable(fn flows.CheckSendableCallback) *Builder
  • func (b *Builder) WithClaimURN(fn flows.ClaimURNCallback) *Builder
  • func (b *Builder) WithEmailServiceFactory(f EmailServiceFactory) *Builder
  • func (b *Builder) WithEvaluationBudget(budget int) *Builder
  • func (b *Builder) WithHTTPClient(client *http.Client) *Builder
  • func (b *Builder) WithLLMPrompts(prompts map[string]*template.Template) *Builder
  • func (b *Builder) WithLLMServiceFactory(f LLMServiceFactory) *Builder
  • func (b *Builder) WithMaxFieldChars(max int) *Builder
  • func (b *Builder) WithMaxNameChars(max int) *Builder
  • func (b *Builder) WithMaxResultChars(max int) *Builder
  • func (b *Builder) WithMaxSprintsPerSession(max int) *Builder
  • func (b *Builder) WithMaxStepsPerSprint(max int) *Builder
  • func (b *Builder) WithMaxTemplateChars(max int) *Builder
  • func (b *Builder) WithWebhookLimits(maxRequestBytes, maxResponseBytes int) *Builder
  • func (b *Builder) WithWebhookServiceFactory(f WebhookServiceFactory) *Builder
• type EmailServiceFactory
• type Error
  • func (e *Error) Code() int
  • func (e *Error) Error() string
• type LLMServiceFactory
• type Path
  • func (p Path) ToXValue(env envs.Environment) types.XValue
• type WebhookServiceFactory

Constants

const (
	ErrorResumeNonWaitingSession int = 101
	ErrorResumeNoWaitingRun      int = 102
	ErrorResumeRejectedByWait    int = 103
)

Functions

func FormatRunSummary

func FormatRunSummary(env envs.Environment, run flows.RunSummary) string

FormatRunSummary formats an instance of the RunSummary interface

func NewSessionAssets

func NewSessionAssets(env envs.Environment, source assets.Source, migrationConfig *migrations.Config) (flows.SessionAssets, error)

NewSessionAssets creates a new session assets instance with the provided base URLs

func NewStep

func NewStep(r flows.Run, n flows.Node, arrivedOn time.Time) flows.Step

NewStep creates a new step

func ReadRunSummary

func ReadRunSummary(sessionAssets flows.SessionAssets, data []byte, missing assets.MissingCallback) (flows.RunSummary, error)

ReadRunSummary reads a run summary from the given JSON

Types

type AirtimeServiceFactory

type AirtimeServiceFactory func(flows.SessionAssets) (flows.AirtimeService, error)

AirtimeServiceFactory resolves a session to an airtime service

type Builder

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

Builder is a builder for engine configs

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates a new engine builder

func (*Builder) Build

func (b *Builder) Build() flows.Engine

Build returns the final engine

func (*Builder) WithAirtimeServiceFactory

func (b *Builder) WithAirtimeServiceFactory(f AirtimeServiceFactory) *Builder

WithAirtimeServiceFactory sets the airtime service factory

func (*Builder) WithCheckSendable

func (b *Builder) WithCheckSendable(fn flows.CheckSendableCallback) *Builder

WithCheckSendable sets the function to use to determine if a message is sendable

func (*Builder) WithClaimURN

func (b *Builder) WithClaimURN(fn flows.ClaimURNCallback) *Builder

WithClaimURN sets the function to use to claim a URN

func (*Builder) WithEmailServiceFactory

func (b *Builder) WithEmailServiceFactory(f EmailServiceFactory) *Builder

WithEmailServiceFactory sets the email service factory

func (*Builder) WithEvaluationBudget

func (b *Builder) WithEvaluationBudget(budget int) *Builder

WithEvaluationBudget sets the cost budget for a single expression evaluation (see excellent.NewEvaluator)

func (*Builder) WithHTTPClient

func (b *Builder) WithHTTPClient(client *http.Client) *Builder

WithHTTPClient sets the HTTP client made available to services such as webhooks. The client's transport can be configured with tracing, mocking or access control as needed (see github.com/nyaruka/gocommon/httpx).

func (*Builder) WithLLMPrompts

func (b *Builder) WithLLMPrompts(prompts map[string]*template.Template) *Builder

WithLLMPrompts sets the LLM prompts to use with LLM services

func (*Builder) WithLLMServiceFactory

func (b *Builder) WithLLMServiceFactory(f LLMServiceFactory) *Builder

WithLLMServiceFactory sets the LLM service factory

func (*Builder) WithMaxFieldChars

func (b *Builder) WithMaxFieldChars(max int) *Builder

WithMaxFieldChars sets the maximum number of characters allowed in a contact field value

func (*Builder) WithMaxNameChars

func (b *Builder) WithMaxNameChars(max int) *Builder

WithMaxNameChars sets the maximum number of characters allowed in a contact name

func (*Builder) WithMaxResultChars

func (b *Builder) WithMaxResultChars(max int) *Builder

WithMaxResultChars sets the maximum number of characters allowed in a result value

func (*Builder) WithMaxSprintsPerSession

func (b *Builder) WithMaxSprintsPerSession(max int) *Builder

WithMaxSprintsPerSession sets the maximum number of resumes allowed in a single session

func (*Builder) WithMaxStepsPerSprint

func (b *Builder) WithMaxStepsPerSprint(max int) *Builder

WithMaxStepsPerSprint sets the maximum number of steps allowed in a single sprint

func (*Builder) WithMaxTemplateChars

func (b *Builder) WithMaxTemplateChars(max int) *Builder

WithMaxTemplateChars sets the maximum number of characters allowed from an evaluated template

func (*Builder) WithWebhookLimits

func (b *Builder) WithWebhookLimits(maxRequestBytes, maxResponseBytes int) *Builder

WithWebhookLimits sets the maximum sizes in bytes of the request and response of a webhook call. A value of zero means no limit.

func (*Builder) WithWebhookServiceFactory

func (b *Builder) WithWebhookServiceFactory(f WebhookServiceFactory) *Builder

WithWebhookServiceFactory sets the webhook service factory

type EmailServiceFactory

type EmailServiceFactory func(flows.SessionAssets) (flows.EmailService, error)

EmailServiceFactory resolves a session to a email service

type Error

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

func (*Error) Code

func (e *Error) Code() int

func (*Error) Error

func (e *Error) Error() string

type LLMServiceFactory

type LLMServiceFactory func(*core.LLM) (flows.LLMService, error)

LLMServiceFactory resolves an LLM asset to to an LLM service

type Path

type Path []flows.Step

Path is the steps taken in a run

func (Path) ToXValue

func (p Path) ToXValue(env envs.Environment) types.XValue

ToXValue returns a representation of this object for use in expressions

type WebhookServiceFactory

type WebhookServiceFactory func(flows.Engine, flows.SessionAssets) (flows.WebhookService, error)

WebhookServiceFactory resolves a session to a webhook service, using the engine's HTTP client and options