Delete a family
Delete a family. One no model ever joined goes, and its name is free again. A model
that failed its gate never joined. Otherwise every model of its line goes with it,
discarded ones included, and you can’t bring them back. Its name is never given again,
and calls to it, and reads and changes of it, get 410 family_deleted. Its dataset and
its fine-tunes, with their charges, stay. 409 family_answers while it or one of its
models answers calls, naming them: switch them off first. 409 family_training while one
of its fine-tunes is queued or running, and 409 version_in_use while an evaluation
scores one of its models. With dataset_id, the dataset the family grew on when the
caller looked, only while it still does, and with latest, the id of its latest model
the caller saw, only while it still is: 409 family_changed otherwise. Deleting a family
a model joined again changes nothing; an empty one is gone, so it gets 404 not_found.
curl --request DELETE \
--url https://console.sqwish.ai/v1/families/{family} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataset_id": "<string>",
"latest": "<string>"
}
'import requests
url = "https://console.sqwish.ai/v1/families/{family}"
payload = {
"dataset_id": "<string>",
"latest": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({dataset_id: '<string>', latest: '<string>'})
};
fetch('https://console.sqwish.ai/v1/families/{family}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "family",
"deleted": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}Authorizations
Create an API key in the console. Required when accounts are enabled.
Path Parameters
Body
The dataset the family grew on when the caller looked: refused with family_changed unless it still does, as a family deleted and named again on another dataset doesn't.
140The id of the family's latest model the caller saw, or null for none: refused with family_changed if it has another since, as when a model joined it, so a delete never takes a model the caller didn't see.
140curl --request DELETE \
--url https://console.sqwish.ai/v1/families/{family} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"dataset_id": "<string>",
"latest": "<string>"
}
'import requests
url = "https://console.sqwish.ai/v1/families/{family}"
payload = {
"dataset_id": "<string>",
"latest": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({dataset_id: '<string>', latest: '<string>'})
};
fetch('https://console.sqwish.ai/v1/families/{family}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "<string>",
"object": "family",
"deleted": true
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"details": [
{
"path": [
"<string>"
],
"message": "<string>",
"type": "<string>"
}
]
}
}