Skip to content

Commit f2cea0e

Browse files
chuang8511chuang8511
committed
chore: update doc to avoid collision of tag
1 parent 5d60f32 commit f2cea0e

File tree

2 files changed

+42
-42
lines changed

2 files changed

+42
-42
lines changed

‎pkg/component/ai/instillmodel/v0/README.mdx

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Input data.
6262

6363
| Field | Field ID | Type | Note |
6464
| :--- | :--- | :--- | :--- |
65-
| [Embeddings](#embedding-embeddings) | `embeddings` | array | List of input data to be embedded. |
65+
| [Input Embeddings](#embedding-input-embeddings) | `embeddings` | array | List of input data to be embedded. |
6666
| Model | `model` | string | The model to be used for generating embeddings. It should be `namespace/model-name/version`. i.e. `admin/dummy-model/latest`. You can see the version from the Versions tab of Model page. |
6767
</div>
6868
<h4 id="embedding-parameter">Parameter</h4>
@@ -134,10 +134,10 @@ Input parameter.
134134

135135
| Field | Field ID | Type | Note |
136136
| :--- | :--- | :--- | :--- |
137-
| [Embeddings](#embedding-embeddings) | `embeddings` | array | List of generated embeddings. |
137+
| [Output Embeddings](#embedding-output-embeddings) | `embeddings` | array | List of generated embeddings. |
138138
</div>
139139

140-
<h4 id="embedding-embeddings">Embeddings</h4>
140+
<h4 id="embedding-output-embeddings">Output Embeddings</h4>
141141

142142
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
143143

@@ -316,15 +316,15 @@ This task generates natural language responses based on a given input prompt. It
316316
| Input | ID | Type | Description |
317317
| :--- | :--- | :--- | :--- |
318318
| Task ID (required) | `task` | string | `TASK_COMPLETION` |
319-
| [Data](#completion-data) (required) | `data` | object | Contains the model name and the prompt for generating a response. This section defines the input prompt and guides the model's behavior using the specified system message. |
319+
| [Input Data](#completion-input-data) (required) | `data` | object | Contains the model name and the prompt for generating a response. This section defines the input prompt and guides the model's behavior using the specified system message. |
320320
| [Parameter](#completion-parameter) | `parameter` | object | Optional settings to control the model’s behavior, including token limit, randomness, and response length. |
321321
</div>
322322

323323

324324
<details>
325325
<summary> Input Objects in Completion</summary>
326326

327-
<h4 id="completion-data">Data</h4>
327+
<h4 id="completion-input-data">Input Data</h4>
328328

329329
Contains the model name and the prompt for generating a response. This section defines the input prompt and guides the model's behavior using the specified system message.
330330

@@ -359,14 +359,14 @@ Optional settings to control the model’s behavior, including token limit, rand
359359

360360
| Output | ID | Type | Description |
361361
| :--- | :--- | :--- | :--- |
362-
| [Data](#completion-data) | `data` | object | Contains the generated responses and details like why the model stopped and when the response was generated. |
362+
| [Output Data](#completion-output-data) | `data` | object | Contains the generated responses and details like why the model stopped and when the response was generated. |
363363
| [Metadata](#completion-metadata) (optional) | `metadata` | object | Provides information on how many tokens were used in both the input prompt and the generated response. |
364364
</div>
365365

366366
<details>
367367
<summary> Output Objects in Completion</summary>
368368

369-
<h4 id="completion-data">Data</h4>
369+
<h4 id="completion-output-data">Output Data</h4>
370370

371371
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
372372

@@ -457,14 +457,14 @@ This section defines optional parameters that modify the behavior of the image g
457457

458458
| Output | ID | Type | Description |
459459
| :--- | :--- | :--- | :--- |
460-
| [Data](#text-to-image-data) | `data` | object | The data section contains the core output of the image generation task. It includes all relevant information generated by the model, such as the list of created images and their associated metadata, providing a comprehensive result for each input prompt. |
460+
| [Output Data](#text-to-image-output-data) | `data` | object | The data section contains the core output of the image generation task. It includes all relevant information generated by the model, such as the list of created images and their associated metadata, providing a comprehensive result for each input prompt. |
461461
| [Metadata](#text-to-image-metadata) (optional) | `metadata` | object | Provides additional details about the image generation request, such as usage statistics and resource consumption. |
462462
</div>
463463

464464
<details>
465465
<summary> Output Objects in Text To Image</summary>
466466

467-
<h4 id="text-to-image-data">Data</h4>
467+
<h4 id="text-to-image-output-data">Output Data</h4>
468468

469469
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
470470

@@ -547,14 +547,14 @@ Specifies the classification model to be utilized for the task. This field must
547547

548548
| Output | ID | Type | Description |
549549
| :--- | :--- | :--- | :--- |
550-
| [Data](#classification-data) | `data` | object | Contains the results of the classification task, including the predicted category and its associated confidence score. This structured output allows users to understand the model's classification decision and assess its reliability based on the score provided. |
550+
| [Output Data](#classification-output-data) | `data` | object | Contains the results of the classification task, including the predicted category and its associated confidence score. This structured output allows users to understand the model's classification decision and assess its reliability based on the score provided. |
551551
| [Metadata](#classification-metadata) (optional) | `metadata` | object | Contains additional information about the request, including usage statistics. This data provides context and insights regarding the classification process, helping users evaluate performance and resource consumption during the classification task. |
552552
</div>
553553

554554
<details>
555555
<summary> Output Objects in Classification</summary>
556556

557-
<h4 id="classification-data">Data</h4>
557+
<h4 id="classification-output-data">Output Data</h4>
558558

559559
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
560560

@@ -583,7 +583,7 @@ This task focuses on identifying and localizing multiple objects within images,
583583
| Input | ID | Type | Description |
584584
| :--- | :--- | :--- | :--- |
585585
| Task ID (required) | `task` | string | `TASK_DETECTION` |
586-
| [Data](#detection-data) (required) | `data` | object | Contains the data required for the detection process. It can include either an image URL or a base64-encoded image representation for detection. |
586+
| [Input Data](#detection-input-data) (required) | `data` | object | Contains the data required for the detection process. It can include either an image URL or a base64-encoded image representation for detection. |
587587
| Parameter | `parameter` | object | An object representing any additional parameters for the detection task. This section is currently empty but can be extended for future needs. |
588588
</div>
589589

@@ -628,14 +628,14 @@ Specifies the detection model to be utilized for the task. This field must conta
628628

629629
| Output | ID | Type | Description |
630630
| :--- | :--- | :--- | :--- |
631-
| [Data](#detection-data) | `data` | object | Contains the results generated by the detection task, including a list of objects detected in the input image along with their details. |
631+
| [Output Data](#detection-output-data) | `data` | object | Contains the results generated by the detection task, including a list of objects detected in the input image along with their details. |
632632
| [Metadata](#detection-metadata) (optional) | `metadata` | object | Contains metadata related to the detection task's output, providing insights into the request's processing and any relevant statistics. |
633633
</div>
634634

635635
<details>
636636
<summary> Output Objects in Detection</summary>
637637

638-
<h4 id="detection-data">Data</h4>
638+
<h4 id="detection-output-data">Output Data</h4>
639639

640640
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
641641

@@ -686,7 +686,7 @@ Detects and localizes multiple keypoints within objects in images, providing pre
686686
| Input | ID | Type | Description |
687687
| :--- | :--- | :--- | :--- |
688688
| Task ID (required) | `task` | string | `TASK_KEYPOINT` |
689-
| [Data](#keypoint-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for keypoint detection. Each input type requires model selection for processing. |
689+
| [Input Data](#keypoint-input-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for keypoint detection. Each input type requires model selection for processing. |
690690
| Parameter | `parameter` | object | Optional parameters for the keypoint detection task, allowing for adjustments in processing. |
691691
</div>
692692

@@ -727,14 +727,14 @@ Detects and localizes multiple keypoints within objects in images, providing pre
727727

728728
| Output | ID | Type | Description |
729729
| :--- | :--- | :--- | :--- |
730-
| [Data](#keypoint-data) | `data` | object | Contains detected objects and associated keypoints for keypoint detection output. Each object includes its bounding box, keypoints, and confidence score. |
730+
| [Output Data](#keypoint-output-data) | `data` | object | Contains detected objects and associated keypoints for keypoint detection output. Each object includes its bounding box, keypoints, and confidence score. |
731731
| [Metadata](#keypoint-metadata) (optional) | `metadata` | object | Contains additional metadata for the keypoint detection task output, including request-specific usage information. |
732732
</div>
733733

734734
<details>
735735
<summary> Output Objects in Keypoint</summary>
736736

737-
<h4 id="keypoint-data">Data</h4>
737+
<h4 id="keypoint-output-data">Output Data</h4>
738738

739739
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
740740

@@ -796,7 +796,7 @@ Optical Character Recognition (OCR) is a process that detects and extracts text
796796
| Input | ID | Type | Description |
797797
| :--- | :--- | :--- | :--- |
798798
| Task ID (required) | `task` | string | `TASK_OCR` |
799-
| [Data](#ocr-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for OCR. Each input type requires model selection for processing. |
799+
| [Input Data](#ocr-input-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for OCR. Each input type requires model selection for processing. |
800800
| Parameter | `parameter` | object | The parameter field is an optional object that allows you to provide specific configurations for the OCR task. Although empty by default, it can be populated with parameters that fine-tune processing or control the model’s behavior. These configurations can help adjust the output according to specific OCR requirements or performance optimizations. |
801801
</div>
802802

@@ -837,14 +837,14 @@ Optical Character Recognition (OCR) is a process that detects and extracts text
837837

838838
| Output | ID | Type | Description |
839839
| :--- | :--- | :--- | :--- |
840-
| [Data](#ocr-data) | `data` | object | Contains the structured output data of the OCR task, presenting a list of detected objects, each represented by a bounding box, recognized text, and associated confidence scores. |
840+
| [Output Data](#ocr-output-data) | `data` | object | Contains the structured output data of the OCR task, presenting a list of detected objects, each represented by a bounding box, recognized text, and associated confidence scores. |
841841
| [Metadata](#ocr-metadata) (optional) | `metadata` | object | Contains additional information on the OCR task, including performance metrics and system usage statistics for the request. |
842842
</div>
843843

844844
<details>
845845
<summary> Output Objects in OCR</summary>
846846

847-
<h4 id="ocr-data">Data</h4>
847+
<h4 id="ocr-output-data">Output Data</h4>
848848

849849
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
850850

@@ -895,7 +895,7 @@ This task involves classifying each pixel in an image into specific, predefined
895895
| Input | ID | Type | Description |
896896
| :--- | :--- | :--- | :--- |
897897
| Task ID (required) | `task` | string | `TASK_SEMANTIC_SEGMENTATION` |
898-
| [Data](#semantic-segmentation-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for semantic segmentation. Each input type requires model selection for processing. |
898+
| [Input Data](#semantic-segmentation-input-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for semantic segmentation. Each input type requires model selection for processing. |
899899
| Parameter | `parameter` | object | This object contains configuration options that allow customization of the semantic segmentation task, such as adjusting thresholds or model settings. |
900900
</div>
901901

@@ -936,14 +936,14 @@ This task involves classifying each pixel in an image into specific, predefined
936936

937937
| Output | ID | Type | Description |
938938
| :--- | :--- | :--- | :--- |
939-
| [Data](#semantic-segmentation-data) | `data` | object | Contains the output data of the semantic segmentation task, detailing the segmented areas through RLE masks. Each segment corresponds to a specific category, providing essential data for analyzing the results. |
939+
| [Output Data](#semantic-segmentation-output-data) | `data` | object | Contains the output data of the semantic segmentation task, detailing the segmented areas through RLE masks. Each segment corresponds to a specific category, providing essential data for analyzing the results. |
940940
| [Metadata](#semantic-segmentation-metadata) (optional) | `metadata` | object | Contains additional information about the output, including statistics regarding the usage of the segmentation request. It helps track the performance and efficiency of the task. |
941941
</div>
942942

943943
<details>
944944
<summary> Output Objects in Semantic Segmentation</summary>
945945

946-
<h4 id="semantic-segmentation-data">Data</h4>
946+
<h4 id="semantic-segmentation-output-data">Output Data</h4>
947947

948948
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
949949

@@ -981,7 +981,7 @@ This task is a computer vision task that identifies and distinguishes multiple o
981981
| Input | ID | Type | Description |
982982
| :--- | :--- | :--- | :--- |
983983
| Task ID (required) | `task` | string | `TASK_INSTANCE_SEGMENTATION` |
984-
| [Data](#instance-segmentation-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for instance segmentation. Each input type requires model selection for processing. |
984+
| [Input Data](#instance-segmentation-input-data) (required) | `data` | object | Contains input data options, allowing for an image URL or a base64-encoded image file for instance segmentation. Each input type requires model selection for processing. |
985985
| Parameter | `parameter` | object | Placeholder for additional input parameters, providing flexibility for task customization. |
986986
</div>
987987

@@ -1022,14 +1022,14 @@ This task is a computer vision task that identifies and distinguishes multiple o
10221022

10231023
| Output | ID | Type | Description |
10241024
| :--- | :--- | :--- | :--- |
1025-
| [Data](#instance-segmentation-data) | `data` | object | Contains segmented instance data, including each detected object and its corresponding segmentation information. |
1025+
| [Output Data](#instance-segmentation-output-data) | `data` | object | Contains segmented instance data, including each detected object and its corresponding segmentation information. |
10261026
| [Metadata](#instance-segmentation-metadata) (optional) | `metadata` | object | Metadata accompanying the output, providing additional context like usage statistics for the segmentation request. |
10271027
</div>
10281028

10291029
<details>
10301030
<summary> Output Objects in Instance Segmentation</summary>
10311031

1032-
<h4 id="instance-segmentation-data">Data</h4>
1032+
<h4 id="instance-segmentation-output-data">Output Data</h4>
10331033

10341034
<div class="markdown-col-no-wrap" data-col-1 data-col-2>
10351035

0 commit comments

Comments
 (0)