Skip to content

Commit 52f778f

Browse files
author
balogh.adam@icloud.com
committed
docs
1 parent 9e8b994 commit 52f778f

4 files changed

Lines changed: 39 additions & 12 deletions

File tree

docs/opengradient/client/llm.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,13 +101,17 @@ Perform inference on an LLM model using chat via TEE.
101101
**Returns**
102102

103103
Union[TextGenerationOutput, AsyncGenerator[StreamChunk, None]]:
104-
- If stream=False: TextGenerationOutput with chat_output, transaction_hash, finish_reason, and payment_hash
104+
- If stream=False: TextGenerationOutput with chat_output, data settlement metadata, finish_reason, and payment_hash
105105
- If stream=True: Async generator yielding StreamChunk objects
106106

107107
**`TextGenerationOutput` fields:**
108108

109-
* **`transaction_hash`**: Blockchain transaction hash. Set to
110-
``"external"`` for TEE-routed providers.
109+
* **`data_settlement_transaction_hash`**: Blockchain transaction hash for
110+
the data settlement transaction. ``None`` when the provider
111+
does not return data settlement metadata.
112+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data
113+
settlement. ``None`` for private/batch settlement or when the
114+
provider does not return it.
111115
* **`finish_reason`**: Reason the model stopped generating
112116
(e.g. ``"stop"``, ``"tool_call"``, ``"error"``).
113117
Only populated for chat requests.
@@ -174,8 +178,12 @@ TextGenerationOutput: Generated text results including:
174178

175179
**`TextGenerationOutput` fields:**
176180

177-
* **`transaction_hash`**: Blockchain transaction hash. Set to
178-
``"external"`` for TEE-routed providers.
181+
* **`data_settlement_transaction_hash`**: Blockchain transaction hash for
182+
the data settlement transaction. ``None`` when the provider
183+
does not return data settlement metadata.
184+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data
185+
settlement. ``None`` for private/batch settlement or when the
186+
provider does not return it.
179187
* **`finish_reason`**: Reason the model stopped generating
180188
(e.g. ``"stop"``, ``"tool_call"``, ``"error"``).
181189
Only populated for chat requests.

docs/opengradient/client/twins.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,12 @@ TextGenerationOutput: Generated text results including chat_output and finish_re
5555

5656
**`TextGenerationOutput` fields:**
5757

58-
* **`transaction_hash`**: Blockchain transaction hash. Set to
59-
``"external"`` for TEE-routed providers.
58+
* **`data_settlement_transaction_hash`**: Blockchain transaction hash for
59+
the data settlement transaction. ``None`` when the provider
60+
does not return data settlement metadata.
61+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data
62+
settlement. ``None`` for private/batch settlement or when the
63+
provider does not return it.
6064
* **`finish_reason`**: Reason the model stopped generating
6165
(e.g. ``"stop"``, ``"tool_call"``, ``"error"``).
6266
Only populated for chat requests.

docs/opengradient/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ opengradient
66

77
# Package opengradient
88

9-
**Version: 1.0.0**
9+
**Version: 1.0.1**
1010

1111
OpenGradient Python SDK for decentralized AI inference with end-to-end verification.
1212

docs/opengradient/types.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,10 @@ usage information.
347347
* **`tee_id`**: On-chain TEE registry ID of the enclave that served this request (final chunk only)
348348
* **`tee_endpoint`**: Endpoint URL of the TEE that served this request (final chunk only)
349349
* **`tee_payment_address`**: Payment address registered for the TEE (final chunk only)
350+
* **`data_settlement_transaction_hash`**: Transaction hash for the data settlement
351+
transaction, present on the final chunk when available.
352+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data settlement,
353+
present on the final chunk when available.
350354

351355
#### Constructor
352356

@@ -360,7 +364,9 @@ def __init__(
360364
tee_timestamp: Optional[str= None,
361365
tee_id: Optional[str= None,
362366
tee_endpoint: Optional[str= None,
363-
tee_payment_address: Optional[str= None
367+
tee_payment_address: Optional[str= None,
368+
data_settlement_transaction_hash: Optional[str= None,
369+
data_settlement_blob_id: Optional[str= None
364370
)
365371
```
366372

@@ -393,6 +399,10 @@ StreamChunk instance
393399
* **`tee_id`**: On-chain TEE registry ID of the enclave that served this request (final chunk only)
394400
* **`tee_endpoint`**: Endpoint URL of the TEE that served this request (final chunk only)
395401
* **`tee_payment_address`**: Payment address registered for the TEE (final chunk only)
402+
* **`data_settlement_transaction_hash`**: Transaction hash for the data settlement
403+
transaction, present on the final chunk when available.
404+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data settlement,
405+
present on the final chunk when available.
396406

397407
### `StreamDelta`
398408

@@ -491,8 +501,12 @@ performed inside a TEE enclave.
491501

492502
**Attributes**
493503

494-
* **`transaction_hash`**: Blockchain transaction hash. Set to
495-
``"external"`` for TEE-routed providers.
504+
* **`data_settlement_transaction_hash`**: Blockchain transaction hash for
505+
the data settlement transaction. ``None`` when the provider
506+
does not return data settlement metadata.
507+
* **`data_settlement_blob_id`**: Walrus blob ID for individual data
508+
settlement. ``None`` for private/batch settlement or when the
509+
provider does not return it.
496510
* **`finish_reason`**: Reason the model stopped generating
497511
(e.g. ``"stop"``, ``"tool_call"``, ``"error"``).
498512
Only populated for chat requests.
@@ -510,7 +524,8 @@ performed inside a TEE enclave.
510524

511525
```python
512526
def __init__(
513-
transaction_hashstr,
527+
data_settlement_transaction_hash: Optional[str= None,
528+
data_settlement_blob_id: Optional[str= None,
514529
finish_reason: Optional[str= None,
515530
chat_output: Optional[Dict] = None,
516531
completion_output: Optional[str= None,

0 commit comments

Comments
 (0)