chore: update doc

instill-ai · Sep 13, 2024 · d5053b3 · d5053b3
1 parent 10ef1b3
commit d5053b3
Show file tree

Hide file tree

Showing 36 changed files with 645 additions and 534 deletions.
diff --git a/ai/anthropic/v0/README.mdx b/ai/anthropic/v0/README.mdx
@@ -60,7 +60,7 @@ Provide text outputs in response to text inputs.
 | Prompt (required) | `prompt` | string | The prompt text |
 | System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is set using a generic message as "You are a helpful assistant." |
 | Prompt Images | `prompt-images` | array[string] | The prompt images (Note: The prompt images will be injected in the order they are provided to the 'prompt' message. Anthropic doesn't support sending images via image-url, use this field instead) |
-| [Chat history](#chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\}. |
+| [Chat history](#text-generation-chat-chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\}. |
 | Seed | `seed` | integer | The seed (Note: Not supported by Anthropic Models) |
 | Temperature | `temperature` | number | The temperature for sampling |
 | Top K | `top-k` | integer | Top k for sampling |
@@ -73,30 +73,30 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Chat history
+<h4 id="text-generation-chat-chat-history">Chat history</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Content](#content) | `content` | array | The message content  |
+| [Content](#text-generation-chat-content) | `content` | array | The message content  |
 | Role | `role` | string | The message role, i.e. 'system', 'user' or 'assistant'  |
 
 
 
 
 
-#### Content
+<h4 id="text-generation-chat-content">Content</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Image URL](#image-url) | `image-url` | object | The image URL  |
+| [Image URL](#text-generation-chat-image-url) | `image-url` | object | The image URL  |
 | Text | `text` | string | The text content.  |
-| Type | `type` | string | The type of the content part.  <br/>Enum: <br/><ul><li>text</li><li>image_url</li></ul>  |
+| Type | `type` | string | The type of the content part.  <br/><details> <summary><strong>Enum values</strong>: </summary><ul><li>`text`</li><li>`image_url`</li></ul></details>  |
 
 
 
 
 
-#### Image URL
+<h4 id="text-generation-chat-image-url">Image URL</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -115,7 +115,7 @@ Provide text outputs in response to text inputs.
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Text | `text` | string | Model Output |
-| [Usage](#usage) (optional) | `usage` | object | Usage tokens in Anthropic |
+| [Usage](#text-generation-chat-usage) (optional) | `usage` | object | Usage tokens in Anthropic |
 
 
 
@@ -125,7 +125,7 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Usage
+<h4 id="text-generation-chat-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |

diff --git a/ai/archetypeai/v0/README.mdx b/ai/archetypeai/v0/README.mdx
@@ -71,7 +71,7 @@ Describe a video.
 
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
-| [Descriptions](#descriptions) | `descriptions` | array[object] | A set of descriptions corresponding to different moments in the video |
+| [Descriptions](#describe-descriptions) | `descriptions` | array[object] | A set of descriptions corresponding to different moments in the video |
 
 
 
@@ -81,7 +81,7 @@ Describe a video.
 
 
 
-#### Descriptions
+<h4 id="describe-descriptions">Descriptions</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |

diff --git a/ai/cohere/v0/README.mdx b/ai/cohere/v0/README.mdx
@@ -63,7 +63,7 @@ Provide text outputs in response to text inputs.
 | System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is using a generic message as "You are a helpful assistant." |
 | Documents | `documents` | array[string] | The documents to be used for the model, for optimal performance, the length of each document should be less than 300 words. |
 | Prompt Images | `prompt-images` | array[string] | The prompt images (Note: As for 2024-06-24 Cohere models are not multimodal, so images will be ignored.) |
-| [Chat history](#chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Each message should adhere to the format: : \{"role": "The message role, i.e. 'USER' or 'CHATBOT'", "content": "message content"\}. |
+| [Chat history](#text-generation-chat-chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Each message should adhere to the format: : \{"role": "The message role, i.e. 'USER' or 'CHATBOT'", "content": "message content"\}. |
 | Seed | `seed` | integer | The seed (default=42) |
 | Temperature | `temperature` | number | The temperature for sampling (default=0.7) |
 | Top K | `top-k` | integer | Top k for sampling (default=10) |
@@ -76,30 +76,30 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Chat history
+<h4 id="text-generation-chat-chat-history">Chat history</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Content](#content) | `content` | array | The message content  |
+| [Content](#text-generation-chat-content) | `content` | array | The message content  |
 | Role | `role` | string | The message role, i.e. 'system', 'user' or 'assistant'  |
 
 
 
 
 
-#### Content
+<h4 id="text-generation-chat-content">Content</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Image URL](#image-url) | `image-url` | object | The image URL  |
+| [Image URL](#text-generation-chat-image-url) | `image-url` | object | The image URL  |
 | Text | `text` | string | The text content.  |
-| Type | `type` | string | The type of the content part.  <br/>Enum: <br/><ul><li>text</li><li>image_url</li></ul>  |
+| Type | `type` | string | The type of the content part.  <br/><details> <summary><strong>Enum values</strong>: </summary><ul><li>`text`</li><li>`image_url`</li></ul></details>  |
 
 
 
 
 
-#### Image URL
+<h4 id="text-generation-chat-image-url">Image URL</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -118,8 +118,8 @@ Provide text outputs in response to text inputs.
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Text | `text` | string | Model Output |
-| [Citations](#citations) (optional) | `citations` | array[object] | Citations |
-| [Usage](#usage) (optional) | `usage` | object | Token Usage on the Cohere Platform Command Models |
+| [Citations](#text-generation-chat-citations) (optional) | `citations` | array[object] | Citations |
+| [Usage](#text-generation-chat-usage) (optional) | `usage` | object | Token Usage on the Cohere Platform Command Models |
 
 
 
@@ -129,7 +129,7 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Citations
+<h4 id="text-generation-chat-citations">Citations</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -141,7 +141,7 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Usage
+<h4 id="text-generation-chat-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -181,7 +181,7 @@ Turn text into a vector of numbers that capture its meaning, unlocking use cases
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Embedding | `embedding` | array[number] | Embedding of the input text |
-| [Usage](#usage) (optional) | `usage` | object | Token usage on the Cohere platform embed models |
+| [Usage](#text-embeddings-usage) (optional) | `usage` | object | Token usage on the Cohere platform embed models |
 
 
 
@@ -191,7 +191,7 @@ Turn text into a vector of numbers that capture its meaning, unlocking use cases
 
 
 
-#### Usage
+<h4 id="text-embeddings-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -232,7 +232,7 @@ Sort text inputs by semantic relevance to a specified query.
 | :--- | :--- | :--- | :--- |
 | Reranked documents | `ranking` | array[string] | Reranked documents |
 | Reranked documents relevance (optional) | `relevance` | array[number] | The relevance scores of the reranked documents |
-| [Usage](#usage) (optional) | `usage` | object | Search Usage on the Cohere Platform Rerank Models |
+| [Usage](#text-reranking-usage) (optional) | `usage` | object | Search Usage on the Cohere Platform Rerank Models |
 
 
 
@@ -242,7 +242,7 @@ Sort text inputs by semantic relevance to a specified query.
 
 
 
-#### Usage
+<h4 id="text-reranking-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |

diff --git a/ai/fireworksai/v0/README.mdx b/ai/fireworksai/v0/README.mdx
@@ -61,7 +61,7 @@ Provide text outputs in response to text inputs.
 | Prompt (required) | `prompt` | string | The prompt text |
 | System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is set using a generic message as "You are a helpful assistant." |
 | Prompt Images | `prompt-images` | array[string] | The prompt images (Note: According to Fireworks AI documentation on 2024-07-24, the total number of images included in a single API request should not exceed 30, and all the images should be smaller than 5MB in size) |
-| [Chat history](#chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\} |
+| [Chat history](#text-generation-chat-chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\} |
 | Seed | `seed` | integer | The seed |
 | Temperature | `temperature` | number | The temperature for sampling |
 | Top K | `top-k` | integer | Integer to define the top tokens considered within the sample operation to create new text |
@@ -75,30 +75,30 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Chat history
+<h4 id="text-generation-chat-chat-history">Chat history</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Content](#content) | `content` | array | The message content  |
+| [Content](#text-generation-chat-content) | `content` | array | The message content  |
 | Role | `role` | string | The message role, i.e. 'system', 'user' or 'assistant'  |
 
 
 
 
 
-#### Content
+<h4 id="text-generation-chat-content">Content</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Image URL](#image-url) | `image-url` | object | The image URL  |
+| [Image URL](#text-generation-chat-image-url) | `image-url` | object | The image URL  |
 | Text | `text` | string | The text content.  |
-| Type | `type` | string | The type of the content part.  <br/>Enum: <br/><ul><li>text</li><li>image_url</li></ul>  |
+| Type | `type` | string | The type of the content part.  <br/><details> <summary><strong>Enum values</strong>: </summary><ul><li>`text`</li><li>`image_url`</li></ul></details>  |
 
 
 
 
 
-#### Image URL
+<h4 id="text-generation-chat-image-url">Image URL</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -117,7 +117,7 @@ Provide text outputs in response to text inputs.
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Text | `text` | string | Model Output |
-| [Usage](#usage) (optional) | `usage` | object | Token usage on the Fireworks AI platform text generation models |
+| [Usage](#text-generation-chat-usage) (optional) | `usage` | object | Token usage on the Fireworks AI platform text generation models |
 
 
 
@@ -127,7 +127,7 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Usage
+<h4 id="text-generation-chat-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -165,7 +165,7 @@ Turn text into a vector of numbers that capture its meaning, unlocking use cases
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Embedding | `embedding` | array[number] | Embedding of the input text |
-| [Usage](#usage) (optional) | `usage` | object | Token usage on the Fireworks AI platform embedding models |
+| [Usage](#text-embeddings-usage) (optional) | `usage` | object | Token usage on the Fireworks AI platform embedding models |
 
 
 
@@ -175,7 +175,7 @@ Turn text into a vector of numbers that capture its meaning, unlocking use cases
 
 
 
-#### Usage
+<h4 id="text-embeddings-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |

diff --git a/ai/groq/v0/README.mdx b/ai/groq/v0/README.mdx
@@ -60,7 +60,7 @@ Provide text outputs in response to text inputs.
 | Prompt (required) | `prompt` | string | The prompt text |
 | System message | `system-message` | string | The system message helps set the behavior of the assistant. For example, you can modify the personality of the assistant or provide specific instructions about how it should behave throughout the conversation. By default, the model’s behavior is set using a generic message as "You are a helpful assistant." |
 | Prompt Images | `prompt-images` | array[string] | The prompt images (Note: Only a subset of OSS models support image inputs) |
-| [Chat history](#chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\} |
+| [Chat history](#text-generation-chat-chat-history) | `chat-history` | array[object] | Incorporate external chat history, specifically previous messages within the conversation. Please note that System Message will be ignored and will not have any effect when this field is populated. Each message should adhere to the format: : \{"role": "The message role, i.e. 'system', 'user' or 'assistant'", "content": "message content"\} |
 | Seed | `seed` | integer | The seed |
 | Temperature | `temperature` | number | The temperature for sampling |
 | Top K | `top-k` | integer | Integer to define the top tokens considered within the sample operation to create new text |
@@ -75,30 +75,30 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Chat history
+<h4 id="text-generation-chat-chat-history">Chat history</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Content](#content) | `content` | array | The message content  |
+| [Content](#text-generation-chat-content) | `content` | array | The message content  |
 | Role | `role` | string | The message role, i.e. 'system', 'user' or 'assistant'  |
 
 
 
 
 
-#### Content
+<h4 id="text-generation-chat-content">Content</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
-| [Image URL](#image-url) | `image-url` | object | The image URL  |
+| [Image URL](#text-generation-chat-image-url) | `image-url` | object | The image URL  |
 | Text | `text` | string | The text content.  |
-| Type | `type` | string | The type of the content part.  <br/>Enum: <br/><ul><li>text</li><li>image_url</li></ul>  |
+| Type | `type` | string | The type of the content part.  <br/><details> <summary><strong>Enum values</strong>: </summary><ul><li>`text`</li><li>`image_url`</li></ul></details>  |
 
 
 
 
 
-#### Image URL
+<h4 id="text-generation-chat-image-url">Image URL</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |
@@ -117,7 +117,7 @@ Provide text outputs in response to text inputs.
 | Output | ID | Type | Description |
 | :--- | :--- | :--- | :--- |
 | Text | `text` | string | Model Output |
-| [Usage](#usage) (optional) | `usage` | object | Token usage on the GroqCloud platform text generation models |
+| [Usage](#text-generation-chat-usage) (optional) | `usage` | object | Token usage on the GroqCloud platform text generation models |
 
 
 
@@ -127,7 +127,7 @@ Provide text outputs in response to text inputs.
 
 
 
-#### Usage
+<h4 id="text-generation-chat-usage">Usage</h4>
 
 | Field | Field ID | Type | Note |
 | :--- | :--- | :--- | :--- |