[INS-2234] [Improvement] Add sample input and output for sharing pipeline

[xiaofei-du]

trafficstars

Is There an Existing Issue for This?

• [X] I have searched the existing issues

Project

Instill VDP

Is your Proposal Related to a Problem?

Presently, we share pipelines without accompanying samples. To address this issue, I will use cohere's example of an invoice entity extraction process, available at this link. They provide both sample input and output, as illustrated below:

Sample Input:

Given a banking invoice, please return the name of the vendor.

Bank Invoice: PURCHASE instill-ai/instill-core#559 MERCHANT ALLBIRDS ACC XXX3846
Vendor: ALLBIRDS

--

Bank Invoice: PURCHASE #6781 MERCHANT SHOPPERS ACC XXX9877
Vendor: SHOPPERS

--

Bank Invoice: PURCHASE #0777 CN TOWER ACC XXX3846
Vendor:

Sample Output:

CN TOWER

Imagine that we construct a similar pipeline template. A user employs this pipeline but may not naturally formulate an invoice in the precise format like this:

Bank Invoice: PURCHASE #0777 CN TOWER ACC XXX3846

The absence of samples can hinder users from readily adopting and experimenting with the pipeline, underscoring the value of providing such illustrative examples.

Describe Your Proposed Improvement

Add sample inputs and outputs to a pipeline for sharing.

Highlight the Benefits

These samples offer users a quick understanding of what the example accomplishes, the relevant use case, and the expected output.

Anything Else?

_INS-2234