Line edits of descriptions

YulNaumenko · Aug 8, 2024 · d97a65e · d97a65e
1 parent cd5458f
commit d97a65e
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 32 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]]
 === Chat Complete API
 
-The Chat Complete API lets you create new Elastic AI Assistant conversations, and add messages to existing conversations.
+The Chat Complete API lets you create new Elastic AI Assistant conversations and add messages to existing conversations.
 
 [discrete]
 === Request URL
@@ -15,14 +15,14 @@ The Chat Complete API lets you create new Elastic AI Assistant conversations, an
 |==============================================
 |Name |Type |Description |Required
 
-|`conversationId` |String |Conversation id to which append the messages and use as a context. See conversations APIs. |No
-|`connectorId` |String |Unique identifier for a connector saved object. Connector is a Kibana integration with the specific LLM provider. |Yes
-|`promptId` |String |Default conversation prompt Id. |No
-|`persist` |Boolean |Define if the new conversation should be created or updated if `conversationId` is provided. |Yes
-|`isStream` |Boolean |Define the type of the response. If isStream equals `true`, the result will be returned as a streaming chunks. |No
-|`messages` |<<message-obj,message object>> |Array of conversation messages. |Yes
-|`model` |String |LLM provider specific model to use. |No
-|`responseLanguage` |String |Defines the language for LLM to response with. |No
+|`conversationId` |String |Conversation ID to append to messages and use as context. Refer to conversation APIs. |No
+|`connectorId` |String |ID for an LLM connector: a Kibana integration with the specific LLM provider. |Yes
+|`promptId` |String |Default conversation prompt ID. |No
+|`persist` |Boolean |Defines if the conversation should be created, or updated (if `conversationId` is provided). |Yes
+|`isStream` |Boolean |Define the type of the response. If `isStream` equals `true`, the result will be returned as streaming chunks. |No
+|`messages` |<<message-obj,Message object>> |Array of conversation messages. |Yes
+|`model` |String |Name of a specific LLM to use. |No
+|`responseLanguage` |String |Defines the language for the LLM to respond in. |No
 |==============================================
 
 [discrete]
@@ -33,10 +33,10 @@ The Chat Complete API lets you create new Elastic AI Assistant conversations, an
 |==============================================
 |Name |Type |Description |Required
 
-|`role` |String |Message role. Could be "user", "assisatnt" or "system". |Yes
+|`role` |String |Message role. Can be "user", "assistant" or "system". |Yes
 |`content` |String |Message content to send to LLM. |Yes
-|`data` |Object |JSON object to extend the context with the specific field of the document. |No
-|`fields_to_anonymize` |Array |List of the fields in `data` object, which should be anonymized. |No
+|`data` |Object |JSON object to include as context for the model. |No
+|`fields_to_anonymize` |Array |List of fields in the `data` object to anonymize. |No
 |==============================================
 
 [discrete]
@@ -89,7 +89,7 @@ POST api/security_ai_assistant/current_user/conversations
 [discrete]
 === Response payload
 
-A JSON object with an LLM response and conversation `id` if `persist` was set to true.
+A JSON object with an LLM response, and a conversation `id` if `persist` was set to true.
 
 *Example 1*
 

diff --git a/docs/AI-for-security/api/conversation-api-create.asciidoc b/docs/AI-for-security/api/conversation-api-create.asciidoc
@@ -15,13 +15,13 @@ Creates a new Conversation.
 |==============================================
 |Name |Type |Description |Required
 
-|`title` |String |Conversation title. By default is "New chat". Will be AI generated if not changed. |Yes
-|`category` |String |Could be 'assistant' or 'insights' or not defined. |Yes
-|`isDefault` |Boolean |Define if conversation is a system conversation. |Yes
-|`excludeFromLastConversationStorage` |Boolean |Defines if conversation should be displayed as the latest used conversation if it was used. |Yes
+|`title` |String |Conversation title. If you set it to "New chat", the AI will generate a title. |Yes
+|`category` |String |Can be 'assistant', 'insights', or not defined. |Yes
+|`isDefault` |Boolean |Define if conversation is a system conversation which cannot be deleted. Defaults to false. |No
+|`excludeFromLastConversationStorage` |Boolean |Defines if conversation can appear as the latest conversation. |Yes
 |`apiConfig` |<<create-apiconfig-obj,apiConfig object>> |Conversation configuration. |Yes
 |`messages` |<<create-message-obj,message object>> |Array of conversation messages. |Yes
-|`replacements` |<<create-replacements-obj,replacements object>> |List of the fields with anonymization. |Yes
+|`replacements` |<<create-replacements-obj,replacements object>> |List of the fields to anonymize. |Yes
 |==============================================
 
 [discrete]
@@ -35,7 +35,7 @@ Creates a new Conversation.
 |`connectorId` |String |Kibana connector ID. |Yes
 |`actionTypeId` |String |Kibana connector action type ID. |Yes
 |`defaultSystemPromptId` |String |Default system prompt ID. |Yes
-|`model` |String |LLM specific model. |Yes
+|`model` |String |Specific LLM name. |Yes
 |==============================================
 
 [discrete]
@@ -46,9 +46,9 @@ Creates a new Conversation.
 |==============================================
 |Name |Type |Description |Required
 
-|`role` |String |Message role. Could be "user", "assisatnt" or "system". |Yes
+|`role` |String |Message role. Can be "user", "assistant", or "system". |Yes
 |`content` |String |Message content to send to LLM. |Yes
-|`isError` |String |Define if the message is an error message and not LLM response. |Yes
+|`isError` |String |Define if the message is an error message instead of an LLM response. |Yes
 |`timestamp` |String |Timestamp when the message was sent. |Yes
 |`traceData` |Object |Tracing information. |Yes
 |==============================================
@@ -61,9 +61,9 @@ Creates a new Conversation.
 |==============================================
 |Name |Type |Description |Required
 
-|`role` |String |Message role. Could be "user", "assisatnt" or "system". |Yes
+|`role` |String |Message role. Can be "user", "assistant", or "system". |Yes
 |`content` |String |Message content to send to LLM. |Yes
-|`isError` |String |Define if the message is an error message and not LLM response. |Yes
+|`isError` |String |Define if the message is an error message instead of an LLM response. |Yes
 |`timestamp` |String |Timestamp when the message was sent. |Yes
 |`traceData` |Object |Tracing information. |Yes
 |==============================================

diff --git a/docs/AI-for-security/api/conversation-api-find.asciidoc b/docs/AI-for-security/api/conversation-api-find.asciidoc
@@ -1,7 +1,7 @@
 [[conversation-api-find]]
 === Find Conversation
 
-Get Conversation list for the current user.
+Get a list of the current user's conversations.
 
 [discrete]
 === Request URL
@@ -14,7 +14,7 @@ Get Conversation list for the current user.
 
 *Example 1*
 
-Get Conversation list for the current user.
+Get a list of the current user's conversations.
 
 [source,console]
 --------------------------------------------------

diff --git a/docs/AI-for-security/api/conversation-api-get.asciidoc b/docs/AI-for-security/api/conversation-api-get.asciidoc
@@ -1,7 +1,7 @@
 [[conversation-api-get]]
 === Get Conversation
 
-Fetch existing Conversation by ID.
+Fetch an existing conversation by ID.
 
 [discrete]
 === Request URL
@@ -13,7 +13,7 @@ Fetch existing Conversation by ID.
 
 *Example 1*
 
-Fetch existing Conversation by ID.
+Fetch an existing conversation by ID.
 
 [source,console]
 --------------------------------------------------

diff --git a/docs/AI-for-security/api/conversation-api-update.asciidoc b/docs/AI-for-security/api/conversation-api-update.asciidoc
@@ -1,7 +1,7 @@
 [[conversation-api-update]]
 === Update Conversation
 
-Update an existing Conversation by ID.
+Update an existing conversation by ID.
 
 ==== Request URL
 
@@ -13,7 +13,7 @@ Update an existing Conversation by ID.
 |==============================================
 |Name |Type |Description |Required
 
-|`title` |String |Conversation title. By default is "New chat". Will be AI generated if not changed. |Yes
+|`title` |String |Conversation title. If you set it to "New chat", the AI will generate a title. |Yes
 |`apiConfig` |<<update-ApiConfig-obj,apiConfig object>> |Conversation configuration. |Yes
 |`messages` |<<update-message-obj,message object>> |Array of conversation messages. |Yes
 |`replacements` |<<update-replacements-obj,replacements object>> |List of the fields with anonymization. |Yes
@@ -42,9 +42,9 @@ Update an existing Conversation by ID.
 |==============================================
 |Name |Type |Description |Required
 
-|`role` |String |Message role. Could be "user", "assisatnt" or "system". |Yes
+|`role` |String |Message role. Can be "user", "assistant", or "system". |Yes
 |`content` |String |Message content to send to LLM. |Yes
-|`isError` |String |Define if the message is an error message and not LLM response. |Yes
+|`isError` |String |Define if the message is an error message instead of an LLM response. |Yes
 |`timestamp` |String |Timestamp when the message was sent. |Yes
 |`traceData` |Object |Tracing information. |Yes
 |==============================================
@@ -57,7 +57,7 @@ Update an existing Conversation by ID.
 |==============================================
 |Name |Type |Description |Required
 
-|`role` |String |Message role. Could be "user", "assisatnt" or "system". |Yes
+|`role` |String |Message role. Can be "user", "assistant", or "system". |Yes
 |`content` |String |Message content to send to LLM. |Yes
 |`isError` |String |Define if the message is an error message and not LLM response. |Yes
 |`timestamp` |String |Timestamp when the message was sent. |Yes