Class: OpenAI::Resources::Admin::Organization::Projects

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/admin/organization/projects.rb,
lib/openai/resources/admin/organization/projects/roles.rb,
lib/openai/resources/admin/organization/projects/users.rb,
lib/openai/resources/admin/organization/projects/groups.rb,
lib/openai/resources/admin/organization/projects/api_keys.rb,
lib/openai/resources/admin/organization/projects/rate_limits.rb,
lib/openai/resources/admin/organization/projects/users/roles.rb,
lib/openai/resources/admin/organization/projects/certificates.rb,
lib/openai/resources/admin/organization/projects/groups/roles.rb,
lib/openai/resources/admin/organization/projects/service_accounts.rb

Defined Under Namespace

Classes: APIKeys, Certificates, Groups, RateLimits, Roles, ServiceAccounts, Users

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Projects

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Projects.

Parameters:



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 167

def initialize(client:)
  @client = client
  @users = OpenAI::Resources::Admin::Organization::Projects::Users.new(client: client)
  @service_accounts = OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts.new(client: client)
  @api_keys = OpenAI::Resources::Admin::Organization::Projects::APIKeys.new(client: client)
  @rate_limits = OpenAI::Resources::Admin::Organization::Projects::RateLimits.new(client: client)
  @groups = OpenAI::Resources::Admin::Organization::Projects::Groups.new(client: client)
  @roles = OpenAI::Resources::Admin::Organization::Projects::Roles.new(client: client)
  @certificates = OpenAI::Resources::Admin::Organization::Projects::Certificates.new(client: client)
end

Instance Attribute Details

#api_keys ⇒ OpenAI::Resources::Admin::Organization::Projects::APIKeys (readonly)

Returns:



15
16
17
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 15

def api_keys
  @api_keys
end

#certificates ⇒ OpenAI::Resources::Admin::Organization::Projects::Certificates (readonly)

Returns:



27
28
29
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 27

def certificates
  @certificates
end

#groups ⇒ OpenAI::Resources::Admin::Organization::Projects::Groups (readonly)

Returns:



21
22
23
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 21

def groups
  @groups
end

#rate_limits ⇒ OpenAI::Resources::Admin::Organization::Projects::RateLimits (readonly)

Returns:



18
19
20
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 18

def rate_limits
  @rate_limits
end

#roles ⇒ OpenAI::Resources::Admin::Organization::Projects::Roles (readonly)

Returns:



24
25
26
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 24

def roles
  @roles
end

#service_accounts ⇒ OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts (readonly)

Returns:



12
13
14
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 12

def service_accounts
  @service_accounts
end

#users ⇒ OpenAI::Resources::Admin::Organization::Projects::Users (readonly)

Returns:



9
10
11
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 9

def users
  @users
end

Instance Method Details

#archive(project_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Project

Archives a project in the organization. Archived projects cannot be used or updated.

Parameters:

  • project_id (String) —

    The ID of the project.

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

Returns:

See Also:



154
155
156
157
158
159
160
161
162
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 154

def archive(project_id, params = {})
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s/archive", project_id],
    model: OpenAI::Admin::Organization::Project,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#create(name:, external_key_id: nil, geography: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Project

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

Create a new project in the organization. Projects can be created and archived, but cannot be deleted.

Parameters:

  • name (String) —

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

  • external_key_id (String, nil) —

    External key ID to associate with the project.

  • geography (String, nil) —

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

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

Returns:

See Also:



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 48

def create(params)
  parsed, options = OpenAI::Admin::Organization::ProjectCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "organization/projects",
    body: parsed,
    model: OpenAI::Admin::Organization::Project,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#list(after: nil, include_archived: nil, limit: nil, request_options: {}) ⇒ OpenAI::Internal::ConversationCursorPage<OpenAI::Models::Admin::Organization::Project>

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

Returns a list of projects.

Parameters:

  • after (String) —

    A cursor for use in pagination. ‘after` is an object ID that defines your place

  • include_archived (Boolean) —

    If ‘true` returns all projects including those that have been `archived`. Archiv

  • limit (Integer) —

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

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

Returns:

See Also:



128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 128

def list(params = {})
  parsed, options = OpenAI::Admin::Organization::ProjectListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "organization/projects",
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Admin::Organization::Project,
    security: {admin_api_key_auth: true},
    options: options
  )
end

#retrieve(project_id, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Project

Retrieves a project.

Parameters:

  • project_id (String) —

    The ID of the project.

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

Returns:

See Also:



71
72
73
74
75
76
77
78
79
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 71

def retrieve(project_id, params = {})
  @client.request(
    method: :get,
    path: ["organization/projects/%1$s", project_id],
    model: OpenAI::Admin::Organization::Project,
    security: {admin_api_key_auth: true},
    options: params[:request_options]
  )
end

#update(project_id, external_key_id: nil, geography: nil, name: nil, request_options: {}) ⇒ OpenAI::Models::Admin::Organization::Project

Modifies a project in the organization.

Parameters:

  • project_id (String) —

    The ID of the project.

  • external_key_id (String, nil) —

    External key ID to associate with the project.

  • geography (String, nil) —

    Geography for the project.

  • name (String, nil) —

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

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

Returns:

See Also:



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/openai/resources/admin/organization/projects.rb', line 98

def update(project_id, params = {})
  parsed, options = OpenAI::Admin::Organization::ProjectUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["organization/projects/%1$s", project_id],
    body: parsed,
    model: OpenAI::Admin::Organization::Project,
    security: {admin_api_key_auth: true},
    options: options
  )
end