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

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

@@ -0,0 +1,694 @@
+{
+  "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": "AssistantObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The identifier, which can be referenced in API endpoints."
+        },
+        {
+          "name": "object",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "assistant"
+          },
+          "required": true,
+          "description": "The object type, which is always `assistant`."
+        },
+        {
+          "name": "created_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) for when the assistant was created."
+        },
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "description",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "model",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models) for descriptions of them.\n"
+        },
+        {
+          "name": "instructions",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "tools",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "AssistantObjectToolsItem"
+            }
+          },
+          "required": true,
+          "default": [],
+          "description": "A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.\n"
+        },
+        {
+          "name": "tool_resources",
+          "type": {
+            "kind": "ref",
+            "name": "AssistantObjectToolResources",
+            "nullable": true
+          },
+          "required": false
+        },
+        {
+          "name": "metadata",
+          "type": {
+            "kind": "ref",
+            "name": "Metadata"
+          },
+          "required": true
+        },
+        {
+          "name": "temperature",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false
+        },
+        {
+          "name": "top_p",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false
+        },
+        {
+          "name": "response_format",
+          "type": {
+            "kind": "ref",
+            "name": "AssistantsApiResponseFormatOption",
+            "nullable": true
+          },
+          "required": false
+        }
+      ],
+      "description": "Represents an `assistant` that can call the model and use tools."
+    },
+    {
+      "name": "AssistantObjectToolsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "AssistantToolsCode"
+        },
+        {
+          "kind": "ref",
+          "name": "AssistantToolsFileSearch"
+        },
+        {
+          "kind": "ref",
+          "name": "AssistantToolsFunction"
+        }
+      ]
+    },
+    {
+      "name": "AssistantToolsCode",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "code_interpreter"
+          },
+          "required": true,
+          "description": "The type of tool being defined: `code_interpreter`"
+        }
+      ]
+    },
+    {
+      "name": "AssistantToolsFileSearch",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "file_search"
+          },
+          "required": true,
+          "description": "The type of tool being defined: `file_search`"
+        },
+        {
+          "name": "file_search",
+          "type": {
+            "kind": "ref",
+            "name": "AssistantToolsFileSearchFileSearch"
+          },
+          "required": false,
+          "description": "Overrides for the file search tool."
+        }
+      ]
+    },
+    {
+      "name": "AssistantToolsFileSearchFileSearch",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "max_num_results",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "description": "The maximum number of results the file search tool should output. The default is 20 for `gpt-4*` models and 5 for `gpt-3.5-turbo`. This number should be between 1 and 50 inclusive.\n\nNote that the file search tool may output fewer than `max_num_results` results. See the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n"
+        },
+        {
+          "name": "ranking_options",
+          "type": {
+            "kind": "ref",
+            "name": "FileSearchRankingOptions"
+          },
+          "required": false
+        }
+      ],
+      "description": "Overrides for the file search tool."
+    },
+    {
+      "name": "FileSearchRankingOptions",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "ranker",
+          "type": {
+            "kind": "ref",
+            "name": "FileSearchRanker"
+          },
+          "required": false
+        },
+        {
+          "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. If not specified, the file search tool will use the `auto` ranker and a score_threshold of 0.\n\nSee the [file search tool documentation](/docs/assistants/tools/file-search#customizing-file-search-settings) for more information.\n"
+    },
+    {
+      "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": "AssistantToolsFunction",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "function"
+          },
+          "required": true,
+          "description": "The type of tool being defined: `function`"
+        },
+        {
+          "name": "function",
+          "type": {
+            "kind": "ref",
+            "name": "FunctionObject"
+          },
+          "required": true
+        }
+      ]
+    },
+    {
+      "name": "FunctionObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "description",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "description": "A description of what the function does, used by the model to choose when and how to call the function."
+        },
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."
+        },
+        {
+          "name": "parameters",
+          "type": {
+            "kind": "ref",
+            "name": "FunctionParameters"
+          },
+          "required": false
+        },
+        {
+          "name": "strict",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean",
+            "nullable": true
+          },
+          "required": false
+        }
+      ]
+    },
+    {
+      "name": "FunctionParameters",
+      "kind": "alias",
+      "of": {
+        "kind": "map",
+        "values": {
+          "kind": "any"
+        }
+      }
+    },
+    {
+      "name": "AssistantObjectToolResources",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "code_interpreter",
+          "type": {
+            "kind": "ref",
+            "name": "AssistantObjectToolResourcesCodeInterpreter"
+          },
+          "required": false
+        },
+        {
+          "name": "file_search",
+          "type": {
+            "kind": "ref",
+            "name": "AssistantObjectToolResourcesFileSearch"
+          },
+          "required": false
+        }
+      ],
+      "description": "A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.\n"
+    },
+    {
+      "name": "AssistantObjectToolResourcesCodeInterpreter",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "file_ids",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "string"
+            }
+          },
+          "required": false,
+          "default": [],
+          "description": "A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.\n"
+        }
+      ]
+    },
+    {
+      "name": "AssistantObjectToolResourcesFileSearch",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "vector_store_ids",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "string"
+            }
+          },
+          "required": false,
+          "description": "The ID of the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant.\n"
+        }
+      ]
+    },
+    {
+      "name": "Metadata",
+      "kind": "alias",
+      "of": {
+        "kind": "map",
+        "values": {
+          "kind": "scalar",
+          "scalar": "string"
+        },
+        "nullable": true
+      }
+    },
+    {
+      "name": "AssistantsApiResponseFormatOption",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "scalar",
+          "scalar": "string",
+          "const": "auto"
+        },
+        {
+          "kind": "ref",
+          "name": "ResponseFormatText"
+        },
+        {
+          "kind": "ref",
+          "name": "ResponseFormatJsonObject"
+        },
+        {
+          "kind": "ref",
+          "name": "ResponseFormatJsonSchema"
+        }
+      ],
+      "description": "Specifies the format that the model must output. Compatible with [GPT-4o](/docs/models#gpt-4o), [GPT-4 Turbo](/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.\n\nSetting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](/docs/guides/structured-outputs).\n\nSetting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\n**Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if `finish_reason=\"length\"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.\n"
+    },
+    {
+      "name": "ResponseFormatText",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "text"
+          },
+          "required": true,
+          "description": "The type of response format being defined. Always `text`."
+        }
+      ],
+      "description": "Default response format. Used to generate text responses.\n"
+    },
+    {
+      "name": "ResponseFormatJsonObject",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "json_object"
+          },
+          "required": true,
+          "description": "The type of response format being defined. Always `json_object`."
+        }
+      ],
+      "description": "JSON object response format. An older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so.\n"
+    },
+    {
+      "name": "ResponseFormatJsonSchema",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "json_schema"
+          },
+          "required": true,
+          "description": "The type of response format being defined. Always `json_schema`."
+        },
+        {
+          "name": "json_schema",
+          "type": {
+            "kind": "ref",
+            "name": "ResponseFormatJsonSchemaJsonSchema"
+          },
+          "required": true,
+          "description": "Structured Outputs configuration options, including a JSON Schema.\n"
+        }
+      ],
+      "description": "JSON Schema response format. Used to generate structured JSON responses.\nLearn more about [Structured Outputs](/docs/guides/structured-outputs).\n"
+    },
+    {
+      "name": "ResponseFormatJsonSchemaJsonSchema",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "description",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "description": "A description of what the response format is for, used by the model to\ndetermine how to respond in the format.\n"
+        },
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the response format. Must be a-z, A-Z, 0-9, or contain\nunderscores and dashes, with a maximum length of 64.\n"
+        },
+        {
+          "name": "schema",
+          "type": {
+            "kind": "ref",
+            "name": "ResponseFormatJsonSchemaSchema"
+          },
+          "required": false
+        },
+        {
+          "name": "strict",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean",
+            "nullable": true
+          },
+          "required": false
+        }
+      ],
+      "description": "Structured Outputs configuration options, including a JSON Schema.\n"
+    },
+    {
+      "name": "ResponseFormatJsonSchemaSchema",
+      "kind": "alias",
+      "of": {
+        "kind": "map",
+        "values": {
+          "kind": "any"
+        }
+      }
+    }
+  ],
+  "resources": [
+    {
+      "name": "beta",
+      "resources": [
+        {
+          "name": "assistants",
+          "methods": [
+            {
+              "action": "retrieve",
+              "httpMethod": "get",
+              "path": "/assistants/{assistant_id}",
+              "operationId": "getAssistant",
+              "description": "Retrieves an assistant.",
+              "deprecated": true,
+              "pathParams": [
+                {
+                  "name": "assistant_id",
+                  "type": {
+                    "kind": "scalar",
+                    "scalar": "string"
+                  },
+                  "required": true,
+                  "description": "The ID of the assistant to retrieve."
+                }
+              ],
+              "responses": [
+                {
+                  "status": "200",
+                  "description": "OK",
+                  "contentType": "application/json",
+                  "type": {
+                    "kind": "ref",
+                    "name": "AssistantObject"
+                  }
+                }
+              ],
+              "primaryResponse": {
+                "kind": "ref",
+                "name": "AssistantObject"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "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"
+      ]
+    }
+  }
+}