Skip to content

feat(api): add Cyber access programs to Responses #754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
marcuswood-oai wants to merge 1 commit into from
Closed

feat(api): add Cyber access programs to Responses #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions .castiron.stats.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
schema_version: 1
generation_id: 062e7c51-8ed8-4111-b6cf-507fa9befcce
openapi_spec_hash: 687580b2f55d2dada661f0387a4b3e0d
openapi_transformed_spec_hash: 904296217a5077aa14766c6c58aa87d9
generation_id: 05ad9a79-c402-46ed-9461-e99b2679ab63
openapi_spec_hash: c80aa413841be7f1fcc2e846a6fa84b6
openapi_transformed_spec_hash: f863c79711166d4468eb3f22fb1cd451
config_hash: 84cdcc959ee7140cc9a65e9b642c097b
codegen_sha: fd63e5c8b7583152acfe88ba6addb8adadcb3cc4
codegen_hash: 932d507add86de293034431eea802f35ed4accc8c8c0e63c0e2be239178a7869
public_codegen_sha: edeb207d57bd3fe367f2b78137d7508b6bf08364
codegen_sha: 7a208d1948b47012a713121f3bab54b2a6c9c2d2
codegen_hash: 3a3fef1a265f41d2e2924d0a9f959596b939905341991ebb5bd8f5343334fcc3
public_codegen_sha: 78bd5c69debaa20bd2d980eb7d4d9626c47dc25d
102 changes: 95 additions & 7 deletions api_reference/openapi.transformed.yml
View file
Open in desktop

Large diffs are not rendered by default.

36 changes: 35 additions & 1 deletion lib/openai/models/beta/beta_response.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ class BetaResponse < OpenAI::Internal::Type::BaseModel
# @return [String]
required :id, String

# @!attribute access_programs
#
# @return [OpenAI::Models::Beta::BetaResponse::AccessPrograms, nil]
required :access_programs, -> { OpenAI::Beta::BetaResponse::AccessPrograms }, nil?: true

# @!attribute created_at
# Unix timestamp (in seconds) of when this Response was created.
#
Expand Down Expand Up @@ -353,10 +358,12 @@ class BetaResponse < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :user, String

# @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
# @!method initialize(id:, access_programs:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, moderation: nil, previous_response_id: nil, prompt: nil, prompt_cache_diagnostics: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
# @param id [String]
# Unique identifier for this Response.
#
# @param access_programs [OpenAI::Models::Beta::BetaResponse::AccessPrograms, nil]
#
# @param created_at [Float]
# Unix timestamp (in seconds) of when this Response was created.
#
Expand Down Expand Up @@ -587,6 +594,33 @@ class BetaResponse < OpenAI::Internal::Type::BaseModel
# @param object [Symbol, :response]
# The object type of this resource - always set to `response`.

# @see OpenAI::Models::Beta::BetaResponse#access_programs
class AccessPrograms < OpenAI::Internal::Type::BaseModel
# @!attribute cyber
# The effective Cyber access program used for this response.
#
# @return [Symbol, OpenAI::Models::Beta::BetaResponse::AccessPrograms::Cyber]
required :cyber, enum: -> { OpenAI::Beta::BetaResponse::AccessPrograms::Cyber }

# @!method initialize(cyber:)
# @param cyber [Symbol, OpenAI::Models::Beta::BetaResponse::AccessPrograms::Cyber]
# The effective Cyber access program used for this response.

# The effective Cyber access program used for this response.
#
# @see OpenAI::Models::Beta::BetaResponse::AccessPrograms#cyber
module Cyber
extend OpenAI::Internal::Type::Enum

STANDARD = :standard
DAYBREAK_BLUE = :daybreak_blue
DAYBREAK_RED = :daybreak_red

# @!method self.values
# @return [Array<Symbol>]
end
end

# @see OpenAI::Models::Beta::BetaResponse#incomplete_details
class IncompleteDetails < OpenAI::Internal::Type::BaseModel
# @!attribute reason
Expand Down
71 changes: 70 additions & 1 deletion lib/openai/models/beta/beta_responses_client_event.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ class ResponseCreate < OpenAI::Internal::Type::BaseModel
# @return [Symbol, :"response.create"]
required :type, const: :"response.create"

# @!attribute access_programs
# Domain-specific access programs to use for this request.
#
# @return [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms, nil]
optional :access_programs, -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms }

# @!attribute background
# Whether to run the model response in the background.
# [Learn more](https://developers.openai.com/api/docs/guides/background).
Expand Down Expand Up @@ -476,7 +482,7 @@ class ResponseCreate < OpenAI::Internal::Type::BaseModel
# @return [String, nil]
optional :user, String

# @!method initialize(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream: nil, stream_id: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, type: :"response.create")
# Client event for creating a response over a persistent WebSocket connection.
# This payload uses the same top-level fields as `POST /v1/responses`, plus
# WebSocket-only envelope metadata.
Expand All @@ -487,6 +493,9 @@ class ResponseCreate < OpenAI::Internal::Type::BaseModel
# - `background` is not supported over WebSocket.
# - `stream_id` is WebSocket-only and is not part of `POST /v1/responses`.
#
# @param access_programs [OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms]
# Domain-specific access programs to use for this request.
#
# @param background [Boolean, nil]
# Whether to run the model response in the background.
# [Learn more](https://developers.openai.com/api/docs/guides/background).
Expand Down Expand Up @@ -752,6 +761,66 @@ class ResponseCreate < OpenAI::Internal::Type::BaseModel
#
# @param type [Symbol, :"response.create"]
# The type of the client event. Always `response.create`.

# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate#access_programs
class AccessPrograms < OpenAI::Internal::Type::BaseModel
# @!attribute cyber
# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.
#
# @return [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber, nil]
optional(
:cyber,
enum: -> { OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber }
)

# @!method initialize(cyber: nil)
# Domain-specific access programs to use for this request.
#
# @param cyber [Symbol, OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms::Cyber]
# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.

# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.
#
# @see OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::AccessPrograms#cyber
module Cyber
extend OpenAI::Internal::Type::Enum

STANDARD = :standard
DAYBREAK_BLUE = :daybreak_blue
DAYBREAK_RED = :daybreak_red

# @!method self.values
# @return [Array<Symbol>]
end
end

class ContextManagement < OpenAI::Internal::Type::BaseModel
# @!attribute type
# The context management entry type. Currently only 'compaction' is supported.
Expand Down
66 changes: 65 additions & 1 deletion lib/openai/models/beta/response_create_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
extend OpenAI::Internal::Type::RequestParameters::Converter
include OpenAI::Internal::Type::RequestParameters

# @!attribute access_programs
# Domain-specific access programs to use for this request.
#
# @return [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms, nil]
optional :access_programs, -> { OpenAI::Beta::ResponseCreateParams::AccessPrograms }

# @!attribute background
# Whether to run the model response in the background.
# [Learn more](https://developers.openai.com/api/docs/guides/background).
Expand Down Expand Up @@ -376,7 +382,10 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
# @return [Array<Symbol, OpenAI::Models::Beta::ResponseCreateParams::Beta>, nil]
optional :betas, -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Beta::ResponseCreateParams::Beta] }

# @!method initialize(background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
# @!method initialize(access_programs: nil, background: nil, context_management: nil, conversation: nil, include: nil, input: nil, instructions: nil, max_output_tokens: nil, max_tool_calls: nil, metadata: nil, model: nil, moderation: nil, multi_agent: nil, parallel_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_options: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, store: nil, stream_options: nil, temperature: nil, text: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, truncation: nil, user: nil, betas: nil, request_options: {})
# @param access_programs [OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms]
# Domain-specific access programs to use for this request.
#
# @param background [Boolean, nil]
# Whether to run the model response in the background.
# [Learn more](https://developers.openai.com/api/docs/guides/background).
Expand Down Expand Up @@ -629,6 +638,61 @@ class ResponseCreateParams < OpenAI::Internal::Type::BaseModel
#
# @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]

class AccessPrograms < OpenAI::Internal::Type::BaseModel
# @!attribute cyber
# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.
#
# @return [Symbol, OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms::Cyber, nil]
optional :cyber, enum: -> { OpenAI::Beta::ResponseCreateParams::AccessPrograms::Cyber }

# @!method initialize(cyber: nil)
# Domain-specific access programs to use for this request.
#
# @param cyber [Symbol, OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms::Cyber]
# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.

# The Cyber access program to use for this request. Supported values are
# `standard`, `daybreak_blue`, and `daybreak_red`. If omitted, the API resolves
# the program from the model's Cyber tier and your organization and project
# access, subject to model-specific eligibility restrictions. By default, models
# without a Cyber tier use Standard. Blue-tier models use Daybreak Blue when
# authorized; otherwise they fall back to Standard unless the model requires
# Daybreak access. Red-tier models use Daybreak Red and require authorization.
# Requests that require unavailable Daybreak access return 403. An implicit
# Standard fallback is represented by null in the response's access_programs
# field, rather than an explicit Standard selection.
#
# @see OpenAI::Models::Beta::ResponseCreateParams::AccessPrograms#cyber
module Cyber
extend OpenAI::Internal::Type::Enum

STANDARD = :standard
DAYBREAK_BLUE = :daybreak_blue
DAYBREAK_RED = :daybreak_red

# @!method self.values
# @return [Array<Symbol>]
end
end

class ContextManagement < OpenAI::Internal::Type::BaseModel
# @!attribute type
# The context management entry type. Currently only 'compaction' is supported.
Expand Down
Loading
Loading