Class: OpenAI::Resources::FineTuning::Checkpoints::Permissions

Inherits:
Object
  • Object
show all
Defined in:
lib/openai/resources/fine_tuning/checkpoints/permissions.rb

Overview

Manage fine-tuning jobs to tailor a model to your specific training data.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Permissions

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 Permissions.

Parameters:

API:

  • private



161
162
163
 
# File 'lib/openai/resources/fine_tuning/checkpoints/permissions.rb', line 161

def initialize(client:)
  @client = client
end

Instance Method Details

#create(fine_tuned_model_checkpoint, project_ids:, request_options: {}) ⇒ OpenAI::Internal::Page<OpenAI::Models::FineTuning::Checkpoints::PermissionCreateResponse>

Some parameter documentations has been truncated, see Models::FineTuning::Checkpoints::PermissionCreateParams for more details.

NOTE: Calling this endpoint requires an [admin API key](../admin-api-keys).

This enables organization owners to share fine-tuned models with other projects in their organization.

Parameters:

  • The ID of the fine-tuned model checkpoint to create a permission for.

  • The project identifiers to grant access to.

Returns:

See Also:



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/openai/resources/fine_tuning/checkpoints/permissions.rb', line 29

def create(fine_tuned_model_checkpoint, params)
  parsed, options = OpenAI::FineTuning::Checkpoints::PermissionCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
    body: parsed,
    page: OpenAI::Internal::Page,
    model: OpenAI::Models::FineTuning::Checkpoints::PermissionCreateResponse,
    options: options
  )
end

#delete(permission_id, fine_tuned_model_checkpoint:, request_options: {}) ⇒ OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteResponse

Some parameter documentations has been truncated, see Models::FineTuning::Checkpoints::PermissionDeleteParams for more details.

NOTE: This endpoint requires an [admin API key](../admin-api-keys).

Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint.

Parameters:

  • The ID of the fine-tuned model checkpoint permission to delete.

  • The ID of the fine-tuned model checkpoint to delete a permission for.

Returns:

See Also:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/openai/resources/fine_tuning/checkpoints/permissions.rb', line 140

def delete(permission_id, params)
  parsed, options = OpenAI::FineTuning::Checkpoints::PermissionDeleteParams.dump_request(params)
  fine_tuned_model_checkpoint =
    parsed.delete(:fine_tuned_model_checkpoint) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: [
      "fine_tuning/checkpoints/%1$s/permissions/%2$s",
      fine_tuned_model_checkpoint,
      permission_id
    ],
    model: OpenAI::Models::FineTuning::Checkpoints::PermissionDeleteResponse,
    options: options
  )
end

#list(fine_tuned_model_checkpoint, after: nil, limit: nil, order: nil, project_id: nil, request_options: {}) ⇒ OpenAI::Internal::ConversationCursorPage<OpenAI::Models::FineTuning::Checkpoints::PermissionListResponse>

Some parameter documentations has been truncated, see Models::FineTuning::Checkpoints::PermissionListParams for more details.

NOTE: This endpoint requires an [admin API key](../admin-api-keys).

Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.

Parameters:

  • The ID of the fine-tuned model checkpoint to get permissions for.

  • Identifier for the last permission ID from the previous pagination request.

  • Number of permissions to retrieve.

  • The order in which to retrieve permissions.

  • The ID of the project to get permissions for.

Returns:

See Also:



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/openai/resources/fine_tuning/checkpoints/permissions.rb', line 107

def list(fine_tuned_model_checkpoint, params = {})
  parsed, options = OpenAI::FineTuning::Checkpoints::PermissionListParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
    query: query,
    page: OpenAI::Internal::ConversationCursorPage,
    model: OpenAI::Models::FineTuning::Checkpoints::PermissionListResponse,
    options: options
  )
end

#retrieve(fine_tuned_model_checkpoint, after: nil, limit: nil, order: nil, project_id: nil, request_options: {}) ⇒ OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse

Deprecated.

Retrieve is deprecated. Please swap to the paginated list method instead.

Some parameter documentations has been truncated, see Models::FineTuning::Checkpoints::PermissionRetrieveParams for more details.

NOTE: This endpoint requires an [admin API key](../admin-api-keys).

Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint.

Parameters:

  • The ID of the fine-tuned model checkpoint to get permissions for.

  • Identifier for the last permission ID from the previous pagination request.

  • Number of permissions to retrieve.

  • The order in which to retrieve permissions.

  • The ID of the project to get permissions for.

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/openai/resources/fine_tuning/checkpoints/permissions.rb', line 69

def retrieve(fine_tuned_model_checkpoint, params = {})
  parsed, options = OpenAI::FineTuning::Checkpoints::PermissionRetrieveParams.dump_request(params)
  query = OpenAI::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["fine_tuning/checkpoints/%1$s/permissions", fine_tuned_model_checkpoint],
    query: query,
    model: OpenAI::Models::FineTuning::Checkpoints::PermissionRetrieveResponse,
    options: options
  )
end