מפרט API
מדריך לשילובים בתהליכי עבודה של טקסט, סוכנים, מדיה ואחזור.
https://cicora.ai/api/v1https://cicora.ai/apiמדריך שילוב: בחרו פרמטרים ויכולות זמינות בהגדרות ה-API של החשבון ובקטלוג המודלים של הסביבה שלכם.
שליחת בקשה ראשונההתחלה
שלחו בקשה ראשונה, בחרו מודל מהקטלוג ושמרו מזהה בקשה לצורך אבחון.
אימות זהותשלחו מפתח API בכותרת Bearer ושמרו פרטי גישה לייצור בנפרד מפרטי גישה לפיתוח.
ערכות SDK ולקוחות HTTPהשתמשו בכתובות בסיס שונות ללקוחות בסגנון OpenAI וללקוחות Messages: הם מכוונים לאותו מפרט אך מרכיבים נתיבים אחרת.
CLI ושילוביםהגדירו לקוח עם מפתח, מודל וכתובת בסיס התואמת לפרוטוקול שלו; שמרו את הסוד בסביבה.
שאלות נפוצות למפתחיםתשובות מעשיות קצרות על מפתחות, כתובות בסיס, מודלים, עלות ואבחון שילובים.
חשבון וקטלוג
בנו את בחירת המודל מנתוני הקטלוג במקום מרשימה קשיחה ביישום.
צוותים ומפתחות APIהפרידו מפתחות, בעלים, תקציבים ומעקבי שימוש בין יישומים וסביבות עבודה.
מגבלותהתייחסו למגבלות המפתח, הארגון, המודל והניתוב כחלק מתהליך המשתמש.
שימוש ועלותחברו בין מטא-נתוני התשובה ויומני הבקשות שלכם לבין פעולות משתמש אמיתיות.
נתונים ופרטיותמזערו נתונים משודרים, הפרידו מזהה משתמש קצה מהתוכן ושלטו בשמירה במוצר.
טקסט וסוכנים
צרו שיחות מרובות סבבים בתבנית messages המוכרת ובחרו מודל לכל בקשה.
Messages APIהשתמשו בתבנית Messages לשיחות עם הוראת מערכת ברמה העליונה ומגבלת פלט מפורשת.
Responses APIהשתמשו באובייקט קלט אחד כאשר היישום מרוויח מטיפול בפריטי פלט ובפעולות במודל נתונים יחיד.
הזרמהקבלו אסימונים ומקטעים מובנים דרך SSE בלי להמתין לתשובה המלאה.
כלים וקריאת פונקציותתארו פונקציות באמצעות JSON Schema, בצעו את הקריאה ביישום והחזירו את התוצאה לשיחה.
פלט מובנהבקשו אובייקט JSON או JSON Schema כאשר תוכנה, ולא אדם, תצרוך את התשובה.
הסקההגדירו מאמץ הסקה לכל בקשה רק במודלים שמצהירים על היכולת.
ניתובבטאו את דרישות הביצוע בהעדפות הספק ושמרו את התוצאה בפועל לצורכי נראות.
שמירת הקשר במטמוןהפרידו הקשר חוזר כדי שלקוח יוכל להשתמש במטמון תואם במקום שבו המודל שנבחר תומך בו.
חיפוש באינטרנטאחזרו מקורות עדכניים באמצעות פונקציית `web_search` שמבצע הלקוח, ושמרו קישורים בנפרד מטקסט שנוצר.
מדיה ואחזור
העלו קובץ בפעולה ייעודית, שמרו את המזהה שלו והעבירו הפניה בבקשה תואמת מאוחרת יותר.
תמונותצרו תמונות דרך נתיב אחד ובחרו פרמטרים מיכולות המודל שנבחר.
וידאוהתחילו וידאו כמשימה אסינכרונית, שמרו את מזהה המשימה והפרידו את היצירה מקריאת התוצאה.
שמעהשתמשו בפעולות נפרדות לסינתזת דיבור, לתמלול ולקלט שמע למודל.
הטמעותהמירו טקסט או קלט נתמך לווקטורים לצורך חיפוש, קיבוץ והמלצות.
דירוג מחדשסדרו מחדש קבוצה קטנה של מועמדים מול שאילתה כדי לשפר את דיוק האחזור הסופי.
ביצוע באצווהעבדו פעולות עצמאיות בקבוצות מבוקרות כאשר התהליך מאפשר מסירה אסינכרונית.