Class: OpenAI::Models::Admin::Organization::ProjectCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/admin/organization/project_create_params.rb,
sig/openai/models/admin/organization/project_create_params.rbs

Overview

See Also:

  • OpenAI::Resources::Admin::Organization::Projects#create

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, external_key_id: nil, geography: nil, residency: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Admin::Organization::ProjectCreateParams for more details.

Parameters:

  • name (String) —

    The friendly name of the project, this name appears in reports.

  • external_key_id (String, nil) (defaults to: nil) —

    External key ID to associate with the project.

  • geography (String, nil) (defaults to: nil) —

    Create the project with the specified data residency region. Your organization m

  • residency (Symbol, OpenAI::Models::Admin::Organization::ProjectResidency, nil) (defaults to: nil) —

    Create the project with the specified residency configuration. Your organization

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/openai/models/admin/organization/project_create_params.rb', line 46

Instance Attribute Details

#external_key_id ⇒ String?

External key ID to associate with the project.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


22
 
# File 'lib/openai/models/admin/organization/project_create_params.rb', line 22

optional :external_key_id, String, nil?: true

#geography ⇒ String?

Deprecated.

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 to review the functionality and limitations of setting this field. Deprecated: use residency instead. Do not provide both geography and residency.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/openai/models/admin/organization/project_create_params.rb', line 34

optional :geography, String, nil?: true

#name ⇒ String

The friendly name of the project, this name appears in reports.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/openai/models/admin/organization/project_create_params.rb', line 16

required :name, String

#residency ⇒ Symbol, ...

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 to review the functionality and limitations of setting this field.

Parameters:

  • value (OpenAI::Models::Admin::Organization::project_residency, nil)

Returns:



44
 
# File 'lib/openai/models/admin/organization/project_create_params.rb', line 44

optional :residency, enum: -> { OpenAI::Admin::Organization::ProjectResidency }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


34
 
# File 'sig/openai/models/admin/organization/project_create_params.rbs', line 34

def to_hash: -> {