How do I use the structured output component? (simple JSON schema)

[ohmeingott]

Hi everyone,

I’m trying to use the structured output component, but I’m stuck on understanding the table with the columns: name, description, type, and multiple. I couldn’t find clear guidance in the documentation about how to fill these fields.

I’d really appreciate it if someone could explain what each column means and how to structure a basic example. I have a JSON schema I’d like to follow, but I’m unsure:

1. Where do I put the schema?
2. How do I define that the output should follow the JSON schema?

I always end up with an error when I try to use it. Could anyone help me troubleshoot or share a working example for better understanding? I’ll attach the JSON schema I’m working with below.

Thanks a lot for your help!

{
        "type": "json_schema",
        "json_schema": {
            "strict": true,
            "name": "PayloadSchema",
            "schema": {
                "$schema": "http://json-schema.org/draft-07/schema#",
                "title": "Payload",
                "type": "object",
                "properties": {
                    "title": {
                        "type": "string"
                    },
                    "elements": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "question": {
                                    "type": "string"
                                },
                                "sampleSolution": {
                                    "type": "object",
                                    "properties": {
                                        "selection": {
                                            "type": "array",
                                            "items": {
                                                "type": "boolean"
                                            }
                                        }
                                    },
                                    "required": ["selection"],
                                    "additionalProperties": false
                                },
                                "data": {
                                    "type": "object",
                                    "properties": {
                                        "answers": {
                                            "type": "array",
                                            "items": {
                                                "type": "object",
                                                "properties": {
                                                    "type": {
                                                        "type": "string",
                                                        "enum": ["text"]
                                                    },
                                                    "value": {
                                                        "type": "string"
                                                    }
                                                },
                                                "required": ["type", "value"],
                                                "additionalProperties": false
                                            }
                                        },
                                        "multipleSelect": {
                                            "type": "boolean"
                                        }
                                    },
                                    "required": ["answers", "multipleSelect"],
                                    "additionalProperties": false
                                }
                            },
                            "required": ["question", "sampleSolution", "data"],
                            "additionalProperties": false
                        }
                    }
                },
                "required": ["title", "elements"],
                "additionalProperties": false
            }
        }
    }

[dosubot[bot]]

Hello @ohmeingott! I'm here to help you with any bugs, questions, or anything else while you wait for a human maintainer. Let's start by addressing your concern.

To use the StructuredOutputComponent with a simple JSON schema, you need to define the schema with fields specifying the name, description, type, and multiple attributes. Here's what each column means:

• name: This is the identifier for the output field. It specifies the key under which the output value will be stored.

• description: This provides a textual explanation of the purpose of the output field. It helps in understanding what the field represents.

• type: This indicates the data type of the output field, such as str, int, float, bool, list, or dict. It defines the kind of data that the field is expected to hold.

• multiple: This is a boolean value that, when set to True, indicates that the output field should be a list of the specified type. If False, the field will hold a single value of the specified type.

Here's a basic example of how you might define a schema and use it with the StructuredOutputComponent:

from langflow.components.helpers.structured_output import StructuredOutputComponent
from unittest.mock import MagicMock

# Define the schema
schema = [
    {
        "name": "title",
        "type": "str",
        "description": "The title of the payload",
        "multiple": False
    },
    {
        "name": "elements",
        "type": "list",
        "description": "List of elements",
        "multiple": True
    }
]

# Create an instance of StructuredOutputComponent
component = StructuredOutputComponent(
    llm=MagicMock(),  # Mock or actual language model
    input_value="Test input",
    schema_name="PayloadSchema",
    output_schema=schema,
    multiple=False
)

# Build the structured output
result = component.build_structured_output()

In this example, the schema is defined to match the structure of your JSON schema. You need to ensure that the type in your schema matches the expected data type in your JSON schema. The StructuredOutputComponent will then use this schema to validate and structure the output accordingly ^[1].

To continue talking to Dosu, mention @dosu.