Skip to content

feat(api): add support for custom API base URL in configuration#152

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.

Sign up for GitHub

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

Closed
mohammadmaso wants to merge 1 commit into from
Closed

feat(api): add support for custom API base URL in configuration #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions openkb/agent/compiler.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
DEFAULT_ENTITY_TYPES,
get_api_base,
get_extra_headers,
get_timeout,
resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
timeout = get_timeout()
if timeout is not None:
kwargs.setdefault("timeout", timeout)
api_base = get_api_base()
if api_base is not None:
kwargs.setdefault("api_base", api_base)
logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
if kwargs:
logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
timeout = get_timeout()
if timeout is not None:
kwargs.setdefault("timeout", timeout)
api_base = get_api_base()
if api_base is not None:
kwargs.setdefault("api_base", api_base)
logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
if kwargs:
logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down
12 changes: 10 additions & 2 deletions openkb/agent/query.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
get_wiki_page_content,
read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

from agents.model_settings import ModelSettings

extra_args: dict = {}
timeout_args = get_timeout_extra_args()
if timeout_args:
extra_args.update(timeout_args)
api_base = get_api_base()
if api_base is not None:
extra_args["api_base"] = api_base

return Agent(
name="wiki-query",
instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
model_settings=ModelSettings(
parallel_tool_calls=False,
extra_headers=get_extra_headers() or None,
extra_args=get_timeout_extra_args(),
extra_args=extra_args or None,
),
)

Expand Down
20 changes: 17 additions & 3 deletions openkb/cli.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
resolve_litellm_settings,
resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

api_key = os.environ.get("LLM_API_KEY", "")

# Try to resolve the active provider, extra headers, and request timeout
# from the KB config
# Try to resolve the active provider, extra headers, request timeout, and
# custom API base URL from the KB config
provider: str | None = None
extra_headers: dict[str, str] = {}
timeout: float | None = None
api_base: str | None = None
litellm_settings: dict = {}
if kb_dir is not None:
config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
provider = _extract_provider(str(model))
extra_headers = resolve_extra_headers(config)
timeout = resolve_timeout(config)
api_base = resolve_api_base(config)
litellm_settings = resolve_litellm_settings(config)
# `timeout` / `extra_headers` in the block route to the per-call
# stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
timeout = resolve_timeout(
{"timeout": litellm_settings.pop("timeout")}
)

# Fall back to LLM_API_BASE env var when api_base is not set in config.
if api_base is None:
env_api_base = os.environ.get("LLM_API_BASE", "").strip()
if env_api_base:
api_base = env_api_base

set_extra_headers(extra_headers)
set_timeout(timeout)
set_api_base(api_base)
# Also set litellm.api_base globally so third-party libraries that call
# litellm directly (e.g. PageIndex) also route through the custom endpoint.
if api_base is not None:
litellm.api_base = api_base
_apply_litellm_settings(litellm_settings)

if not api_key:
Expand Down
38 changes: 38 additions & 0 deletions openkb/config.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
"""Resolve the optional ``api_base:`` config key to a non-empty URL string.

Returns ``None`` (use the provider default) when absent or blank; warns and
returns ``None`` when present but not a string.
"""
raw = config.get("api_base")
if raw is None:
return None
if not isinstance(raw, str):
logger.warning(
"config: 'api_base' must be a URL string, got %s — ignoring it.",
type(raw).__name__,
)
return None
stripped = raw.strip()
if not stripped:
return None
return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
"""Set the process-wide custom API base URL; ``None`` clears it."""
global _runtime_api_base
_runtime_api_base = api_base or None


def get_api_base() -> str | None:
"""Return the process-wide custom API base URL, or ``None``."""
return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
"""Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(api): add support for custom API base URL in configuration by mohammadmaso · Pull Request #152 · VectifyAI/OpenKB · GitHub
Skip to content
feat(api): add support for custom API base URL in configuration#152

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.

 Sign up for GitHub

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

 Closed

mohammadmaso
wants to merge
1
commit into

from

 Closed


feat(api): add support for custom API base URL in configuration
#152
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


7 changes: 7 additions & 0 deletions
openkb/agent/compiler.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,6 +31,7 @@
from openkb import frontmatter
from openkb.config import (
 DEFAULT_ENTITY_TYPES,
 get_api_base,
 get_extra_headers,
 get_timeout,
 resolve_entity_types,
Expand DownExpand Up@@ -334,6 +335,9 @@ def _llm_call(model: str, messages: list[dict], step_name: str, **kwargs) -> str
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand All@@ -359,6 +363,9 @@ async def _llm_call_async(model: str, messages: list[dict], step_name: str, **kw
 timeout = get_timeout()
 if timeout is not None:
 kwargs.setdefault("timeout", timeout)
 api_base = get_api_base()
 if api_base is not None:
 kwargs.setdefault("api_base", api_base)
 logger.debug("LLM request [%s]:\n%s", step_name, _fmt_messages(messages))
 if kwargs:
 logger.debug("LLM kwargs [%s]: %s", step_name, kwargs)
Expand Down

12 changes: 10 additions & 2 deletions
openkb/agent/query.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
from agents import Agent, Runner, function_tool

from agents import ToolOutputImage, ToolOutputText
from openkb.config import get_extra_headers, get_timeout_extra_args
from openkb.config import get_api_base, get_extra_headers, get_timeout_extra_args
from openkb.agent.tools import (
 get_wiki_page_content,
 read_wiki_file,
Expand DownExpand Up@@ -90,6 +90,14 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:

 from agents.model_settings import ModelSettings

 extra_args: dict = {}
 timeout_args = get_timeout_extra_args()
 if timeout_args:
 extra_args.update(timeout_args)
 api_base = get_api_base()
 if api_base is not None:
 extra_args["api_base"] = api_base

 return Agent(
 name="wiki-query",
 instructions=instructions,
Expand All@@ -98,7 +106,7 @@ def get_image(image_path: str) -> ToolOutputImage | ToolOutputText:
 model_settings=ModelSettings(
 parallel_tool_calls=False,
 extra_headers=get_extra_headers() or None,
 extra_args=get_timeout_extra_args(),
 extra_args=extra_args or None,
 ),
 )

Expand Down

20 changes: 17 additions & 3 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,7 @@ def filter(self, record: logging.LogRecord) -> bool:
from openkb.config import (
 DEFAULT_CONFIG, load_config, save_config, load_global_config, register_kb,
 resolve_extra_headers, set_extra_headers, resolve_timeout, set_timeout,
 resolve_litellm_settings,
 resolve_litellm_settings, resolve_api_base, set_api_base,
)
from openkb.converter import _registry_path, convert_document
from openkb.indexer import import_cloud_document
Expand DownExpand Up@@ -138,11 +138,12 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:

 api_key = os.environ.get("LLM_API_KEY", "")

 # Try to resolve the active provider, extra headers, and request timeout
 # from the KB config
 # Try to resolve the active provider, extra headers, request timeout, and
 # custom API base URL from the KB config
 provider: str | None = None
 extra_headers: dict[str, str] = {}
 timeout: float | None = None
 api_base: str | None = None
 litellm_settings: dict = {}
 if kb_dir is not None:
 config_path = kb_dir / ".openkb" / "config.yaml"
Expand All@@ -152,6 +153,7 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 provider = _extract_provider(str(model))
 extra_headers = resolve_extra_headers(config)
 timeout = resolve_timeout(config)
 api_base = resolve_api_base(config)
 litellm_settings = resolve_litellm_settings(config)
 # `timeout` / `extra_headers` in the block route to the per-call
 # stashes (replacing the legacy top-level keys); the rest are globals.
Expand All@@ -163,8 +165,20 @@ def _setup_llm_key(kb_dir: Path | None = None) -> None:
 timeout = resolve_timeout(
 {"timeout": litellm_settings.pop("timeout")}
 )

 # Fall back to LLM_API_BASE env var when api_base is not set in config.
 if api_base is None:
 env_api_base = os.environ.get("LLM_API_BASE", "").strip()
 if env_api_base:
 api_base = env_api_base

 set_extra_headers(extra_headers)
 set_timeout(timeout)
 set_api_base(api_base)
 # Also set litellm.api_base globally so third-party libraries that call
 # litellm directly (e.g. PageIndex) also route through the custom endpoint.
 if api_base is not None:
 litellm.api_base = api_base
 _apply_litellm_settings(litellm_settings)

 if not api_key:
Expand Down

38 changes: 38 additions & 0 deletions
openkb/config.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -242,6 +242,44 @@ def get_timeout_extra_args() -> dict[str, float] | None:
 return {"timeout": _runtime_timeout} if _runtime_timeout is not None else None


def resolve_api_base(config: dict) -> str | None:
 """Resolve the optional ``api_base:`` config key to a non-empty URL string.

 Returns ``None`` (use the provider default) when absent or blank; warns and
 returns ``None`` when present but not a string.
 """
 raw = config.get("api_base")
 if raw is None:
 return None
 if not isinstance(raw, str):
 logger.warning(
 "config: 'api_base' must be a URL string, got %s — ignoring it.",
 type(raw).__name__,
 )
 return None
 stripped = raw.strip()
 if not stripped:
 return None
 return stripped


# Process-wide custom API base URL for LLM requests, set from config / env by
# the CLI entry points and read at call sites via get_api_base(). None means
# use the provider's default endpoint — behaviour is identical to not setting it.
_runtime_api_base: str | None = None


def set_api_base(api_base: str | None) -> None:
 """Set the process-wide custom API base URL; ``None`` clears it."""
 global _runtime_api_base
 _runtime_api_base = api_base or None


def get_api_base() -> str | None:
 """Return the process-wide custom API base URL, or ``None``."""
 return _runtime_api_base


def load_config(config_path: Path) -> dict[str, Any]:
 """Load YAML config from config_path, merged with DEFAULT_CONFIG.

Expand Down