Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .castiron.stats.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
schema_version: 1
generation_id: d231f6bf-7ba6-4566-a3b5-1594927f874c
openapi_spec_hash: 0ac5ea4ab2546a188a36a0d370367637
openapi_transformed_spec_hash: 6be6c39576ec27111cab26c251d2ab65
config_hash: d92ec885ac2a08b6a4c1ff90420f0327
codegen_sha: 6b5c1351630844386f6789b2ad525184ae291fcd
codegen_hash: 3590be3fb9d4224b65931fe65334f9aa18348e99332770511100daae78422f50
public_codegen_sha: 6e84784e4881104d2d9258eee1cd00f2faabda90
generation_id: 9f7d0c3b-eceb-46c9-af22-f6ea83f34eee
openapi_spec_hash: 0cb51423f74235e850a5f1961f31c167
openapi_transformed_spec_hash: 70d190d2b54dd216f7280d9fd94363f0
config_hash: d7b82262337a543ff59106e4a32ead4e
codegen_sha: 849c2727ef14fa3b6999709c51898c1a95a8e585
codegen_hash: 80ecd85fdd98cca059c6706d619f6a074c7c8a7e14ec9eeab83a6c8bf6cb58ea
public_codegen_sha: b0316f5f64b09f8e007e35d6c26828390bc201be
1,020 changes: 598 additions & 422 deletions api_reference/openapi.transformed.yml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ private constructor(

/**
* The parameters the functions accepts, described as a JSON Schema object. See the
* [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the
* [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation
* about the format.
*
Expand All @@ -74,7 +74,7 @@ private constructor(
* Whether to enable strict schema adherence when generating the function call. If set to true,
* the model will follow the exact schema defined in the `parameters` field. Only a subset of
* JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the
* [function calling guide](https://platform.openai.com/docs/guides/function-calling).
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -185,8 +185,8 @@ private constructor(

/**
* The parameters the functions accepts, described as a JSON Schema object. See the
* [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
* [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and
* the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
* documentation about the format.
*
* Omitting `parameters` defines a function with an empty parameter list.
Expand All @@ -209,7 +209,7 @@ private constructor(
* true, the model will follow the exact schema defined in the `parameters` field. Only a
* subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured
* Outputs in the
* [function calling guide](https://platform.openai.com/docs/guides/function-calling).
* [function calling guide](https://developers.openai.com/api/docs/guides/function-calling).
*/
fun strict(strict: Boolean?) = strict(JsonField.ofNullable(strict))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import java.util.Objects

/**
* The parameters the functions accepts, described as a JSON Schema object. See the
* [guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the
* [guide](https://developers.openai.com/api/docs/guides/function-calling) for examples, and the
* [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation
* about the format.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ import java.util.Optional
import kotlin.jvm.optionals.getOrNull

/**
* Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning).
* Configuration options for
* [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
*/
class Reasoning
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
Expand Down Expand Up @@ -62,7 +63,7 @@ private constructor(
* `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result
* in faster responses and fewer tokens used on reasoning in a response. Not all reasoning
* models support every value. See the
* [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for model-specific
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific
* support.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
Expand Down Expand Up @@ -207,8 +208,8 @@ private constructor(
* `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort
* can result in faster responses and fewer tokens used on reasoning in a response. Not all
* reasoning models support every value. See the
* [reasoning guide](https://platform.openai.com/docs/guides/reasoning) for model-specific
* support.
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for
* model-specific support.
*/
fun effort(effort: ReasoningEffort?) = effort(JsonField.ofNullable(effort))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ import com.openai.errors.OpenAIInvalidDataException
* Constrains effort on reasoning for reasoning models. Currently supported values are `none`,
* `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`. Reducing reasoning effort can result in
* faster responses and fewer tokens used on reasoning in a response. Not all reasoning models
* support every value. See the [reasoning guide](https://platform.openai.com/docs/guides/reasoning)
* for model-specific support.
* support every value. See the
* [reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for model-specific
* support.
*/
class ReasoningEffort @JsonCreator private constructor(private val value: JsonField<String>) :
Enum {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import kotlin.jvm.optionals.getOrNull

/**
* JSON Schema response format. Used to generate structured JSON responses. Learn more about
* [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
* [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs).
*/
class ResponseFormatJsonSchema
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
Expand Down Expand Up @@ -266,7 +266,7 @@ private constructor(
* Whether to enable strict schema adherence when generating the output. If set to true, the
* model will always follow the exact schema defined in the `schema` field. Only a subset of
* JSON Schema is supported when `strict` is `true`. To learn more, read the
* [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
* server responded with an unexpected value).
Expand Down Expand Up @@ -397,7 +397,7 @@ private constructor(
* Whether to enable strict schema adherence when generating the output. If set to true,
* the model will always follow the exact schema defined in the `schema` field. Only a
* subset of JSON Schema is supported when `strict` is `true`. To learn more, read the
* [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
* [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
*/
fun strict(strict: Boolean?) = strict(JsonField.ofNullable(strict))

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import java.util.Objects

/**
* A custom grammar for the model to follow when generating text. Learn more in the
* [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars).
* [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars).
*/
class ResponseFormatTextGrammar
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import java.util.Objects

/**
* Configure the model to generate valid Python code. See the
* [custom grammars guide](https://platform.openai.com/docs/guides/custom-grammars) for more
* details.
* [custom grammars guide](https://developers.openai.com/api/docs/guides/function-calling#context-free-grammars)
* for more details.
*/
class ResponseFormatTextPython
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ private constructor(
/**
* Return only events with a `type` in one of these values. For example, `project.created`. For
* all options, see the documentation for the
* [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).
* [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).
*/
fun eventTypes(): Optional<List<EventType>> = Optional.ofNullable(eventTypes)

Expand Down Expand Up @@ -201,7 +201,7 @@ private constructor(
/**
* Return only events with a `type` in one of these values. For example, `project.created`.
* For all options, see the documentation for the
* [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).
* [audit log object](https://developers.openai.com/api/reference/resources/admin/subresources/organization/subresources/audit_logs).
*/
fun eventTypes(eventTypes: List<EventType>?) = apply {
this.eventTypes = eventTypes?.toMutableList()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ private constructor(
/**
* Create the project with the specified data residency region. Your organization must have
* access to Data residency functionality in order to use. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field. Deprecated: use
* `residency` instead. Do not provide both `geography` and `residency`.
*
Expand All @@ -62,7 +62,7 @@ private constructor(
/**
* Create the project with the specified residency configuration. Your organization must have
* access to the requested residency configuration in order to use it. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
Expand Down Expand Up @@ -179,7 +179,7 @@ private constructor(
/**
* Create the project with the specified data residency region. Your organization must have
* access to Data residency functionality in order to use. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field. Deprecated: use
* `residency` instead. Do not provide both `geography` and `residency`.
*/
Expand All @@ -203,7 +203,7 @@ private constructor(
/**
* Create the project with the specified residency configuration. Your organization must
* have access to the requested residency configuration in order to use it. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field.
*/
fun residency(residency: ProjectResidency?) = apply { body.residency(residency) }
Expand Down Expand Up @@ -406,7 +406,7 @@ private constructor(
/**
* Create the project with the specified data residency region. Your organization must have
* access to Data residency functionality in order to use. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field. Deprecated: use
* `residency` instead. Do not provide both `geography` and `residency`.
*
Expand All @@ -419,7 +419,7 @@ private constructor(
/**
* Create the project with the specified residency configuration. Your organization must
* have access to the requested residency configuration in order to use it. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field.
*
* @throws OpenAIInvalidDataException if the JSON field has an unexpected type (e.g. if the
Expand Down Expand Up @@ -540,7 +540,7 @@ private constructor(
/**
* Create the project with the specified data residency region. Your organization must
* have access to Data residency functionality in order to use. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field. Deprecated: use
* `residency` instead. Do not provide both `geography` and `residency`.
*/
Expand All @@ -564,7 +564,7 @@ private constructor(
/**
* Create the project with the specified residency configuration. Your organization must
* have access to the requested residency configuration in order to use it. See
* [data residency controls](https://platform.openai.com/docs/guides/your-data#data-residency-controls)
* [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
* to review the functionality and limitations of setting this field.
*/
fun residency(residency: ProjectResidency?) = residency(JsonField.ofNullable(residency))
Expand Down
Loading
Loading