tekimax-ts 0.1.0

package/src/gen/schemas/responseFailedStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.failed"],"description":"The type of the event, always `response.failed`.","default":"response.failed"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"response":{"allOf":[{"properties":{"id":{"type":"string","description":"The unique ID of the response that was created."},"object":{"type":"string","enum":["response"],"description":"The object type, which was always `response`.","default":"response"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was created."},"completed_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was completed, if it was completed."},{"type":"null"}]},"status":{"type":"string","description":"The status that was set for the response."},"incomplete_details":{"anyOf":[{"allOf":[{"properties":{"reason":{"type":"string","description":"The reason the response could not be completed."}},"type":"object","required":["reason"],"title":"Incomplete details","description":"Details about why the response was incomplete.","x-readme-ref-name":"IncompleteDetails"},{"description":"Details about why the response was incomplete, if applicable."}]},{"type":"null"}]},"model":{"type":"string","description":"The model that generated this response."},"previous_response_id":{"anyOf":[{"type":"string","description":"The ID of the previous response in the chain that was referenced, if any."},{"type":"null"}]},"instructions":{"anyOf":[{"oneOf":[{"type":"string"}],"description":"Additional instructions that were used to guide the model for this response."},{"type":"null"}]},"output":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"},"type":"array","description":"The output items that were generated by the model."},"error":{"anyOf":[{"allOf":[{"properties":{"code":{"type":"string","description":"A machine-readable error code that was returned."},"message":{"type":"string","description":"A human-readable description of the error that was returned."}},"type":"object","required":["code","message"],"title":"Error","description":"An error that occurred while generating the response.","x-readme-ref-name":"Error"},{"description":"The error that occurred, if the response failed."}]},{"type":"null"}]},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function"},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function."},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]}},"type":"object","required":["type","name","description","parameters","strict"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).","x-readme-ref-name":"FunctionTool"}],"description":"A tool that can be used to generate a response.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Tool"},"type":"array","description":"The tools that were available to the model during response generation."},"tool_choice":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"},{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"},{"properties":{"type":{"type":"string","enum":["allowed_tools"],"default":"allowed_tools"},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"}]},"type":"array"},"mode":{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"}},"type":"object","required":["type","tools","mode"],"x-readme-ref-name":"AllowedToolChoice"}]},"truncation":{"allOf":[{"type":"string","enum":["auto","disabled"],"x-enumDescriptions":{"auto":"Let the service decide how to truncate.","disabled":"Disable service truncation. Context over the model's context limit will result in a 400 error."},"x-readme-ref-name":"TruncationEnum"},{"description":"How the input was truncated by the service when it exceeded the model context window."}]},"parallel_tool_calls":{"type":"boolean","description":"Whether the model was allowed to call multiple tools in parallel."},"text":{"allOf":[{"properties":{"format":{"oneOf":[{"properties":{"type":{"type":"string","enum":["text"],"default":"text"}},"type":"object","required":["type"],"x-readme-ref-name":"TextResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_object"],"default":"json_object"}},"type":"object","required":["type"],"x-readme-ref-name":"JsonObjectResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_schema"],"default":"json_schema"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"schema":{"anyOf":[{"type":"null"}]},"strict":{"type":"boolean"}},"type":"object","required":["type","name","description","schema","strict"],"x-readme-ref-name":"JsonSchemaResponseFormat"}]},"verbosity":{"type":"string","enum":["low","medium","high"],"x-enumDescriptions":{"high":"Instruct the model to emit more verbose final responses.","low":"Instruct the model to emit less verbose final responses.","medium":"Use the model's default verbosity setting."},"x-readme-ref-name":"VerbosityEnum"}},"type":"object","required":["format"],"x-readme-ref-name":"TextField"},{"description":"Configuration options for text output that were used."}]},"top_p":{"type":"number","description":"The nucleus sampling parameter that was used for this response."},"presence_penalty":{"type":"number","description":"The presence penalty that was used to penalize new tokens based on whether they appear in the text so far."},"frequency_penalty":{"type":"number","description":"The frequency penalty that was used to penalize new tokens based on their frequency in the text so far."},"top_logprobs":{"type":"integer","description":"The number of most likely tokens that were returned at each position, along with their log probabilities."},"temperature":{"type":"number","description":"The sampling temperature that was used for this response."},"reasoning":{"anyOf":[{"allOf":[{"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"The reasoning effort that was requested for the model, if specified."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"A model-generated summary of its reasoning that was produced, if available."}]},{"type":"null"}]}},"type":"object","required":["effort","summary"],"title":"Reasoning","description":"Reasoning configuration and metadata that were used for the response.","x-readme-ref-name":"Reasoning"},{"description":"Reasoning configuration and outputs that were produced for this response."}]},{"type":"null"}]},"usage":{"anyOf":[{"allOf":[{"properties":{"input_tokens":{"type":"integer","description":"The number of input tokens that were used to generate the response."},"output_tokens":{"type":"integer","description":"The number of output tokens that were generated by the model."},"total_tokens":{"type":"integer","description":"The total number of tokens that were used."},"input_tokens_details":{"allOf":[{"properties":{"cached_tokens":{"type":"integer","description":"The number of input tokens that were served from cache."}},"type":"object","required":["cached_tokens"],"title":"Input tokens details","description":"A breakdown of input token usage that was recorded.","x-readme-ref-name":"InputTokensDetails"},{"description":"A breakdown of input token usage that was recorded."}]},"output_tokens_details":{"allOf":[{"properties":{"reasoning_tokens":{"type":"integer","description":"The number of output tokens that were attributed to reasoning."}},"type":"object","required":["reasoning_tokens"],"title":"Output tokens details","description":"A breakdown of output token usage that was recorded.","x-readme-ref-name":"OutputTokensDetails"},{"description":"A breakdown of output token usage that was recorded."}]}},"type":"object","required":["input_tokens","output_tokens","total_tokens","input_tokens_details","output_tokens_details"],"title":"Usage","description":"Token usage statistics that were recorded for the response.","x-readme-ref-name":"Usage"},{"description":"Token usage statistics that were recorded for the response, if available."}]},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"type":"integer","description":"The maximum number of tokens the model was allowed to generate for this response."},{"type":"null"}]},"max_tool_calls":{"anyOf":[{"type":"integer","description":"The maximum number of tool calls the model was allowed to make while generating the response."},{"type":"null"}]},"store":{"type":"boolean","description":"Whether this response was stored so it can be retrieved later."},"background":{"type":"boolean","description":"Whether this request was run in the background."},"service_tier":{"type":"string","description":"The service tier that was used for this response."},"metadata":{"description":"Developer-defined metadata that was associated with the response."},"safety_identifier":{"anyOf":[{"type":"string","description":"A stable identifier that was used for safety monitoring and abuse detection."},{"type":"null"}]},"prompt_cache_key":{"anyOf":[{"type":"string","description":"A key that was used to read from or write to the prompt cache."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","completed_at","status","incomplete_details","model","previous_response_id","instructions","output","error","tools","tool_choice","truncation","parallel_tool_calls","text","top_p","presence_penalty","frequency_penalty","top_logprobs","temperature","reasoning","usage","max_output_tokens","max_tool_calls","store","background","service_tier","metadata","safety_identifier","prompt_cache_key"],"title":"The response object","description":"The complete response object that was returned by the Responses API.","example":{"id":"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41","object":"response","created_at":1741476777,"status":"completed","completed_at":1741476778,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41","status":"completed","role":"assistant","content":[{"type":"output_text","text":"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.","annotations":[]}]}],"parallel_tool_calls":true,"reasoning":{},"store":true,"background":false,"temperature":1,"presence_penalty":0,"frequency_penalty":0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1,"truncation":"disabled","usage":{"input_tokens":328,"input_tokens_details":{"cached_tokens":0},"output_tokens":52,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":380},"metadata":{}},"x-readme-ref-name":"ResponseResource"},{"description":"The response snapshot that was emitted with the event."}]}},"type":"object","required":["type","sequence_number","response"],"title":"Response failed event","description":"A streaming event that indicated the response had failed.","x-readme-ref-name":"ResponseFailedStreamingEvent"}

package/src/gen/schemas/responseFunctionCallArgumentsDeltaStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.function_call_arguments.delta"],"description":"The type of the event, always `response.function_call_arguments.delta`.","default":"response.function_call_arguments.delta"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"item_id":{"type":"string","description":"The ID of the tool call item that was updated."},"output_index":{"type":"integer","description":"The index of the output item that was updated."},"delta":{"type":"string","description":"The arguments delta that was appended."},"obfuscation":{"type":"string","description":"An obfuscation string that was added to pad the event payload."}},"type":"object","required":["type","sequence_number","item_id","output_index","delta"],"title":"Response function call arguments delta event","description":"A streaming event that indicated function call arguments were incrementally added.","x-readme-ref-name":"ResponseFunctionCallArgumentsDeltaStreamingEvent"}

package/src/gen/schemas/responseFunctionCallArgumentsDoneStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.function_call_arguments.done"],"description":"The type of the event, always `response.function_call_arguments.done`.","default":"response.function_call_arguments.done"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"item_id":{"type":"string","description":"The ID of the tool call item that was updated."},"output_index":{"type":"integer","description":"The index of the output item that was updated."},"arguments":{"type":"string","description":"The final arguments string that was emitted."}},"type":"object","required":["type","sequence_number","item_id","output_index","arguments"],"title":"Response function call arguments done event","description":"A streaming event that indicated function call arguments were completed.","x-readme-ref-name":"ResponseFunctionCallArgumentsDoneStreamingEvent"}

package/src/gen/schemas/responseInProgressStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.in_progress"],"description":"The type of the event, always `response.in_progress`.","default":"response.in_progress"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"response":{"allOf":[{"properties":{"id":{"type":"string","description":"The unique ID of the response that was created."},"object":{"type":"string","enum":["response"],"description":"The object type, which was always `response`.","default":"response"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was created."},"completed_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was completed, if it was completed."},{"type":"null"}]},"status":{"type":"string","description":"The status that was set for the response."},"incomplete_details":{"anyOf":[{"allOf":[{"properties":{"reason":{"type":"string","description":"The reason the response could not be completed."}},"type":"object","required":["reason"],"title":"Incomplete details","description":"Details about why the response was incomplete.","x-readme-ref-name":"IncompleteDetails"},{"description":"Details about why the response was incomplete, if applicable."}]},{"type":"null"}]},"model":{"type":"string","description":"The model that generated this response."},"previous_response_id":{"anyOf":[{"type":"string","description":"The ID of the previous response in the chain that was referenced, if any."},{"type":"null"}]},"instructions":{"anyOf":[{"oneOf":[{"type":"string"}],"description":"Additional instructions that were used to guide the model for this response."},{"type":"null"}]},"output":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"},"type":"array","description":"The output items that were generated by the model."},"error":{"anyOf":[{"allOf":[{"properties":{"code":{"type":"string","description":"A machine-readable error code that was returned."},"message":{"type":"string","description":"A human-readable description of the error that was returned."}},"type":"object","required":["code","message"],"title":"Error","description":"An error that occurred while generating the response.","x-readme-ref-name":"Error"},{"description":"The error that occurred, if the response failed."}]},{"type":"null"}]},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function"},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function."},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]}},"type":"object","required":["type","name","description","parameters","strict"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).","x-readme-ref-name":"FunctionTool"}],"description":"A tool that can be used to generate a response.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Tool"},"type":"array","description":"The tools that were available to the model during response generation."},"tool_choice":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"},{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"},{"properties":{"type":{"type":"string","enum":["allowed_tools"],"default":"allowed_tools"},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"}]},"type":"array"},"mode":{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"}},"type":"object","required":["type","tools","mode"],"x-readme-ref-name":"AllowedToolChoice"}]},"truncation":{"allOf":[{"type":"string","enum":["auto","disabled"],"x-enumDescriptions":{"auto":"Let the service decide how to truncate.","disabled":"Disable service truncation. Context over the model's context limit will result in a 400 error."},"x-readme-ref-name":"TruncationEnum"},{"description":"How the input was truncated by the service when it exceeded the model context window."}]},"parallel_tool_calls":{"type":"boolean","description":"Whether the model was allowed to call multiple tools in parallel."},"text":{"allOf":[{"properties":{"format":{"oneOf":[{"properties":{"type":{"type":"string","enum":["text"],"default":"text"}},"type":"object","required":["type"],"x-readme-ref-name":"TextResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_object"],"default":"json_object"}},"type":"object","required":["type"],"x-readme-ref-name":"JsonObjectResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_schema"],"default":"json_schema"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"schema":{"anyOf":[{"type":"null"}]},"strict":{"type":"boolean"}},"type":"object","required":["type","name","description","schema","strict"],"x-readme-ref-name":"JsonSchemaResponseFormat"}]},"verbosity":{"type":"string","enum":["low","medium","high"],"x-enumDescriptions":{"high":"Instruct the model to emit more verbose final responses.","low":"Instruct the model to emit less verbose final responses.","medium":"Use the model's default verbosity setting."},"x-readme-ref-name":"VerbosityEnum"}},"type":"object","required":["format"],"x-readme-ref-name":"TextField"},{"description":"Configuration options for text output that were used."}]},"top_p":{"type":"number","description":"The nucleus sampling parameter that was used for this response."},"presence_penalty":{"type":"number","description":"The presence penalty that was used to penalize new tokens based on whether they appear in the text so far."},"frequency_penalty":{"type":"number","description":"The frequency penalty that was used to penalize new tokens based on their frequency in the text so far."},"top_logprobs":{"type":"integer","description":"The number of most likely tokens that were returned at each position, along with their log probabilities."},"temperature":{"type":"number","description":"The sampling temperature that was used for this response."},"reasoning":{"anyOf":[{"allOf":[{"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"The reasoning effort that was requested for the model, if specified."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"A model-generated summary of its reasoning that was produced, if available."}]},{"type":"null"}]}},"type":"object","required":["effort","summary"],"title":"Reasoning","description":"Reasoning configuration and metadata that were used for the response.","x-readme-ref-name":"Reasoning"},{"description":"Reasoning configuration and outputs that were produced for this response."}]},{"type":"null"}]},"usage":{"anyOf":[{"allOf":[{"properties":{"input_tokens":{"type":"integer","description":"The number of input tokens that were used to generate the response."},"output_tokens":{"type":"integer","description":"The number of output tokens that were generated by the model."},"total_tokens":{"type":"integer","description":"The total number of tokens that were used."},"input_tokens_details":{"allOf":[{"properties":{"cached_tokens":{"type":"integer","description":"The number of input tokens that were served from cache."}},"type":"object","required":["cached_tokens"],"title":"Input tokens details","description":"A breakdown of input token usage that was recorded.","x-readme-ref-name":"InputTokensDetails"},{"description":"A breakdown of input token usage that was recorded."}]},"output_tokens_details":{"allOf":[{"properties":{"reasoning_tokens":{"type":"integer","description":"The number of output tokens that were attributed to reasoning."}},"type":"object","required":["reasoning_tokens"],"title":"Output tokens details","description":"A breakdown of output token usage that was recorded.","x-readme-ref-name":"OutputTokensDetails"},{"description":"A breakdown of output token usage that was recorded."}]}},"type":"object","required":["input_tokens","output_tokens","total_tokens","input_tokens_details","output_tokens_details"],"title":"Usage","description":"Token usage statistics that were recorded for the response.","x-readme-ref-name":"Usage"},{"description":"Token usage statistics that were recorded for the response, if available."}]},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"type":"integer","description":"The maximum number of tokens the model was allowed to generate for this response."},{"type":"null"}]},"max_tool_calls":{"anyOf":[{"type":"integer","description":"The maximum number of tool calls the model was allowed to make while generating the response."},{"type":"null"}]},"store":{"type":"boolean","description":"Whether this response was stored so it can be retrieved later."},"background":{"type":"boolean","description":"Whether this request was run in the background."},"service_tier":{"type":"string","description":"The service tier that was used for this response."},"metadata":{"description":"Developer-defined metadata that was associated with the response."},"safety_identifier":{"anyOf":[{"type":"string","description":"A stable identifier that was used for safety monitoring and abuse detection."},{"type":"null"}]},"prompt_cache_key":{"anyOf":[{"type":"string","description":"A key that was used to read from or write to the prompt cache."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","completed_at","status","incomplete_details","model","previous_response_id","instructions","output","error","tools","tool_choice","truncation","parallel_tool_calls","text","top_p","presence_penalty","frequency_penalty","top_logprobs","temperature","reasoning","usage","max_output_tokens","max_tool_calls","store","background","service_tier","metadata","safety_identifier","prompt_cache_key"],"title":"The response object","description":"The complete response object that was returned by the Responses API.","example":{"id":"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41","object":"response","created_at":1741476777,"status":"completed","completed_at":1741476778,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41","status":"completed","role":"assistant","content":[{"type":"output_text","text":"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.","annotations":[]}]}],"parallel_tool_calls":true,"reasoning":{},"store":true,"background":false,"temperature":1,"presence_penalty":0,"frequency_penalty":0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1,"truncation":"disabled","usage":{"input_tokens":328,"input_tokens_details":{"cached_tokens":0},"output_tokens":52,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":380},"metadata":{}},"x-readme-ref-name":"ResponseResource"},{"description":"The response snapshot that was emitted with the event."}]}},"type":"object","required":["type","sequence_number","response"],"title":"Response in progress event","description":"A streaming event that indicated the response was in progress.","x-readme-ref-name":"ResponseInProgressStreamingEvent"}

package/src/gen/schemas/responseIncompleteStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.incomplete"],"description":"The type of the event, always `response.incomplete`.","default":"response.incomplete"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"response":{"allOf":[{"properties":{"id":{"type":"string","description":"The unique ID of the response that was created."},"object":{"type":"string","enum":["response"],"description":"The object type, which was always `response`.","default":"response"},"created_at":{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was created."},"completed_at":{"anyOf":[{"type":"integer","description":"The Unix timestamp (in seconds) for when the response was completed, if it was completed."},{"type":"null"}]},"status":{"type":"string","description":"The status that was set for the response."},"incomplete_details":{"anyOf":[{"allOf":[{"properties":{"reason":{"type":"string","description":"The reason the response could not be completed."}},"type":"object","required":["reason"],"title":"Incomplete details","description":"Details about why the response was incomplete.","x-readme-ref-name":"IncompleteDetails"},{"description":"Details about why the response was incomplete, if applicable."}]},{"type":"null"}]},"model":{"type":"string","description":"The model that generated this response."},"previous_response_id":{"anyOf":[{"type":"string","description":"The ID of the previous response in the chain that was referenced, if any."},{"type":"null"}]},"instructions":{"anyOf":[{"oneOf":[{"type":"string"}],"description":"Additional instructions that were used to guide the model for this response."},{"type":"null"}]},"output":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"},"type":"array","description":"The output items that were generated by the model."},"error":{"anyOf":[{"allOf":[{"properties":{"code":{"type":"string","description":"A machine-readable error code that was returned."},"message":{"type":"string","description":"A human-readable description of the error that was returned."}},"type":"object","required":["code","message"],"title":"Error","description":"An error that occurred while generating the response.","x-readme-ref-name":"Error"},{"description":"The error that occurred, if the response failed."}]},{"type":"null"}]},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"description":"The type of the function tool. Always `function`.","default":"function"},"name":{"type":"string","description":"The name of the function to call."},"description":{"anyOf":[{"type":"string","description":"A description of the function. Used by the model to determine whether or not to call the function."},{"type":"null"}]},"parameters":{"anyOf":[{"additionalProperties":{},"type":"object","description":"A JSON schema object describing the parameters of the function."},{"type":"null"}]},"strict":{"anyOf":[{"type":"boolean","description":"Whether to enforce strict parameter validation. Default `true`."},{"type":"null"}]}},"type":"object","required":["type","name","description","parameters","strict"],"title":"Function","description":"Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling).","x-readme-ref-name":"FunctionTool"}],"description":"A tool that can be used to generate a response.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Tool"},"type":"array","description":"The tools that were available to the model during response generation."},"tool_choice":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"},{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"},{"properties":{"type":{"type":"string","enum":["allowed_tools"],"default":"allowed_tools"},"tools":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["function"],"default":"function"},"name":{"type":"string"}},"type":"object","required":["type"],"x-readme-ref-name":"FunctionToolChoice"}]},"type":"array"},"mode":{"type":"string","enum":["none","auto","required"],"x-enumDescriptions":{"auto":"Let the model choose the tools from among the provided set.","none":"Restrict the model from calling any tools.","required":"Require the model to call a tool."},"x-readme-ref-name":"ToolChoiceValueEnum"}},"type":"object","required":["type","tools","mode"],"x-readme-ref-name":"AllowedToolChoice"}]},"truncation":{"allOf":[{"type":"string","enum":["auto","disabled"],"x-enumDescriptions":{"auto":"Let the service decide how to truncate.","disabled":"Disable service truncation. Context over the model's context limit will result in a 400 error."},"x-readme-ref-name":"TruncationEnum"},{"description":"How the input was truncated by the service when it exceeded the model context window."}]},"parallel_tool_calls":{"type":"boolean","description":"Whether the model was allowed to call multiple tools in parallel."},"text":{"allOf":[{"properties":{"format":{"oneOf":[{"properties":{"type":{"type":"string","enum":["text"],"default":"text"}},"type":"object","required":["type"],"x-readme-ref-name":"TextResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_object"],"default":"json_object"}},"type":"object","required":["type"],"x-readme-ref-name":"JsonObjectResponseFormat"},{"properties":{"type":{"type":"string","enum":["json_schema"],"default":"json_schema"},"name":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"schema":{"anyOf":[{"type":"null"}]},"strict":{"type":"boolean"}},"type":"object","required":["type","name","description","schema","strict"],"x-readme-ref-name":"JsonSchemaResponseFormat"}]},"verbosity":{"type":"string","enum":["low","medium","high"],"x-enumDescriptions":{"high":"Instruct the model to emit more verbose final responses.","low":"Instruct the model to emit less verbose final responses.","medium":"Use the model's default verbosity setting."},"x-readme-ref-name":"VerbosityEnum"}},"type":"object","required":["format"],"x-readme-ref-name":"TextField"},{"description":"Configuration options for text output that were used."}]},"top_p":{"type":"number","description":"The nucleus sampling parameter that was used for this response."},"presence_penalty":{"type":"number","description":"The presence penalty that was used to penalize new tokens based on whether they appear in the text so far."},"frequency_penalty":{"type":"number","description":"The frequency penalty that was used to penalize new tokens based on their frequency in the text so far."},"top_logprobs":{"type":"integer","description":"The number of most likely tokens that were returned at each position, along with their log probabilities."},"temperature":{"type":"number","description":"The sampling temperature that was used for this response."},"reasoning":{"anyOf":[{"allOf":[{"properties":{"effort":{"anyOf":[{"oneOf":[{"type":"string","enum":["none","low","medium","high","xhigh"],"x-enumDescriptions":{"high":"Use a higher reasoning effort to improve answer quality.","medium":"Use a balanced reasoning effort.","low":"Use a lower reasoning effort for faster responses.","minimal":"Use the lowest non-zero reasoning effort.","none":"Restrict the model from performing any reasoning before emitting a final answer.","xhigh":"Use the maximum reasoning effort available."},"x-readme-ref-name":"ReasoningEffortEnum"}],"description":"The reasoning effort that was requested for the model, if specified."},{"type":"null"}]},"summary":{"anyOf":[{"allOf":[{"type":"string","enum":["concise","detailed","auto"],"x-enumDescriptions":{"auto":"Allow the model to decide when to summarize.","concise":"Emit concise summaries of reasoning content.","detailed":"Emit details summaries of reasoning content."},"x-readme-ref-name":"ReasoningSummaryEnum"},{"description":"A model-generated summary of its reasoning that was produced, if available."}]},{"type":"null"}]}},"type":"object","required":["effort","summary"],"title":"Reasoning","description":"Reasoning configuration and metadata that were used for the response.","x-readme-ref-name":"Reasoning"},{"description":"Reasoning configuration and outputs that were produced for this response."}]},{"type":"null"}]},"usage":{"anyOf":[{"allOf":[{"properties":{"input_tokens":{"type":"integer","description":"The number of input tokens that were used to generate the response."},"output_tokens":{"type":"integer","description":"The number of output tokens that were generated by the model."},"total_tokens":{"type":"integer","description":"The total number of tokens that were used."},"input_tokens_details":{"allOf":[{"properties":{"cached_tokens":{"type":"integer","description":"The number of input tokens that were served from cache."}},"type":"object","required":["cached_tokens"],"title":"Input tokens details","description":"A breakdown of input token usage that was recorded.","x-readme-ref-name":"InputTokensDetails"},{"description":"A breakdown of input token usage that was recorded."}]},"output_tokens_details":{"allOf":[{"properties":{"reasoning_tokens":{"type":"integer","description":"The number of output tokens that were attributed to reasoning."}},"type":"object","required":["reasoning_tokens"],"title":"Output tokens details","description":"A breakdown of output token usage that was recorded.","x-readme-ref-name":"OutputTokensDetails"},{"description":"A breakdown of output token usage that was recorded."}]}},"type":"object","required":["input_tokens","output_tokens","total_tokens","input_tokens_details","output_tokens_details"],"title":"Usage","description":"Token usage statistics that were recorded for the response.","x-readme-ref-name":"Usage"},{"description":"Token usage statistics that were recorded for the response, if available."}]},{"type":"null"}]},"max_output_tokens":{"anyOf":[{"type":"integer","description":"The maximum number of tokens the model was allowed to generate for this response."},{"type":"null"}]},"max_tool_calls":{"anyOf":[{"type":"integer","description":"The maximum number of tool calls the model was allowed to make while generating the response."},{"type":"null"}]},"store":{"type":"boolean","description":"Whether this response was stored so it can be retrieved later."},"background":{"type":"boolean","description":"Whether this request was run in the background."},"service_tier":{"type":"string","description":"The service tier that was used for this response."},"metadata":{"description":"Developer-defined metadata that was associated with the response."},"safety_identifier":{"anyOf":[{"type":"string","description":"A stable identifier that was used for safety monitoring and abuse detection."},{"type":"null"}]},"prompt_cache_key":{"anyOf":[{"type":"string","description":"A key that was used to read from or write to the prompt cache."},{"type":"null"}]}},"type":"object","required":["id","object","created_at","completed_at","status","incomplete_details","model","previous_response_id","instructions","output","error","tools","tool_choice","truncation","parallel_tool_calls","text","top_p","presence_penalty","frequency_penalty","top_logprobs","temperature","reasoning","usage","max_output_tokens","max_tool_calls","store","background","service_tier","metadata","safety_identifier","prompt_cache_key"],"title":"The response object","description":"The complete response object that was returned by the Responses API.","example":{"id":"resp_67ccd3a9da748190baa7f1570fe91ac604becb25c45c1d41","object":"response","created_at":1741476777,"status":"completed","completed_at":1741476778,"model":"gpt-4o-2024-08-06","output":[{"type":"message","id":"msg_67ccd3acc8d48190a77525dc6de64b4104becb25c45c1d41","status":"completed","role":"assistant","content":[{"type":"output_text","text":"The image depicts a scenic landscape with a wooden boardwalk or pathway leading through lush, green grass under a blue sky with some clouds. The setting suggests a peaceful natural area, possibly a park or nature reserve. There are trees and shrubs in the background.","annotations":[]}]}],"parallel_tool_calls":true,"reasoning":{},"store":true,"background":false,"temperature":1,"presence_penalty":0,"frequency_penalty":0,"text":{"format":{"type":"text"}},"tool_choice":"auto","tools":[],"top_p":1,"truncation":"disabled","usage":{"input_tokens":328,"input_tokens_details":{"cached_tokens":0},"output_tokens":52,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":380},"metadata":{}},"x-readme-ref-name":"ResponseResource"},{"description":"The response snapshot that was emitted with the event."}]}},"type":"object","required":["type","sequence_number","response"],"title":"Response incomplete event","description":"A streaming event that indicated the response was incomplete.","x-readme-ref-name":"ResponseIncompleteStreamingEvent"}

package/src/gen/schemas/responseOutputItemAddedStreamingEvent.json

@@ -0,0 +1 @@
+{"properties":{"type":{"type":"string","enum":["response.output_item.added"],"description":"The type of the event, always `response.output_item.added`.","default":"response.output_item.added"},"sequence_number":{"type":"integer","description":"The sequence number of the event that was emitted."},"output_index":{"type":"integer","description":"The index of the output item that was added."},"item":{"anyOf":[{"allOf":[{"oneOf":[{"properties":{"type":{"type":"string","enum":["message"],"description":"The type of the message. Always set to `message`.","default":"message"},"id":{"type":"string","description":"The unique ID of the message."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"MessageStatus"},{"description":"The status of item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]},"role":{"allOf":[{"type":"string","enum":["user","assistant","system","developer"],"x-enumDescriptions":{"assistant":"Model-generated content in the conversation.","developer":"Developer-supplied guidance that shapes the assistant’s behavior.","system":"System-level instructions that set global behavior.","user":"End‑user input in the conversation."},"x-readme-ref-name":"MessageRole"},{"description":"The role of the message. One of `unknown`, `user`, `assistant`, `system`, `critic`, `discriminator`, `developer`, or `tool`."}]},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"},{"type":"object","description":"A content block representing a video input to the model.","properties":{"type":{"type":"string","enum":["input_video"],"description":"The type of the input content. Always `input_video`."},"video_url":{"type":"string","description":"A base64 or remote url that resolves to a video file."}},"required":["type","video_url"],"x-readme-ref-name":"InputVideoContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The content of the message"}},"type":"object","required":["type","id","status","role","content"],"title":"Message","description":"A message to or from the model.","x-readme-ref-name":"Message"},{"properties":{"type":{"type":"string","enum":["function_call"],"description":"The type of the item. Always `function_call`.","default":"function_call"},"id":{"type":"string","description":"The unique ID of the function call item."},"call_id":{"type":"string","description":"The unique ID of the function tool call that was generated."},"name":{"type":"string","description":"The name of the function that was called."},"arguments":{"type":"string","description":"The arguments JSON string that was generated."},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"x-enumDescriptions":{"completed":"Model has finished sampling this item.","in_progress":"Model is currently sampling this item.","incomplete":"Model was interrupted from sampling this item partway through. This can occur, for example, if the model encounters a stop token or exhausts its output_token budget."},"x-readme-ref-name":"FunctionCallStatus"},{"description":"The status of the function call item that was recorded."}]}},"type":"object","required":["type","id","call_id","name","arguments","status"],"title":"Function call","description":"A function tool call that was generated by the model.","x-readme-ref-name":"FunctionCall"},{"properties":{"type":{"type":"string","enum":["function_call_output"],"description":"The type of the function tool call output. Always `function_call_output`.","default":"function_call_output"},"id":{"type":"string","description":"The unique ID of the function tool call output. Populated when this item is returned via API."},"call_id":{"type":"string","description":"The unique ID of the function tool call generated by the model."},"output":{"oneOf":[{"type":"string","description":"A JSON string of the output of the function tool call."},{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"An array of output contents (images, files, text) for the function tool call."}]},"status":{"allOf":[{"type":"string","enum":["in_progress","completed","incomplete"],"description":"Similar to `FunctionCallStatus`. All three options are allowed here for compatibility, but because in practice these items will be provided by developers, only `completed` should be used.","x-readme-ref-name":"FunctionCallOutputStatusEnum"},{"description":"The status of the item. One of `in_progress`, `completed`, or `incomplete`. Populated when items are returned via API."}]}},"type":"object","required":["type","id","call_id","output","status"],"title":"Function call output","description":"A function tool call output that was returned by the tool.","x-readme-ref-name":"FunctionCallOutput"},{"properties":{"type":{"type":"string","enum":["reasoning"],"description":"The type of the item. Always `reasoning`.","default":"reasoning"},"id":{"type":"string","description":"The unique ID of the reasoning item."},"content":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning content that was generated."},"summary":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["input_text"],"description":"The type of the input item. Always `input_text`.","default":"input_text"},"text":{"type":"string","description":"The text input to the model."}},"type":"object","required":["type","text"],"title":"Input text","description":"A text input to the model.","x-readme-ref-name":"InputTextContent"},{"properties":{"type":{"type":"string","enum":["output_text"],"description":"The type of the output text. Always `output_text`.","default":"output_text"},"text":{"type":"string","description":"The text output from the model."},"annotations":{"items":{"oneOf":[{"properties":{"type":{"type":"string","enum":["url_citation"],"description":"The type of the URL citation. Always `url_citation`.","default":"url_citation"},"url":{"type":"string","description":"The URL of the web resource."},"start_index":{"type":"integer","description":"The index of the first character of the URL citation in the message."},"end_index":{"type":"integer","description":"The index of the last character of the URL citation in the message."},"title":{"type":"string","description":"The title of the web resource."}},"type":"object","required":["type","url","start_index","end_index","title"],"title":"URL citation","description":"A citation for a web resource used to generate a model response.","x-readme-ref-name":"UrlCitationBody"}],"description":"An annotation that applies to a span of output text.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"Annotation"},"type":"array","description":"The annotations of the text output."},"logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"},"top_logprobs":{"items":{"properties":{"token":{"type":"string"},"logprob":{"type":"number"},"bytes":{"items":{"type":"integer"},"type":"array"}},"type":"object","required":["token","logprob","bytes"],"title":"Top log probability","description":"The top log probability of a token.","x-readme-ref-name":"TopLogProb"},"type":"array"}},"type":"object","required":["token","logprob","bytes","top_logprobs"],"title":"Log probability","description":"The log probability of a token.","x-readme-ref-name":"LogProb"},"type":"array"}},"type":"object","required":["type","text","annotations","logprobs"],"title":"Output text","description":"A text output from the model.","x-readme-ref-name":"OutputTextContent"},{"properties":{"type":{"type":"string","enum":["text"],"default":"text"},"text":{"type":"string"}},"type":"object","required":["type","text"],"title":"Text Content","description":"A text content.","x-readme-ref-name":"TextContent"},{"properties":{"type":{"type":"string","enum":["summary_text"],"description":"The type of the object. Always `summary_text`.","default":"summary_text"},"text":{"type":"string","description":"A summary of the reasoning output from the model so far."}},"type":"object","required":["type","text"],"title":"Summary text","description":"A summary text from the model.","x-readme-ref-name":"SummaryTextContent"},{"properties":{"type":{"type":"string","enum":["reasoning_text"],"description":"The type of the reasoning text. Always `reasoning_text`.","default":"reasoning_text"},"text":{"type":"string","description":"The reasoning text from the model."}},"type":"object","required":["type","text"],"title":"Reasoning text","description":"Reasoning text from the model.","x-readme-ref-name":"ReasoningTextContent"},{"properties":{"type":{"type":"string","enum":["refusal"],"description":"The type of the refusal. Always `refusal`.","default":"refusal"},"refusal":{"type":"string","description":"The refusal explanation from the model."}},"type":"object","required":["type","refusal"],"title":"Refusal","description":"A refusal from the model.","x-readme-ref-name":"RefusalContent"},{"properties":{"type":{"type":"string","enum":["input_image"],"description":"The type of the input item. Always `input_image`.","default":"input_image"},"image_url":{"anyOf":[{"type":"string","description":"The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL."},{"type":"null"}]},"detail":{"allOf":[{"type":"string","enum":["low","high","auto"],"x-enumDescriptions":{"auto":"Choose the detail level automatically.","high":"Allows the model to \"see\" a higher-resolution version of the image, usually increasing input token costs.","low":"Restricts the model to a lower-resolution version of the image."},"x-readme-ref-name":"ImageDetail"},{"description":"The detail level of the image to be sent to the model. One of `high`, `low`, or `auto`. Defaults to `auto`."}]}},"type":"object","required":["type","image_url","detail"],"title":"Input image","description":"An image input to the model. Learn about [image inputs](/docs/guides/vision).","x-readme-ref-name":"InputImageContent"},{"properties":{"type":{"type":"string","enum":["input_file"],"description":"The type of the input item. Always `input_file`.","default":"input_file"},"filename":{"type":"string","description":"The name of the file to be sent to the model."},"file_url":{"type":"string","description":"The URL of the file to be sent to the model."}},"type":"object","required":["type"],"title":"Input file","description":"A file input to the model.","x-readme-ref-name":"InputFileContent"}],"description":"A content part that makes up an input or output item.","discriminator":{"propertyName":"type"}},"type":"array","description":"The reasoning summary content that was generated."},"encrypted_content":{"type":"string","description":"The encrypted reasoning content that was generated."}},"type":"object","required":["type","id","summary"],"title":"Reasoning item","description":"A reasoning item that was generated by the model.","x-readme-ref-name":"ReasoningBody"}],"description":"An item representing a message, tool call, tool output, reasoning, or other response element.","discriminator":{"propertyName":"type"},"x-readme-ref-name":"ItemField"},{"description":"An item representing a message, tool call, tool output, reasoning, or other response element."}]},{"type":"null"}]}},"type":"object","required":["type","sequence_number","output_index","item"],"title":"Response output item added event","description":"A streaming event that indicated an output item was added to the response.","x-readme-ref-name":"ResponseOutputItemAddedStreamingEvent"}