Skip to content

Commit 052f096

Browse files
committed
docs
1 parent 9e1f3c9 commit 052f096

5 files changed

Lines changed: 32 additions & 12 deletions

File tree

docs/classes/ClientCompute.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ constructor(params: IComputeParams<Compute>);
2121
params: IComputeParams<Compute>
2222
```
2323

24-
### __@DISPOSE_SLOT_FN_SYMBOL@3106
24+
### __@DISPOSE_SLOT_FN_SYMBOL@3110
2525

2626
```ts
27-
__@DISPOSE_SLOT_FN_SYMBOL@3106: any
27+
__@DISPOSE_SLOT_FN_SYMBOL@3110: any
2828
```
2929

30-
### __@GET_COMPUTE_DATA_FN_SYMBOL@3107
30+
### __@GET_COMPUTE_DATA_FN_SYMBOL@3111
3131

3232
```ts
33-
__@GET_COMPUTE_DATA_FN_SYMBOL@3107: any
33+
__@GET_COMPUTE_DATA_FN_SYMBOL@3111: any
3434
```
3535

3636
## Methods

docs/classes/ClientSwarm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Returns the current busy state of the swarm.
101101
Used to check if the swarm is currently processing an operation (e.g., waiting for output or switching agents).
102102
Supports debugging and flow control in client applications.
103103

104-
### __@SET_BUSY_FN@1563
104+
### __@SET_BUSY_FN@1567
105105

106106
```ts
107107
[SET_BUSY_FN](isBusy: boolean): void;

docs/classes/SchemaUtils.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ constructor();
1616

1717
## Properties
1818

19-
### __@PERSIST_WRITE_SYMBOL@4302
19+
### __@PERSIST_WRITE_SYMBOL@4306
2020

2121
```ts
22-
__@PERSIST_WRITE_SYMBOL@4302: any
22+
__@PERSIST_WRITE_SYMBOL@4306: any
2323
```
2424

2525
### writeSessionMemory

docs/interfaces/ICompletionArgs.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,13 @@ tools: ITool[]
6262
```
6363

6464
Optional array of tools available for the completion process (e.g., for tool calls).
65+
66+
### format
67+
68+
```ts
69+
format: IOutlineFormat
70+
```
71+
72+
Optional format for the outline, specifying how the completion should be structured.
73+
This is used to define the expected output format for JSON completions.
74+
If not provided, the default outline format will be used.

docs/interfaces/IOutlineSchema.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,23 @@ The name of the completion for JSON
2121
### prompt
2222

2323
```ts
24-
prompt: string | string[] | ((outlineName: string) => string | string[] | Promise<string | string[]>)
24+
prompt: string | ((outlineName: string) => string | Promise<string>)
2525
```
2626

27-
The prompt or prompt generator for the outline operation.
28-
Can be a string, an array of strings, or a function that returns a string, array of strings, or a promise resolving to either.
29-
If a function is provided, it receives the outline name and can return a prompt dynamically.
30-
Used as the initial instruction or context for the outline process.
27+
The prompt used to initiate the outline operation.
28+
Can be a static string or a function that generates the prompt dynamically based on the outline name.
29+
If a function is provided, it may return a string or a Promise resolving to a string.
30+
This prompt is typically sent to the completion engine or model to guide the generation process.
31+
32+
### system
33+
34+
```ts
35+
system: string[] | ((outlineName: string) => string[] | Promise<string[]>)
36+
```
37+
38+
The system prompt(s) provided to the language model for the outline operation.
39+
Can be a static array of strings or a function that generates the system prompts dynamically based on the outline name.
40+
These prompts are typically used to set context, instructions, or constraints for the model before user or assistant messages.
3141

3242
### docDescription
3343

0 commit comments

Comments
 (0)