Skip to content

Commit c249b31

Browse files
Copilothotlong
andcommitted
Restructure docs to zod file level - one MDX file per .zod.ts file
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 7a5ffc2 commit c249b31

File tree

567 files changed

+8145
-17249
lines changed

Some content is hidden

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

567 files changed

+8145
-17249
lines changed
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: Agent
3+
description: Agent protocol schemas
4+
---
5+
6+
import { Card, Cards } from 'fumadocs-ui/components/card';
7+
import { Callout } from 'fumadocs-ui/components/callout';
8+
9+
# Agent
10+
11+
<Callout type="info">
12+
**Source:** `packages/spec/src/ai/agent.zod.ts`
13+
</Callout>
14+
15+
## TypeScript Usage
16+
17+
```typescript
18+
import { AIKnowledgeSchema, AIModelConfigSchema, AIToolSchema, AgentSchema } from '@objectstack/spec/ai';
19+
import type { AIKnowledge, AIModelConfig, AITool, Agent } from '@objectstack/spec/ai';
20+
21+
// Validate data
22+
const result = AIKnowledgeSchema.parse(data);
23+
```
24+
25+
---
26+
27+
## AIKnowledge
28+
29+
### Properties
30+
31+
| Property | Type | Required | Description |
32+
| :--- | :--- | :--- | :--- |
33+
| **topics** | `string[]` || Topics/Tags to recruit knowledge from |
34+
| **indexes** | `string[]` || Vector Store Indexes |
35+
36+
---
37+
38+
## AIModelConfig
39+
40+
### Properties
41+
42+
| Property | Type | Required | Description |
43+
| :--- | :--- | :--- | :--- |
44+
| **provider** | `Enum<'openai' \| 'azure_openai' \| 'anthropic' \| 'local'>` | optional | |
45+
| **model** | `string` || Model name (e.g. gpt-4, claude-3-opus) |
46+
| **temperature** | `number` | optional | |
47+
| **maxTokens** | `number` | optional | |
48+
| **topP** | `number` | optional | |
49+
50+
---
51+
52+
## AITool
53+
54+
### Properties
55+
56+
| Property | Type | Required | Description |
57+
| :--- | :--- | :--- | :--- |
58+
| **type** | `Enum<'action' \| 'flow' \| 'query' \| 'vector_search'>` || |
59+
| **name** | `string` || Reference name (Action Name, Flow Name) |
60+
| **description** | `string` | optional | Override description for the LLM |
61+
62+
---
63+
64+
## Agent
65+
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+
| **tools** | `object[]` | optional | Available tools |
77+
| **knowledge** | `object` | optional | RAG access |
78+
| **active** | `boolean` | optional | |
79+
| **access** | `string[]` | optional | Who can chat with this agent |
80+

content/docs/references/ai/agent/AIKnowledge.mdx

Lines changed: 0 additions & 35 deletions
This file was deleted.

content/docs/references/ai/agent/AIModelConfig.mdx

Lines changed: 0 additions & 37 deletions
This file was deleted.

content/docs/references/ai/agent/AITool.mdx

Lines changed: 0 additions & 36 deletions
This file was deleted.

content/docs/references/ai/agent/Agent.mdx

Lines changed: 0 additions & 45 deletions
This file was deleted.

content/docs/references/ai/agent/meta.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)