Pipeline Configured Models Endpoints¶

Pipeline Configured Models API endpoints.

Overview¶

Method	Endpoint	Description
GET	`/api/v1/pipeline-configured-models`	List Pipeline Configured Models
POST	`/api/v1/pipeline-configured-models`	Create Pipeline Configured Model
GET	`/api/v1/pipeline-configured-models/{pipeline_name}`	Get Pipeline Configured Model
PUT	`/api/v1/pipeline-configured-models/{pipeline_name}`	Update Pipeline Configured Model
DELETE	`/api/v1/pipeline-configured-models/{pipeline_name}`	Delete Pipeline Configured Model

API Reference¶

Sartiq Backend Server - Pipeline Configured Models 0.1.0¶

pipeline-configured-models¶

GET /api/v1/pipeline-configured-models¶

List Pipeline Configured Models

Description

List all pipeline model configurations.

Requires admin privileges.

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`skip`	query	integer	0	No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "data": [
        {
            "pipeline_name": "auto_post_prod_revision_product_enhance",
            "generative_model_id": "817371a8-2d51-4a73-9d3b-826cef54adee"
        }
    ],
    "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 response body

{
    "properties": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/PipelineConfiguredGenerativeModelPublic"
            },
            "type": "array",
            "title": "Data"
        },
        "count": {
            "type": "integer",
            "title": "Count"
        }
    },
    "type": "object",
    "required": [
        "data",
        "count"
    ],
    "title": "PipelineConfiguredGenerativeModelListPublic",
    "description": "Schema for list of pipeline model configurations."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

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

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

POST /api/v1/pipeline-configured-models¶

Create Pipeline Configured Model

Description

Create a new pipeline model configuration.

Requires admin privileges.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No

Request body

application/json

{
    "pipeline_name": "auto_post_prod_revision_product_enhance",
    "generative_model_id": "3aeb2984-6954-442d-9507-6bb5e8537227"
}

⚠️ 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

{
    "properties": {
        "pipeline_name": {
            "$ref": "#/components/schemas/PipelineName"
        },
        "generative_model_id": {
            "type": "string",
            "format": "uuid",
            "title": "Generative Model Id"
        }
    },
    "type": "object",
    "required": [
        "pipeline_name",
        "generative_model_id"
    ],
    "title": "PipelineConfiguredGenerativeModelCreate",
    "description": "Schema for creating a new pipeline model configuration."
}

Responses

201 Created422 Unprocessable Entity

application/json

{
    "pipeline_name": "auto_post_prod_revision_product_enhance",
    "generative_model_id": "24f23767-d6f8-4b0c-b570-92643e2f721e"
}

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

Schema of the response body

{
    "properties": {
        "pipeline_name": {
            "$ref": "#/components/schemas/PipelineName"
        },
        "generative_model_id": {
            "type": "string",
            "format": "uuid",
            "title": "Generative Model Id"
        }
    },
    "type": "object",
    "required": [
        "pipeline_name",
        "generative_model_id"
    ],
    "title": "PipelineConfiguredGenerativeModelPublic",
    "description": "Schema for public pipeline model configuration data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

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

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

GET /api/v1/pipeline-configured-models/{pipeline_name}¶

Get Pipeline Configured Model

Description

Get a specific pipeline model configuration.

Requires admin privileges.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`pipeline_name`	path			No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "pipeline_name": "auto_post_prod_revision_product_enhance",
    "generative_model_id": "12f125b6-efd3-4731-8055-d5078463d3bd"
}

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

Schema of the response body

{
    "properties": {
        "pipeline_name": {
            "$ref": "#/components/schemas/PipelineName"
        },
        "generative_model_id": {
            "type": "string",
            "format": "uuid",
            "title": "Generative Model Id"
        }
    },
    "type": "object",
    "required": [
        "pipeline_name",
        "generative_model_id"
    ],
    "title": "PipelineConfiguredGenerativeModelPublic",
    "description": "Schema for public pipeline model configuration data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

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

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

PUT /api/v1/pipeline-configured-models/{pipeline_name}¶

Update Pipeline Configured Model

Description

Update a pipeline model configuration.

Requires admin privileges.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`pipeline_name`	path			No

Request body

application/json

{
    "generative_model_id": "fa8d8f6e-8021-4c6c-88d3-2db000681f5e"
}

⚠️ 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

{
    "properties": {
        "generative_model_id": {
            "type": "string",
            "format": "uuid",
            "title": "Generative Model Id"
        }
    },
    "type": "object",
    "required": [
        "generative_model_id"
    ],
    "title": "PipelineConfiguredGenerativeModelUpdate",
    "description": "Schema for updating a pipeline model configuration."
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "pipeline_name": "auto_post_prod_revision_product_enhance",
    "generative_model_id": "83205c12-f6ea-4368-884a-8936d8450e14"
}

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

Schema of the response body

{
    "properties": {
        "pipeline_name": {
            "$ref": "#/components/schemas/PipelineName"
        },
        "generative_model_id": {
            "type": "string",
            "format": "uuid",
            "title": "Generative Model Id"
        }
    },
    "type": "object",
    "required": [
        "pipeline_name",
        "generative_model_id"
    ],
    "title": "PipelineConfiguredGenerativeModelPublic",
    "description": "Schema for public pipeline model configuration data."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

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

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

DELETE /api/v1/pipeline-configured-models/{pipeline_name}¶

Delete Pipeline Configured Model

Description

Delete a pipeline model configuration.

Requires admin privileges.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`pipeline_name`	path			No

Responses

204 No Content422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

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

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

PipelineConfiguredGenerativeModelCreate¶

Name	Type	Description
`generative_model_id`	string(uuid)
`pipeline_name`	PipelineName

PipelineConfiguredGenerativeModelListPublic¶

Name	Type	Description
`count`	integer
`data`	Array<PipelineConfiguredGenerativeModelPublic>

PipelineConfiguredGenerativeModelPublic¶

Name	Type	Description
`generative_model_id`	string(uuid)
`pipeline_name`	PipelineName

PipelineConfiguredGenerativeModelUpdate¶

Name	Type	Description
`generative_model_id`	string(uuid)

PipelineName¶

Type: string

ValidationError¶

Name	Type	Description
`ctx`
`input`
`loc`	Array<>
`msg`	string
`type`	string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2