Skip to content

Commit 40a88e1

Browse files
chore(doc): auto generate docs
1 parent ed28296 commit 40a88e1

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

doc/CopilotChat.txt

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -329,42 +329,43 @@ For supported models, see:
329329

330330
FUNCTIONS *CopilotChat-functions*
331331

332-
Functions provide additional information and behaviour to the chat. Tools can
333-
be organized into groups by setting the `group` property. Tools assigned to a
334-
group are not automatically made available to the LLM - they must be explicitly
335-
activated. To use grouped tools in your prompt, include `@group_name` in your
336-
message. This allows the LLM to access and use all tools in that group during
337-
the current interaction. Add tools using `#tool_name[:input]` syntax:
332+
Functions provide additional information and behaviour to the chat. Functions
333+
can be organized into groups by setting the `group` property. Functions can be
334+
made available to the LLM with `@group_name` or `@function_name` syntax. LLM
335+
will then be able to use them in responses as tool calls. If function has URI,
336+
they can also be used directly in prompt with `#function_name[:input]` syntax
337+
for providing context as resources.
338338

339-
--------------------------------------------------------------------------
340-
Function Input Description
341-
Support
342-
------------- ------------ -----------------------------------------------
343-
buffer ✓ (name) Retrieves content from a specific buffer
339+
-------------------------------------------------------------------------------
340+
Function Input URI Description
341+
Support
342+
------------- ------------ ----- ----------------------------------------------
343+
buffer ✓ (name) Retrieves content from a specific buffer
344344

345-
buffers ✓ (scope) Fetches content from multiple buffers
346-
(listed/visible)
345+
buffers ✓ (scope) Fetches content from multiple buffers
346+
(listed/visible)
347347

348-
diagnostics ✓ (scope) Collects code diagnostics (errors, warnings)
348+
diagnostics ✓ (scope) Collects code diagnostics (errors, warnings)
349349

350-
file ✓ (path) Reads content from a specified file path
350+
file ✓ (path) Reads content from a specified file path
351351

352-
gitdiff ✓ (sha) Retrieves git diff information
353-
(unstaged/staged/sha)
352+
gitdiff ✓ (sha) Retrieves git diff information
353+
(unstaged/staged/sha)
354354

355-
gitstatus - Retrieves git status information
355+
gitstatus - Retrieves git status information
356356

357-
glob ✓ (pattern) Lists filenames matching a pattern in workspace
357+
glob ✓ (pattern) ✓ Lists filenames matching a pattern in
358+
workspace
358359

359-
grep ✓ (pattern) Searches for a pattern across files in
360-
workspace
360+
grep ✓ (pattern) Searches for a pattern across files in
361+
workspace
361362

362-
quickfix - Includes content of files in quickfix list
363+
quickfix - Includes content of files in quickfix list
363364

364-
register ✓ (register) Provides access to specified Vim register
365+
register ✓ (register) Provides access to specified Vim register
365366

366-
url ✓ (url) Fetches content from a specified URL
367-
--------------------------------------------------------------------------
367+
url ✓ (url) Fetches content from a specified URL
368+
-------------------------------------------------------------------------------
368369
Examples:
369370

370371
>markdown
@@ -378,6 +379,9 @@ Examples:
378379
> #quickfix
379380
> #register:+
380381
> #url:https://example.com
382+
> @glob
383+
> @grep
384+
> @file
381385
<
382386

383387
Define your own functions in the configuration with input handling and schema:
@@ -640,7 +644,7 @@ CORE *CopilotChat-core*
640644
chat.ask(prompt, config) -- Ask a question with optional config
641645
chat.response() -- Get the last response text
642646
chat.resolve_prompt() -- Resolve prompt references
643-
chat.resolve_tools() -- Resolve tools that are available for automatic use by LLM
647+
chat.resolve_functions() -- Resolve functions that are available for automatic use by LLM (WARN: async, requires plenary.async.run)
644648
chat.resolve_model() -- Resolve model from prompt (WARN: async, requires plenary.async.run)
645649

646650
-- Window Management
@@ -697,6 +701,7 @@ You can also access the chat window UI methods through the `chat.chat` object:
697701
-- Content Management
698702
window:append(text) -- Append text to chat window
699703
window:clear() -- Clear chat window content
704+
window:start() -- Start writing to chat window
700705
window:finish() -- Finish writing to chat window
701706

702707
-- Navigation

0 commit comments

Comments
 (0)