github.com/instill-ai/component@v0.16.0-beta/pkg/connector/instill/v0/config/tasks.json (about)

     1  {
     2    "$defs": {
     3      "chat_message": {
     4        "properties": {
     5          "content": {
     6            "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/multi_modal_content",
     7            "description": "The message content",
     8            "instillUIOrder": 1,
     9            "title": "Content"
    10          },
    11          "role": {
    12            "description": "The message role, i.e. 'system', 'user' or 'assistant'",
    13            "instillFormat": "string",
    14            "instillUIOrder": 0,
    15            "title": "Role",
    16            "type": "string"
    17          }
    18        },
    19        "required": [
    20          "role",
    21          "content"
    22        ],
    23        "title": "Chat Message",
    24        "type": "object"
    25      },
    26      "common": {
    27        "description": "Input",
    28        "instillEditOnNodeFields": [
    29          "image_base64",
    30          "model_name"
    31        ],
    32        "instillUIOrder": 0,
    33        "properties": {
    34          "image_base64": {
    35            "description": "Image base64",
    36            "instillAcceptFormats": [
    37              "image/*"
    38            ],
    39            "instillUIOrder": 2,
    40            "instillUpstreamTypes": [
    41              "reference"
    42            ],
    43            "title": "Image",
    44            "type": "string"
    45          },
    46          "model_name": {
    47            "description": "The Instill Model model to be used.",
    48            "instillAcceptFormats": [
    49              "string"
    50            ],
    51            "instillUIOrder": 0,
    52            "instillUpstreamTypes": [
    53              "value",
    54              "reference",
    55              "template"
    56            ],
    57            "title": "Model Name",
    58            "type": "string"
    59          }
    60        },
    61        "required": [
    62          "image_base64",
    63          "model_name"
    64        ],
    65        "title": "Input",
    66        "type": "object"
    67      },
    68      "extra_params": {
    69        "description": "Extra Parameters",
    70        "instillAcceptFormats": [
    71          "semi-structured/object"
    72        ],
    73        "instillUIOrder": 3,
    74        "instillUpstreamTypes": [
    75          "reference"
    76        ],
    77        "required": [],
    78        "title": "Extra Parameters",
    79        "type": "object"
    80      }
    81    },
    82    "TASK_CLASSIFICATION": {
    83      "instillShortDescription": "Classify images into predefined categories.",
    84      "input": {
    85        "$ref": "#/$defs/common",
    86        "type": "object"
    87      },
    88      "output": {
    89        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/classification",
    90        "description": "Output",
    91        "instillUIOrder": 0,
    92        "title": "Output",
    93        "type": "object"
    94      }
    95    },
    96    "TASK_DETECTION": {
    97      "instillShortDescription": "Detect and localize multiple objects in images.",
    98      "input": {
    99        "$ref": "#/$defs/common",
   100        "type": "object"
   101      },
   102      "output": {
   103        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/detection",
   104        "description": "Output",
   105        "instillUIOrder": 0,
   106        "title": "Output",
   107        "type": "object"
   108      }
   109    },
   110    "TASK_IMAGE_TO_IMAGE": {
   111      "instillShortDescription": "Generate image from input text prompt and image.",
   112      "input": {
   113        "description": "Input",
   114        "instillEditOnNodeFields": [
   115          "prompt",
   116          "image_base64",
   117          "model_name"
   118        ],
   119        "instillUIOrder": 0,
   120        "properties": {
   121          "cfg_scale": {
   122            "description": "The guidance scale, default is 7.5",
   123            "instillAcceptFormats": [
   124              "number",
   125              "integer"
   126            ],
   127            "instillUIOrder": 4,
   128            "instillUpstreamTypes": [
   129              "value",
   130              "reference"
   131            ],
   132            "title": "CFG Scale",
   133            "type": "number"
   134          },
   135          "extra_params": {
   136            "$ref": "#/$defs/extra_params"
   137          },
   138          "image_base64": {
   139            "description": "The prompt image",
   140            "instillAcceptFormats": [
   141              "image/*"
   142            ],
   143            "instillUIOrder": 3,
   144            "instillUpstreamTypes": [
   145              "reference"
   146            ],
   147            "title": "Prompt Image",
   148            "type": "string"
   149          },
   150          "model_name": {
   151            "description": "The Instill Model model to be used.",
   152            "instillAcceptFormats": [
   153              "string"
   154            ],
   155            "instillUIOrder": 0,
   156            "instillUpstreamTypes": [
   157              "value",
   158              "reference",
   159              "template"
   160            ],
   161            "title": "Model Name",
   162            "type": "string"
   163          },
   164          "prompt": {
   165            "description": "The prompt text",
   166            "instillAcceptFormats": [
   167              "string"
   168            ],
   169            "instillUIMultiline": true,
   170            "instillUIOrder": 2,
   171            "instillUpstreamTypes": [
   172              "value",
   173              "reference",
   174              "template"
   175            ],
   176            "title": "Prompt",
   177            "type": "string"
   178          },
   179          "samples": {
   180            "description": "The number of generated samples, default is 1",
   181            "instillAcceptFormats": [
   182              "integer"
   183            ],
   184            "instillUIOrder": 5,
   185            "instillUpstreamTypes": [
   186              "value",
   187              "reference"
   188            ],
   189            "title": "Samples",
   190            "type": "integer"
   191          },
   192          "seed": {
   193            "description": "The seed",
   194            "instillAcceptFormats": [
   195              "integer"
   196            ],
   197            "instillUIOrder": 4,
   198            "instillUpstreamTypes": [
   199              "value",
   200              "reference"
   201            ],
   202            "title": "Seed",
   203            "type": "integer"
   204          },
   205          "top_k": {
   206            "default": 10,
   207            "description": "Top k for sampling",
   208            "instillAcceptFormats": [
   209              "integer"
   210            ],
   211            "instillUIOrder": 5,
   212            "instillUpstreamTypes": [
   213              "value",
   214              "reference"
   215            ],
   216            "title": "Top K",
   217            "type": "integer"
   218          }
   219        },
   220        "required": [
   221          "prompt",
   222          "image_base64",
   223          "model_name"
   224        ],
   225        "title": "Input",
   226        "type": "object"
   227      },
   228      "output": {
   229        "description": "Output",
   230        "instillEditOnNodeFields": [
   231          "images"
   232        ],
   233        "instillUIOrder": 0,
   234        "properties": {
   235          "images": {
   236            "description": "Images",
   237            "instillUIOrder": 0,
   238            "instillFormat": "array:image/jpeg",
   239            "items": {
   240              "instillFormat": "image/jpeg",
   241              "title": "Image",
   242              "type": "string"
   243            },
   244            "title": "Images",
   245            "type": "array"
   246          }
   247        },
   248        "required": [
   249          "images"
   250        ],
   251        "title": "Output",
   252        "type": "object"
   253      }
   254    },
   255    "TASK_INSTANCE_SEGMENTATION": {
   256      "instillShortDescription": "Detect, localize and delineate multiple objects in images.",
   257      "input": {
   258        "$ref": "#/$defs/common",
   259        "type": "object"
   260      },
   261      "output": {
   262        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/instance_segmentation",
   263        "description": "Output",
   264        "instillUIOrder": 0,
   265        "title": "Output",
   266        "type": "object"
   267      }
   268    },
   269    "TASK_KEYPOINT": {
   270      "instillShortDescription": "Detect and localize multiple keypoints of objects in images.",
   271      "input": {
   272        "$ref": "#/$defs/common",
   273        "type": "object"
   274      },
   275      "output": {
   276        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/keypoint",
   277        "description": "Output",
   278        "instillUIOrder": 0,
   279        "title": "Output",
   280        "type": "object"
   281      }
   282    },
   283    "TASK_OCR": {
   284      "instillShortDescription": "Detect and recognize text in images.",
   285      "input": {
   286        "$ref": "#/$defs/common",
   287        "type": "object"
   288      },
   289      "output": {
   290        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/ocr",
   291        "description": "Output",
   292        "instillUIOrder": 0,
   293        "title": "Output",
   294        "type": "object"
   295      }
   296    },
   297    "TASK_SEMANTIC_SEGMENTATION": {
   298      "instillShortDescription": "Classify image pixels into predefined categories.",
   299      "input": {
   300        "$ref": "#/$defs/common",
   301        "type": "object"
   302      },
   303      "output": {
   304        "$ref": "https://raw.githubusercontent.com/instill-ai/component/b530a7ac8558f38f45bd116c503b1e2a31a4f92b/schema.json#/$defs/instill_types/semantic_segmentation",
   305        "description": "Output",
   306        "instillUIOrder": 0,
   307        "title": "Output",
   308        "type": "object"
   309      }
   310    },
   311    "TASK_TEXT_GENERATION": {
   312      "instillShortDescription": "Generate texts from input text prompts.",
   313      "input": {
   314        "description": "Input",
   315        "instillEditOnNodeFields": [
   316          "prompt",
   317          "model_name"
   318        ],
   319        "instillUIOrder": 0,
   320        "properties": {
   321          "chat_history": {
   322            "description": "Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : {\"role\": \"The message role, i.e. 'system', 'user' or 'assistant'\", \"content\": \"message content\"}.",
   323            "instillAcceptFormats": [
   324              "structured/chat_messages"
   325            ],
   326            "instillShortDescription": "Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : {\"role\": \"The message role, i.e. 'system', 'user' or 'assistant'\", \"content\": \"message content\"}.",
   327            "instillUIOrder": 4,
   328            "instillUpstreamTypes": [
   329              "reference"
   330            ],
   331            "items": {
   332              "$ref": "#/$defs/chat_message"
   333            },
   334            "title": "Chat history",
   335            "type": "array"
   336          },
   337          "extra_params": {
   338            "$ref": "#/$defs/extra_params"
   339          },
   340          "max_new_tokens": {
   341            "default": 50,
   342            "description": "The maximum number of tokens for model to generate",
   343            "instillAcceptFormats": [
   344              "integer"
   345            ],
   346            "instillUIOrder": 6,
   347            "instillUpstreamTypes": [
   348              "value",
   349              "reference"
   350            ],
   351            "title": "Max new tokens",
   352            "type": "integer"
   353          },
   354          "model_name": {
   355            "description": "The Instill Model model to be used.",
   356            "instillAcceptFormats": [
   357              "string"
   358            ],
   359            "instillUIOrder": 0,
   360            "instillUpstreamTypes": [
   361              "value",
   362              "reference",
   363              "template"
   364            ],
   365            "title": "Model Name",
   366            "type": "string"
   367          },
   368          "prompt": {
   369            "description": "The prompt text",
   370            "instillAcceptFormats": [
   371              "string"
   372            ],
   373            "instillUIMultiline": true,
   374            "instillUIOrder": 2,
   375            "instillUpstreamTypes": [
   376              "value",
   377              "reference",
   378              "template"
   379            ],
   380            "title": "Prompt",
   381            "type": "string"
   382          },
   383          "prompt_images": {
   384            "description": "The prompt images",
   385            "instillAcceptFormats": [
   386              "array:image/*"
   387            ],
   388            "instillUIOrder": 3,
   389            "instillUpstreamTypes": [
   390              "reference"
   391            ],
   392            "items": {
   393              "type": "string"
   394            },
   395            "title": "Prompt Images",
   396            "type": "array"
   397          },
   398          "seed": {
   399            "description": "The seed",
   400            "instillAcceptFormats": [
   401              "integer"
   402            ],
   403            "instillUIOrder": 4,
   404            "instillUpstreamTypes": [
   405              "value",
   406              "reference"
   407            ],
   408            "title": "Seed",
   409            "type": "integer"
   410          },
   411          "system_message": {
   412            "default": "You are a helpful assistant.",
   413            "description": "The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model\u2019s behavior is using a generic message as \"You are a helpful assistant.\"",
   414            "instillAcceptFormats": [
   415              "string"
   416            ],
   417            "instillShortDescription": "The system message helps set the behavior of the assistant",
   418            "instillUIMultiline": true,
   419            "instillUIOrder": 2,
   420            "instillUpstreamTypes": [
   421              "value",
   422              "reference",
   423              "template"
   424            ],
   425            "title": "System message",
   426            "type": "string"
   427          },
   428          "temperature": {
   429            "default": 0.7,
   430            "description": "The temperature for sampling",
   431            "instillAcceptFormats": [
   432              "number"
   433            ],
   434            "instillUIOrder": 5,
   435            "instillUpstreamTypes": [
   436              "value",
   437              "reference"
   438            ],
   439            "title": "Temperature",
   440            "type": "number"
   441          },
   442          "top_k": {
   443            "default": 10,
   444            "description": "Top k for sampling",
   445            "instillAcceptFormats": [
   446              "integer"
   447            ],
   448            "instillUIOrder": 5,
   449            "instillUpstreamTypes": [
   450              "value",
   451              "reference"
   452            ],
   453            "title": "Top K",
   454            "type": "integer"
   455          }
   456        },
   457        "required": [
   458          "prompt",
   459          "model_name"
   460        ],
   461        "title": "Input",
   462        "type": "object"
   463      },
   464      "output": {
   465        "description": "Output",
   466        "instillEditOnNodeFields": [
   467          "text"
   468        ],
   469        "instillUIOrder": 0,
   470        "properties": {
   471          "text": {
   472            "description": "Text",
   473            "instillFormat": "string",
   474            "instillUIMultiline": true,
   475            "instillUIOrder": 0,
   476            "title": "Text",
   477            "type": "string"
   478          }
   479        },
   480        "required": [
   481          "text"
   482        ],
   483        "title": "Output",
   484        "type": "object"
   485      }
   486    },
   487    "TASK_TEXT_GENERATION_CHAT": {
   488      "instillShortDescription": "Generate texts from input text prompts and chat history.",
   489      "$ref": "#/TASK_TEXT_GENERATION"
   490    },
   491    "TASK_TEXT_TO_IMAGE": {
   492      "instillShortDescription": "Generate images from input text prompts.",
   493      "input": {
   494        "description": "Input",
   495        "instillEditOnNodeFields": [
   496          "prompt",
   497          "model_name"
   498        ],
   499        "instillUIOrder": 0,
   500        "properties": {
   501          "cfg_scale": {
   502            "description": "The guidance scale, default is 7.5",
   503            "instillAcceptFormats": [
   504              "number",
   505              "integer"
   506            ],
   507            "instillUIOrder": 4,
   508            "instillUpstreamTypes": [
   509              "value",
   510              "reference"
   511            ],
   512            "title": "CFG Scale",
   513            "type": "number"
   514          },
   515          "extra_params": {
   516            "$ref": "#/$defs/extra_params"
   517          },
   518          "model_name": {
   519            "description": "The Instill Model model to be used.",
   520            "instillAcceptFormats": [
   521              "string"
   522            ],
   523            "instillUIOrder": 0,
   524            "instillUpstreamTypes": [
   525              "value",
   526              "reference",
   527              "template"
   528            ],
   529            "title": "Model Name",
   530            "type": "string"
   531          },
   532          "prompt": {
   533            "description": "The prompt text",
   534            "instillAcceptFormats": [
   535              "string"
   536            ],
   537            "instillUIMultiline": true,
   538            "instillUIOrder": 2,
   539            "instillUpstreamTypes": [
   540              "value",
   541              "reference",
   542              "template"
   543            ],
   544            "title": "Prompt",
   545            "type": "string"
   546          },
   547          "samples": {
   548            "description": "The number of generated samples, default is 1",
   549            "instillAcceptFormats": [
   550              "integer"
   551            ],
   552            "instillUIOrder": 5,
   553            "instillUpstreamTypes": [
   554              "value",
   555              "reference"
   556            ],
   557            "title": "Samples",
   558            "type": "integer"
   559          },
   560          "seed": {
   561            "description": "The seed, default is 0",
   562            "instillAcceptFormats": [
   563              "integer"
   564            ],
   565            "instillUIOrder": 6,
   566            "instillUpstreamTypes": [
   567              "value",
   568              "reference"
   569            ],
   570            "title": "Seed",
   571            "type": "integer"
   572          },
   573          "steps": {
   574            "description": "The steps, default is 5",
   575            "instillAcceptFormats": [
   576              "integer"
   577            ],
   578            "instillUIOrder": 7,
   579            "instillUpstreamTypes": [
   580              "value",
   581              "reference"
   582            ],
   583            "title": "Steps",
   584            "type": "integer"
   585          }
   586        },
   587        "required": [
   588          "prompt",
   589          "model_name"
   590        ],
   591        "title": "Input",
   592        "type": "object"
   593      },
   594      "output": {
   595        "description": "Output",
   596        "instillEditOnNodeFields": [
   597          "images"
   598        ],
   599        "instillUIOrder": 0,
   600        "properties": {
   601          "images": {
   602            "description": "Images",
   603            "instillUIOrder": 0,
   604            "instillFormat": "array:image/jpeg",
   605            "items": {
   606              "instillFormat": "image/jpeg",
   607              "title": "Image",
   608              "type": "string"
   609            },
   610            "title": "Images",
   611            "type": "array"
   612          }
   613        },
   614        "required": [
   615          "images"
   616        ],
   617        "title": "Output",
   618        "type": "object"
   619      }
   620    },
   621    "TASK_VISUAL_QUESTION_ANSWERING": {
   622      "instillShortDescription": "Answer questions based on a prompt and an image.",
   623      "input": {
   624        "description": "Input",
   625        "instillEditOnNodeFields": [
   626          "prompt",
   627          "prompt_images",
   628          "model_name"
   629        ],
   630        "instillUIOrder": 0,
   631        "properties": {
   632          "chat_history": {
   633            "description": "Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : {\"role\": \"The message role, i.e. 'system', 'user' or 'assistant'\", \"content\": \"message content\"}.",
   634            "instillAcceptFormats": [
   635              "structured/chat_messages"
   636            ],
   637            "instillShortDescription": "Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : {\"role\": \"The message role, i.e. 'system', 'user' or 'assistant'\", \"content\": \"message content\"}.",
   638            "instillUIOrder": 4,
   639            "instillUpstreamTypes": [
   640              "reference"
   641            ],
   642            "items": {
   643              "$ref": "#/$defs/chat_message"
   644            },
   645            "title": "Chat history",
   646            "type": "array"
   647          },
   648          "extra_params": {
   649            "$ref": "#/$defs/extra_params"
   650          },
   651          "max_new_tokens": {
   652            "default": 50,
   653            "description": "The maximum number of tokens for model to generate",
   654            "instillAcceptFormats": [
   655              "integer"
   656            ],
   657            "instillUIOrder": 6,
   658            "instillUpstreamTypes": [
   659              "value",
   660              "reference"
   661            ],
   662            "title": "Max new tokens",
   663            "type": "integer"
   664          },
   665          "model_name": {
   666            "description": "The Instill Model model to be used.",
   667            "instillAcceptFormats": [
   668              "string"
   669            ],
   670            "instillUIOrder": 0,
   671            "instillUpstreamTypes": [
   672              "value",
   673              "reference",
   674              "template"
   675            ],
   676            "title": "Model Name",
   677            "type": "string"
   678          },
   679          "prompt": {
   680            "description": "The prompt text",
   681            "instillAcceptFormats": [
   682              "string"
   683            ],
   684            "instillUIMultiline": true,
   685            "instillUIOrder": 2,
   686            "instillUpstreamTypes": [
   687              "value",
   688              "reference",
   689              "template"
   690            ],
   691            "title": "Prompt",
   692            "type": "string"
   693          },
   694          "prompt_images": {
   695            "description": "The prompt images",
   696            "instillAcceptFormats": [
   697              "array:image/*"
   698            ],
   699            "instillUIOrder": 3,
   700            "instillUpstreamTypes": [
   701              "reference"
   702            ],
   703            "items": {
   704              "type": "string"
   705            },
   706            "title": "Prompt Images",
   707            "type": "array"
   708          },
   709          "seed": {
   710            "description": "The seed",
   711            "instillAcceptFormats": [
   712              "integer"
   713            ],
   714            "instillUIOrder": 4,
   715            "instillUpstreamTypes": [
   716              "value",
   717              "reference"
   718            ],
   719            "title": "Seed",
   720            "type": "integer"
   721          },
   722          "system_message": {
   723            "default": "You are a helpful assistant.",
   724            "description": "The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model\u2019s behavior is using a generic message as \"You are a helpful assistant.\"",
   725            "instillAcceptFormats": [
   726              "string"
   727            ],
   728            "instillShortDescription": "The system message helps set the behavior of the assistant",
   729            "instillUIMultiline": true,
   730            "instillUIOrder": 2,
   731            "instillUpstreamTypes": [
   732              "value",
   733              "reference",
   734              "template"
   735            ],
   736            "title": "System message",
   737            "type": "string"
   738          },
   739          "temperature": {
   740            "default": 0.7,
   741            "description": "The temperature for sampling",
   742            "instillAcceptFormats": [
   743              "number"
   744            ],
   745            "instillUIOrder": 5,
   746            "instillUpstreamTypes": [
   747              "value",
   748              "reference"
   749            ],
   750            "title": "Temperature",
   751            "type": "number"
   752          },
   753          "top_k": {
   754            "default": 10,
   755            "description": "Top k for sampling",
   756            "instillAcceptFormats": [
   757              "integer"
   758            ],
   759            "instillUIOrder": 5,
   760            "instillUpstreamTypes": [
   761              "value",
   762              "reference"
   763            ],
   764            "title": "Top K",
   765            "type": "integer"
   766          }
   767        },
   768        "required": [
   769          "prompt",
   770          "prompt_images",
   771          "model_name"
   772        ],
   773        "title": "Input",
   774        "type": "object"
   775      },
   776      "output": {
   777        "description": "Output",
   778        "instillEditOnNodeFields": [
   779          "text"
   780        ],
   781        "instillUIOrder": 0,
   782        "properties": {
   783          "text": {
   784            "description": "Text",
   785            "instillFormat": "string",
   786            "instillUIMultiline": true,
   787            "instillUIOrder": 0,
   788            "title": "Text",
   789            "type": "string"
   790          }
   791        },
   792        "required": [
   793          "text"
   794        ],
   795        "title": "Output",
   796        "type": "object"
   797      }
   798    }
   799  }