@xyd-js/opensdk-python 0.0.0-build-f0c10f6-20260703195526

package/__fixtures__/-2.complex.openai/beta__threads__runs__steps__retrieve/input.json

@@ -0,0 +1,964 @@
+{
+  "opensdk": "1.0.0",
+  "info": {
+    "title": "openai",
+    "version": "2.3.0"
+  },
+  "servers": [
+    "https://api.openai.com/v1"
+  ],
+  "security": [
+    {
+      "type": "http",
+      "kind": "bearer",
+      "schemeName": "ApiKeyAuth",
+      "envVar": "OPENAI_API_KEY",
+      "scheme": "bearer"
+    },
+    {
+      "type": "http",
+      "kind": "bearer",
+      "schemeName": "AdminApiKeyAuth",
+      "envVar": "OPENAI_API_KEY",
+      "scheme": "bearer"
+    }
+  ],
+  "types": [
+    {
+      "name": "RunStepObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The identifier of the run step, which can be referenced in API endpoints."
+        },
+        {
+          "name": "object",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "thread.run.step"
+          },
+          "required": true,
+          "description": "The object type, which is always `thread.run.step`."
+        },
+        {
+          "name": "created_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) for when the run step was created."
+        },
+        {
+          "name": "assistant_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the [assistant](/docs/api-reference/assistants) associated with the run step."
+        },
+        {
+          "name": "thread_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the [thread](/docs/api-reference/threads) that was run."
+        },
+        {
+          "name": "run_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the [run](/docs/api-reference/runs) that this run step is a part of."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepObjectType"
+          },
+          "required": true,
+          "description": "The type of run step, which can be either `message_creation` or `tool_calls`."
+        },
+        {
+          "name": "status",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepObjectStatus"
+          },
+          "required": true,
+          "description": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`."
+        },
+        {
+          "name": "step_details",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepObjectStepDetails"
+          },
+          "required": true,
+          "description": "The details of the run step."
+        },
+        {
+          "name": "last_error",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepObjectLastError",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "expired_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "cancelled_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "failed_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "completed_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "metadata",
+          "type": {
+            "kind": "ref",
+            "name": "Metadata"
+          },
+          "required": true
+        },
+        {
+          "name": "usage",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepCompletionUsage"
+          },
+          "required": true
+        }
+      ],
+      "description": "Represents a step in execution of a run.\n"
+    },
+    {
+      "name": "RunStepObjectType",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "message_creation"
+        },
+        {
+          "value": "tool_calls"
+        }
+      ],
+      "description": "The type of run step, which can be either `message_creation` or `tool_calls`."
+    },
+    {
+      "name": "RunStepObjectStatus",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "in_progress"
+        },
+        {
+          "value": "cancelled"
+        },
+        {
+          "value": "failed"
+        },
+        {
+          "value": "completed"
+        },
+        {
+          "value": "expired"
+        }
+      ],
+      "description": "The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`."
+    },
+    {
+      "name": "RunStepObjectStepDetails",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsMessageCreationObject"
+        },
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsObject"
+        }
+      ],
+      "description": "The details of the run step."
+    },
+    {
+      "name": "RunStepDetailsMessageCreationObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "message_creation"
+          },
+          "required": true,
+          "description": "Always `message_creation`."
+        },
+        {
+          "name": "message_creation",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsMessageCreationObjectMessageCreation"
+          },
+          "required": true
+        }
+      ],
+      "description": "Details of the message creation by the run step."
+    },
+    {
+      "name": "RunStepDetailsMessageCreationObjectMessageCreation",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "message_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the message that was created by this run step."
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "tool_calls"
+          },
+          "required": true,
+          "description": "Always `tool_calls`."
+        },
+        {
+          "name": "tool_calls",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "RunStepDetailsToolCallsObjectToolCallsItem"
+            }
+          },
+          "required": true,
+          "description": "An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`.\n"
+        }
+      ],
+      "description": "Details of the tool call."
+    },
+    {
+      "name": "RunStepDetailsToolCallsObjectToolCallsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsCodeObject"
+        },
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsFileSearchObject"
+        },
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsFunctionObject"
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the tool call."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "code_interpreter"
+          },
+          "required": true,
+          "description": "The type of tool call. This is always going to be `code_interpreter` for this type of tool call."
+        },
+        {
+          "name": "code_interpreter",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreter"
+          },
+          "required": true,
+          "description": "The Code Interpreter tool call definition."
+        }
+      ],
+      "description": "Details of the Code Interpreter tool call the run step was involved in."
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreter",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "input",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The input to the Code Interpreter tool call."
+        },
+        {
+          "name": "outputs",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsItem"
+            }
+          },
+          "required": true,
+          "description": "The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type."
+        }
+      ],
+      "description": "The Code Interpreter tool call definition."
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeObjectCodeInterpreterOutputsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsCodeOutputLogsObject"
+        },
+        {
+          "kind": "ref",
+          "name": "RunStepDetailsToolCallsCodeOutputImageObject"
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeOutputLogsObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "logs"
+          },
+          "required": true,
+          "description": "Always `logs`."
+        },
+        {
+          "name": "logs",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The text output from the Code Interpreter tool call."
+        }
+      ],
+      "description": "Text output from the Code Interpreter tool call as part of a run step."
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeOutputImageObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "image"
+          },
+          "required": true,
+          "description": "Always `image`."
+        },
+        {
+          "name": "image",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsToolCallsCodeOutputImageObjectImage"
+          },
+          "required": true
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsCodeOutputImageObjectImage",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "file_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The [file](/docs/api-reference/files) ID of the image."
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsFileSearchObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the tool call object."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "file_search"
+          },
+          "required": true,
+          "description": "The type of tool call. This is always going to be `file_search` for this type of tool call."
+        },
+        {
+          "name": "file_search",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsToolCallsFileSearchObjectFileSearch"
+          },
+          "required": true,
+          "description": "For now, this is always going to be an empty object."
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsFileSearchObjectFileSearch",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "ranking_options",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsToolCallsFileSearchRankingOptionsObject"
+          },
+          "required": false
+        },
+        {
+          "name": "results",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "RunStepDetailsToolCallsFileSearchResultObject"
+            }
+          },
+          "required": false,
+          "description": "The results of the file search."
+        }
+      ],
+      "description": "For now, this is always going to be an empty object."
+    },
+    {
+      "name": "RunStepDetailsToolCallsFileSearchRankingOptionsObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "ranker",
+          "type": {
+            "kind": "ref",
+            "name": "FileSearchRanker"
+          },
+          "required": true
+        },
+        {
+          "name": "score_threshold",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number"
+          },
+          "required": true,
+          "description": "The score threshold for the file search. All values must be a floating point number between 0 and 1."
+        }
+      ],
+      "description": "The ranking options for the file search."
+    },
+    {
+      "name": "FileSearchRanker",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "auto"
+        },
+        {
+          "value": "default_2024_08_21"
+        }
+      ],
+      "description": "The ranker to use for the file search. If not specified will use the `auto` ranker."
+    },
+    {
+      "name": "RunStepDetailsToolCallsFileSearchResultObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "file_id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the file that result was found in."
+        },
+        {
+          "name": "file_name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the file that result was found in."
+        },
+        {
+          "name": "score",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number"
+          },
+          "required": true,
+          "description": "The score of the result. All values must be a floating point number between 0 and 1."
+        },
+        {
+          "name": "content",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "RunStepDetailsToolCallsFileSearchResultObjectContentItem"
+            }
+          },
+          "required": false,
+          "description": "The content of the result that was found. The content is only included if requested via the include query parameter."
+        }
+      ],
+      "description": "A result instance of the file search."
+    },
+    {
+      "name": "RunStepDetailsToolCallsFileSearchResultObjectContentItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "text"
+          },
+          "required": false,
+          "description": "The type of the content."
+        },
+        {
+          "name": "text",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "description": "The text content of the file."
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsFunctionObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The ID of the tool call object."
+        },
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "function"
+          },
+          "required": true,
+          "description": "The type of tool call. This is always going to be `function` for this type of tool call."
+        },
+        {
+          "name": "function",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepDetailsToolCallsFunctionObjectFunction"
+          },
+          "required": true,
+          "description": "The definition of the function that was called."
+        }
+      ]
+    },
+    {
+      "name": "RunStepDetailsToolCallsFunctionObjectFunction",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function."
+        },
+        {
+          "name": "arguments",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The arguments passed to the function."
+        },
+        {
+          "name": "output",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        }
+      ],
+      "description": "The definition of the function that was called."
+    },
+    {
+      "name": "RunStepObjectLastError",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "code",
+          "type": {
+            "kind": "ref",
+            "name": "RunStepObjectLastErrorCode"
+          },
+          "required": true,
+          "description": "One of `server_error` or `rate_limit_exceeded`."
+        },
+        {
+          "name": "message",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "A human-readable description of the error."
+        }
+      ],
+      "description": "The last error associated with this run step. Will be `null` if there are no errors."
+    },
+    {
+      "name": "RunStepObjectLastErrorCode",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "server_error"
+        },
+        {
+          "value": "rate_limit_exceeded"
+        }
+      ],
+      "description": "One of `server_error` or `rate_limit_exceeded`."
+    },
+    {
+      "name": "Metadata",
+      "kind": "alias",
+      "of": {
+        "kind": "map",
+        "values": {
+          "kind": "scalar",
+          "scalar": "string"
+        },
+        "nullable": true
+      }
+    },
+    {
+      "name": "RunStepCompletionUsage",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "completion_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "Number of completion tokens used over the course of the run step."
+        },
+        {
+          "name": "prompt_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "Number of prompt tokens used over the course of the run step."
+        },
+        {
+          "name": "total_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "Total number of tokens used (prompt + completion)."
+        }
+      ],
+      "description": "Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`."
+    }
+  ],
+  "resources": [
+    {
+      "name": "beta",
+      "resources": [
+        {
+          "name": "threads",
+          "resources": [
+            {
+              "name": "runs",
+              "resources": [
+                {
+                  "name": "steps",
+                  "methods": [
+                    {
+                      "action": "retrieve",
+                      "httpMethod": "get",
+                      "path": "/threads/{thread_id}/runs/{run_id}/steps/{step_id}",
+                      "operationId": "getRunStep",
+                      "description": "Retrieves a run step.",
+                      "pathParams": [
+                        {
+                          "name": "thread_id",
+                          "type": {
+                            "kind": "scalar",
+                            "scalar": "string"
+                          },
+                          "required": true,
+                          "description": "The ID of the thread to which the run and run step belongs."
+                        },
+                        {
+                          "name": "run_id",
+                          "type": {
+                            "kind": "scalar",
+                            "scalar": "string"
+                          },
+                          "required": true,
+                          "description": "The ID of the run to which the run step belongs."
+                        },
+                        {
+                          "name": "step_id",
+                          "type": {
+                            "kind": "scalar",
+                            "scalar": "string"
+                          },
+                          "required": true,
+                          "description": "The ID of the run step to retrieve."
+                        }
+                      ],
+                      "queryParams": [
+                        {
+                          "name": "include",
+                          "type": {
+                            "kind": "array",
+                            "items": {
+                              "kind": "scalar",
+                              "scalar": "string",
+                              "const": "step_details.tool_calls[*].file_search.results[*].content"
+                            }
+                          },
+                          "required": false,
+                          "wireName": "include[]",
+                          "description": "A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[*].file_search.results[*].content` to fetch the file search result content.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n"
+                        }
+                      ],
+                      "responses": [
+                        {
+                          "status": "200",
+                          "description": "OK",
+                          "contentType": "application/json",
+                          "type": {
+                            "kind": "ref",
+                            "name": "RunStepObject"
+                          }
+                        }
+                      ],
+                      "primaryResponse": {
+                        "kind": "ref",
+                        "name": "RunStepObject"
+                      }
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "sdk": {
+    "retry": {
+      "maxRetries": 2,
+      "retryableStatusCodes": [
+        408,
+        429,
+        500,
+        502,
+        503,
+        504
+      ],
+      "retryConnectionErrors": true,
+      "honorRetryAfterHeader": true,
+      "backoff": {
+        "initialDelayMs": 500,
+        "maxDelayMs": 8000,
+        "multiplier": 2,
+        "jitter": 0.25
+      }
+    },
+    "timeout": {
+      "defaultTimeoutMs": 60000
+    },
+    "errors": {
+      "statusCodeMap": {
+        "400": "BadRequest",
+        "401": "Unauthorized",
+        "403": "PermissionDenied",
+        "404": "NotFound",
+        "409": "Conflict",
+        "422": "UnprocessableEntity",
+        "429": "RateLimited"
+      },
+      "clientErrorKind": "API",
+      "serverErrorKind": "Internal"
+    },
+    "userAgent": {
+      "sdkIdentifierTemplate": "{package}-{language}/{version}",
+      "includeRuntimeVersion": false,
+      "aiAgentEnvVars": {
+        "CLAUDE_CODE": "claude-code",
+        "CURSOR_AGENT": "cursor",
+        "CLINE_ACTIVE": "cline",
+        "WINDSURF_ACTIVE": "windsurf",
+        "COPILOT_AGENT": "copilot"
+      }
+    },
+    "telemetry": {
+      "requestIdHeader": "X-Request-ID",
+      "headerName": "X-Client-Telemetry",
+      "enabledByDefault": false
+    },
+    "logging": {
+      "events": [
+        "request.start",
+        "request.success",
+        "request.retry",
+        "request.rate_limited",
+        "request.error",
+        "request.connection_error"
+      ]
+    },
+    "idempotency": {
+      "headerName": "Idempotency-Key",
+      "autoGenerateForPost": true
+    },
+    "pagination": {
+      "autoPageDelayMs": 0
+    },
+    "requestGuard": {
+      "optionKeys": [
+        "api_key",
+        "apiKey",
+        "idempotency_key",
+        "idempotencyKey",
+        "extra_headers",
+        "extraHeaders",
+        "max_retries",
+        "maxRetries",
+        "base_url",
+        "baseUrl",
+        "timeout"
+      ]
+    }
+  }
+}