artifact

API definition for MLTE artifacts.

delete_artifact(model_id, version_id, artifact_id, current_user)

Delete an artifact by identifier.

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
artifact_id	str	The identifier for the artifact	required

Returns:

Type	Description
ArtifactModel	The deleted artifact

Source code in mlte/backend/api/endpoints/artifact.py

@router.delete("/{artifact_id}")
def delete_artifact(
    model_id: str,
    version_id: str,
    artifact_id: str,
    current_user: AuthorizedUser,
) -> ArtifactModel:
    """
    Delete an artifact by identifier.
    :param model_id: The model identifier
    :param version_id: The version identifier
    :param artifact_id: The identifier for the artifact
    :return: The deleted artifact
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)
    artifact_id = url_utils.revert_valid_url_part(artifact_id)
    with state_stores.artifact_store_session() as artifact_store:
        try:
            return artifact_store.artifact_mapper.delete(
                artifact_id, (model_id, version_id)
            )
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as ex:
            raise_http_internal_error(ex)

read_artifact(model_id, version_id, artifact_id, current_user)

Read an artifact by identifier.

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
artifact_id	str	The identifier for the artifact	required

Returns:

Type	Description
ArtifactModel	The read artifact

Source code in mlte/backend/api/endpoints/artifact.py

@router.get("/{artifact_id}")
def read_artifact(
    model_id: str,
    version_id: str,
    artifact_id: str,
    current_user: AuthorizedUser,
) -> ArtifactModel:
    """
    Read an artifact by identifier.
    :param model_id: The model identifier
    :param version_id: The version identifier
    :param artifact_id: The identifier for the artifact
    :return: The read artifact
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)
    artifact_id = url_utils.revert_valid_url_part(artifact_id)
    with state_stores.artifact_store_session() as artifact_store:
        try:
            return artifact_store.artifact_mapper.read(
                artifact_id, (model_id, version_id)
            )
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as ex:
            raise_http_internal_error(ex)

read_artifacts(model_id, version_id, current_user, limit=100, offset=0)

Read artifacts with limit and offset.

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
limit	int	The limit on returned artifacts	100
offset	int	The offset on returned artifacts	0

Returns:

Type	Description
list[ArtifactModel]	The read artifacts

Source code in mlte/backend/api/endpoints/artifact.py

@router.get("")
def read_artifacts(
    model_id: str,
    version_id: str,
    current_user: AuthorizedUser,
    limit: int = 100,
    offset: int = 0,
) -> list[ArtifactModel]:
    """
    Read artifacts with limit and offset.
    :param model_id: The model identifier
    :param version_id: The version identifier
    :param limit: The limit on returned artifacts
    :param offset: The offset on returned artifacts
    :return: The read artifacts
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)
    with state_stores.artifact_store_session() as artifact_store:
        try:
            return artifact_store.artifact_mapper.list_details(
                context=(model_id, version_id), limit=limit, offset=offset
            )
        except Exception as ex:
            raise_http_internal_error(ex)

search_artifacts(model_id, version_id, query, current_user)

Search artifacts.

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
query	Query	The artifact query	required

Returns:

Type	Description
list[ArtifactModel]	The read artifacts

Source code in mlte/backend/api/endpoints/artifact.py

@router.post("/search")
def search_artifacts(
    model_id: str,
    version_id: str,
    query: Query,
    current_user: AuthorizedUser,
) -> list[ArtifactModel]:
    """
    Search artifacts.

    :param model_id: The model identifier
    :param version_id: The version identifier
    :param query: The artifact query
    :return: The read artifacts
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)
    with state_stores.artifact_store_session() as artifact_store:
        try:
            return artifact_store.artifact_mapper.search(
                query, context=(model_id, version_id)
            )
        except Exception as ex:
            raise_http_internal_error(ex)

suite_template(model_id, version_id, artifact_id, current_user)

Create a TestSuite template from a negotiation card artifact

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
artifact_id	str	The identifier for the artifact	required

Returns:

Type	Description
str	The read artifact

Source code in mlte/backend/api/endpoints/artifact.py

@router.get("/{artifact_id}/suite_template")
def suite_template(
    model_id: str,
    version_id: str,
    artifact_id: str,
    current_user: AuthorizedUser,
) -> str:
    """
    Create a TestSuite template from a negotiation card artifact
    :param model_id: The model identifier
    :param version_id: The version identifier
    :param artifact_id: The identifier for the artifact
    :return: The read artifact
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)
    artifact_id = url_utils.revert_valid_url_part(artifact_id)
    with state_stores.artifact_store_session() as artifact_store:
        try:
            artifact = artifact_store.artifact_mapper.read(
                artifact_id, (model_id, version_id)
            )
            if artifact.header.type == ArtifactType.NEGOTIATION_CARD:
                card = typing.cast(NegotiationCardModel, artifact.body)
                return generate_suite_str(card.system_requirements)
            else:
                raise Exception(
                    "Artifact passed to suite_template endpoint was not a negotiation card."
                )
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as ex:
            raise_http_internal_error(ex)

write_artifact(model_id, version_id, request, current_user)

Write an artifact.

Parameters:

Name	Type	Description	Default
model_id	str	The model identifier	required
version_id	str	The version identifier	required
request	WriteArtifactRequest	The artifact write request	required

Returns:

Type	Description
WriteArtifactResponse	The created artifact

Source code in mlte/backend/api/endpoints/artifact.py

@router.post("")
def write_artifact(
    model_id: str,
    version_id: str,
    request: WriteArtifactRequest,
    current_user: AuthorizedUser,
) -> WriteArtifactResponse:
    """
    Write an artifact.
    :param model_id: The model identifier
    :param version_id: The version identifier
    :param request: The artifact write request
    :return: The created artifact
    """
    model_id = url_utils.revert_valid_url_part(model_id)
    version_id = url_utils.revert_valid_url_part(version_id)

    try:
        artifact = ArtifactFactory.from_model(request.artifact)
        model = artifact.save_with(
            Context(model_id, version_id),
            state.stores.artifact_store,
            force=request.force,
            parents=request.parents,
            user=current_user.username,
        )
        return WriteArtifactResponse(artifact=model)
    except errors.ErrorNotFound as e:
        raise HTTPException(
            status_code=codes.NOT_FOUND, detail=f"{e} not found."
        )
    except errors.ErrorAlreadyExists as e:
        raise HTTPException(
            status_code=codes.ALREADY_EXISTS, detail=f"{e} already exists."
        )
    except Exception as ex:
        raise_http_internal_error(ex)