Class: OpenAI::Models::Admin::Organization::UsageCostsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Admin::Organization::UsageCostsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/admin/organization/usage_costs_params.rb

Overview

See Also:

• Resources::Admin::Organization::Usage#costs

Defined Under Namespace

Modules: BucketWidth, GroupBy

Instance Attribute Summary

• #api_key_ids ⇒ Array<String>^?

  Return only costs for these API keys.

• #bucket_width ⇒ Symbol, ...

  Width of each time bucket in response.

• #end_time ⇒ Integer^?

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

• #group_by ⇒ Array<Symbol, OpenAI::Models::Admin::Organization::UsageCostsParams::GroupBy>^?

  Group the costs by the specified fields.

• #limit ⇒ Integer^?

  A limit on the number of buckets to be returned.

• #page ⇒ String^?

  A cursor for use in pagination.

• #project_ids ⇒ Array<String>^?

  Return only costs for these projects.

• #start_time ⇒ Integer

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

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(start_time:, api_key_ids: nil, bucket_width: nil, end_time: nil, group_by: nil, limit: nil, page: nil, project_ids: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see UsageCostsParams for more details.

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, page: nil, project_ids: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Admin::Organization::UsageCostsParams 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 costs for these API keys.

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

  Width of each time bucket in response. Currently only ‘1d` is supported, default

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

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

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

  Group the costs by the specified fields. Support fields include ‘project_id`, `l

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

  A limit on the number of buckets to be returned. Limit can range between 1 and 1

• 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 costs for these projects.

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

# File 'lib/openai/models/admin/organization/usage_costs_params.rb', line 65

Instance Attribute Details

#api_key_ids ⇒ Array<String>^?

Return only costs for these API keys.

Returns:

• (Array<String>, nil)

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

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

#bucket_width ⇒ Symbol, ...

Width of each time bucket in response. Currently only ‘1d` is supported, default to `1d`.

Returns:

• (Symbol, OpenAI::Models::Admin::Organization::UsageCostsParams::BucketWidth, nil)

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

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

#end_time ⇒ Integer^?

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

Returns:

• (Integer, nil)

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

optional :end_time, Integer

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

Group the costs by the specified fields. Support fields include ‘project_id`, `line_item`, `api_key_id` and any combination of them.

Returns:

• (Array<Symbol, OpenAI::Models::Admin::Organization::UsageCostsParams::GroupBy>, nil)

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

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

#limit ⇒ Integer^?

A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.

Returns:

• (Integer, nil)

# File 'lib/openai/models/admin/organization/usage_costs_params.rb', line 50

optional :limit, Integer

#page ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/openai/models/admin/organization/usage_costs_params.rb', line 57

optional :page, String

#project_ids ⇒ Array<String>^?

Return only costs for these projects.

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/admin/organization/usage_costs_params.rb', line 63

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

#start_time ⇒ Integer

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

Returns:

• (Integer)

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

required :start_time, Integer

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/admin/organization/usage_costs_params.rb', line 94