Instill Model

The Instill Model AI Connector enables you to connect the AI models served on the Instill Model Platform for various AI tasks:

#Release Stage

Alpha

#Resource Configuration

The up-to-date configuration is maintained here.

FieldTypeNote
api_tokenstringTo access models on Instill Cloud, enter your Instill Cloud API Token. You can find your tokens by visiting your Instill Cloud's Settings > API Tokens page. Leave this field empty to access models on your local Instill Model.
server_url*stringBase URL for the Instill Model API. To access models on Instill Cloud, use the base URL https://api.instill.tech. To access models on your local Instill Model, use the base URL http://localhost:9080.

#No-code Setup

INFO

Comparing to launching a local Instill Model, Instill Cloud is the fastest way to create an Instill Model AI Connector.

👉 You can try out Instill Cloud to use our pre-created Instill Model AI connector for FREE during Open Alpha.

To create an Instill Model AI connector from Instill Cloud, you'll first need to create an Instill Cloud account by visiting console.instill.tech.

  1. Visit Model Hub on Instill Cloud to explore available models

  2. Go to the Resource page and click Add Resource

  3. Select Instill Model

  4. Fill an ID, this will be the unique identifier of this connector

  5. [Optional] Give a short description of your connector in the Description field

  6. Fill in the following information and click Save

    • Enter API Token. You can find your Instill Cloud API tokens by visiting your Settings > API Tokens page.
    • Set the the Server URL https://api.instill.tech to access models on Instill Cloud

To create an Instill Model AI connector from local Instill Model, follow the same steps, follow the same steps as above, but with the following difference in step 1 and 6:

  1. Visit local Instill Model from local Console](http://localhost:3000/model-hub) to create and deploy your models

and

  1. Fill the following information and click Set up

    • Leave the API Key field empty to access models on your local Instill Model
    • Set the Server URL to http://localhost:9080 to access models on your local Instill Model.
    • Enter the ID of the model served on your local Instill Model that you want to use

#Low-code Setup

cURL(Instill-Cloud)
cURL(Instill-Core)
Copy

curl -X POST https://api.instill.tech/v1alpha/users/<user-id>/connectors \
--header 'Authorization: Bearer <Instill-Cloud-API-Token>' \
--data '{
"id": "my-instill-model",
"connector_definition_name": "connector-definitions/ai-instill-model",
"configuration": {
"api_token": "<instill-cloud-api-token>",
"server_url": "https://api.instill.tech"
}
}'

For other operations, please refer to the VDP Protobufs.

#Connector Configuration

When using the Instill Model AI connector in your pipeline, certain fields of the input data need to be filled to trigger the pipeline effectively. Here are the expected input and output data fields for the Instill Model AI connector.

#Classification

InputTypeDescription
taskstringTASK_CLASSIFICATION
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
categorystringThe predicted category of the input
scorenumberThe confidence score of the predicted category of the input

#Object Detection

InputTypeDescription
taskstringTASK_OBJECT_DETECTION
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
objectsarray[object]A list of detected instance bounding boxes

#Semantic Segmentation

InputTypeDescription
taskstringTASK_SEMANTIC_SEGMENTATION
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
stuffsarray[object]A list of RLE binary masks

#Instance Segmentation

InputTypeDescription
taskstringTASK_INSTANCE_SEGMENTATION
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
objectsarray[object]A list of detected instance bounding boxes

#OCR

InputTypeDescription
taskstringTASK_OCR
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
objectsarray[object]A list of detected bounding boxes

#Keypoint

InputTypeDescription
taskstringTASK_KEYPOINT
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
image_base64stringImage as base64 encoded string
OutputTypeDescription
objectsarray[object]A list of keypoint objects, a keypoint object includes all the pre-defined keypoints of a detected object

#Text Generation

InputTypeDescription
taskstringTASK_TEXT_GENERATION
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
promptstringText prompt
output_lenintOutput length
bad_words_liststringBad words formatted in a string
stop_words_liststringStop words formatted in a string
top_kintTop K
seedintRandom noise seed
OutputTypeDescription
textstringGenerated text

#Text to Image

InputTypeDescription
taskstringTASK_TEXT_TO_IMAGE
model_namespacestringThe namespace of the model to be used from Instill Model
model_idstringThe ID of the model that you want to use from Instill Model
promptstringText prompt
cfg_scalefloatHow strictly the diffusion process adheres to the prompt text
stepsintNumber of diffusion steps to run
samplesintNumber of images to generate
seedintRandom noise seed
OutputTypeDescription
imagesarray[image]A list of generated images as base64 encoded string

Last updated: 1/15/2024, 2:25:21 PM