ResponseObject

Example Usage

import { ResponseObject } from "@meetkai/mka1/models/components";

let value: ResponseObject = {
  id: "<id>",
  object: "response",
  createdAt: 6080.39,
  status: "completed",
  error: {
    code: "<value>",
    message: "<value>",
  },
  incompleteDetails: {
    reason: "<value>",
  },
  background: true,
  instructions: null,
  maxOutputTokens: null,
  maxToolCalls: 846401,
  metadata: {},
  model: "Aventador",
  output: [],
  parallelToolCalls: true,
  previousResponseId: "<id>",
  store: false,
  text: {
    format: {
      type: "text",
    },
  },
  toolChoice: {
    type: "web_search_preview",
  },
  tools: [
    {
      type: "history",
    },
  ],
  truncation: "auto",
  usage: {
    inputTokens: 233607,
    inputTokensDetails: {
      cachedTokens: 705997,
    },
    outputTokens: 998649,
    outputTokensDetails: {
      reasoningTokens: 945279,
    },
    totalTokens: 705508,
  },
  user: "Mavis_White68",
};

Fields

Field	Type	Required	Description
id	string	✔️	N/A
object	"response"	✔️	N/A
createdAt	number	✔️	N/A
status	components.ResponseStatus	✔️	The overall status of the response generation. 'completed' means successfully finished, 'failed' means error occurred, 'in_progress' means currently processing, 'cancelled' means user-cancelled, 'queued' means waiting to start, 'incomplete' means partial completion.
error	components.ErrorT	✔️	N/A
incompleteDetails	components.IncompleteDetails	✔️	N/A
background	boolean	✔️	N/A
conversation	components.Conversation	➖	N/A
instructions	components.Instructions	✔️	N/A
maxOutputTokens	number	✔️	N/A
maxToolCalls	number	✔️	N/A
metadata	Record<string, string>	✔️	N/A
model	string	✔️	N/A
output	components.Item[]	✔️	N/A
outputText	string	➖	N/A
parallelToolCalls	boolean	✔️	N/A
previousResponseId	string	✔️	N/A
prompt	components.PromptTemplate	➖	N/A
promptCacheKey	string	➖	N/A
reasoning	components.ReasoningConfiguration	➖	N/A
safetyIdentifier	string	➖	N/A
serviceTier	components.ResponseObjectServiceTier	➖	N/A
store	boolean	✔️	N/A
temperature	number	➖	N/A
text	components.TextConfiguration	✔️	N/A
toolChoice	components.ToolChoice	✔️	N/A
tools	components.ResponseObjectTools[]	✔️	N/A
topLogprobs	number	➖	N/A
topP	number	➖	N/A
truncation	components.ResponseObjectTruncation	✔️	N/A
usage	components.Usage	✔️	N/A
user	string	✔️	N/A