docs: add validation requirement for message fields (#9000)

* docs: add validation requirement for message fields Add note clarifying that at least one field must be non-null and non-empty for successful message creation/update operations Signed-off-by: rithin-pullela-aws <[email protected]> * Update _ml-commons-plugin/api/memory-apis/create-message.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> --------- Signed-off-by: rithin-pullela-aws <[email protected]> Signed-off-by: Rithin Pullela <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
opensearch-project · Jan 8, 2025 · 9775ca9 · 9775ca9
1 parent 9439bb8
commit 9775ca9
Showing 1 changed file with 8 additions and 5 deletions.
diff --git a/_ml-commons-plugin/api/memory-apis/create-message.md b/_ml-commons-plugin/api/memory-apis/create-message.md
@@ -44,11 +44,14 @@ The following table lists the available request fields.
 
 Field | Data type | Required/Optional | Updatable | Description
 :--- | :--- | :--- | :--- | :---
-| `input` | String | Optional | No | The question (human input) in the message. |
-| `prompt_template` | String | Optional | No | The prompt template that was used for the message. The template may contain instructions or examples that were sent to the large language model. |
-| `response` | String | Optional | No | The answer (generative AI output) to the question. |
-| `origin` | String | Optional | No | The name of the AI or other system that generated the response. |
-| `additional_info` | Object | Optional | Yes | Any other information that was sent to the `origin`. |
+`input` | String | Optional | No | The question (human input) in the message. |
+`prompt_template` | String | Optional | No | The prompt template that was used for the message. The template may contain instructions or examples that were sent to the large language model. |
+`response` | String | Optional | No | The answer (generative AI output) to the question. |
+`origin` | String | Optional | No | The name of the AI or other system that generated the response. |
+`additional_info` | Object | Optional | Yes | Any other information that was sent to the `origin`. |
+
+To create or update a message successfully, you must provide at least one of the preceding fields. The provided field(s) cannot be null or empty.
+{: .note}
 
 #### Example request: Create a message