💧 Instill VDP Quickstart

Welcome to the Instill Versatile Data Pipeline (VDP) Quickstart Guide! Here you will learn how to run, clone and customise your own Instill VDP pipelines on Instill Cloud.

Instill VDP pipelines use Instill Components as building blocks to create versatile automations, ETL processes, and unstructured data transformations. They can leverage the capabilities of 3rd-party data, AI, and applications functionalities, and seamlessly connect with Instill Model and Instill Artifact.

This quick start guide introduces a simple contract review pipeline that:

  1. Takes a PDF contract and a question as input
  2. Summarizes the document
  3. Answers your question using OpenAI's GPT-4 model

#Prerequisites

Please create an Instill Cloud account first by following the steps outlined in the previous Quickstart Guide. Alternatively, if you prefer running Instill VDP locally, please read about Instill Core.

#Run Pipeline via 📺 Instill Console

  1. Go to the contract-reviewer pipeline playground
  2. Upload a contract PDF and enter your question
  3. Click Run
Run contract reviewer pipeline
Run contract reviewer pipeline

#Run Pipeline via API

All Instill VDP pipelines are API-ready by default, read about Run Pipeline via API Endpoint. To trigger the contract review pipeline, follow these steps:

  1. Generate an INSTILL_API_TOKEN by going to Console > Settings > API Tokens or following the steps here
  2. Copy and paste the following snippet into your terminal
  3. Hit enter to trigger this pipeline
cURL

export INSTILL_API_TOKEN=********
curl -X POST 'https://api.instill.tech/v1beta/organizations/instill-ai/pipelines/contract-reviewer/trigger' \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $INSTILL_API_TOKEN" \
--data '{
"inputs": [
{
"question": "Any red flags in this contract?",
"contract_pdf_file": "'$(base64 -i <YOUR_PDF_FILENAME>)'"
}
]
}'

The corresponding JSON response should look like:


{
"outputs": [
{
"contract-summary": [
"It is a Professional Services Agreement."
],
"contract-question-answering":
"Certainly. Reviewing the provided contract, there are several provisions and issues that may raise red flags or require further clarification:
1. **Incomplete Information**:
- **Contract No.** and **Date** are not filled in.
- The name of the **CONSULTANT** and the **services/project name** is missing.
2. **Ambiguity in Scope of Services (Section 1.A)**:
- The specific results the CONSULTANT should accomplish are not detailed.
- Exhibit A: Scope of Services should be attached for complete clarity.
3. **Compensation Cap (Section 2.A)**:
- The total payment amount is missing ("$_____").
- It is vital to specify this to prevent any disputes over payment limitations.
4. **Timing of Invoices (Section 2.E and 2.H)**:
- Several timelines are dictated for invoicing and progress reporting, which could be problematic if not diligently tracked.
5. **Insurance Requirements (Section 6)**:
- Ensure the requirements align with industry standards and that the CONSULTANT can provide the necessary coverages. Subconsultants also need to meet these requirements.
- Consider specifying the limits of Professional Liability Insurance, as indicated by the initialed clause.
6. **Early Termination (Section 4)**:
- Termination for convenience by the COMMISSION and the related cost recovery could become contentious if not clearly understood and agreed upon.
- COMMISSION's ability to terminate for CONSULTANT's default should be clearly defined, especially the conditions under which a default is declared.
7. **Indemnification (Section 5)**:
- This clause places significant liabilities on the CONSULTANT. Ensure the CONSULTANT is aware and that insurance coverage is adequate to cover these liabilities.
8. **Licensing (Section 10)**:
- Confirm that all necessary licenses are obtained and validated.
9. **Independent Consultant Status**:
- Ensure that the criteria defining the independent contractor status under laws such as the California ABC test are met to avoid misclassification.
10. **Ownership and Use of Work Products (Section 15)**:
- The clause grants the COMMISSION extensive rights over all work products, including a perpetual, royalty-free license. This could be problematic for the CONSULTANT if they desire to use their work elsewhere.
- CONSULTANT should ensure that the confidentiality requirements are feasible under the operational framework.
11. **Safety Regulations (Section 16)**:
- Clear communication and mutual understanding regarding safety requirements, especially those specific to the Santa Cruz Branch Rail Line.
12. **Modification of Agreement (Section 17)**:
- Changes to the project team need COMMISSION's prior written approval, which can cause delays.
13. **Disputes and Audit Review Procedures**:
- Ensure the CONSULTANT understands the dispute resolution process. Delays in dispute resolution could affect project deadlines.
14. **Insurance Changes Notification (Section 6.B(3)&amp; B(5))**:
- Any changes in insurance coverage need prompt notice and approval. Ensure this is feasible.
15. **Attachments (Section 24.D)**:
- Ensure all referenced Exhibits (A: Scope of Services and B: Fee Schedule) are attached and reviewed for completeness and clarity.
16. **Rebates and Kickbacks (Section 22)**:
- Any breach of this provision can lead to severe penalties. Emphasize compliance.
**Overall Recommendations**:
- Ensure all missing information is filled in before finalizing the contract.
- Attach and review Exhibit A (Scope of Services) and Exhibit B (Fee Schedule).
- Clarify the total payment in Section 2.A.
- Ensure insurance coverages as detailed can be adequately met.
- It is advisable for both the COMMISSION and the CONSULTANT to review all terms in detail, particularly around indemnifications, intellectual property rights, and dispute resolutions.
- Consider seeking reviews from both legal advisors and insurance experts to ensure responsibilities and risks are clearly understood and appropriately covered.
Every contract should be reviewed in the context of the specific project and relationship involved, and these points highlight areas that may need more attention or negotiation."
}
],
"metadata": null
}

#Customise Pipeline via the Editor

  1. Go to the contract-reviewer pipeline
  2. Click Clone in the top right corner
  3. Select Edit to enter the pipeline editor
  4. Familiarize yourself with the editor layout:
    • Left: YAML recipe
    • Right: Pipeline preview
  5. Modify the prompt or system-message in the YAML
  6. Add, remove, or adjust components as needed
  7. Test your changes by running the modified pipeline
  8. Repeat steps 5-8 to further refine your pipeline
TIP

Use keyboard shorcuts:

  • CMD + O on MacOS or CTRL + O on Windows and Linux to add a new component recipe snippet
  • CMD + K on MacOS or CTRL + K on Windows and Linux to search for something

#Next Steps

#See Our Examples

Explore, test, modify and draw inspiration from the diverse range of AI products you can build with our services on our Examples page. This includes:

#Read Our Blog

Stay up-to-date with our latest product updates, AI insights, and tutorials by visiting our Blog.

#Support

Get help to your queries by joining our community on Discord where you can post any questions on our #ask-for-help channel or join Weekly Office Hours every Tuesday at 3pm BST or Thursdays at 6pm BST.

Previous Page

Data

Next Page

Examples