Merge branch 'main' of github.com:invariantlabs-ai/docs

Author: lbeurerkellner

docs/explorer/Explorer_API/1_client_setup.md

@@ -21,19 +21,40 @@ export INVARIANT_API_KEY=YourAPIKey
 
 ## Creating a Client
 
-In your Python code, you can create a `Client` object. This object will use the environment variables you set up earlier to authenticate your uploads.
+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.
+
+```python
+from invariant_sdk.async_client import AsyncClient
+
+client = AsyncClient()
+```
+
+Without parameters, the `AsyncClient` object will automatically use the environment variables you set up earlier and the default Explorer instance at `https://explorer.invariantlabs.ai`.
+
+To create a sync client:
 
 ```python
 from invariant_sdk.client import Client
 
 client = Client()
 ```
 
-Without parameters, the `Client` object will automatically use the environment variables you set up earlier and the default Explorer instance at `https://explorer.invariantlabs.ai`.
 
 ## Overriding Environment Configuration
 
-If you want to override the environment configuration or use a different API key, you can also pass the API endpoint URL and API key as arguments to the `Client` constructor directly.
+If you want to override the environment configuration or use a different API key, you can also pass the API endpoint URL and API key as arguments to the `AsyncClient` constructor directly.
+
+```python
+from invariant_sdk.async_client import AsyncClient
+
+client = AsyncClient(
+    api_url="https://explorer.invariantlabs.ai",
+    # Add the API key here.
+    api_key="YourAPIKey",
+)
+```
+
+For the sync `Client` type:
 
 ```python
 from invariant_sdk.client import Client
@@ -43,4 +64,4 @@ client = Client(
     # Add the API key here.
     api_key="YourAPIKey",
 )
-```
+```

docs/explorer/Explorer_API/Dataset_Metadata/get_dataset_metadata_api.md

@@ -32,8 +32,17 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
 
 The response object from the Invariant API.
 
+> AsyncClient Example
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+    from invariant_sdk.types.push_traces import PushTracesRequest
+
+    client = AsyncClient()
+
+    dataset_metadata = await client.get_dataset_metadata(dataset_name="some_dataset_name")
+    ```
 
-> Example
+> Client Example
     ```python
     from invariant_sdk.client import Client
     from invariant_sdk.types.push_traces import PushTracesRequest

docs/explorer/Explorer_API/Dataset_Metadata/update_dataset_metadata_api.md

@@ -80,22 +80,75 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
 
 The response object from the Invariant API.
 
+> AsyncClient Example
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+    from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
+
+    client = AsyncClient()
+
+    # Metadata state: {}
+
+    request_1 = UpdateDatasetMetadataRequest(
+        dataset_name="some_name",
+        metadata=MetadataUpdate(benchmark="some_benchmark")
+    )
+    response_1 = await client.update_dataset_metadata(request_1)
+
+    # Metadata state: {"benchmark": "some_benchmark"}
+
+    request_2 = UpdateDatasetMetadataRequest(
+        dataset_name="some_name",
+        metadata=MetadataUpdate(accuracy=5, name="xyz")
+    )
+
+    response_2 = await client.update_dataset_metadata(request_2)
+
+    # Metadata state: {"benchmark": "some_benchmark", "accuracy": 5, "name": "xyz"}
 
-> Example
+    request_3 = UpdateDatasetMetadataRequest(
+        dataset_name="some_name",
+        replace_all=True
+        metadata=MetadataUpdate(benchmark="new_benchmark")
+    )
+
+    response_3 = await client.update_dataset_metadata(request_3)
+
+    # Metadata state: {"benchmark": "new_benchmark"}
+
+    ```
+
+> AsyncClient Example to clear all previously set metadata
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+    from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
+
+    client = AsyncClient()
+
+    request = UpdateDatasetMetadataRequest(
+        dataset_name="some_name",
+        replace_all=True,
+        metadata=MetadataUpdate()
+    )
+
+    response = await client.update_dataset_metadata(request)
+    ```
+
+> Client Example
     ```python
     from invariant_sdk.client import Client
     from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
 
     client = Client()
 
     # Metadata state: {}
-    
+
     request_1 = UpdateDatasetMetadataRequest(
         dataset_name="some_name",
         metadata=MetadataUpdate(benchmark="some_benchmark")
     )
     response_1 = client.update_dataset_metadata(request_1)
-    
+
     # Metadata state: {"benchmark": "some_benchmark"}
 
     request_2 = UpdateDatasetMetadataRequest(
@@ -119,7 +172,7 @@ The response object from the Invariant API.
 
     ```
 
-> Example to clear all previously set metadata
+> Client Example to clear all previously set metadata
     ```python
     from invariant_sdk.client import Client
     from invariant_sdk.types.update_dataset_metadata import UpdateDatasetMetadataRequest, MetadataUpdate
@@ -160,8 +213,50 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
 ##### <span class='type'>Dict</span>
 
 The response object from the Invariant API.
+> AsyncClient Example
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+
+    client = AsyncClient()
+
+    # Metadata state: {}
+    
+    response_1 = await client.create_request_and_update_dataset_metadata(
+        dataset_name="some_name",
+        metadata={"benchmark": "some_benchmark"}
+    )
+    
+    # Metadata state: {"benchmark": "some_benchmark"}
+
+    response_2 = await client.create_request_and_update_dataset_metadata(
+        dataset_name="some_name",
+        metadata={"accuracy": 5, "name": "xyz"}
+    )
+
+    # Metadata state: {"benchmark": "some_benchmark", "accuracy": 5, "name": "xyz"}
+
+    response_3 = await client.create_request_and_update_dataset_metadata(
+        dataset_name="some_name",
+        replace_all=True,
+        metadata={"benchmark": "new_benchmark"}
+    )
+
+    # Metadata state: {"benchmark": "new_benchmark"}
+    ```
+
+> AsyncClient Example to clear all previously set metadata
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+
+    client = AsyncClient()
+
+    response = await client.create_request_and_update_dataset_metadata(
+        dataset_name="some_name"
+        replace_all=True,
+    )
+    ```
 
-> Example
+> Client Example
     ```python
     from invariant_sdk.client import Client
 
@@ -192,7 +287,7 @@ The response object from the Invariant API.
     # Metadata state: {"benchmark": "new_benchmark"}
     ```
 
-> Example to clear all previously set metadata
+> Client Example to clear all previously set metadata
     ```python
     from invariant_sdk.client import Client
 

docs/explorer/Explorer_API/Uploading_Traces/push_api.md

@@ -104,8 +104,37 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
 
 The response object from the Invariant API.
 
+> AsyncClient Example
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+    from invariant_sdk.types.push_traces import PushTracesRequest
 
-> Example
+    client = AsyncClient()
+
+    request = PushTracesRequest(
+        messages=[
+            [
+                {"role": "user", "content": "one"},
+                {"role": "assistant", "content": "two \n three"},
+            ]
+        ],
+        annotations=[
+            [
+                {
+                    "content": "annotating one",
+                    "address": "messages[0].content:L0",
+                    "extra_metadata": {"key1": "value1"},
+                }
+            ]
+        ],
+        metadata=[{"meta_key_1": "meta_value_1"}],
+        dataset="dataset_name"
+    )
+
+    response = await client.push_trace(request)
+    ```
+
+> Client Example
     ```python
     from invariant_sdk.client import Client
     from invariant_sdk.types.push_traces import PushTracesRequest
@@ -165,7 +194,40 @@ Additional keyword arguments to pass to the requests method. Default is `None`.
 
 The response object from the Invariant API.
 
-> Example
+> AsyncClient Example
+    ```python
+    from invariant_sdk.async_client import AsyncClient
+
+    client = AsyncClient()
+
+    messages = [
+        [
+            {"role": "user", "content": "one"},
+            {"role": "assistant", "content": "two \n three"},
+        ]
+    ]
+
+    annotations = [
+        [
+            {
+                "content": "annotating one",
+                "address": "messages[0].content:L0",
+                "extra_metadata": {"key1": "value1"},
+            }
+        ]
+    ]
+
+    metadata = [{"meta_key_1": "meta_value_1"}]
+
+    response = await client.create_request_and_push_trace(
+        messages=messages,
+        annotations=annotations,
+        metadata=metadata,
+        dataset="dataset_name"
+    )
+    ```
+
+> Client Example
     ```python
     from invariant_sdk.client import Client
 

docs/assets/images/search.png docs/explorer/assets/search.pngdocs/assets/images/search.png renamed to docs/explorer/assets/search.png

@@ -6,7 +6,7 @@ Often, there is a large number of traces in the dataset. In this chapter, we des
 
 For instance, searching for `maps` would return all traces containing the word `maps` somewhere in the trace.
 
-<img src="/assets/images/search.png" class="img-fluid" alt="Search bar in the Invariant Explorer">
+<img src="../assets/search.png" class="img-fluid" alt="Search bar in the Invariant Explorer">
 
 ## Exact search