List Transformation Definitions

GET 
/api/v1/component-definition/configurable-transformations

List transformation component definitions.

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

label Label (string)required

The label field will be used to display the name of the component in the UI

json_schema objectrequired

The json_schema field can be used by clients to determine how to construct the component

configurable_transformation_type ConfigurableTransformationNames (string)required

The name field will act as the unique identifier of TransformationDefinition objects

Possible values: [CHARACTER_SPLITTER, PAGE_SPLITTER_NODE_PARSER, CODE_NODE_PARSER, SENTENCE_AWARE_NODE_PARSER, TOKEN_AWARE_NODE_PARSER, MARKDOWN_NODE_PARSER, MARKDOWN_ELEMENT_NODE_PARSER]

transformation_category TransformationCategoryNames (string)required

The transformation_category field will be used to group transformations in the UI

Possible values: [NODE_PARSER, EMBEDDING]

• ]

Example (from schema)

[
  {
    "label": "string",
    "json_schema": {},
    "configurable_transformation_type": "CHARACTER_SPLITTER",
    "transformation_category": "NODE_PARSER"
  }
]

Loading...