chore: setup docs foundation

Author: thedevtoni

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

example.py

@@ -2,17 +2,42 @@
 
 ### Intialize the Orquesta client
 
-client_options = OrquestaClientOptions(
+options = OrquestaClientOptions(
     api_key="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3b3Jrc3BhY2VJZCI6ImUzYTIwMmE2LTQ2MWItNDQ3Yy1hYmUyLTAxOGJhNGQwNGNkMCIsImlhdCI6MTY5NzEyNTQ1NDczN30.3kBW_RfS104S2DAlSvPpr3tQiq15nTxNuUv2gE0Nxd0",
     environment="production",
 )
 
-client = Orquesta(options=client_options)
+client = Orquesta(options)
 
-deployment = client.deployments.invoke_with_stream(
-    key="withFallback", metadata={"name": "test"}
+deployment = client.deployments.get_config(
+    key="withFallback",
+    context={"environments": "production", "country": "NLD"},
+    inputs={"firstname": "John", "city": "New York"},
+    metadata={"customer_id": "Qwtqwty90281"},
 )
 
-for chunk in deployment:
-    if chunk.is_final:
-        print("Stream is finished")
+print(deployment.to_dict())
+
+deployment.add_metrics(
+    chain_id="c4a75b53-62fa-401b-8e97-493f3d299316",
+    conversation_id="ee7b0c8c-eeb2-43cf-83e9-a4a49f8f13ea",
+    user_id="e3a202a6-461b-447c-abe2-018ba4d04cd0",
+    feedback={"score": 100},
+    metadata={
+        "custom": "custom_metadata",
+        "chain_id": "ad1231xsdaABw",
+    },
+    usage={
+        "prompt_tokens": 100,
+        "completion_tokens": 900,
+        "total_tokens": 1000,
+    },
+    performance={
+        "latency": 9000,
+        "time_to_first_token": 250,
+    },
+)
+
+# for chunk in deployment:
+#     if chunk.is_final:
+#         print("Stream is finished")

examples/deployment-with-image.ipynb

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

make.bat

@@ -0,0 +1,12 @@
+site_name: "Orquesta's Python SDK"
+
+theme:
+  name: "readthedocs"
+
+plugins:
+  - search
+  - mkdocstrings:
+      default_handler: python
+
+sphinx:
+  configuration: source/conf.py

mkdocs.yml

@@ -1,5 +1,2 @@
-api_key: str | None = None
-
-
 from .client import Orquesta
 from .options import OrquestaClientOptions

orquesta_sdk/__init__.py

@@ -7,7 +7,7 @@
 from orquesta_sdk.options import OrquestaClientOptions
 from orquesta_sdk.util import extract_json
 
-DEPLOYMENTS_API = "https://preview.orquesta.cloud/v2/deployments"
+DEPLOYMENTS_API = "https://api.orquesta.cloud/v2/deployments"
 
 GET_CONFIG_URL = "{}/get_config".format(DEPLOYMENTS_API)
 INVOKE_URL = "{}/invoke".format(DEPLOYMENTS_API)
@@ -187,6 +187,13 @@ def __init__(
         self.choices = [DeploymentDataChoice(choice) for choice in choices]
 
     def to_dict(self):
+        """
+        Converts the deployment object to a dictionary representation.
+
+        Returns:
+            dict: A dictionary representation of the deployment object.
+
+        """
         return {
             "id": self.id,
             "created": self.created,
@@ -371,8 +378,6 @@ def invoke_with_stream(self, key: str, context=None, inputs=None, metadata=None)
             key=key, context=context, variables=inputs, metadata=metadata
         )
 
-        stream = self.body_params.get("stream", False)
-
         response = post(
             url=INVOKE_URL,
             api_key=self.options.api_key,

orquesta_sdk/api_resources/deployments.py

@@ -7,6 +7,19 @@
 
 
 class Orquesta:
+    """
+    Represents an Orquesta client.
+
+    Args:
+        options (OrquestaClientOptions): The options for the Orquesta client.
+
+    Attributes:
+        deployments (Deployments): An instance of the Deployments class.
+
+    Raises:
+        OrquestaInvalidAPIException: If the provided API key is invalid.
+    """
+
     def __init__(self, options: OrquestaClientOptions):
         api_key = options.api_key or os.environ.get("ORQUESTA_API_KEY")
 

orquesta_sdk/client.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "orquesta_sdk"
-version = "1.11.6"
+version = '2.0.0rc1'
 description = "_LLM Operations and Integration Platform_"
 authors = ["Orquesta <info@orquesta.dev>"]
 classifiers = [
@@ -23,10 +23,11 @@ readme = "README.md"
 
 
 [tool.poetry.dependencies]
-python = ">=3.8,<4.0.0"
+python = ">=3.9,<4.0.0"
 requests = "^2.28.2"
 httpx = "^0.25.2"
 
+
 [tool.poetry.dev-dependencies]
 black = "^21.9b0"
 pytest = "^6.2.5"
@@ -36,6 +37,10 @@ tox = "^3.24.4"
 tox-pyenv = "^1.1.0"
 pytest-watch = "^4.2.0"
 
+[tool.poetry.group.dev.dependencies]
+mkdocs = "^1.5.3"
+sphinx = "^7.2.6"
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"