Skip to content

Commit 8b70a92

Browse files
committed
Add detailed schema property tables to docs
Expand reference docs with explicit Properties / Allowed Values tables for many schemas (AI, conversation, cost, API, automation, data, identity, integration, kernel, system, UI, etc.), including union/option breakdowns and enum lists for message, action, and budget types. Remove several hub reference files under content/docs/references/hub. Update packages/spec/scripts/build-docs.ts to accommodate the documentation changes. These edits improve discoverability of fields and make the API/AI schemas more explicit for consumers.
1 parent 3a15368 commit 8b70a92

File tree

155 files changed

+15340
-420
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

155 files changed

+15340
-420
lines changed

content/docs/references/ai/agent-action.mdx

Lines changed: 420 additions & 0 deletions
Large diffs are not rendered by default.

content/docs/references/ai/agent.mdx

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,64 @@ const result = AIKnowledge.parse(data);
2323

2424
## AIKnowledge
2525

26+
### Properties
27+
28+
| Property | Type | Required | Description |
29+
| :--- | :--- | :--- | :--- |
30+
| **topics** | `string[]` || Topics/Tags to recruit knowledge from |
31+
| **indexes** | `string[]` || Vector Store Indexes |
32+
2633

2734
---
2835

2936
## AIModelConfig
3037

38+
### Properties
39+
40+
| Property | Type | Required | Description |
41+
| :--- | :--- | :--- | :--- |
42+
| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'local'>` || |
43+
| **model** | `string` || Model name (e.g. gpt-4, claude-3-opus) |
44+
| **temperature** | `number` || |
45+
| **maxTokens** | `number` | optional | |
46+
| **topP** | `number` | optional | |
47+
3148

3249
---
3350

3451
## AITool
3552

53+
### Properties
54+
55+
| Property | Type | Required | Description |
56+
| :--- | :--- | :--- | :--- |
57+
| **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` || |
58+
| **name** | `string` || Reference name (Action Name, Flow Name) |
59+
| **description** | `string` | optional | Override description for the LLM |
60+
3661

3762
---
3863

3964
## Agent
4065

66+
### Properties
67+
68+
| Property | Type | Required | Description |
69+
| :--- | :--- | :--- | :--- |
70+
| **name** | `string` || Agent unique identifier |
71+
| **label** | `string` || Agent display name |
72+
| **avatar** | `string` | optional | |
73+
| **role** | `string` || The persona/role (e.g. "Senior Support Engineer") |
74+
| **instructions** | `string` || System Prompt / Prime Directives |
75+
| **model** | `Object` | optional | |
76+
| **lifecycle** | `Object` | optional | State machine defining the agent conversation follow and constraints |
77+
| **tools** | `Object[]` | optional | Available tools |
78+
| **knowledge** | `Object` | optional | RAG access |
79+
| **active** | `boolean` || |
80+
| **access** | `string[]` | optional | Who can chat with this agent |
81+
| **tenantId** | `string` | optional | Tenant/Organization ID |
82+
| **visibility** | `Enum<'global' \| 'organization' \| 'private'>` || |
83+
4184

4285
---
4386

0 commit comments

Comments
 (0)