Skip to content

Proxies API Reference

BaseProxy

lllm.proxies.base.BaseProxy

Base class for describing an API surface that agents can call as tools.

Source code in lllm/proxies/base.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
class BaseProxy:
    """Base class for describing an API surface that agents can call as tools."""

    def __init__(
        self,
        *args,
        activate_proxies: Optional[List[str]] = None,
        cutoff_date: Optional[dt.datetime] = None,
        deploy_mode: bool = False,
        use_cache: bool = True,
        runtime: Optional[Runtime] = None,
        **kwargs,
    ):
        self._runtime = runtime or get_default_runtime()
        self._qualified_key = getattr(self.__class__, "_qualified_key", None)
        self._resource_namespace = getattr(self.__class__, "_resource_namespace", None)
        self.activate_proxies = activate_proxies[:] if activate_proxies else []
        self.cutoff_date = cutoff_date
        self.deploy_mode = deploy_mode
        self.use_cache = use_cache

        if isinstance(self.cutoff_date, str):
            try:
                self.cutoff_date = dt.datetime.fromisoformat(self.cutoff_date)
            except ValueError:
                self.cutoff_date = None

    @staticmethod
    def endpoint(
        category: str,
        endpoint: str,
        description: str,
        params: dict,
        response: list,
        name: Optional[str] = None,
        sub_category: Optional[str] = None,
        remove_keys: Optional[list] = None,
        dt_cutoff: Optional[tuple] = None,
        method: str = "GET",
    ):
        """Decorator that records metadata about an API endpoint."""

        def decorator(func):
            func.endpoint_info = {
                "category": category,
                "endpoint": endpoint,
                "name": name,
                "description": description,
                "sub_category": sub_category,
                "remove_keys": remove_keys,
                "params": params,
                "response": response,
                "dt_cutoff": dt_cutoff,
                "method": method,
            }
            return func

        return decorator

    @staticmethod
    def postcall(func):
        func.is_postcall = True
        return func

    @staticmethod
    def tactic_endpoint(
        tactic_url: str,
        *,
        config: Any = None,
        endpoint: Optional[str] = None,
        category: str = "tactics",
        name: Optional[str] = None,
        description: Optional[str] = None,
        response: Any = None,
        method: str = "TACTIC",
    ):
        """Create a proxy endpoint backed by a tactic resource URL."""
        from ..core.tactic_tool import sanitize_tool_name

        endpoint_name = endpoint or sanitize_tool_name(tactic_url)

        def _call_tactic_endpoint(self, params: Any = None, **kwargs):
            from ..core.tactic_tool import call_tactic_proxy_endpoint

            return call_tactic_proxy_endpoint(
                tactic_url,
                params=params,
                kwargs=kwargs,
                runtime=getattr(self, "_runtime", None),
                base_namespace=getattr(self, "_resource_namespace", None),
                config=config,
            )

        _call_tactic_endpoint.__name__ = endpoint_name
        _call_tactic_endpoint.endpoint_info = {
            "category": category,
            "endpoint": endpoint_name,
            "name": name or endpoint_name,
            "description": description or f"Run tactic {tactic_url}.",
            "sub_category": None,
            "remove_keys": None,
            "params": {},
            "response": response if response is not None else "str",
            "dt_cutoff": None,
            "method": method,
        }
        _call_tactic_endpoint._lllm_tactic_endpoint = {
            "tactic_url": tactic_url,
            "config": config,
            "endpoint": endpoint,
            "category": category,
            "name": name,
            "description": description,
            "response": response,
            "method": method,
        }
        return _call_tactic_endpoint

    @classmethod
    def register_tactic(
        cls,
        tactic_url: str,
        *,
        endpoint: str = None,
        config: Any = None,
        category: str = "tactics",
        name: str = None,
        description: str = None,
        response: Any = None,
        method: str = "TACTIC",
    ):
        """Imperatively add a tactic-backed endpoint to this proxy class."""
        from ..core.tactic_tool import sanitize_tool_name

        attr_name = sanitize_tool_name(endpoint or name or tactic_url)
        method_fn = BaseProxy.tactic_endpoint(
            tactic_url,
            config=config,
            endpoint=endpoint or attr_name,
            category=category,
            name=name,
            description=description,
            response=response,
            method=method,
        )
        setattr(cls, attr_name, method_fn)
        return method_fn

    # ------------------------------------------------------------------
    # Endpoint metadata helpers
    # ------------------------------------------------------------------

    @staticmethod
    def _callable_attr(method, attr: str, default: Any = None) -> Any:
        value = getattr(method, attr, None)
        if value is not None:
            return value
        func = getattr(method, "__func__", None)
        return getattr(func, attr, default)

    def _materialize_endpoint_info(
        self, attr_name: str, method, info: Dict[str, Any]
    ) -> Dict[str, Any]:
        tactic_meta = self._callable_attr(method, "_lllm_tactic_endpoint")
        if not tactic_meta:
            return info

        from ..core.tactic_tool import build_tactic_endpoint_info

        return build_tactic_endpoint_info(
            tactic_meta["tactic_url"],
            runtime=getattr(self, "_runtime", None),
            base_namespace=getattr(self, "_resource_namespace", None),
            endpoint=tactic_meta.get("endpoint") or attr_name,
            category=tactic_meta.get("category") or "tactics",
            name=tactic_meta.get("name"),
            description=tactic_meta.get("description"),
            response=tactic_meta.get("response"),
            method=tactic_meta.get("method") or "TACTIC",
        )

    def _endpoint_methods(self):
        """
        Yield ``(attr_name, method, endpoint_info)`` triples for every method
        decorated with :func:`BaseProxy.endpoint`.
        """
        for name, method in inspect.getmembers(self, predicate=callable):
            info = self._callable_attr(method, "endpoint_info")
            if info:
                info = self._materialize_endpoint_info(name, method, dict(info))
                yield name, method, info

    def endpoint_directory(self) -> List[Dict[str, Any]]:
        """
        Return a structured list describing every endpoint exposed by this proxy.
        """
        directory: List[Dict[str, Any]] = []
        for name, method, info in self._endpoint_methods():
            entry = dict(info)
            entry.setdefault("name", info.get("name") or name)
            entry["callable"] = name
            entry["docstring"] = inspect.getdoc(method)
            directory.append(entry)
        directory.sort(
            key=lambda item: ((item.get("category") or ""), item.get("endpoint") or "")
        )
        return directory

    def api_directory(self) -> Dict[str, Any]:
        """
        Return proxy metadata plus the endpoint directory.
        """
        return {
            "id": getattr(self, "_proxy_path", self.__class__.__name__),
            "display_name": getattr(self, "_proxy_name", self.__class__.__name__),
            "description": getattr(self, "_proxy_description", ""),
            "endpoints": self.endpoint_directory(),
        }

    def auto_test(self) -> Dict[str, Dict[str, Any]]:
        """
        Perform light-weight validation of endpoint metadata.

        Returns a dict mapping callable name to ``{"status": "...", "issues": [...]}``.
        """
        results: Dict[str, Dict[str, Any]] = {}
        for entry in self.endpoint_directory():
            issues: List[str] = []
            params = entry.get("params")
            if not isinstance(params, dict):
                issues.append("params")
            if entry.get("response") is None:
                issues.append("response")
            status = "ok" if not issues else "warning"
            results[entry["callable"]] = {"status": status, "issues": issues}
        return results

api_directory()

Return proxy metadata plus the endpoint directory.

Source code in lllm/proxies/base.py 
219
220
221
222
223
224
225
226
227
228
def api_directory(self) -> Dict[str, Any]:
    """
    Return proxy metadata plus the endpoint directory.
    """
    return {
        "id": getattr(self, "_proxy_path", self.__class__.__name__),
        "display_name": getattr(self, "_proxy_name", self.__class__.__name__),
        "description": getattr(self, "_proxy_description", ""),
        "endpoints": self.endpoint_directory(),
    }

auto_test()

Perform light-weight validation of endpoint metadata.

Returns a dict mapping callable name to {"status": "...", "issues": [...]}.

Source code in lllm/proxies/base.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def auto_test(self) -> Dict[str, Dict[str, Any]]:
    """
    Perform light-weight validation of endpoint metadata.

    Returns a dict mapping callable name to ``{"status": "...", "issues": [...]}``.
    """
    results: Dict[str, Dict[str, Any]] = {}
    for entry in self.endpoint_directory():
        issues: List[str] = []
        params = entry.get("params")
        if not isinstance(params, dict):
            issues.append("params")
        if entry.get("response") is None:
            issues.append("response")
        status = "ok" if not issues else "warning"
        results[entry["callable"]] = {"status": status, "issues": issues}
    return results

endpoint(category, endpoint, description, params, response, name=None, sub_category=None, remove_keys=None, dt_cutoff=None, method='GET') staticmethod

Decorator that records metadata about an API endpoint.

Source code in lllm/proxies/base.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@staticmethod
def endpoint(
    category: str,
    endpoint: str,
    description: str,
    params: dict,
    response: list,
    name: Optional[str] = None,
    sub_category: Optional[str] = None,
    remove_keys: Optional[list] = None,
    dt_cutoff: Optional[tuple] = None,
    method: str = "GET",
):
    """Decorator that records metadata about an API endpoint."""

    def decorator(func):
        func.endpoint_info = {
            "category": category,
            "endpoint": endpoint,
            "name": name,
            "description": description,
            "sub_category": sub_category,
            "remove_keys": remove_keys,
            "params": params,
            "response": response,
            "dt_cutoff": dt_cutoff,
            "method": method,
        }
        return func

    return decorator

endpoint_directory()

Return a structured list describing every endpoint exposed by this proxy.

Source code in lllm/proxies/base.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def endpoint_directory(self) -> List[Dict[str, Any]]:
    """
    Return a structured list describing every endpoint exposed by this proxy.
    """
    directory: List[Dict[str, Any]] = []
    for name, method, info in self._endpoint_methods():
        entry = dict(info)
        entry.setdefault("name", info.get("name") or name)
        entry["callable"] = name
        entry["docstring"] = inspect.getdoc(method)
        directory.append(entry)
    directory.sort(
        key=lambda item: ((item.get("category") or ""), item.get("endpoint") or "")
    )
    return directory

register_tactic(tactic_url, *, endpoint=None, config=None, category='tactics', name=None, description=None, response=None, method='TACTIC') classmethod

Imperatively add a tactic-backed endpoint to this proxy class.

Source code in lllm/proxies/base.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
@classmethod
def register_tactic(
    cls,
    tactic_url: str,
    *,
    endpoint: str = None,
    config: Any = None,
    category: str = "tactics",
    name: str = None,
    description: str = None,
    response: Any = None,
    method: str = "TACTIC",
):
    """Imperatively add a tactic-backed endpoint to this proxy class."""
    from ..core.tactic_tool import sanitize_tool_name

    attr_name = sanitize_tool_name(endpoint or name or tactic_url)
    method_fn = BaseProxy.tactic_endpoint(
        tactic_url,
        config=config,
        endpoint=endpoint or attr_name,
        category=category,
        name=name,
        description=description,
        response=response,
        method=method,
    )
    setattr(cls, attr_name, method_fn)
    return method_fn

tactic_endpoint(tactic_url, *, config=None, endpoint=None, category='tactics', name=None, description=None, response=None, method='TACTIC') staticmethod

Create a proxy endpoint backed by a tactic resource URL.

Source code in lllm/proxies/base.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
@staticmethod
def tactic_endpoint(
    tactic_url: str,
    *,
    config: Any = None,
    endpoint: Optional[str] = None,
    category: str = "tactics",
    name: Optional[str] = None,
    description: Optional[str] = None,
    response: Any = None,
    method: str = "TACTIC",
):
    """Create a proxy endpoint backed by a tactic resource URL."""
    from ..core.tactic_tool import sanitize_tool_name

    endpoint_name = endpoint or sanitize_tool_name(tactic_url)

    def _call_tactic_endpoint(self, params: Any = None, **kwargs):
        from ..core.tactic_tool import call_tactic_proxy_endpoint

        return call_tactic_proxy_endpoint(
            tactic_url,
            params=params,
            kwargs=kwargs,
            runtime=getattr(self, "_runtime", None),
            base_namespace=getattr(self, "_resource_namespace", None),
            config=config,
        )

    _call_tactic_endpoint.__name__ = endpoint_name
    _call_tactic_endpoint.endpoint_info = {
        "category": category,
        "endpoint": endpoint_name,
        "name": name or endpoint_name,
        "description": description or f"Run tactic {tactic_url}.",
        "sub_category": None,
        "remove_keys": None,
        "params": {},
        "response": response if response is not None else "str",
        "dt_cutoff": None,
        "method": method,
    }
    _call_tactic_endpoint._lllm_tactic_endpoint = {
        "tactic_url": tactic_url,
        "config": config,
        "endpoint": endpoint,
        "category": category,
        "name": name,
        "description": description,
        "response": response,
        "method": method,
    }
    return _call_tactic_endpoint

ProxyManager

lllm.proxies.base.ProxyManager

Runtime registry that instantiates every discovered proxy and forwards calls.

Agents rarely instantiate this directly; instead the sandbox or higher-level tooling wires it up so prompts can enumerate available endpoints for tool selection.

Source code in lllm/proxies/base.py 
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
class ProxyManager:
    """
    Runtime registry that instantiates every discovered proxy and forwards calls.

    Agents rarely instantiate this directly; instead the sandbox or higher-level tooling
    wires it up so prompts can enumerate available endpoints for tool selection.
    """

    def __init__(
        self,
        activate_proxies: Optional[List[str]] = None,
        cutoff_date: dt.datetime = None,
        deploy_mode: bool = False,
        runtime: Runtime = None,
    ):
        self._runtime = runtime or get_default_runtime()

        self.activate_proxies = activate_proxies or []
        self.cutoff_date = cutoff_date
        self.deploy_mode = deploy_mode
        self.proxies = {}
        self._load_registered_proxies()

    def _load_registered_proxies(self):
        for qk, node in self._runtime.iter_items("proxy"):
            proxy_cls = node.value
            if self.activate_proxies:
                # Match against qualified key, bare key, or _proxy_path
                matched = any(
                    act == qk
                    or act == node.key
                    or act == getattr(proxy_cls, "_proxy_path", None)
                    for act in self.activate_proxies
                )
                if not matched:
                    continue
            try:
                instance = proxy_cls(
                    cutoff_date=self.cutoff_date,
                    activate_proxies=self.activate_proxies,
                    deploy_mode=self.deploy_mode,
                    runtime=self._runtime,
                )
            except TypeError:
                instance = proxy_cls()
            instance._runtime = self._runtime
            instance._qualified_key = node.qualified_key
            instance._resource_namespace = node.namespace
            # Store under the bare key (what existing code expects for dispatch)
            self.proxies[node.key] = instance

    def register(self, name: str, proxy_cls: Any):
        """Register (or override) a proxy implementation at runtime."""
        if name in self.proxies:
            logger.warning(
                "Proxy '%s' already instantiated, overwriting instance", name
            )
        try:
            instance = proxy_cls(
                cutoff_date=self.cutoff_date,
                activate_proxies=self.activate_proxies,
                deploy_mode=self.deploy_mode,
                runtime=self._runtime,
            )
        except TypeError:
            instance = proxy_cls(
                self.activate_proxies, self.cutoff_date, self.deploy_mode
            )
        instance._runtime = self._runtime
        instance._qualified_key = getattr(proxy_cls, "_qualified_key", None)
        instance._resource_namespace = getattr(proxy_cls, "_resource_namespace", None)
        self.proxies[name] = instance

    def available(self) -> List[str]:
        """Return the sorted list of proxy identifiers currently loaded."""
        return sorted(self.proxies.keys())

    def api_catalog(self) -> Dict[str, Dict[str, Any]]:
        """Return the API directory for every loaded proxy."""
        return {name: proxy.api_directory() for name, proxy in self.proxies.items()}

    def get_api_directory(self, proxy_name: str) -> Dict[str, Any]:
        """Convenience wrapper that returns the directory for a single proxy."""
        if proxy_name not in self.proxies:
            raise KeyError(f"Proxy '{proxy_name}' not registered")
        return self.proxies[proxy_name].api_directory()

    def retrieve_api_docs(self, proxy_name: Optional[str] = None) -> str:
        """
        Render a human-readable overview of the available endpoints.

        Args:
            proxy_name: Optional identifier. If omitted, all proxies are included.
        """
        if proxy_name is not None:
            target_names = [proxy_name]
        else:
            target_names = sorted(self.proxies.keys())

        sections: List[str] = []
        for name in target_names:
            if name not in self.proxies:
                raise KeyError(f"Proxy '{name}' not registered")
            meta = self.proxies[name].api_directory()
            header = f"## {meta['display_name']} ({name})"
            description = (meta.get("description") or "").strip()
            lines = [header]
            if description:
                lines.append(description)
            for endpoint in meta.get("endpoints", []):
                method = (endpoint.get("method") or "GET").upper()
                desc = endpoint.get("description") or ""
                line = f"- **{endpoint.get('endpoint')}** [{method}] – {desc}"
                lines.append(line.strip())
                params = endpoint.get("params") or {}
                if isinstance(params, dict) and params:
                    for param_name, spec in params.items():
                        if isinstance(spec, tuple) and spec:
                            type_hint = spec[0]
                            example = spec[1] if len(spec) > 1 else None
                        else:
                            type_hint = None
                            example = spec
                        type_name = (
                            getattr(type_hint, "__name__", str(type_hint))
                            if type_hint
                            else "Any"
                        )
                        if isinstance(example, (list, dict)):
                            example_preview = str(example)[:60]
                        else:
                            example_preview = example
                        lines.append(
                            f"    - `{param_name}` ({type_name}) e.g. {example_preview}"
                        )
            sections.append("\n".join(lines).strip())
        return "\n\n".join(sections).strip()

    def _resolve(self, endpoint: str) -> tuple[str, str]:
        if "." in endpoint:
            parts = endpoint.split(".", 1)
            return parts[0], parts[1]
        path_parts = endpoint.split("/")
        if len(path_parts) < 2:
            raise ValueError(
                f"Invalid endpoint '{endpoint}'. Use '<proxy>.<method>' or '<proxy>/<method>'."
            )
        return "/".join(path_parts[:-1]), path_parts[-1]

    def __call__(self, endpoint: str, *args, **kwargs):
        """Dispatch ``proxy_path.endpoint_name`` or ``proxy_path/endpoint`` to the proxy."""
        proxy_name, func_name = self._resolve(endpoint)
        if proxy_name not in self.proxies:
            raise KeyError(
                f"Proxy '{proxy_name}' not registered. Available: {list(self.proxies.keys())}"
            )
        proxy = self.proxies[proxy_name]
        if not hasattr(proxy, func_name):
            raise AttributeError(f"Proxy '{proxy_name}' has no endpoint '{func_name}'")
        handler = getattr(proxy, func_name)
        return handler(*args, **kwargs)

__call__(endpoint, *args, **kwargs)

Dispatch proxy_path.endpoint_name or proxy_path/endpoint to the proxy.

Source code in lllm/proxies/base.py 
398
399
400
401
402
403
404
405
406
407
408
409
def __call__(self, endpoint: str, *args, **kwargs):
    """Dispatch ``proxy_path.endpoint_name`` or ``proxy_path/endpoint`` to the proxy."""
    proxy_name, func_name = self._resolve(endpoint)
    if proxy_name not in self.proxies:
        raise KeyError(
            f"Proxy '{proxy_name}' not registered. Available: {list(self.proxies.keys())}"
        )
    proxy = self.proxies[proxy_name]
    if not hasattr(proxy, func_name):
        raise AttributeError(f"Proxy '{proxy_name}' has no endpoint '{func_name}'")
    handler = getattr(proxy, func_name)
    return handler(*args, **kwargs)

api_catalog()

Return the API directory for every loaded proxy.

Source code in lllm/proxies/base.py 
326
327
328
def api_catalog(self) -> Dict[str, Dict[str, Any]]:
    """Return the API directory for every loaded proxy."""
    return {name: proxy.api_directory() for name, proxy in self.proxies.items()}

available()

Return the sorted list of proxy identifiers currently loaded.

Source code in lllm/proxies/base.py 
322
323
324
def available(self) -> List[str]:
    """Return the sorted list of proxy identifiers currently loaded."""
    return sorted(self.proxies.keys())

get_api_directory(proxy_name)

Convenience wrapper that returns the directory for a single proxy.

Source code in lllm/proxies/base.py 
330
331
332
333
334
def get_api_directory(self, proxy_name: str) -> Dict[str, Any]:
    """Convenience wrapper that returns the directory for a single proxy."""
    if proxy_name not in self.proxies:
        raise KeyError(f"Proxy '{proxy_name}' not registered")
    return self.proxies[proxy_name].api_directory()

register(name, proxy_cls)

Register (or override) a proxy implementation at runtime.

Source code in lllm/proxies/base.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
def register(self, name: str, proxy_cls: Any):
    """Register (or override) a proxy implementation at runtime."""
    if name in self.proxies:
        logger.warning(
            "Proxy '%s' already instantiated, overwriting instance", name
        )
    try:
        instance = proxy_cls(
            cutoff_date=self.cutoff_date,
            activate_proxies=self.activate_proxies,
            deploy_mode=self.deploy_mode,
            runtime=self._runtime,
        )
    except TypeError:
        instance = proxy_cls(
            self.activate_proxies, self.cutoff_date, self.deploy_mode
        )
    instance._runtime = self._runtime
    instance._qualified_key = getattr(proxy_cls, "_qualified_key", None)
    instance._resource_namespace = getattr(proxy_cls, "_resource_namespace", None)
    self.proxies[name] = instance

retrieve_api_docs(proxy_name=None)

Render a human-readable overview of the available endpoints.

Parameters:

Name Type Description Default
proxy_name Optional[str]

Optional identifier. If omitted, all proxies are included.

 None
Source code in lllm/proxies/base.py 
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
def retrieve_api_docs(self, proxy_name: Optional[str] = None) -> str:
    """
    Render a human-readable overview of the available endpoints.

    Args:
        proxy_name: Optional identifier. If omitted, all proxies are included.
    """
    if proxy_name is not None:
        target_names = [proxy_name]
    else:
        target_names = sorted(self.proxies.keys())

    sections: List[str] = []
    for name in target_names:
        if name not in self.proxies:
            raise KeyError(f"Proxy '{name}' not registered")
        meta = self.proxies[name].api_directory()
        header = f"## {meta['display_name']} ({name})"
        description = (meta.get("description") or "").strip()
        lines = [header]
        if description:
            lines.append(description)
        for endpoint in meta.get("endpoints", []):
            method = (endpoint.get("method") or "GET").upper()
            desc = endpoint.get("description") or ""
            line = f"- **{endpoint.get('endpoint')}** [{method}] – {desc}"
            lines.append(line.strip())
            params = endpoint.get("params") or {}
            if isinstance(params, dict) and params:
                for param_name, spec in params.items():
                    if isinstance(spec, tuple) and spec:
                        type_hint = spec[0]
                        example = spec[1] if len(spec) > 1 else None
                    else:
                        type_hint = None
                        example = spec
                    type_name = (
                        getattr(type_hint, "__name__", str(type_hint))
                        if type_hint
                        else "Any"
                    )
                    if isinstance(example, (list, dict)):
                        example_preview = str(example)[:60]
                    else:
                        example_preview = example
                    lines.append(
                        f"    - `{param_name}` ({type_name}) e.g. {example_preview}"
                    )
        sections.append("\n".join(lines).strip())
    return "\n\n".join(sections).strip()

ProxyRegistrator

lllm.proxies.base.ProxyRegistrator(path, name, description, runtime=None)

Source code in lllm/proxies/base.py 
412
413
414
415
416
417
418
419
420
421
422
def ProxyRegistrator(path: str, name: str, description: str, runtime: Runtime = None):
    runtime = runtime or get_default_runtime()

    def decorator(cls):
        cls._proxy_path = path
        cls._proxy_name = name
        cls._proxy_description = description
        runtime.register_proxy(path, cls, overwrite=True)
        return cls

    return decorator