תיעוד Syncanix
כל מה שדרוש כדי לגלות את ה-API שלכם, להטמיע את רכיב הצ׳אט, לחבר לקוח MCP ולהשיק עוזר AI שמבצע פעולות אמיתיות עבור המשתמשים שלכם — מתארח באיחוד האירופי, בשש שפות.
מתחילים כאן
- התחלה מהירהמה-API הקיים שלכם ועד עוזר פעיל באפליקציה שלכם — בכ-90 דקות.
- הטמעה באפליקציה שלכםכל הדרכים להציב את הווידג׳ט של Syncanix באתר: תגית הסקריפט, אפליקציות עמוד יחיד, עיגון בתוך הדף, זהות ו-CSP.
- אימות המשתמשים שלךארבע הדרכים שבהן הווידג׳ט יכול לאמת את משתמשי הקצה שלך, וכיצד לבחור את זו שמתאימה למערך שלך.
- חיבור לקוחחברו את Claude Desktop, Cursor, ChatGPT ולקוחות MCP אחרים לסביבת העבודה שלכם.
מבוא
- מה זה Syncanix?Syncanix הופך את ה-API הקיים שלכ ם לעוזר AI שהמשתמשים שלכם יכולים לשוחח איתו — מוטמע באפליקציה שלכם וזמין ללקוחות AI דרך MCP.
- איך Syncanix עובדמפקודת גילוי אחת ועד עוזר פעיל: כיצד קטלוג היכולות מחבר בין ה-CLI, הרכיב, משטח הצ׳אט ושרת ה-MCP.
- סקירת הארכיטקטורהכיצד Syncanix מחבר בין המשתמשים שלכם, ה-API שלכם וה-AI — והיכן הכול פועל.
- שפות ו-RTLSyncanix עובד בשש שפות באופן מובנֶה, עם תמיכה מלאה מימין לשמאל לערבית ולעברית.
- מילון מונחיםמונחי מפתח שבשימוש בתיעוד של Syncanix.
- שאלות נפוצותתשובות ישירות לשאלות ששואלים הכי הרבה על Syncanix — הקמה, מה העוזר יכול לעשות, אבטחה ונתונים, הווידג'ט, חיוב ושפות.
תחילת העבודה
מושגי יסוד
- קטלוג היכולותהרשימה המובְנית של מה שה-API שלכם יכול לעשות — מתגלה פעם אחת, נכתבת על ידיכם, ונקראת בכל המשטחים.
- הדפדפן הוא השערמודל האבטחה של Syncanix ברעיון אחד: מודל השפה לעולם אינו מחזיק את פרטי הזהות של המשתמשים שלכם.
- מה העוזר יכול לעשות ומה לאסיכום בשפה פשוטה של מה בדיוק העוזר החכם מורשה לעשות בשמכם, מה הוא לעולם לא יכול לעשות, וכיצד כל פעולה בעלת סיכון נבדקת.
- זהות ואימותSyncanix משתמש בספק הזהויות הקיים שלכם — הוא לעולם אינו הופך למחסן הסיסמאות של המשתמשים שלכם.
- אישור פעולות וסיכוןכיצד Syncanix מחליט מה רץ אוטומטית ומה דורש «כן» אנושי.
- מצבי הצגהכיצד העוזר מציג תוצאות — רכיבים מובְנים, רכיבים משלכם, או הפניית המשתמש לעמוד הנכון.
- אמינות וניתוב מודליםכיצד Syncanix ממשיך לענות: כמה ספקי מודלים, מפתחות משלכם, וניתוב באיחוד האירופי.
- זיכרון וידעמה העוזר זוכר בין מפגשים, והידע שעליו הוא נשען כדי לענות.
CLI
- ה-CLI של Syncanixגלו את ה-API שלכם ונהלו את הקטלוג שלכם משורת הפקודה — ללא התקנה.
- syncanix initגלו את ה-API שלכם, בנו את קטלוג היכולות והעלו אותו — עם העשרת AI הכפופה להסכמה.
- עוד פקודות CLIהתחברו, ייבאו סכמה, הריצו את הסביבה המקומית, אבחנו, רשמו שרת MCP חיצוני, והחילו שכבות קטלוג.
- קובצי תצורההקבצים שה-CLI קורא וכותב: כללי התעלמות, תצורת ה-CLI, הקטלוג, רשומת ההסכמה שלכם, פרטי ההזדהות, ושכבת הקטלוג.
- משתני סביבה וקודי יציאהמשתני הסביבה שה-CLI קורא וקודי היציאה שהוא מחזיר.
- תמיכת frameworksהשפות וה-frameworks שה-CLI של הגילוי יכול לקרוא אוטומטית — ומה לעשות כששלכם אינו אחד מהם.
מדריכים לפי פריימוורק
- Syncanix עם Expressהפכו API של Express למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם NestJSהפכו API של NestJS למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם Next.jsהפכו אפליקציית Next.js למוכנה לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם Fastifyהפכו API של Fastify למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם FastAPIהפכו שירות FastAPI למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם Djangoהפכו פרויקט Django למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם Railsהפכו API של Rails למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
- Syncanix עם Laravelהפכו API של Laravel למוכן לסוכנים: מה הגילוי קורא, איך מריצים אותו ואיך משחררים את ממשק הצ׳אט ושרת ה‑MCP.
לוח בקרה
- לוח הבקרההמקו ם שבו אתם מגדירים את סביבת העבודה שלכם — הקטלוג, האופי, הידע, העיצוב, הצוות והחיוב — במקום אחד.
- קטלוג ויכולותעיינו ביכולות שהתגלו ושפרו כל אחת — תיאורה, הרשאותיה, הסיכון שלה ועוד.
- ממשלשלטו בדיוק במה שהעוזר שלכם יכול לעשות ומי רשאי להשתמש בכל כלי: הפעלה ואישור של יכולות, זמינות לפי משתמש, והפעולות שהרכיב שלכם רושם בעמוד.
- נקודות קצה מותאמות וזמינות כליםהוסיפו יכולות שהעוזר יכול לקרוא להן מעבר לנתיבים שהתגלו, ושלטו לאילו משתמשים מוצע כל כלי.
- שרתי MCP חיצונייםרשמו שרתי MCP שאתם מארחים כדי ש-Syncanix יעביר אליהם קריאות כלים, ובאופן אופציונלי יפעל בתור משתמש הקצה המחובר.
- הנחיותהעניקו לעוזר קול, פרומפט מערכת והתנהגות סירוב ברורה — ואז כוונו פרופיל לגולשים שהוא מיועד להם, השיקו אותו בהדרגה ובדקו איך הוא הצליח.
- ידע ומסמכיםחברו מקורות תוכן כדי שהעוזר יוכל לענות מתוך התיעוד שלכם, וכווננו את מה שהוא מאחזר.
- עיצוב ואולפן עיצוב הרכיבעצבו את הרכיב שיתאים למותג שלכם — אסימוני ערכת נושא, רכיבים, ואולפן העיצוב לכל ארגון.
- כללי עמודגרמו לעוזר להתנהג אחרת בעמודים מסוימים באתר שלכם.
- Playgroundדברו עם העוזר שלכם כפי שהמשתמשים שלכם ידברו איתו — הרכיב האמיתי, העיצוב הפעיל שלכם, תשובות חיות — לפני שאתם מטמיעים אותו.
- יומני שיחות ושימושסקרו כיצד כל שיחה הסתיימה, קראו תמלילים בודדים, ובחנו את יומן השימוש והעלות לכל אירוע.
- ניטור, עלות וביקורתראו איך העוזר מתפקד, כמה הוא עולה, ורישום מלא של מה שקרה.
- יומן ביקורתרישום בהוספה בלבד וחסין חבלה של כל עריכת דריסה, קידום, צפייה בתמליל ופעולת מפתח API בסביבת העבודה שלכם.
- תיבת העברה לנציגהתור ש ל שיחות משתמשי קצה שהעוזר הסלים למפעיל אנושי.
- תקרות הוצאה, מגבלות קצב והתראותקבעו תקרות קשיחות להוצאה ולתעבורה, וקבלו התראה לפני שמכסת שימוש מתרוקנת.
- סביבות וקידוםהגדירו בבטחה בפיתוח, ואז קדמו לייצור מאחורי בדיקת הערכה.
- צוות ותפקידיםהזמינו את הצוות שלכם ותנו לכל אחד את רמת הגישה הנכונה בעזרת חמישה תפקידים ברורים.
- הגדרותמפתחות, מקורות, מפתחות מודל משלכם, פדרציית זהות, מגבלות, חיוב והנחות.
Widget
- הרכיבהטמיעו את רכיב הצ׳אט של Syncanix באפליקציה שלכם בעזרת תגית סקריפט אחת — מבודד, נטען בעצלתיים, ותואם למותג.
- הטמעה באפליקציה שלכםכל הדרכים להציב את הווידג׳ט של Syncanix באתר: תגית הסקריפט, אפליקציות עמוד יחיד, עיגון בתוך הדף, זהות ו-CSP.
- הטמעה באפליקציה ניידתהכניסו את סוכן Syncanix לאפליקציית React Native או Flutter על ידי טעינת רכיב הווב בתוך WebView — ללא צורך ב-SDK מקורי.
- תצורת הרכיבהגדירו את הרכיב באמצעות מאפייני data-* על תגית הסקריפט.
- API של זמן הריצה של הרכיבשלטו ברכיב מ-JavaScript דרך האובייקט window.syncanix.
- הרחבת הווידג׳טרשמו רכיבי React משלכם, פעולות עמוד ומקורות נתונים חיים כדי שהעוזר יציג את הממשק שלכם ויפעל בתוך האפליקציה.
- עיצוב הרכיבהרכיב תואם למותג שלכם אוטומטית, עם שליטה מלאה כשתרצו.
- CSS מותאם אישיתפתח המילוט: עצבו מחדש כל משטח של הווידג'ט עם CSS גולמי כשפקדי הטוקנים של הסטודיו אינם מספיקים.
- גדלים ומצביםהרכיב מגיע בחמישה גדלים ובשני מצבי פריסה — בחרו את המתאים לכל מקום שבו אתם משתמשים בו.
- חוויית הצ׳אטמה המשתמשים שלכם רואים בשיחה — תשובות בזרימה, הצעות, כרטיסי פעולה, גילויים ועוד.
- בניית חוויה מותאמת אישיתעד כמה תוכלו להתאים אישית את הצ'אט של Syncanix — מהטמעה מוטבעת ורכיבים משלכם ועד עיצוב מלא ו-API של זמן הריצה.
- נגישות ו-RTLהרכיב עומד ב-WCAG 2.1 AA ונפרס נכון בשפות מימין לשמאל.
שרת MCP
- שרת ה-MCPכל סביבת עבודה מקבלת שרת MCP משלה, כך שלקוחות AI כמו Claude Desktop, Cursor ו-ChatGPT יכולים להגיע ליכולות שלכם.
- חיבור לקוחחברו את Claude Desktop, Cursor, ChatGPT ולקוחות MCP אחרים לסביבת העבודה שלכם.
- איך התחברות MCP עובדתלקוחות MCP מתאמתים עם OAuth 2.1, מואצלים לספק הזהויות שלכם — Syncanix לעולם אינו מחזיק את פרטי ההזדהות של המשתמשים שלכם.
- כלים וביצועמה שרת ה-MCP חושף, כיצד כלים מסוכנים מסומנים, וכיצד קריאות באמת רצות.
- מגבלות ונקודות קצה של MCPמגבלות הסשן ונקודות הקצה של OAuth והתעבורה ששרת ה-MCP חושף.
אימות וגישה
- אימות וגישהאיך אנשים נכנסים ל‑Syncanix — הצוות שלך אל לוח הבקרה והמשתמשים שלך אל הצ׳אט — לצד המפתחות, ספקי הזהות ואמצעי ההגנה שמחברים ביניהם.
- כניסה ומרחבי עבודהאיך אתה והצוות שלך נכנסים אל לוח הבקרה של Syncanix, וכיצד מרחבי עבודה שומרים על הפרדה נקייה בין העבודה של כל חשבון.
- אימות המשתמשים שלךארבע הדרכים שבהן הווידג׳ט יכול לאמת את משתמשי הקצה שלך, וכיצד לבחור את זו שמתאימה למערך שלך.
- חיבור ספק זהותחבר את Auth0, Clerk, Amazon Cognito או WorkOS בלוח הבקרה כדי ש‑Syncanix יוכל לאמת את משתמשי הקצה שלך דרך הספק שכבר אתה משתמש בו.
- מפתחות APIצרו, חשפו ובטלו את שני סוגי המפתחות ש-Syncanix מנפיקה — מפתח ס ודי ל-CLI ול-SDK, ומפתח לפרסום עבור הווידג׳ט המוטמע.
- אימות מוגבר ובטיחות פעולותכיצד Syncanix מסווג כל פעולה כקריאה, כתיבה או הרסנית — ובקרות האישור, האימות החוזר והביטול שמגינות על כל אחת.
ערכות SDK
- ערכות SDKערכות ה-SDK בצד השרת שמאמתות כוונות סוכן של Syncanix בבק-אנד שלכם — אחת לכל שפה, בשמונה סביבות פיתוח.
- Pythonאמתו כוונות סוכן של Syncanix ב-Python — Django, Flask ו-FastAPI — עם בדיקת HMAC מקומית על כל קריאת כלי.
- Goאמתו כוונות סוכן של Syncanix ב-Go — net/http, Gin, Echo ו-Fiber — עם בדיקת HMAC מקומית על כל קריאת כלי.
- Spring Bootאמתו כוונות סוכן של Syncanix ב-Spring Boot עם אימות כוונות בהגדרה אוטומטית, באמצעות servlet filter.
- PHPאמתו כוונות סוכן של Syncanix ב-PHP — Laravel ו-Symfony — עם בדיקת HMAC מקומית על כל קריאת כלי.
- Rubyאמתו כוונות סוכן של Syncanix ב-Ruby — Rails וכל אפליקציית Rack — עם בדיקת HMAC מקומית על כל קריאת כלי.
- Rustאמתו כוונות סוכן של Syncanix ב-Rust — Axum, Actix Web ו-Tower — עם בדיקת HMAC מקומית על כל קריאת כלי.
- .NETאמתו כוונות סוכן של Syncanix ב-ASP.NET Core 8 ומעלה — Minimal API ו-MVC — עם בדיקת HMAC מקומית על כל קריאת כלי.
חיוב ותוכניות
- חיוב ותוכניותאיך Syncanix גובה תשלום: תוכניות לכל מרחב עבודה, מדידה לפי יחידות מחשוב (שימוש), מנויים, שימוש במפתח המודל שלך, והמגבלות ששומרות על צריכה צפויה.
- תוכניותחמש תוכניות Syncanix — Dev, Starter, Growth, Scale ו-Enterprise — בתוספת תקופות ניסיון, חיוב שנתי והנחות למלכ"רים, חינוך וקוד פתוח.
- שימוש ומדידהכיצד Syncanix מודד שימוש ביחידות מחשוב (CU), כיצד הן נספרות, מה קורה במגבלה, והיכן לעקוב.
- ניהול המנוי שלךהתחל, שנה או בטל תוכנית Syncanix, נהל את אמצעי התשלום שלך דרך פורטל החיוב של Paddle, ומצא את החשבוניות והקבלות שלך.
- הבא את המפתח שלך (BYOK)השתמש במפתח Anthropic או OpenAI משלך כך שהספק שלך מחייב על שימוש במודל ישירות ללא תוספת מחיר של Syncanix. המפתחות הם לכתיבה בלבד ומוצפנים במנוחה.
- מגבלות קצב ותקרות הוצאהמעקות הבטיחות ששומרים על שימוש צפוי ב-Syncanix: מגבלות קצב ברמת הפלטפורמה ששומרות על יציבות, ותקרות הוצאה שאתה מגדיר כדי להישאר בתקציב.
אמון, פרטיות וציות
- אמון, פרטיות וציותאיך Syncanix מגנה על הנתונים שלך ושל משתמשי הקצה שלך: מקום אחסון נתונים באיחוד האירופי, בידוד בין דיירים, מה אנו מעבדים ושומרים, זכויות הפרטיות שלך, תוכנית הציות שלנו ושקיפות הבינה המלאכותית.
- אבטחה בשפה פשוטהתשובה בשפה פשוטה ל"האם הנתונים שלי בטוחים עם Syncanix?" — היכן הם שוכנים, כיצד לקוחות מופרדים זה מזה, מי יכול לראותם, מה הבינה המלאכותית רואה, ומה בשליטתכם.
- מקום אחסון נתונים ואבטחהSyncanix פועלת כולה ב-AWS eu-central-1 (פרנקפורט), מבודדת את נתוני כל לקוח בארבע שכבות, ומצפינה נתונים במעבר ובמנוחה.
- טיפול בנתונים ושמירתםאילו נתונים Syncanix מעבדת, איך אי-שמירת נתונים (ZDR) עובדת עם ספקי המודלים, מה שולחת ה-CLI לגילוי, וכמה זמן נשמרים הנתונים.
- פרטיות והזכויות שלךאיך נשלטת זיכרון העוזר, איך מטופלים נתונים אישיים, וכיצד אתה ומשתמשי הקצה שלך יכולים לממש זכויות GDPR ו-CCPA דרך טופס בקשת הנתונים.
- ציות ומעבדי משנהתוכנית הציות של Syncanix: תמיכת GDPR ו-CCPA עם DPA זמין, SOC 2 ו-ISO 27001 בתהליך, ומעבדי המשנה שעליהם אנו נשענים.
- שקיפות בינה מלאכותיתאיך Syncanix חושפת את השימוש בבינה מלאכותית למשתמשי הקצה בכל שפה, אילו מודלים מפעילים את העוזר, וכיצד התשובות מבוססות על התוכן שלך.
מדריכים
- מדריכיםמדריכים מוכווני-משימה המשלבים את תיעוד העזר למשימות שלמות — השקת היישומון, חיבור לקוח בינה מלאכותית, ביסוס תשובות, פעולה עבור משתמש, ומעבר לייצור.
- הוסף את יישומון הצ׳אט לאתר שלךעבור מהקוד שלך ליישומון צ׳אט חי: גלה את ה-API שלך עם ה-CLI, סקור את הקטלוג, עצב את היישומון, והטמע את הקטע.
- חבר לקוח בינה מלאכותית למרחב העבודה שלךחבר את Claude Desktop, Cursor או ChatGPT לשרת ה-MCP שלך ב-Syncanix כדי שלקוח בינה מלאכותית יוכל להשתמש ב-API שלך בשמך.
- בסס תשובות על התוכן שלךהוסף את התיעוד והתוכן שלך כדי שהעוזר יענה מהחומר שלך במקום לנחש, ובדוק שזה עובד.
- עגנו את הסוכן בנתוני האנליטיקה שלכםהזינו את העוזר בהקשר מסע והתנהגות ממערך האנליטיקה שלכם דרך MCP — שום נתון אינו יוצא מה כלים שלכם.
- תן לעוזר לפעול עבור משתמש מחובראפשר לעוזר לבצע פעולות מאומתות בשם משתמש קצה מחובר, תחומות להרשאותיו, עם אישור לפני פעולות רגישות.
- שמרו על קטלוג עדכניהריצו מחדש את הגילוי כשה-API משתנה, חברו אותו ל-CI, ותנו לזיהוי הסחיפה בזמן ריצה לתפוס את מה שחמק.
- ייצוא ומחיקת נתוניםאיך עובדות בקשות נושאי מידע עם Syncanix — הגשת בקשות גישה, ייצוא ומחיקה, חלונות התגובה, ומי אחראי למה.
- כיצד אנו מודדים החזר על ההשקעהמתודולוגיית הפתרונות השקופה שמאחורי דוח ההחזר על ההשקעה שלך: מה נחשב לפתרון, וכיצד מחושב הערך.
- עבור לייצורהעבר את העוזר שלך מבדיקה לחי: עבור לסביבת הייצור, צור מפתחות ייצור, הגדר מקורות מותרים, בחר תוכנית, והפעל מעקות בטיחות.
- פתרון תקלותפתרונות לפי סימפטום לבעיות שאנחנו באמת רואים: ווידג׳ט חסום, בקשה ראשונה איטית, פספוסי זיהוי, כשלי העשרה ובעיות התחברות.
עיון
- עיוןמקור עיון מאוחד: עובדות מהירות, פורמטים של מפתחות ומזהים, מגבלות וברירות מחדל של הפלטפורמה, והפניות אל עיון ה-CLI, עיון MCP, תמיכת מסגרות והמילון.
- מפתחות, אסימונים ומזהיםמקור עיון מאוחד לפורמטים של אישורים ומזהים בשימוש ב-Syncanix: מפתחות API סודיים וניתנים-לפרסום, אסימוני חיבור MCP, וסביבות.
- מגבלות וברירות מחדלמקור עיון יחיד לעובדות חוצות-פלטפורמה: אזור הנתונים, שמירת יומנים, תגובות מגבלת קצב, יחידת המדידה, תקרות הוצאה והשפות הנתמכות.
- מדריך API בזמן ריצהחוזי זמן הריצה בצד הלקוח: כותרת הכוונה החתומה שהשרת שלכם מאמת, חוזה הפעולה-בשם-משתמש שהוא צופה בו, וצורת נתוני ה-witness.