liyaengine 0.2.0__tar.gz → 0.4.0__tar.gz

{liyaengine-0.2.0 → liyaengine-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: liyaengine
-Version: 0.2.0
+Version: 0.4.0
 Summary: Official Python client for the Liya Engine public API
 Project-URL: Homepage, https://liyaengine.ai
 Project-URL: Documentation, https://liyaengine.ai/docs/sdks/python
@@ -31,7 +31,7 @@ Description-Content-Type: text/markdown
 
 Official Python client for the [Liya Engine](https://liyaengine.ai) public API.
 
-> **Status: early access.** This SDK currently covers Collections and Agents. More resources (Domains, Run, Workflows, Guardrail Policies, Evals) ship incrementally — see [Roadmap](#roadmap).
+> **Status: early access.** This SDK currently covers Collections, Agents, Workflows, and Evaluations. More resources (Domains, Run, Guardrail Policies) ship incrementally — see [Roadmap](#roadmap).
 
 ## Install
 
@@ -81,6 +81,66 @@ result = client.agents.run(agent.agent_key, input={"message": "My order hasn't a
 history = client.agents.list_runs(agent.agent_key)
 ```
 
+## Workflows
+
+```python
+workflow = client.workflows.create(
+    name="Lead Intake",
+    steps=[{"step_type": "trigger", "config": {"trigger_subtype": "webhook"}}],
+)
+
+# Workflows are created in draft status — deploy to publish and make them
+# callable. Deploying a webhook-triggered workflow for the first time mints
+# its webhook secret; capture it immediately, it is never returned again.
+deployed = client.workflows.deploy(workflow.workflow_key)
+webhook_url, webhook_secret = deployed["webhook_url"], deployed["webhook_secret"]
+
+# Roll the secret with a grace window so in-flight senders don't break.
+client.workflows.rotate_webhook_secret(workflow.workflow_key, grace_period_seconds=300)
+
+# Flip a deployed workflow on/off without touching its definition.
+client.workflows.toggle(workflow.workflow_key)
+
+result = client.workflows.run(workflow.workflow_key, input={"email": "ada@example.com"})
+
+history = client.workflows.list_runs(workflow.workflow_key)
+```
+
+> `deploy()` and `rotate_webhook_secret()` return the plaintext webhook secret exactly once. Store it immediately — subsequent reads (`get`, `list`) only ever expose `trigger_config["has_secret"]`.
+
+## Evaluations
+
+A Suite binds a Dataset to one specific intent; `suites.run()` calls that intent for real and scores what it produces. `runs.submit()`/`evaluations.score()` score a response you already generated yourself — no intent execution involved.
+
+```python
+dataset = client.evaluations.datasets.create(
+    name="Support Replies",
+    cases=[{"input": {"message": "Where is my order?"}}],
+)
+
+suite = client.evaluations.suites.create(
+    name="Order Status Suite",
+    domain_key="support",
+    intent_key="order-status",
+    dataset_id=dataset.id,
+)
+
+# Runs are always async — poll for status/results.
+run = client.evaluations.suites.run(suite.id)
+result = client.evaluations.runs.get(run.id)
+
+# A failed run can be resumed — already-scored cases are skipped.
+client.evaluations.runs.resume(run.id)
+
+# Score a response you already generated, no dataset/suite required.
+scored = client.evaluations.score(
+    input={"message": "Where is my order?"},
+    output="Your order shipped yesterday and should arrive by Friday.",
+)
+```
+
+> `custom_scorer_webhook_secret` on a Suite is write-only — it's never returned; only a `custom_scorer_webhook_secret_set` boolean comes back on reads.
+
 ## Error handling
 
 Every failed request raises `LiyaEngineAPIError`, carrying the API's `code`, `message`, and HTTP `status`:
@@ -114,11 +174,11 @@ LiyaEngine(
 
 - [x] Collections
 - [x] Agents (full CRUD, deploy, run, run/session history)
+- [x] Workflows (full CRUD, toggle, deploy, webhook secret rotate, run, run history)
+- [x] Evaluations (Datasets/Cases/Suites/Runs/Reviews CRUD, suite execution, cancel/resume, statistical + pairwise compare, standalone scoring)
 - [ ] Domains (custom domain + intent CRUD)
 - [ ] Run / Run (streaming)
-- [ ] Workflows
 - [ ] Guardrail Policies
-- [ ] Evaluations
 - [ ] Async client
 
 Full docs: https://liyaengine.ai/docs/sdks/python

liyaengine-0.4.0/README.md

@@ -0,0 +1,168 @@
+# liyaengine
+
+Official Python client for the [Liya Engine](https://liyaengine.ai) public API.
+
+> **Status: early access.** This SDK currently covers Collections, Agents, Workflows, and Evaluations. More resources (Domains, Run, Guardrail Policies) ship incrementally — see [Roadmap](#roadmap).
+
+## Install
+
+```bash
+pip install liyaengine
+```
+
+## Quickstart
+
+```python
+from liyaengine import LiyaEngine
+
+client = LiyaEngine(api_key="liya_...")
+
+collection = client.collections.create(
+    slug="contracts",
+    label="Contracts",
+    domain_keys=["legal-ops"],
+)
+
+collections = client.collections.list()
+```
+
+Or as a context manager (closes the underlying HTTP connection pool automatically):
+
+```python
+with LiyaEngine(api_key="liya_...") as client:
+    collections = client.collections.list()
+```
+
+Get an API key from your [Liya Engine dashboard](https://app.liyaengine.ai) under Settings → API Keys.
+
+## Agents
+
+```python
+agent = client.agents.create(
+    agent_key="support-triage",
+    name="Support Triage",
+    goal="Triage incoming support tickets and route them to the right team.",
+)
+
+# Agents are created in draft status — deploy to activate for execution.
+client.agents.deploy(agent.agent_key)
+
+result = client.agents.run(agent.agent_key, input={"message": "My order hasn't arrived yet."})
+
+history = client.agents.list_runs(agent.agent_key)
+```
+
+## Workflows
+
+```python
+workflow = client.workflows.create(
+    name="Lead Intake",
+    steps=[{"step_type": "trigger", "config": {"trigger_subtype": "webhook"}}],
+)
+
+# Workflows are created in draft status — deploy to publish and make them
+# callable. Deploying a webhook-triggered workflow for the first time mints
+# its webhook secret; capture it immediately, it is never returned again.
+deployed = client.workflows.deploy(workflow.workflow_key)
+webhook_url, webhook_secret = deployed["webhook_url"], deployed["webhook_secret"]
+
+# Roll the secret with a grace window so in-flight senders don't break.
+client.workflows.rotate_webhook_secret(workflow.workflow_key, grace_period_seconds=300)
+
+# Flip a deployed workflow on/off without touching its definition.
+client.workflows.toggle(workflow.workflow_key)
+
+result = client.workflows.run(workflow.workflow_key, input={"email": "ada@example.com"})
+
+history = client.workflows.list_runs(workflow.workflow_key)
+```
+
+> `deploy()` and `rotate_webhook_secret()` return the plaintext webhook secret exactly once. Store it immediately — subsequent reads (`get`, `list`) only ever expose `trigger_config["has_secret"]`.
+
+## Evaluations
+
+A Suite binds a Dataset to one specific intent; `suites.run()` calls that intent for real and scores what it produces. `runs.submit()`/`evaluations.score()` score a response you already generated yourself — no intent execution involved.
+
+```python
+dataset = client.evaluations.datasets.create(
+    name="Support Replies",
+    cases=[{"input": {"message": "Where is my order?"}}],
+)
+
+suite = client.evaluations.suites.create(
+    name="Order Status Suite",
+    domain_key="support",
+    intent_key="order-status",
+    dataset_id=dataset.id,
+)
+
+# Runs are always async — poll for status/results.
+run = client.evaluations.suites.run(suite.id)
+result = client.evaluations.runs.get(run.id)
+
+# A failed run can be resumed — already-scored cases are skipped.
+client.evaluations.runs.resume(run.id)
+
+# Score a response you already generated, no dataset/suite required.
+scored = client.evaluations.score(
+    input={"message": "Where is my order?"},
+    output="Your order shipped yesterday and should arrive by Friday.",
+)
+```
+
+> `custom_scorer_webhook_secret` on a Suite is write-only — it's never returned; only a `custom_scorer_webhook_secret_set` boolean comes back on reads.
+
+## Error handling
+
+Every failed request raises `LiyaEngineAPIError`, carrying the API's `code`, `message`, and HTTP `status`:
+
+```python
+from liyaengine import LiyaEngineAPIError
+
+try:
+    client.collections.create(slug="contracts", label="Contracts", domain_keys=["legal-ops"])
+except LiyaEngineAPIError as err:
+    if err.code == "SLUG_CONFLICT":
+        # handle the conflict
+        pass
+    raise
+```
+
+Network failures and timeouts raise `LiyaEngineNetworkError` instead. Requests are retried automatically on `429`/`5xx` responses and transient network errors (2 retries by default).
+
+## Configuration
+
+```python
+LiyaEngine(
+    api_key="liya_...",
+    base_url="https://api.liyaengine.ai",  # override for local/staging
+    timeout_s=30.0,
+    max_retries=2,
+)
+```
+
+## Roadmap
+
+- [x] Collections
+- [x] Agents (full CRUD, deploy, run, run/session history)
+- [x] Workflows (full CRUD, toggle, deploy, webhook secret rotate, run, run history)
+- [x] Evaluations (Datasets/Cases/Suites/Runs/Reviews CRUD, suite execution, cancel/resume, statistical + pairwise compare, standalone scoring)
+- [ ] Domains (custom domain + intent CRUD)
+- [ ] Run / Run (streaming)
+- [ ] Guardrail Policies
+- [ ] Async client
+
+Full docs: https://liyaengine.ai/docs/sdks/python
+
+## Development
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+mypy src
+pytest
+```
+
+## License
+
+MIT

{liyaengine-0.2.0 → liyaengine-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "liyaengine"
-version = "0.2.0"
+version = "0.4.0"
 description = "Official Python client for the Liya Engine public API"
 readme = "README.md"
 license = "MIT"

{liyaengine-0.2.0 → liyaengine-0.4.0}/src/liyaengine/__init__.py

@@ -2,6 +2,8 @@ from .client import LiyaEngine
 from .errors import LiyaEngineAPIError, LiyaEngineNetworkError
 from .resources.agents import Agent
 from .resources.collections import Collection
+from .resources.workflows import Workflow
+from .resources.evaluations import EvalDataset, EvalCase, EvalSuite, EvalRun, EvalReview
 
 __all__ = [
     "LiyaEngine",
@@ -9,6 +11,12 @@ __all__ = [
     "LiyaEngineNetworkError",
     "Collection",
     "Agent",
+    "Workflow",
+    "EvalDataset",
+    "EvalCase",
+    "EvalSuite",
+    "EvalRun",
+    "EvalReview",
 ]
 
-__version__ = "0.2.0"
+__version__ = "0.4.0"

{liyaengine-0.2.0 → liyaengine-0.4.0}/src/liyaengine/client.py

@@ -7,6 +7,8 @@ import httpx
 from ._http import HttpClient
 from .resources.agents import AgentsResource
 from .resources.collections import CollectionsResource
+from .resources.workflows import WorkflowsResource
+from .resources.evaluations import EvaluationsResource
 
 _DEFAULT_BASE_URL = "https://api.liyaengine.ai"
 
@@ -41,6 +43,8 @@ class LiyaEngine:
         )
         self.collections = CollectionsResource(self._http)
         self.agents = AgentsResource(self._http)
+        self.workflows = WorkflowsResource(self._http)
+        self.evaluations = EvaluationsResource(self._http)
 
     def close(self) -> None:
         self._http.close()