Skip to content

Commit

Permalink
chore: exclude mdx and svg files from end-of-file-fixer
Browse files Browse the repository at this point in the history
  • Loading branch information
donch1989 committed Oct 18, 2024
1 parent da68466 commit 32fcb81
Show file tree
Hide file tree
Showing 38 changed files with 70 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/workflows/test-compogen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ jobs:
cd pkg/component/tools/compogen
go mod tidy
go test -mod=mod -race -cover ./...
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions pkg/component/ai/cohere/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
</div>
</details>


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


2 changes: 2 additions & 0 deletions pkg/component/ai/instill/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -581,3 +581,5 @@ The image URL
| :--- | :--- | :--- | :--- |
| Text | `text` | string | Text |
</div>


2 changes: 1 addition & 1 deletion pkg/component/ai/ollama/v0/.compogen/setup-hosting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5. Enjoy fast LLM inference on your local machine and integration with 💧 Instill VDP.
3 changes: 3 additions & 0 deletions pkg/component/ai/ollama/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 |
</div>


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


2 changes: 2 additions & 0 deletions pkg/component/ai/universalai/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,5 @@ Input parameter
| Total Tokens | `total-tokens` | integer | Total number of tokens used in the request (prompt + completion). |
</div>
</details>


2 changes: 2 additions & 0 deletions pkg/component/application/asana/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -642,3 +642,5 @@ Create Portfolio
| User Name | `name` | string | The name of the user. |
</div>
</details>


2 changes: 2 additions & 0 deletions pkg/component/application/email/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 protected]`, you need to input `<[email protected]>`.


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


2 changes: 2 additions & 0 deletions pkg/component/application/googlesearch/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,5 @@ Search data via Google Search Engine.
| Title | `title` | string | The title of a search result, in plain text |
</div>
</details>


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


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


2 changes: 2 additions & 0 deletions pkg/component/application/numbers/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,5 @@ License
| :--- | :--- | :--- | :--- |
| Asset Urls | `asset-urls` | array[string] | Asset Urls |
</div>


2 changes: 2 additions & 0 deletions pkg/component/application/slack/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,3 +142,5 @@ send message to a specific channel
| :--- | :--- | :--- | :--- |
| Result | `result` | string | Result of the message delivery |
</div>


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


2 changes: 2 additions & 0 deletions pkg/component/data/bigquery/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,5 @@ Read data from BigQuery.
| :--- | :--- | :--- | :--- |
| [Data](#read-data) | `data` | array[object] | The data to be read from BigQuery |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/chroma/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -234,3 +234,5 @@ Delete a collection
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Delete collection status |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/elasticsearch/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -308,3 +308,5 @@ Delete an index in Elasticsearch
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Delete index operation status |
</div>


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


Original file line number Diff line number Diff line change
Expand Up @@ -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.
p.s. In Instill Cloud case, you do not need to set up the OpenAI API key.
1 change: 1 addition & 0 deletions pkg/component/data/instillartifact/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 2 additions & 0 deletions pkg/component/data/milvus/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -340,3 +340,5 @@ Drop an index from a collection
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Drop index status |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/mongodb/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -362,3 +362,5 @@ Perform a vector search operation
| Vectors | `vectors` | array | The vectors returned from the vector search operation |
</div>
</details>


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


2 changes: 2 additions & 0 deletions pkg/component/data/qdrant/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -231,3 +231,5 @@ Delete a collection
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Delete collection status |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/redis/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -167,3 +167,5 @@ Write multi-modal chat message into Redis.
| :--- | :--- | :--- | :--- |
| Status | `status` | boolean | The status of the write operation |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/sql/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -274,3 +274,5 @@ Drop a table in the database
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Drop table status |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/weaviate/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,3 +229,5 @@ Delete a collection
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Delete collection status |
</div>


2 changes: 2 additions & 0 deletions pkg/component/data/zilliz/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -287,3 +287,5 @@ Drop a partition from a collection
| :--- | :--- | :--- | :--- |
| Status | `status` | string | Drop partition status |
</div>


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


2 changes: 2 additions & 0 deletions pkg/component/operator/base64/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,5 @@ Decode the base64 string.
| :--- | :--- | :--- | :--- |
| Data | `data` | string | Data |
</div>


2 changes: 1 addition & 1 deletion pkg/component/operator/document/v0/.compogen/bottom.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ output:
contract_summary:
title: Contract Summary
value: ${gpt-4-summary.output.texts}
```
```
2 changes: 2 additions & 0 deletions pkg/component/operator/image/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -414,3 +414,5 @@ A list of RLE binary masks.
| :--- | :--- | :--- | :--- |
| Image | `image` | string | Output image |
</div>


2 changes: 2 additions & 0 deletions pkg/component/operator/text/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,5 @@ This text splitter is specially designed for Markdown format.
| Token Count | `token-count` | integer | Count of tokens in a chunk |
</div>
</details>


2 changes: 2 additions & 0 deletions pkg/component/operator/video/v0/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,3 +82,5 @@ Subsample video into frames
| :--- | :--- | :--- | :--- |
| Frames | `frames` | array[string] | Base64 encoded sub-sampled frames |
</div>


0 comments on commit 32fcb81

Please sign in to comment.