@promptbook/google 0.100.0-4 → 0.100.0-40

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts

@@ -0,0 +1,54 @@
+import type { string_url } from '../../../types/typeAliases';
+import type { RAGConfig } from './types';
+import type { RetrievalResult } from './types';
+/**
+ * RAG (Retrieval-Augmented Generation) Service
+ * Handles knowledge source processing and retrieval
+ *
+ * @private
+ */
+export declare class RAGService {
+    private knowledgeBase;
+    private config;
+    constructor(config?: Partial<RAGConfig>);
+    /**
+     * Add a knowledge source from URL
+     */
+    addKnowledgeSource(url: string_url): Promise<void>;
+    /**
+     * Retrieve relevant chunks for a query
+     */
+    retrieveRelevantChunks(query: string): RetrievalResult[];
+    /**
+     * Get formatted context for the agent
+     */
+    getContextForQuery(query: string): string;
+    /**
+     * Get knowledge base statistics
+     */
+    getStats(): {
+        sources: number;
+        chunks: number;
+        lastUpdated: Date;
+    };
+    /**
+     * Clear all knowledge sources
+     */
+    clearKnowledgeBase(): void;
+    /**
+     * Tokenize query into words for relevance scoring
+     */
+    private tokenizeQuery;
+    /**
+     * Calculate relevance score between content and query words
+     * Simple keyword matching - in production, use embeddings
+     */
+    private calculateRelevanceScore;
+    /**
+     * Generate content hash for caching
+     */
+    private generateContentHash;
+}
+/**
+ * TODO: !!!! use the already existing RAG instead of this
+ */

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { TODO_any } from '../../../../utils/organization/TODO_any';
+import type { string_url } from '../../../../types/typeAliases';
+import type { KnowledgeChunk } from '../types';
+import type { KnowledgeSourceFormat } from '../types';
+import type { RAGConfig } from '../types';
+/**
+ * Base class for knowledge source processors
+ * Provides common functionality for all knowledge processors
+ *
+ * @private
+ */
+export declare abstract class BaseKnowledgeProcessor {
+    protected readonly config: RAGConfig;
+    constructor(config?: Partial<RAGConfig>);
+    /**
+     * The format this processor supports
+     */
+    abstract readonly supportedFormat: KnowledgeSourceFormat;
+    /**
+     * Process a buffer and return knowledge chunks
+     */
+    abstract processBuffer(buffer: Buffer, sourceUrl: string_url): Promise<KnowledgeChunk[]>;
+    /**
+     * Generate a content hash for caching purposes
+     */
+    protected generateContentHash(content: string): string;
+    /**
+     * Generate a unique chunk ID
+     */
+    protected generateChunkId(sourceUrl: string_url, chunkIndex: number): string;
+    /**
+     * Split text into sentences for better chunking
+     */
+    protected splitIntoSentences(text: string): string[];
+    /**
+     * Get overlap text from the end of current chunk
+     */
+    protected getOverlapText(text: string, overlapSize: number): string;
+    /**
+     * Create chunks from text with proper overlap handling
+     */
+    protected createChunksFromText(text: string, sourceUrl: string_url, additionalMetadata?: Record<string, TODO_any>): KnowledgeChunk[];
+}

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { string_url } from '../../../../types/typeAliases';
+import type { KnowledgeChunk } from '../types';
+import { BaseKnowledgeProcessor } from './BaseKnowledgeProcessor';
+/**
+ * PDF knowledge source processor
+ * Handles extraction and chunking of PDF documents
+ *
+ * @private
+ */
+export declare class PdfProcessor extends BaseKnowledgeProcessor {
+    readonly supportedFormat: "pdf";
+    /**
+     * Process PDF buffer and extract text content
+     */
+    processBuffer(buffer: Buffer, sourceUrl: string_url): Promise<KnowledgeChunk[]>;
+    /**
+     * Extract title from PDF text (first meaningful line)
+     */
+    private extractTitleFromText;
+    /**
+     * Create chunks from PDF text with page awareness
+     */
+    protected createChunksFromText(text: string, sourceUrl: string_url, pdfInfo: {
+        totalPages: number;
+    }): KnowledgeChunk[];
+}
+/**
+ * TODO: !!!! Implement this through standard knowledge scraper
+ */

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts

@@ -0,0 +1,23 @@
+import type { string_url } from '../../../../types/typeAliases';
+import type { KnowledgeSourceFormat } from '../types';
+import type { RAGConfig } from '../types';
+import { BaseKnowledgeProcessor } from './BaseKnowledgeProcessor';
+/**
+ * Factory for creating knowledge source processors
+ *
+ * @private
+ */
+export declare class ProcessorFactory {
+    /**
+     * Get processor for a specific format
+     */
+    static getProcessor(format: KnowledgeSourceFormat, config?: Partial<RAGConfig>): BaseKnowledgeProcessor;
+    /**
+     * Detect format from URL
+     */
+    static detectFormat(url: string_url): KnowledgeSourceFormat;
+    /**
+     * Get all supported formats
+     */
+    static getSupportedFormats(): KnowledgeSourceFormat[];
+}

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { string_url } from '../../../../types/typeAliases';
+import type { KnowledgeChunk } from '../types';
+import { BaseKnowledgeProcessor } from './BaseKnowledgeProcessor';
+/**
+ * Text knowledge source processor
+ * Handles plain text documents
+ *
+ * @private
+ */
+export declare class TextProcessor extends BaseKnowledgeProcessor {
+    readonly supportedFormat: "text";
+    /**
+     * Process text buffer and extract content
+     */
+    processBuffer(buffer: Buffer, sourceUrl: string_url): Promise<KnowledgeChunk[]>;
+}

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts

@@ -0,0 +1,56 @@
+import type { string_url } from '../../../types/typeAliases';
+/**
+ * Supported knowledge source formats
+ */
+export type KnowledgeSourceFormat = 'pdf' | 'text' | 'markdown' | 'html';
+/**
+ * Knowledge source metadata
+ */
+export interface KnowledgeSourceMetadata {
+    readonly url: string_url;
+    readonly format: KnowledgeSourceFormat;
+    readonly title?: string;
+    readonly lastFetched?: Date;
+    readonly contentHash?: string;
+}
+/**
+ * Processed knowledge chunk for RAG
+ */
+export interface KnowledgeChunk {
+    readonly id: string;
+    readonly sourceUrl: string_url;
+    readonly content: string;
+    readonly metadata: {
+        readonly pageNumber?: number;
+        readonly section?: string;
+        readonly chunkIndex: number;
+        readonly totalChunks: number;
+    };
+}
+/**
+ * Knowledge base containing all processed knowledge sources
+ */
+export interface KnowledgeBase {
+    readonly sources: KnowledgeSourceMetadata[];
+    readonly chunks: KnowledgeChunk[];
+    readonly lastUpdated: Date;
+}
+/**
+ * RAG retrieval result
+ */
+export interface RetrievalResult {
+    readonly chunk: KnowledgeChunk;
+    readonly relevanceScore: number;
+}
+/**
+ * Configuration for RAG processing
+ */
+export interface RAGConfig {
+    readonly maxChunkSize: number;
+    readonly chunkOverlap: number;
+    readonly maxRetrievedChunks: number;
+    readonly minRelevanceScore: number;
+}
+/**
+ * [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts

@@ -0,0 +1,34 @@
+import type { AgentModelRequirements } from '../../_misc/AgentModelRequirements';
+import { FrontendRAGService } from '../FrontendRAGService';
+/**
+ * Helper utilities for RAG processing in chat systems
+ *
+ * @private
+ */
+export declare class RAGHelper {
+    /**
+     * Initialize knowledge sources from agent requirements
+     * This should be called when starting a chat session
+     */
+    static initializeKnowledgeSources(requirements: AgentModelRequirements): Promise<FrontendRAGService | null>;
+    /**
+     * Get relevant context for a user query
+     * This should be called before sending the query to the AI model
+     */
+    static getRelevantContext(ragService: FrontendRAGService | null, userQuery: string): Promise<string>;
+    /**
+     * Update system message with relevant context for a query
+     */
+    static updateSystemMessageWithContext(requirements: AgentModelRequirements, ragService: FrontendRAGService | null, userQuery: string): Promise<AgentModelRequirements>;
+    /**
+     * Get statistics about the knowledge base
+     */
+    static getKnowledgeStats(ragService: FrontendRAGService | null): {
+        sources: number;
+        chunks: number;
+        isInitialized: boolean;
+    } | null;
+}
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts

@@ -0,0 +1,44 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * META IMAGE commitment definition
+ *
+ * The META IMAGE commitment sets the agent's avatar/profile image URL.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * META IMAGE https://example.com/avatar.jpg
+ * META IMAGE /assets/agent-avatar.png
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinition<'META IMAGE'> {
+    constructor();
+    /**
+     * Short one-line description of META IMAGE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META IMAGE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the profile image URL from the content
+     * This is used by the parsing logic
+     */
+    extractProfileImageUrl(content: string): string | null;
+}
+/**
+ * Singleton instance of the META IMAGE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaImageCommitment: MetaImageCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts

@@ -0,0 +1,56 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * META LINK commitment definition
+ *
+ * The `META LINK` commitment represents the link to the person from whom the agent is created.
+ * This commitment is special because it doesn't affect the system message,
+ * but is handled separately in the parsing logic for profile display.
+ *
+ * Example usage in agent source:
+ *
+ * ```
+ * META LINK https://twitter.com/username
+ * META LINK https://linkedin.com/in/profile
+ * META LINK https://github.com/username
+ * ```
+ *
+ * Multiple `META LINK` commitments can be used when there are multiple sources:
+ *
+ * ```book
+ * META LINK https://twitter.com/username
+ * META LINK https://linkedin.com/in/profile
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefinition<'META LINK'> {
+    constructor();
+    /**
+     * Short one-line description of META LINK.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for META LINK commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+    /**
+     * Extracts the profile link URL from the content
+     * This is used by the parsing logic
+     */
+    extractProfileLinkUrl(content: string): string | null;
+    /**
+     * Validates if the provided content is a valid URL
+     */
+    isValidUrl(content: string): boolean;
+}
+/**
+ * Singleton instance of the META LINK commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const MetaLinkCommitment: MetaLinkCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts

@@ -0,0 +1,39 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * MODEL commitment definition
+ *
+ * The MODEL commitment specifies which AI model to use and can also set
+ * model-specific parameters like temperature, topP, and topK.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * MODEL gpt-4
+ * MODEL claude-3-opus temperature=0.3
+ * MODEL gpt-3.5-turbo temperature=0.8 topP=0.9
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
+    constructor();
+    /**
+     * Short one-line description of MODEL.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for MODEL commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the MODEL commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ModelCommitment: ModelCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts

@@ -0,0 +1,49 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * NOTE commitment definition
+ *
+ * The NOTE commitment is used to add comments to the agent source without making any changes
+ * to the system message or agent model requirements. It serves as a documentation mechanism
+ * for developers to add explanatory comments, reminders, or annotations directly in the agent source.
+ *
+ * Key features:
+ * - Makes no changes to the system message
+ * - Makes no changes to agent model requirements
+ * - Content is preserved in metadata.NOTE for debugging and inspection
+ * - Multiple NOTE commitments are aggregated together
+ * - Comments (# NOTE) are removed from the final system message
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * NOTE This agent was designed for customer support scenarios
+ * NOTE Remember to update the knowledge base monthly
+ * NOTE Performance optimized for quick response times
+ * ```
+ *
+ * The above notes will be stored in metadata but won't affect the agent's behavior.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
+    constructor();
+    /**
+     * Short one-line description of NOTE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for NOTE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the NOTE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const NoteCommitment: NoteCommitmentDefinition;
+/**
+ * [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts

@@ -0,0 +1,46 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * PERSONA commitment definition
+ *
+ * The PERSONA commitment modifies the agent's personality and character in the system message.
+ * It defines who the agent is, their background, expertise, and personality traits.
+ *
+ * Key features:
+ * - Multiple PERSONA commitments are automatically merged into one
+ * - Content is placed at the beginning of the system message
+ * - Original content with comments is preserved in metadata.PERSONA
+ * - Comments (# PERSONA) are removed from the final system message
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * PERSONA You are a helpful programming assistant with expertise in TypeScript and React
+ * PERSONA You have deep knowledge of modern web development practices
+ * ```
+ *
+ * The above will be merged into a single persona section at the beginning of the system message.
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
+    constructor();
+    /**
+     * Short one-line description of PERSONA.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for PERSONA commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the PERSONA commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const PersonaCommitment: PersonaCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts

@@ -0,0 +1,44 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * RULE commitment definition
+ *
+ * The RULE/RULES commitment adds behavioral constraints and guidelines that the agent must follow.
+ * These are specific instructions about what the agent should or shouldn't do.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * RULE Always ask for clarification if the user's request is ambiguous
+ * RULES Never provide medical advice, always refer to healthcare professionals
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'RULE' | 'RULES'> {
+    constructor(type?: 'RULE' | 'RULES');
+    /**
+     * Short one-line description of RULE/RULES.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for RULE/RULES commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instances of the RULE commitment definitions
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const RuleCommitment: RuleCommitmentDefinition;
+/**
+ * Singleton instances of the RULE commitment definitions
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const RulesCommitment: RuleCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts

@@ -0,0 +1,44 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * SAMPLE commitment definition
+ *
+ * The SAMPLE/EXAMPLE commitment provides examples of how the agent should respond
+ * or behave in certain situations. These examples help guide the agent's responses.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * SAMPLE When asked about pricing, respond: "Our basic plan starts at $10/month..."
+ * EXAMPLE For code questions, always include working code snippets
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition<'SAMPLE' | 'EXAMPLE'> {
+    constructor(type?: 'SAMPLE' | 'EXAMPLE');
+    /**
+     * Short one-line description of SAMPLE/EXAMPLE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for SAMPLE/EXAMPLE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instances of the SAMPLE commitment definitions
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const SampleCommitment: SampleCommitmentDefinition;
+/**
+ * Singleton instances of the SAMPLE commitment definitions
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const ExampleCommitment: SampleCommitmentDefinition;
+/**
+ * Note: [💞] Ignore a discrepancy between file name and entity name
+ */

package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts

@@ -0,0 +1,38 @@
+import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
+import type { AgentModelRequirements } from '../_misc/AgentModelRequirements';
+/**
+ * STYLE commitment definition
+ *
+ * The STYLE commitment defines how the agent should format and present its responses.
+ * This includes tone, writing style, formatting preferences, and communication patterns.
+ *
+ * Example usage in agent source:
+ *
+ * ```book
+ * STYLE Write in a professional but friendly tone, use bullet points for lists
+ * STYLE Always provide code examples when explaining programming concepts
+ * ```
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
+    constructor();
+    /**
+     * Short one-line description of STYLE.
+     */
+    get description(): string;
+    /**
+     * Markdown documentation for STYLE commitment.
+     */
+    get documentation(): string;
+    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
+}
+/**
+ * Singleton instance of the STYLE commitment definition
+ *
+ * @private [🪔] Maybe export the commitments through some package
+ */
+export declare const StyleCommitment: StyleCommitmentDefinition;
+/**
+ * [💞] Ignore a discrepancy between file name and entity name
+ */