Skip to content

Commit d1b55af

Browse files
committed
Update docstrings
1 parent b51559b commit d1b55af

File tree

2 files changed

+49
-2
lines changed

2 files changed

+49
-2
lines changed

mindsdb_sdk/agents.py

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,35 @@ def __repr__(self):
1717

1818

1919
class Agent:
20-
"""Represents a MindsDB agent"""
20+
"""Represents a MindsDB agent.
21+
22+
Working with agents:
23+
24+
Get an agent by name:
25+
>>> agent = agents.get('my_agent')
26+
27+
Query an agent:
28+
>>> completion = agent.completion([{'question': 'What is your name?', 'answer': None}])
29+
>>> print(completion.content)
30+
31+
List all agents:
32+
>>> agents = agents.list()
33+
34+
Create a new agent:
35+
>>> model = models.get('my_model') # Or use models.create(...)
36+
>>> # Connect your agent to a MindsDB table.
37+
>>> text_to_sql_skill = skills.create('text_to_sql', 'sql', { 'tables': ['my_table'], 'database': 'my_database' })
38+
>>> agent = agents.create('my_agent', model, [text_to_sql_skill])
39+
40+
Update an agent:
41+
>>> new_model = models.get('new_model')
42+
>>> agent.model_name = new_model.name
43+
>>> new_skill = skills.create('new_skill', 'sql', { 'tables': ['new_table'], 'database': 'new_database' })
44+
>>> updated_agent = agents.update('my_agent', agent)
45+
46+
Delete an agent by name:
47+
>>> agents.delete('my_agent')
48+
"""
2149
def __init__(
2250
self,
2351
name: str,

mindsdb_sdk/skills.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,26 @@
44

55

66
class Skill():
7-
"""Represents a MindsDB skill"""
7+
"""Represents a MindsDB skill
8+
9+
Working with skills:
10+
11+
Get a skill by name:
12+
>>> skill = skills.get('my_skill')
13+
14+
List all skills:
15+
>>> skills = skills.list()
16+
17+
Create a new SQL skill:
18+
>>> text_to_sql_skill = skills.create('text_to_sql', 'sql', { 'tables': ['my_table'], 'database': 'my_database' })
19+
20+
Update a skill:
21+
>>> skill.params = { 'tables': ['new_table'], 'database': 'new_database' }
22+
>>> updated_skill = skills.update('my_skill', skill)
23+
24+
Delete a skill by name
25+
>>> skills.delete('my_skill')
26+
"""
827
def __init__(
928
self,
1029
name: str,

0 commit comments

Comments
 (0)