diff --git a/.github/workflows/test-compogen.yml b/.github/workflows/test-compogen.yml index 69fbaecd8..9bfd6abd0 100644 --- a/.github/workflows/test-compogen.yml +++ b/.github/workflows/test-compogen.yml @@ -34,4 +34,3 @@ jobs: cd pkg/component/tools/compogen go mod tidy go test -mod=mod -race -cover ./... - diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4d99acf41..9faea3c61 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,6 +5,7 @@ repos: - id: check-yaml - id: end-of-file-fixer exclude: (?i).*testdata/ + exclude_types: [svg, mdx] - id: trailing-whitespace exclude: (?i).*testdata/ - repo: https://github.com/dnephin/pre-commit-golang diff --git a/pkg/component/ai/cohere/v0/README.mdx b/pkg/component/ai/cohere/v0/README.mdx index d77eb60a1..56abe2291 100644 --- a/pkg/component/ai/cohere/v0/README.mdx +++ b/pkg/component/ai/cohere/v0/README.mdx @@ -228,3 +228,5 @@ Rerank models sort text inputs by semantic relevance to a specified query. They | Search Counts | `search-counts` | number | The search count used by Cohere Models | + + diff --git a/pkg/component/ai/huggingface/v0/README.mdx b/pkg/component/ai/huggingface/v0/README.mdx index cf5ae0edf..58126d9dd 100644 --- a/pkg/component/ai/huggingface/v0/README.mdx +++ b/pkg/component/ai/huggingface/v0/README.mdx @@ -920,3 +920,5 @@ Audio classification is the task of assigning a label or class to a given audio. | Score | `score` | number | A float that represents how likely it is that the audio file belongs to this class. | + + diff --git a/pkg/component/ai/instill/v0/README.mdx b/pkg/component/ai/instill/v0/README.mdx index 1c6f22629..f37743e2d 100644 --- a/pkg/component/ai/instill/v0/README.mdx +++ b/pkg/component/ai/instill/v0/README.mdx @@ -581,3 +581,5 @@ The image URL | :--- | :--- | :--- | :--- | | Text | `text` | string | Text | + + diff --git a/pkg/component/ai/ollama/v0/.compogen/setup-hosting.mdx b/pkg/component/ai/ollama/v0/.compogen/setup-hosting.mdx index 7be0a9eef..d7a9757f1 100644 --- a/pkg/component/ai/ollama/v0/.compogen/setup-hosting.mdx +++ b/pkg/component/ai/ollama/v0/.compogen/setup-hosting.mdx @@ -10,4 +10,4 @@ To set up an Ollama instance on your local machine, follow the instructions belo - On Linux and macOS, open the terminal and type `ifconfig`. - On Windows, open the command prompt and type `ipconfig`. 4. Suppose the IP address is `192.168.178.88`, then the Ollama hosting endpoint would be `192.168.178.88:11434`. -5. Enjoy fast LLM inference on your local machine and integration with 💧 Instill VDP. \ No newline at end of file +5. Enjoy fast LLM inference on your local machine and integration with 💧 Instill VDP. diff --git a/pkg/component/ai/ollama/v0/README.mdx b/pkg/component/ai/ollama/v0/README.mdx index 635dc35dd..260c20528 100644 --- a/pkg/component/ai/ollama/v0/README.mdx +++ b/pkg/component/ai/ollama/v0/README.mdx @@ -129,6 +129,7 @@ To set up an Ollama instance on your local machine, follow the instructions belo - On Windows, open the command prompt and type `ipconfig`. 4. Suppose the IP address is `192.168.178.88`, then the Ollama hosting endpoint would be `192.168.178.88:11434`. 5. Enjoy fast LLM inference on your local machine and integration with 💧 Instill VDP. + ### Text Embeddings An embedding is a list of floating point numbers that captures semantic information about the text that it represents. @@ -153,3 +154,5 @@ An embedding is a list of floating point numbers that captures semantic informat | :--- | :--- | :--- | :--- | | Embedding | `embedding` | array[number] | Embedding of the input text | + + diff --git a/pkg/component/ai/stabilityai/v0/README.mdx b/pkg/component/ai/stabilityai/v0/README.mdx index c339f0544..9992e042f 100644 --- a/pkg/component/ai/stabilityai/v0/README.mdx +++ b/pkg/component/ai/stabilityai/v0/README.mdx @@ -122,3 +122,5 @@ Modify an image based on a text prompt. | Images | `images` | array[string] | Generated images | | Seeds | `seeds` | array[number] | Seeds of generated images | + + diff --git a/pkg/component/ai/universalai/v0/README.mdx b/pkg/component/ai/universalai/v0/README.mdx index b82e39491..1454707ae 100644 --- a/pkg/component/ai/universalai/v0/README.mdx +++ b/pkg/component/ai/universalai/v0/README.mdx @@ -170,3 +170,5 @@ Input parameter | Total Tokens | `total-tokens` | integer | Total number of tokens used in the request (prompt + completion). | + + diff --git a/pkg/component/application/asana/v0/README.mdx b/pkg/component/application/asana/v0/README.mdx index 75790c639..e258566bc 100644 --- a/pkg/component/application/asana/v0/README.mdx +++ b/pkg/component/application/asana/v0/README.mdx @@ -642,3 +642,5 @@ Create Portfolio | User Name | `name` | string | The name of the user. | + + diff --git a/pkg/component/application/email/v0/README.mdx b/pkg/component/application/email/v0/README.mdx index c31c041ba..6c52af1d4 100644 --- a/pkg/component/application/email/v0/README.mdx +++ b/pkg/component/application/email/v0/README.mdx @@ -181,3 +181,5 @@ Take Gmail as an example, the mailbox names are following. #### Search From and Search To You need to input the exact same email address with `<` as a prefix and `>` as a suffix as the email you want to search for. For example, if you want to search for the email from `email@example.com`, you need to input ``. + + diff --git a/pkg/component/application/freshdesk/v0/README.mdx b/pkg/component/application/freshdesk/v0/README.mdx index b99e93472..47da79245 100644 --- a/pkg/component/application/freshdesk/v0/README.mdx +++ b/pkg/component/application/freshdesk/v0/README.mdx @@ -634,3 +634,5 @@ Get skill using ID. This task will only work if you have admin privileges. Agent | Created At | `created-at` | string | Timestamp that denotes when the skill was created | | Updated At | `updated-at` | string | Timestamp that denotes when the skill was last updated | + + diff --git a/pkg/component/application/googlesearch/v0/README.mdx b/pkg/component/application/googlesearch/v0/README.mdx index ee4483c41..96fdf501a 100644 --- a/pkg/component/application/googlesearch/v0/README.mdx +++ b/pkg/component/application/googlesearch/v0/README.mdx @@ -91,3 +91,5 @@ Search data via Google Search Engine. | Title | `title` | string | The title of a search result, in plain text | + + diff --git a/pkg/component/application/hubspot/v0/README.mdx b/pkg/component/application/hubspot/v0/README.mdx index c1ac59728..06f3d9fd1 100644 --- a/pkg/component/application/hubspot/v0/README.mdx +++ b/pkg/component/application/hubspot/v0/README.mdx @@ -593,3 +593,5 @@ Get all the IDs for a specific object (e.g. all contact IDs) | Object ID Array | `object-ids` | array[string] | An array of object ID | | Object IDs Length | `object-ids-length` | integer | The number of object IDs | + + diff --git a/pkg/component/application/instillapp/v0/README.mdx b/pkg/component/application/instillapp/v0/README.mdx index 381b8a367..1cd1ed3a5 100644 --- a/pkg/component/application/instillapp/v0/README.mdx +++ b/pkg/component/application/instillapp/v0/README.mdx @@ -116,3 +116,5 @@ A chat message to be written into the conversation. | Create Time | `create-time` | string | The creation time of the message in ISO 8601 format | | Update Time | `update-time` | string | The update time of the message in ISO 8601 format | + + diff --git a/pkg/component/application/numbers/v0/README.mdx b/pkg/component/application/numbers/v0/README.mdx index 9e75f1096..d759934b6 100644 --- a/pkg/component/application/numbers/v0/README.mdx +++ b/pkg/component/application/numbers/v0/README.mdx @@ -91,3 +91,5 @@ License | :--- | :--- | :--- | :--- | | Asset Urls | `asset-urls` | array[string] | Asset Urls | + + diff --git a/pkg/component/application/slack/v0/README.mdx b/pkg/component/application/slack/v0/README.mdx index dd47d3519..694539023 100644 --- a/pkg/component/application/slack/v0/README.mdx +++ b/pkg/component/application/slack/v0/README.mdx @@ -142,3 +142,5 @@ send message to a specific channel | :--- | :--- | :--- | :--- | | Result | `result` | string | Result of the message delivery | + + diff --git a/pkg/component/application/whatsapp/v0/README.mdx b/pkg/component/application/whatsapp/v0/README.mdx index 01c25897b..7de5987c1 100644 --- a/pkg/component/application/whatsapp/v0/README.mdx +++ b/pkg/component/application/whatsapp/v0/README.mdx @@ -338,3 +338,5 @@ Send interactive Call-To-Action URL button message. Note: Message can only be se | Recipient WhatsApp ID | `recipient-wa-id` | string | The WhatsApp ID of the recipient. Most likely the same with their phone number. | | Message ID | `message-id` | string | The ID of the message | + + diff --git a/pkg/component/data/bigquery/v0/README.mdx b/pkg/component/data/bigquery/v0/README.mdx index c92b8910c..c35044592 100644 --- a/pkg/component/data/bigquery/v0/README.mdx +++ b/pkg/component/data/bigquery/v0/README.mdx @@ -98,3 +98,5 @@ Read data from BigQuery. | :--- | :--- | :--- | :--- | | [Data](#read-data) | `data` | array[object] | The data to be read from BigQuery | + + diff --git a/pkg/component/data/chroma/v0/README.mdx b/pkg/component/data/chroma/v0/README.mdx index cc63a4793..69ff38577 100644 --- a/pkg/component/data/chroma/v0/README.mdx +++ b/pkg/component/data/chroma/v0/README.mdx @@ -234,3 +234,5 @@ Delete a collection | :--- | :--- | :--- | :--- | | Status | `status` | string | Delete collection status | + + diff --git a/pkg/component/data/elasticsearch/v0/README.mdx b/pkg/component/data/elasticsearch/v0/README.mdx index 6a915ffad..8efe6fec1 100644 --- a/pkg/component/data/elasticsearch/v0/README.mdx +++ b/pkg/component/data/elasticsearch/v0/README.mdx @@ -308,3 +308,5 @@ Delete an index in Elasticsearch | :--- | :--- | :--- | :--- | | Status | `status` | string | Delete index operation status | + + diff --git a/pkg/component/data/googlecloudstorage/v0/README.mdx b/pkg/component/data/googlecloudstorage/v0/README.mdx index eaf92bb0e..ac50c48dd 100644 --- a/pkg/component/data/googlecloudstorage/v0/README.mdx +++ b/pkg/component/data/googlecloudstorage/v0/README.mdx @@ -286,3 +286,5 @@ Read objects from Google Cloud Storage. | Bucket Name (optional) | `name` | string | The name of the bucket | | Location (optional) | `location` | string | The location of the bucket | + + diff --git a/pkg/component/data/instillartifact/v0/.compogen/extra-intro.mdx b/pkg/component/data/instillartifact/v0/.compogen/extra-intro.mdx index 9ada1d17e..2fb351914 100644 --- a/pkg/component/data/instillartifact/v0/.compogen/extra-intro.mdx +++ b/pkg/component/data/instillartifact/v0/.compogen/extra-intro.mdx @@ -3,4 +3,4 @@ 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) -p.s. In Instill Cloud case, you do not need to set up the OpenAI API key. \ No newline at end of file +p.s. In Instill Cloud case, you do not need to set up the OpenAI API key. diff --git a/pkg/component/data/instillartifact/v0/README.mdx b/pkg/component/data/instillartifact/v0/README.mdx index d3324e5f1..05391404d 100644 --- a/pkg/component/data/instillartifact/v0/README.mdx +++ b/pkg/component/data/instillartifact/v0/README.mdx @@ -23,6 +23,7 @@ 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) p.s. In Instill Cloud case, you do not need to set up the OpenAI API key. + ## Release Stage `Alpha` diff --git a/pkg/component/data/milvus/v0/README.mdx b/pkg/component/data/milvus/v0/README.mdx index a0da515ce..2fb075dae 100644 --- a/pkg/component/data/milvus/v0/README.mdx +++ b/pkg/component/data/milvus/v0/README.mdx @@ -340,3 +340,5 @@ Drop an index from a collection | :--- | :--- | :--- | :--- | | Status | `status` | string | Drop index status | + + diff --git a/pkg/component/data/mongodb/v0/README.mdx b/pkg/component/data/mongodb/v0/README.mdx index c20f83db3..285ee7c13 100644 --- a/pkg/component/data/mongodb/v0/README.mdx +++ b/pkg/component/data/mongodb/v0/README.mdx @@ -362,3 +362,5 @@ Perform a vector search operation | Vectors | `vectors` | array | The vectors returned from the vector search operation | + + diff --git a/pkg/component/data/pinecone/v0/README.mdx b/pkg/component/data/pinecone/v0/README.mdx index ada4fd036..9f2f1d247 100644 --- a/pkg/component/data/pinecone/v0/README.mdx +++ b/pkg/component/data/pinecone/v0/README.mdx @@ -123,3 +123,5 @@ Writes vectors into a namespace. If a new value is upserted for an existing vect | :--- | :--- | :--- | :--- | | Upserted Count | `upserted-count` | integer | Number of records modified or added | + + diff --git a/pkg/component/data/qdrant/v0/README.mdx b/pkg/component/data/qdrant/v0/README.mdx index b0500627f..ce489cec0 100644 --- a/pkg/component/data/qdrant/v0/README.mdx +++ b/pkg/component/data/qdrant/v0/README.mdx @@ -231,3 +231,5 @@ Delete a collection | :--- | :--- | :--- | :--- | | Status | `status` | string | Delete collection status | + + diff --git a/pkg/component/data/redis/v0/README.mdx b/pkg/component/data/redis/v0/README.mdx index 0549d0a3f..20b1ddb34 100644 --- a/pkg/component/data/redis/v0/README.mdx +++ b/pkg/component/data/redis/v0/README.mdx @@ -167,3 +167,5 @@ Write multi-modal chat message into Redis. | :--- | :--- | :--- | :--- | | Status | `status` | boolean | The status of the write operation | + + diff --git a/pkg/component/data/sql/v0/README.mdx b/pkg/component/data/sql/v0/README.mdx index fefb30289..a81fbe081 100644 --- a/pkg/component/data/sql/v0/README.mdx +++ b/pkg/component/data/sql/v0/README.mdx @@ -274,3 +274,5 @@ Drop a table in the database | :--- | :--- | :--- | :--- | | Status | `status` | string | Drop table status | + + diff --git a/pkg/component/data/weaviate/v0/README.mdx b/pkg/component/data/weaviate/v0/README.mdx index abc0498aa..cbbfbbbaf 100644 --- a/pkg/component/data/weaviate/v0/README.mdx +++ b/pkg/component/data/weaviate/v0/README.mdx @@ -229,3 +229,5 @@ Delete a collection | :--- | :--- | :--- | :--- | | Status | `status` | string | Delete collection status | + + diff --git a/pkg/component/data/zilliz/v0/README.mdx b/pkg/component/data/zilliz/v0/README.mdx index 94ded457e..b595380e8 100644 --- a/pkg/component/data/zilliz/v0/README.mdx +++ b/pkg/component/data/zilliz/v0/README.mdx @@ -287,3 +287,5 @@ Drop a partition from a collection | :--- | :--- | :--- | :--- | | Status | `status` | string | Drop partition status | + + diff --git a/pkg/component/generic/restapi/v0/README.mdx b/pkg/component/generic/restapi/v0/README.mdx index 9799df3ba..e74fcf657 100644 --- a/pkg/component/generic/restapi/v0/README.mdx +++ b/pkg/component/generic/restapi/v0/README.mdx @@ -295,3 +295,5 @@ Send a HTTP OPTIONS request. | Body | `body` | any | The body of the response | | Header | `header` | object | The HTTP header of the response | + + diff --git a/pkg/component/operator/base64/v0/README.mdx b/pkg/component/operator/base64/v0/README.mdx index b4c23923c..e83c1b46d 100644 --- a/pkg/component/operator/base64/v0/README.mdx +++ b/pkg/component/operator/base64/v0/README.mdx @@ -76,3 +76,5 @@ Decode the base64 string. | :--- | :--- | :--- | :--- | | Data | `data` | string | Data | + + diff --git a/pkg/component/operator/document/v0/.compogen/bottom.mdx b/pkg/component/operator/document/v0/.compogen/bottom.mdx index ba1f7bbaa..8151ac812 100644 --- a/pkg/component/operator/document/v0/.compogen/bottom.mdx +++ b/pkg/component/operator/document/v0/.compogen/bottom.mdx @@ -59,4 +59,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 f4f410445..9d1ef152e 100644 --- a/pkg/component/operator/image/v0/README.mdx +++ b/pkg/component/operator/image/v0/README.mdx @@ -414,3 +414,5 @@ A list of RLE binary masks. | :--- | :--- | :--- | :--- | | Image | `image` | string | Output image | + + diff --git a/pkg/component/operator/text/v0/README.mdx b/pkg/component/operator/text/v0/README.mdx index 65d2febae..ecacc8520 100644 --- a/pkg/component/operator/text/v0/README.mdx +++ b/pkg/component/operator/text/v0/README.mdx @@ -137,3 +137,5 @@ This text splitter is specially designed for Markdown format. | Token Count | `token-count` | integer | Count of tokens in a chunk | + + diff --git a/pkg/component/operator/video/v0/README.mdx b/pkg/component/operator/video/v0/README.mdx index 1316c21ff..f24196459 100644 --- a/pkg/component/operator/video/v0/README.mdx +++ b/pkg/component/operator/video/v0/README.mdx @@ -82,3 +82,5 @@ Subsample video into frames | :--- | :--- | :--- | :--- | | Frames | `frames` | array[string] | Base64 encoded sub-sampled frames | + +