forked from phoenix-oss/llama-stack-mirror
ec4fc800cc
This is yet another of those large PRs (hopefully we will have less and less of them as things mature fast). This one introduces substantial improvements and some simplifications to the stack. Most important bits: * Agents reference implementation now has support for session / turn persistence. The default implementation uses sqlite but there's also support for using Redis. * We have re-architected the structure of the Stack APIs to allow for more flexible routing. The motivating use cases are: - routing model A to ollama and model B to a remote provider like Together - routing shield A to local impl while shield B to a remote provider like Bedrock - routing a vector memory bank to Weaviate while routing a keyvalue memory bank to Redis * Support for provider specific parameters to be passed from the clients. A client can pass data using `x_llamastack_provider_data` parameter which can be type-checked and provided to the Adapter implementations.
116 lines
3.5 KiB
Python
116 lines
3.5 KiB
Python
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
# All rights reserved.
|
|
#
|
|
# This source code is licensed under the terms described in the LICENSE file in
|
|
# the root directory of this source tree.
|
|
|
|
import json
|
|
import typing
|
|
from pathlib import Path
|
|
from typing import TextIO
|
|
|
|
from ..strong_typing.schema import object_to_json, StrictJsonType
|
|
|
|
from .generator import Generator
|
|
from .options import Options
|
|
from .specification import Document
|
|
|
|
|
|
THIS_DIR = Path(__file__).parent
|
|
|
|
|
|
class Specification:
|
|
document: Document
|
|
|
|
def __init__(self, endpoint: type, options: Options):
|
|
generator = Generator(endpoint, options)
|
|
self.document = generator.generate()
|
|
|
|
def get_json(self) -> StrictJsonType:
|
|
"""
|
|
Returns the OpenAPI specification as a Python data type (e.g. `dict` for an object, `list` for an array).
|
|
|
|
The result can be serialized to a JSON string with `json.dump` or `json.dumps`.
|
|
"""
|
|
|
|
json_doc = typing.cast(StrictJsonType, object_to_json(self.document))
|
|
|
|
if isinstance(json_doc, dict):
|
|
# rename vendor-specific properties
|
|
tag_groups = json_doc.pop("tagGroups", None)
|
|
if tag_groups:
|
|
json_doc["x-tagGroups"] = tag_groups
|
|
tags = json_doc.get("tags")
|
|
if tags and isinstance(tags, list):
|
|
for tag in tags:
|
|
if not isinstance(tag, dict):
|
|
continue
|
|
|
|
display_name = tag.pop("displayName", None)
|
|
if display_name:
|
|
tag["x-displayName"] = display_name
|
|
|
|
return json_doc
|
|
|
|
def get_json_string(self, pretty_print: bool = False) -> str:
|
|
"""
|
|
Returns the OpenAPI specification as a JSON string.
|
|
|
|
:param pretty_print: Whether to use line indents to beautify the output.
|
|
"""
|
|
|
|
json_doc = self.get_json()
|
|
if pretty_print:
|
|
return json.dumps(
|
|
json_doc, check_circular=False, ensure_ascii=False, indent=4
|
|
)
|
|
else:
|
|
return json.dumps(
|
|
json_doc,
|
|
check_circular=False,
|
|
ensure_ascii=False,
|
|
separators=(",", ":"),
|
|
)
|
|
|
|
def write_json(self, f: TextIO, pretty_print: bool = False) -> None:
|
|
"""
|
|
Writes the OpenAPI specification to a file as a JSON string.
|
|
|
|
:param pretty_print: Whether to use line indents to beautify the output.
|
|
"""
|
|
|
|
json_doc = self.get_json()
|
|
if pretty_print:
|
|
json.dump(
|
|
json_doc,
|
|
f,
|
|
check_circular=False,
|
|
ensure_ascii=False,
|
|
indent=4,
|
|
)
|
|
else:
|
|
json.dump(
|
|
json_doc,
|
|
f,
|
|
check_circular=False,
|
|
ensure_ascii=False,
|
|
separators=(",", ":"),
|
|
)
|
|
|
|
def write_html(self, f: TextIO, pretty_print: bool = False) -> None:
|
|
"""
|
|
Creates a stand-alone HTML page for the OpenAPI specification with ReDoc.
|
|
|
|
:param pretty_print: Whether to use line indents to beautify the JSON string in the HTML file.
|
|
"""
|
|
|
|
path = THIS_DIR / "template.html"
|
|
with path.open(encoding="utf-8", errors="strict") as html_template_file:
|
|
html_template = html_template_file.read()
|
|
|
|
html = html_template.replace(
|
|
"{ /* OPENAPI_SPECIFICATION */ }",
|
|
self.get_json_string(pretty_print=pretty_print),
|
|
)
|
|
|
|
f.write(html)
|