1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
import { toLower } from 'lodash';
import { Doc } from '../../../../../fields/Doc';
import { Id } from '../../../../../fields/FieldSymbols';
import { DocumentOptions } from '../../../../documents/Documents';
import { parsedDoc } from '../chatboxcomponents/ChatBox';
import { ParametersType, ToolInfo } from '../types/tool_types';
import { Observation } from '../types/types';
import { BaseTool } from './BaseTool';
import { supportedDocTypes } from './CreateDocumentTool';
const standardOptions = ['title', 'backgroundColor'];
/**
* Description of document options and data field for each type.
*/
const documentTypesInfo: { [key in supportedDocTypes]: { options: string[]; dataDescription: string } } = {
[supportedDocTypes.flashcard]: {
options: [...standardOptions, 'fontColor', 'text_align'],
dataDescription: 'an array of two strings. the first string contains a question, and the second string contains an answer',
},
[supportedDocTypes.text]: {
options: [...standardOptions, 'fontColor', 'text_align'],
dataDescription: 'The text content of the document.',
},
[supportedDocTypes.html]: {
options: [],
dataDescription: 'The HTML-formatted text content of the document.',
},
[supportedDocTypes.equation]: {
options: [...standardOptions, 'fontColor'],
dataDescription: 'The equation content as a string.',
},
[supportedDocTypes.functionplot]: {
options: [...standardOptions, 'function_definition'],
dataDescription: 'The function definition(s) for plotting. Provide as a string or array of function definitions.',
},
[supportedDocTypes.dataviz]: {
options: [...standardOptions, 'chartType'],
dataDescription: 'A string of comma-separated values representing the CSV data.',
},
[supportedDocTypes.notetaking]: {
options: standardOptions,
dataDescription: 'The initial content or structure for note-taking.',
},
[supportedDocTypes.rtf]: {
options: standardOptions,
dataDescription: 'The rich text content in RTF format.',
},
[supportedDocTypes.image]: {
options: standardOptions,
dataDescription: 'The image content as an image file URL.',
},
[supportedDocTypes.pdf]: {
options: standardOptions,
dataDescription: 'the pdf content as a PDF file url.',
},
[supportedDocTypes.audio]: {
options: standardOptions,
dataDescription: 'The audio content as a file url.',
},
[supportedDocTypes.video]: {
options: standardOptions,
dataDescription: 'The video content as a file url.',
},
[supportedDocTypes.message]: {
options: standardOptions,
dataDescription: 'The message content of the document.',
},
[supportedDocTypes.diagram]: {
options: ['title', 'backgroundColor'],
dataDescription: 'diagram content as a text string in Mermaid format.',
},
[supportedDocTypes.script]: {
options: ['title', 'backgroundColor'],
dataDescription: 'The compilable JavaScript code. Use this for creating scripts.',
},
};
const createAnyDocumentToolParams = [
{
name: 'document_type',
type: 'string',
description: `The type of the document to create. Supported types are: ${Object.values(supportedDocTypes).join(', ')}`,
required: true,
},
{
name: 'data',
type: 'string',
description: 'The content or data of the document. The exact format depends on the document type.',
required: true,
},
{
name: 'options',
type: 'string',
required: false,
description: `A JSON string representing the document options. Available options depend on the document type. For example:
${Object.entries(documentTypesInfo).map( ([doc_type, info]) => `
- For '${doc_type}' documents, options include: ${info.options.join(', ')}`)
.join('\n')}`, // prettier-ignore
},
] as const;
type CreateAnyDocumentToolParamsType = typeof createAnyDocumentToolParams;
const createAnyDocToolInfo: ToolInfo<CreateAnyDocumentToolParamsType> = {
name: 'createAnyDocument',
description:
`Creates any type of document with the provided options and data.
Supported document types are: ${Object.values(supportedDocTypes).join(', ')}.
dataviz is a csv table tool, so for CSVs, use dataviz. Here are the options for each type:
<supported_document_types>` +
Object.entries(documentTypesInfo)
.map(
([doc_type, info]) =>
`<document_type name="${doc_type}">
<data_description>${info.dataDescription}</data_description>
<options>` +
info.options.map(option => `<option>${option}</option>`).join('\n') +
`</options>
</document_type>`
)
.join('\n') +
`</supported_document_types>`,
parameterRules: createAnyDocumentToolParams,
citationRules: 'No citation needed.',
};
export class CreateAnyDocumentTool extends BaseTool<CreateAnyDocumentToolParamsType> {
private _addLinkedDoc: (doc: parsedDoc) => Doc | undefined;
constructor(addLinkedDoc: (doc: parsedDoc) => Doc | undefined) {
super(createAnyDocToolInfo);
this._addLinkedDoc = addLinkedDoc;
}
async execute(args: ParametersType<CreateAnyDocumentToolParamsType>): Promise<Observation[]> {
try {
const documentType = toLower(args.document_type) as unknown as supportedDocTypes;
const info = documentTypesInfo[documentType];
if (info === undefined) {
throw new Error(`Unsupported document type: ${documentType}. Supported types are: ${Object.values(supportedDocTypes).join(', ')}.`);
}
if (!args.data) {
throw new Error(`Data is required for ${documentType} documents. ${info.dataDescription}`);
}
const options: DocumentOptions = !args.options ? {} : JSON.parse(args.options);
// Call the function to add the linked document (add default title that can be overriden if set in options)
const doc = this._addLinkedDoc({ doc_type: documentType, data: args.data, title: `New ${documentType.charAt(0).toUpperCase() + documentType.slice(1)} Document`, ...options });
return [{ type: 'text', text: `Created ${documentType} document with ID ${doc?.[Id]}.` }];
} catch (error) {
return [{ type: 'text', text: 'Error creating document: ' + (error as Error).message }];
}
}
}
|
