Describe workflow intefrace

[EmilyGavrilenko]

Description

Adding capability to describe workflow interface - both inputs and outputs regarding types of data:

The following workflow:

{
    "version": "1.0",
    "inputs": [
        {"type": "WorkflowImage", "name": "image"},
        {"type": "WorkflowParameter", "name": "model_id"},
    ],
    "steps": [
        {
            "type": "ObjectDetectionModel",
            "name": "general_detection",
            "image": "$inputs.image",
            "model_id": "$inputs.model_id",
            "class_filter": ["dog"],
        },
        {
            "type": "Crop",
            "name": "cropping",
            "image": "$inputs.image",
            "predictions": "$steps.general_detection.predictions",
        },
        {
            "type": "ClassificationModel",
            "name": "breds_classification",
            "image": "$steps.cropping.crops",
            "model_id": "dog-breed-xpaq6/1",
        },
    ],
    "outputs": [
        {
            "type": "JsonField",
            "name": "detections",
            "selector": "$steps.general_detection.predictions",
        },
        {
            "type": "JsonField",
            "name": "crops",
            "selector": "$steps.cropping.crops",
        },
        {
            "type": "JsonField",
            "name": "classification",
            "selector": "$steps.breds_classification.*",
        },
    ],
}

will return:

{
    "inputs": {
        "image": ["image"],
        "model_id": ["roboflow_model_id"],
    },
    "outputs": {
        "detections": ["object_detection_prediction"],
         "crops": ["image"],
         "classification": {
            "inference_id": ["string"],
            "predictions": ["classification_prediction"],
         },
    },
    "typing_hints": {
        "image": "dict",
        "roboflow_model_id": "str",
        "object_detection_prediction": "dict",
        "string": "str",
        "classification_prediction": "dict",
    },
    "kinds_schemas": {
        "image": {},
        "object_detection_prediction": {"dict": "with OpenAPI 3.0 schema of result"},
        "classification_prediction": {"dict": "with OpenAPI 3.0 schema of result"}
    }
}

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

• CI still 🟢
• new tests
• e2e tests

Any specific deployment considerations

For example, documentation changes, usability, usage/costs, secrets, etc.

Docs

• Docs updated? What were the changes:

[PawelPeczek-Roboflow]

the same can be achieved having schemas of blocks on the UI end - why secondary request to backend to run post-processing of schemas needed?

[EmilyGavrilenko]

the same can be achieved having schemas of blocks on the UI end - why secondary request to backend to run post-processing of schemas needed?

A customer requested an API endpoint to call to get the schema for the workflow response (slack thread). Will be used for integration with their downstream pipelines

[PawelPeczek-Roboflow]

ok then - let's mark it to be released in 0.19.0

[PawelPeczek-Roboflow]

taking that and preparing for rel

[PawelPeczek-Roboflow]

that needs to be added into hosted API routing

[hansent]

I think we need to add it here like the other ones: https://github.com/roboflow/roboflow-infra/blob/1e58b097dc081a18851588a253d18ac3e4539b1c/aws/serverless/modules/containerlambda/main.tf#L128-L144

[hansent]

@EmilyGavrilenko is the customer requesting this running on hosted API or dedicates/local?

[PawelPeczek-Roboflow]

that's hosted most likely given Nick comment
I posted this comment not to forget

[PawelPeczek-Roboflow]

regardless - this is potentially useful feature for preview in UI

[hansent]

infra PR here: https://github.com/roboflow/roboflow-infra/pull/334

[PawelPeczek-Roboflow]

Added typing_hints and kinds_schemas. Not in the way I like that - would require re-iteration to ease maintenance, but works for now and is added aside of anything else, not requesting drastic changes.

kinds_schemas provide OpenAPI 3.0 schemas for entities, but obviously not for all, simple type hints for kinds are delivered undertyping_hints key

[hansent]

lgtm tested locally

we only need this for explicit spec? i.e. not able to get it for name workflow via workflow url?

[PawelPeczek-Roboflow]

we only need this for explicit spec? i.e. not able to get it for name workflow via workflow url? - not sure if I understand

[hansent]

we only need this for explicit spec? i.e. not able to get it for name workflow via workflow url? - not sure if I understand

like I have to post the workflow spec, but I can't post hte workflow url and have it looked up via API like I can for running it?

[PawelPeczek-Roboflow]

still do not understand - I feel like both are possible

[hansent]

reapproving after fixing block names