mirror of
https://github.com/trustgraph-ai/trustgraph.git
synced 2026-04-25 16:36:21 +02:00
152 lines
6.7 KiB
Markdown
152 lines
6.7 KiB
Markdown
|
|
---
|
|||
|
|
layout: default
|
|||
|
|
title: "מפרט טכני של שורת הפקודה עבור תצורות"
|
|||
|
|
parent: "Hebrew (Beta)"
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# מפרט טכני של שורת הפקודה עבור תצורות
|
|||
|
|
|
|||
|
|
> **Beta Translation:** This document was translated via Machine Learning and as such may not be 100% accurate. All non-English languages are currently classified as Beta.
|
|||
|
|
|
|||
|
|
## סקירה כללית
|
|||
|
|
|
|||
|
|
מסמך זה מתאר יכולות תצורה משופרות של שורת הפקודה עבור TrustGraph, ומאפשר למשתמשים לנהל פריטי תצורה בודדים באמצעות פקודות שורת פקודה מפורטות. האינטגרציה תומכת ברשיות שימושיות עיקריות:
|
|||
|
|
|
|||
|
|
1. **רשימת פריטי תצורה**: הצגת מפתחות התצורה של סוג מסוים
|
|||
|
|
2. **קבלת פריט תצורה**: שליפת ערכי התצורה הספציפיים
|
|||
|
|
3. **הגדרת פריט תצורה**: הגדרת או עדכון פריטי תצורה בודדים
|
|||
|
|
4. **מחיקת פריט תצורה**: הסרת פריטי תצורה ספציפיים
|
|||
|
|
|
|||
|
|
## יעדים
|
|||
|
|
|
|||
|
|
- **שליטה מפורטת**: אפשר ניהול של פריטי תצורה בודדים ולא פעולות מקובצות
|
|||
|
|
- **רשימה לפי סוג**: לאפשר למשתמשים לחקור פריטי תצורה לפי סוג
|
|||
|
|
- **פעולות על פריט בודד**: לספק פקודות לקבלת/הגדרה/מחיקה של פריטי תצורה בודדים
|
|||
|
|
- **אינטגרציה של API**: לנצל את ה-API הקיים של התצורה עבור כל הפעולות
|
|||
|
|
- **תבנית שורת פקודה עקבית**: לעקוב אחר התקנות והתבניות הסטנדרטיות של TrustGraph
|
|||
|
|
- **טיפול בשגיאות**: לספק הודעות שגיאה ברורות עבור פעולות לא חוקיות
|
|||
|
|
- **פלט JSON**: תמיכה בפלט מובנה לשימוש תכנותי
|
|||
|
|
- **תיעוד**: לכלול עזרה מקיפה ודוגמאות שימוש
|
|||
|
|
|
|||
|
|
## רקע
|
|||
|
|
|
|||
|
|
TrustGraph מספקת כיום ניהול תצורה באמצעות ה-API של התצורה ופקודה בודדת בשם `tg-show-config` המציגה את כל התצורה. אמנם זה עובד לצורך הצגת התצורה, אך הוא חסר יכולות ניהול מפורטות.
|
|||
|
|
|
|||
|
|
הגבלות נוכחיות כוללות:
|
|||
|
|
- אין דרך לרשום פריטי תצורה לפי סוג מתוך שורת הפקודה
|
|||
|
|
- אין פקודה בשורת הפקודה לקבלת ערכי תצורה ספציפיים
|
|||
|
|
- אין פקודה בשורת הפקודה להגדרת פריטי תצורה בודדים
|
|||
|
|
- אין פקודה בשורת הפקודה למחיקת פריטי תצורה ספציפיים
|
|||
|
|
|
|||
|
|
מסמך זה מטפל בחוסרים אלה על ידי הוספת ארבע פקודות שורת פקודה חדשות המספקות ניהול תצורה מפורט. על ידי חשיפת פעולות API של התצורה הבודדות דרך פקודות שורת פקודה, TrustGraph יכול:
|
|||
|
|
- לאפשר ניהול תצורה מבוסס תסריט
|
|||
|
|
- לאפשר חקירה של מבנה התצורה לפי סוג
|
|||
|
|
- לתמוך בעדכונים ממוקדי תצורה
|
|||
|
|
- לספק שליטה מפורטת על התצורה
|
|||
|
|
|
|||
|
|
## עיצוב טכני
|
|||
|
|
|
|||
|
|
### ארכיטקטורה
|
|||
|
|
|
|||
|
|
התצורה המשופרת של שורת הפקודה דורשת את הרכיבים הטכניים הבאים:
|
|||
|
|
|
|||
|
|
1. **tg-list-config-items**
|
|||
|
|
- רשימת מפתחות תצורה עבור סוג ספציפי
|
|||
|
|
- קוראת לשיטת ה-API `Config.list(type)`
|
|||
|
|
- פלט של רשימת מפתחות התצורה
|
|||
|
|
|
|||
|
|
מודול: `trustgraph.cli.list_config_items`
|
|||
|
|
|
|||
|
|
2. **tg-get-config-item**
|
|||
|
|
- השגת פריט תצורה ספציפי(ים)
|
|||
|
|
- קוראת לשיטת ה-API `Config.get(keys)`
|
|||
|
|
- פלט של ערכי התצורה בפורמט JSON
|
|||
|
|
|
|||
|
|
מודול: `trustgraph.cli.get_config_item`
|
|||
|
|
|
|||
|
|
3. **tg-put-config-item**
|
|||
|
|
- הגדרת או עדכון פריט תצורה
|
|||
|
|
- קוראת לשיטת ה-API `Config.put(values)`
|
|||
|
|
- מקבל את פרמטרי הטיפוס, המפתח והערך
|
|||
|
|
|
|||
|
|
מודול: `trustgraph.cli.put_config_item`
|
|||
|
|
|
|||
|
|
4. **tg-delete-config-item**
|
|||
|
|
- הסרת פריט תצורה
|
|||
|
|
- קוראת לשיטת ה-API `Config.delete(keys)`
|
|||
|
|
- מקבל את פרמטרי הטיפוס והמפתח
|
|||
|
|
|
|||
|
|
מודול: `trustgraph.cli.delete_config_item`
|
|||
|
|
|
|||
|
|
### מודלים של נתונים
|
|||
|
|
|
|||
|
|
#### ConfigKey ו-ConfigValue
|
|||
|
|
|
|||
|
|
הפקודות משתמשות במבני נתונים הקיימים מ-`trustgraph.api.types`:
|
|||
|
|
|
|||
|
|
```python
|
|||
|
|
@dataclasses.dataclass
|
|||
|
|
class ConfigKey:
|
|||
|
|
type : str
|
|||
|
|
key : str
|
|||
|
|
|
|||
|
|
@dataclasses.dataclass
|
|||
|
|
class ConfigValue:
|
|||
|
|
type : str
|
|||
|
|
key : str
|
|||
|
|
value : str
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
גישה זו מאפשרת:
|
|||
|
|
- טיפול עקבי בנתונים בכל ה-CLI וה-API
|
|||
|
|
- פעולות תצורה מסוג-יציבות
|
|||
|
|
- פורמטי קלט/פלט מובנים
|
|||
|
|
- שילוב עם ה-API של התצורה הקיים
|
|||
|
|
|
|||
|
|
### מפרטי פקודות שורת הפקודה
|
|||
|
|
|
|||
|
|
#### tg-list-config-items
|
|||
|
|
```bash
|
|||
|
|
tg-list-config-items --type <config-type> [--format text|json] [--api-url <url>]
|
|||
|
|
```
|
|||
|
|
- **מטרה**: רשימת מפתחות התצורה עבור סוג נתון
|
|||
|
|
- **קריאה ל-API**: `Config.list(type)`
|
|||
|
|
- **פלט**:
|
|||
|
|
- `text` (ברירת מחדל): מפתחות התצורה מופרדים ברווחים
|
|||
|
|
- `json`: מערך JSON של מפתחות התצורה
|
|||
|
|
|
|||
|
|
#### tg-get-config-item
|
|||
|
|
```bash
|
|||
|
|
tg-get-config-item --type <type> --key <key> [--format text|json] [--api-url <url>]
|
|||
|
|
```
|
|||
|
|
- **מטרה**: השגת פריט תצורה ספציפי
|
|||
|
|
- **קריאה ל-API**: `Config.get([ConfigKey(type, key)])`
|
|||
|
|
- **פלט**: ערך התצורה
|
|||
|
|
|
|||
|
|
#### הגדרת פריט תצורה
|
|||
|
|
```bash
|
|||
|
|
tg-put-config-item --type <type> --key <key> --value <value>
|
|||
|
|
```
|
|||
|
|
- **מטרה**: הגדרת או עדכון פריט תצורה
|
|||
|
|
- **קריאה ל-API**: `Config.put(key, value)`
|
|||
|
|
- **פרמטרים**:
|
|||
|
|
- `<type>`: סוג פריט התצורה (לדוגמה, "prompt", "system-prompt")
|
|||
|
|
- `<key>`: המפתח של פריט התצורה
|
|||
|
|
- `<value>`: הערך של פריט התצורה
|
|||
|
|
|
|||
|
|
#### מחיקת פריט תצורה
|
|||
|
|
```bash
|
|||
|
|
tg-delete-config-item --type <type> --key <key>
|
|||
|
|
```
|
|||
|
|
- **מטרה**: הסרת פריט תצורה
|
|||
|
|
- **קריאה ל-API**: `Config.delete(key)`
|
|||
|
|
- **פרמטרים**:
|
|||
|
|
- `<type>`: סוג פריט התצורה
|
|||
|
|
- `<key>`: המפתח של פריט התצורה
|
|||
|
|
|
|||
|
|
## שאלות פתוחות
|
|||
|
|
|
|||
|
|
- האם יש לשנות את הפקודות לתמוך בפעולות מקובצות (מפתחות מרובים) בנוסף לפריטים בודדים?
|
|||
|
|
- איזה פורמט פלט צריך להיות בשימוש עבור אישור הצלחה?
|
|||
|
|
- איך המשתמשים יכולים לגלות או לתעד את סוגי התצורה?
|