Skip to content

Commit 8dcdef3

Browse files
balogh.adam@icloud.combalogh.adam@icloud.com
authored andcommitted
api docs
1 parent ee27a94 commit 8dcdef3

6 files changed

Lines changed: 24 additions & 6 deletions

File tree

docs/opengradient/client/client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ blockchain private key and optional Model Hub credentials.
2121
#### Constructor
2222

2323
```python
24-
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
24+
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, wallet_addressstr = None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
2525
```
2626

2727
**Arguments**

docs/opengradient/client/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ blockchain private key and optional Model Hub credentials.
6868
#### Constructor
6969

7070
```python
71-
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
71+
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, wallet_addressstr = None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
7272
```
7373

7474
**Arguments**

docs/opengradient/client/llm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def __init__(wallet_account: `LocalAccount`, og_llm_server_url: str, og_llm_st
3131
#### `chat()`
3232

3333
```python
34-
def chat(self, model`TEE_LLM`, messages: List[Dict], max_tokensint = 100, stop_sequence: Optional[List[str]] = None, temperaturefloat = 0.0, tools: Optional[List[Dict]] = [], tool_choice: Optional[str= None, x402_settlement_mode: Optional[`x402SettlementMode`= x402SettlementMode.SETTLE_BATCH, streambool = False) ‑> Union[`TextGenerationOutput`, `TextGenerationStream`]
34+
def chat(self, model`TEE_LLM`, messages: List[Dict], max_tokensint = 100, stop_sequence: Optional[List[str]] = None, temperaturefloat = 0.0, tools: Optional[List[Dict]] = [], tool_choice: Optional[str= None, x402_settlement_mode: Optional[`x402SettlementMode`= x402SettlementMode.SETTLE_BATCH, streambool = False, network: Optional[`x402Network`= x402Network.OG_EVM) ‑> Union[`TextGenerationOutput`, `TextGenerationStream`]
3535
```
3636
Perform inference on an LLM model using chat via TEE.
3737

docs/opengradient/client/twins.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Digital twins chat via OpenGradient verifiable inference.
1414

1515
Digital twins chat namespace.
1616

17-
Provides access to digital twin conversations from twin.fun,
18-
backed by OpenGradient verifiable inference.
17+
Provides access to digital twin conversations backed by OpenGradient
18+
verifiable inference. Browse available twins at https://twin.fun.
1919

2020
#### Constructor
2121

docs/opengradient/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ blockchain private key and optional Model Hub credentials.
127127
#### Constructor
128128

129129
```python
130-
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
130+
def __init__(private_keystr, email: Optional[str= None, password: Optional[str= None, twins_api_key: Optional[str= None, wallet_addressstr = None, rpc_urlstr = 'https://ogevmdevnet.opengradient.ai', api_urlstr = 'https://sdk-devnet.opengradient.ai', contract_addressstr = '0x8383C9bD7462F12Eb996DD02F78234C0421A6FaE', og_llm_server_url: Optional[str= 'https://llmogevm.opengradient.ai', og_llm_streaming_server_url: Optional[str= 'https://llmogevm.opengradient.ai')
131131
```
132132

133133
**Arguments**

docs/opengradient/types.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,24 @@ automatic parsing of SSE format.
435435
def __init__(_iterator: Union[Iterator[str], AsyncIterator[str]])
436436
```
437437

438+
### `x402Network`
439+
440+
str(object='') -> str
441+
str(bytes_or_buffer[, encoding[, errors]]) -> str
442+
443+
Create a new string object from the given object. If encoding or
444+
errors is specified, then the object must expose a data buffer
445+
that will be decoded using the given encoding and error handler.
446+
Otherwise, returns the result of object.__str__() (if defined)
447+
or repr(object).
448+
encoding defaults to 'utf-8'.
449+
errors defaults to 'strict'.
450+
451+
#### Variables
452+
453+
* static `BASE_TESTNET`
454+
* static `OG_EVM`
455+
438456
### `x402SettlementMode`
439457

440458
Settlement modes for x402 payment protocol transactions.

0 commit comments

Comments
 (0)