Skip to content

OrcaAPI 0.1.0#

API for accessing memorysets and models in the OrcaCloud

default#

GET /#

Healthcheck

Response 200 OK

Schema of the response body 
1

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /gpu/#

Healthcheck

Response 200 OK

Schema of the response body 
1

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

auth#

GET /auth/api_key#

List Api Keys

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
    {
        "id": "string",
        "org_id": "string",
        "name": "string",
        "created_by": null,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/ApiKeyMetadata"
    },
    "type": "array",
    "title": "Response List Api Keys Auth Api Key Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /auth/api_key#

Create Api Key

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

1
2
3
4
5
{
    "id": "string",
    "name": "string",
    "created_by": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name",
            "default": "default"
        },
        "created_by": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Created By"
        }
    },
    "type": "object",
    "title": "CreateApiKeyRequest"
}

Response 201 Created 

1
2
3
4
5
6
7
8
9
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "created_by": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "api_key": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "created_by": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Created By"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "api_key": {
            "type": "string",
            "title": "Api Key"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "created_by",
        "created_at",
        "updated_at",
        "api_key"
    ],
    "title": "CreateApiKeyResponse"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 403 Forbidden 

1
2
3
4
{
    "status_code": 0,
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 403,
            "title": "Status Code"
        },
        "reason": {
            "type": "string",
            "title": "Reason"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "reason"
    ],
    "title": "_UnauthorizedErrorResponse"
}

DELETE /auth/api_key/{name_or_id}#

Delete Api Key

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 403 Forbidden 

1
2
3
4
{
    "status_code": 0,
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 403,
            "title": "Status Code"
        },
        "reason": {
            "type": "string",
            "title": "Reason"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "reason"
    ],
    "title": "_UnauthorizedErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /auth/#

Check Authentication

Description

Returns true if the api key header is valid for the org (will be false for admin api key)

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

1
true
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
{
    "type": "boolean",
    "const": true,
    "title": "Response Check Authentication Auth  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

DELETE /auth/org/#

Delete Org

Description

Deletes the org and all associated resources

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 403 Forbidden 

1
2
3
4
{
    "status_code": 0,
    "reason": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 403,
            "title": "Status Code"
        },
        "reason": {
            "type": "string",
            "title": "Reason"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "reason"
    ],
    "title": "_UnauthorizedErrorResponse"
}

memoryset#

GET /memoryset/#

List Memorysets

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
    {
        "id": "string",
        "org_id": "string",
        "collection_name": "string",
        "name": "string",
        "length": 0,
        "pretrained_embedding_model_name": null,
        "finetuned_embedding_model_id": null,
        "label_names": [
            "string"
        ],
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "insertion_task_id": "string",
        "insertion_status": "INITIALIZED"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/LabeledMemorysetMetadata"
    },
    "type": "array",
    "title": "Response List Memorysets Memoryset  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /memoryset/#

Create Memoryset

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "name": "string",
    "datasource_id": null,
    "datasource_name": null,
    "datasource_label_column": "string",
    "datasource_value_column": "string",
    "datasource_source_id_column": null,
    "pretrained_embedding_model_name": null,
    "finetuned_embedding_model_id": null,
    "finetuned_embedding_model_name": null,
    "max_seq_length_override": null,
    "label_names": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
{
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "datasource_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Datasource Id"
        },
        "datasource_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Datasource Name"
        },
        "datasource_label_column": {
            "type": "string",
            "title": "Datasource Label Column"
        },
        "datasource_value_column": {
            "type": "string",
            "title": "Datasource Value Column"
        },
        "datasource_source_id_column": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Datasource Source Id Column"
        },
        "pretrained_embedding_model_name": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
                },
                {
                    "type": "null"
                }
            ]
        },
        "finetuned_embedding_model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Id"
        },
        "finetuned_embedding_model_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Name"
        },
        "max_seq_length_override": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Seq Length Override"
        },
        "label_names": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Label Names",
            "default": []
        }
    },
    "type": "object",
    "required": [
        "name",
        "datasource_label_column",
        "datasource_value_column"
    ],
    "title": "CreateLabeledMemorysetRequest"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "collection_name": "string",
    "name": "string",
    "length": 0,
    "pretrained_embedding_model_name": null,
    "finetuned_embedding_model_id": null,
    "label_names": [
        "string"
    ],
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "insertion_task_id": "string",
    "insertion_status": "INITIALIZED"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "collection_name": {
            "type": "string",
            "pattern": "^[a-z_]+[a-z0-9_]+$",
            "title": "Collection Name"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "length": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Length"
        },
        "pretrained_embedding_model_name": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
                },
                {
                    "type": "null"
                }
            ]
        },
        "finetuned_embedding_model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Id"
        },
        "label_names": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Label Names"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "insertion_task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Insertion Task Id"
        },
        "insertion_status": {
            "$ref": "#/components/schemas/TaskStatus"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "collection_name",
        "name",
        "length",
        "pretrained_embedding_model_name",
        "finetuned_embedding_model_id",
        "label_names",
        "created_at",
        "updated_at",
        "insertion_task_id",
        "insertion_status"
    ],
    "title": "LabeledMemorysetMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /memoryset/{name_or_id}/clone#

Clone Memoryset

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
6
{
    "name": "string",
    "pretrained_embedding_model_name": null,
    "finetuned_embedding_model_id": null,
    "max_seq_length_override": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "pretrained_embedding_model_name": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
                },
                {
                    "type": "null"
                }
            ]
        },
        "finetuned_embedding_model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Id"
        },
        "max_seq_length_override": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Seq Length Override"
        }
    },
    "type": "object",
    "required": [
        "name"
    ],
    "title": "CloneLabeledMemorysetRequest"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "collection_name": "string",
    "name": "string",
    "length": 0,
    "pretrained_embedding_model_name": null,
    "finetuned_embedding_model_id": null,
    "label_names": [
        "string"
    ],
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "insertion_task_id": "string",
    "insertion_status": "INITIALIZED"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "collection_name": {
            "type": "string",
            "pattern": "^[a-z_]+[a-z0-9_]+$",
            "title": "Collection Name"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "length": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Length"
        },
        "pretrained_embedding_model_name": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
                },
                {
                    "type": "null"
                }
            ]
        },
        "finetuned_embedding_model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Id"
        },
        "label_names": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Label Names"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "insertion_task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Insertion Task Id"
        },
        "insertion_status": {
            "$ref": "#/components/schemas/TaskStatus"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "collection_name",
        "name",
        "length",
        "pretrained_embedding_model_name",
        "finetuned_embedding_model_id",
        "label_names",
        "created_at",
        "updated_at",
        "insertion_task_id",
        "insertion_status"
    ],
    "title": "LabeledMemorysetMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /memoryset/{name_or_id}#

Get Memoryset

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "collection_name": "string",
    "name": "string",
    "length": 0,
    "pretrained_embedding_model_name": null,
    "finetuned_embedding_model_id": null,
    "label_names": [
        "string"
    ],
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "insertion_task_id": "string",
    "insertion_status": "INITIALIZED"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "collection_name": {
            "type": "string",
            "pattern": "^[a-z_]+[a-z0-9_]+$",
            "title": "Collection Name"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "length": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Length"
        },
        "pretrained_embedding_model_name": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
                },
                {
                    "type": "null"
                }
            ]
        },
        "finetuned_embedding_model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Finetuned Embedding Model Id"
        },
        "label_names": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Label Names"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "insertion_task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Insertion Task Id"
        },
        "insertion_status": {
            "$ref": "#/components/schemas/TaskStatus"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "collection_name",
        "name",
        "length",
        "pretrained_embedding_model_name",
        "finetuned_embedding_model_id",
        "label_names",
        "created_at",
        "updated_at",
        "insertion_task_id",
        "insertion_status"
    ],
    "title": "LabeledMemorysetMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /memoryset/{name_or_id}#

Delete Memoryset

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

GET /memoryset/{name_or_id}/memory/{memory_id}#

Get Memory

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
memory_id path string No ID of the memory
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "value": null,
    "embedding": [
        10.12
    ],
    "label": 0,
    "label_name": null,
    "source_id": null,
    "metadata": {},
    "memory_id": "string",
    "memory_version": 0,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "metrics": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
    "properties": {
        "value": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "string",
                    "format": "base64-image",
                    "contentEncoding": "base64",
                    "contentMediaType": "image"
                }
            ],
            "title": "Value"
        },
        "embedding": {
            "items": {
                "type": "number"
            },
            "type": "array",
            "title": "Embedding"
        },
        "label": {
            "type": "integer",
            "title": "Label"
        },
        "label_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Label Name"
        },
        "source_id": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Source Id"
        },
        "metadata": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "integer"
                    },
                    {
                        "type": "number"
                    },
                    {
                        "type": "boolean"
                    },
                    {
                        "type": "null"
                    }
                ]
            },
            "type": "object",
            "title": "Metadata"
        },
        "memory_id": {
            "type": "string",
            "format": "uuid7",
            "title": "Memory Id"
        },
        "memory_version": {
            "type": "integer",
            "title": "Memory Version"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "metrics": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/LabeledMemoryMetrics"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "type": "object",
    "required": [
        "value",
        "embedding",
        "label",
        "label_name",
        "source_id",
        "metadata",
        "memory_id",
        "memory_version",
        "created_at",
        "updated_at",
        "metrics"
    ],
    "title": "LabeledMemory",
    "description": "A labeled memory is a single item that can be stored in the database and has a label."
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /memoryset/{name_or_id}/memory/{memory_id}#

Delete Memory

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
memory_id path string No ID of the memory
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /memoryset/{name_or_id}/memories/get#

Get Memories

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
{
    "memory_ids": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    "properties": {
        "memory_ids": {
            "items": {
                "type": "string",
                "format": "uuid7"
            },
            "type": "array",
            "title": "Memory Ids"
        }
    },
    "type": "object",
    "required": [
        "memory_ids"
    ],
    "title": "GetMemoriesRequest"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
[
    {
        "value": null,
        "embedding": [
            10.12
        ],
        "label": 0,
        "label_name": null,
        "source_id": null,
        "metadata": {},
        "memory_id": "string",
        "memory_version": 0,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "metrics": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabeledMemory"
    },
    "title": "Response Get Memories Memoryset  Name Or Id  Memories Get Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /memoryset/{name_or_id}/memories#

Query Memoryset

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "offset": 0,
    "limit": 0,
    "filters": [
        {
            "field": null,
            "op": "==",
            "value": null
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "properties": {
        "offset": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Offset",
            "default": 0
        },
        "limit": {
            "type": "integer",
            "minimum": 1.0,
            "title": "Limit",
            "default": 100
        },
        "filters": {
            "items": {
                "$ref": "#/components/schemas/FilterItem"
            },
            "type": "array",
            "title": "Filters",
            "default": []
        }
    },
    "type": "object",
    "title": "ListMemoriesRequest"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
[
    {
        "value": null,
        "embedding": [
            10.12
        ],
        "label": 0,
        "label_name": null,
        "source_id": null,
        "metadata": {},
        "memory_id": "string",
        "memory_version": 0,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "metrics": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabeledMemory"
    },
    "title": "Response Query Memoryset Memoryset  Name Or Id  Memories Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /memoryset/{name_or_id}/memories/delete#

Delete Memories

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
{
    "memory_ids": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    "properties": {
        "memory_ids": {
            "items": {
                "type": "string",
                "format": "uuid7"
            },
            "type": "array",
            "title": "Memory Ids"
        }
    },
    "type": "object",
    "required": [
        "memory_ids"
    ],
    "title": "DeleteMemoriesRequest"
}

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /memoryset/{name_or_id}/analysis#

Create Analysis

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
{
    "type": "ANALYZE_MEMORY_NEIGHBOR_LABELS",
    "neighbor_count": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "type": {
            "type": "string",
            "enum": [
                "ANALYZE_MEMORY_NEIGHBOR_LABELS",
                "ANALYZE_DUPLICATE_MEMORIES"
            ],
            "title": "Type"
        },
        "neighbor_count": {
            "type": "integer",
            "title": "Neighbor Count",
            "default": 10
        }
    },
    "type": "object",
    "required": [
        "type"
    ],
    "title": "MemorysetAnalysisRequest"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "task_id": "string",
    "org_id": "string",
    "memoryset_id": "string",
    "type": "ANALYZE_MEMORY_NEIGHBOR_LABELS",
    "status": "INITIALIZED",
    "config": {},
    "result": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
    "properties": {
        "task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Task Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "memoryset_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Memoryset Id"
        },
        "type": {
            "type": "string",
            "enum": [
                "ANALYZE_MEMORY_NEIGHBOR_LABELS",
                "ANALYZE_DUPLICATE_MEMORIES"
            ],
            "title": "Type"
        },
        "status": {
            "$ref": "#/components/schemas/TaskStatus"
        },
        "config": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "type": "integer"
                    },
                    {
                        "type": "string"
                    },
                    {
                        "type": "number"
                    }
                ]
            },
            "type": "object",
            "title": "Config"
        },
        "result": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalyzeNeighborLabelsResult"
                },
                {
                    "$ref": "#/components/schemas/FindDuplicatesAnalysisResult"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Result"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "task_id",
        "org_id",
        "memoryset_id",
        "type",
        "status",
        "config",
        "result",
        "created_at",
        "updated_at"
    ],
    "title": "MemorysetAnalysisResponse"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

GET /memoryset/{name_or_id}/analysis#

List Analyses

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
limit query None 100 No
name_or_id path string No
offset query None 0 No
status query None No
type query None No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
[
    {
        "task_id": "string",
        "org_id": "string",
        "memoryset_id": "string",
        "type": "ANALYZE_MEMORY_NEIGHBOR_LABELS",
        "status": "INITIALIZED",
        "config": {},
        "result": null,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/MemorysetAnalysisResponse"
    },
    "title": "Response List Analyses Memoryset  Name Or Id  Analysis Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /memoryset/{name_or_id}/analysis/{analysis_task_id}#

Get Analysis

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
analysis_task_id path string No
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
    "task_id": "string",
    "org_id": "string",
    "memoryset_id": "string",
    "type": "ANALYZE_MEMORY_NEIGHBOR_LABELS",
    "status": "INITIALIZED",
    "config": {},
    "result": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
    "properties": {
        "task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Task Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "memoryset_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Memoryset Id"
        },
        "type": {
            "type": "string",
            "enum": [
                "ANALYZE_MEMORY_NEIGHBOR_LABELS",
                "ANALYZE_DUPLICATE_MEMORIES"
            ],
            "title": "Type"
        },
        "status": {
            "$ref": "#/components/schemas/TaskStatus"
        },
        "config": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "type": "integer"
                    },
                    {
                        "type": "string"
                    },
                    {
                        "type": "number"
                    }
                ]
            },
            "type": "object",
            "title": "Config"
        },
        "result": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/AnalyzeNeighborLabelsResult"
                },
                {
                    "$ref": "#/components/schemas/FindDuplicatesAnalysisResult"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Result"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "task_id",
        "org_id",
        "memoryset_id",
        "type",
        "status",
        "config",
        "result",
        "created_at",
        "updated_at"
    ],
    "title": "MemorysetAnalysisResponse"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /gpu/memoryset/{name_or_id}/lookup#

Memoryset Lookup

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
6
{
    "query": [
        "string"
    ],
    "count": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
{
    "properties": {
        "query": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "title": "Query"
        },
        "count": {
            "type": "integer",
            "title": "Count",
            "default": 1
        }
    },
    "type": "object",
    "required": [
        "query"
    ],
    "title": "LookupRequest"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
[
    [
        {
            "value": null,
            "embedding": [
                10.12
            ],
            "label": 0,
            "label_name": null,
            "source_id": null,
            "metadata": {},
            "memory_id": "string",
            "memory_version": 0,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z",
            "metrics": null,
            "lookup_score": 10.12,
            "reranker_score": null,
            "reranker_embedding": null
        }
    ]
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "type": "array",
    "items": {
        "type": "array",
        "items": {
            "$ref": "#/components/schemas/LabeledMemoryLookup"
        }
    },
    "title": "Response Memoryset Lookup Gpu Memoryset  Name Or Id  Lookup Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

PATCH /gpu/memoryset/{name_or_id}/memory#

Update Memory

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
6
7
8
{
    "memory_id": "string",
    "value": null,
    "label": 0,
    "metadata": null,
    "source_id": null,
    "metrics": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
{
    "properties": {
        "memory_id": {
            "type": "string",
            "format": "uuid7",
            "title": "Memory Id"
        },
        "value": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "string",
                    "format": "base64-image",
                    "contentEncoding": "base64",
                    "contentMediaType": "image"
                }
            ],
            "title": "Value"
        },
        "label": {
            "type": "integer",
            "title": "Label"
        },
        "metadata": {
            "anyOf": [
                {
                    "additionalProperties": {
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "integer"
                            },
                            {
                                "type": "number"
                            },
                            {
                                "type": "boolean"
                            },
                            {
                                "type": "null"
                            }
                        ]
                    },
                    "type": "object"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Metadata"
        },
        "source_id": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Source Id"
        },
        "metrics": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/LabeledMemoryMetrics"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "additionalProperties": false,
    "type": "object",
    "required": [
        "memory_id"
    ],
    "title": "LabeledMemoryUpdate",
    "description": "Model for updating a labeled memory (unset fields are kept as is)"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
    "value": null,
    "embedding": [
        10.12
    ],
    "label": 0,
    "label_name": null,
    "source_id": null,
    "metadata": {},
    "memory_id": "string",
    "memory_version": 0,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "metrics": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
{
    "properties": {
        "value": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "string",
                    "format": "base64-image",
                    "contentEncoding": "base64",
                    "contentMediaType": "image"
                }
            ],
            "title": "Value"
        },
        "embedding": {
            "items": {
                "type": "number"
            },
            "type": "array",
            "title": "Embedding"
        },
        "label": {
            "type": "integer",
            "title": "Label"
        },
        "label_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Label Name"
        },
        "source_id": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Source Id"
        },
        "metadata": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "integer"
                    },
                    {
                        "type": "number"
                    },
                    {
                        "type": "boolean"
                    },
                    {
                        "type": "null"
                    }
                ]
            },
            "type": "object",
            "title": "Metadata"
        },
        "memory_id": {
            "type": "string",
            "format": "uuid7",
            "title": "Memory Id"
        },
        "memory_version": {
            "type": "integer",
            "title": "Memory Version"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "metrics": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/LabeledMemoryMetrics"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "type": "object",
    "required": [
        "value",
        "embedding",
        "label",
        "label_name",
        "source_id",
        "metadata",
        "memory_id",
        "memory_version",
        "created_at",
        "updated_at",
        "metrics"
    ],
    "title": "LabeledMemory",
    "description": "A labeled memory is a single item that can be stored in the database and has a label."
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /gpu/memoryset/{name_or_id}/memory#

Insert Memories

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
6
7
8
[
    {
        "value": null,
        "label": 0,
        "metadata": {},
        "source_id": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabeledMemoryInsert"
    },
    "title": "Memories"
}

Response 201 Created

Schema of the response body 
1

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

PATCH /gpu/memoryset/{name_or_id}/memories#

Update Memories

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
    {
        "memory_id": "string",
        "value": null,
        "label": 0,
        "metadata": null,
        "source_id": null,
        "metrics": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabeledMemoryUpdate"
    },
    "title": "Updates"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
[
    {
        "value": null,
        "embedding": [
            10.12
        ],
        "label": 0,
        "label_name": null,
        "source_id": null,
        "metadata": {},
        "memory_id": "string",
        "memory_version": 0,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "metrics": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabeledMemory"
    },
    "title": "Response Update Memories Gpu Memoryset  Name Or Id  Memories Patch"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

finetuned-embedding-model#

GET /finetuned_embedding_model/#

List Finetuned Embedding Models

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
    {
        "embedding_dim": 0,
        "max_seq_length": 0,
        "uses_context": true,
        "id": "string",
        "org_id": "string",
        "name": "string",
        "storage_path": "string",
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "base_model": "CLIP_BASE",
        "finetuning_task_id": "string",
        "finetuning_status": "INITIALIZED"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/FinetunedEmbeddingModelMetadata"
    },
    "type": "array",
    "title": "Response List Finetuned Embedding Models Finetuned Embedding Model  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /finetuned_embedding_model/#

Create Finetuned Embedding Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "name": "string",
    "base_model": "CLIP_BASE",
    "train_memoryset_id": null,
    "train_memoryset_name": null,
    "train_datasource_id": null,
    "train_datasource_name": null,
    "eval_datasource_id": null,
    "eval_datasource_name": null,
    "label_column": "string",
    "value_column": "string",
    "training_method": "classification",
    "training_args": {}
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
{
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "base_model": {
            "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
        },
        "train_memoryset_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Train Memoryset Id"
        },
        "train_memoryset_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Train Memoryset Name"
        },
        "train_datasource_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Train Datasource Id"
        },
        "train_datasource_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Train Datasource Name"
        },
        "eval_datasource_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Eval Datasource Id"
        },
        "eval_datasource_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Eval Datasource Name"
        },
        "label_column": {
            "type": "string",
            "title": "Label Column",
            "default": "label"
        },
        "value_column": {
            "type": "string",
            "title": "Value Column",
            "default": "value"
        },
        "training_method": {
            "$ref": "#/components/schemas/EmbeddingFinetuningMethod",
            "default": "classification"
        },
        "training_args": {
            "additionalProperties": {
                "anyOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "integer"
                    },
                    {
                        "type": "number"
                    },
                    {
                        "type": "boolean"
                    }
                ]
            },
            "type": "object",
            "title": "Training Args",
            "default": {}
        }
    },
    "type": "object",
    "required": [
        "name",
        "base_model"
    ],
    "title": "FinetuneEmbeddingModelRequest"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "embedding_dim": 0,
    "max_seq_length": 0,
    "uses_context": true,
    "id": "string",
    "org_id": "string",
    "name": "string",
    "storage_path": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "base_model": "CLIP_BASE",
    "finetuning_task_id": "string",
    "finetuning_status": "INITIALIZED"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
    "properties": {
        "embedding_dim": {
            "type": "integer",
            "title": "Embedding Dim"
        },
        "max_seq_length": {
            "type": "integer",
            "title": "Max Seq Length"
        },
        "uses_context": {
            "type": "boolean",
            "title": "Uses Context"
        },
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "base_model": {
            "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
        },
        "finetuning_task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Finetuning Task Id"
        },
        "finetuning_status": {
            "$ref": "#/components/schemas/TaskStatus"
        }
    },
    "type": "object",
    "required": [
        "embedding_dim",
        "max_seq_length",
        "uses_context",
        "id",
        "org_id",
        "name",
        "storage_path",
        "created_at",
        "updated_at",
        "base_model",
        "finetuning_task_id",
        "finetuning_status"
    ],
    "title": "FinetunedEmbeddingModelMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /finetuned_embedding_model/{name_or_id}#

Get Finetuned Embedding Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "embedding_dim": 0,
    "max_seq_length": 0,
    "uses_context": true,
    "id": "string",
    "org_id": "string",
    "name": "string",
    "storage_path": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "base_model": "CLIP_BASE",
    "finetuning_task_id": "string",
    "finetuning_status": "INITIALIZED"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
    "properties": {
        "embedding_dim": {
            "type": "integer",
            "title": "Embedding Dim"
        },
        "max_seq_length": {
            "type": "integer",
            "title": "Max Seq Length"
        },
        "uses_context": {
            "type": "boolean",
            "title": "Uses Context"
        },
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "base_model": {
            "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
        },
        "finetuning_task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Finetuning Task Id"
        },
        "finetuning_status": {
            "$ref": "#/components/schemas/TaskStatus"
        }
    },
    "type": "object",
    "required": [
        "embedding_dim",
        "max_seq_length",
        "uses_context",
        "id",
        "org_id",
        "name",
        "storage_path",
        "created_at",
        "updated_at",
        "base_model",
        "finetuning_task_id",
        "finetuning_status"
    ],
    "title": "FinetunedEmbeddingModelMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /finetuned_embedding_model/{name_or_id}#

Delete Finetuned Embedding Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

POST /gpu/finetuned_embedding_model/{name_or_id}/embedding#

Embed With Finetuned Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
{
    "values": null,
    "max_seq_length": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
    "properties": {
        "values": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "type": "string",
                        "format": "base64-image",
                        "contentEncoding": "base64",
                        "contentMediaType": "image"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "string",
                                "format": "base64-image",
                                "contentEncoding": "base64",
                                "contentMediaType": "image"
                            }
                        ]
                    },
                    "type": "array"
                }
            ],
            "title": "Values"
        },
        "max_seq_length": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Seq Length"
        }
    },
    "type": "object",
    "required": [
        "values"
    ],
    "title": "EmbedRequest"
}

Response 200 OK 

1
2
3
4
5
[
    [
        10.12
    ]
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "type": "array",
    "items": {
        "type": "array",
        "items": {
            "type": "number"
        }
    },
    "title": "Response Embed With Finetuned Model Gpu Finetuned Embedding Model  Name Or Id  Embedding Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

pretrained-embedding-model#

GET /pretrained_embedding_model/#

List Pretrained Embedding Models

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

1
2
3
4
5
6
7
8
[
    {
        "embedding_dim": 0,
        "max_seq_length": 0,
        "uses_context": true,
        "name": "CLIP_BASE"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/PretrainedEmbeddingModelMetadata"
    },
    "type": "array",
    "title": "Response List Pretrained Embedding Models Pretrained Embedding Model  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /pretrained_embedding_model/{model_name}#

Get Pretrained Embedding Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name path None No

Response 200 OK 

1
2
3
4
5
6
{
    "embedding_dim": 0,
    "max_seq_length": 0,
    "uses_context": true,
    "name": "CLIP_BASE"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
    "properties": {
        "embedding_dim": {
            "type": "integer",
            "title": "Embedding Dim"
        },
        "max_seq_length": {
            "type": "integer",
            "title": "Max Seq Length"
        },
        "uses_context": {
            "type": "boolean",
            "title": "Uses Context"
        },
        "name": {
            "$ref": "#/components/schemas/PretrainedEmbeddingModelName"
        }
    },
    "type": "object",
    "required": [
        "embedding_dim",
        "max_seq_length",
        "uses_context",
        "name"
    ],
    "title": "PretrainedEmbeddingModelMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /gpu/pretrained_embedding_model/{model_name}/embedding#

Embed With Pretrained Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name path None No

Request body

1
2
3
4
{
    "values": null,
    "max_seq_length": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
{
    "properties": {
        "values": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "type": "string",
                        "format": "base64-image",
                        "contentEncoding": "base64",
                        "contentMediaType": "image"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "string",
                                "format": "base64-image",
                                "contentEncoding": "base64",
                                "contentMediaType": "image"
                            }
                        ]
                    },
                    "type": "array"
                }
            ],
            "title": "Values"
        },
        "max_seq_length": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Max Seq Length"
        }
    },
    "type": "object",
    "required": [
        "values"
    ],
    "title": "EmbedRequest"
}

Response 200 OK 

1
2
3
4
5
[
    [
        10.12
    ]
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "type": "array",
    "items": {
        "type": "array",
        "items": {
            "type": "number"
        }
    },
    "title": "Response Embed With Pretrained Model Gpu Pretrained Embedding Model  Model Name  Embedding Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

datasource#

GET /datasource/#

List Datasources

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
    {
        "id": "string",
        "org_id": "string",
        "name": "string",
        "storage_path": "string",
        "length": 0,
        "columns": [
            {
                "name": "string",
                "type": "STRING",
                "enum_options": null
            }
        ],
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/DatasourceMetadata"
    },
    "type": "array",
    "title": "Response List Datasources Datasource  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /datasource/#

Create Datasource

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

1
2
3
4
5
{
    "files": null,
    "name": "string",
    "content": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
    "properties": {
        "files": {
            "anyOf": [
                {
                    "items": {
                        "type": "string",
                        "format": "binary"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Files"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "content": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Content"
        }
    },
    "type": "object",
    "required": [
        "name"
    ],
    "title": "Body_create_datasource_datasource__post"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "storage_path": "string",
    "length": 0,
    "columns": [
        {
            "name": "string",
            "type": "STRING",
            "enum_options": null
        }
    ],
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "length": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Length"
        },
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "storage_path",
        "length",
        "columns",
        "created_at",
        "updated_at"
    ],
    "title": "DatasourceMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /datasource/{name_or_id}#

Get Datasource

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "storage_path": "string",
    "length": 0,
    "columns": [
        {
            "name": "string",
            "type": "STRING",
            "enum_options": null
        }
    ],
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "length": {
            "type": "integer",
            "minimum": 0.0,
            "title": "Length"
        },
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "storage_path",
        "length",
        "columns",
        "created_at",
        "updated_at"
    ],
    "title": "DatasourceMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /datasource/{name_or_id}#

Delete Datasource

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

classification_model#

GET /classification_model/#

List Models

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
[
    {
        "id": "string",
        "org_id": "string",
        "name": "string",
        "version": 0,
        "num_classes": 0,
        "head_type": "KNN",
        "memoryset_id": "string",
        "memory_lookup_count": 0,
        "weigh_memories": null,
        "min_memory_weight": null,
        "storage_path": "string",
        "memoryset_collection_name": "string",
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/RACModelMetadata"
    },
    "type": "array",
    "title": "Response List Models Classification Model  Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

POST /classification_model/#

Create Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "name": "string",
    "memoryset_id": null,
    "memoryset_name": null,
    "head_type": "KNN",
    "weigh_memories": null,
    "min_memory_weight": null,
    "memory_lookup_count": null,
    "num_classes": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
    "properties": {
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "memoryset_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Memoryset Id"
        },
        "memoryset_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Memoryset Name"
        },
        "head_type": {
            "$ref": "#/components/schemas/RACHeadType",
            "default": "KNN"
        },
        "weigh_memories": {
            "anyOf": [
                {
                    "type": "boolean"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Weigh Memories"
        },
        "min_memory_weight": {
            "anyOf": [
                {
                    "type": "number"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Min Memory Weight"
        },
        "memory_lookup_count": {
            "anyOf": [
                {
                    "type": "integer",
                    "exclusiveMinimum": 0.0
                },
                {
                    "type": "null"
                }
            ],
            "title": "Memory Lookup Count"
        },
        "num_classes": {
            "anyOf": [
                {
                    "type": "integer",
                    "exclusiveMinimum": 0.0
                },
                {
                    "type": "null"
                }
            ],
            "title": "Num Classes"
        }
    },
    "type": "object",
    "required": [
        "name"
    ],
    "title": "CreateRACModelRequest"
}

Response 201 Created 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "version": 0,
    "num_classes": 0,
    "head_type": "KNN",
    "memoryset_id": "string",
    "memory_lookup_count": 0,
    "weigh_memories": null,
    "min_memory_weight": null,
    "storage_path": "string",
    "memoryset_collection_name": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "version": {
            "type": "integer",
            "title": "Version"
        },
        "num_classes": {
            "type": "integer",
            "exclusiveMinimum": 0.0,
            "title": "Num Classes"
        },
        "head_type": {
            "$ref": "#/components/schemas/RACHeadType"
        },
        "memoryset_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Memoryset Id"
        },
        "memory_lookup_count": {
            "type": "integer",
            "exclusiveMinimum": 0.0,
            "title": "Memory Lookup Count"
        },
        "weigh_memories": {
            "anyOf": [
                {
                    "type": "boolean"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Weigh Memories"
        },
        "min_memory_weight": {
            "anyOf": [
                {
                    "type": "number"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Min Memory Weight"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "memoryset_collection_name": {
            "type": "string",
            "pattern": "^[a-z_]+[a-z0-9_]+$",
            "title": "Memoryset Collection Name"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "version",
        "num_classes",
        "head_type",
        "memoryset_id",
        "memory_lookup_count",
        "weigh_memories",
        "min_memory_weight",
        "storage_path",
        "memoryset_collection_name",
        "created_at",
        "updated_at"
    ],
    "title": "RACModelMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

GET /classification_model/{name_or_id}#

Get Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "version": 0,
    "num_classes": 0,
    "head_type": "KNN",
    "memoryset_id": "string",
    "memory_lookup_count": 0,
    "weigh_memories": null,
    "min_memory_weight": null,
    "storage_path": "string",
    "memoryset_collection_name": "string",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "version": {
            "type": "integer",
            "title": "Version"
        },
        "num_classes": {
            "type": "integer",
            "exclusiveMinimum": 0.0,
            "title": "Num Classes"
        },
        "head_type": {
            "$ref": "#/components/schemas/RACHeadType"
        },
        "memoryset_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Memoryset Id"
        },
        "memory_lookup_count": {
            "type": "integer",
            "exclusiveMinimum": 0.0,
            "title": "Memory Lookup Count"
        },
        "weigh_memories": {
            "anyOf": [
                {
                    "type": "boolean"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Weigh Memories"
        },
        "min_memory_weight": {
            "anyOf": [
                {
                    "type": "number"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Min Memory Weight"
        },
        "storage_path": {
            "type": "string",
            "pattern": "^[a-z0-9]+://[a-z0-9\\-]{3,63}/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/(?:[a-zA-Z0-9_]+/)?[a-zA-Z0-9_]+$",
            "title": "Storage Path"
        },
        "memoryset_collection_name": {
            "type": "string",
            "pattern": "^[a-z_]+[a-z0-9_]+$",
            "title": "Memoryset Collection Name"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "version",
        "num_classes",
        "head_type",
        "memoryset_id",
        "memory_lookup_count",
        "weigh_memories",
        "min_memory_weight",
        "storage_path",
        "memoryset_collection_name",
        "created_at",
        "updated_at"
    ],
    "title": "RACModelMetadata"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /classification_model/{name_or_id}#

Delete Model

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /classification_model/{model_name_or_id}/evaluation#

Create Evaluation

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name_or_id path string No

Request body

1
2
3
4
5
6
7
8
9
{
    "datasource_id": null,
    "datasource_name": null,
    "memoryset_override_id": null,
    "datasource_label_column": "string",
    "datasource_value_column": "string",
    "record_telemetry": true,
    "telemetry_tags": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
    "properties": {
        "datasource_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Datasource Id"
        },
        "datasource_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Datasource Name"
        },
        "memoryset_override_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Memoryset Override Id"
        },
        "datasource_label_column": {
            "type": "string",
            "title": "Datasource Label Column"
        },
        "datasource_value_column": {
            "type": "string",
            "title": "Datasource Value Column"
        },
        "record_telemetry": {
            "type": "boolean",
            "title": "Record Telemetry",
            "default": false
        },
        "telemetry_tags": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array",
                    "uniqueItems": true
                },
                {
                    "type": "null"
                }
            ],
            "title": "Telemetry Tags"
        }
    },
    "type": "object",
    "required": [
        "datasource_label_column",
        "datasource_value_column"
    ],
    "title": "EvaluationRequest"
}

Response 201 Created 

1
2
3
4
5
6
7
8
{
    "task_id": "string",
    "org_id": "string",
    "status": "INITIALIZED",
    "result": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
    "properties": {
        "task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Task Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "status": {
            "$ref": "#/components/schemas/TaskStatus"
        },
        "result": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ClassificationEvaluationResult"
                },
                {
                    "type": "null"
                }
            ]
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "task_id",
        "org_id",
        "status",
        "result",
        "created_at",
        "updated_at"
    ],
    "title": "EvaluationResponse"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

GET /classification_model/{model_name_or_id}/evaluation#

List Evaluations

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name_or_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
    {
        "task_id": "string",
        "org_id": "string",
        "status": "INITIALIZED",
        "result": null,
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/EvaluationResponse"
    },
    "title": "Response List Evaluations Classification Model  Model Name Or Id  Evaluation Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /classification_model/{model_name_or_id}/evaluation/{task_id}#

Get Evaluation

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name_or_id path string No
task_id path string No

Response 200 OK 

1
2
3
4
5
6
7
8
{
    "task_id": "string",
    "org_id": "string",
    "status": "INITIALIZED",
    "result": null,
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
    "properties": {
        "task_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Task Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "status": {
            "$ref": "#/components/schemas/TaskStatus"
        },
        "result": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/ClassificationEvaluationResult"
                },
                {
                    "type": "null"
                }
            ]
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "task_id",
        "org_id",
        "status",
        "result",
        "created_at",
        "updated_at"
    ],
    "title": "EvaluationResponse"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /classification_model/{model_name_or_id}/evaluation/{task_id}#

Delete Evaluation

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
model_name_or_id path string No
task_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

POST /gpu/classification_model/{name_or_id}/prediction#

Predict

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Request body

1
2
3
4
5
6
7
8
{
    "input_values": null,
    "expected_labels": null,
    "tags": [
        "string"
    ],
    "memoryset_override_id": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{
    "properties": {
        "input_values": {
            "anyOf": [
                {
                    "items": {
                        "type": "string"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "type": "string",
                        "format": "base64-image",
                        "contentEncoding": "base64",
                        "contentMediaType": "image"
                    },
                    "type": "array"
                },
                {
                    "items": {
                        "anyOf": [
                            {
                                "type": "string"
                            },
                            {
                                "type": "string",
                                "format": "base64-image",
                                "contentEncoding": "base64",
                                "contentMediaType": "image"
                            }
                        ]
                    },
                    "type": "array"
                }
            ],
            "title": "Input Values"
        },
        "expected_labels": {
            "anyOf": [
                {
                    "items": {
                        "type": "integer"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Expected Labels"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true,
            "title": "Tags",
            "default": []
        },
        "memoryset_override_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Memoryset Override Id"
        }
    },
    "type": "object",
    "required": [
        "input_values"
    ],
    "title": "PredictionRequest"
}

Response 200 OK 

1
2
3
4
5
6
7
8
[
    {
        "prediction_id": "string",
        "label": 0,
        "label_name": null,
        "confidence": 10.12
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LabelPredictionResult"
    },
    "title": "Response Predict Gpu Classification Model  Name Or Id  Prediction Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

Response 409 Conflict 

1
2
3
4
{
    "status_code": 0,
    "constraint": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 409,
            "title": "Status Code"
        },
        "constraint": {
            "type": "string",
            "title": "Constraint"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "constraint"
    ],
    "title": "_ConflictErrorResponse"
}

task#

GET /task/{task_id}/status#

Get Task Status

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
task_id path string No

Response 200 OK 

1
2
3
4
5
6
7
8
{
    "status": "INITIALIZED",
    "steps_total": null,
    "steps_completed": null,
    "exception": null,
    "updated_at": "2022-04-13T15:42:05.901Z",
    "created_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
{
    "properties": {
        "status": {
            "$ref": "#/components/schemas/TaskStatus"
        },
        "steps_total": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Steps Total"
        },
        "steps_completed": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Steps Completed"
        },
        "exception": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Exception"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        }
    },
    "type": "object",
    "required": [
        "status",
        "steps_total",
        "steps_completed",
        "exception",
        "updated_at",
        "created_at"
    ],
    "title": "TaskStatusInfo"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /task#

List Tasks

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
limit query integer 100 No
offset query integer 0 No
status query None No
type query None No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
[
    {
        "status": "INITIALIZED",
        "steps_total": null,
        "steps_completed": null,
        "exception": null,
        "updated_at": "2022-04-13T15:42:05.901Z",
        "created_at": "2022-04-13T15:42:05.901Z",
        "id": "string",
        "org_id": "string",
        "type": "string",
        "payload": {},
        "result": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/Task"
    },
    "title": "Response List Tasks Task Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /task/{task_id}/abort#

Abort Task

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
task_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

telemetry#

POST /telemetry/prediction#

List Predictions

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
    "model_id": null,
    "tag": null,
    "prediction_ids": null,
    "limit": null,
    "offset": null,
    "sort": [
        []
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
{
    "properties": {
        "model_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid4"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Model Id"
        },
        "tag": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Tag"
        },
        "prediction_ids": {
            "anyOf": [
                {
                    "items": {
                        "type": "string",
                        "format": "uuid4"
                    },
                    "type": "array"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prediction Ids"
        },
        "limit": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Limit"
        },
        "offset": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Offset",
            "default": 0
        },
        "sort": {
            "items": {
                "prefixItems": [
                    {
                        "type": "string",
                        "enum": [
                            "timestamp",
                            "confidence"
                        ]
                    },
                    {
                        "type": "string",
                        "enum": [
                            "asc",
                            "desc"
                        ]
                    }
                ],
                "type": "array",
                "maxItems": 2,
                "minItems": 2
            },
            "type": "array",
            "title": "Sort",
            "default": []
        }
    },
    "type": "object",
    "title": "ListPredictionsRequest"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
[
    {
        "prediction_id": "string",
        "label": 0,
        "label_name": null,
        "confidence": 10.12,
        "timestamp": "2022-04-13T15:42:05.901Z",
        "logits": [
            10.12
        ],
        "input_value": null,
        "input_embedding": [
            10.12
        ],
        "expected_label": null,
        "memories": [
            {
                "value": null,
                "embedding": [
                    10.12
                ],
                "label": 0,
                "label_name": null,
                "source_id": null,
                "metadata": {},
                "memory_id": "string",
                "memory_version": 0,
                "created_at": "2022-04-13T15:42:05.901Z",
                "updated_at": "2022-04-13T15:42:05.901Z",
                "metrics": null,
                "lookup_score": 10.12,
                "reranker_score": null,
                "reranker_embedding": null,
                "prediction_id": "string",
                "attention_weight": 10.12
            }
        ],
        "org_id": "string",
        "memoryset_id": "string",
        "model_id": "string",
        "updated_at": "2022-04-13T15:42:05.901Z",
        "tags": [
            "string"
        ],
        "feedbacks": [
            {
                "prediction_id": "string",
                "category_name": "string",
                "value": null,
                "comment": null,
                "id": "string",
                "org_id": "string",
                "category_id": "string",
                "category_type": "CONTINUOUS",
                "created_at": "2022-04-13T15:42:05.901Z",
                "updated_at": "2022-04-13T15:42:05.901Z"
            }
        ]
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/LabelPredictionWithMemoriesAndFeedback"
    },
    "type": "array",
    "title": "Response List Predictions Telemetry Prediction Post"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /telemetry/prediction/{prediction_id}#

Get Prediction

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
prediction_id path string No

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
    "prediction_id": "string",
    "label": 0,
    "label_name": null,
    "confidence": 10.12,
    "timestamp": "2022-04-13T15:42:05.901Z",
    "logits": [
        10.12
    ],
    "input_value": null,
    "input_embedding": [
        10.12
    ],
    "expected_label": null,
    "memories": [
        {
            "value": null,
            "embedding": [
                10.12
            ],
            "label": 0,
            "label_name": null,
            "source_id": null,
            "metadata": {},
            "memory_id": "string",
            "memory_version": 0,
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z",
            "metrics": null,
            "lookup_score": 10.12,
            "reranker_score": null,
            "reranker_embedding": null,
            "prediction_id": "string",
            "attention_weight": 10.12
        }
    ],
    "org_id": "string",
    "memoryset_id": "string",
    "model_id": "string",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "tags": [
        "string"
    ],
    "feedbacks": [
        {
            "prediction_id": "string",
            "category_name": "string",
            "value": null,
            "comment": null,
            "id": "string",
            "org_id": "string",
            "category_id": "string",
            "category_type": "CONTINUOUS",
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
    "properties": {
        "prediction_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Prediction Id"
        },
        "label": {
            "type": "integer",
            "title": "Label"
        },
        "label_name": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Label Name"
        },
        "confidence": {
            "type": "number",
            "title": "Confidence"
        },
        "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp"
        },
        "logits": {
            "items": {
                "type": "number"
            },
            "type": "array",
            "title": "Logits"
        },
        "input_value": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "string",
                    "format": "base64-image",
                    "contentEncoding": "base64",
                    "contentMediaType": "image"
                }
            ],
            "title": "Input Value"
        },
        "input_embedding": {
            "items": {
                "type": "number"
            },
            "type": "array",
            "title": "Input Embedding"
        },
        "expected_label": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Expected Label"
        },
        "memories": {
            "items": {
                "$ref": "#/components/schemas/LabelPredictionMemoryLookup"
            },
            "type": "array",
            "title": "Memories"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "memoryset_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Memoryset Id"
        },
        "model_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Model Id"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true,
            "title": "Tags"
        },
        "feedbacks": {
            "items": {
                "$ref": "#/components/schemas/PredictionFeedback"
            },
            "type": "array",
            "title": "Feedbacks"
        }
    },
    "type": "object",
    "required": [
        "prediction_id",
        "label",
        "label_name",
        "confidence",
        "timestamp",
        "logits",
        "input_value",
        "input_embedding",
        "expected_label",
        "memories",
        "org_id",
        "memoryset_id",
        "model_id",
        "updated_at",
        "tags",
        "feedbacks"
    ],
    "title": "LabelPredictionWithMemoriesAndFeedback"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

PATCH /telemetry/prediction/{prediction_id}#

Update Prediction

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
prediction_id path string No

Request body

1
2
3
4
5
6
{
    "expected_label": null,
    "tags": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "properties": {
        "expected_label": {
            "anyOf": [
                {
                    "type": "integer"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Expected Label"
        },
        "tags": {
            "items": {
                "type": "string"
            },
            "type": "array",
            "uniqueItems": true,
            "title": "Tags"
        }
    },
    "type": "object",
    "title": "UpdatePredictionRequest"
}

Response 200 OK

Schema of the response body 
1

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

GET /telemetry/feedback_category#

List Feedback Categories

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
[
    {
        "id": "string",
        "org_id": "string",
        "name": "string",
        "type": "CONTINUOUS",
        "created_at": "2022-04-13T15:42:05.901Z",
        "updated_at": "2022-04-13T15:42:05.901Z"
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/PredictionFeedbackCategory"
    },
    "type": "array",
    "title": "Response List Feedback Categories Telemetry Feedback Category Get"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

GET /telemetry/feedback_category/{name_or_id}#

Get Feedback Category

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 200 OK 

1
2
3
4
5
6
7
8
{
    "id": "string",
    "org_id": "string",
    "name": "string",
    "type": "CONTINUOUS",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
    "properties": {
        "id": {
            "type": "string",
            "format": "uuid4",
            "title": "Id"
        },
        "org_id": {
            "type": "string",
            "format": "uuid4",
            "title": "Org Id"
        },
        "name": {
            "type": "string",
            "pattern": "^[a-zA-Z0-9_\\-]+$",
            "title": "Name"
        },
        "type": {
            "$ref": "#/components/schemas/FeedbackType"
        },
        "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
        },
        "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "org_id",
        "name",
        "type",
        "created_at",
        "updated_at"
    ],
    "title": "PredictionFeedbackCategory"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

DELETE /telemetry/feedback_category/{name_or_id}#

Drop Feedback Category With Data

Description

Delete a feedback category and all associated feedback records.

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key
name_or_id path string No

Response 204 No Content

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Response 404 Not Found 

1
2
3
4
{
    "status_code": 0,
    "resource": null
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 404,
            "title": "Status Code"
        },
        "resource": {
            "anyOf": [
                {
                    "type": "string",
                    "enum": [
                        "org",
                        "api_key",
                        "datasource",
                        "memoryset",
                        "classification_model",
                        "prediction",
                        "memory",
                        "evaluation",
                        "analysis",
                        "task",
                        "pretrained_embedding_model",
                        "finetuned_embedding_model",
                        "feedback_category"
                    ]
                },
                {
                    "type": "null"
                }
            ],
            "title": "Resource"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "resource"
    ],
    "title": "_NotFoundErrorResponse"
}

PUT /telemetry/prediction/feedback#

Record Prediction Feedback

Input parameters

Parameter In Type Default Nullable Description
APIKeyHeader header string N/A No API key

Request body

1
2
3
4
5
6
7
8
[
    {
        "prediction_id": "string",
        "category_name": "string",
        "value": null,
        "comment": null
    }
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body 
1
2
3
4
5
6
7
{
    "items": {
        "$ref": "#/components/schemas/PredictionFeedbackRequest"
    },
    "type": "array",
    "title": "Prediction Feedback Requests"
}

Response 200 OK 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
    "prediction_ids": [
        "string"
    ],
    "deleted_feedback_ids": [
        "string"
    ],
    "updated_feedback_ids": [
        "string"
    ],
    "inserted_feedback_ids": [
        "string"
    ],
    "new_category_ids": [
        "string"
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
    "properties": {
        "prediction_ids": {
            "items": {
                "type": "string",
                "format": "uuid4"
            },
            "type": "array",
            "title": "Prediction Ids"
        },
        "deleted_feedback_ids": {
            "items": {
                "type": "string",
                "format": "uuid4"
            },
            "type": "array",
            "title": "Deleted Feedback Ids"
        },
        "updated_feedback_ids": {
            "items": {
                "type": "string",
                "format": "uuid4"
            },
            "type": "array",
            "title": "Updated Feedback Ids"
        },
        "inserted_feedback_ids": {
            "items": {
                "type": "string",
                "format": "uuid4"
            },
            "type": "array",
            "title": "Inserted Feedback Ids"
        },
        "new_category_ids": {
            "items": {
                "type": "string",
                "format": "uuid4"
            },
            "type": "array",
            "title": "New Category Ids"
        }
    },
    "type": "object",
    "required": [
        "prediction_ids",
        "deleted_feedback_ids",
        "updated_feedback_ids",
        "inserted_feedback_ids",
        "new_category_ids"
    ],
    "title": "PredictionFeedbackResult"
}

Response 401 Unauthorized 

1
2
3
{
    "status_code": 0
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 401,
            "title": "Status Code"
        }
    },
    "type": "object",
    "required": [
        "status_code"
    ],
    "title": "_UnauthenticatedErrorResponse"
}

Response 500 Internal Server Error 

1
2
3
4
{
    "status_code": 0,
    "message": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 500,
            "title": "Status Code"
        },
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "message"
    ],
    "title": "_InternalServerErrorResponse"
}

Response 503 Service Unavailable 

1
2
3
4
{
    "status_code": 0,
    "service": "string"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 503,
            "title": "Status Code"
        },
        "service": {
            "type": "string",
            "title": "Service"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "service"
    ],
    "title": "_ServiceUnavailableErrorResponse"
}

Response 422 Unprocessable Entity 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
    "status_code": 0,
    "validation_issues": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
    "properties": {
        "status_code": {
            "type": "integer",
            "const": 422,
            "title": "Status Code"
        },
        "validation_issues": {
            "items": {
                "$ref": "#/components/schemas/FieldValidationError"
            },
            "type": "array",
            "title": "Validation Issues"
        }
    },
    "type": "object",
    "required": [
        "status_code",
        "validation_issues"
    ],
    "title": "_UnprocessableInputErrorResponse"
}

Schemas#

_ConflictErrorResponse#

Name Type
constraint string
status_code integer

_InternalServerErrorResponse#

Name Type
message string
status_code integer

_NotFoundErrorResponse#

Name Type
resource
status_code integer

_ServiceUnavailableErrorResponse#

Name Type
service string
status_code integer

_UnauthenticatedErrorResponse#

Name Type
status_code integer

_UnauthorizedErrorResponse#

Name Type
reason string
status_code integer

_UnprocessableInputErrorResponse#

Name Type
status_code integer
validation_issues Array<FieldValidationError>

AnalyzeNeighborLabelsResult#

Name Type
label_metrics Array<LabelClassMetrics>

ApiKeyMetadata#

Name Type
created_at string(date-time)
created_by
id string(uuid4)
name string
org_id string(uuid4)
updated_at string(date-time)

BaseModel#

Body_create_datasource_datasource__post#

Name Type
content
files
name string

ClassificationEvaluationResult#

Name Type
accuracy number
f1_score number
loss number
pr_auc
roc_auc

CloneLabeledMemorysetRequest#

Name Type
finetuned_embedding_model_id
max_seq_length_override
name string
pretrained_embedding_model_name

ColumnInfo#

Name Type
enum_options
name string
type ColumnType

ColumnType#

Type: string

CreateApiKeyRequest#

Name Type
created_by
id string(uuid4)
name string

CreateApiKeyResponse#

Name Type
api_key string
created_at string(date-time)
created_by
id string(uuid4)
name string
org_id string(uuid4)
updated_at string(date-time)

CreateLabeledMemorysetRequest#

Name Type
datasource_id
datasource_label_column string
datasource_name
datasource_source_id_column
datasource_value_column string
finetuned_embedding_model_id
finetuned_embedding_model_name
label_names Array<string>
max_seq_length_override
name string
pretrained_embedding_model_name

CreateRACModelRequest#

Name Type
head_type RACHeadType
memory_lookup_count
memoryset_id
memoryset_name
min_memory_weight
name string
num_classes
weigh_memories

DatasourceMetadata#

Name Type
columns Array<ColumnInfo>
created_at string(date-time)
id string(uuid4)
length integer
name string
org_id string(uuid4)
storage_path string
updated_at string(date-time)

DeleteMemoriesRequest#

Name Type
memory_ids Array<string(uuid7)>

EmbeddingFinetuningMethod#

Type: string

EmbedRequest#

Name Type
max_seq_length
values

EvaluationRequest#

Name Type
datasource_id
datasource_label_column string
datasource_name
datasource_value_column string
memoryset_override_id
record_telemetry boolean
telemetry_tags

EvaluationResponse#

Name Type
created_at string(date-time)
org_id string(uuid4)
result
status TaskStatus
task_id string(uuid4)
updated_at string(date-time)

FeedbackType#

Type: string

FieldValidationError#

Name Type
loc Array<>
msg string
type string

FilterItem#

Name Type
field
op string
value

FindDuplicatesAnalysisResult#

Name Type
num_duplicates integer

FinetunedEmbeddingModelMetadata#

Name Type
base_model PretrainedEmbeddingModelName
created_at string(date-time)
embedding_dim integer
finetuning_status TaskStatus
finetuning_task_id string(uuid4)
id string(uuid4)
max_seq_length integer
name string
org_id string(uuid4)
storage_path string
updated_at string(date-time)
uses_context boolean

FinetuneEmbeddingModelRequest#

Name Type
base_model PretrainedEmbeddingModelName
eval_datasource_id
eval_datasource_name
label_column string
name string
train_datasource_id
train_datasource_name
train_memoryset_id
train_memoryset_name
training_args
training_method EmbeddingFinetuningMethod
value_column string

GetMemoriesRequest#

Name Type
memory_ids Array<string(uuid7)>

LabelClassMetrics#

Name Type
average_lookup_score number
label integer
label_name
memory_count integer

LabeledMemory#

Name Type
created_at string(date-time)
embedding Array<number>
label integer
label_name
memory_id string(uuid7)
memory_version integer
metadata
metrics
source_id
updated_at string(date-time)
value

LabeledMemoryInsert#

Name Type
label integer
metadata
source_id
value

LabeledMemoryLookup#

Name Type
created_at string(date-time)
embedding Array<number>
label integer
label_name
lookup_score number
memory_id string(uuid7)
memory_version integer
metadata
metrics
reranker_embedding
reranker_score
source_id
updated_at string(date-time)
value

LabeledMemoryMetrics#

Name Type
current_label_neighbor_confidence
duplicate_memory_ids
is_duplicate
neighbor_label_logits
neighbor_predicted_label
neighbor_predicted_label_ambiguity
neighbor_predicted_label_confidence
neighbor_predicted_label_matches_current_label
normalized_neighbor_label_entropy

LabeledMemorysetMetadata#

Name Type
collection_name string
created_at string(date-time)
finetuned_embedding_model_id
id string(uuid4)
insertion_status TaskStatus
insertion_task_id string(uuid4)
label_names Array<string>
length integer
name string
org_id string(uuid4)
pretrained_embedding_model_name
updated_at string(date-time)

LabeledMemoryUpdate#

Name Type
label integer
memory_id string(uuid7)
metadata
metrics
source_id
value

LabelPredictionMemoryLookup#

Name Type
attention_weight number
created_at string(date-time)
embedding Array<number>
label integer
label_name
lookup_score number
memory_id string(uuid7)
memory_version integer
metadata
metrics
prediction_id string(uuid4)
reranker_embedding
reranker_score
source_id
updated_at string(date-time)
value

LabelPredictionResult#

Name Type
confidence number
label integer
label_name
prediction_id string(uuid4)

LabelPredictionWithMemoriesAndFeedback#

Name Type
confidence number
expected_label
feedbacks Array<PredictionFeedback>
input_embedding Array<number>
input_value
label integer
label_name
logits Array<number>
memories Array<LabelPredictionMemoryLookup>
memoryset_id string(uuid4)
model_id string(uuid4)
org_id string(uuid4)
prediction_id string(uuid4)
tags Array<string>
timestamp string(date-time)
updated_at string(date-time)

ListMemoriesRequest#

Name Type
filters Array<FilterItem>
limit integer
offset integer

ListPredictionsRequest#

Name Type
limit
model_id
offset
prediction_ids
sort Array<Array<>>
tag

LookupRequest#

Name Type
count integer
query Array<string>

MemorysetAnalysisRequest#

Name Type
neighbor_count integer
type string

MemorysetAnalysisResponse#

Name Type
config
created_at string(date-time)
memoryset_id string(uuid4)
org_id string(uuid4)
result
status TaskStatus
task_id string(uuid4)
type string
updated_at string(date-time)

PredictionFeedback#

Name Type
category_id string(uuid4)
category_name string
category_type FeedbackType
comment
created_at string(date-time)
id string(uuid4)
org_id string(uuid4)
prediction_id string(uuid4)
updated_at string(date-time)
value

PredictionFeedbackCategory#

Name Type
created_at string(date-time)
id string(uuid4)
name string
org_id string(uuid4)
type FeedbackType
updated_at string(date-time)

PredictionFeedbackRequest#

Name Type
category_name string
comment
prediction_id string(uuid4)
value

PredictionFeedbackResult#

Name Type
deleted_feedback_ids Array<string(uuid4)>
inserted_feedback_ids Array<string(uuid4)>
new_category_ids Array<string(uuid4)>
prediction_ids Array<string(uuid4)>
updated_feedback_ids Array<string(uuid4)>

PredictionRequest#

Name Type
expected_labels
input_values
memoryset_override_id
tags Array<string>

PretrainedEmbeddingModelMetadata#

Name Type
embedding_dim integer
max_seq_length integer
name PretrainedEmbeddingModelName
uses_context boolean

PretrainedEmbeddingModelName#

Type: string

RACHeadType#

Type: string

RACModelMetadata#

Name Type
created_at string(date-time)
head_type RACHeadType
id string(uuid4)
memory_lookup_count integer
memoryset_collection_name string
memoryset_id string(uuid4)
min_memory_weight
name string
num_classes integer
org_id string(uuid4)
storage_path string
updated_at string(date-time)
version integer
weigh_memories

Task#

Name Type
created_at string(date-time)
exception
id string(uuid4)
org_id string(uuid4)
payload BaseModel
result
status TaskStatus
steps_completed
steps_total
type string
updated_at string(date-time)

TaskStatus#

Type: string

TaskStatusInfo#

Name Type
created_at string(date-time)
exception
status TaskStatus
steps_completed
steps_total
updated_at string(date-time)

UpdatePredictionRequest#

Name Type
expected_label
tags Array<string>

Security schemes#

Name Type Scheme Description
APIKeyHeader apiKey