Skip to content

Commit 81ccb86

Browse files
chore(api): docs and spec refactoring
1 parent 8ad2281 commit 81ccb86

19 files changed

+131
-58
lines changed

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 118
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-94b1e3cb0bdc616ff0c2f267c33dadd95f133b1f64e647aab6c64afb292b2793.yml
3-
openapi_spec_hash: 2395319ac9befd59b6536ae7f9564a05
4-
config_hash: 930dac3aa861344867e4ac84f037b5df
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-d30ff992a48873c1466c49f3c01f2ec8933faebff23424748f8d056065b1bcef.yml
3+
openapi_spec_hash: e933ec43b46f45c348adb78840e5808d
4+
config_hash: bf45940f0a7805b4ec2017eecdd36893

lib/openai/models/chat/completion_list_params.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,12 @@ class CompletionListParams < OpenAI::Internal::Type::BaseModel
2121
optional :limit, Integer
2222

2323
# @!attribute metadata
24-
# A list of metadata keys to filter the Chat Completions by. Example:
24+
# Set of 16 key-value pairs that can be attached to an object. This can be useful
25+
# for storing additional information about the object in a structured format, and
26+
# querying for objects via API or the dashboard.
2527
#
26-
# `metadata[key1]=value1&metadata[key2]=value2`
28+
# Keys are strings with a maximum length of 64 characters. Values are strings with
29+
# a maximum length of 512 characters.
2730
#
2831
# @return [Hash{Symbol=>String}, nil]
2932
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
@@ -49,7 +52,7 @@ class CompletionListParams < OpenAI::Internal::Type::BaseModel
4952
#
5053
# @param limit [Integer] Number of Chat Completions to retrieve.
5154
#
52-
# @param metadata [Hash{Symbol=>String}, nil] A list of metadata keys to filter the Chat Completions by. Example:
55+
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
5356
#
5457
# @param model [String] The model used to generate the Chat Completions.
5558
#

lib/openai/models/conversations/conversation_create_params.rb

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ class ConversationCreateParams < OpenAI::Internal::Type::BaseModel
1818
nil?: true
1919

2020
# @!attribute metadata
21-
# Set of 16 key-value pairs that can be attached to an object. Useful for storing
22-
# additional information about the object in a structured format.
21+
# Set of 16 key-value pairs that can be attached to an object. This can be useful
22+
# for storing additional information about the object in a structured format, and
23+
# querying for objects via API or the dashboard.
24+
#
25+
# Keys are strings with a maximum length of 64 characters. Values are strings with
26+
# a maximum length of 512 characters.
2327
#
2428
# @return [Hash{Symbol=>String}, nil]
2529
optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
@@ -30,7 +34,7 @@ class ConversationCreateParams < OpenAI::Internal::Type::BaseModel
3034
#
3135
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context.
3236
#
33-
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. Useful for
37+
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
3438
#
3539
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
3640
end

lib/openai/models/evals/run_cancel_response.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,11 @@ class Responses < OpenAI::Internal::Type::BaseModel
314314
optional :model, String, nil?: true
315315

316316
# @!attribute reasoning_effort
317-
# Optional reasoning effort parameter. This is a query parameter used to select
318-
# responses.
317+
# Constrains effort on reasoning for
318+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
319+
# supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
320+
# effort can result in faster responses and fewer tokens used on reasoning in a
321+
# response.
319322
#
320323
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
321324
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -361,7 +364,7 @@ class Responses < OpenAI::Internal::Type::BaseModel
361364
#
362365
# @param model [String, nil] The name of the model to find responses for. This is a query parameter used to s
363366
#
364-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Optional reasoning effort parameter. This is a query parameter used to select re
367+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
365368
#
366369
# @param temperature [Float, nil] Sampling temperature. This is a query parameter used to select responses.
367370
#

lib/openai/models/evals/run_create_params.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,11 @@ class Responses < OpenAI::Internal::Type::BaseModel
226226
optional :model, String, nil?: true
227227

228228
# @!attribute reasoning_effort
229-
# Optional reasoning effort parameter. This is a query parameter used to select
230-
# responses.
229+
# Constrains effort on reasoning for
230+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
231+
# supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
232+
# effort can result in faster responses and fewer tokens used on reasoning in a
233+
# response.
231234
#
232235
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
233236
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -273,7 +276,7 @@ class Responses < OpenAI::Internal::Type::BaseModel
273276
#
274277
# @param model [String, nil] The name of the model to find responses for. This is a query parameter used to s
275278
#
276-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Optional reasoning effort parameter. This is a query parameter used to select re
279+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
277280
#
278281
# @param temperature [Float, nil] Sampling temperature. This is a query parameter used to select responses.
279282
#

lib/openai/models/evals/run_create_response.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,11 @@ class Responses < OpenAI::Internal::Type::BaseModel
314314
optional :model, String, nil?: true
315315

316316
# @!attribute reasoning_effort
317-
# Optional reasoning effort parameter. This is a query parameter used to select
318-
# responses.
317+
# Constrains effort on reasoning for
318+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
319+
# supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
320+
# effort can result in faster responses and fewer tokens used on reasoning in a
321+
# response.
319322
#
320323
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
321324
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -361,7 +364,7 @@ class Responses < OpenAI::Internal::Type::BaseModel
361364
#
362365
# @param model [String, nil] The name of the model to find responses for. This is a query parameter used to s
363366
#
364-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Optional reasoning effort parameter. This is a query parameter used to select re
367+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
365368
#
366369
# @param temperature [Float, nil] Sampling temperature. This is a query parameter used to select responses.
367370
#

lib/openai/models/evals/run_list_response.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,11 @@ class Responses < OpenAI::Internal::Type::BaseModel
314314
optional :model, String, nil?: true
315315

316316
# @!attribute reasoning_effort
317-
# Optional reasoning effort parameter. This is a query parameter used to select
318-
# responses.
317+
# Constrains effort on reasoning for
318+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
319+
# supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
320+
# effort can result in faster responses and fewer tokens used on reasoning in a
321+
# response.
319322
#
320323
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
321324
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -361,7 +364,7 @@ class Responses < OpenAI::Internal::Type::BaseModel
361364
#
362365
# @param model [String, nil] The name of the model to find responses for. This is a query parameter used to s
363366
#
364-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Optional reasoning effort parameter. This is a query parameter used to select re
367+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
365368
#
366369
# @param temperature [Float, nil] Sampling temperature. This is a query parameter used to select responses.
367370
#

lib/openai/models/evals/run_retrieve_response.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,11 @@ class Responses < OpenAI::Internal::Type::BaseModel
314314
optional :model, String, nil?: true
315315

316316
# @!attribute reasoning_effort
317-
# Optional reasoning effort parameter. This is a query parameter used to select
318-
# responses.
317+
# Constrains effort on reasoning for
318+
# [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
319+
# supported values are `minimal`, `low`, `medium`, and `high`. Reducing reasoning
320+
# effort can result in faster responses and fewer tokens used on reasoning in a
321+
# response.
319322
#
320323
# @return [Symbol, OpenAI::Models::ReasoningEffort, nil]
321324
optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true
@@ -361,7 +364,7 @@ class Responses < OpenAI::Internal::Type::BaseModel
361364
#
362365
# @param model [String, nil] The name of the model to find responses for. This is a query parameter used to s
363366
#
364-
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Optional reasoning effort parameter. This is a query parameter used to select re
367+
# @param reasoning_effort [Symbol, OpenAI::Models::ReasoningEffort, nil] Constrains effort on reasoning for
365368
#
366369
# @param temperature [Float, nil] Sampling temperature. This is a query parameter used to select responses.
367370
#

lib/openai/resources/chat/completions.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ def update(completion_id, params)
387387
#
388388
# @param limit [Integer] Number of Chat Completions to retrieve.
389389
#
390-
# @param metadata [Hash{Symbol=>String}, nil] A list of metadata keys to filter the Chat Completions by. Example:
390+
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
391391
#
392392
# @param model [String] The model used to generate the Chat Completions.
393393
#

lib/openai/resources/conversations.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class Conversations
1515
#
1616
# @param items [Array<OpenAI::Models::Responses::EasyInputMessage, OpenAI::Models::Responses::ResponseInputItem::Message, OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseInputItem::ComputerCallOutput, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseInputItem::FunctionCallOutput, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseInputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCall, OpenAI::Models::Responses::ResponseInputItem::LocalShellCallOutput, OpenAI::Models::Responses::ResponseInputItem::McpListTools, OpenAI::Models::Responses::ResponseInputItem::McpApprovalRequest, OpenAI::Models::Responses::ResponseInputItem::McpApprovalResponse, OpenAI::Models::Responses::ResponseInputItem::McpCall, OpenAI::Models::Responses::ResponseCustomToolCallOutput, OpenAI::Models::Responses::ResponseCustomToolCall, OpenAI::Models::Responses::ResponseInputItem::ItemReference>, nil] Initial items to include in the conversation context.
1717
#
18-
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. Useful for
18+
# @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
1919
#
2020
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
2121
#

0 commit comments

Comments
 (0)