@agentica/core/src/events/AgenticaResponseEvent.ts

Agentic AI Library specialized in LLM Function Calling

import type OpenAI from "openai";

import type { AgenticaEventBase } from "./AgenticaEventBase";
import type { AgenticaEventSource } from "./AgenticaEventSource";

export interface AgenticaResponseEvent extends AgenticaEventBase<"response"> {
  request_id: string;

  /**
   * The source agent of the response.
   */
  source: AgenticaEventSource;

  /**
   * Request body.
   */
  body: OpenAI.ChatCompletionCreateParamsStreaming;

  /**
   * The text content stream.
   */
  stream: AsyncGenerator<OpenAI.ChatCompletionChunk, undefined, undefined>;

  /**
   * Options for the request.
   */
  options?: OpenAI.RequestOptions | undefined;

  /**
   * Wait the completion.
   */
  join: () => Promise<OpenAI.ChatCompletion>;
}