ResponseObject

Example Usage

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

let value: ResponseObject = {
  id: "resp_abc123",
  object: "response",
  createdAt: 1735689600,
  completedAt: 1735689601,
  status: "completed",
  error: null,
  incompleteDetails: null,
  background: false,
  instructions: null,
  maxOutputTokens: null,
  maxToolCalls: 30,
  metadata: {},
  model: "meetkai:functionary-urdu-mini-pak",
  output: [
    {
      role: "assistant",
      content: [
        {
          type: "output_text",
          text: "The capital of France is Paris.",
          annotations: [],
        },
      ],
      status: "completed",
      id: "msg_abc123",
    },
  ],
  outputText: "The capital of France is Paris.",
  parallelToolCalls: true,
  previousResponseId: null,
  reasoning: {
    effort: null,
    summary: null,
  },
  serviceTier: "auto",
  store: true,
  text: {
    format: {
      type: "text",
    },
  },
  toolChoice: "auto",
  tools: [],
  truncation: "auto",
  usage: {
    inputTokens: 8,
    inputTokensDetails: {
      cachedTokens: 0,
    },
    outputTokens: 7,
    outputTokensDetails: {
      reasoningTokens: 0,
    },
    totalTokens: 15,
  },
  user: null,
};

Fields

Field	Type	Required	Description
id	string	✔️	N/A
object	"response"	✔️	N/A
createdAt	number	✔️	N/A
completedAt	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
presencePenalty	number	➖	N/A
frequencyPenalty	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
contextManagement	components.CompactionContextManagement[]	➖	N/A
usage	components.Usage	✔️	N/A
user	string	✔️	N/A