@promptbook/core 0.103.0-37 → 0.103.0-40

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.
Files changed (44) hide show
  1. package/README.md +205 -182
  2. package/esm/index.es.js +115 -74
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/typings/books/index.d.ts +0 -81
  5. package/esm/typings/src/_packages/core.index.d.ts +12 -10
  6. package/esm/typings/src/_packages/node.index.d.ts +4 -2
  7. package/esm/typings/src/_packages/types.index.d.ts +3 -1
  8. package/esm/typings/src/book-components/_common/Modal/Modal.d.ts +1 -1
  9. package/esm/typings/src/cli/cli-commands/start-agents-server.d.ts +14 -0
  10. package/esm/typings/src/cli/cli-commands/{start-server.d.ts → start-pipelines-server.d.ts} +2 -2
  11. package/esm/typings/src/collection/agent-collection/AgentCollection.d.ts +36 -0
  12. package/esm/typings/src/collection/agent-collection/constructors/AgentCollectionInDirectory.d.ts +88 -0
  13. package/esm/typings/src/collection/{PipelineCollection.d.ts → pipeline-collection/PipelineCollection.d.ts} +7 -3
  14. package/esm/typings/src/collection/{SimplePipelineCollection.d.ts → pipeline-collection/SimplePipelineCollection.d.ts} +5 -5
  15. package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.d.ts} +8 -10
  16. package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromJson.d.ts +13 -0
  17. package/esm/typings/src/collection/{constructors/createCollectionFromPromise.d.ts → pipeline-collection/constructors/createPipelineCollectionFromPromise.d.ts} +6 -5
  18. package/esm/typings/src/collection/pipeline-collection/constructors/createPipelineCollectionFromPromise.test.d.ts +1 -0
  19. package/esm/typings/src/collection/{constructors/createCollectionFromUrl.d.ts → pipeline-collection/constructors/createPipelineCollectionFromUrl.d.ts} +3 -3
  20. package/esm/typings/src/collection/{constructors/createSubcollection.d.ts → pipeline-collection/constructors/createPipelineSubcollection.d.ts} +3 -3
  21. package/esm/typings/src/collection/pipeline-collection/pipelineCollectionToJson.d.ts +13 -0
  22. package/esm/typings/src/config.d.ts +8 -1
  23. package/esm/typings/src/execution/FilesystemTools.d.ts +1 -1
  24. package/esm/typings/src/execution/LlmExecutionTools.d.ts +6 -0
  25. package/esm/typings/src/llm-providers/agent/Agent.d.ts +6 -1
  26. package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +9 -4
  27. package/esm/typings/src/llm-providers/agent/createAgentLlmExecutionTools.d.ts +0 -4
  28. package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts +17 -1
  29. package/esm/typings/src/other/templates/getTemplatesPipelineCollection.d.ts +1 -1
  30. package/esm/typings/src/remote-server/startRemoteServer.d.ts +1 -1
  31. package/esm/typings/src/remote-server/types/RemoteServerOptions.d.ts +22 -8
  32. package/esm/typings/src/transpilers/formatted-book-in-markdown/register.d.ts +1 -1
  33. package/esm/typings/src/utils/files/listAllFiles.d.ts +2 -3
  34. package/esm/typings/src/version.d.ts +1 -1
  35. package/esm/typings/src/wizard/$getCompiledBook.d.ts +1 -2
  36. package/package.json +1 -1
  37. package/umd/index.umd.js +119 -77
  38. package/umd/index.umd.js.map +1 -1
  39. package/esm/typings/src/collection/collectionToJson.d.ts +0 -13
  40. package/esm/typings/src/collection/constructors/createCollectionFromJson.d.ts +0 -13
  41. /package/esm/typings/src/collection/{constructors/createCollectionFromDirectory.test.d.ts → agent-collection/constructors/AgentCollectionInDirectory.test.d.ts} +0 -0
  42. /package/esm/typings/src/collection/{constructors/createCollectionFromJson.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromDirectory.test.d.ts} +0 -0
  43. /package/esm/typings/src/collection/{constructors/createCollectionFromPromise.test.d.ts → pipeline-collection/constructors/createPipelineCollectionFromJson.test.d.ts} +0 -0
  44. /package/esm/typings/src/collection/{collectionToJson.test.d.ts → pipeline-collection/pipelineCollectionToJson.test.d.ts} +0 -0
package/README.md CHANGED
@@ -59,237 +59,260 @@ The core package serves as the foundation of the Promptbook ecosystem. It abstra
59
59
  ## 🔧 High-Level Functionality
60
60
 
61
61
  This package orchestrates the entire promptbook execution lifecycle:
62
- - **Pipeline Management**: Parse, validate, and compile promptbook definitions
63
- - **Execution Engine**: Create and manage pipeline executors with comprehensive error handling
64
- - **LLM Integration**: Unified interface for multiple LLM providers (OpenAI, Anthropic, Google, etc.)
65
- - **Parameter Processing**: Template parameter substitution and validation
66
- - **Knowledge Management**: Handle knowledge sources and scraping
67
- - **Storage Abstraction**: Flexible storage backends for caching and persistence
68
- - **Format Support**: Parse and validate various data formats (JSON, CSV, XML)
62
+
63
+ - **Pipeline Management**: Parse, validate, and compile promptbook definitions
64
+ - **Execution Engine**: Create and manage pipeline executors with comprehensive error handling
65
+ - **LLM Integration**: Unified interface for multiple LLM providers (OpenAI, Anthropic, Google, etc.)
66
+ - **Parameter Processing**: Template parameter substitution and validation
67
+ - **Knowledge Management**: Handle knowledge sources and scraping
68
+ - **Storage Abstraction**: Flexible storage backends for caching and persistence
69
+ - **Format Support**: Parse and validate various data formats (JSON, CSV, XML)
69
70
 
70
71
  ## ✨ Key Features
71
72
 
72
- - 🚀 **Universal Pipeline Executor** - Execute promptbooks with any supported LLM provider
73
- - 🔄 **Multi-Provider Support** - Seamlessly switch between OpenAI, Anthropic, Google, and other providers
74
- - 📊 **Comprehensive Validation** - Validate promptbooks, parameters, and execution results
75
- - 🎯 **Expectation Checking** - Built-in validation for output format, length, and content expectations
76
- - 🧠 **Knowledge Integration** - Scrape and process knowledge from various sources
77
- - 💾 **Flexible Storage** - Memory, filesystem, and custom storage backends
78
- - 🔧 **Error Handling** - Detailed error types for debugging and monitoring
79
- - 📈 **Usage Tracking** - Monitor token usage, costs, and performance metrics
80
- - 🎨 **Format Parsers** - Support for JSON, CSV, XML, and text formats
81
- - 🔀 **Pipeline Migration** - Upgrade and migrate pipeline definitions
73
+ - 🚀 **Universal Pipeline Executor** - Execute promptbooks with any supported LLM provider
74
+ - 🔄 **Multi-Provider Support** - Seamlessly switch between OpenAI, Anthropic, Google, and other providers
75
+ - 📊 **Comprehensive Validation** - Validate promptbooks, parameters, and execution results
76
+ - 🎯 **Expectation Checking** - Built-in validation for output format, length, and content expectations
77
+ - 🧠 **Knowledge Integration** - Scrape and process knowledge from various sources
78
+ - 💾 **Flexible Storage** - Memory, filesystem, and custom storage backends
79
+ - 🔧 **Error Handling** - Detailed error types for debugging and monitoring
80
+ - 📈 **Usage Tracking** - Monitor token usage, costs, and performance metrics
81
+ - 🎨 **Format Parsers** - Support for JSON, CSV, XML, and text formats
82
+ - 🔀 **Pipeline Migration** - Upgrade and migrate pipeline definitions
82
83
 
83
84
  ## 📦 Exported Entities
84
85
 
85
86
  ### Version Information
86
- - `BOOK_LANGUAGE_VERSION` - Current book language version
87
- - `PROMPTBOOK_ENGINE_VERSION` - Current engine version
87
+
88
+ - `BOOK_LANGUAGE_VERSION` - Current book language version
89
+ - `PROMPTBOOK_ENGINE_VERSION` - Current engine version
88
90
 
89
91
  ### Agent and Book Management
90
- - `createAgentModelRequirements` - Create model requirements for agents
91
- - `parseAgentSource` - Parse agent source code
92
- - `isValidBook` - Validate book format
93
- - `validateBook` - Comprehensive book validation
94
- - `DEFAULT_BOOK` - Default book template
92
+
93
+ - `createAgentModelRequirements` - Create model requirements for agents
94
+ - `parseAgentSource` - Parse agent source code
95
+ - `isValidBook` - Validate book format
96
+ - `validateBook` - Comprehensive book validation
97
+ - `DEFAULT_BOOK` - Default book template
95
98
 
96
99
  ### Commitment System
97
- - `createEmptyAgentModelRequirements` - Create empty model requirements
98
- - `createBasicAgentModelRequirements` - Create basic model requirements
99
- - `NotYetImplementedCommitmentDefinition` - Placeholder for future commitments
100
- - `getCommitmentDefinition` - Get specific commitment definition
101
- - `getAllCommitmentDefinitions` - Get all available commitment definitions
102
- - `getAllCommitmentTypes` - Get all commitment types
103
- - `isCommitmentSupported` - Check if commitment is supported
100
+
101
+ - `createEmptyAgentModelRequirements` - Create empty model requirements
102
+ - `createBasicAgentModelRequirements` - Create basic model requirements
103
+ - `NotYetImplementedCommitmentDefinition` - Placeholder for future commitments
104
+ - `getCommitmentDefinition` - Get specific commitment definition
105
+ - `getAllCommitmentDefinitions` - Get all available commitment definitions
106
+ - `getAllCommitmentTypes` - Get all commitment types
107
+ - `isCommitmentSupported` - Check if commitment is supported
104
108
 
105
109
  ### Collection Management
106
- - `collectionToJson` - Convert collection to JSON
107
- - `createCollectionFromJson` - Create collection from JSON data
108
- - `createCollectionFromPromise` - Create collection from async source
109
- - `createCollectionFromUrl` - Create collection from URL
110
- - `createSubcollection` - Create filtered subcollection
110
+
111
+ - `pipelineCollectionToJson` - Convert collection to JSON
112
+ - `createPipelineCollectionFromJson` - Create collection from JSON data
113
+ - `createPipelineCollectionFromPromise` - Create collection from async source
114
+ - `createPipelineCollectionFromUrl` - Create collection from URL
115
+ - `createPipelineSubcollection` - Create filtered subcollection
111
116
 
112
117
  ### Configuration Constants
113
- - `NAME` - Project name
114
- - `ADMIN_EMAIL` - Administrator email
115
- - `ADMIN_GITHUB_NAME` - GitHub username
116
- - `CLAIM` - Project claim/tagline
117
- - `DEFAULT_BOOK_TITLE` - Default book title
118
- - `DEFAULT_TASK_TITLE` - Default task title
119
- - `DEFAULT_PROMPT_TASK_TITLE` - Default prompt task title
120
- - `DEFAULT_BOOK_OUTPUT_PARAMETER_NAME` - Default output parameter name
121
- - `DEFAULT_MAX_FILE_SIZE` - Maximum file size limit
122
- - `BIG_DATASET_TRESHOLD` - Threshold for large datasets
123
- - `FAILED_VALUE_PLACEHOLDER` - Placeholder for failed values
124
- - `PENDING_VALUE_PLACEHOLDER` - Placeholder for pending values
125
- - `MAX_FILENAME_LENGTH` - Maximum filename length
126
- - `DEFAULT_INTERMEDIATE_FILES_STRATEGY` - Strategy for intermediate files
127
- - `DEFAULT_MAX_PARALLEL_COUNT` - Maximum parallel executions
128
- - `DEFAULT_MAX_EXECUTION_ATTEMPTS` - Maximum execution attempts
129
- - `DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH` - Knowledge scraping depth limit
130
- - `DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL` - Knowledge scraping total limit
131
- - `DEFAULT_BOOKS_DIRNAME` - Default books directory name
132
- - `DEFAULT_DOWNLOAD_CACHE_DIRNAME` - Default download cache directory
133
- - `DEFAULT_EXECUTION_CACHE_DIRNAME` - Default execution cache directory
134
- - `DEFAULT_SCRAPE_CACHE_DIRNAME` - Default scrape cache directory
135
- - `CLI_APP_ID` - CLI application identifier
136
- - `PLAYGROUND_APP_ID` - Playground application identifier
137
- - `DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME` - Default collection filename
138
- - `DEFAULT_REMOTE_SERVER_URL` - Default remote server URL
139
- - `DEFAULT_CSV_SETTINGS` - Default CSV parsing settings
140
- - `DEFAULT_IS_VERBOSE` - Default verbosity setting
141
- - `SET_IS_VERBOSE` - Verbosity setter
142
- - `DEFAULT_IS_AUTO_INSTALLED` - Default auto-install setting
143
- - `DEFAULT_TASK_SIMULATED_DURATION_MS` - Default task simulation duration
144
- - `DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME` - Default collection function name
145
- - `DEFAULT_MAX_REQUESTS_PER_MINUTE` - Rate limiting configuration
146
- - `API_REQUEST_TIMEOUT` - API request timeout
147
- - `PROMPTBOOK_LOGO_URL` - Official logo URL
118
+
119
+ - `NAME` - Project name
120
+ - `ADMIN_EMAIL` - Administrator email
121
+ - `ADMIN_GITHUB_NAME` - GitHub username
122
+ - `CLAIM` - Project claim/tagline
123
+ - `DEFAULT_BOOK_TITLE` - Default book title
124
+ - `DEFAULT_TASK_TITLE` - Default task title
125
+ - `DEFAULT_PROMPT_TASK_TITLE` - Default prompt task title
126
+ - `DEFAULT_BOOK_OUTPUT_PARAMETER_NAME` - Default output parameter name
127
+ - `DEFAULT_MAX_FILE_SIZE` - Maximum file size limit
128
+ - `BIG_DATASET_TRESHOLD` - Threshold for large datasets
129
+ - `FAILED_VALUE_PLACEHOLDER` - Placeholder for failed values
130
+ - `PENDING_VALUE_PLACEHOLDER` - Placeholder for pending values
131
+ - `MAX_FILENAME_LENGTH` - Maximum filename length
132
+ - `DEFAULT_INTERMEDIATE_FILES_STRATEGY` - Strategy for intermediate files
133
+ - `DEFAULT_MAX_PARALLEL_COUNT` - Maximum parallel executions
134
+ - `DEFAULT_MAX_EXECUTION_ATTEMPTS` - Maximum execution attempts
135
+ - `DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_DEPTH` - Knowledge scraping depth limit
136
+ - `DEFAULT_MAX_KNOWLEDGE_SOURCES_SCRAPING_TOTAL` - Knowledge scraping total limit
137
+ - `DEFAULT_BOOKS_DIRNAME` - Default books directory name
138
+ - `DEFAULT_DOWNLOAD_CACHE_DIRNAME` - Default download cache directory
139
+ - `DEFAULT_EXECUTION_CACHE_DIRNAME` - Default execution cache directory
140
+ - `DEFAULT_SCRAPE_CACHE_DIRNAME` - Default scrape cache directory
141
+ - `CLI_APP_ID` - CLI application identifier
142
+ - `PLAYGROUND_APP_ID` - Playground application identifier
143
+ - `DEFAULT_PIPELINE_COLLECTION_BASE_FILENAME` - Default collection filename
144
+ - `DEFAULT_REMOTE_SERVER_URL` - Default remote server URL
145
+ - `DEFAULT_CSV_SETTINGS` - Default CSV parsing settings
146
+ - `DEFAULT_IS_VERBOSE` - Default verbosity setting
147
+ - `SET_IS_VERBOSE` - Verbosity setter
148
+ - `DEFAULT_IS_AUTO_INSTALLED` - Default auto-install setting
149
+ - `DEFAULT_TASK_SIMULATED_DURATION_MS` - Default task simulation duration
150
+ - `DEFAULT_GET_PIPELINE_COLLECTION_FUNCTION_NAME` - Default collection function name
151
+ - `DEFAULT_MAX_REQUESTS_PER_MINUTE` - Rate limiting configuration
152
+ - `API_REQUEST_TIMEOUT` - API request timeout
153
+ - `PROMPTBOOK_LOGO_URL` - Official logo URL
148
154
 
149
155
  ### Model and Provider Constants
150
- - `MODEL_TRUST_LEVELS` - Trust levels for different models
151
- - `MODEL_ORDERS` - Ordering preferences for models
152
- - `ORDER_OF_PIPELINE_JSON` - JSON property ordering
153
- - `RESERVED_PARAMETER_NAMES` - Reserved parameter names
156
+
157
+ - `MODEL_TRUST_LEVELS` - Trust levels for different models
158
+ - `MODEL_ORDERS` - Ordering preferences for models
159
+ - `ORDER_OF_PIPELINE_JSON` - JSON property ordering
160
+ - `RESERVED_PARAMETER_NAMES` - Reserved parameter names
154
161
 
155
162
  ### Pipeline Processing
156
- - `compilePipeline` - Compile pipeline from source
157
- - `parsePipeline` - Parse pipeline definition
158
- - `pipelineJsonToString` - Convert pipeline JSON to string
159
- - `prettifyPipelineString` - Format pipeline string
160
- - `extractParameterNamesFromTask` - Extract parameter names
161
- - `validatePipeline` - Validate pipeline structure
163
+
164
+ - `compilePipeline` - Compile pipeline from source
165
+ - `parsePipeline` - Parse pipeline definition
166
+ - `pipelineJsonToString` - Convert pipeline JSON to string
167
+ - `prettifyPipelineString` - Format pipeline string
168
+ - `extractParameterNamesFromTask` - Extract parameter names
169
+ - `validatePipeline` - Validate pipeline structure
162
170
 
163
171
  ### Dialog and Interface Tools
164
- - `CallbackInterfaceTools` - Callback-based interface tools
165
- - `CallbackInterfaceToolsOptions` - Options for callback tools (type)
172
+
173
+ - `CallbackInterfaceTools` - Callback-based interface tools
174
+ - `CallbackInterfaceToolsOptions` - Options for callback tools (type)
166
175
 
167
176
  ### Error Handling
168
- - `BoilerplateError` - Base error class
169
- - `PROMPTBOOK_ERRORS` - All error types registry
170
- - `AbstractFormatError` - Abstract format validation error
171
- - `AuthenticationError` - Authentication failure error
172
- - `CollectionError` - Collection-related error
173
- - `EnvironmentMismatchError` - Environment compatibility error
174
- - `ExpectError` - Expectation validation error
175
- - `KnowledgeScrapeError` - Knowledge scraping error
176
- - `LimitReachedError` - Resource limit error
177
- - `MissingToolsError` - Missing tools error
178
- - `NotFoundError` - Resource not found error
179
- - `NotYetImplementedError` - Feature not implemented error
180
- - `ParseError` - Parsing error
181
- - `PipelineExecutionError` - Pipeline execution error
182
- - `PipelineLogicError` - Pipeline logic error
183
- - `PipelineUrlError` - Pipeline URL error
184
- - `PromptbookFetchError` - Fetch operation error
185
- - `UnexpectedError` - Unexpected error
186
- - `WrappedError` - Wrapped error container
177
+
178
+ - `BoilerplateError` - Base error class
179
+ - `PROMPTBOOK_ERRORS` - All error types registry
180
+ - `AbstractFormatError` - Abstract format validation error
181
+ - `AuthenticationError` - Authentication failure error
182
+ - `CollectionError` - Collection-related error
183
+ - `EnvironmentMismatchError` - Environment compatibility error
184
+ - `ExpectError` - Expectation validation error
185
+ - `KnowledgeScrapeError` - Knowledge scraping error
186
+ - `LimitReachedError` - Resource limit error
187
+ - `MissingToolsError` - Missing tools error
188
+ - `NotFoundError` - Resource not found error
189
+ - `NotYetImplementedError` - Feature not implemented error
190
+ - `ParseError` - Parsing error
191
+ - `PipelineExecutionError` - Pipeline execution error
192
+ - `PipelineLogicError` - Pipeline logic error
193
+ - `PipelineUrlError` - Pipeline URL error
194
+ - `PromptbookFetchError` - Fetch operation error
195
+ - `UnexpectedError` - Unexpected error
196
+ - `WrappedError` - Wrapped error container
187
197
 
188
198
  ### Execution Engine
189
- - `createPipelineExecutor` - Create pipeline executor
190
- - `computeCosineSimilarity` - Compute cosine similarity for embeddings
191
- - `embeddingVectorToString` - Convert embedding vector to string
192
- - `executionReportJsonToString` - Convert execution report to string
193
- - `ExecutionReportStringOptions` - Report formatting options (type)
194
- - `ExecutionReportStringOptionsDefaults` - Default report options
199
+
200
+ - `createPipelineExecutor` - Create pipeline executor
201
+ - `computeCosineSimilarity` - Compute cosine similarity for embeddings
202
+ - `embeddingVectorToString` - Convert embedding vector to string
203
+ - `executionReportJsonToString` - Convert execution report to string
204
+ - `ExecutionReportStringOptions` - Report formatting options (type)
205
+ - `ExecutionReportStringOptionsDefaults` - Default report options
195
206
 
196
207
  ### Usage and Metrics
197
- - `addUsage` - Add usage metrics
198
- - `isPassingExpectations` - Check if expectations are met
199
- - `ZERO_VALUE` - Zero usage value constant
200
- - `UNCERTAIN_ZERO_VALUE` - Uncertain zero value constant
201
- - `ZERO_USAGE` - Zero usage object
202
- - `UNCERTAIN_USAGE` - Uncertain usage object
203
- - `usageToHuman` - Convert usage to human-readable format
204
- - `usageToWorktime` - Convert usage to work time estimate
208
+
209
+ - `addUsage` - Add usage metrics
210
+ - `isPassingExpectations` - Check if expectations are met
211
+ - `ZERO_VALUE` - Zero usage value constant
212
+ - `UNCERTAIN_ZERO_VALUE` - Uncertain zero value constant
213
+ - `ZERO_USAGE` - Zero usage object
214
+ - `UNCERTAIN_USAGE` - Uncertain usage object
215
+ - `usageToHuman` - Convert usage to human-readable format
216
+ - `usageToWorktime` - Convert usage to work time estimate
205
217
 
206
218
  ### Format Parsers
207
- - `CsvFormatError` - CSV format error
208
- - `CsvFormatParser` - CSV format parser
209
- - `MANDATORY_CSV_SETTINGS` - Required CSV settings
210
- - `TextFormatParser` - Text format parser
219
+
220
+ - `CsvFormatError` - CSV format error
221
+ - `CsvFormatParser` - CSV format parser
222
+ - `MANDATORY_CSV_SETTINGS` - Required CSV settings
223
+ - `TextFormatParser` - Text format parser
211
224
 
212
225
  ### Form Factor Definitions
213
- - `BoilerplateFormfactorDefinition` - Boilerplate form factor
214
- - `ChatbotFormfactorDefinition` - Chatbot form factor
215
- - `CompletionFormfactorDefinition` - Completion form factor
216
- - `GeneratorFormfactorDefinition` - Generator form factor
217
- - `GenericFormfactorDefinition` - Generic form factor
218
- - `ImageGeneratorFormfactorDefinition` - Image generator form factor
219
- - `FORMFACTOR_DEFINITIONS` - All form factor definitions
220
- - `MatcherFormfactorDefinition` - Matcher form factor
221
- - `SheetsFormfactorDefinition` - Sheets form factor
222
- - `TranslatorFormfactorDefinition` - Translator form factor
226
+
227
+ - `BoilerplateFormfactorDefinition` - Boilerplate form factor
228
+ - `ChatbotFormfactorDefinition` - Chatbot form factor
229
+ - `CompletionFormfactorDefinition` - Completion form factor
230
+ - `GeneratorFormfactorDefinition` - Generator form factor
231
+ - `GenericFormfactorDefinition` - Generic form factor
232
+ - `ImageGeneratorFormfactorDefinition` - Image generator form factor
233
+ - `FORMFACTOR_DEFINITIONS` - All form factor definitions
234
+ - `MatcherFormfactorDefinition` - Matcher form factor
235
+ - `SheetsFormfactorDefinition` - Sheets form factor
236
+ - `TranslatorFormfactorDefinition` - Translator form factor
223
237
 
224
238
  ### LLM Provider Integration
225
- - `filterModels` - Filter available models
226
- - `$llmToolsMetadataRegister` - LLM tools metadata registry
227
- - `$llmToolsRegister` - LLM tools registry
228
- - `createLlmToolsFromConfiguration` - Create tools from config
229
- - `cacheLlmTools` - Cache LLM tools
230
- - `countUsage` - Count total usage
231
- - `limitTotalUsage` - Limit total usage
232
- - `joinLlmExecutionTools` - Join multiple LLM tools
233
- - `MultipleLlmExecutionTools` - Multiple LLM tools container
239
+
240
+ - `filterModels` - Filter available models
241
+ - `$llmToolsMetadataRegister` - LLM tools metadata registry
242
+ - `$llmToolsRegister` - LLM tools registry
243
+ - `createLlmToolsFromConfiguration` - Create tools from config
244
+ - `cacheLlmTools` - Cache LLM tools
245
+ - `countUsage` - Count total usage
246
+ - `limitTotalUsage` - Limit total usage
247
+ - `joinLlmExecutionTools` - Join multiple LLM tools
248
+ - `MultipleLlmExecutionTools` - Multiple LLM tools container
234
249
 
235
250
  ### Provider Registrations
236
- - `_AnthropicClaudeMetadataRegistration` - Anthropic Claude registration
237
- - `_AzureOpenAiMetadataRegistration` - Azure OpenAI registration
238
- - `_DeepseekMetadataRegistration` - Deepseek registration
239
- - `_GoogleMetadataRegistration` - Google registration
240
- - `_OllamaMetadataRegistration` - Ollama registration
241
- - `_OpenAiMetadataRegistration` - OpenAI registration
242
- - `_OpenAiAssistantMetadataRegistration` - OpenAI Assistant registration
243
- - `_OpenAiCompatibleMetadataRegistration` - OpenAI Compatible registration
251
+
252
+ - `_AnthropicClaudeMetadataRegistration` - Anthropic Claude registration
253
+ - `_AzureOpenAiMetadataRegistration` - Azure OpenAI registration
254
+ - `_DeepseekMetadataRegistration` - Deepseek registration
255
+ - `_GoogleMetadataRegistration` - Google registration
256
+ - `_OllamaMetadataRegistration` - Ollama registration
257
+ - `_OpenAiMetadataRegistration` - OpenAI registration
258
+ - `_OpenAiAssistantMetadataRegistration` - OpenAI Assistant registration
259
+ - `_OpenAiCompatibleMetadataRegistration` - OpenAI Compatible registration
244
260
 
245
261
  ### Pipeline Management
246
- - `migratePipeline` - Migrate pipeline to newer version
247
- - `preparePersona` - Prepare persona for execution
248
- - `book` - Book notation utilities
249
- - `isValidPipelineString` - Validate pipeline string
250
- - `GENERIC_PIPELINE_INTERFACE` - Generic pipeline interface
251
- - `getPipelineInterface` - Get pipeline interface
252
- - `isPipelineImplementingInterface` - Check interface implementation
253
- - `isPipelineInterfacesEqual` - Compare pipeline interfaces
254
- - `EXPECTATION_UNITS` - Units for expectations
255
- - `validatePipelineString` - Validate pipeline string format
262
+
263
+ - `migratePipeline` - Migrate pipeline to newer version
264
+ - `preparePersona` - Prepare persona for execution
265
+ - `book` - Book notation utilities
266
+ - `isValidPipelineString` - Validate pipeline string
267
+ - `GENERIC_PIPELINE_INTERFACE` - Generic pipeline interface
268
+ - `getPipelineInterface` - Get pipeline interface
269
+ - `isPipelineImplementingInterface` - Check interface implementation
270
+ - `isPipelineInterfacesEqual` - Compare pipeline interfaces
271
+ - `EXPECTATION_UNITS` - Units for expectations
272
+ - `validatePipelineString` - Validate pipeline string format
256
273
 
257
274
  ### Pipeline Preparation
258
- - `isPipelinePrepared` - Check if pipeline is prepared
259
- - `preparePipeline` - Prepare pipeline for execution
260
- - `unpreparePipeline` - Unprepare pipeline
275
+
276
+ - `isPipelinePrepared` - Check if pipeline is prepared
277
+ - `preparePipeline` - Prepare pipeline for execution
278
+ - `unpreparePipeline` - Unprepare pipeline
261
279
 
262
280
  ### Remote Server Integration
263
- - `identificationToPromptbookToken` - Convert ID to token
264
- - `promptbookTokenToIdentification` - Convert token to ID
281
+
282
+ - `identificationToPromptbookToken` - Convert ID to token
283
+ - `promptbookTokenToIdentification` - Convert token to ID
265
284
 
266
285
  ### Knowledge Scraping
267
- - `_BoilerplateScraperMetadataRegistration` - Boilerplate scraper registration
268
- - `prepareKnowledgePieces` - Prepare knowledge pieces
269
- - `$scrapersMetadataRegister` - Scrapers metadata registry
270
- - `$scrapersRegister` - Scrapers registry
271
- - `makeKnowledgeSourceHandler` - Create knowledge source handler
272
- - `promptbookFetch` - Fetch with promptbook context
273
- - `_LegacyDocumentScraperMetadataRegistration` - Legacy document scraper
274
- - `_DocumentScraperMetadataRegistration` - Document scraper registration
275
- - `_MarkdownScraperMetadataRegistration` - Markdown scraper registration
276
- - `_MarkitdownScraperMetadataRegistration` - Markitdown scraper registration
277
- - `_PdfScraperMetadataRegistration` - PDF scraper registration
278
- - `_WebsiteScraperMetadataRegistration` - Website scraper registration
286
+
287
+ - `_BoilerplateScraperMetadataRegistration` - Boilerplate scraper registration
288
+ - `prepareKnowledgePieces` - Prepare knowledge pieces
289
+ - `$scrapersMetadataRegister` - Scrapers metadata registry
290
+ - `$scrapersRegister` - Scrapers registry
291
+ - `makeKnowledgeSourceHandler` - Create knowledge source handler
292
+ - `promptbookFetch` - Fetch with promptbook context
293
+ - `_LegacyDocumentScraperMetadataRegistration` - Legacy document scraper
294
+ - `_DocumentScraperMetadataRegistration` - Document scraper registration
295
+ - `_MarkdownScraperMetadataRegistration` - Markdown scraper registration
296
+ - `_MarkitdownScraperMetadataRegistration` - Markitdown scraper registration
297
+ - `_PdfScraperMetadataRegistration` - PDF scraper registration
298
+ - `_WebsiteScraperMetadataRegistration` - Website scraper registration
279
299
 
280
300
  ### Storage Backends
281
- - `BlackholeStorage` - Blackhole storage (discards data)
282
- - `MemoryStorage` - In-memory storage
283
- - `PrefixStorage` - Prefixed storage wrapper
301
+
302
+ - `BlackholeStorage` - Blackhole storage (discards data)
303
+ - `MemoryStorage` - In-memory storage
304
+ - `PrefixStorage` - Prefixed storage wrapper
284
305
 
285
306
  ### Type Definitions
286
- - `MODEL_VARIANTS` - Available model variants
287
- - `NonTaskSectionTypes` - Non-task section types
288
- - `SectionTypes` - All section types
289
- - `TaskTypes` - Task types
307
+
308
+ - `MODEL_VARIANTS` - Available model variants
309
+ - `NonTaskSectionTypes` - Non-task section types
310
+ - `SectionTypes` - All section types
311
+ - `TaskTypes` - Task types
290
312
 
291
313
  ### Server Configuration
292
- - `REMOTE_SERVER_URLS` - Remote server URLs
314
+
315
+ - `REMOTE_SERVER_URLS` - Remote server URLs
293
316
 
294
317
  > 💡 This package does not make sense on its own, look at [all promptbook packages](#-packages) or just install all by `npm i ptbk`
295
318