File size: 10,998 Bytes
4ff79c6 | 1 2 3 4 5 6 7 8 9 10 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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | # SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
#
# SPDX-License-Identifier: Apache-2.0
import json
import sys
import tempfile
import pytest
from haystack.components.converters import OpenAPIServiceToFunctions
from haystack.dataclasses import ByteStream
@pytest.fixture
def json_serperdev_openapi_spec():
serper_spec = """
{
"openapi": "3.0.0",
"info": {
"title": "SerperDev",
"version": "1.0.0",
"description": "API for performing search queries"
},
"servers": [
{
"url": "https://google.serper.dev"
}
],
"paths": {
"/search": {
"post": {
"operationId": "search",
"description": "Search the web with Google",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"q": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"searchParameters": {
"type": "undefined"
},
"knowledgeGraph": {
"type": "undefined"
},
"answerBox": {
"type": "undefined"
},
"organic": {
"type": "undefined"
},
"topStories": {
"type": "undefined"
},
"peopleAlsoAsk": {
"type": "undefined"
},
"relatedSearches": {
"type": "undefined"
}
}
}
}
}
}
},
"security": [
{
"apikey": []
}
]
}
}
},
"components": {
"securitySchemes": {
"apikey": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
}
}
}
"""
return serper_spec
@pytest.fixture
def yaml_serperdev_openapi_spec():
serper_spec = """
openapi: 3.0.0
info:
title: SerperDev
version: 1.0.0
description: API for performing search queries
servers:
- url: 'https://google.serper.dev'
paths:
/search:
post:
operationId: search
description: Search the web with Google
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
q:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
searchParameters:
type: undefined
knowledgeGraph:
type: undefined
answerBox:
type: undefined
organic:
type: undefined
topStories:
type: undefined
peopleAlsoAsk:
type: undefined
relatedSearches:
type: undefined
security:
- apikey: []
components:
securitySchemes:
apikey:
type: apiKey
name: x-api-key
in: header
"""
return serper_spec
class TestOpenAPIServiceToFunctions:
# test we can parse openapi spec given in json
def test_openapi_spec_parsing_json(self, json_serperdev_openapi_spec):
service = OpenAPIServiceToFunctions()
serper_spec_json = service._parse_openapi_spec(json_serperdev_openapi_spec)
assert serper_spec_json["openapi"] == "3.0.0"
assert serper_spec_json["info"]["title"] == "SerperDev"
# test we can parse openapi spec given in yaml
def test_openapi_spec_parsing_yaml(self, yaml_serperdev_openapi_spec):
service = OpenAPIServiceToFunctions()
serper_spec_yaml = service._parse_openapi_spec(yaml_serperdev_openapi_spec)
assert serper_spec_yaml["openapi"] == "3.0.0"
assert serper_spec_yaml["info"]["title"] == "SerperDev"
# test we can extract functions from openapi spec given
def test_run_with_bytestream_source(self, json_serperdev_openapi_spec):
service = OpenAPIServiceToFunctions()
spec_stream = ByteStream.from_string(json_serperdev_openapi_spec)
result = service.run(sources=[spec_stream])
assert len(result["functions"]) == 1
fc = result["functions"][0]
# check that fc definition is as expected
assert fc == {
"name": "search",
"description": "Search the web with Google",
"parameters": {"type": "object", "properties": {"q": {"type": "string"}}},
}
@pytest.mark.skipif(
sys.platform in ["win32", "cygwin"],
reason="Can't run on Windows Github CI, need access temp file but windows does not allow it",
)
def test_run_with_file_source(self, json_serperdev_openapi_spec):
# test we can extract functions from openapi spec given in file
service = OpenAPIServiceToFunctions()
# write the spec to NamedTemporaryFile and check that it is parsed correctly
with tempfile.NamedTemporaryFile() as tmp:
tmp.write(json_serperdev_openapi_spec.encode("utf-8"))
tmp.seek(0)
result = service.run(sources=[tmp.name])
assert len(result["functions"]) == 1
fc = result["functions"][0]
# check that fc definition is as expected
assert fc == {
"name": "search",
"description": "Search the web with Google",
"parameters": {"type": "object", "properties": {"q": {"type": "string"}}},
}
def test_run_with_invalid_file_source(self, caplog):
# test invalid source
service = OpenAPIServiceToFunctions()
result = service.run(sources=["invalid_source"])
assert result["functions"] == []
assert "not found" in caplog.text
def test_run_with_invalid_bytestream_source(self, caplog):
# test invalid source
service = OpenAPIServiceToFunctions()
result = service.run(sources=[ByteStream.from_string("")])
assert result["functions"] == []
assert "Invalid OpenAPI specification" in caplog.text
def test_complex_types_conversion(self, test_files_path):
# ensure that complex types from OpenAPI spec are converted to the expected format in OpenAI function calling
service = OpenAPIServiceToFunctions()
result = service.run(sources=[test_files_path / "json" / "complex_types_openapi_service.json"])
assert len(result["functions"]) == 1
with open(test_files_path / "json" / "complex_types_openai_spec.json") as openai_spec_file:
desired_output = json.load(openai_spec_file)
assert result["functions"][0] == desired_output
def test_simple_and_complex_at_once(self, test_files_path, json_serperdev_openapi_spec):
# ensure multiple functions are extracted from multiple paths in OpenAPI spec
service = OpenAPIServiceToFunctions()
sources = [
ByteStream.from_string(json_serperdev_openapi_spec),
test_files_path / "json" / "complex_types_openapi_service.json",
]
result = service.run(sources=sources)
assert len(result["functions"]) == 2
with open(test_files_path / "json" / "complex_types_openai_spec.json") as openai_spec_file:
desired_output = json.load(openai_spec_file)
assert result["functions"][0] == {
"name": "search",
"description": "Search the web with Google",
"parameters": {"type": "object", "properties": {"q": {"type": "string"}}},
}
assert result["functions"][1] == desired_output
|