Skip to content

Commit 9f8568a

Browse files
committed
Remove some Client examples. Redundant since we have AsyncClient examples.
1 parent 001fcd2 commit 9f8568a

File tree

4 files changed

+3
-173
lines changed

4 files changed

+3
-173
lines changed

docs/explorer/api/client-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export INVARIANT_API_KEY=YourAPIKey
2121

2222
## Creating a Client
2323

24-
In your Python code, you can create an `AsyncClient` or a `Client` object. This object will use the environment variables you set up earlier to authenticate your uploads.
24+
In your Python code, you can create an `AsyncClient` (which exposes asynchronous methods) or a `Client` (which exposes synchronous methods) object. This object will use the environment variables you set up earlier to authenticate your uploads.
2525

2626
```python
2727
from invariant_sdk.async_client import AsyncClient

docs/explorer/api/dataset-metadata/get.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,4 @@ The response object from the Invariant API.
4040
client = AsyncClient()
4141

4242
dataset_metadata = await client.get_dataset_metadata(dataset_name="some_dataset_name")
43-
```
44-
45-
> Client Example
46-
```python
47-
from invariant_sdk.client import Client
48-
from invariant_sdk.types.push_traces import PushTracesRequest
49-
50-
client = Client()
51-
52-
dataset_metadata = client.get_dataset_metadata(dataset_name="some_dataset_name")
53-
```
43+
```

docs/explorer/api/dataset-metadata/update.md

Lines changed: 1 addition & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -134,60 +134,6 @@ The response object from the Invariant API.
134134
response = await client.update_dataset_metadata(request)
135135
```
136136

137-
> Client Example
138-
```python
139-
from invariant_sdk.client import Client
140-
from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
141-
142-
client = Client()
143-
144-
# Metadata state: {}
145-
146-
request_1 = UpdateDatasetMetadataRequest(
147-
dataset_name="some_name",
148-
metadata=MetadataUpdate(benchmark="some_benchmark")
149-
)
150-
response_1 = client.update_dataset_metadata(request_1)
151-
152-
# Metadata state: {"benchmark": "some_benchmark"}
153-
154-
request_2 = UpdateDatasetMetadataRequest(
155-
dataset_name="some_name",
156-
metadata=MetadataUpdate(accuracy=5, name="xyz")
157-
)
158-
159-
response_2 = client.update_dataset_metadata(request_2)
160-
161-
# Metadata state: {"benchmark": "some_benchmark", "accuracy": 5, "name": "xyz"}
162-
163-
request_3 = UpdateDatasetMetadataRequest(
164-
dataset_name="some_name",
165-
replace_all=True
166-
metadata=MetadataUpdate(benchmark="new_benchmark")
167-
)
168-
169-
response_3 = client.update_dataset_metadata(request_3)
170-
171-
# Metadata state: {"benchmark": "new_benchmark"}
172-
173-
```
174-
175-
> Client Example to clear all previously set metadata
176-
```python
177-
from invariant_sdk.client import Client
178-
from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
179-
180-
client = Client()
181-
182-
request = UpdateDatasetMetadataRequest(
183-
dataset_name="some_name",
184-
replace_all=True,
185-
metadata=MetadataUpdate()
186-
)
187-
188-
response = client.update_dataset_metadata(request)
189-
```
190-
191137
### `create_request_and_update_dataset_metadata`
192138

193139
The `create_request_and_update_dataset_metadata` method is used to update the metadata for a dataset.
@@ -254,47 +200,4 @@ The response object from the Invariant API.
254200
dataset_name="some_name"
255201
replace_all=True,
256202
)
257-
```
258-
259-
> Client Example
260-
```python
261-
from invariant_sdk.client import Client
262-
263-
client = Client()
264-
265-
# Metadata state: {}
266-
267-
response_1 = client.create_request_and_update_dataset_metadata(
268-
dataset_name="some_name",
269-
metadata={"benchmark": "some_benchmark"}
270-
)
271-
272-
# Metadata state: {"benchmark": "some_benchmark"}
273-
274-
response_2 = client.create_request_and_update_dataset_metadata(
275-
dataset_name="some_name",
276-
metadata={"accuracy": 5, "name": "xyz"}
277-
)
278-
279-
# Metadata state: {"benchmark": "some_benchmark", "accuracy": 5, "name": "xyz"}
280-
281-
response_3 = client.create_request_and_update_dataset_metadata(
282-
dataset_name="some_name",
283-
replace_all=True,
284-
metadata={"benchmark": "new_benchmark"}
285-
)
286-
287-
# Metadata state: {"benchmark": "new_benchmark"}
288-
```
289-
290-
> Client Example to clear all previously set metadata
291-
```python
292-
from invariant_sdk.client import Client
293-
294-
client = Client()
295-
296-
response = client.create_request_and_update_dataset_metadata(
297-
dataset_name="some_name"
298-
replace_all=True,
299-
)
300-
```
203+
```

docs/explorer/api/uploading-traces/push-api.md

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -104,36 +104,6 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
104104

105105
The response object from the Invariant API.
106106

107-
> AsyncClient Example
108-
```python
109-
from invariant_sdk.async_client import AsyncClient
110-
from invariant_sdk.types.push_traces import PushTracesRequest
111-
112-
client = AsyncClient()
113-
114-
request = PushTracesRequest(
115-
messages=[
116-
[
117-
{"role": "user", "content": "one"},
118-
{"role": "assistant", "content": "two \n three"},
119-
]
120-
],
121-
annotations=[
122-
[
123-
{
124-
"content": "annotating one",
125-
"address": "messages[0].content:L0",
126-
"extra_metadata": {"key1": "value1"},
127-
}
128-
]
129-
],
130-
metadata=[{"meta_key_1": "meta_value_1"}],
131-
dataset="dataset_name"
132-
)
133-
134-
response = await client.push_trace(request)
135-
```
136-
137107
> Client Example
138108
```python
139109
from invariant_sdk.client import Client
@@ -194,39 +164,6 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
194164

195165
The response object from the Invariant API.
196166

197-
> AsyncClient Example
198-
```python
199-
from invariant_sdk.async_client import AsyncClient
200-
201-
client = AsyncClient()
202-
203-
messages = [
204-
[
205-
{"role": "user", "content": "one"},
206-
{"role": "assistant", "content": "two \n three"},
207-
]
208-
]
209-
210-
annotations = [
211-
[
212-
{
213-
"content": "annotating one",
214-
"address": "messages[0].content:L0",
215-
"extra_metadata": {"key1": "value1"},
216-
}
217-
]
218-
]
219-
220-
metadata = [{"meta_key_1": "meta_value_1"}]
221-
222-
response = await client.create_request_and_push_trace(
223-
messages=messages,
224-
annotations=annotations,
225-
metadata=metadata,
226-
dataset="dataset_name"
227-
)
228-
```
229-
230167
> Client Example
231168
```python
232169
from invariant_sdk.client import Client

0 commit comments

Comments
 (0)