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

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

@@ -0,0 +1,788 @@
+{
+  "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": "CreateCompletionRequest",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "model",
+          "type": {
+            "kind": "ref",
+            "name": "CreateCompletionRequestModel"
+          },
+          "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": "prompt",
+          "type": {
+            "kind": "ref",
+            "name": "CreateCompletionRequestPrompt",
+            "nullable": true
+          },
+          "required": true,
+          "nullable": true,
+          "default": "<|endoftext|>",
+          "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n"
+        },
+        {
+          "name": "best_of",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 1,
+          "description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"
+        },
+        {
+          "name": "echo",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": false,
+          "description": "Echo back the prompt in addition to the completion\n"
+        },
+        {
+          "name": "frequency_penalty",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 0,
+          "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n"
+        },
+        {
+          "name": "logit_bias",
+          "type": {
+            "kind": "map",
+            "values": {
+              "kind": "scalar",
+              "scalar": "integer"
+            },
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": null,
+          "description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n"
+        },
+        {
+          "name": "logprobs",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": null,
+          "description": "Include the log probabilities on the `logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5.\n"
+        },
+        {
+          "name": "max_tokens",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 16,
+          "description": "The maximum number of [tokens](/tokenizer) that can be generated in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.\n"
+        },
+        {
+          "name": "n",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 1,
+          "description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"
+        },
+        {
+          "name": "presence_penalty",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 0,
+          "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/guides/text-generation)\n"
+        },
+        {
+          "name": "seed",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "int64",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "description": "If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.\n\nDeterminism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend.\n"
+        },
+        {
+          "name": "stop",
+          "type": {
+            "kind": "ref",
+            "name": "StopConfiguration"
+          },
+          "required": false
+        },
+        {
+          "name": "stream",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": false,
+          "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).\n"
+        },
+        {
+          "name": "stream_options",
+          "type": {
+            "kind": "ref",
+            "name": "ChatCompletionStreamOptions"
+          },
+          "required": false
+        },
+        {
+          "name": "suffix",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": null,
+          "description": "The suffix that comes after a completion of inserted text.\n\nThis parameter is only supported for `gpt-3.5-turbo-instruct`.\n"
+        },
+        {
+          "name": "temperature",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 1,
+          "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n"
+        },
+        {
+          "name": "top_p",
+          "type": {
+            "kind": "scalar",
+            "scalar": "number",
+            "nullable": true
+          },
+          "required": false,
+          "nullable": true,
+          "default": 1,
+          "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n"
+        },
+        {
+          "name": "user",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices#end-user-ids).\n"
+        }
+      ]
+    },
+    {
+      "name": "CreateCompletionRequestModel",
+      "kind": "union",
+      "semantics": "anyOf",
+      "variants": [
+        {
+          "kind": "scalar",
+          "scalar": "string"
+        },
+        {
+          "kind": "ref",
+          "name": "CreateCompletionRequestModelString"
+        }
+      ],
+      "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": "CreateCompletionRequestModelString",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "gpt-3.5-turbo-instruct"
+        },
+        {
+          "value": "davinci-002"
+        },
+        {
+          "value": "babbage-002"
+        }
+      ]
+    },
+    {
+      "name": "CreateCompletionRequestPrompt",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "scalar",
+          "scalar": "string"
+        },
+        {
+          "kind": "array",
+          "items": {
+            "kind": "scalar",
+            "scalar": "string"
+          }
+        },
+        {
+          "kind": "array",
+          "items": {
+            "kind": "scalar",
+            "scalar": "integer"
+          }
+        },
+        {
+          "kind": "array",
+          "items": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "integer"
+            }
+          }
+        }
+      ],
+      "description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n"
+    },
+    {
+      "name": "StopConfiguration",
+      "kind": "union",
+      "semantics": "oneOf",
+      "variants": [
+        {
+          "kind": "scalar",
+          "scalar": "string",
+          "nullable": true
+        },
+        {
+          "kind": "array",
+          "items": {
+            "kind": "scalar",
+            "scalar": "string"
+          }
+        }
+      ],
+      "description": "Not supported with latest reasoning models `o3` and `o4-mini`.\n\nUp to 4 sequences where the API will stop generating further tokens. The\nreturned text will not contain the stop sequence.\n"
+    },
+    {
+      "name": "ChatCompletionStreamOptions",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "include_usage",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean"
+          },
+          "required": false,
+          "description": "If set, an additional chunk will be streamed before the `data: [DONE]`\nmessage. The `usage` field on this chunk shows the token usage statistics\nfor the entire request, and the `choices` field will always be an empty\narray.\n\nAll other chunks will also include a `usage` field, but with a null\nvalue. **NOTE:** If the stream is interrupted, you may not receive the\nfinal usage chunk which contains the total token usage for the request.\n"
+        },
+        {
+          "name": "include_obfuscation",
+          "type": {
+            "kind": "scalar",
+            "scalar": "boolean"
+          },
+          "required": false,
+          "description": "When true, stream obfuscation will be enabled. Stream obfuscation adds\nrandom characters to an `obfuscation` field on streaming delta events to\nnormalize payload sizes as a mitigation to certain side-channel attacks.\nThese obfuscation fields are included by default, but add a small amount\nof overhead to the data stream. You can set `include_obfuscation` to\nfalse to optimize for bandwidth if you trust the network links between\nyour application and the OpenAI API.\n"
+        }
+      ],
+      "description": "Options for streaming response. Only set this when you set `stream: true`.\n"
+    },
+    {
+      "name": "CreateCompletionResponse",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "id",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "A unique identifier for the completion."
+        },
+        {
+          "name": "choices",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "ref",
+              "name": "CreateCompletionResponseChoicesItem"
+            }
+          },
+          "required": true,
+          "description": "The list of completion choices the model generated for the input prompt."
+        },
+        {
+          "name": "created",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer",
+            "format": "unixtime"
+          },
+          "required": true,
+          "description": "The Unix timestamp (in seconds) of when the completion was created."
+        },
+        {
+          "name": "model",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true,
+          "description": "The model used for completion."
+        },
+        {
+          "name": "system_fingerprint",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": false,
+          "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": "text_completion"
+          },
+          "required": true,
+          "description": "The object type, which is always \"text_completion\""
+        },
+        {
+          "name": "usage",
+          "type": {
+            "kind": "ref",
+            "name": "CompletionUsage"
+          },
+          "required": false
+        }
+      ],
+      "description": "Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).\n"
+    },
+    {
+      "name": "CreateCompletionResponseChoicesItem",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "finish_reason",
+          "type": {
+            "kind": "ref",
+            "name": "CreateCompletionResponseChoicesItemFinishReason"
+          },
+          "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,\nor `content_filter` if content was omitted due to a flag from our content filters.\n"
+        },
+        {
+          "name": "index",
+          "type": {
+            "kind": "scalar",
+            "scalar": "integer"
+          },
+          "required": true
+        },
+        {
+          "name": "logprobs",
+          "type": {
+            "kind": "ref",
+            "name": "CreateCompletionResponseChoicesItemLogprobs",
+            "nullable": true
+          },
+          "required": true
+        },
+        {
+          "name": "text",
+          "type": {
+            "kind": "scalar",
+            "scalar": "string"
+          },
+          "required": true
+        }
+      ]
+    },
+    {
+      "name": "CreateCompletionResponseChoicesItemFinishReason",
+      "kind": "enum",
+      "base": "string",
+      "values": [
+        {
+          "value": "stop"
+        },
+        {
+          "value": "length"
+        },
+        {
+          "value": "content_filter"
+        }
+      ],
+      "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,\nor `content_filter` if content was omitted due to a flag from our content filters.\n"
+    },
+    {
+      "name": "CreateCompletionResponseChoicesItemLogprobs",
+      "kind": "struct",
+      "fields": [
+        {
+          "name": "text_offset",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "integer"
+            }
+          },
+          "required": false
+        },
+        {
+          "name": "token_logprobs",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "number"
+            }
+          },
+          "required": false
+        },
+        {
+          "name": "tokens",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "scalar",
+              "scalar": "string"
+            }
+          },
+          "required": false
+        },
+        {
+          "name": "top_logprobs",
+          "type": {
+            "kind": "array",
+            "items": {
+              "kind": "map",
+              "values": {
+                "kind": "scalar",
+                "scalar": "number"
+              }
+            }
+          },
+          "required": false
+        }
+      ]
+    },
+    {
+      "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": "completions",
+      "methods": [
+        {
+          "action": "create",
+          "httpMethod": "post",
+          "path": "/completions",
+          "operationId": "createCompletion",
+          "description": "Creates a completion for the provided prompt and parameters.\n\nReturns a completion object, or a sequence of completion objects if the request is streamed.\n",
+          "requestBody": {
+            "contentType": "application/json",
+            "type": {
+              "kind": "ref",
+              "name": "CreateCompletionRequest"
+            },
+            "required": true,
+            "encoding": "json"
+          },
+          "responses": [
+            {
+              "status": "200",
+              "description": "OK",
+              "contentType": "application/json",
+              "type": {
+                "kind": "ref",
+                "name": "CreateCompletionResponse"
+              }
+            }
+          ],
+          "primaryResponse": {
+            "kind": "ref",
+            "name": "CreateCompletionResponse"
+          }
+        }
+      ]
+    }
+  ],
+  "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"
+      ]
+    }
+  }
+}