diff --git a/genaisrc/genaiscript.d.ts b/genaisrc/genaiscript.d.ts index f21ea5fbf..6671ae0ad 100644 --- a/genaisrc/genaiscript.d.ts +++ b/genaisrc/genaiscript.d.ts @@ -65,37 +65,9 @@ interface PromptLike extends PromptDefinition { text?: string } -type SystemPromptId = - | "system" - | "system.annotations" - | "system.changelog" - | "system.diff" - | "system.explanations" - | "system.files" - | "system.files_schema" - | "system.fs_find_files" - | "system.fs_read_file" - | "system.fs_read_summary" - | "system.functions" - | "system.math" - | "system.python" - | "system.retrieval_fuzz_search" - | "system.retrieval_vector_search" - | "system.retrieval_web_search" - | "system.schema" - | "system.tasks" - | "system.technical" - | "system.typescript" - | "system.zero_shot_cot" +type SystemPromptId = "system" | "system.annotations" | "system.changelog" | "system.diff" | "system.explanations" | "system.files" | "system.files_schema" | "system.fs_find_files" | "system.fs_read_file" | "system.fs_read_summary" | "system.functions" | "system.math" | "system.python" | "system.retrieval_fuzz_search" | "system.retrieval_vector_search" | "system.retrieval_web_search" | "system.schema" | "system.tasks" | "system.technical" | "system.typescript" | "system.zero_shot_cot" -type SystemToolId = - | "fs_find_files" - | "fs_read_file" - | "fs_read_summary" - | "math_eval" - | "retrieval_fuzz_search" - | "retrieval_vector_search" - | "retrieval_web_search" +type SystemToolId = "fs_find_files" | "fs_read_file" | "fs_read_summary" | "math_eval" | "retrieval_fuzz_search" | "retrieval_vector_search" | "retrieval_web_search" type FileMergeHandler = ( filename: string, @@ -220,45 +192,45 @@ interface ScriptRuntimeOptions { /** * List of system script ids used by the prompt. */ - /** - * System prompt identifiers ([reference](https://microsoft.github.io/genaiscript/reference/scripts/system/)) - * - `system`: Base system prompt - * - `system.annotations`: Emits annotations compatible with GitHub Actions - * - `system.changelog`: Generate changelog formatter edits - * - `system.diff`: Generates concise file diffs. - * - `system.explanations`: Explain your answers - * - `system.files`: File generation - * - `system.files_schema`: Apply JSON schemas to generated data. - * - `system.fs_find_files`: File Find Files - * - `system.fs_read_file`: File Read File - * - `system.fs_read_summary`: File Read Summary - * - `system.functions`: use functions - * - `system.math`: Math expression evaluator - * - `system.python`: Expert at generating and understanding Python code. - * - `system.retrieval_fuzz_search`: Full Text Fuzzy Search - * - `system.retrieval_vector_search`: Embeddings Vector Search - * - `system.retrieval_web_search`: Web Search - * - `system.schema`: JSON Schema support - * - `system.tasks`: Generates tasks - * - `system.technical`: Technical Writer - * - `system.typescript`: Export TypeScript Developer - * - `system.zero_shot_cot`: Zero-shot Chain Of Though - **/ +/** +* System prompt identifiers ([reference](https://microsoft.github.io/genaiscript/reference/scripts/system/)) +* - `system`: Base system prompt +* - `system.annotations`: Emits annotations compatible with GitHub Actions +* - `system.changelog`: Generate changelog formatter edits +* - `system.diff`: Generates concise file diffs. +* - `system.explanations`: Explain your answers +* - `system.files`: File generation +* - `system.files_schema`: Apply JSON schemas to generated data. +* - `system.fs_find_files`: File Find Files +* - `system.fs_read_file`: File Read File +* - `system.fs_read_summary`: File Read Summary +* - `system.functions`: use functions +* - `system.math`: Math expression evaluator +* - `system.python`: Expert at generating and understanding Python code. +* - `system.retrieval_fuzz_search`: Full Text Fuzzy Search +* - `system.retrieval_vector_search`: Embeddings Vector Search +* - `system.retrieval_web_search`: Web Search +* - `system.schema`: JSON Schema support +* - `system.tasks`: Generates tasks +* - `system.technical`: Technical Writer +* - `system.typescript`: Export TypeScript Developer +* - `system.zero_shot_cot`: Zero-shot Chain Of Though +**/ system?: SystemPromptId[] /** * List of tools used by the prompt. */ - /** - * System tool identifiers ([reference](https://microsoft.github.io/genaiscript/reference/scripts/tools/)) - * - `fs_find_files`: Finds file matching a glob pattern. - * - `fs_read_file`: Reads a file as text from the file system. - * - `fs_read_summary`: Reads a summary of a file from the file system. - * - `math_eval`: Evaluates a math expression - * - `retrieval_fuzz_search`: Search for keywords using the full text of files and a fuzzy distance. - * - `retrieval_vector_search`: Search files using embeddings and similarity distance. - * - `retrieval_web_search`: Search the web for a user query using Bing Search. - **/ +/** +* System tool identifiers ([reference](https://microsoft.github.io/genaiscript/reference/scripts/tools/)) +* - `fs_find_files`: Finds file matching a glob pattern. +* - `fs_read_file`: Reads a file as text from the file system. +* - `fs_read_summary`: Reads a summary of a file from the file system. +* - `math_eval`: Evaluates a math expression +* - `retrieval_fuzz_search`: Search for keywords using the full text of files and a fuzzy distance. +* - `retrieval_vector_search`: Search files using embeddings and similarity distance. +* - `retrieval_web_search`: Search the web for a user query using Bing Search. +**/ tools?: SystemToolId[] /** @@ -556,7 +528,7 @@ interface WorkspaceFileSystem { /** * Reads the content of a file and parses to JSON, using the JSON5 parser. - * @param path + * @param path */ readJSON(path: string | WorkspaceFile): Promise @@ -1677,6 +1649,8 @@ interface PromptContext extends ChatGenerationContext { host: PromptHost } + + // keep in sync with PromptContext! /** diff --git a/genaisrc/jsconfig.json b/genaisrc/jsconfig.json index edf1f30e9..4c21c58ce 100644 --- a/genaisrc/jsconfig.json +++ b/genaisrc/jsconfig.json @@ -12,7 +12,6 @@ }, "include": [ "*.js", - "*.mjs", "./genaiscript.d.ts" ] } \ No newline at end of file