diff options
Diffstat (limited to 'src/client/views/nodes/chatbot/tools/CreateDocumentTool.ts')
| -rw-r--r-- | src/client/views/nodes/chatbot/tools/CreateDocumentTool.ts | 415 |
1 files changed, 415 insertions, 0 deletions
diff --git a/src/client/views/nodes/chatbot/tools/CreateDocumentTool.ts b/src/client/views/nodes/chatbot/tools/CreateDocumentTool.ts new file mode 100644 index 000000000..7d6964f44 --- /dev/null +++ b/src/client/views/nodes/chatbot/tools/CreateDocumentTool.ts @@ -0,0 +1,415 @@ +import { BaseTool } from './BaseTool'; +import { Observation } from '../types/types'; +import { ParametersType, ToolInfo } from '../types/tool_types'; +import { parsedDoc } from '../chatboxcomponents/ChatBox'; + +/** + * List of supported document types that can be created via text LLM. + */ +export enum supportedDocumentTypes { + flashcard = 'flashcard', + text = 'text', + html = 'html', + equation = 'equation', + functionplot = 'functionplot', + dataviz = 'dataviz', + notetaking = 'notetaking', + audio = 'audio', + video = 'video', + pdf = 'pdf', + rtf = 'rtf', + message = 'message', + collection = 'collection', + image = 'image', + deck = 'deck', + web = 'web', + comparison = 'comparison', + mermaid = 'mermaid', + script = 'script', +} +/** + * Tthe CreateDocTool class is responsible for creating + * documents of various types (e.g., text, flashcards, collections) and organizing them in a + * structured manner. The tool supports creating dashboards with diverse document types and + * ensures proper placement of documents without overlap. + */ + +// Example document structure for various document types +const example = [ + { + doc_type: supportedDocumentTypes.equation, + title: 'quadratic', + data: 'x^2 + y^2 = 3', + width: 300, + height: 300, + x: 0, + y: 0, + }, + { + doc_type: supportedDocumentTypes.collection, + title: 'Advanced Biology', + data: [ + { + doc_type: supportedDocumentTypes.text, + title: 'Cell Structure', + data: 'Cells are the basic building blocks of all living organisms.', + width: 300, + height: 300, + x: 500, + y: 0, + }, + ], + backgroundColor: '#00ff00', + width: 600, + height: 600, + x: 600, + y: 0, + type_collection: 'tree', + }, + { + doc_type: supportedDocumentTypes.image, + title: 'experiment', + data: 'https://plus.unsplash.com/premium_photo-1694819488591-a43907d1c5cc?q=80&w=2628&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D', + width: 300, + height: 300, + x: 600, + y: 300, + }, + { + doc_type: supportedDocumentTypes.deck, + title: 'Chemistry', + data: [ + { + doc_type: supportedDocumentTypes.flashcard, + title: 'Photosynthesis', + data: [ + { + doc_type: supportedDocumentTypes.text, + title: 'front_Photosynthesis', + data: 'What is photosynthesis?', + width: 300, + height: 300, + x: 100, + y: 600, + }, + { + doc_type: supportedDocumentTypes.text, + title: 'back_photosynthesis', + data: 'The process by which plants make food.', + width: 300, + height: 300, + x: 100, + y: 700, + }, + ], + backgroundColor: '#00ff00', + width: 300, + height: 300, + x: 300, + y: 1000, + }, + { + doc_type: supportedDocumentTypes.flashcard, + title: 'Photosynthesis', + data: [ + { + doc_type: supportedDocumentTypes.text, + title: 'front_Photosynthesis', + data: 'What is photosynthesis?', + width: 300, + height: 300, + x: 200, + y: 800, + }, + { + doc_type: supportedDocumentTypes.text, + title: 'back_photosynthesis', + data: 'The process by which plants make food.', + width: 300, + height: 300, + x: 100, + y: -100, + }, + ], + backgroundColor: '#00ff00', + width: 300, + height: 300, + x: 10, + y: 70, + }, + ], + backgroundColor: '#00ff00', + width: 600, + height: 600, + x: 200, + y: 800, + }, + { + doc_type: supportedDocumentTypes.web, + title: 'Brown University Wikipedia', + data: 'https://en.wikipedia.org/wiki/Brown_University', + width: 300, + height: 300, + x: 1000, + y: 2000, + }, + { + doc_type: supportedDocumentTypes.comparison, + title: 'WWI vs. WWII', + data: [ + { + doc_type: supportedDocumentTypes.text, + title: 'WWI', + data: 'From 1914 to 1918, fighting took place across several continents, at sea and, for the first time, in the air.', + width: 300, + height: 300, + x: 100, + y: 100, + }, + { + doc_type: supportedDocumentTypes.text, + title: 'WWII', + data: 'A devastating global conflict spanning from 1939 to 1945, saw the Allied powers fight against the Axis powers.', + width: 300, + height: 300, + x: 100, + y: 100, + }, + ], + width: 300, + height: 300, + x: 100, + y: 100, + }, + { + doc_type: supportedDocumentTypes.collection, + title: 'Science Collection', + data: [ + { + doc_type: supportedDocumentTypes.flashcard, + title: 'Photosynthesis', + data: [ + { + doc_type: supportedDocumentTypes.text, + title: 'front_Photosynthesis', + data: 'What is photosynthesis?', + width: 300, + height: 300, + }, + { + doc_type: supportedDocumentTypes.text, + title: 'back_photosynthesis', + data: 'The process by which plants make food.', + width: 300, + height: 300, + }, + ], + backgroundColor: '#00ff00', + width: 300, + height: 300, + }, + { + doc_type: supportedDocumentTypes.web, + title: 'Brown University Wikipedia', + data: 'https://en.wikipedia.org/wiki/Brown_University', + width: 300, + height: 300, + x: 1100, + y: 1100, + }, + { + doc_type: supportedDocumentTypes.text, + title: 'Water Cycle', + data: 'The continuous movement of water on, above, and below the Earth’s surface.', + width: 300, + height: 300, + x: 1500, + y: 500, + }, + { + doc_type: supportedDocumentTypes.collection, + title: 'Advanced Biology', + data: [ + { + doc_type: 'text', + title: 'Cell Structure', + data: 'Cells are the basic building blocks of all living organisms.', + width: 300, + height: 300, + }, + ], + backgroundColor: '#00ff00', + width: 600, + height: 600, + x: 1100, + y: 500, + type_collection: 'freeform', + }, + ], + width: 600, + height: 600, + x: 500, + y: 500, + type_collection: 'freeform', + }, +]; + +// Stringify the entire structure for transmission if needed +const finalJsonString = JSON.stringify(example); + +// Instructions for creating various document types +const docInstructions: [supportedDocumentTypes, string | { description: string; example: string }][] = [ + [ supportedDocumentTypes.collection, + { description: `A recursive collection of documents as a stringified array. Each document can be a ${Object.keys(supportedDocumentTypes).map(key => '"' + key + '"').join(',')}.`, + example: finalJsonString }, + ], // prettier-ignore + [supportedDocumentTypes.text, 'Provide text content as a plain string. Example: "This is a standalone text document."'], + [supportedDocumentTypes.flashcard, 'Two text documents with content for the front and back.'], + [supportedDocumentTypes.deck, 'A decks data is an array of flashcards.'], + [supportedDocumentTypes.comparison, 'two documents of any kind that can be compared.'], + [supportedDocumentTypes.image, `A url string that must end with '.png', '.jpeg', '.gif', or '.jpg'`], + [supportedDocumentTypes.web, 'A URL to a webpage. Example: https://en.wikipedia.org/wiki/Brown_University'], + [supportedDocumentTypes.equation, 'Create an equation document, not a text document. Data is math equation.'], + [supportedDocumentTypes.notetaking, 'Create a noteboard document'], + [supportedDocumentTypes.audio, 'A url to an audio recording. Example: '], +] as const; + +// Parameters for creating individual documents +const createDocToolParams = [ + { + name: 'data', + type: 'string', // Accepts either string or array, supporting individual and nested data + description: + typeof docInstructions === 'string' + ? docInstructions + : docInstructions.reduce( + (prev, [type, data]) => { + prev[type] = data; + return prev; + }, + {} as { [key: string]: string | { description: string; example: string } } + ), + required: true, + }, + { + name: 'doc_type', + type: 'string', + description: 'The type of the document. Options: "collection", "text", "flashcard", "web".', + required: true, + }, + { + name: 'title', + type: 'string', + description: 'The title of the document.', + required: true, + }, + { + name: 'x', + type: 'number', + description: 'The x location of the document; 0 <= x.', + required: true, + }, + { + name: 'y', + type: 'number', + description: 'The y location of the document; 0 <= y.', + required: true, + }, + { + name: 'backgroundColor', + type: 'string', + description: 'The background color of the document as a hex string.', + required: false, + }, + { + name: 'fontColor', + type: 'string', + description: 'The font color of the document as a hex string.', + required: false, + }, + { + name: 'width', + type: 'number', + description: 'The width of the document in pixels.', + required: true, + }, + { + name: 'height', + type: 'number', + description: 'The height of the document in pixels.', + required: true, + }, + { + name: 'type_collection', + type: 'string', + description: 'Either freeform, card, carousel, 3d-carousel, multicolumn, multirow, linear, map, notetaking, schema, stacking, grid, tree, or masonry.', + required: false, + }, +] as const; + +// Parameters for creating a list of documents +const createListDocToolParams = [ + { + name: 'docs', + type: 'string', + description: + 'Array of documents in stringified JSON format. Each item in the array should be an individual stringified JSON object. Each document can be of type "text", "flashcard", "comparison", "web", or "collection" (for nested documents). ' + + 'Use this structure for nesting collections within collections. Each document should follow the structure in ' + + createDocToolParams + + '. Example: ' + + finalJsonString, + required: true, + }, +] as const; + +type CreateListDocToolParamsType = typeof createListDocToolParams; + +type CreateDocumentToolParamsType = typeof createDocToolParams; + +const createDocToolInfo: ToolInfo<CreateDocumentToolParamsType> = { + name: 'createAnyDocument', + description: `Creates one or more documents that best fit the user’s request. + If the user requests a "dashboard," first call the search tool and then generate a variety of document types individually, with absolutely a minimum of 20 documents + with two stacks of flashcards that are small and it should have a couple nested freeform collections of things, each with different content and color schemes. + For example, create multiple individual documents like "text," "deck," "web", "equation," and "comparison." + Use decks instead of flashcards for dashboards. Decks should have at least three flashcards. + Really think about what documents are useful to the user. If they ask for a dashboard about the skeletal system, include flashcards, as they would be helpful. + Arrange the documents in a grid layout, ensuring that the x and y coordinates are calculated so no documents overlap but they should be directly next to each other with 20 padding in between. + Take into account the width and height of each document, spacing them appropriately to prevent collisions. + Use a systematic approach, such as placing each document in a grid cell based on its order, where cell dimensions match the document dimensions plus a fixed margin for spacing. + Do not nest all documents within a single collection unless explicitly requested by the user. + Instead, create a set of independent documents with diverse document types. Each type should appear separately unless specified otherwise. + Use the "data" parameter for document content and include title, color, and document dimensions. + Ensure web documents use URLs from the search tool if relevant. Each document in a dashboard should be unique and well-differentiated in type and content, + without repetition of similar types in any single collection. + When creating a dashboard, ensure that it consists of a broad range of document types. + Include a variety of documents, such as text, web, deck, comparison, image, simulation, and equation documents, + each with distinct titles and colors, following the user’s preferences. + Do not overuse collections or nest all document types within a single collection; instead, represent document types individually. Use this example for reference: + ${finalJsonString} . + Which documents are created should be random with different numbers of each document type and different for each dashboard. + Must use search tool before creating a dashboard.`, + parameterRules: createDocToolParams, + citationRules: 'No citation needed.', +}; + +// Tool class for creating documents +export class CreateDocTool extends BaseTool<CreateListDocToolParamsType> { + private _addLinkedDoc: (doc: parsedDoc) => void; + + constructor(addLinkedDoc: (doc: parsedDoc) => void) { + super(createDocToolInfo); + this._addLinkedDoc = addLinkedDoc; + } + + // Executes the tool logic for creating documents + async execute(args: ParametersType<CreateListDocToolParamsType>): Promise<Observation[]> { + try { + const parsedDocs = JSON.parse(args.docs) as parsedDoc[]; + parsedDocs.forEach(doc => this._addLinkedDoc({ ...doc, _layout_fitWidth: false, _layout_autoHeight: true })); + return [{ type: 'text', text: 'Created document.' }]; + } catch (error) { + return [{ type: 'text', text: 'Error creating text document, ' + error }]; + } + } +} |