The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
community: Resolve refs recursively when generating openai_fn from OpenAPI spec (#19002)
Bruno Alvisioab527027acfc
diff --git a/libs/community/langchain_community/utilities/openapi.py b/libs/community/langchain_community/utilities/openapi.pyindex 9660a5408d..6bd9182713 100644--- a/libs/community/langchain_community/utilities/openapi.py+++ b/libs/community/langchain_community/utilities/openapi.py@@ -129,11 +129,31 @@ class OpenAPISpec(OpenAPI):raise ValueError(f"No schema found for {ref_name}")return schemas[ref_name]- def get_schema(self, schema: Union[Reference, Schema]) -> Schema:+ def get_schema(+ self,+ schema: Union[Reference, Schema],+ depth: int = 0,+ max_depth: Optional[int] = None,+ ) -> Schema:+ if max_depth is not None and depth >= max_depth:+ raise RecursionError(+ f"Max depth of {max_depth} has been exceeded when resolving references."+ )+from openapi_pydantic import Referenceif isinstance(schema, Reference):- return self.get_referenced_schema(schema)+ schema = self.get_referenced_schema(schema)++ # TODO: Resolve references on all fields of Schema ?+ # (e.g. patternProperties, etc...)+ if schema.properties is not None:+ for p_name, p in schema.properties.items():+ schema.properties[p_name] = self.get_schema(p, depth + 1, max_depth)++ if schema.items is not None:+ schema.items = self.get_schema(schema.items, depth + 1, max_depth)+return schemadef _get_root_referenced_schema(self, ref: Reference) -> Schema:diff --git a/libs/community/tests/unit_tests/data/openapi_specs/openapi_spec_nested_ref.json b/libs/community/tests/unit_tests/data/openapi_specs/openapi_spec_nested_ref.jsonnew file mode 100644index 0000000000..18190feda3--- /dev/null+++ b/libs/community/tests/unit_tests/data/openapi_specs/openapi_spec_nested_ref.json@@ -0,0 +1,70 @@+{+ "openapi": "3.0.3",+ "info": {+ "title": "Swagger Petstore - OpenAPI 3.0",+ "license": {+ "name": "Apache 2.0",+ "url": "http://www.apache.org/licenses/LICENSE-2.0.html"+ },+ "version": "1.0.11"+ },+ "paths": {+ "/pet": {+ "post": {+ "summary": "Add a new pet to the store",+ "description": "Add a new pet to the store",+ "operationId": "addPet",+ "requestBody": {+ "description": "Create a new pet in the store",+ "content": {+ "application/json": {+ "schema": {+ "$ref": "#/components/schemas/Pet"+ }+ }+ },+ "required": true+ }+ }+ }+ },+ "components": {+ "schemas": {+ "Tag": {+ "type": "object",+ "properties": {+ "id": {+ "type": "integer",+ "format": "int64"+ },+ "model_type": {+ "type": "number"+ }+ }+ },+ "Pet": {+ "required": [+ "name"+ ],+ "type": "object",+ "properties": {+ "id": {+ "type": "integer",+ "format": "int64",+ "example": 10+ },+ "name": {+ "type": "string",+ "example": "doggie"+ },+ "tags": {+ "type": "array",+ "items": {+ "$ref": "#/components/schemas/Tag"+ }+ }+ }+ }+ }+ }+ }\ No newline at end of filediff --git a/libs/community/tests/unit_tests/utilities/test_openapi.py b/libs/community/tests/unit_tests/utilities/test_openapi.pyindex e7e8b74557..377c86ad56 100644--- a/libs/community/tests/unit_tests/utilities/test_openapi.py+++ b/libs/community/tests/unit_tests/utilities/test_openapi.py@@ -42,3 +42,52 @@ def test_header_param() -> None:openai_functions, _ = openapi_spec_to_openai_fn(spec)assert openai_functions == EXPECTED_OPENAI_FUNCTIONS_HEADER_PARAM+++EXPECTED_OPENAI_FUNCTIONS_NESTED_REF = [+ {+ "name": "addPet",+ "description": "Add a new pet to the store",+ "parameters": {+ "type": "object",+ "properties": {+ "json": {+ "properties": {+ "id": {+ "type": "integer",+ "schema_format": "int64",+ "example": 10,+ },+ "name": {"type": "string", "example": "doggie"},+ "tags": {+ "items": {+ "properties": {+ "id": {"type": "integer", "schema_format": "int64"},+ "model_type": {"type": "number"},+ },+ "type": "object",+ },+ "type": "array",+ },+ },+ "type": "object",+ "required": ["name"],+ }+ },+ },+ }+]++[email protected]("openapi_pydantic")+def test_nested_ref_in_openapi_spec() -> None:+ spec = OpenAPISpec.from_file(+ Path(__file__).parent.parent+ / "data"+ / "openapi_specs"+ / "openapi_spec_nested_ref.json",+ )++ openai_functions, _ = openapi_spec_to_openai_fn(spec)++ assert openai_functions == EXPECTED_OPENAI_FUNCTIONS_NESTED_REF