Fields and Models | OCP® Learning Center

Fields

Node.component_id

This field indicates some of the component's values. Here are some examples:

MiniApps
Example: "user-id.corpus2.CorpusCollection.MiniApps.group"

Name	Value	Static
`user_id`	user-id	No
`name`	corpus2	No
`block_type`	CorpusCollection	No
`diamant_app`	MiniApps	Yes
`group_name`	group	No

Conditions
Example: "user-id.Condition.builtin.orc.group"

Name	Value	Static
`user_id`	user-id	No
`name`	Condition	Yes
`block_type`	builtin	Yes
`diamant_app`	orc	Yes
`group_name`	group	No

Flows
Example: "user-id.MyFlowName.Flows.orc.group"

Name	Value	Static
`user_id`	user-id	No
`name`	MyFlowName	No
`block_type`	Flows	Yes
`diamant_app`	orc	Yes
`group_name`	group	No

Apps
Example: "user-id.MyAppName.Apps.orc.group"

Name	Value	Static
`user_id`	user-id	No
`name`	MyAppName	No
`block_type`	Apps	Yes
`diamant_app`	orc	Yes
`group_name`	group	No

Models

Here you can find a list of the models we are using in the Orchestrator API.

Canvas

Name	Type	Description
`content`	CanvasContent	the canvas content

CanvasContent

Name	Type	Default	Description
`nodes`	array[Node]	[ ]	array of nodes
`edges`	array[Edge]	[ ]	array of edges

Example:

JSON

{
    "content": {
        "nodes": [
            {
                "title": "ia_iandronis_announcement",
                "node_id": "758d7ab6-5eba-47e7-8d29-749fb79bf346",
                "component_id": "827aa8e8-351c-4622-9e11-722d38efdcfe.ia_iandronis_announcement.Announcement.MiniApps.iandronis",
                "configuration": {
                    "reset_on_intent": false,
                    "input_fields": {},
                    "output_fields": [
                        {
                            "miniapp_name": "AnnouncementResult",
                            "local_name": "ia_iandronis_announcement_0_output",
                            "optional": false,
                            "locked": true
                        }
                    ],
                    "referents": []
                },
                "x_value": 83.0,
                "y_value": 86.0,
                "type": "miniApp",
                "miniapp_type": "Announcement"
            },
            {
                "title": "ia_iandronis_intent",
                "node_id": "98668bc3-f857-44f1-943e-99281a5d55d5",
                "component_id": "827aa8e8-351c-4622-9e11-722d38efdcfe.ia_iandronis_intent.Banking.MiniApps.iandronis",
                "configuration": {
                    "reset_on_intent": false,
                    "input_fields": {},
                    "output_fields": [
                        {
                            "miniapp_name": "Intent",
                            "local_name": "Intent",
                            "optional": false,
                            "locked": true
                        }
                    ],
                    "referents": []
                },
                "x_value": 201.0,
                "y_value": 265.0,
                "type": "miniApp",
                "miniapp_type": "Banking"
            }
        ],
        "edges": [
            {
                "id": "3221acbe-9d52-472f-a144-1fe8784d98d7",
                "source": "758d7ab6-5eba-47e7-8d29-749fb79bf346",
                "target": "98668bc3-f857-44f1-943e-99281a5d55d5",
                "conditions": [],
                "condition_operator": "AND",
                "port": "out"
            }
        ]
    }
}

App

Name	Type	Default	Description
`name`	string	-	The application’s name
`canvas_id`	uuid	-	The application’s Canvas id

Example:

JSON

{
    "name": "my_app",
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Flow

Name	Type	Default	Description
`name`	string	-	The Flow's name
`input_fields`	array[string]	[ ]	The Flow's input fields
`output_fields`	array[string]	[ ]	The Flow's output fields
`canvas_id`	uuid	-	The Flow'sCanvas id

Example:

JSON

{
    "name": "my_flow",
    "input_fields": ["inputField1", "inputField2"],
    "output_fields": ["outputField1", "outputField2"],
    "canvas_id": "8101c262-be18-40c7-a85a-78b47dcdf80d"
}

Graph.Node

Name	Type	Default	Optional	Description
`title`	string	null	True	The node's title
`node_id`	uuid	-	False	The node's node_id
`component_id`	string	null	False	The node's component_id
`configuration`	NodeConfiguration	-	False	The node's configuration
`x_value`	float	100	True	The node's x value
`y_value`	float	100	True	The node's y value
`type`	string (read-only)	-	False	The component's type ("miniApp"/"Flow"/"condition")
`miniapp_type (used for miniApp components)`	string (read-only)	-	False	The component's miniApp type (ex. "Announcement", "Banking")

Graph.Node.NodeConfiguration

Name	Type	Default	Description
`input_fields`	dict[string, string]	{ }	Maps miniApp input fields to orc fields
`output_fields`	dict[string, string]	{ }	Maps miniApp output fields to orc fields
`extra_fields`	array[dict[string, string]]	-	Provides additional data required for Node configuration
`intent_miniapp`	string	-	Intent miniApp's component id
`reask_index (used for reask components)`	int	-	The Reask prompt index number (from 0 to 10)

Graph.Edge

Name	Type	Default	Description
`id`	uuid	-	The edge's id
`source`	uuid	-	The edge's source's id
`target`	uuid	-	The edge's target's id
`conditions`	array[EdgeCondition]	[ ]	The edge's conditions
`condition_operator`	string	"AND"	The logical operator (available values: ["AND", "OR"])
`port`	string	-	The edge's connection port

Graph.Node.EdgeCondition

Name	Type	Description
`field`	string	The condition's field
`value`	string	The condition's value

Example:

JSON

{
    "nodes": [
        {
            "title": "ia_iandronis_announcement",
            "node_id": "758d7ab6-5eba-47e7-8d29-749fb79bf346",
            "component_id": "827aa8e8-351c-4622-9e11-722d38efdcfe.ia_iandronis_announcement.Announcement.MiniApps.iandronis",
            "configuration": {
                "reset_on_intent": false,
                "input_fields": {},
                "output_fields": [
                    {
                        "miniapp_name": "AnnouncementResult",
                        "local_name": "ia_iandronis_announcement_0_output",
                        "optional": false,
                        "locked": true
                    }
                ],
                "referents": []
            },
            "x_value": 83.0,
            "y_value": 86.0,
            "type": "miniApp",
            "miniapp_type": "Announcement"
        },
        {
            "title": "ia_iandronis_intent",
            "node_id": "98668bc3-f857-44f1-943e-99281a5d55d5",
            "component_id": "827aa8e8-351c-4622-9e11-722d38efdcfe.ia_iandronis_intent.Banking.MiniApps.iandronis",
            "configuration": {
                "reset_on_intent": false,
                "input_fields": {},
                "output_fields": [
                    {
                        "miniapp_name": "Intent",
                        "local_name": "Intent",
                        "optional": false,
                        "locked": true
                    }
                ],
                "referents": []
            },
            "x_value": 201.0,
            "y_value": 265.0,
            "type": "miniApp",
            "miniapp_type": "Banking"
        }
    ],
    "edges": [
        {
            "id": "3221acbe-9d52-472f-a144-1fe8784d98d7",
            "source": "758d7ab6-5eba-47e7-8d29-749fb79bf346",
            "target": "98668bc3-f857-44f1-943e-99281a5d55d5",
            "conditions": [],
            "condition_operator": "AND",
            "port": "out"
        }
    ]
}

MiniApp

Name	Type	Description
`id`	string	The miniApp's id (see Node.component_id)
`name`	string	The miniApp's name
`type`	string	The miniApp's type
`diamantAppName`	string	The miniApp's DiaManT application name
`group`	string	The miniApp's group
`number`	list	The list of numbers

Example:

JSON

{
    "id": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
    "name": "corpus3",
    "type": "CorpusCollection",
    "diamantAppName": "MiniApps",
    "group": "ocp",
    "numbers": [
        {
            "number": "+12244781692",
            "country": "US",
            "groupId": "ocp",
            "miniAppId": "025c9ddd-2357-4415-8c55-466cbe44a548.corpus3.CorpusCollection.MiniApps.e92b6e81c15c448e9972b0e4669e18bb",
            "locale": "en-US"
        }
    ]
}