Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add validation requirement for message fields #9000

Merged
merged 5 commits into from
Jan 8, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions _ml-commons-plugin/api/memory-apis/create-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading