Skip to content

Commit

Permalink
chore(component): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chuang8511 committed Oct 17, 2024
1 parent 233d20b commit da68466
Show file tree
Hide file tree
Showing 44 changed files with 334 additions and 2 deletions.
9 changes: 9 additions & 0 deletions pkg/component/ai/anthropic/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -122,6 +129,8 @@ The image URL
| Output Tokens | `output-tokens` | number | The output tokens used by Anthropic |
</div>
</details>


## Example Recipes

Recipe for the [List GitHub Repo Issues](https://instill.tech/instill-ai/pipelines/github-demo/playground) pipeline.
Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/cohere/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
9 changes: 9 additions & 0 deletions pkg/component/ai/fireworksai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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 |
</div>
</details>


## Example Recipes

Recipe for the [Fireworks Chinese Content Writer](https://instill.tech/instill-ai/pipelines/fireworks-chinese-content-writer/playground) pipeline.
Expand Down
9 changes: 9 additions & 0 deletions pkg/component/ai/groq/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -124,6 +131,8 @@ The image URL
| Output Tokens | `output-tokens` | number | The output tokens generated by GroqCloud OSS models |
</div>
</details>


## Example Recipes

Recipe for the [Groq Interview Helper](https://instill.tech/instill-ai/pipelines/groq-interview-helper/playground) pipeline.
Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/huggingface/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/instill/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions pkg/component/ai/mistralai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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 |
</div>
</details>


## Example Recipes

Recipe for the [Short-film Script Writer](https://instill.tech/instill-ai/pipelines/mistral-demo/playground) pipeline.
Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/ollama/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
9 changes: 9 additions & 0 deletions pkg/component/ai/openai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -290,6 +297,8 @@ Generate or manipulate images with DALL·E.
| Revised Prompt | `revised-prompt` | string | Revised prompt |
</div>
</details>


## Example Recipes

Recipe for the [PicassoAI: Cubist Creations at Your Command!](https://instill.tech/instill-ai/pipelines/picasso-ai/playground) pipeline.
Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/stabilityai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
7 changes: 7 additions & 0 deletions pkg/component/ai/universalai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
7 changes: 7 additions & 0 deletions pkg/component/application/asana/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
9 changes: 8 additions & 1 deletion pkg/component/application/email/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,25 @@ 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.


## 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/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


Expand Down
7 changes: 7 additions & 0 deletions pkg/component/application/freshdesk/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
9 changes: 9 additions & 0 deletions pkg/component/application/github/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -580,6 +587,8 @@ Create a webhook for a repository
| Webhook URL | `url` | string | URL of the webhook |
</div>
</details>


## Example Recipes

Recipe for the [List GitHub Repo Issues](https://instill.tech/instill-ai/pipelines/github-demo/playground) pipeline.
Expand Down
Loading

0 comments on commit da68466

Please sign in to comment.