תיעוד Syncanix
כל מה שדרוש כדי לגלות את ה-API שלכם, להטמיע את רכיב הצ׳אט, לחבר לקוח MCP ולהשיק עוזר AI שמבצע פעולות אמיתיות עבור המשתמשים שלכם — מתארח באיחוד האירופי, בשש שפות.
מבוא
- מה זה Syncanix?Syncanix הופך את ה-API הקיים שלכם לעוזר AI שהמשתמשים שלכם יכולים לשוחח איתו — מוטמע באפליקציה שלכם וזמין ללקוחות AI דרך MCP.
- איך Syncanix עובדמפקודת גילוי אחת ועד עוזר פעיל: כיצד קטלוג היכולות מחבר בין ה-CLI, הרכיב, משטח הצ׳אט ושרת ה-MCP.
- סקירת הארכיטקטורהכיצד Syncanix מחבר בין המשתמשים שלכם, ה-API שלכם וה-AI — והיכן הכול פועל.
- שפות ו-RTLSyncanix עובד בשש שפות באופן מובנֶה, עם תמיכה מלאה מימין לשמאל לערבית ולעברית.
- מילון מונחיםמונחי מפתח שבשימוש בתיעוד של Syncanix.
תחילת העבודה
מושגי יסוד
- קטלוג היכולותהרשימה המובְנית של מה שה-API שלכם יכול לעשות — מתגלה פעם אחת, נכתבת על ידיכם, ונקראת בכל המשטחים.
- הדפדפן הוא השערמודל האבטחה של Syncanix ברעיון אחד: ה-AI לעולם אינו מחזיק את פרטי ההזדהות של המשתמשים שלכם.
- זהות ואימות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.
לוח בקרה
- לוח הבקרההמקום שבו אתם מגדירים את סביבת העבודה שלכם — הקטלוג, האופי, הידע, העיצוב, הצוות והחיוב — במקום אחד.
- קטלוג ויכולותעיינו ביכולות שהתגלו ושפרו כל אחת — תיאורה, הרשאותיה, הסיכון שלה ועוד.
- נקודות קצה מותאמות וזמינות כליםהוסיפו יכולות שהעוזר יכול לקרוא להן מעבר לנתיבים שהתגלו, ושלטו לאילו משתמשים מוצע כל כלי.
- הנחיות ואופיתנו לעוזר קול, הנחיית מערכת, והתנהגות ברורה של נסיגה וסירוב.
- ידע ומסמכיםחברו מקורות תוכן כדי שהעוזר יוכל לענות מתוך התיעוד שלכם, וכווננו את מה שהוא מאחזר.
- עיצוב ואולפן עיצוב הרכיבעצבו את הרכיב שיתאים למותג שלכם — אסימוני ערכת נושא, רכיבים, ואולפן העיצוב לכל ארגון.
- ניטור, עלות וביקורתראו איך העוזר מתפקד, כמה הוא עולה, ורישום מלא של מה שקרה.
- סביבות וקידוםהגדירו בבטחה בפיתוח, ואז קדמו לייצור מאחורי בדיקת הערכה.
- צוות ותפקידיםהזמינו את הצוות שלכם ותנו לכ ל אחד את רמת הגישה הנכונה בעזרת חמישה תפקידים ברורים.
- הגדרותמפתחות, מקורות, מפתחות מודל משלכם, פדרציית זהות, מגבלות, חיוב והנחות.
Widget
- הרכיבהטמיעו את רכיב הצ׳אט של Syncanix באפליקציה שלכם בעזרת תגית סקריפט אחת — מבודד, נטען בעצלתיים, ותואם למותג.
- תצורת הרכיבהגדירו את הרכיב באמצעות מאפייני data-* על תגית הסקריפט.
- API של זמן הריצה של הרכיבשלטו ברכיב מ-JavaScript דרך האובייקט window.syncanix.
- עיצוב הרכיבהרכיב תואם למותג שלכם אוטומטית, עם שליטה מלאה כשתרצו.
- גדלים ומצביםהרכיב מגיע בחמישה גדלים ובשני מצבי פריסה — בחרו את המתאים לכל מקום שבו אתם משתמשים בו.
- חוויית הצ׳אטמה המשתמשים שלכם רואים בשיחה — תשובות בזרימה, הצעות, כרטיסי פעולה, גילויים ועוד.
- ה-SDK ללא ממשקבנו ממשק צ׳אט מותאם לחלוטין מעל Syncanix, בלי להרכיב את הרכיב.
- נגישות ו-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 ול‑MCP, ומפתח לפרסום עבור הווידג׳ט המוטמע.
- אימות מוגבר ובטיחות פעולותכיצד Syncanix מסווג כל פעולה כקריאה, כתיבה או הרסנית — ובקרות האישור, האימות החוזר והביטול שמגינות על כל אחת.
חיוב ותוכניות
- חיוב ותוכניותאיך Syncanix גובה תשלום: תוכניות לכל מרחב עבודה, מדידה לפי משתמשי קצה, מנויים, שימוש במפתח המודל שלך, והמגבלות ששומרות על צריכה צפויה.
- תוכניותחמש תוכניות Syncanix — Dev, Starter, Growth, Scale ו-Enterprise — בתוספת תקופות ניסיון, חיוב שנתי והנחות למלכ"רים, חינוך וקוד פתוח.
- שימוש ומדידהאיך Syncanix מודדת שימוש עם משתמשי קצה פעילים חודשיים (MAEU), איך הספירה עובדת, מה קורה במגבלה שלך, והיכן לעקוב אחריה.
- ניהול המנוי שלךהתחל, שנה או בטל תוכנית Syncanix, נהל את אמצעי התשלום שלך דרך פורטל החיוב של Paddle, ומצא את החשבוניות והקבלות שלך.
- הבא את המפתח שלך (BYOK)השתמש במפתח Anthropic או OpenAI משלך כך שהספק שלך מחייב על שימוש במודל ישירות ללא תוספת מחיר של 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 שלך בשמך.
- בסס תשובות על התוכן שלךהוסף את התיעוד והתוכן שלך כדי שהעוזר יענה מהחומר שלך במקום לנחש, ובדוק שזה עובד.
- תן לעוזר לפעול עבור משתמש מחובראפשר לעוזר לבצע פעולות מאומתות בשם משתמש קצה מחובר, תחומות להרשאותיו, עם אישור לפני פעולות רגישות.
- שמרו על קטלוג עדכניהריצו מחדש את הגילוי כשה-API משתנה, חברו אותו ל-CI, ותנו לזיהוי הסחיפה בזמן ריצה לתפוס את מה שחמק.
- ייצוא ומחיקת נתוניםאיך עובדות בקשות נושאי מידע עם Syncanix — הגשת בקשות גישה, ייצוא ומחיקה, חלונות התגובה, ומי אחראי למה.
- עבור לייצורהעבר את העוזר שלך מבדיקה לחי: עבור לסביבת הייצור, צור מפתחות ייצור, הגדר מקורות מותרים, בחר תוכנית, והפעל מעקות בטיחות.
- פתרון תקלותפתרונות לפי סימפטום לבעיות שאנחנו באמת רואים: ווידג׳ט חסום, בקשה ראשונה איטית, פספוסי זיהוי, כשלי העשרה ובעיות התחברות.
עיון
- עיוןמקור עיון מאוחד: עובדות מהירות, פורמטים של מפתחות ומזהים, מגבלות וברירות מחדל של הפלטפורמה, והפניות אל עיון ה-CLI, עיון MCP, תמיכת מסגרות והמילון.
- מפתחות, אסימונים ומזהיםמקור עיון מאוחד לפורמטים של אישורים ומזהים בשימוש ב-Syncanix: מפתחות API סודיים וניתנים-לפרסום, אסימוני חיבור MCP, וסביבות.
- מגבלות וברירות מחדלמקור עיון יחיד לעובדות חוצות-פלטפורמה: אזור הנתונים, שמירת יומנים, תגובות מגבלת קצב, יחידת המדידה, תקרות הוצאה והשפות הנתמכות.
- מדריך API בזמן ריצהחוזי זמן הריצה בצד הלקוח: כותרת הכוונה החתומה שהשרת שלכם מאמת, חוזה הפעולה-בשם-משתמש שהוא צופה בו, וצורת נתוני ה-witness.