Skip to content
API Reference
/
ai-finetuning
/
ai_finetuning_v1_org_user_datasets_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai_finetuning_v1_org_user_datasets_list

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Query
date_createdstring(date-time)
num_data_pointsinteger
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

retry_attemptsinteger
searchstring

A search term.

statusstring
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"completed""failed""pending""processing"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/?date_created=2019-08-24T14%3A15%3A22Z&num_data_points=0&ordering=string&page=0&page_size=0&retry_attempts=0&search=string&status=completed' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(DataSet)required
results[].​idstring(uuid)read-onlyrequired
results[].​platformobject or nullread-onlyrequired
results[].​platform.​property name*string or integeradditional property
One of:
string
results[].​namestring<= 255 charactersrequired
results[].​promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

results[].​source_urlstring(uri)<= 400 characters
results[].​source_filestring(uri)
results[].​statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
results[].​num_data_pointsinteger[ 0 .. 2147483647 ]
results[].​train_splitnumber(double)[ 0 .. 1 ]
results[].​train_filestring(uri)
results[].​test_filestring(uri)
results[].​retry_attemptsinteger[ 0 .. 2147483647 ]
results[].​error_logstring
results[].​date_createdstring(date-time)read-onlyrequired
results[].​last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_finetuning_v1_org_user_datasets_create

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Body
required
namestring<= 255 charactersrequired
source_urlstring(uri)<= 400 characters
source_filestring(uri)
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "source_url": "http://example.com",
    "source_file": "http://example.com",
    "num_data_points": 2147483647,
    "train_split": 1,
    "prompt": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
namestring<= 255 charactersrequired
source_urlstring(uri)<= 400 characters
source_filestring(uri)
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "source_url": "http://example.com",
  "source_file": "http://example.com",
  "num_data_points": 2147483647,
  "train_split": 1,
  "prompt": "string"
}

ai_finetuning_v1_org_user_datasets_retrieve

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this data set.

orgstringrequired
usernamestringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
platformobject or nullread-onlyrequired
platform.​property name*string or integeradditional property
One of:
string
namestring<= 255 charactersrequired
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

source_urlstring(uri)<= 400 characters
source_filestring(uri)
statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
train_filestring(uri)
test_filestring(uri)
retry_attemptsinteger[ 0 .. 2147483647 ]
error_logstring
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "platform": {
    "property1": "string",
    "property2": "string"
  },
  "name": "string",
  "prompt": "string",
  "source_url": "http://example.com",
  "source_file": "http://example.com",
  "status": "pending",
  "num_data_points": 2147483647,
  "train_split": 1,
  "train_file": "http://example.com",
  "test_file": "http://example.com",
  "retry_attempts": 2147483647,
  "error_log": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_datasets_update

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this data set.

orgstringrequired
usernamestringrequired
Body
required
namestring<= 255 charactersrequired
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

source_urlstring(uri)<= 400 characters
source_filestring(uri)
statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
train_filestring(uri)
test_filestring(uri)
retry_attemptsinteger[ 0 .. 2147483647 ]
error_logstring
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "prompt": "string",
    "source_url": "http://example.com",
    "source_file": "http://example.com",
    "status": "pending",
    "num_data_points": 2147483647,
    "train_split": 1,
    "train_file": "http://example.com",
    "test_file": "http://example.com",
    "retry_attempts": 2147483647,
    "error_log": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
platformobject or nullread-onlyrequired
platform.​property name*string or integeradditional property
One of:
string
namestring<= 255 charactersrequired
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

source_urlstring(uri)<= 400 characters
source_filestring(uri)
statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
train_filestring(uri)
test_filestring(uri)
retry_attemptsinteger[ 0 .. 2147483647 ]
error_logstring
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "platform": {
    "property1": "string",
    "property2": "string"
  },
  "name": "string",
  "prompt": "string",
  "source_url": "http://example.com",
  "source_file": "http://example.com",
  "status": "pending",
  "num_data_points": 2147483647,
  "train_split": 1,
  "train_file": "http://example.com",
  "test_file": "http://example.com",
  "retry_attempts": 2147483647,
  "error_log": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_datasets_partial_update

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this data set.

orgstringrequired
usernamestringrequired
Body
namestring<= 255 characters
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

source_urlstring(uri)<= 400 characters
source_filestring(uri)
statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
train_filestring(uri)
test_filestring(uri)
retry_attemptsinteger[ 0 .. 2147483647 ]
error_logstring
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "prompt": "string",
    "source_url": "http://example.com",
    "source_file": "http://example.com",
    "status": "pending",
    "num_data_points": 2147483647,
    "train_split": 1,
    "train_file": "http://example.com",
    "test_file": "http://example.com",
    "retry_attempts": 2147483647,
    "error_log": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
platformobject or nullread-onlyrequired
platform.​property name*string or integeradditional property
One of:
string
namestring<= 255 charactersrequired
promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

source_urlstring(uri)<= 400 characters
source_filestring(uri)
statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
num_data_pointsinteger[ 0 .. 2147483647 ]
train_splitnumber(double)[ 0 .. 1 ]
train_filestring(uri)
test_filestring(uri)
retry_attemptsinteger[ 0 .. 2147483647 ]
error_logstring
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "platform": {
    "property1": "string",
    "property2": "string"
  },
  "name": "string",
  "prompt": "string",
  "source_url": "http://example.com",
  "source_file": "http://example.com",
  "status": "pending",
  "num_data_points": 2147483647,
  "train_split": 1,
  "train_file": "http://example.com",
  "test_file": "http://example.com",
  "retry_attempts": 2147483647,
  "error_log": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_datasets_destroy

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this data set.

orgstringrequired
usernamestringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_finetuning_v1_org_user_trainings_list

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Query
base_model_namestring
datasetstring(uuid)
date_createdstring(date-time)
fine_tuned_modelstring
last_modifiedstring(date-time)
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

preprocess_datasetboolean
providerstring
  • openai - Openai
Value"openai"
searchstring

A search term.

statusstring
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • cancelled - Cancelled
  • failed - Failed
Enum"cancelled""completed""failed""pending""processing"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/?base_model_name=string&dataset=497f6eca-6276-4993-bfeb-53cbbbba6f08&date_created=2019-08-24T14%3A15%3A22Z&fine_tuned_model=string&last_modified=2019-08-24T14%3A15%3A22Z&ordering=string&page=0&page_size=0&preprocess_dataset=true&provider=openai&search=string&status=cancelled' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?page=4"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?page=2"
resultsArray of objects(Training)required
results[].​idstring(uuid)
results[].​datasetobject(DataSet)required
results[].​dataset.​idstring(uuid)read-onlyrequired
results[].​dataset.​platformobject or nullread-onlyrequired
results[].​dataset.​platform.​property name*string or integeradditional property
One of:
string
results[].​dataset.​namestring<= 255 charactersrequired
results[].​dataset.​promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

results[].​dataset.​source_urlstring(uri)<= 400 characters
results[].​dataset.​source_filestring(uri)
results[].​dataset.​statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
results[].​dataset.​num_data_pointsinteger[ 0 .. 2147483647 ]
results[].​dataset.​train_splitnumber(double)[ 0 .. 1 ]
results[].​dataset.​train_filestring(uri)
results[].​dataset.​test_filestring(uri)
results[].​dataset.​retry_attemptsinteger[ 0 .. 2147483647 ]
results[].​dataset.​error_logstring
results[].​dataset.​date_createdstring(date-time)read-onlyrequired
results[].​dataset.​last_modifiedstring(date-time)read-onlyrequired
results[].​project_namestring<= 255 charactersrequired
results[].​metadataany
results[].​statusstring(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
results[].​retry_attemptsinteger[ 0 .. 2147483647 ]
results[].​fine_tuned_modelstring<= 400 characters
results[].​providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
results[].​base_model_namestring<= 400 charactersrequired
results[].​text_columnstring<= 50 characters
results[].​learning_ratenumber(double)
results[].​batch_sizeinteger[ 0 .. 2147483647 ]
results[].​num_epochsinteger[ 0 .. 2147483647 ]
results[].​block_sizeinteger[ 0 .. 2147483647 ]
results[].​warmup_rationumber(double)
results[].​lora_rinteger[ 0 .. 2147483647 ]
results[].​lora_alphainteger[ 0 .. 2147483647 ]
results[].​lora_dropoutnumber(double)
results[].​weight_decaynumber(double)
results[].​gradient_accumulationinteger[ 0 .. 2147483647 ]
results[].​use_peftboolean
results[].​use_fp16boolean
results[].​use_int4boolean
results[].​push_to_hubboolean
results[].​repo_idstring<= 400 characters
results[].​preprocess_datasetboolean
results[].​prompt_columnstring<= 50 characters
results[].​response_columnstring<= 50 characters
results[].​prompt_prefixstring<= 50 characters
results[].​prompt_suffixstring<= 50 characters
results[].​response_prefixstring<= 50 characters
results[].​response_suffixstring<= 50 characters
results[].​error_logstring
results[].​date_createdstring(date-time)read-onlyrequired
results[].​last_modifiedstring(date-time)read-onlyrequired
results[].​platformintegerrequired
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    { … }
  ]
}

ai_finetuning_v1_org_user_trainings_create

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
Body
required
project_namestring<= 255 charactersrequired
datasetstring(uuid)required
base_model_namestring<= 400 charactersrequired
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_name": "string",
    "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
    "base_model_name": "string",
    "provider": "openai",
    "text_column": "string",
    "learning_rate": 0.1,
    "batch_size": 2147483647,
    "num_epochs": 2147483647,
    "block_size": 2147483647,
    "warmup_ratio": 0.1,
    "lora_r": 2147483647,
    "lora_alpha": 2147483647,
    "lora_dropout": 0.1,
    "weight_decay": 0.1,
    "gradient_accumulation": 2147483647,
    "use_peft": true,
    "use_fp16": true,
    "use_int4": true,
    "push_to_hub": true,
    "repo_id": "string",
    "preprocess_dataset": true,
    "prompt_column": "string",
    "prompt_prefix": "string",
    "prompt_suffix": "string",
    "response_prefix": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
project_namestring<= 255 charactersrequired
datasetstring(uuid)required
base_model_namestring<= 400 charactersrequired
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_name": "string",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "base_model_name": "string",
  "provider": "openai",
  "text_column": "string",
  "learning_rate": 0.1,
  "batch_size": 2147483647,
  "num_epochs": 2147483647,
  "block_size": 2147483647,
  "warmup_ratio": 0.1,
  "lora_r": 2147483647,
  "lora_alpha": 2147483647,
  "lora_dropout": 0.1,
  "weight_decay": 0.1,
  "gradient_accumulation": 2147483647,
  "use_peft": true,
  "use_fp16": true,
  "use_int4": true,
  "push_to_hub": true,
  "repo_id": "string",
  "preprocess_dataset": true,
  "prompt_column": "string",
  "prompt_prefix": "string",
  "prompt_suffix": "string",
  "response_prefix": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_trainings_retrieve

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this training.

orgstringrequired
usernamestringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(uuid)
datasetobject(DataSet)required
dataset.​idstring(uuid)read-onlyrequired
dataset.​platformobject or nullread-onlyrequired
dataset.​platform.​property name*string or integeradditional property
One of:
string
dataset.​namestring<= 255 charactersrequired
dataset.​promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

dataset.​source_urlstring(uri)<= 400 characters
dataset.​source_filestring(uri)
dataset.​statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
dataset.​num_data_pointsinteger[ 0 .. 2147483647 ]
dataset.​train_splitnumber(double)[ 0 .. 1 ]
dataset.​train_filestring(uri)
dataset.​test_filestring(uri)
dataset.​retry_attemptsinteger[ 0 .. 2147483647 ]
dataset.​error_logstring
dataset.​date_createdstring(date-time)read-onlyrequired
dataset.​last_modifiedstring(date-time)read-onlyrequired
project_namestring<= 255 charactersrequired
metadataany
statusstring(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
retry_attemptsinteger[ 0 .. 2147483647 ]
fine_tuned_modelstring<= 400 characters
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
base_model_namestring<= 400 charactersrequired
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
response_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
response_suffixstring<= 50 characters
error_logstring
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
platformintegerrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "platform": { … },
    "name": "string",
    "prompt": "string",
    "source_url": "http://example.com",
    "source_file": "http://example.com",
    "status": "pending",
    "num_data_points": 2147483647,
    "train_split": 1,
    "train_file": "http://example.com",
    "test_file": "http://example.com",
    "retry_attempts": 2147483647,
    "error_log": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "last_modified": "2019-08-24T14:15:22Z"
  },
  "project_name": "string",
  "metadata": null,
  "status": "trained",
  "retry_attempts": 2147483647,
  "fine_tuned_model": "string",
  "provider": "openai",
  "base_model_name": "string",
  "text_column": "string",
  "learning_rate": 0.1,
  "batch_size": 2147483647,
  "num_epochs": 2147483647,
  "block_size": 2147483647,
  "warmup_ratio": 0.1,
  "lora_r": 2147483647,
  "lora_alpha": 2147483647,
  "lora_dropout": 0.1,
  "weight_decay": 0.1,
  "gradient_accumulation": 2147483647,
  "use_peft": true,
  "use_fp16": true,
  "use_int4": true,
  "push_to_hub": true,
  "repo_id": "string",
  "preprocess_dataset": true,
  "prompt_column": "string",
  "response_column": "string",
  "prompt_prefix": "string",
  "prompt_suffix": "string",
  "response_prefix": "string",
  "response_suffix": "string",
  "error_log": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z",
  "platform": 0
}

ai_finetuning_v1_org_user_trainings_update

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this training.

orgstringrequired
usernamestringrequired
Body
required
project_namestring<= 255 charactersrequired
datasetstring(uuid)required
base_model_namestring<= 400 charactersrequired
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_name": "string",
    "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
    "base_model_name": "string",
    "provider": "openai",
    "text_column": "string",
    "learning_rate": 0.1,
    "batch_size": 2147483647,
    "num_epochs": 2147483647,
    "block_size": 2147483647,
    "warmup_ratio": 0.1,
    "lora_r": 2147483647,
    "lora_alpha": 2147483647,
    "lora_dropout": 0.1,
    "weight_decay": 0.1,
    "gradient_accumulation": 2147483647,
    "use_peft": true,
    "use_fp16": true,
    "use_int4": true,
    "push_to_hub": true,
    "repo_id": "string",
    "preprocess_dataset": true,
    "prompt_column": "string",
    "prompt_prefix": "string",
    "prompt_suffix": "string",
    "response_prefix": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
project_namestring<= 255 charactersrequired
datasetstring(uuid)required
base_model_namestring<= 400 charactersrequired
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_name": "string",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "base_model_name": "string",
  "provider": "openai",
  "text_column": "string",
  "learning_rate": 0.1,
  "batch_size": 2147483647,
  "num_epochs": 2147483647,
  "block_size": 2147483647,
  "warmup_ratio": 0.1,
  "lora_r": 2147483647,
  "lora_alpha": 2147483647,
  "lora_dropout": 0.1,
  "weight_decay": 0.1,
  "gradient_accumulation": 2147483647,
  "use_peft": true,
  "use_fp16": true,
  "use_int4": true,
  "push_to_hub": true,
  "repo_id": "string",
  "preprocess_dataset": true,
  "prompt_column": "string",
  "prompt_prefix": "string",
  "prompt_suffix": "string",
  "response_prefix": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_trainings_partial_update

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this training.

orgstringrequired
usernamestringrequired
Body
project_namestring<= 255 characters
datasetstring(uuid)
base_model_namestring<= 400 characters
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "project_name": "string",
    "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
    "base_model_name": "string",
    "provider": "openai",
    "text_column": "string",
    "learning_rate": 0.1,
    "batch_size": 2147483647,
    "num_epochs": 2147483647,
    "block_size": 2147483647,
    "warmup_ratio": 0.1,
    "lora_r": 2147483647,
    "lora_alpha": 2147483647,
    "lora_dropout": 0.1,
    "weight_decay": 0.1,
    "gradient_accumulation": 2147483647,
    "use_peft": true,
    "use_fp16": true,
    "use_int4": true,
    "push_to_hub": true,
    "repo_id": "string",
    "preprocess_dataset": true,
    "prompt_column": "string",
    "prompt_prefix": "string",
    "prompt_suffix": "string",
    "response_prefix": "string"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
project_namestring<= 255 charactersrequired
datasetstring(uuid)required
base_model_namestring<= 400 charactersrequired
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_name": "string",
  "dataset": "d93f2be0-02b1-4d87-8b6e-fc5cba21ed8d",
  "base_model_name": "string",
  "provider": "openai",
  "text_column": "string",
  "learning_rate": 0.1,
  "batch_size": 2147483647,
  "num_epochs": 2147483647,
  "block_size": 2147483647,
  "warmup_ratio": 0.1,
  "lora_r": 2147483647,
  "lora_alpha": 2147483647,
  "lora_dropout": 0.1,
  "weight_decay": 0.1,
  "gradient_accumulation": 2147483647,
  "use_peft": true,
  "use_fp16": true,
  "use_int4": true,
  "push_to_hub": true,
  "repo_id": "string",
  "preprocess_dataset": true,
  "prompt_column": "string",
  "prompt_prefix": "string",
  "prompt_suffix": "string",
  "response_prefix": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z"
}

ai_finetuning_v1_org_user_trainings_destroy

Request

Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin

Security
PlatformApiKeyAuthentication
Path
idstring(uuid)required

A UUID string identifying this training.

orgstringrequired
usernamestringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

ai_finetuning_v1_org_user_trainings_finetuned_models_retrieve

Request

Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model. Filtering and pagination is allowed.

NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the training list endpoint. Returns: Response: A paginated response containing the serialized fine-tuned models.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
usernamestringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstring(uuid)
datasetobject(DataSet)required
dataset.​idstring(uuid)read-onlyrequired
dataset.​platformobject or nullread-onlyrequired
dataset.​platform.​property name*string or integeradditional property
One of:
string
dataset.​namestring<= 255 charactersrequired
dataset.​promptstring<= 1000 characters

(if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.

dataset.​source_urlstring(uri)<= 400 characters
dataset.​source_filestring(uri)
dataset.​statusstring(DataSetStatusEnum)
  • pending - Pending
  • processing - Processing
  • completed - Completed
  • failed - Failed
Enum"pending""processing""completed""failed"
dataset.​num_data_pointsinteger[ 0 .. 2147483647 ]
dataset.​train_splitnumber(double)[ 0 .. 1 ]
dataset.​train_filestring(uri)
dataset.​test_filestring(uri)
dataset.​retry_attemptsinteger[ 0 .. 2147483647 ]
dataset.​error_logstring
dataset.​date_createdstring(date-time)read-onlyrequired
dataset.​last_modifiedstring(date-time)read-onlyrequired
project_namestring<= 255 charactersrequired
metadataany
statusstring(TrainingStatusEnum)
  • trained - Trained
  • failed - Failed
  • pending - Pending
  • untrained - Untrained
Enum"trained""failed""pending""untrained"
retry_attemptsinteger[ 0 .. 2147483647 ]
fine_tuned_modelstring<= 400 characters
providerstring(Provider63aEnum)
  • openai - Openai
Value"openai"
base_model_namestring<= 400 charactersrequired
text_columnstring<= 50 characters
learning_ratenumber(double)
batch_sizeinteger[ 0 .. 2147483647 ]
num_epochsinteger[ 0 .. 2147483647 ]
block_sizeinteger[ 0 .. 2147483647 ]
warmup_rationumber(double)
lora_rinteger[ 0 .. 2147483647 ]
lora_alphainteger[ 0 .. 2147483647 ]
lora_dropoutnumber(double)
weight_decaynumber(double)
gradient_accumulationinteger[ 0 .. 2147483647 ]
use_peftboolean
use_fp16boolean
use_int4boolean
push_to_hubboolean
repo_idstring<= 400 characters
preprocess_datasetboolean
prompt_columnstring<= 50 characters
response_columnstring<= 50 characters
prompt_prefixstring<= 50 characters
prompt_suffixstring<= 50 characters
response_prefixstring<= 50 characters
response_suffixstring<= 50 characters
error_logstring
date_createdstring(date-time)read-onlyrequired
last_modifiedstring(date-time)read-onlyrequired
platformintegerrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dataset": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "platform": { … },
    "name": "string",
    "prompt": "string",
    "source_url": "http://example.com",
    "source_file": "http://example.com",
    "status": "pending",
    "num_data_points": 2147483647,
    "train_split": 1,
    "train_file": "http://example.com",
    "test_file": "http://example.com",
    "retry_attempts": 2147483647,
    "error_log": "string",
    "date_created": "2019-08-24T14:15:22Z",
    "last_modified": "2019-08-24T14:15:22Z"
  },
  "project_name": "string",
  "metadata": null,
  "status": "trained",
  "retry_attempts": 2147483647,
  "fine_tuned_model": "string",
  "provider": "openai",
  "base_model_name": "string",
  "text_column": "string",
  "learning_rate": 0.1,
  "batch_size": 2147483647,
  "num_epochs": 2147483647,
  "block_size": 2147483647,
  "warmup_ratio": 0.1,
  "lora_r": 2147483647,
  "lora_alpha": 2147483647,
  "lora_dropout": 0.1,
  "weight_decay": 0.1,
  "gradient_accumulation": 2147483647,
  "use_peft": true,
  "use_fp16": true,
  "use_int4": true,
  "push_to_hub": true,
  "repo_id": "string",
  "preprocess_dataset": true,
  "prompt_column": "string",
  "response_column": "string",
  "prompt_prefix": "string",
  "prompt_suffix": "string",
  "response_prefix": "string",
  "response_suffix": "string",
  "error_log": "string",
  "date_created": "2019-08-24T14:15:22Z",
  "last_modified": "2019-08-24T14:15:22Z",
  "platform": 0
}

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com