@falai/agent 3.4.5 → 4.0.0-alpha.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -34
- package/dist/cjs/core/Agent.d.ts +29 -378
- package/dist/cjs/core/Agent.d.ts.map +1 -1
- package/dist/cjs/core/Agent.js +113 -1178
- package/dist/cjs/core/Agent.js.map +1 -1
- package/dist/cjs/core/CompactionEngine.d.ts.map +1 -1
- package/dist/cjs/core/CompactionEngine.js +5 -3
- package/dist/cjs/core/CompactionEngine.js.map +1 -1
- package/dist/cjs/core/FlowSpec.d.ts +136 -0
- package/dist/cjs/core/FlowSpec.d.ts.map +1 -0
- package/dist/cjs/core/FlowSpec.js +573 -0
- package/dist/cjs/core/FlowSpec.js.map +1 -0
- package/dist/cjs/core/Migrate.d.ts +38 -0
- package/dist/cjs/core/Migrate.d.ts.map +1 -0
- package/dist/cjs/core/Migrate.js +270 -0
- package/dist/cjs/core/Migrate.js.map +1 -0
- package/dist/cjs/core/Prompt.d.ts +54 -0
- package/dist/cjs/core/Prompt.d.ts.map +1 -0
- package/dist/cjs/core/Prompt.js +149 -0
- package/dist/cjs/core/Prompt.js.map +1 -0
- package/dist/cjs/core/Runner.d.ts +171 -0
- package/dist/cjs/core/Runner.d.ts.map +1 -0
- package/dist/cjs/core/Runner.js +1158 -0
- package/dist/cjs/core/Runner.js.map +1 -0
- package/dist/cjs/core/Speak.d.ts +37 -0
- package/dist/cjs/core/Speak.d.ts.map +1 -0
- package/dist/cjs/core/Speak.js +373 -0
- package/dist/cjs/core/Speak.js.map +1 -0
- package/dist/cjs/core/Understand.d.ts +28 -0
- package/dist/cjs/core/Understand.d.ts.map +1 -0
- package/dist/cjs/core/Understand.js +357 -0
- package/dist/cjs/core/Understand.js.map +1 -0
- package/dist/cjs/core/contracts.d.ts +122 -0
- package/dist/cjs/core/contracts.d.ts.map +1 -0
- package/dist/cjs/core/contracts.js +11 -0
- package/dist/cjs/core/contracts.js.map +1 -0
- package/dist/cjs/core/falai.d.ts +57 -0
- package/dist/cjs/core/falai.d.ts.map +1 -0
- package/dist/cjs/core/falai.js +43 -0
- package/dist/cjs/core/falai.js.map +1 -0
- package/dist/cjs/core/predicate.d.ts +9 -0
- package/dist/cjs/core/predicate.d.ts.map +1 -0
- package/dist/cjs/core/predicate.js +58 -0
- package/dist/cjs/core/predicate.js.map +1 -0
- package/dist/cjs/index.d.ts +26 -31
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +46 -68
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/persistence/MemoryStore.d.ts +15 -0
- package/dist/cjs/persistence/MemoryStore.d.ts.map +1 -0
- package/dist/cjs/persistence/MemoryStore.js +39 -0
- package/dist/cjs/persistence/MemoryStore.js.map +1 -0
- package/dist/cjs/persistence/MongoStore.d.ts +42 -0
- package/dist/cjs/persistence/MongoStore.d.ts.map +1 -0
- package/dist/cjs/persistence/MongoStore.js +60 -0
- package/dist/cjs/persistence/MongoStore.js.map +1 -0
- package/dist/cjs/persistence/OpenSearchStore.d.ts +86 -0
- package/dist/cjs/persistence/OpenSearchStore.d.ts.map +1 -0
- package/dist/cjs/persistence/OpenSearchStore.js +120 -0
- package/dist/cjs/persistence/OpenSearchStore.js.map +1 -0
- package/dist/cjs/persistence/PostgresStore.d.ts +41 -0
- package/dist/cjs/persistence/PostgresStore.d.ts.map +1 -0
- package/dist/cjs/persistence/PostgresStore.js +58 -0
- package/dist/cjs/persistence/PostgresStore.js.map +1 -0
- package/dist/cjs/persistence/PrismaStore.d.ts +65 -0
- package/dist/cjs/persistence/PrismaStore.d.ts.map +1 -0
- package/dist/cjs/persistence/PrismaStore.js +95 -0
- package/dist/cjs/persistence/PrismaStore.js.map +1 -0
- package/dist/cjs/persistence/RedisStore.d.ts +34 -0
- package/dist/cjs/persistence/RedisStore.d.ts.map +1 -0
- package/dist/cjs/persistence/RedisStore.js +61 -0
- package/dist/cjs/persistence/RedisStore.js.map +1 -0
- package/dist/cjs/persistence/SQLiteStore.d.ts +45 -0
- package/dist/cjs/persistence/SQLiteStore.d.ts.map +1 -0
- package/dist/cjs/persistence/SQLiteStore.js +74 -0
- package/dist/cjs/persistence/SQLiteStore.js.map +1 -0
- package/dist/cjs/persistence/sessionRow.d.ts +14 -0
- package/dist/cjs/persistence/sessionRow.d.ts.map +1 -0
- package/dist/cjs/persistence/sessionRow.js +50 -0
- package/dist/cjs/persistence/sessionRow.js.map +1 -0
- package/dist/cjs/providers/DeepSeekProvider.d.ts.map +1 -1
- package/dist/cjs/providers/DeepSeekProvider.js +8 -3
- package/dist/cjs/providers/DeepSeekProvider.js.map +1 -1
- package/dist/cjs/providers/GeminiProvider.d.ts +4 -3
- package/dist/cjs/providers/GeminiProvider.d.ts.map +1 -1
- package/dist/cjs/providers/GeminiProvider.js +4 -3
- package/dist/cjs/providers/GeminiProvider.js.map +1 -1
- package/dist/cjs/providers/OpenAICompatibleProvider.d.ts +4 -0
- package/dist/cjs/providers/OpenAICompatibleProvider.d.ts.map +1 -1
- package/dist/cjs/providers/OpenAICompatibleProvider.js +2 -0
- package/dist/cjs/providers/OpenAICompatibleProvider.js.map +1 -1
- package/dist/cjs/providers/OpenRouterProvider.d.ts.map +1 -1
- package/dist/cjs/providers/OpenRouterProvider.js +2 -4
- package/dist/cjs/providers/OpenRouterProvider.js.map +1 -1
- package/dist/cjs/providers/ProviderAdapter.d.ts +11 -6
- package/dist/cjs/providers/ProviderAdapter.d.ts.map +1 -1
- package/dist/cjs/providers/ProviderAdapter.js +33 -10
- package/dist/cjs/providers/ProviderAdapter.js.map +1 -1
- package/dist/cjs/providers/ZaiProvider.d.ts +6 -4
- package/dist/cjs/providers/ZaiProvider.d.ts.map +1 -1
- package/dist/cjs/providers/ZaiProvider.js +6 -4
- package/dist/cjs/providers/ZaiProvider.js.map +1 -1
- package/dist/cjs/types/agent.d.ts +163 -383
- package/dist/cjs/types/agent.d.ts.map +1 -1
- package/dist/cjs/types/agent.js +1 -1
- package/dist/cjs/types/ai.d.ts +32 -1
- package/dist/cjs/types/ai.d.ts.map +1 -1
- package/dist/cjs/types/compaction.d.ts +3 -1
- package/dist/cjs/types/compaction.d.ts.map +1 -1
- package/dist/cjs/types/errors.d.ts +9 -12
- package/dist/cjs/types/errors.d.ts.map +1 -1
- package/dist/cjs/types/errors.js +14 -17
- package/dist/cjs/types/errors.js.map +1 -1
- package/dist/cjs/types/flow.d.ts +265 -513
- package/dist/cjs/types/flow.d.ts.map +1 -1
- package/dist/cjs/types/flow.js +7 -1
- package/dist/cjs/types/flow.js.map +1 -1
- package/dist/cjs/types/history.d.ts +7 -18
- package/dist/cjs/types/history.d.ts.map +1 -1
- package/dist/cjs/types/history.js.map +1 -1
- package/dist/cjs/types/index.d.ts +9 -15
- package/dist/cjs/types/index.d.ts.map +1 -1
- package/dist/cjs/types/index.js +4 -14
- package/dist/cjs/types/index.js.map +1 -1
- package/dist/cjs/types/session.d.ts +94 -64
- package/dist/cjs/types/session.d.ts.map +1 -1
- package/dist/cjs/types/session.js +5 -1
- package/dist/cjs/types/session.js.map +1 -1
- package/dist/cjs/types/tool.d.ts +37 -207
- package/dist/cjs/types/tool.d.ts.map +1 -1
- package/dist/cjs/types/tool.js +5 -14
- package/dist/cjs/types/tool.js.map +1 -1
- package/dist/cjs/utils/clock.d.ts +28 -0
- package/dist/cjs/utils/clock.d.ts.map +1 -0
- package/dist/cjs/utils/clock.js +64 -0
- package/dist/cjs/utils/clock.js.map +1 -0
- package/dist/cjs/utils/duration.d.ts +11 -0
- package/dist/cjs/utils/duration.d.ts.map +1 -0
- package/dist/cjs/utils/duration.js +31 -0
- package/dist/cjs/utils/duration.js.map +1 -0
- package/dist/cjs/utils/history.d.ts +4 -1
- package/dist/cjs/utils/history.d.ts.map +1 -1
- package/dist/cjs/utils/history.js +2 -2
- package/dist/cjs/utils/history.js.map +1 -1
- package/dist/cjs/utils/index.d.ts +4 -10
- package/dist/cjs/utils/index.d.ts.map +1 -1
- package/dist/cjs/utils/index.js +14 -61
- package/dist/cjs/utils/index.js.map +1 -1
- package/dist/cjs/utils/json.d.ts +2 -0
- package/dist/cjs/utils/json.d.ts.map +1 -1
- package/dist/cjs/utils/json.js +5 -0
- package/dist/cjs/utils/json.js.map +1 -1
- package/dist/cjs/utils/outcomes.d.ts +48 -0
- package/dist/cjs/utils/outcomes.d.ts.map +1 -0
- package/dist/cjs/utils/outcomes.js +51 -0
- package/dist/cjs/utils/outcomes.js.map +1 -0
- package/dist/cjs/utils/phrases.d.ts +25 -0
- package/dist/cjs/utils/phrases.d.ts.map +1 -0
- package/dist/cjs/utils/phrases.js +38 -0
- package/dist/cjs/utils/phrases.js.map +1 -0
- package/dist/cjs/utils/schema.d.ts +50 -0
- package/dist/cjs/utils/schema.d.ts.map +1 -0
- package/dist/cjs/utils/schema.js +138 -0
- package/dist/cjs/utils/schema.js.map +1 -0
- package/dist/cjs/utils/streamingMessage.d.ts +3 -2
- package/dist/cjs/utils/streamingMessage.d.ts.map +1 -1
- package/dist/cjs/utils/streamingMessage.js +38 -4
- package/dist/cjs/utils/streamingMessage.js.map +1 -1
- package/dist/cjs/utils/template.d.ts +22 -150
- package/dist/cjs/utils/template.d.ts.map +1 -1
- package/dist/cjs/utils/template.js +64 -359
- package/dist/cjs/utils/template.js.map +1 -1
- package/dist/cjs/utils/usage.d.ts +19 -0
- package/dist/cjs/utils/usage.d.ts.map +1 -0
- package/dist/cjs/utils/usage.js +35 -0
- package/dist/cjs/utils/usage.js.map +1 -0
- package/dist/core/Agent.d.ts +29 -378
- package/dist/core/Agent.d.ts.map +1 -1
- package/dist/core/Agent.js +116 -1181
- package/dist/core/Agent.js.map +1 -1
- package/dist/core/CompactionEngine.d.ts.map +1 -1
- package/dist/core/CompactionEngine.js +5 -3
- package/dist/core/CompactionEngine.js.map +1 -1
- package/dist/core/FlowSpec.d.ts +136 -0
- package/dist/core/FlowSpec.d.ts.map +1 -0
- package/dist/core/FlowSpec.js +567 -0
- package/dist/core/FlowSpec.js.map +1 -0
- package/dist/core/Migrate.d.ts +38 -0
- package/dist/core/Migrate.d.ts.map +1 -0
- package/dist/core/Migrate.js +264 -0
- package/dist/core/Migrate.js.map +1 -0
- package/dist/core/Prompt.d.ts +54 -0
- package/dist/core/Prompt.d.ts.map +1 -0
- package/dist/core/Prompt.js +139 -0
- package/dist/core/Prompt.js.map +1 -0
- package/dist/core/Runner.d.ts +171 -0
- package/dist/core/Runner.d.ts.map +1 -0
- package/dist/core/Runner.js +1154 -0
- package/dist/core/Runner.js.map +1 -0
- package/dist/core/Speak.d.ts +37 -0
- package/dist/core/Speak.d.ts.map +1 -0
- package/dist/core/Speak.js +369 -0
- package/dist/core/Speak.js.map +1 -0
- package/dist/core/Understand.d.ts +28 -0
- package/dist/core/Understand.d.ts.map +1 -0
- package/dist/core/Understand.js +353 -0
- package/dist/core/Understand.js.map +1 -0
- package/dist/core/contracts.d.ts +122 -0
- package/dist/core/contracts.d.ts.map +1 -0
- package/dist/core/contracts.js +10 -0
- package/dist/core/contracts.js.map +1 -0
- package/dist/core/falai.d.ts +57 -0
- package/dist/core/falai.d.ts.map +1 -0
- package/dist/core/falai.js +40 -0
- package/dist/core/falai.js.map +1 -0
- package/dist/core/predicate.d.ts +9 -0
- package/dist/core/predicate.d.ts.map +1 -0
- package/dist/core/predicate.js +54 -0
- package/dist/core/predicate.js.map +1 -0
- package/dist/index.d.ts +26 -31
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -24
- package/dist/index.js.map +1 -1
- package/dist/persistence/MemoryStore.d.ts +15 -0
- package/dist/persistence/MemoryStore.d.ts.map +1 -0
- package/dist/persistence/MemoryStore.js +35 -0
- package/dist/persistence/MemoryStore.js.map +1 -0
- package/dist/persistence/MongoStore.d.ts +42 -0
- package/dist/persistence/MongoStore.d.ts.map +1 -0
- package/dist/persistence/MongoStore.js +56 -0
- package/dist/persistence/MongoStore.js.map +1 -0
- package/dist/persistence/OpenSearchStore.d.ts +86 -0
- package/dist/persistence/OpenSearchStore.d.ts.map +1 -0
- package/dist/persistence/OpenSearchStore.js +116 -0
- package/dist/persistence/OpenSearchStore.js.map +1 -0
- package/dist/persistence/PostgresStore.d.ts +41 -0
- package/dist/persistence/PostgresStore.d.ts.map +1 -0
- package/dist/persistence/PostgresStore.js +54 -0
- package/dist/persistence/PostgresStore.js.map +1 -0
- package/dist/persistence/PrismaStore.d.ts +65 -0
- package/dist/persistence/PrismaStore.d.ts.map +1 -0
- package/dist/persistence/PrismaStore.js +91 -0
- package/dist/persistence/PrismaStore.js.map +1 -0
- package/dist/persistence/RedisStore.d.ts +34 -0
- package/dist/persistence/RedisStore.d.ts.map +1 -0
- package/dist/persistence/RedisStore.js +57 -0
- package/dist/persistence/RedisStore.js.map +1 -0
- package/dist/persistence/SQLiteStore.d.ts +45 -0
- package/dist/persistence/SQLiteStore.d.ts.map +1 -0
- package/dist/persistence/SQLiteStore.js +70 -0
- package/dist/persistence/SQLiteStore.js.map +1 -0
- package/dist/persistence/sessionRow.d.ts +14 -0
- package/dist/persistence/sessionRow.d.ts.map +1 -0
- package/dist/persistence/sessionRow.js +45 -0
- package/dist/persistence/sessionRow.js.map +1 -0
- package/dist/providers/DeepSeekProvider.d.ts.map +1 -1
- package/dist/providers/DeepSeekProvider.js +8 -3
- package/dist/providers/DeepSeekProvider.js.map +1 -1
- package/dist/providers/GeminiProvider.d.ts +4 -3
- package/dist/providers/GeminiProvider.d.ts.map +1 -1
- package/dist/providers/GeminiProvider.js +4 -3
- package/dist/providers/GeminiProvider.js.map +1 -1
- package/dist/providers/OpenAICompatibleProvider.d.ts +4 -0
- package/dist/providers/OpenAICompatibleProvider.d.ts.map +1 -1
- package/dist/providers/OpenAICompatibleProvider.js +2 -0
- package/dist/providers/OpenAICompatibleProvider.js.map +1 -1
- package/dist/providers/OpenRouterProvider.d.ts.map +1 -1
- package/dist/providers/OpenRouterProvider.js +2 -4
- package/dist/providers/OpenRouterProvider.js.map +1 -1
- package/dist/providers/ProviderAdapter.d.ts +11 -6
- package/dist/providers/ProviderAdapter.d.ts.map +1 -1
- package/dist/providers/ProviderAdapter.js +34 -11
- package/dist/providers/ProviderAdapter.js.map +1 -1
- package/dist/providers/ZaiProvider.d.ts +6 -4
- package/dist/providers/ZaiProvider.d.ts.map +1 -1
- package/dist/providers/ZaiProvider.js +6 -4
- package/dist/providers/ZaiProvider.js.map +1 -1
- package/dist/types/agent.d.ts +163 -383
- package/dist/types/agent.d.ts.map +1 -1
- package/dist/types/agent.js +1 -1
- package/dist/types/ai.d.ts +32 -1
- package/dist/types/ai.d.ts.map +1 -1
- package/dist/types/compaction.d.ts +3 -1
- package/dist/types/compaction.d.ts.map +1 -1
- package/dist/types/errors.d.ts +9 -12
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +12 -15
- package/dist/types/errors.js.map +1 -1
- package/dist/types/flow.d.ts +265 -513
- package/dist/types/flow.d.ts.map +1 -1
- package/dist/types/flow.js +7 -1
- package/dist/types/flow.js.map +1 -1
- package/dist/types/history.d.ts +7 -18
- package/dist/types/history.d.ts.map +1 -1
- package/dist/types/history.js.map +1 -1
- package/dist/types/index.d.ts +9 -15
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +2 -7
- package/dist/types/index.js.map +1 -1
- package/dist/types/session.d.ts +94 -64
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +5 -1
- package/dist/types/session.js.map +1 -1
- package/dist/types/tool.d.ts +37 -207
- package/dist/types/tool.d.ts.map +1 -1
- package/dist/types/tool.js +6 -13
- package/dist/types/tool.js.map +1 -1
- package/dist/utils/clock.d.ts +28 -0
- package/dist/utils/clock.d.ts.map +1 -0
- package/dist/utils/clock.js +59 -0
- package/dist/utils/clock.js.map +1 -0
- package/dist/utils/duration.d.ts +11 -0
- package/dist/utils/duration.d.ts.map +1 -0
- package/dist/utils/duration.js +26 -0
- package/dist/utils/duration.js.map +1 -0
- package/dist/utils/history.d.ts +4 -1
- package/dist/utils/history.d.ts.map +1 -1
- package/dist/utils/history.js +2 -2
- package/dist/utils/history.js.map +1 -1
- package/dist/utils/index.d.ts +4 -10
- package/dist/utils/index.d.ts.map +1 -1
- package/dist/utils/index.js +4 -21
- package/dist/utils/index.js.map +1 -1
- package/dist/utils/json.d.ts +2 -0
- package/dist/utils/json.d.ts.map +1 -1
- package/dist/utils/json.js +4 -0
- package/dist/utils/json.js.map +1 -1
- package/dist/utils/outcomes.d.ts +48 -0
- package/dist/utils/outcomes.d.ts.map +1 -0
- package/dist/utils/outcomes.js +48 -0
- package/dist/utils/outcomes.js.map +1 -0
- package/dist/utils/phrases.d.ts +25 -0
- package/dist/utils/phrases.d.ts.map +1 -0
- package/dist/utils/phrases.js +35 -0
- package/dist/utils/phrases.js.map +1 -0
- package/dist/utils/schema.d.ts +50 -0
- package/dist/utils/schema.d.ts.map +1 -0
- package/dist/utils/schema.js +129 -0
- package/dist/utils/schema.js.map +1 -0
- package/dist/utils/streamingMessage.d.ts +3 -2
- package/dist/utils/streamingMessage.d.ts.map +1 -1
- package/dist/utils/streamingMessage.js +38 -4
- package/dist/utils/streamingMessage.js.map +1 -1
- package/dist/utils/template.d.ts +22 -150
- package/dist/utils/template.d.ts.map +1 -1
- package/dist/utils/template.js +61 -351
- package/dist/utils/template.js.map +1 -1
- package/dist/utils/usage.d.ts +19 -0
- package/dist/utils/usage.d.ts.map +1 -0
- package/dist/utils/usage.js +31 -0
- package/dist/utils/usage.js.map +1 -0
- package/docs/README.md +37 -19
- package/docs/concepts/architecture.md +117 -239
- package/docs/concepts/collection.md +170 -0
- package/docs/concepts/pipeline.md +132 -378
- package/docs/concepts/runs-and-waits.md +192 -0
- package/docs/guides/actions-and-events.md +276 -0
- package/docs/guides/branching.md +119 -208
- package/docs/guides/compaction.md +63 -158
- package/docs/guides/conditions.md +164 -128
- package/docs/guides/error-handling.md +170 -164
- package/docs/guides/flow-control.md +210 -349
- package/docs/guides/flows-from-json.md +224 -0
- package/docs/guides/instructions.md +125 -161
- package/docs/guides/persistence.md +182 -206
- package/docs/guides/streaming.md +50 -114
- package/docs/guides/testing.md +284 -0
- package/docs/guides/triggers.md +401 -0
- package/docs/migration/README.md +8 -15
- package/docs/migration/v1-to-v2.md +1 -1
- package/docs/migration/v2-3-to-v2-4.md +2 -2
- package/docs/migration/v2-6-to-v2-7.md +4 -4
- package/docs/migration/v3-to-v4.md +457 -0
- package/docs/reference/actions-events-conditions.md +396 -0
- package/docs/reference/agent.md +248 -0
- package/docs/reference/branches.md +75 -203
- package/docs/reference/errors.md +188 -144
- package/docs/reference/fields.md +125 -0
- package/docs/reference/flow-spec.md +248 -0
- package/docs/reference/flow.md +104 -192
- package/docs/reference/instruction.md +83 -137
- package/docs/reference/outcomes.md +273 -0
- package/docs/reference/providers.md +525 -302
- package/docs/reference/session.md +210 -0
- package/docs/reference/step.md +194 -312
- package/docs/reference/stores.md +496 -0
- package/docs/reference/tool.md +162 -231
- package/docs/reference/trigger.md +200 -0
- package/docs/rfc/v4-one-flow.md +477 -0
- package/docs/start/01-install.md +59 -44
- package/docs/start/02-first-agent.md +97 -147
- package/docs/start/03-collect-data.md +78 -183
- package/docs/start/04-add-tools.md +159 -227
- package/docs/start/05-go-to-production.md +181 -163
- package/examples/01-quickstart.ts +26 -16
- package/examples/02-fields.ts +75 -0
- package/examples/03-tools.ts +79 -119
- package/examples/04-instructions.ts +60 -87
- package/examples/05-branches.ts +78 -0
- package/examples/06-triggers-and-waits.ts +149 -0
- package/examples/07-streaming.ts +34 -60
- package/examples/08-store-and-migration.ts +97 -0
- package/examples/09-flows-from-json.ts +107 -0
- package/package.json +11 -6
- package/src/core/Agent.ts +126 -1512
- package/src/core/CompactionEngine.ts +7 -4
- package/src/core/FlowSpec.ts +778 -0
- package/src/core/Migrate.ts +256 -0
- package/src/core/Prompt.ts +162 -0
- package/src/core/Runner.ts +1214 -0
- package/src/core/Speak.ts +460 -0
- package/src/core/Understand.ts +423 -0
- package/src/core/contracts.ts +111 -0
- package/src/core/falai.ts +86 -0
- package/src/core/predicate.ts +56 -0
- package/src/index.ts +120 -147
- package/src/persistence/MemoryStore.ts +37 -0
- package/src/persistence/MongoStore.ts +89 -0
- package/src/persistence/OpenSearchStore.ts +153 -0
- package/src/persistence/PostgresStore.ts +89 -0
- package/src/persistence/PrismaStore.ts +127 -0
- package/src/persistence/RedisStore.ts +90 -0
- package/src/persistence/SQLiteStore.ts +103 -0
- package/src/persistence/sessionRow.ts +45 -0
- package/src/providers/DeepSeekProvider.ts +8 -3
- package/src/providers/GeminiProvider.ts +4 -3
- package/src/providers/OpenAICompatibleProvider.ts +6 -0
- package/src/providers/OpenRouterProvider.ts +2 -4
- package/src/providers/ProviderAdapter.ts +46 -13
- package/src/providers/ZaiProvider.ts +6 -4
- package/src/types/agent.ts +135 -397
- package/src/types/ai.ts +33 -1
- package/src/types/compaction.ts +3 -1
- package/src/types/errors.ts +13 -16
- package/src/types/flow.ts +249 -550
- package/src/types/history.ts +7 -20
- package/src/types/index.ts +88 -139
- package/src/types/session.ts +135 -70
- package/src/types/tool.ts +42 -267
- package/src/utils/clock.ts +70 -0
- package/src/utils/duration.ts +33 -0
- package/src/utils/history.ts +3 -2
- package/src/utils/index.ts +8 -66
- package/src/utils/json.ts +5 -0
- package/src/utils/outcomes.ts +56 -0
- package/src/utils/phrases.ts +40 -0
- package/src/utils/schema.ts +145 -0
- package/src/utils/streamingMessage.ts +34 -4
- package/src/utils/template.ts +63 -418
- package/src/utils/usage.ts +37 -0
- package/dist/adapters/MemoryAdapter.d.ts +0 -47
- package/dist/adapters/MemoryAdapter.d.ts.map +0 -1
- package/dist/adapters/MemoryAdapter.js +0 -204
- package/dist/adapters/MemoryAdapter.js.map +0 -1
- package/dist/adapters/MongoAdapter.d.ts +0 -97
- package/dist/adapters/MongoAdapter.d.ts.map +0 -1
- package/dist/adapters/MongoAdapter.js +0 -196
- package/dist/adapters/MongoAdapter.js.map +0 -1
- package/dist/adapters/OpenSearchAdapter.d.ts +0 -169
- package/dist/adapters/OpenSearchAdapter.d.ts.map +0 -1
- package/dist/adapters/OpenSearchAdapter.js +0 -471
- package/dist/adapters/OpenSearchAdapter.js.map +0 -1
- package/dist/adapters/PostgreSQLAdapter.d.ts +0 -85
- package/dist/adapters/PostgreSQLAdapter.d.ts.map +0 -1
- package/dist/adapters/PostgreSQLAdapter.js +0 -308
- package/dist/adapters/PostgreSQLAdapter.js.map +0 -1
- package/dist/adapters/PrismaAdapter.d.ts +0 -115
- package/dist/adapters/PrismaAdapter.d.ts.map +0 -1
- package/dist/adapters/PrismaAdapter.js +0 -406
- package/dist/adapters/PrismaAdapter.js.map +0 -1
- package/dist/adapters/RedisAdapter.d.ts +0 -72
- package/dist/adapters/RedisAdapter.d.ts.map +0 -1
- package/dist/adapters/RedisAdapter.js +0 -286
- package/dist/adapters/RedisAdapter.js.map +0 -1
- package/dist/adapters/SQLiteAdapter.d.ts +0 -86
- package/dist/adapters/SQLiteAdapter.d.ts.map +0 -1
- package/dist/adapters/SQLiteAdapter.js +0 -337
- package/dist/adapters/SQLiteAdapter.js.map +0 -1
- package/dist/adapters/index.d.ts +0 -17
- package/dist/adapters/index.d.ts.map +0 -1
- package/dist/adapters/index.js +0 -11
- package/dist/adapters/index.js.map +0 -1
- package/dist/adapters/sessionRow.d.ts +0 -22
- package/dist/adapters/sessionRow.d.ts.map +0 -1
- package/dist/adapters/sessionRow.js +0 -48
- package/dist/adapters/sessionRow.js.map +0 -1
- package/dist/cjs/adapters/MemoryAdapter.d.ts +0 -47
- package/dist/cjs/adapters/MemoryAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/MemoryAdapter.js +0 -208
- package/dist/cjs/adapters/MemoryAdapter.js.map +0 -1
- package/dist/cjs/adapters/MongoAdapter.d.ts +0 -97
- package/dist/cjs/adapters/MongoAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/MongoAdapter.js +0 -200
- package/dist/cjs/adapters/MongoAdapter.js.map +0 -1
- package/dist/cjs/adapters/OpenSearchAdapter.d.ts +0 -169
- package/dist/cjs/adapters/OpenSearchAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/OpenSearchAdapter.js +0 -475
- package/dist/cjs/adapters/OpenSearchAdapter.js.map +0 -1
- package/dist/cjs/adapters/PostgreSQLAdapter.d.ts +0 -85
- package/dist/cjs/adapters/PostgreSQLAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/PostgreSQLAdapter.js +0 -312
- package/dist/cjs/adapters/PostgreSQLAdapter.js.map +0 -1
- package/dist/cjs/adapters/PrismaAdapter.d.ts +0 -115
- package/dist/cjs/adapters/PrismaAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/PrismaAdapter.js +0 -410
- package/dist/cjs/adapters/PrismaAdapter.js.map +0 -1
- package/dist/cjs/adapters/RedisAdapter.d.ts +0 -72
- package/dist/cjs/adapters/RedisAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/RedisAdapter.js +0 -290
- package/dist/cjs/adapters/RedisAdapter.js.map +0 -1
- package/dist/cjs/adapters/SQLiteAdapter.d.ts +0 -86
- package/dist/cjs/adapters/SQLiteAdapter.d.ts.map +0 -1
- package/dist/cjs/adapters/SQLiteAdapter.js +0 -341
- package/dist/cjs/adapters/SQLiteAdapter.js.map +0 -1
- package/dist/cjs/adapters/index.d.ts +0 -17
- package/dist/cjs/adapters/index.d.ts.map +0 -1
- package/dist/cjs/adapters/index.js +0 -21
- package/dist/cjs/adapters/index.js.map +0 -1
- package/dist/cjs/adapters/sessionRow.d.ts +0 -22
- package/dist/cjs/adapters/sessionRow.d.ts.map +0 -1
- package/dist/cjs/adapters/sessionRow.js +0 -52
- package/dist/cjs/adapters/sessionRow.js.map +0 -1
- package/dist/cjs/constants/index.d.ts +0 -1
- package/dist/cjs/constants/index.d.ts.map +0 -1
- package/dist/cjs/constants/index.js +0 -4
- package/dist/cjs/constants/index.js.map +0 -1
- package/dist/cjs/core/AutoChainExecutor.d.ts +0 -97
- package/dist/cjs/core/AutoChainExecutor.d.ts.map +0 -1
- package/dist/cjs/core/AutoChainExecutor.js +0 -288
- package/dist/cjs/core/AutoChainExecutor.js.map +0 -1
- package/dist/cjs/core/BranchEvaluator.d.ts +0 -55
- package/dist/cjs/core/BranchEvaluator.d.ts.map +0 -1
- package/dist/cjs/core/BranchEvaluator.js +0 -125
- package/dist/cjs/core/BranchEvaluator.js.map +0 -1
- package/dist/cjs/core/DirectiveChainTracker.d.ts +0 -49
- package/dist/cjs/core/DirectiveChainTracker.d.ts.map +0 -1
- package/dist/cjs/core/DirectiveChainTracker.js +0 -121
- package/dist/cjs/core/DirectiveChainTracker.js.map +0 -1
- package/dist/cjs/core/Events.d.ts +0 -26
- package/dist/cjs/core/Events.d.ts.map +0 -1
- package/dist/cjs/core/Events.js +0 -144
- package/dist/cjs/core/Events.js.map +0 -1
- package/dist/cjs/core/Flow.d.ts +0 -183
- package/dist/cjs/core/Flow.d.ts.map +0 -1
- package/dist/cjs/core/Flow.js +0 -551
- package/dist/cjs/core/Flow.js.map +0 -1
- package/dist/cjs/core/FlowRouter.d.ts +0 -183
- package/dist/cjs/core/FlowRouter.d.ts.map +0 -1
- package/dist/cjs/core/FlowRouter.js +0 -1047
- package/dist/cjs/core/FlowRouter.js.map +0 -1
- package/dist/cjs/core/PersistenceManager.d.ts +0 -114
- package/dist/cjs/core/PersistenceManager.d.ts.map +0 -1
- package/dist/cjs/core/PersistenceManager.js +0 -336
- package/dist/cjs/core/PersistenceManager.js.map +0 -1
- package/dist/cjs/core/PromptComposer.d.ts +0 -47
- package/dist/cjs/core/PromptComposer.d.ts.map +0 -1
- package/dist/cjs/core/PromptComposer.js +0 -397
- package/dist/cjs/core/PromptComposer.js.map +0 -1
- package/dist/cjs/core/PromptSectionCache.d.ts +0 -48
- package/dist/cjs/core/PromptSectionCache.d.ts.map +0 -1
- package/dist/cjs/core/PromptSectionCache.js +0 -108
- package/dist/cjs/core/PromptSectionCache.js.map +0 -1
- package/dist/cjs/core/ResponseEngine.d.ts +0 -43
- package/dist/cjs/core/ResponseEngine.d.ts.map +0 -1
- package/dist/cjs/core/ResponseEngine.js +0 -235
- package/dist/cjs/core/ResponseEngine.js.map +0 -1
- package/dist/cjs/core/ResponseGenerationError.d.ts +0 -30
- package/dist/cjs/core/ResponseGenerationError.d.ts.map +0 -1
- package/dist/cjs/core/ResponseGenerationError.js +0 -35
- package/dist/cjs/core/ResponseGenerationError.js.map +0 -1
- package/dist/cjs/core/ResponseModal.d.ts +0 -305
- package/dist/cjs/core/ResponseModal.d.ts.map +0 -1
- package/dist/cjs/core/ResponseModal.js +0 -1414
- package/dist/cjs/core/ResponseModal.js.map +0 -1
- package/dist/cjs/core/ResponsePipeline.d.ts +0 -220
- package/dist/cjs/core/ResponsePipeline.d.ts.map +0 -1
- package/dist/cjs/core/ResponsePipeline.js +0 -1040
- package/dist/cjs/core/ResponsePipeline.js.map +0 -1
- package/dist/cjs/core/SessionFinalizer.d.ts +0 -34
- package/dist/cjs/core/SessionFinalizer.d.ts.map +0 -1
- package/dist/cjs/core/SessionFinalizer.js +0 -88
- package/dist/cjs/core/SessionFinalizer.js.map +0 -1
- package/dist/cjs/core/SessionManager.d.ts +0 -112
- package/dist/cjs/core/SessionManager.d.ts.map +0 -1
- package/dist/cjs/core/SessionManager.js +0 -308
- package/dist/cjs/core/SessionManager.js.map +0 -1
- package/dist/cjs/core/SignalCoordinator.d.ts +0 -103
- package/dist/cjs/core/SignalCoordinator.d.ts.map +0 -1
- package/dist/cjs/core/SignalCoordinator.js +0 -207
- package/dist/cjs/core/SignalCoordinator.js.map +0 -1
- package/dist/cjs/core/SignalEvaluator.d.ts +0 -86
- package/dist/cjs/core/SignalEvaluator.d.ts.map +0 -1
- package/dist/cjs/core/SignalEvaluator.js +0 -319
- package/dist/cjs/core/SignalEvaluator.js.map +0 -1
- package/dist/cjs/core/SignalProcessor.d.ts +0 -152
- package/dist/cjs/core/SignalProcessor.d.ts.map +0 -1
- package/dist/cjs/core/SignalProcessor.js +0 -505
- package/dist/cjs/core/SignalProcessor.js.map +0 -1
- package/dist/cjs/core/Step.d.ts +0 -184
- package/dist/cjs/core/Step.d.ts.map +0 -1
- package/dist/cjs/core/Step.js +0 -599
- package/dist/cjs/core/Step.js.map +0 -1
- package/dist/cjs/core/StepLifecycle.d.ts +0 -43
- package/dist/cjs/core/StepLifecycle.d.ts.map +0 -1
- package/dist/cjs/core/StepLifecycle.js +0 -180
- package/dist/cjs/core/StepLifecycle.js.map +0 -1
- package/dist/cjs/core/StreamingToolExecutor.d.ts +0 -142
- package/dist/cjs/core/StreamingToolExecutor.d.ts.map +0 -1
- package/dist/cjs/core/StreamingToolExecutor.js +0 -490
- package/dist/cjs/core/StreamingToolExecutor.js.map +0 -1
- package/dist/cjs/core/ToolLoopExecutor.d.ts +0 -133
- package/dist/cjs/core/ToolLoopExecutor.d.ts.map +0 -1
- package/dist/cjs/core/ToolLoopExecutor.js +0 -568
- package/dist/cjs/core/ToolLoopExecutor.js.map +0 -1
- package/dist/cjs/core/ToolManager.d.ts +0 -250
- package/dist/cjs/core/ToolManager.d.ts.map +0 -1
- package/dist/cjs/core/ToolManager.js +0 -1104
- package/dist/cjs/core/ToolManager.js.map +0 -1
- package/dist/cjs/core/createAgent.d.ts +0 -35
- package/dist/cjs/core/createAgent.d.ts.map +0 -1
- package/dist/cjs/core/createAgent.js +0 -39
- package/dist/cjs/core/createAgent.js.map +0 -1
- package/dist/cjs/core/flow-namespace.d.ts +0 -64
- package/dist/cjs/core/flow-namespace.d.ts.map +0 -1
- package/dist/cjs/core/flow-namespace.js +0 -182
- package/dist/cjs/core/flow-namespace.js.map +0 -1
- package/dist/cjs/core/toolGates.d.ts +0 -24
- package/dist/cjs/core/toolGates.d.ts.map +0 -1
- package/dist/cjs/core/toolGates.js +0 -52
- package/dist/cjs/core/toolGates.js.map +0 -1
- package/dist/cjs/types/persistence.d.ts +0 -254
- package/dist/cjs/types/persistence.d.ts.map +0 -1
- package/dist/cjs/types/persistence.js +0 -7
- package/dist/cjs/types/persistence.js.map +0 -1
- package/dist/cjs/types/prompt-cache.d.ts +0 -15
- package/dist/cjs/types/prompt-cache.d.ts.map +0 -1
- package/dist/cjs/types/prompt-cache.js +0 -6
- package/dist/cjs/types/prompt-cache.js.map +0 -1
- package/dist/cjs/types/signals.d.ts +0 -263
- package/dist/cjs/types/signals.d.ts.map +0 -1
- package/dist/cjs/types/signals.js +0 -11
- package/dist/cjs/types/signals.js.map +0 -1
- package/dist/cjs/types/template.d.ts +0 -84
- package/dist/cjs/types/template.d.ts.map +0 -1
- package/dist/cjs/types/template.js +0 -3
- package/dist/cjs/types/template.js.map +0 -1
- package/dist/cjs/utils/condition.d.ts +0 -63
- package/dist/cjs/utils/condition.d.ts.map +0 -1
- package/dist/cjs/utils/condition.js +0 -239
- package/dist/cjs/utils/condition.js.map +0 -1
- package/dist/cjs/utils/event.d.ts +0 -6
- package/dist/cjs/utils/event.d.ts.map +0 -1
- package/dist/cjs/utils/event.js +0 -20
- package/dist/cjs/utils/event.js.map +0 -1
- package/dist/cjs/utils/id.d.ts +0 -33
- package/dist/cjs/utils/id.d.ts.map +0 -1
- package/dist/cjs/utils/id.js +0 -84
- package/dist/cjs/utils/id.js.map +0 -1
- package/dist/cjs/utils/serialize.d.ts +0 -36
- package/dist/cjs/utils/serialize.d.ts.map +0 -1
- package/dist/cjs/utils/serialize.js +0 -77
- package/dist/cjs/utils/serialize.js.map +0 -1
- package/dist/cjs/utils/session.d.ts +0 -124
- package/dist/cjs/utils/session.d.ts.map +0 -1
- package/dist/cjs/utils/session.js +0 -396
- package/dist/cjs/utils/session.js.map +0 -1
- package/dist/constants/index.d.ts +0 -2
- package/dist/constants/index.d.ts.map +0 -1
- package/dist/constants/index.js +0 -4
- package/dist/constants/index.js.map +0 -1
- package/dist/core/AutoChainExecutor.d.ts +0 -97
- package/dist/core/AutoChainExecutor.d.ts.map +0 -1
- package/dist/core/AutoChainExecutor.js +0 -284
- package/dist/core/AutoChainExecutor.js.map +0 -1
- package/dist/core/BranchEvaluator.d.ts +0 -55
- package/dist/core/BranchEvaluator.d.ts.map +0 -1
- package/dist/core/BranchEvaluator.js +0 -121
- package/dist/core/BranchEvaluator.js.map +0 -1
- package/dist/core/DirectiveChainTracker.d.ts +0 -49
- package/dist/core/DirectiveChainTracker.d.ts.map +0 -1
- package/dist/core/DirectiveChainTracker.js +0 -117
- package/dist/core/DirectiveChainTracker.js.map +0 -1
- package/dist/core/Events.d.ts +0 -26
- package/dist/core/Events.d.ts.map +0 -1
- package/dist/core/Events.js +0 -137
- package/dist/core/Events.js.map +0 -1
- package/dist/core/Flow.d.ts +0 -183
- package/dist/core/Flow.d.ts.map +0 -1
- package/dist/core/Flow.js +0 -547
- package/dist/core/Flow.js.map +0 -1
- package/dist/core/FlowRouter.d.ts +0 -183
- package/dist/core/FlowRouter.d.ts.map +0 -1
- package/dist/core/FlowRouter.js +0 -1043
- package/dist/core/FlowRouter.js.map +0 -1
- package/dist/core/PersistenceManager.d.ts +0 -114
- package/dist/core/PersistenceManager.d.ts.map +0 -1
- package/dist/core/PersistenceManager.js +0 -332
- package/dist/core/PersistenceManager.js.map +0 -1
- package/dist/core/PromptComposer.d.ts +0 -47
- package/dist/core/PromptComposer.d.ts.map +0 -1
- package/dist/core/PromptComposer.js +0 -393
- package/dist/core/PromptComposer.js.map +0 -1
- package/dist/core/PromptSectionCache.d.ts +0 -48
- package/dist/core/PromptSectionCache.d.ts.map +0 -1
- package/dist/core/PromptSectionCache.js +0 -104
- package/dist/core/PromptSectionCache.js.map +0 -1
- package/dist/core/ResponseEngine.d.ts +0 -43
- package/dist/core/ResponseEngine.d.ts.map +0 -1
- package/dist/core/ResponseEngine.js +0 -231
- package/dist/core/ResponseEngine.js.map +0 -1
- package/dist/core/ResponseGenerationError.d.ts +0 -30
- package/dist/core/ResponseGenerationError.d.ts.map +0 -1
- package/dist/core/ResponseGenerationError.js +0 -31
- package/dist/core/ResponseGenerationError.js.map +0 -1
- package/dist/core/ResponseModal.d.ts +0 -305
- package/dist/core/ResponseModal.d.ts.map +0 -1
- package/dist/core/ResponseModal.js +0 -1410
- package/dist/core/ResponseModal.js.map +0 -1
- package/dist/core/ResponsePipeline.d.ts +0 -220
- package/dist/core/ResponsePipeline.d.ts.map +0 -1
- package/dist/core/ResponsePipeline.js +0 -1035
- package/dist/core/ResponsePipeline.js.map +0 -1
- package/dist/core/SessionFinalizer.d.ts +0 -34
- package/dist/core/SessionFinalizer.d.ts.map +0 -1
- package/dist/core/SessionFinalizer.js +0 -84
- package/dist/core/SessionFinalizer.js.map +0 -1
- package/dist/core/SessionManager.d.ts +0 -112
- package/dist/core/SessionManager.d.ts.map +0 -1
- package/dist/core/SessionManager.js +0 -301
- package/dist/core/SessionManager.js.map +0 -1
- package/dist/core/SignalCoordinator.d.ts +0 -103
- package/dist/core/SignalCoordinator.d.ts.map +0 -1
- package/dist/core/SignalCoordinator.js +0 -203
- package/dist/core/SignalCoordinator.js.map +0 -1
- package/dist/core/SignalEvaluator.d.ts +0 -86
- package/dist/core/SignalEvaluator.d.ts.map +0 -1
- package/dist/core/SignalEvaluator.js +0 -312
- package/dist/core/SignalEvaluator.js.map +0 -1
- package/dist/core/SignalProcessor.d.ts +0 -152
- package/dist/core/SignalProcessor.d.ts.map +0 -1
- package/dist/core/SignalProcessor.js +0 -498
- package/dist/core/SignalProcessor.js.map +0 -1
- package/dist/core/Step.d.ts +0 -184
- package/dist/core/Step.d.ts.map +0 -1
- package/dist/core/Step.js +0 -594
- package/dist/core/Step.js.map +0 -1
- package/dist/core/StepLifecycle.d.ts +0 -43
- package/dist/core/StepLifecycle.d.ts.map +0 -1
- package/dist/core/StepLifecycle.js +0 -176
- package/dist/core/StepLifecycle.js.map +0 -1
- package/dist/core/StreamingToolExecutor.d.ts +0 -142
- package/dist/core/StreamingToolExecutor.d.ts.map +0 -1
- package/dist/core/StreamingToolExecutor.js +0 -483
- package/dist/core/StreamingToolExecutor.js.map +0 -1
- package/dist/core/ToolLoopExecutor.d.ts +0 -133
- package/dist/core/ToolLoopExecutor.d.ts.map +0 -1
- package/dist/core/ToolLoopExecutor.js +0 -564
- package/dist/core/ToolLoopExecutor.js.map +0 -1
- package/dist/core/ToolManager.d.ts +0 -250
- package/dist/core/ToolManager.d.ts.map +0 -1
- package/dist/core/ToolManager.js +0 -1098
- package/dist/core/ToolManager.js.map +0 -1
- package/dist/core/createAgent.d.ts +0 -35
- package/dist/core/createAgent.d.ts.map +0 -1
- package/dist/core/createAgent.js +0 -36
- package/dist/core/createAgent.js.map +0 -1
- package/dist/core/flow-namespace.d.ts +0 -64
- package/dist/core/flow-namespace.d.ts.map +0 -1
- package/dist/core/flow-namespace.js +0 -179
- package/dist/core/flow-namespace.js.map +0 -1
- package/dist/core/toolGates.d.ts +0 -24
- package/dist/core/toolGates.d.ts.map +0 -1
- package/dist/core/toolGates.js +0 -49
- package/dist/core/toolGates.js.map +0 -1
- package/dist/types/persistence.d.ts +0 -254
- package/dist/types/persistence.d.ts.map +0 -1
- package/dist/types/persistence.js +0 -6
- package/dist/types/persistence.js.map +0 -1
- package/dist/types/prompt-cache.d.ts +0 -15
- package/dist/types/prompt-cache.d.ts.map +0 -1
- package/dist/types/prompt-cache.js +0 -5
- package/dist/types/prompt-cache.js.map +0 -1
- package/dist/types/signals.d.ts +0 -263
- package/dist/types/signals.d.ts.map +0 -1
- package/dist/types/signals.js +0 -10
- package/dist/types/signals.js.map +0 -1
- package/dist/types/template.d.ts +0 -84
- package/dist/types/template.d.ts.map +0 -1
- package/dist/types/template.js +0 -2
- package/dist/types/template.js.map +0 -1
- package/dist/utils/condition.d.ts +0 -63
- package/dist/utils/condition.d.ts.map +0 -1
- package/dist/utils/condition.js +0 -230
- package/dist/utils/condition.js.map +0 -1
- package/dist/utils/event.d.ts +0 -6
- package/dist/utils/event.d.ts.map +0 -1
- package/dist/utils/event.js +0 -17
- package/dist/utils/event.js.map +0 -1
- package/dist/utils/id.d.ts +0 -33
- package/dist/utils/id.d.ts.map +0 -1
- package/dist/utils/id.js +0 -77
- package/dist/utils/id.js.map +0 -1
- package/dist/utils/serialize.d.ts +0 -36
- package/dist/utils/serialize.d.ts.map +0 -1
- package/dist/utils/serialize.js +0 -72
- package/dist/utils/serialize.js.map +0 -1
- package/dist/utils/session.d.ts +0 -124
- package/dist/utils/session.d.ts.map +0 -1
- package/dist/utils/session.js +0 -379
- package/dist/utils/session.js.map +0 -1
- package/docs/concepts/directives.md +0 -369
- package/docs/reference/adapters.md +0 -543
- package/docs/reference/create-agent.md +0 -216
- package/docs/reference/directive.md +0 -242
- package/docs/reference/signals.md +0 -368
- package/examples/02-data-extraction.ts +0 -90
- package/examples/05-branching.ts +0 -140
- package/examples/06-flow-control.ts +0 -103
- package/examples/08-persistence.ts +0 -98
- package/examples/09-signals.ts +0 -144
- package/src/adapters/MemoryAdapter.ts +0 -281
- package/src/adapters/MongoAdapter.ts +0 -341
- package/src/adapters/OpenSearchAdapter.ts +0 -693
- package/src/adapters/PostgreSQLAdapter.ts +0 -487
- package/src/adapters/PrismaAdapter.ts +0 -617
- package/src/adapters/RedisAdapter.ts +0 -439
- package/src/adapters/SQLiteAdapter.ts +0 -496
- package/src/adapters/index.ts +0 -43
- package/src/adapters/sessionRow.ts +0 -57
- package/src/constants/index.ts +0 -2
- package/src/core/AutoChainExecutor.ts +0 -397
- package/src/core/BranchEvaluator.ts +0 -161
- package/src/core/DirectiveChainTracker.ts +0 -144
- package/src/core/Events.ts +0 -164
- package/src/core/Flow.ts +0 -665
- package/src/core/FlowRouter.ts +0 -1540
- package/src/core/PersistenceManager.ts +0 -446
- package/src/core/PromptComposer.ts +0 -448
- package/src/core/PromptSectionCache.ts +0 -125
- package/src/core/ResponseEngine.ts +0 -338
- package/src/core/ResponseGenerationError.ts +0 -53
- package/src/core/ResponseModal.ts +0 -1902
- package/src/core/ResponsePipeline.ts +0 -1404
- package/src/core/SessionFinalizer.ts +0 -108
- package/src/core/SessionManager.ts +0 -372
- package/src/core/SignalCoordinator.ts +0 -263
- package/src/core/SignalEvaluator.ts +0 -404
- package/src/core/SignalProcessor.ts +0 -663
- package/src/core/Step.ts +0 -782
- package/src/core/StepLifecycle.ts +0 -242
- package/src/core/StreamingToolExecutor.ts +0 -609
- package/src/core/ToolLoopExecutor.ts +0 -749
- package/src/core/ToolManager.ts +0 -1379
- package/src/core/createAgent.ts +0 -40
- package/src/core/flow-namespace.ts +0 -227
- package/src/core/toolGates.ts +0 -72
- package/src/types/persistence.ts +0 -303
- package/src/types/prompt-cache.ts +0 -17
- package/src/types/signals.ts +0 -338
- package/src/types/template.ts +0 -98
- package/src/utils/condition.ts +0 -296
- package/src/utils/event.ts +0 -16
- package/src/utils/id.ts +0 -91
- package/src/utils/serialize.ts +0 -86
- package/src/utils/session.ts +0 -501
|
@@ -1,368 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: "Signals"
|
|
3
|
-
description: "Typed event detectors that run before and after each LLM turn, with optional structured extraction and rate-limited firing."
|
|
4
|
-
type: reference
|
|
5
|
-
order: 9
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Signals
|
|
9
|
-
|
|
10
|
-
> **Where this is introduced:** [Turn pipeline](../concepts/pipeline.md)
|
|
11
|
-
|
|
12
|
-
A `Signal` is a typed event detector that runs around an LLM turn. Each signal pairs a *condition* (`when` / `if`) with a *handler* that returns a `SignalDirective`. Signals optionally carry an `extract` schema for structured data extraction beyond boolean detection, run at two pipeline phases (PRE-SIGNAL parallel with routing, POST-SIGNAL after the LLM), are rate-limited (`once` / `always` / `cooldown`), and surface their firings on `AgentResponse.triggeredSignals`.
|
|
13
|
-
|
|
14
|
-
Signals operate in two modes:
|
|
15
|
-
|
|
16
|
-
- **Detection mode** — no `extract`. Boolean match/no-match via a batched classifier call. Multiple signals share one LLM call.
|
|
17
|
-
- **Extraction mode** — `extract` set. Structured data extraction merged into the same batched call. The handler receives `ctx.extracted` typed by the `TExtract` generic.
|
|
18
|
-
|
|
19
|
-
When `agent.signals` is empty or undefined, both phases short-circuit to zero cost — no extra provider calls.
|
|
20
|
-
|
|
21
|
-
## Signature
|
|
22
|
-
|
|
23
|
-
```typescript
|
|
24
|
-
interface Signal<TContext = unknown, TData = unknown, TExtract = void> {
|
|
25
|
-
// Identity
|
|
26
|
-
id?: string;
|
|
27
|
-
title?: string;
|
|
28
|
-
description?: string;
|
|
29
|
-
|
|
30
|
-
// Conditions (v2 when/if split)
|
|
31
|
-
when?: string | string[];
|
|
32
|
-
if?: SignalPredicate<TContext, TData> | SignalPredicate<TContext, TData>[];
|
|
33
|
-
|
|
34
|
-
// Optional structured extraction
|
|
35
|
-
extract?: SignalSchema<TExtract>;
|
|
36
|
-
|
|
37
|
-
// Phase + handler
|
|
38
|
-
phase: 'pre' | 'post' | 'both';
|
|
39
|
-
handler: (ctx: SignalContext<TContext, TData, TExtract>) =>
|
|
40
|
-
| void
|
|
41
|
-
| SignalDirective<TContext, TData>
|
|
42
|
-
| Promise<void | SignalDirective<TContext, TData>>;
|
|
43
|
-
|
|
44
|
-
// Rate limiting
|
|
45
|
-
behavior?: 'once' | 'always' | 'cooldown';
|
|
46
|
-
cooldownMs?: number;
|
|
47
|
-
|
|
48
|
-
// Misc
|
|
49
|
-
enabled?: boolean;
|
|
50
|
-
priority?: number;
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
type SignalSchema<_T = unknown> = Record<string, unknown>;
|
|
54
|
-
|
|
55
|
-
type SignalPredicate<TContext = unknown, TData = unknown> = (
|
|
56
|
-
ctx: SignalPredicateContext<TContext, TData>,
|
|
57
|
-
) => boolean | Promise<boolean>;
|
|
58
|
-
|
|
59
|
-
interface SignalPredicateContext<TContext = unknown, TData = unknown> {
|
|
60
|
-
data: Partial<TData>;
|
|
61
|
-
context: TContext;
|
|
62
|
-
session: SessionState<TData>;
|
|
63
|
-
history: Event[];
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
interface SignalContext<TContext = unknown, TData = unknown, TExtract = void> {
|
|
67
|
-
signal: Signal<TContext, TData, TExtract>;
|
|
68
|
-
phase: 'pre' | 'post';
|
|
69
|
-
matched: true;
|
|
70
|
-
reason: string;
|
|
71
|
-
extracted: TExtract extends void ? undefined : TExtract;
|
|
72
|
-
|
|
73
|
-
session: SessionState<TData>;
|
|
74
|
-
context: TContext;
|
|
75
|
-
data: Partial<TData>;
|
|
76
|
-
history: Event[];
|
|
77
|
-
lastUserMessage?: string;
|
|
78
|
-
triggeredAt: Date;
|
|
79
|
-
|
|
80
|
-
updateContext(updates: Partial<TContext>): Promise<void>;
|
|
81
|
-
updateData(updates: Partial<TData>): Promise<void>;
|
|
82
|
-
dispatch(directive: SignalDirective<TContext, TData>): void;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
interface SignalDirective<TContext = unknown, TData = unknown>
|
|
86
|
-
extends Directive<TContext, TData> {
|
|
87
|
-
stopOtherSignals?: boolean;
|
|
88
|
-
replyWith?: string | ((ctx: SignalContext<TContext, TData>) => string);
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
// As reported on the response surface: replyWith already resolved onto reply
|
|
92
|
-
type ResolvedSignalDirective<TContext = unknown, TData = unknown> =
|
|
93
|
-
Directive<TContext, TData> & { stopOtherSignals?: boolean };
|
|
94
|
-
|
|
95
|
-
interface SignalFiring<TContext = unknown, TData = unknown> {
|
|
96
|
-
id: string;
|
|
97
|
-
phase: 'pre' | 'post';
|
|
98
|
-
reason?: string;
|
|
99
|
-
extracted?: unknown;
|
|
100
|
-
directive?: ResolvedSignalDirective<TContext, TData>;
|
|
101
|
-
handlerError?: string;
|
|
102
|
-
extractionError?: string;
|
|
103
|
-
durationMs?: number;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
interface SignalsState {
|
|
107
|
-
triggers: Record<string, SignalTriggerState>;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
interface SignalTriggerState {
|
|
111
|
-
firstTriggeredAt: Date;
|
|
112
|
-
lastTriggeredAt: Date;
|
|
113
|
-
count: number;
|
|
114
|
-
lastReason?: string;
|
|
115
|
-
lastPhase?: 'pre' | 'post';
|
|
116
|
-
}
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
Signals are wired into the agent through two `AgentOptions` fields:
|
|
120
|
-
|
|
121
|
-
```typescript
|
|
122
|
-
interface AgentOptions<TContext, TData> {
|
|
123
|
-
// ... other fields ...
|
|
124
|
-
signals?: Signal<TContext, TData, unknown>[];
|
|
125
|
-
signalBatchSize?: number; // default 10
|
|
126
|
-
}
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
## Fields
|
|
130
|
-
|
|
131
|
-
### `Signal`
|
|
132
|
-
|
|
133
|
-
| Field | Type | Required | Default | Notes |
|
|
134
|
-
|-------|------|----------|---------|-------|
|
|
135
|
-
| `id` | `string` | no | auto-generated | Stable identifier within a session. Used for `SignalsState.triggers` keying and on `SignalFiring`. Must be unique across the agent's signals. |
|
|
136
|
-
| `title` | `string` | no | — | Display title shown in logs and traces. |
|
|
137
|
-
| `description` | `string` | no | — | Free-text description; rendered into the classifier prompt. |
|
|
138
|
-
| `when` | `string \| string[]` | no | — | AI-evaluated condition(s), using the same `ConditionWhen` include/exclude syntax as flows, steps, branches, and instructions. Non-prefixed entries render under "TRIGGER WHEN" (OR semantics — any match can trigger). Entries prefixed with `!` are exclusion conditions rendered under "DO NOT TRIGGER WHEN" (OR semantics — any match inhibits firing). |
|
|
139
|
-
| `if` | `SignalPredicate \| SignalPredicate[]` | no | — | Code predicate(s). AND semantics. Free to evaluate. Runs before `when`; if any returns `false`, `when` is skipped (no token cost). |
|
|
140
|
-
| `extract` | `SignalSchema<TExtract>` | no | — | When set, the signal operates in extraction mode. JSON Schema object describing the per-signal `extracted` field merged into the classifier response. The `TExtract` generic carries the resulting type onto `ctx.extracted`. |
|
|
141
|
-
| `phase` | `'pre' \| 'post' \| 'both'` | yes | — | When the signal evaluates. `'pre'` runs in parallel with routing. `'post'` runs after the LLM call, before persistence. `'both'` evaluates in both phases. |
|
|
142
|
-
| `handler` | `(ctx) => void \| SignalDirective \| Promise<…>` | yes | — | Invoked when the signal fires. May return a directive, dispatch one via `ctx.dispatch`, or return void for side-effect-only behavior. |
|
|
143
|
-
| `behavior` | `'once' \| 'always' \| 'cooldown'` | no | `'always'` | Rate-limit / dedup mode. `'once'` fires once per session. `'cooldown'` requires `cooldownMs`. |
|
|
144
|
-
| `cooldownMs` | `number` | conditional | — | Required when `behavior === 'cooldown'`. Suppresses re-firing for this duration after the last trigger. Misconfiguration logs a debug warning and falls back to `'always'`. |
|
|
145
|
-
| `enabled` | `boolean` | no | `true` | When `false`, the signal is filtered out at the start of the phase. |
|
|
146
|
-
| `priority` | `number` | no | `0` | Higher priority handlers run first within a phase. Ties break by declaration order in `agent.signals`. |
|
|
147
|
-
|
|
148
|
-
### `SignalPredicateContext`
|
|
149
|
-
|
|
150
|
-
Passed to every `if` predicate. Symmetric with `BranchPredicateContext`.
|
|
151
|
-
|
|
152
|
-
| Field | Type | Notes |
|
|
153
|
-
|-------|------|-------|
|
|
154
|
-
| `data` | `Partial<TData>` | Collected data so far. Fields not yet collected are `undefined`. |
|
|
155
|
-
| `context` | `TContext` | Ambient agent context. |
|
|
156
|
-
| `session` | `SessionState<TData>` | Full session state, including `session.signals` for inspecting prior triggers. |
|
|
157
|
-
| `history` | `Event[]` | Conversation history as native events. |
|
|
158
|
-
|
|
159
|
-
A predicate that throws is treated as a non-match — other signals continue evaluating.
|
|
160
|
-
|
|
161
|
-
### `SignalContext`
|
|
162
|
-
|
|
163
|
-
Passed to handlers when a signal fires. Symmetric with `ToolContext`.
|
|
164
|
-
|
|
165
|
-
| Field | Type | Notes |
|
|
166
|
-
|-------|------|-------|
|
|
167
|
-
| `signal` | `Signal<TContext, TData, TExtract>` | The signal definition that fired. |
|
|
168
|
-
| `phase` | `'pre' \| 'post'` | Which phase this firing belongs to. Useful when `signal.phase === 'both'`. |
|
|
169
|
-
| `matched` | `true` | Always `true` when the handler runs. Typed for narrowing. |
|
|
170
|
-
| `reason` | `string` | AI rationale when `when` matched, or `'code-only'` / `'unconditional'`. |
|
|
171
|
-
| `extracted` | `TExtract extends void ? undefined : TExtract` | Extracted data when `signal.extract` is set; `undefined` for detection-only signals. |
|
|
172
|
-
| `session` | `SessionState<TData>` | Session state. Use writers below for mutations. |
|
|
173
|
-
| `context` | `TContext` | Ambient agent context. |
|
|
174
|
-
| `data` | `Partial<TData>` | Collected data (partial). |
|
|
175
|
-
| `history` | `Event[]` | Conversation history. |
|
|
176
|
-
| `lastUserMessage` | `string \| undefined` | Convenience accessor for the most recent user message. |
|
|
177
|
-
| `triggeredAt` | `Date` | Wall-clock timestamp when the handler started. |
|
|
178
|
-
| `updateContext` | `(updates) => Promise<void>` | Shallow-merge into `context`. Same contract as `ToolContext.updateContext`. |
|
|
179
|
-
| `updateData` | `(updates) => Promise<void>` | Shallow-merge into `data`. Same contract as `ToolContext.updateData`. |
|
|
180
|
-
| `dispatch` | `(directive) => void` | Emit a `SignalDirective` onto the per-turn bus. May be called multiple times; emissions merge by Algorithm 4 alongside hook and tool directives. |
|
|
181
|
-
|
|
182
|
-
### `SignalDirective`
|
|
183
|
-
|
|
184
|
-
Extends [`Directive`](./directive.md). All position fields (`goTo`, `goToStep`, `complete`, `abort`, `reset`), state writes (`dataUpdate`, `contextUpdate`), `reply`, and pre-LLM fields (`appendPrompt`, `injectTools`, `halt`) are inherited unchanged.
|
|
185
|
-
|
|
186
|
-
| Added field | Type | Notes |
|
|
187
|
-
|-------------|------|-------|
|
|
188
|
-
| `stopOtherSignals` | `boolean` | When `true`, skip remaining signals in the current phase after this handler. Does not affect the other phase. Consumed inside the signal pipeline — does not enter the directive bus. |
|
|
189
|
-
| `replyWith` | `string \| ((ctx) => string)` | Late-binding `reply`. String form is identical to `Directive.reply`. Function form is evaluated at emit time and projected onto `reply` before bus merging. |
|
|
190
|
-
|
|
191
|
-
**Post-phase drop rules.** When a signal runs in the post-phase, `appendPrompt`, `injectTools`, and `halt` are dropped with a debug warning — they have no meaning after the LLM call has already completed. Position directives in the post-phase set `session.pendingDirective` for the *next* turn (no mid-turn re-entry).
|
|
192
|
-
|
|
193
|
-
### `ResolvedSignalDirective`
|
|
194
|
-
|
|
195
|
-
The directive shape as reported on the response surface (`SignalFiring.directive`). The signal processor resolves `replyWith` onto `reply` and strips it before firings reach `AgentResponse` — so a `ResolvedSignalDirective` is a plain [`Directive`](./directive.md) plus `stopOtherSignals`, with the reply text (if any) always on `reply`. Exported from the package barrel.
|
|
196
|
-
|
|
197
|
-
### `SignalFiring`
|
|
198
|
-
|
|
199
|
-
One entry per signal that fired this turn. Populated in fire order across both phases on `AgentResponse.triggeredSignals` (and on the final chunk of `AgentResponseStreamChunk`). Mirrors the observability framing of `executedSteps` and `appliedInstructions`.
|
|
200
|
-
|
|
201
|
-
| Field | Type | Notes |
|
|
202
|
-
|-------|------|-------|
|
|
203
|
-
| `id` | `string` | The signal's identifier. |
|
|
204
|
-
| `phase` | `'pre' \| 'post'` | Phase the signal fired in. |
|
|
205
|
-
| `reason` | `string \| undefined` | AI rationale, `'code-only'`, or `'unconditional'`. |
|
|
206
|
-
| `extracted` | `unknown` | Extracted payload when in extraction mode. |
|
|
207
|
-
| `directive` | `ResolvedSignalDirective \| undefined` | The directive returned (or dispatched) by the handler, with `replyWith` already resolved onto `reply`. |
|
|
208
|
-
| `handlerError` | `string \| undefined` | Error message if the handler threw. The turn continues — handler errors never break a turn. |
|
|
209
|
-
| `extractionError` | `string \| undefined` | Set when an extraction-mode signal matched but the classifier returned no `extracted` payload (model omitted the field or returned `null`). The handler still runs with `extracted: undefined`; this makes the miss observable instead of silent. Independent of `handlerError`. |
|
|
210
|
-
| `durationMs` | `number \| undefined` | Wall-clock duration of the handler invocation. |
|
|
211
|
-
|
|
212
|
-
### `SignalsState` and `SignalTriggerState`
|
|
213
|
-
|
|
214
|
-
Persisted on `session.signals`. Adapters preserve this shape bit-identical.
|
|
215
|
-
|
|
216
|
-
`SignalsState` has a single field, `triggers: Record<string, SignalTriggerState>`, keyed by `signal.id`.
|
|
217
|
-
|
|
218
|
-
| `SignalTriggerState` field | Type | Notes |
|
|
219
|
-
|----------------------------|------|-------|
|
|
220
|
-
| `firstTriggeredAt` | `Date` | When this signal first completed its handler successfully in the session. Never updated on subsequent successful triggers. |
|
|
221
|
-
| `lastTriggeredAt` | `Date` | When this signal last completed its handler successfully. Drives `cooldown` arithmetic. |
|
|
222
|
-
| `count` | `number` | Total successful handler completions for this signal in this session. Monotonically increasing. |
|
|
223
|
-
| `lastReason` | `string \| undefined` | The `reason` from the most recent successful trigger. |
|
|
224
|
-
| `lastPhase` | `'pre' \| 'post' \| undefined` | The phase of the most recent successful trigger. |
|
|
225
|
-
|
|
226
|
-
Handler errors are still surfaced on `SignalFiring.handlerError`, but they do not update `SignalsState.triggers`. A `behavior: 'once'` or cooldown signal can therefore retry after an app-side handler failure.
|
|
227
|
-
|
|
228
|
-
### `signalBatchSize`
|
|
229
|
-
|
|
230
|
-
Maximum signals per batched classifier call. Default `10`. When more LLM-conditioned signals are eligible after gating, they split into parallel batches of this size — each batch is one provider call, all batches run via `Promise.all`. Setting this to `0` or a non-integer throws `FlowConfigurationError` at agent construction.
|
|
231
|
-
|
|
232
|
-
## Phase semantics
|
|
233
|
-
|
|
234
|
-
| Capability | Pre-phase | Post-phase |
|
|
235
|
-
|---|---|---|
|
|
236
|
-
| `halt` | Skips the LLM call | Dropped with debug warning |
|
|
237
|
-
| `reply` / `replyWith` | Replaces the message that would have been generated | Replaces the message that was just generated |
|
|
238
|
-
| `goTo` / `goToStep` | Overrides routing for this turn | Sets `pendingDirective` for next turn |
|
|
239
|
-
| `complete` | This turn closes the flow | Same |
|
|
240
|
-
| `appendPrompt` | Injected into this turn's response prompt | Dropped with debug warning |
|
|
241
|
-
| `injectTools` | Available to this turn's LLM | Dropped with debug warning |
|
|
242
|
-
| `dataUpdate` / `contextUpdate` | Applied before LLM, visible in prompt | Applied, persisted |
|
|
243
|
-
| `extract` results | Available to handler pre-LLM | Available to handler post-LLM |
|
|
244
|
-
| `stopOtherSignals` | Stops further pre-signals | Stops further post-signals |
|
|
245
|
-
|
|
246
|
-
### Resolution precedence within a turn
|
|
247
|
-
|
|
248
|
-
Per turn, position decisions are resolved in this fixed order:
|
|
249
|
-
|
|
250
|
-
1. **`session.pendingDirective`** (set last turn or via `agent.dispatch()`) — consumed first.
|
|
251
|
-
2. **PRE-SIGNAL phase directives** (parallel with routing). Position fields override routing; `halt` discards routing entirely.
|
|
252
|
-
3. **AI routing** — used only if (1) and (2) produced no position field.
|
|
253
|
-
4. **Auto-step chain.**
|
|
254
|
-
5. **Step branches.**
|
|
255
|
-
6. **Linear successor / AI step selection** — final fallback.
|
|
256
|
-
7. **POST-SIGNAL phase directives** — set `pendingDirective` for the *next* turn.
|
|
257
|
-
|
|
258
|
-
## Examples
|
|
259
|
-
|
|
260
|
-
### 1. Pre-phase halt with verbatim reply (escalation)
|
|
261
|
-
|
|
262
|
-
A handoff signal that intercepts the turn before the LLM runs, notifies a side channel, and replies with a fixed message. Cooldown prevents re-notification within the hour.
|
|
263
|
-
|
|
264
|
-
```typescript
|
|
265
|
-
import type { Signal } from "@falai/agent";
|
|
266
|
-
|
|
267
|
-
type Ctx = { conversationId: string };
|
|
268
|
-
type Data = { topic?: string };
|
|
269
|
-
|
|
270
|
-
export const humanHandoff: Signal<Ctx, Data> = {
|
|
271
|
-
id: "human_handoff",
|
|
272
|
-
title: "Human handoff requested",
|
|
273
|
-
description: "Lead asks to talk to a real person.",
|
|
274
|
-
when: [
|
|
275
|
-
"the user explicitly asks to talk to a human, agent, or representative",
|
|
276
|
-
"the user explicitly says they do not want to talk to a bot",
|
|
277
|
-
"!casual mentions of people (e.g., 'my colleague said')",
|
|
278
|
-
"!general frustration without an explicit handoff request",
|
|
279
|
-
],
|
|
280
|
-
phase: "pre",
|
|
281
|
-
behavior: "cooldown",
|
|
282
|
-
cooldownMs: 60 * 60_000, // 1 hour
|
|
283
|
-
priority: 100,
|
|
284
|
-
async handler({ session, lastUserMessage }) {
|
|
285
|
-
await notifyTeam(session.id, lastUserMessage);
|
|
286
|
-
return {
|
|
287
|
-
halt: true,
|
|
288
|
-
replyWith: "I'm connecting you with someone from our team. They'll reach out shortly.",
|
|
289
|
-
stopOtherSignals: true,
|
|
290
|
-
};
|
|
291
|
-
},
|
|
292
|
-
};
|
|
293
|
-
```
|
|
294
|
-
|
|
295
|
-
### 2. Post-phase extraction (entity capture)
|
|
296
|
-
|
|
297
|
-
A signal that runs after every LLM turn, extracts a structured payload, and writes it back into collected data. No `when` — it's gated by `if` on session state, then unconditionally extracts when eligible.
|
|
298
|
-
|
|
299
|
-
```typescript
|
|
300
|
-
import type { Signal } from "@falai/agent";
|
|
301
|
-
|
|
302
|
-
type Data = { leadStage?: "cold" | "warm" | "hot" | "closing" };
|
|
303
|
-
|
|
304
|
-
export const leadStage: Signal<unknown, Data, { stage: Data["leadStage"]; confidence: number }> = {
|
|
305
|
-
id: "lead_stage",
|
|
306
|
-
title: "Lead stage classification",
|
|
307
|
-
if: ({ session }) => (session.history?.length ?? 0) > 5,
|
|
308
|
-
extract: {
|
|
309
|
-
type: "object",
|
|
310
|
-
properties: {
|
|
311
|
-
stage: { type: "string", enum: ["cold", "warm", "hot", "closing"] },
|
|
312
|
-
confidence: { type: "number", minimum: 0, maximum: 1 },
|
|
313
|
-
},
|
|
314
|
-
required: ["stage", "confidence"],
|
|
315
|
-
},
|
|
316
|
-
phase: "post",
|
|
317
|
-
behavior: "always",
|
|
318
|
-
async handler({ extracted, updateData }) {
|
|
319
|
-
if (extracted.confidence >= 0.6) {
|
|
320
|
-
await updateData({ leadStage: extracted.stage });
|
|
321
|
-
}
|
|
322
|
-
},
|
|
323
|
-
};
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
### 3. Cooldown behavior
|
|
327
|
-
|
|
328
|
-
A pre-phase signal that nudges the next prompt with a tone hint, suppressed for two minutes after each fire so a frustrated user isn't re-flagged on every turn.
|
|
329
|
-
|
|
330
|
-
```typescript
|
|
331
|
-
import type { Signal } from "@falai/agent";
|
|
332
|
-
|
|
333
|
-
export const frustrationDetected: Signal = {
|
|
334
|
-
id: "frustration_detected",
|
|
335
|
-
when: "the user is visibly frustrated, impatient, or upset",
|
|
336
|
-
phase: "pre",
|
|
337
|
-
behavior: "cooldown",
|
|
338
|
-
cooldownMs: 2 * 60_000, // 2 minutes
|
|
339
|
-
async handler({ dispatch }) {
|
|
340
|
-
dispatch({
|
|
341
|
-
appendPrompt: ["The user is frustrated. Lead with empathy and acknowledge the issue."],
|
|
342
|
-
});
|
|
343
|
-
},
|
|
344
|
-
};
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
## Errors
|
|
348
|
-
|
|
349
|
-
Misuse surfaces as typed errors:
|
|
350
|
-
|
|
351
|
-
- `FlowConfigurationError` — duplicate `id` across `agent.signals`, invalid `extract` schema (not a JSON Schema object), `signalBatchSize` not a positive integer, or a position directive (`goTo` / `goToStep`) that resolves to an unknown flow or step.
|
|
352
|
-
- `DataValidationError` — `dataUpdate` (or `extracted` written via `updateData`) violates the agent schema.
|
|
353
|
-
|
|
354
|
-
Soft failures handled in-band (no thrown error, turn continues):
|
|
355
|
-
|
|
356
|
-
- **Handler throws** — recorded as `firings[i].handlerError`; iteration continues with the next signal.
|
|
357
|
-
- **Classifier call fails** — all LLM-conditioned signals in that batch are treated as non-match; code-only and unconditional signals continue normally.
|
|
358
|
-
- **Extraction-mode signal matched but no payload returned** — recorded as `firings[i].extractionError` with a WARN log; the handler still runs with `extracted: undefined`. Usually means the `extract` schema used a keyword the provider ignores (e.g. `nullable: true` instead of `type: ['string', 'null']`), so the model omitted the field.
|
|
359
|
-
- **Post-phase emits pre-LLM-only fields** (`halt` / `appendPrompt` / `injectTools`) — dropped with debug warning.
|
|
360
|
-
- **`behavior: 'cooldown'` with no `cooldownMs`** — debug warning at construction; runtime treats as `'always'`.
|
|
361
|
-
|
|
362
|
-
## Related
|
|
363
|
-
|
|
364
|
-
- [Turn pipeline](../concepts/pipeline.md) — where signal phases sit in the turn lifecycle.
|
|
365
|
-
- [Directives](../concepts/directives.md) — the Directive shape and SignalDirective extension.
|
|
366
|
-
- [Directive](./directive.md) — base shape for all position and state fields.
|
|
367
|
-
- [createAgent](./create-agent.md) — `signals` and `signalBatchSize` options.
|
|
368
|
-
- [Errors](./errors.md) — `FlowConfigurationError` format contract.
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Data extraction — schema, collect, skip, requires, requiredFields; pre-extraction in action.
|
|
3
|
-
* Run with the message "I want X for Y people on Z" and watch all three fields populate from one turn.
|
|
4
|
-
* Read after: docs/start/03-collect-data.md
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { createAgent, GeminiProvider } from "@falai/agent";
|
|
8
|
-
|
|
9
|
-
// ─── Schema ──────────────────────────────────────────────────────────────────
|
|
10
|
-
|
|
11
|
-
interface BookingData {
|
|
12
|
-
roomType: "single" | "double" | "suite";
|
|
13
|
-
guests: number;
|
|
14
|
-
checkIn: string;
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
const schema = {
|
|
18
|
-
type: "object" as const,
|
|
19
|
-
properties: {
|
|
20
|
-
roomType: {
|
|
21
|
-
type: "string" as const,
|
|
22
|
-
enum: ["single", "double", "suite"],
|
|
23
|
-
description: "Type of room requested",
|
|
24
|
-
},
|
|
25
|
-
guests: {
|
|
26
|
-
type: "number" as const,
|
|
27
|
-
description: "Number of guests",
|
|
28
|
-
},
|
|
29
|
-
checkIn: {
|
|
30
|
-
type: "string" as const,
|
|
31
|
-
description: "Check-in date in YYYY-MM-DD format",
|
|
32
|
-
},
|
|
33
|
-
},
|
|
34
|
-
required: ["roomType", "guests", "checkIn"],
|
|
35
|
-
};
|
|
36
|
-
|
|
37
|
-
// ─── Agent ───────────────────────────────────────────────────────────────────
|
|
38
|
-
|
|
39
|
-
const agent = createAgent<Record<string, never>, BookingData>({
|
|
40
|
-
name: "Booking Agent",
|
|
41
|
-
provider: new GeminiProvider({
|
|
42
|
-
apiKey: process.env.GEMINI_API_KEY!,
|
|
43
|
-
model: "gemini-3.5-flash-lite",
|
|
44
|
-
}),
|
|
45
|
-
schema,
|
|
46
|
-
flows: [
|
|
47
|
-
{
|
|
48
|
-
title: "Book a room",
|
|
49
|
-
when: "The user wants to book a hotel room",
|
|
50
|
-
requiredFields: ["roomType", "guests", "checkIn"],
|
|
51
|
-
steps: [
|
|
52
|
-
{
|
|
53
|
-
id: "ask_room",
|
|
54
|
-
prompt: "What type of room would you like? (single, double, or suite)",
|
|
55
|
-
collect: ["roomType"],
|
|
56
|
-
skip: [({ data }) => data.roomType !== undefined],
|
|
57
|
-
},
|
|
58
|
-
{
|
|
59
|
-
id: "ask_guests",
|
|
60
|
-
prompt: "How many guests will be staying?",
|
|
61
|
-
collect: ["guests"],
|
|
62
|
-
requires: ["roomType"],
|
|
63
|
-
skip: [({ data }) => data.guests !== undefined],
|
|
64
|
-
},
|
|
65
|
-
{
|
|
66
|
-
id: "ask_checkin",
|
|
67
|
-
prompt: "When would you like to check in?",
|
|
68
|
-
collect: ["checkIn"],
|
|
69
|
-
requires: ["roomType", "guests"],
|
|
70
|
-
skip: [({ data }) => data.checkIn !== undefined],
|
|
71
|
-
},
|
|
72
|
-
],
|
|
73
|
-
},
|
|
74
|
-
],
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
// ─── Run ─────────────────────────────────────────────────────────────────────
|
|
78
|
-
|
|
79
|
-
async function main() {
|
|
80
|
-
// Pre-extraction: all three fields are extracted from a single message.
|
|
81
|
-
const response = await agent.respond({
|
|
82
|
-
history: [{ role: "user", content: "I want a double for 2 people on 2025-03-15" }],
|
|
83
|
-
});
|
|
84
|
-
|
|
85
|
-
console.log(response.message);
|
|
86
|
-
console.log("Collected:", response.session?.data);
|
|
87
|
-
console.log("Complete:", response.isFlowComplete);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
main();
|
package/examples/05-branching.ts
DELETED
|
@@ -1,140 +0,0 @@
|
|
|
1
|
-
/** @intent Demonstrates step.branches — source-local forks with if, when, and Directive targets.
|
|
2
|
-
* @teaches BranchEntry, BranchMap, if-only fork, when-only fork, combined if+when, mixed targets
|
|
3
|
-
* @readAfter docs/guides/branching.md */
|
|
4
|
-
import { createAgent, GeminiProvider } from "../src/index.js";
|
|
5
|
-
import type { BranchMap, Directive, FlowOptions, StepOptions } from "../src/index.js";
|
|
6
|
-
|
|
7
|
-
// ─── Types ───────────────────────────────────────────────────────────────────
|
|
8
|
-
|
|
9
|
-
interface Context { tier: "free" | "pro" | "enterprise" }
|
|
10
|
-
interface Data { intent: string; query: string; answer: string }
|
|
11
|
-
|
|
12
|
-
// ─── Provider ────────────────────────────────────────────────────────────────
|
|
13
|
-
|
|
14
|
-
const provider = new GeminiProvider({
|
|
15
|
-
apiKey: process.env.GEMINI_API_KEY!,
|
|
16
|
-
model: "gemini-3.5-flash-lite",
|
|
17
|
-
});
|
|
18
|
-
|
|
19
|
-
// ─── Steps with branches ─────────────────────────────────────────────────────
|
|
20
|
-
|
|
21
|
-
// 1. if-only fork — pure code predicate, zero LLM cost
|
|
22
|
-
const triageStep: StepOptions<Context, Data> = {
|
|
23
|
-
id: "triage",
|
|
24
|
-
prompt: "What can I help you with today?",
|
|
25
|
-
collect: ["intent"],
|
|
26
|
-
branches: [
|
|
27
|
-
{
|
|
28
|
-
label: "pro-fast-track",
|
|
29
|
-
if: ({ context }) => context.tier === "pro" || context.tier === "enterprise",
|
|
30
|
-
then: "priority_queue", // resolves as step id in same flow
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
label: "free-default",
|
|
34
|
-
then: "general_help", // unconditional fallback (last entry)
|
|
35
|
-
},
|
|
36
|
-
] satisfies BranchMap<Context, Data>,
|
|
37
|
-
};
|
|
38
|
-
|
|
39
|
-
// 2. when-only fork — AI-evaluated condition (costs tokens)
|
|
40
|
-
const classifyStep: StepOptions<Context, Data> = {
|
|
41
|
-
id: "general_help",
|
|
42
|
-
prompt: "Let me look into that for you.",
|
|
43
|
-
collect: ["query"],
|
|
44
|
-
branches: [
|
|
45
|
-
{
|
|
46
|
-
label: "billing",
|
|
47
|
-
when: "The user is asking about billing, invoices, or payments",
|
|
48
|
-
then: "billing_flow", // resolves as flow id (cross-flow jump)
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
label: "technical",
|
|
52
|
-
when: "The user is asking a technical or API question",
|
|
53
|
-
then: "tech_support", // resolves as step id
|
|
54
|
-
},
|
|
55
|
-
{
|
|
56
|
-
label: "fallback",
|
|
57
|
-
then: "tech_support",
|
|
58
|
-
},
|
|
59
|
-
] satisfies BranchMap<Context, Data>,
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
// 3. Combined if + when — code runs first (free), AI only if code passes
|
|
63
|
-
const priorityStep: StepOptions<Context, Data> = {
|
|
64
|
-
id: "priority_queue",
|
|
65
|
-
prompt: "You have priority support. What do you need?",
|
|
66
|
-
collect: ["query"],
|
|
67
|
-
branches: [
|
|
68
|
-
{
|
|
69
|
-
label: "enterprise-escalation",
|
|
70
|
-
if: ({ context }) => context.tier === "enterprise",
|
|
71
|
-
when: "The user is reporting a production outage or critical bug",
|
|
72
|
-
then: {
|
|
73
|
-
goTo: "escalation_flow",
|
|
74
|
-
dataUpdate: { intent: "escalation" },
|
|
75
|
-
reply: "Routing you to our on-call engineering team now.",
|
|
76
|
-
} satisfies Directive<Context, Data>,
|
|
77
|
-
},
|
|
78
|
-
{
|
|
79
|
-
label: "standard-priority",
|
|
80
|
-
then: "tech_support",
|
|
81
|
-
},
|
|
82
|
-
] satisfies BranchMap<Context, Data>,
|
|
83
|
-
};
|
|
84
|
-
|
|
85
|
-
// 4. Terminal step — no branches, linear end
|
|
86
|
-
const techSupportStep: StepOptions<Context, Data> = {
|
|
87
|
-
id: "tech_support",
|
|
88
|
-
prompt: "I'll find the answer to your technical question.",
|
|
89
|
-
collect: ["answer"],
|
|
90
|
-
};
|
|
91
|
-
|
|
92
|
-
// ─── Flows ───────────────────────────────────────────────────────────────────
|
|
93
|
-
|
|
94
|
-
const supportFlow: FlowOptions<Context, Data> = {
|
|
95
|
-
id: "support_flow",
|
|
96
|
-
title: "Support",
|
|
97
|
-
description: "Routes users through support triage",
|
|
98
|
-
when: "The user needs help or support",
|
|
99
|
-
steps: [triageStep, classifyStep, priorityStep, techSupportStep],
|
|
100
|
-
requiredFields: ["answer"],
|
|
101
|
-
};
|
|
102
|
-
|
|
103
|
-
const billingFlow: FlowOptions<Context, Data> = {
|
|
104
|
-
id: "billing_flow",
|
|
105
|
-
title: "Billing",
|
|
106
|
-
description: "Handles billing inquiries",
|
|
107
|
-
when: "The user asks about billing",
|
|
108
|
-
steps: [{ id: "billing_help", prompt: "Let me pull up your billing info." }],
|
|
109
|
-
};
|
|
110
|
-
|
|
111
|
-
const escalationFlow: FlowOptions<Context, Data> = {
|
|
112
|
-
id: "escalation_flow",
|
|
113
|
-
title: "Escalation",
|
|
114
|
-
description: "Critical issue escalation for enterprise customers",
|
|
115
|
-
steps: [{ id: "escalate", prompt: "Connecting you to on-call engineering." }],
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
// ─── Agent ───────────────────────────────────────────────────────────────────
|
|
119
|
-
|
|
120
|
-
const agent = createAgent<Context, Data>({
|
|
121
|
-
name: "Support Bot",
|
|
122
|
-
provider,
|
|
123
|
-
context: { tier: "pro" },
|
|
124
|
-
schema: {
|
|
125
|
-
type: "object",
|
|
126
|
-
properties: {
|
|
127
|
-
intent: { type: "string" },
|
|
128
|
-
query: { type: "string" },
|
|
129
|
-
answer: { type: "string" },
|
|
130
|
-
},
|
|
131
|
-
},
|
|
132
|
-
flows: [supportFlow, billingFlow, escalationFlow],
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
// ─── Run ─────────────────────────────────────────────────────────────────────
|
|
136
|
-
|
|
137
|
-
const response = await agent.respond({
|
|
138
|
-
history: [{ role: "user", content: "I need help with my API integration" }],
|
|
139
|
-
});
|
|
140
|
-
console.log(response.message);
|