feat(core): update sdk documentation

Author: thedevtoni

cases.py

@@ -0,0 +1,32 @@
+from orquesta_sdk.helpers import orquesta_openai_parameters_mapper
+
+import os
+
+from orquesta_sdk import OrquestaClient, OrquestaClientOptions
+from orquesta_sdk.prompts import OrquestaPromptRequest
+from orquesta_sdk.remoteconfigs import OrquestaRemoteConfigRequest
+
+api_key = os.environ.get("ORQUESTA_API_KEY", "__API_KEY__")
+
+options = OrquestaClientOptions(api_key=api_key, ttl=3600, environment="production")
+
+client = OrquestaClient(options)
+
+request = OrquestaPromptRequest(
+    key="prompt_key",
+    context={"environments": "production", "workspaceId": "soql1odAABC2"},
+    variables={"firstname": "John", "city": "New York"},
+    metadata={"chain_id": "ad1231xsdaABw"},
+)
+
+request = OrquestaRemoteConfigRequest(
+    key="prompt_key",
+    context={"environments": "production", "workspaceId": "soql1odAABC2"},
+    metadata={"chain_id": "ad1231xsdaABw"},
+)
+
+prompt = client.prompts.query(
+    request=request,
+)
+
+print(prompt.value)

docs/conf.py

@@ -12,7 +12,7 @@
 project = "orquesta_sdk"
 copyright = "2023, orquesta"
 author = "orquesta"
-release = "1.11.2"
+release = "1.11.4"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

orquesta_sdk/version.py

@@ -1 +1 @@
-__version__ = "1.11.2"
+__version__ = "1.11.4"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "orquesta_sdk"
-version = "1.11.2"
+version = "1.11.4"
 description = "_LLM Operations and Integration Platform_"
 authors = ["Orquesta <info@orquesta.dev>"]
 classifiers = [

readme.md

@@ -156,13 +156,17 @@ The `query` method receives an object of type `OrquestaPromptRequest` as paramet
 
 from orquesta_sdk.helpers import orquesta_openai_parameters_mapper
 
-prompt = client.prompts.query(
+request = OrquestaPromptRequest(
     key="prompt_key",
     context={"environments": "production", "workspaceId": "soql1odAABC2"},
     variables={"firstname": "John", "city": "New York"},
     metadata={"chain_id": "ad1231xsdaABw"},
 )
 
+prompt = client.prompts.query(
+    request=request,
+)
+
 openai_api_parameters = orquesta_openai_parameters_mapper(prompt.value)
 ```
 
@@ -236,45 +240,61 @@ config = client.remoteconfigs.query(
 
 ```python
 
-
-config = client.remoteconfigs.query(
+request = OrquestaRemoteConfigRequest(
     key="str_config",
     default_value="str_value",
     context={"environments": "production", "country": "NL"},
     metadata={"timestamp": 1623345600}
 )
+
+config = client.remoteconfigs.query(
+    request=request
+)
 ```
 
 #### Example: Querying a configuration of type int
 
 ```python
-config = client.remoteconfigs.query(
+request = OrquestaRemoteConfigRequest(
     key="int_config",
     default_value=1990,
     context={"environments": "production", "market": "US" },
     metadata={"domain": "ecommerce"}
 )
+
+config = client.remoteconfigs.query(
+    request=request
+)
+
 ```
 
 #### Example: Querying a configuration of type array
 
 ```python
-config = client.remoteconfigs.query(
+request = OrquestaRemoteConfigRequest(
     key="list_config",
     default_value=["USA", "NL"],
     context={"environments": "acceptance", "is_enable": True},
     metadata={"domain": "ecommerce"}
 )
+
+config = client.remoteconfigs.query(
+    request=request
+)
 ```
 
 #### Example: Querying a configuration of type JSON
 
 ```python
-config = client.remoteconfigs.query(
+request = OrquestaRemoteConfigRequest(
     key="json_config",
     default_value=dict,
     contenxt={"environments": "develop", "platform": "mobile"},
 )
+
+config = client.remoteconfigs.query(
+    request=request
+)
 ```
 
 ### Additional metadata logging