الانتقال إلى المحتوى الرئيسي
لم تُحدَّث ترجمة هذه الصفحة بعد، والنسخة الإنجليزية هي الأحدث والأصح، وقد يختلف المحتوى أدناه عنها. اقرأ النسخة الإنجليزية.
الأحداث التي يطلقها agent.stream()، وترتيبها، وطريقة ترقيم إصداراتها. إذا أردت معرفة كيفية استهلاك الـ stream، فراجع Streaming.

Event schema (version 1)

يحتوي كل event على الحقول التالية: أنواع الـ events وحقولها الإضافية: تُحذف الحقول الاختيارية إذا لم تكن لها قيمة. ولا تكون أبدًا undefined، أي أن JSON.parse(JSON.stringify(event)) يُرجع object يساوي الأصل.

ضمانات الترتيب

  • يأتي run.start أولًا ويأتي run.done أخيرًا، وكلٌّ منهما مرة واحدة بالضبط.
  • يتبع كل step.start حدث step.done واحد بالضبط بالقيمة نفسها لـ step، قبل step.start التالي. وكل ما تفعله الـ step يحدث بينهما. لكن ليس كل event يقع داخل step: agent.drift، وguardrail.tripped الخاص بـ input guardrail، وevents الـ call المحسوم في streamed approval continuation (أدناه)، كلها تأتي قبل أول step.start أو بين اثنين منها، ويذهب context.cleared إلى session.on() لا إلى run.
  • داخل الـ step: compaction.start / compaction.done (إذا ضُغط الطلب، قبل استدعاء الـ model)، ثم events provider.retry / provider.fallback (إذا فشل استدعاء الـ model)، ثم text.delta، ثم text.done، ثم events الأدوات.
  • تعمل الـ tool calls للـ step الواحدة بالتوازي (راجع toolConcurrency): تأتي events الـ tool.start بترتيب استدعاءات الـ model، وtool.done / tool.error بترتيب الاكتمال. طابقها باستخدام toolCallId.
  • تبدأ الـ calls الداخلية لاستدعاء run_code (code mode) وتنتهي بين tool.start وtool.done / tool.error الخاصين به.
  • تأتي events الـ tool.partial للـ call بين tool.start وtool.done / tool.error الخاصين به، مع index = 0، 1، 2، …؛ وتتداخل الـ partials الخاصة بالـ calls المتوازية. والـ call الذي يتوقف بانتظار sign-in أو approval ليس له tool.done؛ ويعمل من جديد من البداية عندما يُحسم، ويصدر باسم tool.resume (وليس tool.start آخر) ويبدأ index من 0.
  • يأتي input.queued عندما تستدعي run.enqueue() (بعد run.start، حتى لو دخل الـ input الـ queue قبل انطلاق الـ run)، لذا قد يقع داخل step. ويأتي input.applied بين step.done للـ step التي كانت جارية وstep.start التالي — الذي يحمل قيمة step نفسها التي ذكرها الـ event.
  • يأتي input.steered عندما تستدعي run.steer(). ومع mode: 'immediate' تنتهي الـ step الجارية مباشرة بـ step.done ('steered'، بلا text events من الاستدعاء الملغى)، ثم input.applied ثم step.start التالي.
  • عندما يحتاج call إلى approval، تعمل الـ calls التي قبله وتُبلغ عن نتائجها، ثم يأتي approval.requested وstep.done ('awaiting-approval') وrun.done ('awaiting-approval'). ولا تبدأ الـ calls التي بعده أبدًا. والـ run الذي يكمل كـ stream (agent.approvals.streamResolve() / streamAnswer()، راجع stream بعد approval) هو stream جديد: يُبلغ عن run.start خاص به، ثم agent.drift إذا تغيّر الـ agent، ثم tool.resume وtool.done للـ call المحسوم (tool.error عند الرفض) قبل أول step.start — لذا يرى من يتابع الـ streamين tool.start لهذا الـ call مرة واحدة فقط، في الـ run الذي توقف.
  • عندما يمنع guardrail، يأتي guardrail.tripped قبل النهاية مباشرة: للـ input guardrail يأتي بعد run.start مباشرة (ولا تبدأ أي step)؛ وللـ output أو tool guardrail يأتي داخل الـ step، ويتبعه step.done وrun.done ('guardrail'). والـ output الممنوع ليس له text.done؛ والـ calls التي تلي tool call ممنوعًا لا تبدأ أبدًا.
run يحتوي على نص فقط:
run يحتوي على tool call واحد:

TypeScript

AgentEvent هو discriminated union: طبّق narrowing على event.type فتحصل على الـ payload. وكل event type مُصدَّر أيضًا (TextDeltaEvent وToolDoneEvent وRunDoneEvent …)، ويختار AgentEventOf<'tool.done'> واحدًا منها بالاسم.

Versioning

لا يتغيّر v إلا إذا تغيّر event موجود بشكل يكسر التوافق (حُذف حقل أو تغيّر اسمه أو نوعه). وقد تُضاف event types جديدة وحقول اختيارية جديدة بدون تغيير v، لذا تجاهل أي event type لا تعرفه.