Skip to content

Commit 2215e8b

Browse files
committed
docs(forward): clarify Decision API beta status
1 parent 7389b11 commit 2215e8b

5 files changed

Lines changed: 17 additions & 1 deletion

File tree

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ existing `0.1.0` release; earlier development prereleases are not listed.
55

66
## [Unreleased]
77

8+
### Changed
9+
10+
- Clarify that the Forward Decision API is in Beta and its behavior may change in future updates.
11+
812
## [0.10.0]
913

1014
### Added

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,9 @@ credential = client.vaults.credentials.retrieve("credential-id", vault_id="vault
609609
memory = client.memory_stores.memories.retrieve("memory-id", memory_store_id="store-id")
610610
```
611611

612-
## Forward Decisions
612+
## Forward Decisions (Beta)
613+
614+
The Decision API is in Beta. Its behavior may change in future updates.
613615

614616
Evaluate a nonempty `state` object or an accessible `session_id` (exactly one)
615617
with 1–32 choice or score questions. Choice values are strings or booleans;

‎docs/api/reference.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3389,6 +3389,8 @@ class Decisions(SyncAPIResource)
33893389

33903390
[[view_source]](https://github.com/QoderAI/qoder-cloud-agents-sdk-python/blob/main/src/qca/forward/resources/decisions.py)
33913391

3392+
The Decision API is in Beta. Its behavior may change in future updates.
3393+
33923394
<a id="qca.forward.resources.decisions.Decisions.create"></a>
33933395

33943396
#### create
@@ -3475,6 +3477,8 @@ class AsyncDecisions(AsyncAPIResource)
34753477

34763478
[[view_source]](https://github.com/QoderAI/qoder-cloud-agents-sdk-python/blob/main/src/qca/forward/resources/decisions.py)
34773479

3480+
The Decision API is in Beta. Its behavior may change in future updates.
3481+
34783482
<a id="qca.forward.resources.decisions.AsyncDecisions.create"></a>
34793483

34803484
#### create

‎examples/forward/decisions.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
"""Create a Decision using shared PAT/SA configuration.
22
3+
The Decision API is in Beta. Its behavior may change in future updates.
4+
35
Run: python -m examples.forward.decisions --env .env.live
46
Optionally set QODER_DECISION_SESSION_ID to evaluate an accessible Session.
57
"""

‎src/qca/forward/resources/decisions.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616

1717
class Decisions(SyncAPIResource):
18+
"""The Decision API is in Beta. Its behavior may change in future updates."""
19+
1820
def create(
1921
self,
2022
*,
@@ -105,6 +107,8 @@ def list(
105107

106108

107109
class AsyncDecisions(AsyncAPIResource):
110+
"""The Decision API is in Beta. Its behavior may change in future updates."""
111+
108112
async def create(
109113
self,
110114
*,

0 commit comments

Comments
 (0)