checkpoint_permissions

Creates, updates, deletes, gets or lists a checkpoint_permissions resource.

Overview

Name	checkpoint_permissions
Type	Resource
Id	openai.fine_tuning.checkpoint_permissions

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
id	string	The permission identifier, which can be referenced in the API endpoints.
project_id	string	The project identifier that the permission is for.
created_at	integer (unixtime)	The Unix timestamp (in seconds) for when the permission was created.
object	string	The object type, which is always "checkpoint.permission". (checkpoint.permission)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	fine_tuned_model_checkpoint	project_id, after, limit, order, openai-organization, openai-project
create	insert	fine_tuned_model_checkpoint, project_ids	openai-organization, openai-project
delete	delete	fine_tuned_model_checkpoint, permission_id	openai-organization, openai-project

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fine_tuned_model_checkpoint	string	The ID of the fine-tuned model checkpoint to delete a permission for.
permission_id	string	The ID of the fine-tuned model checkpoint permission to delete.
after	string	Identifier for the last permission ID from the previous pagination request.
limit	integer	Number of permissions to retrieve. Automatically applied from a SQL LIMIT clause - SELECT ... LIMIT 10 sends limit=10 on the wire. Setting it explicitly in a WHERE clause is not required.
openai-organization	string	Optionally scope the request to a specific organization (overrides the default associated with the API key). Addressable in SQL as openai_organization.
openai-project	string	Optionally scope the request to a specific project (overrides the default associated with the API key). Addressable in SQL as openai_project.
order	string	The order in which to retrieve permissions.
project_id	string	The ID of the project to get permissions for.

SELECT examples

list

OK

SELECT
id,
project_id,
created_at,
object
FROM openai.fine_tuning.checkpoint_permissions
WHERE fine_tuned_model_checkpoint = '{{ fine_tuned_model_checkpoint }}' -- required
AND project_id = '{{ project_id }}'
AND after = '{{ after }}'
AND "order" = '{{ order }}'
AND "openai-organization" = '{{ openai-organization }}'
AND "openai-project" = '{{ openai-project }}'
;

INSERT examples

create

No description available.

INSERT INTO openai.fine_tuning.checkpoint_permissions (
project_ids,
fine_tuned_model_checkpoint,
"openai-organization",
"openai-project"
)
SELECT 
'{{ project_ids }}' /* required */,
'{{ fine_tuned_model_checkpoint }}',
'{{ openai-organization }}',
'{{ openai-project }}'
RETURNING
first_id,
last_id,
data,
has_more,
object
;

Manifest

# Description fields are for documentation purposes
- name: checkpoint_permissions
props:
  - name: fine_tuned_model_checkpoint
    value: "{{ fine_tuned_model_checkpoint }}"
    description: Required parameter for the checkpoint_permissions resource.
  - name: project_ids
    value:
      - "{{ project_ids }}"
    description: |
      The project identifiers to grant access to.
  - name: openai-organization
    value: "{{ openai-organization }}"
    description: Optionally scope the request to a specific organization (overrides the default associated with the API key). Addressable in SQL as `openai_organization`.
    description: Optionally scope the request to a specific organization (overrides the default associated with the API key). Addressable in SQL as `openai_organization`.
  - name: openai-project
    value: "{{ openai-project }}"
    description: Optionally scope the request to a specific project (overrides the default associated with the API key). Addressable in SQL as `openai_project`.
    description: Optionally scope the request to a specific project (overrides the default associated with the API key). Addressable in SQL as `openai_project`.

DELETE examples

delete

No description available.

DELETE FROM openai.fine_tuning.checkpoint_permissions
WHERE fine_tuned_model_checkpoint = '{{ fine_tuned_model_checkpoint }}' --required
AND permission_id = '{{ permission_id }}' --required
AND "openai-organization" = '{{ openai-organization }}'
AND "openai-project" = '{{ openai-project }}'
;