Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <[email protected]>
elastic · Aug 8, 2024 · 65bb68e · 65bb68e
1 parent 5fd5283
commit 65bb68e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/AI-for-security/api/chat-complete-api.asciidoc b/docs/AI-for-security/api/chat-complete-api.asciidoc
@@ -1,7 +1,7 @@
 [[chat-complete-api]]
 === Complete chat
 
-The Chat Complete API allows to communicate to the configured LLM and if needed to persist the result as a conversation (new or extend existing).
+The complete chat API allows you to communicate with the configured large language model (LLM) and, if needed, persist the result as a conversation (create new or extend existing).
 
 [discrete]
 === Request URL
@@ -44,7 +44,7 @@ The Chat Complete API allows to communicate to the configured LLM and if needed
 
 *Example 1*
 
-Sending the message to LLM and getting the response. The data is anonymized with the central anonimization applied and the extended with the list of the fields to anonymize.
+Sends a message to the LLM. The data is anonymized with central anonymization applied and extended with a list of fields to anonymize.
 
 [source,console]
 --------------------------------------------------
@@ -72,7 +72,7 @@ POST api/security_ai_assistant/chat/complete
 
 *Example 2*
 
-Sending the message to LLM within the conversation and the data as a context. The data is anonymized with the central anonimization applied and the extended with the list of the fields to anonymize. Adding the LLM response with the role "assistant" to existing Conversation.
+Sends a message to the LLM within an existing conversation and provides data as a context. The data is anonymized with central anonymization applied and extended with a list of fields to anonymize. Adds the LLM response with the role `assistant` to the existing conversation.
 
 [source,console]
 --------------------------------------------------
@@ -110,7 +110,7 @@ POST api/security_ai_assistant/chat/complete
 
 *Example 3*
 
-Sending the message to LLM. Creating the new Conversation and adding the LLM response with the role "assistant".
+Sends a message to the LLM. Creates a new conversation and adds the LLM response with the role `assistant`.
 
 [source,console]
 --------------------------------------------------

diff --git a/docs/AI-for-security/api/conversation-api-find.asciidoc b/docs/AI-for-security/api/conversation-api-find.asciidoc
@@ -45,7 +45,7 @@ Retrieve a list of Elastic AI Assistant conversations for the current user.
 
 *Example 1*
 
-Get Conversation list for the current user.
+Get a conversation list for the current user.
 
 [source,console]
 --------------------------------------------------

diff --git a/docs/siem-apis.asciidoc b/docs/siem-apis.asciidoc
@@ -13,7 +13,7 @@ NOTE: Console supports sending requests to {kib} APIs. Prepend any {kib} API end
 * <<lists-api-overview>>: Create source event value lists for use with rule exceptions
 * <<timeline-api-overview>>: Import and export timelines
 * <<cases-api-overview>>: Open and manage cases
-* <<assistant-api-overview>>: Security AI Assistant APIs
+* <<assistant-api-overview>>: Interact with and manage Elastic AI Assistant
 * <<asset-criticality-api-overview>>: Create and manage asset criticality records
 
 Additionally, the {kib} <<actions-api-overview, Actions API>> is partially