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

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

@@ -0,0 +1,938 @@
+{
+  "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": "CreateChatCompletionResponse",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "A unique identifier for the chat completion."
+        },
+        {
+          "name": "choices",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "CreateChatCompletionResponseChoicesItem"
+            }
+          },
+          "required": true,
+          "description": "A list of chat completion choices. Can be more than one if `n` is greater than 1."
+        },
+        {
+          "name": "created",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) of when the chat completion was created."
+        },
+        {
+          "name": "model",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The model used for the chat completion."
+        },
+        {
+          "name": "service_tier",
+          "type": {
+            "kind": "ref",
+            "name": "ServiceTier"
+          },
+          "required": false
+        },
+        {
+          "name": "system_fingerprint",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "deprecated": true,
+          "description": "This fingerprint represents the backend configuration that the model runs with.\n\nCan be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.\n"
+        },
+        {
+          "name": "object",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "chat.completion"
+          },
+          "required": true,
+          "description": "The object type, which is always `chat.completion`."
+        },
+        {
+          "name": "usage",
+          "type": {
+            "kind": "ref",
+            "name": "CompletionUsage"
+          },
+          "required": false
+        }
+      ],
+      "description": "Represents a chat completion response returned by model, based on the provided input."
+    },
+    {
+      "name": "CreateChatCompletionResponseChoicesItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "finish_reason",
+          "type": {
+            "kind": "ref",
+            "name": "CreateChatCompletionResponseChoicesItemFinishReason"
+          },
+          "required": true,
+          "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n"
+        },
+        {
+          "name": "index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "The index of the choice in the list of choices."
+        },
+        {
+          "name": "message",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionResponseMessage"
+          },
+          "required": true
+        },
+        {
+          "name": "logprobs",
+          "type": {
+            "kind": "ref",
+            "name": "CreateChatCompletionResponseChoicesItemLogprobs",
+            "nullable": true
+          },
+          "required": true
+        }
+      ]
+    },
+    {
+      "name": "CreateChatCompletionResponseChoicesItemFinishReason",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "stop"
+        },
+        {
+          "value": "length"
+        },
+        {
+          "value": "tool_calls"
+        },
+        {
+          "value": "content_filter"
+        },
+        {
+          "value": "function_call"
+        }
+      ],
+      "description": "The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence,\n`length` if the maximum number of tokens specified in the request was reached,\n`content_filter` if content was omitted due to a flag from our content filters,\n`tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function.\n"
+    },
+    {
+      "name": "ChatCompletionResponseMessage",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "content",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "refusal",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "tool_calls",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageToolCalls"
+          },
+          "required": false
+        },
+        {
+          "name": "annotations",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionResponseMessageAnnotationsItem"
+            }
+          },
+          "required": false,
+          "description": "Annotations for the message, when applicable, as when using the\n[web search tool](/docs/guides/tools-web-search?api-mode=chat).\n"
+        },
+        {
+          "name": "role",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "assistant"
+          },
+          "required": true,
+          "description": "The role of the author of this message."
+        },
+        {
+          "name": "function_call",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionResponseMessageFunctionCall"
+          },
+          "required": false,
+          "deprecated": true,
+          "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
+        },
+        {
+          "name": "audio",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionResponseMessageAudio",
+            "nullable": true
+          },
+          "required": false
+        }
+      ],
+      "description": "A chat completion message generated by the model."
+    },
+    {
+      "name": "ChatCompletionMessageToolCalls",
+      "kind": "alias",
+      "of": {
+        "kind": "array",
+        "items": {
+          "kind": "ref",
+          "name": "ChatCompletionMessageToolCallsItem"
+        }
+      }
+    },
+    {
+      "name": "ChatCompletionMessageToolCallsItem",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "ref",
+          "name": "ChatCompletionMessageToolCall"
+        },
+        {
+          "kind": "ref",
+          "name": "ChatCompletionMessageCustomToolCall"
+        }
+      ],
+      "discriminator": {
+        "propertyName": "type",
+        "mapping": {
+          "function": "ChatCompletionMessageToolCall",
+          "custom": "ChatCompletionMessageCustomToolCall"
+        }
+      }
+    },
+    {
+      "name": "ChatCompletionMessageToolCall",
+      "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": "function"
+          },
+          "required": true,
+          "description": "The type of the tool. Currently, only `function` is supported."
+        },
+        {
+          "name": "function",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageToolCallFunction"
+          },
+          "required": true,
+          "description": "The function that the model called."
+        }
+      ],
+      "description": "A call to a function tool created by the model.\n"
+    },
+    {
+      "name": "ChatCompletionMessageToolCallFunction",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function to call."
+        },
+        {
+          "name": "arguments",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
+        }
+      ],
+      "description": "The function that the model called."
+    },
+    {
+      "name": "ChatCompletionMessageCustomToolCall",
+      "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": "custom"
+          },
+          "required": true,
+          "description": "The type of the tool. Always `custom`."
+        },
+        {
+          "name": "custom",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionMessageCustomToolCallCustom"
+          },
+          "required": true,
+          "description": "The custom tool that the model called."
+        }
+      ],
+      "description": "A call to a custom tool created by the model.\n"
+    },
+    {
+      "name": "ChatCompletionMessageCustomToolCallCustom",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the custom tool to call."
+        },
+        {
+          "name": "input",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The input for the custom tool call generated by the model."
+        }
+      ],
+      "description": "The custom tool that the model called."
+    },
+    {
+      "name": "ChatCompletionResponseMessageAnnotationsItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "type",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "const": "url_citation"
+          },
+          "required": true,
+          "description": "The type of the URL citation. Always `url_citation`."
+        },
+        {
+          "name": "url_citation",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionResponseMessageAnnotationsItemUrlCitation"
+          },
+          "required": true,
+          "description": "A URL citation when using web search."
+        }
+      ],
+      "description": "A URL citation when using web search.\n"
+    },
+    {
+      "name": "ChatCompletionResponseMessageAnnotationsItemUrlCitation",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "end_index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "The index of the last character of the URL citation in the message."
+        },
+        {
+          "name": "start_index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "description": "The index of the first character of the URL citation in the message."
+        },
+        {
+          "name": "url",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "format": "uri"
+          },
+          "required": true,
+          "description": "The URL of the web resource."
+        },
+        {
+          "name": "title",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The title of the web resource."
+        }
+      ],
+      "description": "A URL citation when using web search."
+    },
+    {
+      "name": "ChatCompletionResponseMessageFunctionCall",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "arguments",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
+        },
+        {
+          "name": "name",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The name of the function to call."
+        }
+      ],
+      "description": "Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model."
+    },
+    {
+      "name": "ChatCompletionResponseMessageAudio",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Unique identifier for this audio response."
+        },
+        {
+          "name": "expires_at",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) for when this audio response will\nno longer be accessible on the server for use in multi-turn\nconversations.\n"
+        },
+        {
+          "name": "data",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Base64 encoded audio bytes generated by the model, in the format\nspecified in the request.\n"
+        },
+        {
+          "name": "transcript",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "Transcript of the audio generated by the model."
+        }
+      ],
+      "description": "If the audio output modality is requested, this object contains data\nabout the audio response from the model. [Learn more](/docs/guides/audio).\n"
+    },
+    {
+      "name": "CreateChatCompletionResponseChoicesItemLogprobs",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "content",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionTokenLogprob"
+            },
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "refusal",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionTokenLogprob"
+            },
+            "nullable": true
+          },
+          "required": true
+        }
+      ],
+      "description": "Log probability information for the choice."
+    },
+    {
+      "name": "ChatCompletionTokenLogprob",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "token",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The token."
+        },
+        {
+          "name": "logprob",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number"
+          },
+          "required": true,
+          "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."
+        },
+        {
+          "name": "bytes",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "integer"
+            },
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "top_logprobs",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "ChatCompletionTokenLogprobTopLogprobsItem"
+            }
+          },
+          "required": true,
+          "description": "List of the most likely tokens and their log probability, at this token position. The number of entries may be fewer than the requested `top_logprobs`."
+        }
+      ]
+    },
+    {
+      "name": "ChatCompletionTokenLogprobTopLogprobsItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "token",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The token."
+        },
+        {
+          "name": "logprob",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number"
+          },
+          "required": true,
+          "description": "The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely."
+        },
+        {
+          "name": "bytes",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "integer"
+            },
+            "nullable": true
+          },
+          "required": true
+        }
+      ]
+    },
+    {
+      "name": "ServiceTier",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "auto"
+        },
+        {
+          "value": "default"
+        },
+        {
+          "value": "flex"
+        },
+        {
+          "value": "scale"
+        },
+        {
+          "value": "priority"
+        }
+      ],
+      "description": "Specifies the processing type used for serving the request.\n  - If set to 'auto', then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use 'default'.\n  - If set to 'default', then the request will be processed with the standard pricing and performance for the selected model.\n  - If set to '[flex](/docs/guides/flex-processing)' or '[priority](https://openai.com/api-priority-processing/)', then the request will be processed with the corresponding service tier.\n  - When not set, the default behavior is 'auto'.\n\n  When the `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.\n"
+    },
+    {
+      "name": "CompletionUsage",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "completion_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "default": 0,
+          "description": "Number of tokens in the generated completion."
+        },
+        {
+          "name": "prompt_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "default": 0,
+          "description": "Number of tokens in the prompt."
+        },
+        {
+          "name": "total_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true,
+          "default": 0,
+          "description": "Total number of tokens used in the request (prompt + completion)."
+        },
+        {
+          "name": "completion_tokens_details",
+          "type": {
+            "kind": "ref",
+            "name": "CompletionUsageCompletionTokensDetails"
+          },
+          "required": false,
+          "description": "Breakdown of tokens used in a completion."
+        },
+        {
+          "name": "prompt_tokens_details",
+          "type": {
+            "kind": "ref",
+            "name": "CompletionUsagePromptTokensDetails"
+          },
+          "required": false,
+          "description": "Breakdown of tokens used in the prompt."
+        }
+      ],
+      "description": "Usage statistics for the completion request."
+    },
+    {
+      "name": "CompletionUsageCompletionTokensDetails",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "accepted_prediction_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "When using Predicted Outputs, the number of tokens in the\nprediction that appeared in the completion.\n"
+        },
+        {
+          "name": "audio_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "Audio input tokens generated by the model."
+        },
+        {
+          "name": "reasoning_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "Tokens generated by the model for reasoning."
+        },
+        {
+          "name": "rejected_prediction_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "When using Predicted Outputs, the number of tokens in the\nprediction that did not appear in the completion. However, like\nreasoning tokens, these tokens are still counted in the total\ncompletion tokens for purposes of billing, output, and context window\nlimits.\n"
+        }
+      ],
+      "description": "Breakdown of tokens used in a completion."
+    },
+    {
+      "name": "CompletionUsagePromptTokensDetails",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "audio_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "Audio input tokens present in the prompt."
+        },
+        {
+          "name": "cached_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": false,
+          "default": 0,
+          "description": "Cached tokens present in the prompt."
+        }
+      ],
+      "description": "Breakdown of tokens used in the prompt."
+    }
+  ],
+  "resources": [
+    {
+      "name": "chat",
+      "resources": [
+        {
+          "name": "completions",
+          "methods": [
+            {
+              "action": "retrieve",
+              "httpMethod": "get",
+              "path": "/chat/completions/{completion_id}",
+              "operationId": "getChatCompletion",
+              "description": "Get a stored chat completion. Only Chat Completions that have been created\nwith the `store` parameter set to `true` will be returned.\n",
+              "pathParams": [
+                {
+                  "name": "completion_id",
+                  "type": {
+                    "kind": "scalar",
+                    "scalar": "string"
+                  },
+                  "required": true,
+                  "description": "The ID of the chat completion to retrieve."
+                }
+              ],
+              "responses": [
+                {
+                  "status": "200",
+                  "description": "A chat completion",
+                  "contentType": "application/json",
+                  "type": {
+                    "kind": "ref",
+                    "name": "CreateChatCompletionResponse"
+                  }
+                }
+              ],
+              "primaryResponse": {
+                "kind": "ref",
+                "name": "CreateChatCompletionResponse"
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "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"
+      ]
+    }
+  }
+}