StreamEventResponseCompleted

type StreamEventResponseCompleted = object;

Event returned by the model when a response is completed.

Type declaration

providerData?

optional providerData: Record<string, any>;

response

response: object;

response.id

id: string;

response.output

output: (
  | {
  content: (
     | {
     providerData?: Record<string, any>;
     refusal: string;
     type: "refusal";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "output_text";
   }
     | {
     providerData?: Record<string, any>;
     text: string;
     type: "input_text";
   }
     | {
     audio:   | string
        | {
        id: string;
      };
     format?: null | string;
     providerData?: Record<string, any>;
     transcript?: null | string;
     type: "audio";
   }
     | {
     image: string;
     providerData?: Record<string, any>;
     type: "image";
  })[];
  id?: string;
  providerData?: Record<string, any>;
  role: "assistant";
  status: "in_progress" | "completed" | "incomplete";
  type?: "message";
}
  | {
  arguments?: string;
  id?: string;
  name: string;
  output?: string;
  providerData?: Record<string, any>;
  status?: string;
  type: "hosted_tool_call";
}
  | {
  arguments: string;
  callId: string;
  id?: string;
  name: string;
  providerData?: Record<string, any>;
  status?: "in_progress" | "completed" | "incomplete";
  type: "function_call";
}
  | {
  action:   | {
     type: "screenshot";
   }
     | {
     button: "left" | "right" | "wheel" | "back" | "forward";
     type: "click";
     x: number;
     y: number;
   }
     | {
     type: "double_click";
     x: number;
     y: number;
   }
     | {
     scroll_x: number;
     scroll_y: number;
     type: "scroll";
     x: number;
     y: number;
   }
     | {
     text: string;
     type: "type";
   }
     | {
     type: "wait";
   }
     | {
     type: "move";
     x: number;
     y: number;
   }
     | {
     keys: string[];
     type: "keypress";
   }
     | {
     path: object[];
     type: "drag";
   };
  callId: string;
  id?: string;
  providerData?: Record<string, any>;
  status: "in_progress" | "completed" | "incomplete";
  type: "computer_call";
}
  | {
  content: object[];
  id?: string;
  providerData?: Record<string, any>;
  type: "reasoning";
}
  | {
  id?: string;
  providerData?: Record<string, any>;
  type: "unknown";
})[];

response.providerData?

optional providerData: Record<string, any>;

response.usage

usage: object;

response.usage.inputTokens

inputTokens: number;

response.usage.inputTokensDetails?

optional inputTokensDetails: Record<string, number>;

response.usage.outputTokens

outputTokens: number;

response.usage.outputTokensDetails?

optional outputTokensDetails: Record<string, number>;

response.usage.requests?

optional requests: number;

response.usage.totalTokens

totalTokens: number;

type

type: "response_done";