העדפות פרטיות

תכונות חיוניות

נדרשות לאבטחה ולפעולות הבסיסיות של האתר.

פעילות תמיד

ניתוח שימוש אופציונלי

לאפשר ניתוח שימוש באמצעות PostHog? אפשר לשנות את הבחירה בכל עת בתחתית האתר.

לאפשר גם הקלטת הפעלות באתר הציבורי הזה

הקלטת ההפעלות מציגה עמודים ציבוריים ואינטראקציות, תוך הסתרת שדות קלט ותוכן פרטי. הקלטת הפעלות באפליקציה היא בחירה נפרדת.

נדרש ניתוח שימוש; שחזור האתר כבוי כברירת מחדל.

איך אנחנו משתמשים בנתונים

אישור ניתוח שימוש מאפשר ל-PostHog לשתף קובץ Cookie אנונימי בין האתר הזה לאפליקציה שלנו, עם אחסון מקומי בדפדפן בכל אחד מהאתרים. בהסכמתכם, ניתן לקשר ביקור מאומת באותה לשונית לחשבון החדש שלכם לאחר אישור ההרשמה.

הקלטת ההפעלות מציגה עמודים ציבוריים ואינטראקציות, תוך הסתרת שדות קלט ותוכן פרטי. הקלטת הפעלות באפליקציה היא בחירה נפרדת.

הקלטת הפעלות באתר כבויה כברירת מחדל. בטלו את הסימון ושמרו כדי להפסיק הקלטות חדשות; בחירה זו אינה משנה את הגדרות החשבון.

הודעת פרטיות ומדידה מצטברת נפרדת באמצעות Cloudflare.

ניתוח השימוש בדפדפן אינו מפעיל ניתוח שימוש בחשבון.

SosoAPI
התחילו בחינם
HE
EN繁中繁體中文（台灣）简体中文日本語한국어DeutschFrançaisEspañolPortuguês (Brasil)العربيةעבריתNederlandsहिन्दीBahasa IndonesiaNorsk bokmålSvenskaMagyar
התחילו בחינם

החיפוש נטען רק כשמשתמשים בו. עיינו בכל הקטגוריות שלהלן.

מחקר ותמציות עם אסמכתאות

ביטול שליפת מקור ציבורי

ביטול שליפה ממתינה לפי mutation_id, גם לפני שתהליך הקבלה מחזיר תשובה; לא ניתן לשמור תוכן מאוחר. נדרשת agent:research.

POST /research-api/evidence/cancel

החוזה נבדק: · sha256:ab393e91e9b7f18a

קריאה בפורמט Markdownהורדת החוזה הציבוריהורדת OpenAPI

סקירה

ביטול שליפה ממתינה לפי mutation_id, גם לפני שתהליך הקבלה מחזיר תשובה; לא ניתן לשמור תוכן מאוחר. נדרשת agent:research.

תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.

אימות והרשאות

סוגי אמצעי גישה מתקבלים
user_session, delegated_oauth, personal_access_token
יכולת מואצלת
agent:research
תפקיד מינימלי בסביבת העבודה
editor
היקף הגישה
משאבים שהמשתמש הזה מורשה לגשת אליהם
נדרשת הסכמה לכל סביבות העבודה
לא
משנה מצב
כן
מתי הפעולה הושלמה
committed cancellation fence; late reader output is discarded

אסימון יכול להשתמש רק בזכויות שיש לבעליו. כל בקשה בודקת חברות בסביבת העבודה, בעלות על משאבים, סביבות עבודה נבחרות ויכולות שהוענקו. הפרופילים core ו-full משנים אילו כלים מוצגים; הם אינם מעניקים גישה.

שדות הבקשה

שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.

שדות הבקשה
שדה / ענףסוג / חובהאילוצים
$objectחובה באובייקט האב
  • additionalProperties: false
workspace_idstringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
mutation_idstringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
JSON Schema מלא
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "mutation_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "workspace_id",
    "mutation_id"
  ],
  "additionalProperties": false
}

תגובה והשלמה

סטטוסי HTTP להצלחה: 200. מתי הפעולה הושלמה: committed cancellation fence; late reader output is discarded.

תגובת HTTP מוצלחת עשויה לציין שבקשה התקבלה, ולא שהושלמה. בעבודת רקע, שמרו את המזהה שהוחזר ובדקו את אותה פעולה עד שתסתיים. פוסט שתוזמן או התקבל נחשב שפורסם רק כשהפלטפורמה מאשרת זאת; חריגה מזמן ההמתנה אצל הלקוח אינה קובעת מה התוצאה.

שדה חובה נדרש בתוך אובייקט האב והענף הנבחר שלו. צאצא נדרש אינו הופך אב אופציונלי לנדרש. הכללים ושמות השדות שלהלן מועתקים מהחוזה.

תגובה והשלמה
שדה / ענףסוג / חובהאילוצים
$objectחובה באובייקט האב—
retrievalobjectחובה באובייקט האב—
retrieval.idstringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
retrieval.workspace_idstringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
retrieval.mutation_idstringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
retrieval.statestringחובה באובייקט האב
  • enum: ["pending","running","completed","cancelled","unconfirmed","expired"]
retrieval.kindstring | nullחובה באובייקט האב—
retrieval.kindanyOf 1stringחובה באובייקט האב
  • enum: ["url_text","published_captions"]
retrieval.kindanyOf 2nullחובה באובייקט האב—
retrieval.created_atstringחובה באובייקט האב
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
retrieval.settled_atstring | nullחובה באובייקט האב—
retrieval.settled_atanyOf 1stringחובה באובייקט האב
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
retrieval.settled_atanyOf 2nullחובה באובייקט האב—
retrieval.valid_untilstringחובה באובייקט האב
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
retrieval.resultobject | nullחובה באובייקט האב—
retrieval.resultanyOf 1objectחובה באובייקט האב—
retrieval.result.kindanyOf 1stringחובה באובייקט האב
  • enum: ["url_text","published_captions"]
retrieval.result.statusanyOf 1stringחובה באובייקט האב
  • enum: ["ready","partial","blocked","unsupported","empty","rate_limited","unavailable","cancelled"]
retrieval.result.textanyOf 1stringחובה באובייקט האב
  • maxLength: 20000
retrieval.result.titleanyOf 1string | nullחובה באובייקט האב—
retrieval.result.titleanyOf 1 / anyOf 1stringחובה באובייקט האב
  • minLength: 1
  • maxLength: 200
retrieval.result.titleanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.descriptionanyOf 1string | nullחובה באובייקט האב—
retrieval.result.descriptionanyOf 1 / anyOf 1stringחובה באובייקט האב
  • minLength: 1
  • maxLength: 2000
retrieval.result.descriptionanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.segmentsanyOf 1arrayחובה באובייקט האב
  • maxItems: 1000
retrieval.result.segments[]anyOf 1objectרשות / פריט—
retrieval.result.segments[].start_msanyOf 1integerחובה באובייקט האב
  • minimum: 0
  • maximum: 9007199254740991
retrieval.result.segments[].end_msanyOf 1integerחובה באובייקט האב
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
retrieval.result.segments[].textanyOf 1stringחובה באובייקט האב
  • minLength: 1
  • maxLength: 20000
retrieval.result.provenanceanyOf 1objectחובה באובייקט האב—
retrieval.result.provenance.source_urlanyOf 1string | nullחובה באובייקט האב—
retrieval.result.provenance.source_urlanyOf 1 / anyOf 1stringחובה באובייקט האב
  • format: "uri"
  • maxLength: 2048
retrieval.result.provenance.source_urlanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.provenance.retrieved_atanyOf 1stringחובה באובייקט האב
  • format: "date-time"
  • pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
retrieval.result.provenance.mime_typeanyOf 1string | nullחובה באובייקט האב—
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 1stringחובה באובייקט האב
  • enum: ["text/html","application/xhtml+xml","text/plain","text/vtt","application/x-subrip","application/srt","text/srt"]
retrieval.result.provenance.mime_typeanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.provenance.parser_versionanyOf 1stringחובה באובייקט האב
  • const: "research-public-retrieval/v1"
retrieval.result.provenance.content_kindanyOf 1stringחובה באובייקט האב
  • enum: ["document_text","metadata_only","published_caption_file","none"]
retrieval.result.provenance.caption_formatanyOf 1string | nullחובה באובייקט האב—
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 1stringחובה באובייקט האב
  • enum: ["webvtt","subrip"]
retrieval.result.provenance.caption_formatanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.provenance.languageanyOf 1string | nullחובה באובייקט האב—
retrieval.result.provenance.languageanyOf 1 / anyOf 1stringחובה באובייקט האב
  • minLength: 1
  • maxLength: 35
  • pattern: "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
retrieval.result.provenance.languageanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.provenance.language_sourceanyOf 1stringחובה באובייקט האב
  • enum: ["publisher_declared","unknown"]
retrieval.result.provenance.platform_native_verifiedanyOf 1booleanחובה באובייקט האב
  • const: false
retrieval.result.reasonanyOf 1string | nullחובה באובייקט האב—
retrieval.result.reasonanyOf 1 / anyOf 1stringחובה באובייקט האב
  • enum: ["unsafe_url","unsupported_source","unsupported_media","unsupported_content","access_denied","login_required","no_text","metadata_only","no_captions","invalid_captions","not_found","rate_limited","response_too_large","text_limited","nodes_limited","cues_limited","invalid_cues","language_mismatch","source_partial","timeout","cancelled","egress_unavailable","unavailable"]
retrieval.result.reasonanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.result.warningsanyOf 1arrayחובה באובייקט האב
  • maxItems: 10
retrieval.result.warnings[]anyOf 1stringרשות / פריט
  • enum: ["unsafe_url","unsupported_source","unsupported_media","unsupported_content","access_denied","login_required","no_text","metadata_only","no_captions","invalid_captions","not_found","rate_limited","response_too_large","text_limited","nodes_limited","cues_limited","invalid_cues","language_mismatch","source_partial","timeout","cancelled","egress_unavailable","unavailable"]
retrieval.result.retry_after_secondsanyOf 1integer | nullחובה באובייקט האב—
retrieval.result.retry_after_secondsanyOf 1 / anyOf 1integerחובה באובייקט האב
  • minimum: 1
  • maximum: 86400
retrieval.result.retry_after_secondsanyOf 1 / anyOf 2nullחובה באובייקט האב—
retrieval.resultanyOf 2nullחובה באובייקט האב—
retrieval.evidenceobject | nullחובה באובייקט האב—
retrieval.evidenceanyOf 1objectחובה באובייקט האב—
retrieval.evidence.evidence_idanyOf 1stringחובה באובייקט האב
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
retrieval.evidence.revisionanyOf 1integerחובה באובייקט האב
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
retrieval.evidenceanyOf 2nullחובה באובייקט האב—
JSON Schema מלא
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "retrieval": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "workspace_id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "mutation_id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "state": {
          "type": "string",
          "enum": [
            "pending",
            "running",
            "completed",
            "cancelled",
            "unconfirmed",
            "expired"
          ]
        },
        "kind": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "url_text",
                "published_captions"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "created_at": {
          "type": "string",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
          "format": "date-time"
        },
        "settled_at": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
              "format": "date-time"
            },
            {
              "type": "null"
            }
          ]
        },
        "valid_until": {
          "type": "string",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
          "format": "date-time"
        },
        "result": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "url_text",
                    "published_captions"
                  ]
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "ready",
                    "partial",
                    "blocked",
                    "unsupported",
                    "empty",
                    "rate_limited",
                    "unavailable",
                    "cancelled"
                  ]
                },
                "text": {
                  "type": "string",
                  "maxLength": 20000
                },
                "title": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "description": {
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "segments": {
                  "maxItems": 1000,
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "start_ms": {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      "end_ms": {
                        "type": "integer",
                        "exclusiveMinimum": 0,
                        "maximum": 9007199254740991
                      },
                      "text": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 20000
                      }
                    },
                    "required": [
                      "start_ms",
                      "end_ms",
                      "text"
                    ]
                  }
                },
                "provenance": {
                  "type": "object",
                  "properties": {
                    "source_url": {
                      "anyOf": [
                        {
                          "type": "string",
                          "maxLength": 2048,
                          "format": "uri"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "retrieved_at": {
                      "type": "string",
                      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
                      "format": "date-time"
                    },
                    "mime_type": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "text/html",
                            "application/xhtml+xml",
                            "text/plain",
                            "text/vtt",
                            "application/x-subrip",
                            "application/srt",
                            "text/srt"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "parser_version": {
                      "type": "string",
                      "const": "research-public-retrieval/v1"
                    },
                    "content_kind": {
                      "type": "string",
                      "enum": [
                        "document_text",
                        "metadata_only",
                        "published_caption_file",
                        "none"
                      ]
                    },
                    "caption_format": {
                      "anyOf": [
                        {
                          "type": "string",
                          "enum": [
                            "webvtt",
                            "subrip"
                          ]
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language": {
                      "anyOf": [
                        {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 35,
                          "pattern": "^[a-zA-Z]{2,8}(?:-[a-zA-Z0-9]{1,8})*$"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "language_source": {
                      "type": "string",
                      "enum": [
                        "publisher_declared",
                        "unknown"
                      ]
                    },
                    "platform_native_verified": {
                      "type": "boolean",
                      "const": false
                    }
                  },
                  "required": [
                    "source_url",
                    "retrieved_at",
                    "mime_type",
                    "parser_version",
                    "content_kind",
                    "caption_format",
                    "language",
                    "language_source",
                    "platform_native_verified"
                  ]
                },
                "reason": {
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "unsafe_url",
                        "unsupported_source",
                        "unsupported_media",
                        "unsupported_content",
                        "access_denied",
                        "login_required",
                        "no_text",
                        "metadata_only",
                        "no_captions",
                        "invalid_captions",
                        "not_found",
                        "rate_limited",
                        "response_too_large",
                        "text_limited",
                        "nodes_limited",
                        "cues_limited",
                        "invalid_cues",
                        "language_mismatch",
                        "source_partial",
                        "timeout",
                        "cancelled",
                        "egress_unavailable",
                        "unavailable"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "warnings": {
                  "maxItems": 10,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "enum": [
                      "unsafe_url",
                      "unsupported_source",
                      "unsupported_media",
                      "unsupported_content",
                      "access_denied",
                      "login_required",
                      "no_text",
                      "metadata_only",
                      "no_captions",
                      "invalid_captions",
                      "not_found",
                      "rate_limited",
                      "response_too_large",
                      "text_limited",
                      "nodes_limited",
                      "cues_limited",
                      "invalid_cues",
                      "language_mismatch",
                      "source_partial",
                      "timeout",
                      "cancelled",
                      "egress_unavailable",
                      "unavailable"
                    ]
                  }
                },
                "retry_after_seconds": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 86400
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "required": [
                "kind",
                "status",
                "text",
                "title",
                "description",
                "segments",
                "provenance",
                "reason",
                "warnings",
                "retry_after_seconds"
              ]
            },
            {
              "type": "null"
            }
          ]
        },
        "evidence": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "evidence_id": {
                  "type": "string",
                  "format": "uuid",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
                },
                "revision": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                }
              },
              "required": [
                "evidence_id",
                "revision"
              ]
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "id",
        "workspace_id",
        "mutation_id",
        "state",
        "kind",
        "created_at",
        "settled_at",
        "valid_until",
        "result",
        "evidence"
      ]
    }
  },
  "required": [
    "retrieval"
  ]
}

שגיאות וניסיונות חוזרים בטוחים

בדקו את סטטוס ה-HTTP ואת גוף התגובה. שגיאת אימות 400 עשויה להכיל ZodError; שגיאות מטפל משתמשות בשדות error, ‏message ו-code. שמרו request_id או x-request-id לאבחון, ללא אמצעי גישה. תקנו שגיאות גישה 401/403 לפני ניסיון חוזר, ופעלו לפי Retry-After עבור 429. אם תוצאת כתיבה אינה ודאית או שמוחזר 5xx, קראו תחילה את התוצאה הקיימת. השתמשו שוב במפתח אידמפוטנטיות רק במקומות הנתמכים; התנהגות הניסיון החוזר משתנה בין פעולות ואינה מבטיחה מסירה בדיוק פעם אחת.

מדריך לפתרון בעיות

דוגמאות

הדוגמאות משתמשות בערכים בדויים שנבדקו מול הסכמות. החליפו את המזהים בכאלה שאתם מורשים להשתמש בהם, את המדיה בנכסים מוכנים ואת התאריכים במועד הפרסום שאישרתם. בדקו את התאמת החשבון לפני שליחת כתיבה. העמוד הזה אינו שולח בקשות API.

הגדירו בשרת שלכם SOSOAPI_ACCESS_TOKEN לאמצעי גישה שהפעולה הזו מקבלת, והשאירו אותו מחוץ לקוד הדפדפן. עבור סוכן AI, השתמשו ב-sosoapi auth login כדי להיכנס דרך הדפדפן ולאפשר ל-CLI לרענן את אמצעי הגישה שלו.

request.json

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "mutation_id": "40000000-0000-4000-8000-000000000001"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/evidence/cancel" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/research-api/evidence/cancel", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "mutation_id": "40000000-0000-4000-8000-000000000001"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

CLI

npx sosoapi api post /research-api/evidence/cancel < request.json

דוגמת תגובה סינתטית

{
  "retrieval": {
    "id": "30000000-0000-4000-8000-000000000007",
    "workspace_id": "11111111-1111-4111-8111-111111111111",
    "mutation_id": "40000000-0000-4000-8000-000000000001",
    "state": "cancelled",
    "kind": "url_text",
    "created_at": "2099-01-15T09:00:00Z",
    "settled_at": "2099-01-15T09:00:01Z",
    "valid_until": "2099-01-16T09:00:00Z",
    "evidence": null,
    "result": null
  }
}

MCP: sosoapi_research_evidence_cancel

כל פעולות ה-APIאימות והרשאות