Class: OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams

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

Overview

See Also:

  • OpenAI::Resources::Admin::Organization::Usage#audio_speeches

Defined Under Namespace

Modules: BucketWidth, GroupBy

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, 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, #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(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, models: nil, page: nil, project_ids: nil, user_ids: nil, request_options: {}) ⇒ Object

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

Parameters:

  • start_time (Integer) —

    Start time (Unix seconds) of the query time range, inclusive.

  • api_key_ids (Array<String>) (defaults to: nil) —

    Return only usage for these API keys.

  • bucket_width (Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::BucketWidth) (defaults to: nil) —

    Width of each time bucket in response. Currently 1m, 1h and 1d are support

  • end_time (Integer) (defaults to: nil) —

    End time (Unix seconds) of the query time range, exclusive.

  • group_by (Array<Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::GroupBy>) (defaults to: nil) —

    Group the usage data by the specified fields. Support fields include `project_id

  • limit (Integer) (defaults to: nil) —

    Specifies the number of buckets to return.

  • models (Array<String>) (defaults to: nil) —

    Return only usage for these models.

  • page (String) (defaults to: nil) —

    A cursor for use in pagination. Corresponding to the next_page field from the

  • project_ids (Array<String>) (defaults to: nil) —

    Return only usage for these projects.

  • user_ids (Array<String>) (defaults to: nil) —

    Return only usage for these users.

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



# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 80

Instance Attribute Details

#api_key_ids ⇒ Array<String>?

Return only usage for these API keys.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :api_key_ids, OpenAI::Internal::Type::ArrayOf[String]

#bucket_width ⇒ Symbol, ...

Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

Returns:



29
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 29

optional :bucket_width, enum: -> { OpenAI::Admin::Organization::UsageAudioSpeechesParams::BucketWidth }

#end_time ⇒ Integer?

End time (Unix seconds) of the query time range, exclusive.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


35
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 35

optional :end_time, Integer

#group_by ⇒ Array<Symbol, OpenAI::Models::Admin::Organization::UsageAudioSpeechesParams::GroupBy>?

Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

Returns:



42
43
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 42

optional :group_by,
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Admin::Organization::UsageAudioSpeechesParams::GroupBy] }

#limit ⇒ Integer?

Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


53
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 53

optional :limit, Integer

#models ⇒ Array<String>?

Return only usage for these models.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


59
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 59

optional :models, OpenAI::Internal::Type::ArrayOf[String]

#page ⇒ String?

A cursor for use in pagination. Corresponding to the next_page field from the previous response.

Parameters:

  • (String)

Returns:

  • (String, nil) 


66
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 66

optional :page, String

#project_ids ⇒ Array<String>?

Return only usage for these projects.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


72
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 72

optional :project_ids, OpenAI::Internal::Type::ArrayOf[String]

#start_time ⇒ Integer

Start time (Unix seconds) of the query time range, inclusive.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :start_time, Integer

#user_ids ⇒ Array<String>?

Return only usage for these users.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


78
 
# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 78

optional :user_ids, OpenAI::Internal::Type::ArrayOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/admin/organization/usage_audio_speeches_params.rb', line 116

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


80
 
# File 'sig/openai/models/admin/organization/usage_audio_speeches_params.rbs', line 80

def to_hash: -> {