From 1770f540fa231b31901803f3b444433820a33149 Mon Sep 17 00:00:00 2001 From: Fantix King Date: Fri, 26 Apr 2024 18:06:58 -0400 Subject: [PATCH 1/5] Create edgedb_ai package --- .gitignore | 1 + ai/LICENSE | 201 +++++++++++++++++++++++++++++++++++++++ ai/edgedb_ai/__init__.py | 21 ++++ ai/edgedb_ai/core.py | 170 +++++++++++++++++++++++++++++++++ ai/edgedb_ai/types.py | 81 ++++++++++++++++ ai/pyproject.toml | 16 ++++ 6 files changed, 490 insertions(+) create mode 100644 ai/LICENSE create mode 100644 ai/edgedb_ai/__init__.py create mode 100644 ai/edgedb_ai/core.py create mode 100644 ai/edgedb_ai/types.py create mode 100644 ai/pyproject.toml diff --git a/.gitignore b/.gitignore index 84d8e3dc..1d28f1ac 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ __pycache__/ /.eggs /*.egg /*.egg-info +/ai/*.egg-info /dist /.cache docs/_build diff --git a/ai/LICENSE b/ai/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/ai/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/ai/edgedb_ai/__init__.py b/ai/edgedb_ai/__init__.py new file mode 100644 index 00000000..d36b68cd --- /dev/null +++ b/ai/edgedb_ai/__init__.py @@ -0,0 +1,21 @@ +# +# This source file is part of the EdgeDB open source project. +# +# Copyright 2024-present MagicStack Inc. and the EdgeDB authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .types import AIOptions, ChatParticipantRole, Prompt, QueryContext +from .core import create_AI, EdgeDBAI +from .core import create_async_AI, AsyncEdgeDBAI diff --git a/ai/edgedb_ai/core.py b/ai/edgedb_ai/core.py new file mode 100644 index 00000000..03117d35 --- /dev/null +++ b/ai/edgedb_ai/core.py @@ -0,0 +1,170 @@ +# +# This source file is part of the EdgeDB open source project. +# +# Copyright 2024-present MagicStack Inc. and the EdgeDB authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from __future__ import annotations +import typing + +import edgedb +import httpx +import httpx_sse + +from . import types + + +def create_AI(client: edgedb.Client, **kwargs) -> EdgeDBAI: + client.ensure_connected() + return EdgeDBAI(client, types.AIOptions(**kwargs)) + + +async def create_async_AI( + client: edgedb.AsyncIOClient, **kwargs +) -> AsyncEdgeDBAI: + await client.ensure_connected() + return AsyncEdgeDBAI(client, types.AIOptions(**kwargs)) + + +class BaseEdgeDBAI: + options: types.AIOptions + context: types.QueryContext + client_cls = NotImplemented + + def __init__( + self, + client: typing.Union[edgedb.Client, edgedb.AsyncIOClient], + options: types.AIOptions, + **kwargs, + ): + pool = getattr(client, "_impl") + host, port = getattr(pool, "_working_addr") + params = getattr(pool, "_working_params") + proto = "http" if params.tls_security == "insecure" else "https" + branch = params.branch + self.options = options + self.context = types.QueryContext(**kwargs) + self._init_client( + base_url=f"{proto}://{host}:{port}/branch/{branch}/ext/ai", + auth=(params.user, params.password), + verify=params.ssl_ctx, + ) + + def _init_client(self, **kwargs): + raise NotImplementedError + + def with_config(self, **kwargs) -> typing.Self: + cls = type(self) + rv = cls.__new__(cls) + rv.options = self.options.derive(kwargs) + rv.context = self.context + rv.client = self.client + return rv + + def with_context(self, **kwargs) -> typing.Self: + cls = type(self) + rv = cls.__new__(cls) + rv.options = self.options + rv.context = self.context.derive(kwargs) + rv.client = self.client + return rv + + +class EdgeDBAI(BaseEdgeDBAI): + client: httpx.Client + + def _init_client(self, **kwargs): + self.client = httpx.Client(**kwargs) + + def query_rag( + self, message: str, context: typing.Optional[types.QueryContext] = None + ) -> str: + if context is None: + context = self.context + resp = self.client.post( + **types.RAGRequest( + model=self.options.model, + prompt=self.options.prompt, + context=context, + query=message, + stream=False, + ).to_httpx_request() + ) + resp.raise_for_status() + return resp.json()["response"] + + def stream_rag( + self, message: str, context: typing.Optional[types.QueryContext] = None + ): + if context is None: + context = self.context + with httpx_sse.connect_sse( + self.client, + "post", + **types.RAGRequest( + model=self.options.model, + prompt=self.options.prompt, + context=context, + query=message, + stream=True, + ).to_httpx_request(), + ) as event_source: + event_source.response.raise_for_status() + for sse in event_source.iter_sse(): + yield sse.data + + +class AsyncEdgeDBAI(BaseEdgeDBAI): + client: httpx.AsyncClient + + def _init_client(self, **kwargs): + self.client = httpx.AsyncClient(**kwargs) + + async def query_rag( + self, message: str, context: typing.Optional[types.QueryContext] = None + ) -> str: + if context is None: + context = self.context + resp = await self.client.post( + **types.RAGRequest( + model=self.options.model, + prompt=self.options.prompt, + context=context, + query=message, + stream=False, + ).to_httpx_request() + ) + resp.raise_for_status() + return resp.json()["response"] + + async def stream_rag( + self, message: str, context: typing.Optional[types.QueryContext] = None + ): + if context is None: + context = self.context + async with httpx_sse.aconnect_sse( + self.client, + "post", + **types.RAGRequest( + model=self.options.model, + prompt=self.options.prompt, + context=context, + query=message, + stream=True, + ).to_httpx_request(), + ) as event_source: + event_source.response.raise_for_status() + async for sse in event_source.aiter_sse(): + yield sse.data diff --git a/ai/edgedb_ai/types.py b/ai/edgedb_ai/types.py new file mode 100644 index 00000000..41bf24c0 --- /dev/null +++ b/ai/edgedb_ai/types.py @@ -0,0 +1,81 @@ +# +# This source file is part of the EdgeDB open source project. +# +# Copyright 2024-present MagicStack Inc. and the EdgeDB authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import typing + +import dataclasses as dc +import enum + + +class ChatParticipantRole(enum.Enum): + SYSTEM = "system" + USER = "user" + ASSISTANT = "assistant" + TOOL = "tool" + + +class Custom(typing.TypedDict): + role: ChatParticipantRole + content: str + + +class Prompt: + name: typing.Optional[str] + id: typing.Optional[str] + custom: typing.Optional[typing.List[Custom]] + + +@dc.dataclass +class AIOptions: + model: str + prompt: typing.Optional[Prompt] = None + + def derive(self, kwargs): + return AIOptions(**{**dc.asdict(self), **kwargs}) + + +@dc.dataclass +class QueryContext: + query: str = "" + variables: typing.Optional[typing.Dict[str, typing.Any]] = None + globals: typing.Optional[typing.Dict[str, typing.Any]] = None + max_object_count: typing.Optional[int] = None + + def derive(self, kwargs): + return QueryContext(**{**dc.asdict(self), **kwargs}) + + +@dc.dataclass +class RAGRequest: + model: str + prompt: typing.Optional[Prompt] + context: QueryContext + query: str + stream: typing.Optional[bool] + + def to_httpx_request(self) -> typing.Dict[str, typing.Any]: + return dict( + url="/rag", + headers={ + "Content-Type": "application/json", + "Accept": ( + "text/event-stream" if self.stream else "application/json" + ), + }, + json=dc.asdict(self), + ) diff --git a/ai/pyproject.toml b/ai/pyproject.toml new file mode 100644 index 00000000..c28a5ca8 --- /dev/null +++ b/ai/pyproject.toml @@ -0,0 +1,16 @@ +[project] +name = "edgedb_ai" +version = "0.1.0" +description = "Helper library for the EdgeDB AI extension" +readme = "README.md" +requires-python = ">=3.8" +license = {file = "LICENSE"} +dependencies = [ + "edgedb", + "httpx", + "httpx-sse" +] + +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" From de94a4559b0acd822136402cf6ef2cc663b01c72 Mon Sep 17 00:00:00 2001 From: Fantix King Date: Fri, 26 Apr 2024 18:15:25 -0400 Subject: [PATCH 2/5] Support EdgeDB Cloud --- ai/edgedb_ai/core.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/ai/edgedb_ai/core.py b/ai/edgedb_ai/core.py index 03117d35..aede1867 100644 --- a/ai/edgedb_ai/core.py +++ b/ai/edgedb_ai/core.py @@ -56,11 +56,15 @@ def __init__( branch = params.branch self.options = options self.context = types.QueryContext(**kwargs) - self._init_client( + args = dict( base_url=f"{proto}://{host}:{port}/branch/{branch}/ext/ai", - auth=(params.user, params.password), verify=params.ssl_ctx, ) + if params.password is not None: + args["auth"] = (params.user, params.password) + elif params.secret_key is not None: + args["headers"] = {"Authorization": f"Bearer {params.secret_key}"} + self._init_client(**args) def _init_client(self, **kwargs): raise NotImplementedError From 00936e87c91b620926c8d4ddf9b7301d9f49324f Mon Sep 17 00:00:00 2001 From: Fantix King Date: Fri, 26 Apr 2024 18:31:59 -0400 Subject: [PATCH 3/5] Merge into the main package --- .gitignore | 1 - ai/LICENSE | 201 ------------------------ ai/pyproject.toml | 16 -- {ai/edgedb_ai => edgedb/ai}/__init__.py | 0 {ai/edgedb_ai => edgedb/ai}/core.py | 0 {ai/edgedb_ai => edgedb/ai}/types.py | 0 setup.py | 6 + 7 files changed, 6 insertions(+), 218 deletions(-) delete mode 100644 ai/LICENSE delete mode 100644 ai/pyproject.toml rename {ai/edgedb_ai => edgedb/ai}/__init__.py (100%) rename {ai/edgedb_ai => edgedb/ai}/core.py (100%) rename {ai/edgedb_ai => edgedb/ai}/types.py (100%) diff --git a/.gitignore b/.gitignore index 1d28f1ac..84d8e3dc 100644 --- a/.gitignore +++ b/.gitignore @@ -15,7 +15,6 @@ __pycache__/ /.eggs /*.egg /*.egg-info -/ai/*.egg-info /dist /.cache docs/_build diff --git a/ai/LICENSE b/ai/LICENSE deleted file mode 100644 index 261eeb9e..00000000 --- a/ai/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/ai/pyproject.toml b/ai/pyproject.toml deleted file mode 100644 index c28a5ca8..00000000 --- a/ai/pyproject.toml +++ /dev/null @@ -1,16 +0,0 @@ -[project] -name = "edgedb_ai" -version = "0.1.0" -description = "Helper library for the EdgeDB AI extension" -readme = "README.md" -requires-python = ">=3.8" -license = {file = "LICENSE"} -dependencies = [ - "edgedb", - "httpx", - "httpx-sse" -] - -[build-system] -requires = ["setuptools"] -build-backend = "setuptools.build_meta" diff --git a/ai/edgedb_ai/__init__.py b/edgedb/ai/__init__.py similarity index 100% rename from ai/edgedb_ai/__init__.py rename to edgedb/ai/__init__.py diff --git a/ai/edgedb_ai/core.py b/edgedb/ai/core.py similarity index 100% rename from ai/edgedb_ai/core.py rename to edgedb/ai/core.py diff --git a/ai/edgedb_ai/types.py b/edgedb/ai/types.py similarity index 100% rename from ai/edgedb_ai/types.py rename to edgedb/ai/types.py diff --git a/setup.py b/setup.py index b8f83148..8884fed2 100644 --- a/setup.py +++ b/setup.py @@ -59,7 +59,13 @@ 'sphinx_rtd_theme~=1.0.0', ] +AI_DEPENDENCIES = [ + 'httpx~=0.27.0', + 'httpx-sse~=0.4.0', +] + EXTRA_DEPENDENCIES = { + 'ai': AI_DEPENDENCIES, 'docs': DOC_DEPENDENCIES, 'test': TEST_DEPENDENCIES, # Dependencies required to develop edgedb. From ad70a549a02657a189fd498695b349b228a83aa6 Mon Sep 17 00:00:00 2001 From: Fantix King Date: Sat, 27 Apr 2024 21:34:41 -0400 Subject: [PATCH 4/5] Fix flake8 --- edgedb/ai/__init__.py | 11 +++++++++++ edgedb/ai/core.py | 6 +++--- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/edgedb/ai/__init__.py b/edgedb/ai/__init__.py index d36b68cd..2fc3b67d 100644 --- a/edgedb/ai/__init__.py +++ b/edgedb/ai/__init__.py @@ -19,3 +19,14 @@ from .types import AIOptions, ChatParticipantRole, Prompt, QueryContext from .core import create_AI, EdgeDBAI from .core import create_async_AI, AsyncEdgeDBAI + +__all__ = [ + "AIOptions", + "ChatParticipantRole", + "Prompt", + "QueryContext", + "create_AI", + "EdgeDBAI", + "create_async_AI", + "AsyncEdgeDBAI", +] diff --git a/edgedb/ai/core.py b/edgedb/ai/core.py index aede1867..9fe8bbb4 100644 --- a/edgedb/ai/core.py +++ b/edgedb/ai/core.py @@ -49,9 +49,9 @@ def __init__( options: types.AIOptions, **kwargs, ): - pool = getattr(client, "_impl") - host, port = getattr(pool, "_working_addr") - params = getattr(pool, "_working_params") + pool = client._impl + host, port = pool._working_addr + params = pool._working_params proto = "http" if params.tls_security == "insecure" else "https" branch = params.branch self.options = options From 81616ed9f1b8bbccdc567fedc6c2cfc206e985dc Mon Sep 17 00:00:00 2001 From: Fantix King Date: Mon, 29 Apr 2024 21:29:45 -0400 Subject: [PATCH 5/5] CRF: renaming --- edgedb/ai/__init__.py | 8 ++++---- edgedb/ai/core.py | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/edgedb/ai/__init__.py b/edgedb/ai/__init__.py index 2fc3b67d..96111c2b 100644 --- a/edgedb/ai/__init__.py +++ b/edgedb/ai/__init__.py @@ -17,16 +17,16 @@ # from .types import AIOptions, ChatParticipantRole, Prompt, QueryContext -from .core import create_AI, EdgeDBAI -from .core import create_async_AI, AsyncEdgeDBAI +from .core import create_ai, EdgeDBAI +from .core import create_async_ai, AsyncEdgeDBAI __all__ = [ "AIOptions", "ChatParticipantRole", "Prompt", "QueryContext", - "create_AI", + "create_ai", "EdgeDBAI", - "create_async_AI", + "create_async_ai", "AsyncEdgeDBAI", ] diff --git a/edgedb/ai/core.py b/edgedb/ai/core.py index 9fe8bbb4..e7fd0700 100644 --- a/edgedb/ai/core.py +++ b/edgedb/ai/core.py @@ -26,12 +26,12 @@ from . import types -def create_AI(client: edgedb.Client, **kwargs) -> EdgeDBAI: +def create_ai(client: edgedb.Client, **kwargs) -> EdgeDBAI: client.ensure_connected() return EdgeDBAI(client, types.AIOptions(**kwargs)) -async def create_async_AI( +async def create_async_ai( client: edgedb.AsyncIOClient, **kwargs ) -> AsyncEdgeDBAI: await client.ensure_connected()