From da68466b376760b9a1904095a1b38d77af807c6c Mon Sep 17 00:00:00 2001 From: chuang8511 Date: Thu, 17 Oct 2024 22:27:38 +0100 Subject: [PATCH] chore(component): update doc --- pkg/component/ai/anthropic/v0/README.mdx | 9 +++++++++ pkg/component/ai/cohere/v0/README.mdx | 7 +++++++ pkg/component/ai/fireworksai/v0/README.mdx | 9 +++++++++ pkg/component/ai/groq/v0/README.mdx | 9 +++++++++ pkg/component/ai/huggingface/v0/README.mdx | 7 +++++++ pkg/component/ai/instill/v0/README.mdx | 7 +++++++ pkg/component/ai/mistralai/v0/README.mdx | 9 +++++++++ pkg/component/ai/ollama/v0/README.mdx | 7 +++++++ pkg/component/ai/openai/v0/README.mdx | 9 +++++++++ pkg/component/ai/stabilityai/v0/README.mdx | 7 +++++++ pkg/component/ai/universalai/v0/README.mdx | 7 +++++++ pkg/component/application/asana/v0/README.mdx | 7 +++++++ pkg/component/application/email/v0/README.mdx | 9 ++++++++- pkg/component/application/freshdesk/v0/README.mdx | 7 +++++++ pkg/component/application/github/v0/README.mdx | 9 +++++++++ pkg/component/application/googlesearch/v0/README.mdx | 7 +++++++ pkg/component/application/hubspot/v0/README.mdx | 7 +++++++ pkg/component/application/instillapp/v0/README.mdx | 7 +++++++ pkg/component/application/jira/v0/README.mdx | 9 +++++++++ pkg/component/application/numbers/v0/README.mdx | 7 +++++++ pkg/component/application/slack/v0/README.mdx | 7 +++++++ pkg/component/application/whatsapp/v0/README.mdx | 7 +++++++ pkg/component/data/bigquery/v0/README.mdx | 7 +++++++ pkg/component/data/chroma/v0/README.mdx | 7 +++++++ pkg/component/data/elasticsearch/v0/README.mdx | 7 +++++++ pkg/component/data/googlecloudstorage/v0/README.mdx | 7 +++++++ pkg/component/data/instillartifact/v0/README.mdx | 9 +++++++++ pkg/component/data/milvus/v0/README.mdx | 7 +++++++ pkg/component/data/mongodb/v0/README.mdx | 7 +++++++ pkg/component/data/pinecone/v0/README.mdx | 7 +++++++ pkg/component/data/qdrant/v0/README.mdx | 7 +++++++ pkg/component/data/redis/v0/README.mdx | 7 +++++++ pkg/component/data/sql/v0/README.mdx | 7 +++++++ pkg/component/data/weaviate/v0/README.mdx | 7 +++++++ pkg/component/data/zilliz/v0/README.mdx | 7 +++++++ pkg/component/generic/restapi/v0/README.mdx | 7 +++++++ pkg/component/operator/audio/v0/README.mdx | 9 +++++++++ pkg/component/operator/base64/v0/README.mdx | 7 +++++++ pkg/component/operator/document/v0/README.mdx | 11 ++++++++++- pkg/component/operator/image/v0/README.mdx | 7 +++++++ pkg/component/operator/json/v0/README.mdx | 9 +++++++++ pkg/component/operator/text/v0/README.mdx | 7 +++++++ pkg/component/operator/video/v0/README.mdx | 7 +++++++ pkg/component/operator/web/v0/README.mdx | 9 +++++++++ 44 files changed, 334 insertions(+), 2 deletions(-) diff --git a/pkg/component/ai/anthropic/v0/README.mdx b/pkg/component/ai/anthropic/v0/README.mdx index 4ae62fd57..6d38ffacb 100644 --- a/pkg/component/ai/anthropic/v0/README.mdx +++ b/pkg/component/ai/anthropic/v0/README.mdx @@ -9,14 +9,21 @@ The Anthropic component is an AI component that allows users to connect the AI m It can carry out the following tasks: - [Text Generation Chat](#text-generation-chat) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/anthropic/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/anthropic/v0/config/tasks.json) files respectively. + + + ## Setup @@ -122,6 +129,8 @@ The image URL | Output Tokens | `output-tokens` | number | The output tokens used by Anthropic | + + ## Example Recipes Recipe for the [List GitHub Repo Issues](https://instill.tech/instill-ai/pipelines/github-demo/playground) pipeline. diff --git a/pkg/component/ai/cohere/v0/README.mdx b/pkg/component/ai/cohere/v0/README.mdx index aff0563ce..d77eb60a1 100644 --- a/pkg/component/ai/cohere/v0/README.mdx +++ b/pkg/component/ai/cohere/v0/README.mdx @@ -11,14 +11,21 @@ It can carry out the following tasks: - [Text Embeddings](#text-embeddings) - [Text Reranking](#text-reranking) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/cohere/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/cohere/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/ai/fireworksai/v0/README.mdx b/pkg/component/ai/fireworksai/v0/README.mdx index 937c0ab07..f4f15f99e 100644 --- a/pkg/component/ai/fireworksai/v0/README.mdx +++ b/pkg/component/ai/fireworksai/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Text Generation Chat](#text-generation-chat) - [Text Embeddings](#text-embeddings) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/fireworksai/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/fireworksai/v0/config/tasks.json) files respectively. + + + ## Setup @@ -163,6 +170,8 @@ An embedding is a list of floating point numbers that captures semantic informat | Token Count | `tokens` | number | The token count used by Fireworks AI models | + + ## Example Recipes Recipe for the [Fireworks Chinese Content Writer](https://instill.tech/instill-ai/pipelines/fireworks-chinese-content-writer/playground) pipeline. diff --git a/pkg/component/ai/groq/v0/README.mdx b/pkg/component/ai/groq/v0/README.mdx index 5db2db542..ab73699c2 100644 --- a/pkg/component/ai/groq/v0/README.mdx +++ b/pkg/component/ai/groq/v0/README.mdx @@ -9,14 +9,21 @@ The Groq component is an AI component that allows users to connect the AI models It can carry out the following tasks: - [Text Generation Chat](#text-generation-chat) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/groq/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/groq/v0/config/tasks.json) files respectively. + + + ## Setup @@ -124,6 +131,8 @@ The image URL | Output Tokens | `output-tokens` | number | The output tokens generated by GroqCloud OSS models | + + ## Example Recipes Recipe for the [Groq Interview Helper](https://instill.tech/instill-ai/pipelines/groq-interview-helper/playground) pipeline. diff --git a/pkg/component/ai/huggingface/v0/README.mdx b/pkg/component/ai/huggingface/v0/README.mdx index 92eeeee0f..cf5ae0edf 100644 --- a/pkg/component/ai/huggingface/v0/README.mdx +++ b/pkg/component/ai/huggingface/v0/README.mdx @@ -25,14 +25,21 @@ It can carry out the following tasks: - [Speech Recognition](#speech-recognition) - [Audio Classification](#audio-classification) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/huggingface/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/huggingface/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/ai/instill/v0/README.mdx b/pkg/component/ai/instill/v0/README.mdx index b8f177e1e..1c6f22629 100644 --- a/pkg/component/ai/instill/v0/README.mdx +++ b/pkg/component/ai/instill/v0/README.mdx @@ -19,16 +19,23 @@ It can carry out the following tasks: - [Visual Question Answering](#visual-question-answering) - [Chat](#chat) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/instill/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/instill/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Classification diff --git a/pkg/component/ai/mistralai/v0/README.mdx b/pkg/component/ai/mistralai/v0/README.mdx index 5a24d9cb0..a00b4e87a 100644 --- a/pkg/component/ai/mistralai/v0/README.mdx +++ b/pkg/component/ai/mistralai/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Text Generation Chat](#text-generation-chat) - [Text Embeddings](#text-embeddings) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/mistralai/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/mistralai/v0/config/tasks.json) files respectively. + + + ## Setup @@ -164,6 +171,8 @@ An embedding is a list of floating point numbers that captures semantic informat | Token Count | `tokens` | number | The token count used by Mistral models | + + ## Example Recipes Recipe for the [Short-film Script Writer](https://instill.tech/instill-ai/pipelines/mistral-demo/playground) pipeline. diff --git a/pkg/component/ai/ollama/v0/README.mdx b/pkg/component/ai/ollama/v0/README.mdx index 6d80b715b..635dc35dd 100644 --- a/pkg/component/ai/ollama/v0/README.mdx +++ b/pkg/component/ai/ollama/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Text Generation Chat](#text-generation-chat) - [Text Embeddings](#text-embeddings) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/ollama/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/ollama/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/ai/openai/v0/README.mdx b/pkg/component/ai/openai/v0/README.mdx index 2f63c801c..d61bebeee 100644 --- a/pkg/component/ai/openai/v0/README.mdx +++ b/pkg/component/ai/openai/v0/README.mdx @@ -13,14 +13,21 @@ It can carry out the following tasks: - [Text to Speech](#text-to-speech) - [Text to Image](#text-to-image) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/openai/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/openai/v0/config/tasks.json) files respectively. + + + ## Setup @@ -290,6 +297,8 @@ Generate or manipulate images with DALL·E. | Revised Prompt | `revised-prompt` | string | Revised prompt | + + ## Example Recipes Recipe for the [PicassoAI: Cubist Creations at Your Command!](https://instill.tech/instill-ai/pipelines/picasso-ai/playground) pipeline. diff --git a/pkg/component/ai/stabilityai/v0/README.mdx b/pkg/component/ai/stabilityai/v0/README.mdx index ceeff77af..c339f0544 100644 --- a/pkg/component/ai/stabilityai/v0/README.mdx +++ b/pkg/component/ai/stabilityai/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Text to Image](#text-to-image) - [Image to Image](#image-to-image) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/stabilityai/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/stabilityai/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/ai/universalai/v0/README.mdx b/pkg/component/ai/universalai/v0/README.mdx index fd092e54d..b82e39491 100644 --- a/pkg/component/ai/universalai/v0/README.mdx +++ b/pkg/component/ai/universalai/v0/README.mdx @@ -9,14 +9,21 @@ The Universal AI component is an AI component that allows users to connect the A It can carry out the following tasks: - [Chat](#chat) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/universalai/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/ai/universalai/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/asana/v0/README.mdx b/pkg/component/application/asana/v0/README.mdx index 031cfe519..75790c639 100644 --- a/pkg/component/application/asana/v0/README.mdx +++ b/pkg/component/application/asana/v0/README.mdx @@ -12,14 +12,21 @@ It can carry out the following tasks: - [Crud Project](#crud-project) - [Crud Portfolio](#crud-portfolio) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/asana/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/asana/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/email/v0/README.mdx b/pkg/component/application/email/v0/README.mdx index d949cf839..c31c041ba 100644 --- a/pkg/component/application/email/v0/README.mdx +++ b/pkg/component/application/email/v0/README.mdx @@ -8,7 +8,9 @@ description: "Learn about how to set up a VDP Email component https://github.com The Email component is an application component that allows users to get and send email from Mail Protocol. It can carry out the following tasks: - [Send Email](#send-email) -- [Read Emails](#read-emails)You can connect to different email servers through the Email component. +- [Read Emails](#read-emails) + +You can connect to different email servers through the Email component. Emails are fetched and sent using the IMAP and SMTP protocols, respectively. You can set the server address and port for each protocol in the component configuration. @@ -16,10 +18,15 @@ Emails are fetched and sent using the IMAP and SMTP protocols, respectively. You `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/email/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/email/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/freshdesk/v0/README.mdx b/pkg/component/application/freshdesk/v0/README.mdx index f6984f4ea..b99e93472 100644 --- a/pkg/component/application/freshdesk/v0/README.mdx +++ b/pkg/component/application/freshdesk/v0/README.mdx @@ -23,14 +23,21 @@ It can carry out the following tasks: - [Get Group](#get-group) - [Get Skill](#get-skill) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/freshdesk/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/freshdesk/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/github/v0/README.mdx b/pkg/component/application/github/v0/README.mdx index 2b60fadb7..8a4a11ebb 100644 --- a/pkg/component/application/github/v0/README.mdx +++ b/pkg/component/application/github/v0/README.mdx @@ -17,14 +17,21 @@ It can carry out the following tasks: - [Create Issue](#create-issue) - [Create Webhook](#create-webhook) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/github/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/github/v0/config/tasks.json) files respectively. + + + ## Setup @@ -580,6 +587,8 @@ Create a webhook for a repository | Webhook URL | `url` | string | URL of the webhook | + + ## Example Recipes Recipe for the [List GitHub Repo Issues](https://instill.tech/instill-ai/pipelines/github-demo/playground) pipeline. diff --git a/pkg/component/application/googlesearch/v0/README.mdx b/pkg/component/application/googlesearch/v0/README.mdx index 991d71b4a..ee4483c41 100644 --- a/pkg/component/application/googlesearch/v0/README.mdx +++ b/pkg/component/application/googlesearch/v0/README.mdx @@ -9,14 +9,21 @@ The Google Search component is an application component that allows users to lev It can carry out the following tasks: - [Search](#search) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/googlesearch/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/googlesearch/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/hubspot/v0/README.mdx b/pkg/component/application/hubspot/v0/README.mdx index 38391788b..c1ac59728 100644 --- a/pkg/component/application/hubspot/v0/README.mdx +++ b/pkg/component/application/hubspot/v0/README.mdx @@ -23,14 +23,21 @@ It can carry out the following tasks: - [Get Owner](#get-owner) - [Get All](#get-all) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/hubspot/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/hubspot/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/instillapp/v0/README.mdx b/pkg/component/application/instillapp/v0/README.mdx index 009a43263..381b8a367 100644 --- a/pkg/component/application/instillapp/v0/README.mdx +++ b/pkg/component/application/instillapp/v0/README.mdx @@ -10,16 +10,23 @@ It can carry out the following tasks: - [Read Chat History](#read-chat-history) - [Write Chat Message](#write-chat-message) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/instillapp/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/instillapp/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Read Chat History diff --git a/pkg/component/application/jira/v0/README.mdx b/pkg/component/application/jira/v0/README.mdx index 2f6c49977..40ac84261 100644 --- a/pkg/component/application/jira/v0/README.mdx +++ b/pkg/component/application/jira/v0/README.mdx @@ -17,14 +17,21 @@ It can carry out the following tasks: - [Create Sprint](#create-sprint) - [Update Sprint](#update-sprint) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/jira/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/jira/v0/config/tasks.json) files respectively. + + + ## Setup @@ -581,6 +588,8 @@ Update a sprint in Jira | Origin Board ID (optional) | `origin-board-id` | integer | The ID of the origin board | | Goal (optional) | `goal` | string | The Goal of the sprint | + + ## Example Recipes Recipe for the [Your Project Management Assistant ](https://instill.tech/instill-ai/pipelines/pm-assistant/playground) pipeline. diff --git a/pkg/component/application/numbers/v0/README.mdx b/pkg/component/application/numbers/v0/README.mdx index 6446996c7..9e75f1096 100644 --- a/pkg/component/application/numbers/v0/README.mdx +++ b/pkg/component/application/numbers/v0/README.mdx @@ -9,14 +9,21 @@ The Numbers Protocol component is an application component that allows users to It can carry out the following tasks: - [Register](#register) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/numbers/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/numbers/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/slack/v0/README.mdx b/pkg/component/application/slack/v0/README.mdx index c6a4d421c..dd47d3519 100644 --- a/pkg/component/application/slack/v0/README.mdx +++ b/pkg/component/application/slack/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Read Message](#read-message) - [Send Message](#send-message) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/slack/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/slack/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/application/whatsapp/v0/README.mdx b/pkg/component/application/whatsapp/v0/README.mdx index b03d7a28f..01c25897b 100644 --- a/pkg/component/application/whatsapp/v0/README.mdx +++ b/pkg/component/application/whatsapp/v0/README.mdx @@ -17,14 +17,21 @@ It can carry out the following tasks: - [Send Contact Message](#send-contact-message) - [Send Interactive Call to Action URL Button Message](#send-interactive-call-to-action-url-button-message) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/whatsapp/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/whatsapp/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/bigquery/v0/README.mdx b/pkg/component/data/bigquery/v0/README.mdx index 8563424b8..c92b8910c 100644 --- a/pkg/component/data/bigquery/v0/README.mdx +++ b/pkg/component/data/bigquery/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Insert](#insert) - [Read](#read) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/bigquery/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/bigquery/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/chroma/v0/README.mdx b/pkg/component/data/chroma/v0/README.mdx index 9d2d2474f..cc63a4793 100644 --- a/pkg/component/data/chroma/v0/README.mdx +++ b/pkg/component/data/chroma/v0/README.mdx @@ -14,14 +14,21 @@ It can carry out the following tasks: - [Create Collection](#create-collection) - [Delete Collection](#delete-collection) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/chroma/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/chroma/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/elasticsearch/v0/README.mdx b/pkg/component/data/elasticsearch/v0/README.mdx index 4a22f41d1..6a915ffad 100644 --- a/pkg/component/data/elasticsearch/v0/README.mdx +++ b/pkg/component/data/elasticsearch/v0/README.mdx @@ -16,14 +16,21 @@ It can carry out the following tasks: - [Create Index](#create-index) - [Delete Index](#delete-index) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/elasticsearch/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/application/elasticsearch/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/googlecloudstorage/v0/README.mdx b/pkg/component/data/googlecloudstorage/v0/README.mdx index e92427974..eaf92bb0e 100644 --- a/pkg/component/data/googlecloudstorage/v0/README.mdx +++ b/pkg/component/data/googlecloudstorage/v0/README.mdx @@ -11,14 +11,21 @@ It can carry out the following tasks: - [Read Objects](#read-objects) - [Create Bucket](#create-bucket) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/googlecloudstorage/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/googlecloudstorage/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/instillartifact/v0/README.mdx b/pkg/component/data/instillartifact/v0/README.mdx index 4aaed715c..d3324e5f1 100644 --- a/pkg/component/data/instillartifact/v0/README.mdx +++ b/pkg/component/data/instillartifact/v0/README.mdx @@ -16,6 +16,8 @@ It can carry out the following tasks: - [Retrieve](#retrieve) - [Ask](#ask) + + To use Artifact Component, you will need to set up the OpenAI API key for self-hosted deployment of Instill Core. You can do this by setting the `OPENAI_API_KEY` environment variable. Please refer to [configuring-the-embedding-feature](https://www.instill.tech/docs/core/configuration#configuring-the-embedding-feature) @@ -25,12 +27,17 @@ p.s. In Instill Cloud case, you do not need to set up the OpenAI API key. `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/instillartifact/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/instillartifact/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Upload File @@ -419,6 +426,8 @@ Reply the questions based on the files in the catalog | Text Content | `text-content` | string | The text content of the chunk | + + ## Example Recipes Recipe for the [Ask your Catalog](https://instill.tech/instill-ai/pipelines/ask-your-catalog/playground) pipeline. diff --git a/pkg/component/data/milvus/v0/README.mdx b/pkg/component/data/milvus/v0/README.mdx index aef1780bd..a0da515ce 100644 --- a/pkg/component/data/milvus/v0/README.mdx +++ b/pkg/component/data/milvus/v0/README.mdx @@ -18,14 +18,21 @@ It can carry out the following tasks: - [Create Index](#create-index) - [Drop Index](#drop-index) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/milvus/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/milvus/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/mongodb/v0/README.mdx b/pkg/component/data/mongodb/v0/README.mdx index 97905927f..c20f83db3 100644 --- a/pkg/component/data/mongodb/v0/README.mdx +++ b/pkg/component/data/mongodb/v0/README.mdx @@ -18,14 +18,21 @@ It can carry out the following tasks: - [Drop Search Index](#drop-search-index) - [Vector Search](#vector-search) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/mongodb/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/mongodb/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/pinecone/v0/README.mdx b/pkg/component/data/pinecone/v0/README.mdx index 15f2b1189..ada4fd036 100644 --- a/pkg/component/data/pinecone/v0/README.mdx +++ b/pkg/component/data/pinecone/v0/README.mdx @@ -10,14 +10,21 @@ It can carry out the following tasks: - [Query](#query) - [Upsert](#upsert) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/pinecone/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/pinecone/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/qdrant/v0/README.mdx b/pkg/component/data/qdrant/v0/README.mdx index fbed526c6..b0500627f 100644 --- a/pkg/component/data/qdrant/v0/README.mdx +++ b/pkg/component/data/qdrant/v0/README.mdx @@ -14,14 +14,21 @@ It can carry out the following tasks: - [Create Collection](#create-collection) - [Delete Collection](#delete-collection) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/qdrant/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/qdrant/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/redis/v0/README.mdx b/pkg/component/data/redis/v0/README.mdx index dc7221c33..0549d0a3f 100644 --- a/pkg/component/data/redis/v0/README.mdx +++ b/pkg/component/data/redis/v0/README.mdx @@ -11,14 +11,21 @@ It can carry out the following tasks: - [Write Chat Message](#write-chat-message) - [Write Multi Modal Chat Message](#write-multi-modal-chat-message) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/redis/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/redis/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/sql/v0/README.mdx b/pkg/component/data/sql/v0/README.mdx index 42de4c295..fefb30289 100644 --- a/pkg/component/data/sql/v0/README.mdx +++ b/pkg/component/data/sql/v0/README.mdx @@ -15,14 +15,21 @@ It can carry out the following tasks: - [Create Table](#create-table) - [Drop Table](#drop-table) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/sql/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/sql/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/weaviate/v0/README.mdx b/pkg/component/data/weaviate/v0/README.mdx index 3bf36de61..abc0498aa 100644 --- a/pkg/component/data/weaviate/v0/README.mdx +++ b/pkg/component/data/weaviate/v0/README.mdx @@ -14,14 +14,21 @@ It can carry out the following tasks: - [Delete](#delete) - [Delete Collection](#delete-collection) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/weaviate/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/weaviate/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/data/zilliz/v0/README.mdx b/pkg/component/data/zilliz/v0/README.mdx index e0b0f2b9f..94ded457e 100644 --- a/pkg/component/data/zilliz/v0/README.mdx +++ b/pkg/component/data/zilliz/v0/README.mdx @@ -16,14 +16,21 @@ It can carry out the following tasks: - [Create Partition](#create-partition) - [Drop Partition](#drop-partition) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/zilliz/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/data/zilliz/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/generic/restapi/v0/README.mdx b/pkg/component/generic/restapi/v0/README.mdx index 53a3b7d42..9799df3ba 100644 --- a/pkg/component/generic/restapi/v0/README.mdx +++ b/pkg/component/generic/restapi/v0/README.mdx @@ -15,14 +15,21 @@ It can carry out the following tasks: - [Head](#head) - [Options](#options) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/generic/restapi/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/generic/restapi/v0/config/tasks.json) files respectively. + + + ## Setup diff --git a/pkg/component/operator/audio/v0/README.mdx b/pkg/component/operator/audio/v0/README.mdx index d0f187730..82da2651e 100644 --- a/pkg/component/operator/audio/v0/README.mdx +++ b/pkg/component/operator/audio/v0/README.mdx @@ -10,16 +10,23 @@ It can carry out the following tasks: - [Chunk Audios](#chunk-audios) - [Slice Audio](#slice-audio) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/audio/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/audio/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Chunk Audios @@ -72,6 +79,8 @@ Specify a time range to slice an audio file | :--- | :--- | :--- | :--- | | Audio | `audio` | string | Base64 encoded audio slice | + + ## Example Recipes Recipe for the [Audio Transcription Generator](https://instill.tech/instill-ai/pipelines/audio-transcription/playground) pipeline. diff --git a/pkg/component/operator/base64/v0/README.mdx b/pkg/component/operator/base64/v0/README.mdx index d9179da47..b4c23923c 100644 --- a/pkg/component/operator/base64/v0/README.mdx +++ b/pkg/component/operator/base64/v0/README.mdx @@ -10,16 +10,23 @@ It can carry out the following tasks: - [Encode](#encode) - [Decode](#decode) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/base64/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/base64/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Encode diff --git a/pkg/component/operator/document/v0/README.mdx b/pkg/component/operator/document/v0/README.mdx index 4dc150aad..c64353679 100644 --- a/pkg/component/operator/document/v0/README.mdx +++ b/pkg/component/operator/document/v0/README.mdx @@ -11,16 +11,23 @@ It can carry out the following tasks: - [Convert to Text](#convert-to-text) - [Convert to Images](#convert-to-images) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/document/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/document/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Convert to Markdown @@ -108,6 +115,8 @@ Convert Document to images. | Images | `images` | array[string] | Images converted from the document | | Filenames (optional) | `filenames` | array[string] | The filenames of the images. The filenames will be appended with the page number. e.g. 'example-1.jpg' | + + ## Example Recipes Recipe for the [Content Reviewer](https://instill.tech/instill-ai/pipelines/contract-reviewer/playground) pipeline. @@ -169,4 +178,4 @@ output: contract_summary: title: Contract Summary value: ${gpt-4-summary.output.texts} -``` \ No newline at end of file +``` diff --git a/pkg/component/operator/image/v0/README.mdx b/pkg/component/operator/image/v0/README.mdx index 6b1d3eec6..f4f410445 100644 --- a/pkg/component/operator/image/v0/README.mdx +++ b/pkg/component/operator/image/v0/README.mdx @@ -17,16 +17,23 @@ It can carry out the following tasks: - [Draw Instance Segmentation](#draw-instance-segmentation) - [Draw Semantic Segmentation](#draw-semantic-segmentation) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/image/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/image/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Concat diff --git a/pkg/component/operator/json/v0/README.mdx b/pkg/component/operator/json/v0/README.mdx index 93d8b7499..f3def7e45 100644 --- a/pkg/component/operator/json/v0/README.mdx +++ b/pkg/component/operator/json/v0/README.mdx @@ -11,16 +11,23 @@ It can carry out the following tasks: - [Unmarshal](#unmarshal) - [jq](#jq) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/json/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/json/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Marshal @@ -118,6 +125,8 @@ to access such fields in a `jq` filter is by wrapping the key in double quotes: | Input JSON | `jq` filter | Output | | :--- | :--- | :--- | | `[{"key-a": "value1"}, {"key-a": "value2"}]` | `.[] \| ."key-a"` | `["value1", "value2"]` | + + ## Example Recipes Recipe for the [Resume Screening](https://instill.tech/instill-ai/pipelines/structured-resume-screening/playground) pipeline. diff --git a/pkg/component/operator/text/v0/README.mdx b/pkg/component/operator/text/v0/README.mdx index e2cb9077a..65d2febae 100644 --- a/pkg/component/operator/text/v0/README.mdx +++ b/pkg/component/operator/text/v0/README.mdx @@ -9,16 +9,23 @@ The Text component is an operator component that allows users to extract and man It can carry out the following tasks: - [Chunk Text](#chunk-text) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/text/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/text/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Chunk Text diff --git a/pkg/component/operator/video/v0/README.mdx b/pkg/component/operator/video/v0/README.mdx index d19f74dc5..1316c21ff 100644 --- a/pkg/component/operator/video/v0/README.mdx +++ b/pkg/component/operator/video/v0/README.mdx @@ -10,16 +10,23 @@ It can carry out the following tasks: - [Subsample Video](#subsample-video) - [Subsample Video Frames](#subsample-video-frames) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/video/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/video/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Subsample Video diff --git a/pkg/component/operator/web/v0/README.mdx b/pkg/component/operator/web/v0/README.mdx index 5ad402ab0..a94fa6d83 100644 --- a/pkg/component/operator/web/v0/README.mdx +++ b/pkg/component/operator/web/v0/README.mdx @@ -11,16 +11,23 @@ It can carry out the following tasks: - [Scrape Page](#scrape-page) - [Scrape Sitemap](#scrape-sitemap) + + ## Release Stage `Alpha` + + ## Configuration The component definition and tasks are defined in the [definition.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/web/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component/operator/web/v0/config/tasks.json) files respectively. + + + ## Supported Tasks ### Crawl Site @@ -177,6 +184,8 @@ This task extracts data directly from a website’s sitemap. A sitemap is typica + + ## Example Recipes ```yaml