added auth_type option, closes #153

Author: madox2

README.md

@@ -326,7 +326,7 @@ END
 " - options: openai config (see https://platform.openai.com/docs/api-reference/completions)
 " - options.initial_prompt: prompt prepended to every chat request (list of lines or string)
 " - options.request_timeout: request timeout in seconds
-" - options.enable_auth: enable authorization using openai key
+" - options.auth_type: API authentication method (bearer, api-key, none)
 " - options.token_file_path: override global token configuration
 " - options.selection_boundary: selection prompt wrapper (eliminates empty responses, see #20)
 " - ui.paste_mode: use paste mode (see more info in the Notes below)
@@ -341,7 +341,7 @@ let g:vim_ai_complete = {
 \    "temperature": 0.1,
 \    "request_timeout": 20,
 \    "stream": 1,
-\    "enable_auth": 1,
+\    "auth_type": "bearer",
 \    "token_file_path": "",
 \    "selection_boundary": "#####",
 \    "initial_prompt": s:initial_complete_prompt,
@@ -357,7 +357,7 @@ let g:vim_ai_complete = {
 " - options: openai config (see https://platform.openai.com/docs/api-reference/completions)
 " - options.initial_prompt: prompt prepended to every chat request (list of lines or string)
 " - options.request_timeout: request timeout in seconds
-" - options.enable_auth: enable authorization using openai key
+" - options.auth_type: API authentication method (bearer, api-key, none)
 " - options.token_file_path: override global token configuration
 " - options.selection_boundary: selection prompt wrapper (eliminates empty responses, see #20)
 " - ui.paste_mode: use paste mode (see more info in the Notes below)
@@ -372,7 +372,7 @@ let g:vim_ai_edit = {
 \    "temperature": 0.1,
 \    "request_timeout": 20,
 \    "stream": 1,
-\    "enable_auth": 1,
+\    "auth_type": "bearer",
 \    "token_file_path": "",
 \    "selection_boundary": "#####",
 \    "initial_prompt": s:initial_complete_prompt,
@@ -396,7 +396,7 @@ END
 " - options: openai config (see https://platform.openai.com/docs/api-reference/chat)
 " - options.initial_prompt: prompt prepended to every chat request (list of lines or string)
 " - options.request_timeout: request timeout in seconds
-" - options.enable_auth: enable authorization using openai key
+" - options.auth_type: API authentication method (bearer, api-key, none)
 " - options.token_file_path: override global token configuration
 " - options.selection_boundary: selection prompt wrapper (eliminates empty responses, see #20)
 " - ui.open_chat_command: preset (preset_below, preset_tab, preset_right) or a custom command
@@ -415,7 +415,7 @@ let g:vim_ai_chat = {
 \    "temperature": 1,
 \    "request_timeout": 20,
 \    "stream": 1,
-\    "enable_auth": 1,
+\    "auth_type": "bearer",
 \    "token_file_path": "",
 \    "selection_boundary": "",
 \    "initial_prompt": s:initial_chat_prompt,
@@ -434,7 +434,7 @@ let g:vim_ai_chat = {
 " - prompt: optional prepended prompt
 " - options: openai config (https://platform.openai.com/docs/api-reference/images/create)
 " - options.request_timeout: request timeout in seconds
-" - options.enable_auth: enable authorization using openai key
+" - options.auth_type: API authentication method (bearer, api-key, none)
 " - options.token_file_path: override global token configuration
 " - options.download_dir: path to image download directory, `cwd` if not defined
 let g:vim_ai_image = {
@@ -447,7 +447,7 @@ let g:vim_ai_image = {
 \    "size": "1024x1024",
 \    "style": "vivid",
 \    "request_timeout": 40,
-\    "enable_auth": 1,
+\    "auth_type": "bearer",
 \    "token_file_path": "",
 \  },
 \  "ui": {
@@ -486,7 +486,7 @@ See some cool projects listed in [Custom APIs](https://github.com/madox2/vim-ai/
 let g:vim_ai_chat = {
 \  "options": {
 \    "endpoint_url": "http://localhost:8000/v1/chat/completions",
-\    "enable_auth": 0,
+\    "auth_type": "none",
 \  },
 \}
 ```

autoload/vim_ai_config.vim

@@ -73,7 +73,7 @@ let g:vim_ai_openai_complete = {
 \  "temperature": 0.1,
 \  "request_timeout": 20,
 \  "stream": 1,
-\  "enable_auth": 1,
+\  "auth_type": "bearer",
 \  "token_file_path": "",
 \  "selection_boundary": "#####",
 \  "initial_prompt": s:initial_complete_prompt,
@@ -87,7 +87,7 @@ let g:vim_ai_openai_chat = {
 \  "temperature": 1,
 \  "request_timeout": 20,
 \  "stream": 1,
-\  "enable_auth": 1,
+\  "auth_type": "bearer",
 \  "token_file_path": "",
 \  "selection_boundary": "",
 \  "initial_prompt": s:initial_chat_prompt,
@@ -99,7 +99,7 @@ let g:vim_ai_openai_image = {
 \  "size": "1024x1024",
 \  "style": "vivid",
 \  "request_timeout": 40,
-\  "enable_auth": 1,
+\  "auth_type": "bearer",
 \  "token_file_path": "",
 \}
 

doc/vim-ai.txt

@@ -40,7 +40,7 @@ Options: >
   \    "temperature": 0.1,
   \    "request_timeout": 20,
   \    "stream": 1,
-  \    "enable_auth": 1,
+  \    "auth_type": "bearer",
   \    "token_file_path": "",
   \    "selection_boundary": "#####",
   \    "initial_prompt": s:initial_complete_prompt,
@@ -80,7 +80,7 @@ Options: >
   \    "temperature": 0.1,
   \    "request_timeout": 20,
   \    "stream": 1,
-  \    "enable_auth": 1,
+  \    "auth_type": "bearer",
   \    "token_file_path": "",
   \    "selection_boundary": "#####",
   \    "initial_prompt": s:initial_complete_prompt,
@@ -118,7 +118,7 @@ Options: >
   \    "temperature": 1,
   \    "request_timeout": 20,
   \    "stream": 1,
-  \    "enable_auth": 1,
+  \    "auth_type": "bearer",
   \    "token_file_path": "",
   \    "selection_boundary": "",
   \    "initial_prompt": s:initial_chat_prompt,
@@ -170,7 +170,7 @@ Options: >
   \    "size": "1024x1024",
   \    "style": "vivid",
   \    "request_timeout": 40,
-  \    "enable_auth": 1,
+  \    "auth_type": "bearer",
   \    "token_file_path": "",
   \  },
   \  "ui": {

py/providers/openai.py

@@ -28,7 +28,7 @@ def request(self, messages: Sequence[AIMessage]) -> Iterator[AIResponseChunk]:
         openai_options = self._make_openai_options(options)
         http_options = {
             'request_timeout': options['request_timeout'],
-            'enable_auth': options['enable_auth'],
+            'auth_type': options['auth_type'],
             'token_file_path': options['token_file_path'],
         }
 
@@ -83,9 +83,12 @@ def _load_api_key(self):
         return (api_key, org_id)
 
     def _parse_raw_options(self, raw_options: Mapping[str, Any]):
+        if raw_options.get('enable_auth', 1) == "0":
+            # raise error for users who don't use default value of this obsolete option
+            raise self.utils.make_known_error("`enable_auth = 0` option is no longer supported. use `auth_type = none` instead")
+
         options = {**raw_options}
         options['request_timeout'] = float(options['request_timeout'])
-        options['enable_auth'] = bool(int(options['enable_auth']))
         if self.command_type != 'image':
             options['max_tokens'] = int(options['max_tokens'])
             options['max_completion_tokens'] = int(options['max_completion_tokens'])
@@ -111,7 +114,7 @@ def request_image(self, prompt: str) -> list[AIImageResponseChunk]:
         options = self.options
         http_options = {
             'request_timeout': options['request_timeout'],
-            'enable_auth': options['enable_auth'],
+            'auth_type': options['auth_type'],
             'token_file_path': options['token_file_path'],
         }
         openai_options = {
@@ -133,18 +136,23 @@ def _openai_request(self, url, data, options):
         RESP_DATA_PREFIX = 'data: '
         RESP_DONE = '[DONE]'
 
-        enable_auth=options['enable_auth']
+        auth_type = options['auth_type']
         headers = {
             "Content-Type": "application/json",
             "User-Agent": "VimAI",
         }
-        if enable_auth:
+
+        if auth_type == 'bearer':
             (OPENAI_API_KEY, OPENAI_ORG_ID) = self._load_api_key()
             headers['Authorization'] = f"Bearer {OPENAI_API_KEY}"
 
             if OPENAI_ORG_ID is not None:
                 headers["OpenAI-Organization"] =  f"{OPENAI_ORG_ID}"
 
+        if auth_type == 'api-key':
+            (OPENAI_API_KEY, _) = self._load_api_key()
+            headers['api-key'] = f"{OPENAI_API_KEY}"
+
         request_timeout=options['request_timeout']
         req = urllib.request.Request(
             url,

tests/deprecated_role_syntax_test.py

@@ -9,7 +9,7 @@
     "temperature": "1",
     "request_timeout": "20",
     "stream": "1",
-    "enable_auth": "1",
+    "auth_type": "bearer",
     "token_file_path": "",
     "selection_boundary": "",
     "initial_prompt": "You are a general assistant.",