From 10055ff30501767b8749b72f9059e058da32f932 Mon Sep 17 00:00:00 2001
From: Martin Bielik <mx.bielik@gmail.com>
Date: Tue, 21 Mar 2023 18:47:49 +0100
Subject: openai configuration docu

---
 README.md      | 27 +++++++++++++++++++++++++++
 doc/tags       |  1 +
 doc/vim-ai.txt | 29 ++++++++++++++++++++++++++++-
 3 files changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d2776b6..ab35f11 100644
--- a/README.md
+++ b/README.md
@@ -87,6 +87,33 @@ nnoremap <leader>a :AI<CR>
 xnoremap <leader>a :AI<CR>
 ```
 
+### Completion configuration
+
+Request to the OpenAI API can be configured for each command. Below are listed available options with default values.
+
+```vim
+" :AI
+" - https://platform.openai.com/docs/api-reference/completions
+let g:vim_ai_complete.options.model = "text-davinci-003"
+let g:vim_ai_complete.options.max_tokens = 1000
+let g:vim_ai_complete.options.temperature = 0.1
+let g:vim_ai_complete.options.request_timeout = 10
+
+" :AIEdit
+" - https://platform.openai.com/docs/api-reference/completions
+let g:vim_ai_edit.options.model = "text-davinci-003"
+let g:vim_ai_edit.options.max_tokens = 1000
+let g:vim_ai_edit.options.temperature = 0.1
+let g:vim_ai_edit.options.request_timeout = 10
+
+" :AIChat
+" - https://platform.openai.com/docs/api-reference/chat
+let g:vim_ai_chat.options.model = "gpt-3.5-turbo"
+let g:vim_ai_chat.options.max_tokens = 1000
+let g:vim_ai_chat.options.temperature = 1
+let g:vim_ai_chat.options.request_timeout = 10
+```
+
 ### Custom commands
 
 To customize and re-use prompts it is useful to put some context to the language model. You can do it with prepending text to `:AI` command.
diff --git a/doc/tags b/doc/tags
index 9a56766..20ddc90 100644
--- a/doc/tags
+++ b/doc/tags
@@ -1,4 +1,5 @@
 :AI	vim-ai.txt	/*:AI*
+:AIChat	vim-ai.txt	/*:AIChat*
 :AIEdit	vim-ai.txt	/*:AIEdit*
 vim-ai	vim-ai.txt	/*vim-ai*
 vim-ai-about	vim-ai.txt	/*vim-ai-about*
diff --git a/doc/vim-ai.txt b/doc/vim-ai.txt
index 3bea986..a2ca093 100644
--- a/doc/vim-ai.txt
+++ b/doc/vim-ai.txt
@@ -20,19 +20,46 @@ https://github.com/madox2/vim-ai
 (selection) :AI                     complete the selection
 (selection) :AI {instruction}       complete the selection using the instruction
 
+Options: >
+  let g:vim_ai_complete.options.model = "text-davinci-003"
+  let g:vim_ai_complete.options.max_tokens = 1000
+  let g:vim_ai_complete.options.temperature = 0.1
+  let g:vim_ai_complete.options.request_timeout = 10
+
+Check OpenAI docs for more infomration:
+https://platform.openai.com/docs/api-reference/completions
+
                                                 *:AIEdit*
 
 (selection)? :AIEdit                edit the current line or the selection
 (selection)? :AIEdit {instruction}  edit the current line or the selection using
                                     the instruction
 
-                                                ### :AICh*a*
+Options: >
+  let g:vim_ai_edit.options.model = "text-davinci-003"
+  let g:vim_ai_edit.options.max_tokens = 1000
+  let g:vim_ai_edit.options.temperature = 0.1
+  let g:vim_ai_edit.options.request_timeout = 10
+
+Check OpenAI docs for more infomration:
+https://platform.openai.com/docs/api-reference/completions
+
+                                                *:AIChat*
 
 
 :AIChat                             continue or start a new conversation.
 (selection)? :AIChat {instruction}? start a new conversation given the selection,
                                     the instruction or both
 
+Options: >
+  let g:vim_ai_chat.options.model = "gpt-3.5-turbo"
+  let g:vim_ai_chat.options.max_tokens = 1000
+  let g:vim_ai_chat.options.temperature = 1
+  let g:vim_ai_chat.options.request_timeout = 10
+
+Check OpenAI docs for more infomration:
+https://platform.openai.com/docs/api-reference/chat
+
 ABOUT                                           *vim-ai-about*
 
 Contributions are welcome on GitHub:
-- 
cgit v1.2.3