From 2974847e56c3b72fb12af33f7f4ab84bcc184ede Mon Sep 17 00:00:00 2001 From: Rithin Pullela Date: Wed, 8 Jan 2025 08:44:41 -0800 Subject: [PATCH] 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 * Update _ml-commons-plugin/api/memory-apis/create-message.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Rithin Pullela --------- Signed-off-by: rithin-pullela-aws Signed-off-by: Rithin Pullela Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- .../api/memory-apis/create-message.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/_ml-commons-plugin/api/memory-apis/create-message.md b/_ml-commons-plugin/api/memory-apis/create-message.md index 561e321624..d1272e3e54 100644 --- 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