Skip to content

Commit 84c3eb5

Browse files
dxpythondxpython
committed
docs: align README, examples, and samples with Skill-enabled runtime
1 parent 5c3dba5 commit 84c3eb5

File tree

13 files changed

+30
-189
lines changed

13 files changed

+30
-189
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Package download: https://www.nuget.org/packages/SharpAIKit/
4444
using SharpAIKit.LLM;
4545

4646
// Works with ANY OpenAI-compatible API
47-
var client = LLMClientFactory.Create("api-key", "https://api.deepseek.com/v1", "deepseek-chat");
47+
var client = LLMClientFactory.Create("YOUR-API-KEY", "https://api.deepseek.com/v1", "deepseek-chat");
4848

4949
// Chat
5050
var response = await client.ChatAsync("Hello!");
@@ -76,7 +76,7 @@ pip install sharpaikit
7676
from sharpaikit import Agent
7777

7878
agent = Agent(
79-
api_key="your-api-key",
79+
api_key="YOUR-API-KEY",
8080
model="gpt-4",
8181
auto_start_host=True
8282
)

‎README_CN.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ from sharpaikit import Agent
140140

141141
# 创建 Agent（自动启动 gRPC 主机）
142142
agent = Agent(
143-
api_key="your-api-key",
143+
api_key="YOUR-API-KEY",
144144
model="gpt-4",
145145
base_url="https://api.openai.com/v1",
146146
auto_start_host=True
@@ -152,7 +152,7 @@ print(result.output)
152152

153153
# 使用 Skills
154154
agent = Agent(
155-
api_key="your-api-key",
155+
api_key="YOUR-API-KEY",
156156
model="gpt-4",
157157
skills=["code-review", "security-policy"],
158158
auto_start_host=True
@@ -178,7 +178,7 @@ agent.close()
178178
using SharpAIKit.LLM;
179179

180180
// 三行代码，支持任意 OpenAI 兼容 API
181-
var client = LLMClientFactory.Create("your-api-key", "https://api.deepseek.com/v1", "deepseek-chat");
181+
var client = LLMClientFactory.Create("YOUR-API-KEY", "https://api.deepseek.com/v1", "deepseek-chat");
182182
var response = await client.ChatAsync("你好！");
183183
Console.WriteLine(response);
184184

@@ -493,7 +493,7 @@ skillResolver.RegisterSkill(new SecurityPolicySkill());
493493
skillResolver.RegisterSkill(new CodeReviewSkill());
494494

495495
// 3. 创建 Agent 并注入 Skill Resolver
496-
var client = LLMClientFactory.CreateDeepSeek("your-api-key");
496+
var client = LLMClientFactory.CreateDeepSeek("YOUR-API-KEY");
497497
var agent = new EnhancedAgent(
498498
llmClient,
499499
skillResolver: skillResolver // 注入 Skill Resolver

‎README_EN.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ from sharpaikit import Agent
140140

141141
# Create agent (automatically starts gRPC host)
142142
agent = Agent(
143-
api_key="your-api-key",
143+
api_key="YOUR-API-KEY",
144144
model="gpt-4",
145145
base_url="https://api.openai.com/v1",
146146
auto_start_host=True
@@ -152,7 +152,7 @@ print(result.output)
152152

153153
# Use Skills
154154
agent = Agent(
155-
api_key="your-api-key",
155+
api_key="YOUR-API-KEY",
156156
model="gpt-4",
157157
skills=["code-review", "security-policy"],
158158
auto_start_host=True
@@ -178,7 +178,7 @@ agent.close()
178178
using SharpAIKit.LLM;
179179

180180
// Three lines of code, works with any OpenAI-compatible API
181-
var client = LLMClientFactory.Create("your-api-key", "https://api.deepseek.com/v1", "deepseek-chat");
181+
var client = LLMClientFactory.Create("YOUR-API-KEY", "https://api.deepseek.com/v1", "deepseek-chat");
182182
var response = await client.ChatAsync("Hello!");
183183
Console.WriteLine(response);
184184

@@ -493,7 +493,7 @@ skillResolver.RegisterSkill(new SecurityPolicySkill());
493493
skillResolver.RegisterSkill(new CodeReviewSkill());
494494

495495
// 3. Create Agent and inject Skill Resolver
496-
var client = LLMClientFactory.CreateDeepSeek("your-api-key");
496+
var client = LLMClientFactory.CreateDeepSeek("YOUR-API-KEY");
497497
var agent = new EnhancedAgent(
498498
llmClient,
499499
skillResolver: skillResolver // Inject Skill Resolver

‎TEST_RESULTS_SUMMARY.md‎

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

‎docs/examples/aiagent-with-skills.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
using SharpAIKit.Agent;
1313
using SharpAIKit.LLM;
1414

15-
var client = LLMClientFactory.CreateDeepSeek("your-api-key");
15+
var client = LLMClientFactory.CreateDeepSeek("YOUR-API-KEY");
1616
var agent = new AiAgent(client);
1717

1818
// Add tools as before
@@ -37,7 +37,7 @@ skillResolver.RegisterSkill(new SecurityPolicySkill());
3737
skillResolver.RegisterSkill(new CodeReviewSkill());
3838

3939
// Create agent with Skill resolver
40-
var client = LLMClientFactory.CreateDeepSeek("your-api-key");
40+
var client = LLMClientFactory.CreateDeepSeek("YOUR-API-KEY");
4141
var agent = new AiAgent(client, skillResolver: skillResolver);
4242

4343
// Add tools

‎python-client/INSTALL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ from sharpaikit import Agent
5252

5353
# This will automatically start the host if needed
5454
agent = Agent(
55-
api_key="your-api-key",
55+
api_key="YOUR-API-KEY",
5656
model="gpt-3.5-turbo",
5757
auto_start_host=True
5858
)

‎python-client/examples/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ This directory contains example scripts demonstrating how to use the SharpAIKit
3636

3737
4. **Set your API key**:
3838
```bash
39-
export OPENAI_API_KEY="your-api-key-here"
39+
export OPENAI_API_KEY="YOUR-API-KEY"
4040
# Or for DeepSeek
41-
export DEEPSEEK_API_KEY="your-api-key-here"
41+
export DEEPSEEK_API_KEY="YOUR-API-KEY"
4242
```
4343

4444
## Running Examples

‎python-client/examples/agent_demo.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ def main():
3333
print("⚠️ Warning: No API key found in environment variables")
3434
print(" Please set OPENAI_API_KEY, DEEPSEEK_API_KEY, or QWEN_API_KEY")
3535
print(" Or edit this script to set your API key directly")
36-
# Default to Qwen API key for testing (通义千问)
37-
api_key = "sk-502f0625194247d4adc2a9c7659c0ffe"
38-
print(" Using default Qwen API key for testing")
36+
# Default API key for testing
37+
api_key = "YOUR-API-KEY"
38+
print(" Please set YOUR-API-KEY in the script or environment variables")
3939

4040
# Use Qwen configuration if using Qwen API key
41+
4142
if api_key == "YOUR-API-KEY" or os.getenv("QWEN_API_KEY"):
4243
base_url = os.getenv("LLM_BASE_URL", "https://dashscope.aliyuncs.com/compatible-mode/v1")
4344
model = os.getenv("LLM_MODEL", "qwen-turbo")

‎python-client/examples/comprehensive_demo.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def demo_basic_agent():
4040
print_section("Demo 1: Basic Agent Execution")
4141

4242
# Configuration
43-
API_KEY = "YOUR_API_KEY"
43+
API_KEY = "YOUR-API-KEY"
4444
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
4545
MODEL = "qwen-plus"
4646

@@ -81,7 +81,7 @@ def demo_skill_system():
8181
"""Demo 2: Skill system integration"""
8282
print_section("Demo 2: Skill System Integration")
8383

84-
API_KEY = "sk-502f0625194247d4adc2a9c7659c0ffe"
84+
API_KEY = "YOUR-API-KEY"
8585
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
8686
MODEL = "qwen-plus"
8787

@@ -141,7 +141,7 @@ def demo_streaming():
141141
"""Demo 3: Streaming execution"""
142142
print_section("Demo 3: Streaming Execution")
143143

144-
API_KEY = "sk-502f0625194247d4adc2a9c7659c0ffe"
144+
API_KEY = "YOUR-API-KEY"
145145
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
146146
MODEL = "qwen-plus"
147147

@@ -186,7 +186,7 @@ def demo_context_passing():
186186
"""Demo 4: Context passing"""
187187
print_section("Demo 4: Context Passing")
188188

189-
API_KEY = "sk-502f0625194247d4adc2a9c7659c0ffe"
189+
API_KEY = "YOUR-API-KEY"
190190
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
191191
MODEL = "qwen-plus"
192192

@@ -229,7 +229,7 @@ def demo_error_handling():
229229
"""Demo 5: Error handling"""
230230
print_section("Demo 5: Error Handling")
231231

232-
API_KEY = "sk-502f0625194247d4adc2a9c7659c0ffe"
232+
API_KEY = "YOUR-API-KEY"
233233
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
234234
MODEL = "qwen-plus"
235235

@@ -277,7 +277,7 @@ def demo_skill_resolution():
277277
"""Demo 6: Skill resolution details"""
278278
print_section("Demo 6: Skill Resolution Details")
279279

280-
API_KEY = "sk-502f0625194247d4adc2a9c7659c0ffe"
280+
API_KEY = "YOUR-API-KEY"
281281
BASE_URL = "https://dashscope.aliyuncs.com/compatible-mode/v1"
282282
MODEL = "qwen-plus"
283283

‎samples/NewFeaturesDemo/Program.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
using SharpAIKit.Observability;
77
using ToolDefinition = SharpAIKit.Agent.ToolDefinition;
88

9-
Console.WriteLine("🧪 SharpAIKit New Features Test (v0.3.0)\n");
9+
Console.WriteLine("🧪 SharpAIKit New Features Test (v0.4.0)\n");
1010
Console.WriteLine("=".PadRight(60, '='));
1111

12-
var apiKey = "sk-e164311ef7914e46a5d760c505714b94";
12+
var apiKey = "YOUR-API-KEY";
1313
var client = LLMClientFactory.CreateDeepSeek(apiKey);
1414

1515
// ============================================================

0 commit comments

Comments
 (0)