opik 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -23,11 +23,13 @@ npm install opik
23
23
 
24
24
  You can configure the Opik client using environment variables.
25
25
 
26
+ `.env` file:
27
+
26
28
  ```bash
27
- export OPIK_API_KEY="your-api-key"
28
- export OPIK_HOST="https://www.comet.com/opik/api"
29
- export OPIK_PROJECT_NAME="your-project-name"
30
- export OPIK_WORKSPACE_NAME="your-workspace-name"
29
+ OPIK_API_KEY="your-api-key"
30
+ OPIK_URL_OVERRIDE="https://www.comet.com/opik/api"
31
+ OPIK_PROJECT_NAME="your-project-name"
32
+ OPIK_WORKSPACE_NAME="your-workspace-name"
31
33
  ```
32
34
 
33
35
  Or you can pass the configuration to the Opik client constructor.
@@ -37,7 +39,7 @@ import { Opik } from "opik";
37
39
 
38
40
  const client = new Opik({
39
41
  apiKey: "<your-api-key>",
40
- host: "https://www.comet.com/opik/api",
42
+ apiUrl: "https://www.comet.com/opik/api",
41
43
  projectName: "<your-project-name>",
42
44
  workspaceName: "<your-workspace-name>",
43
45
  });
@@ -2,7 +2,7 @@ import * as stream from 'stream';
2
2
 
3
3
  interface OpikConfig {
4
4
  apiKey: string;
5
- host?: string;
5
+ apiUrl?: string;
6
6
  projectName: string;
7
7
  workspaceName: string;
8
8
  }
@@ -2,7 +2,7 @@ import * as stream from 'stream';
2
2
 
3
3
  interface OpikConfig {
4
4
  apiKey: string;
5
- host?: string;
5
+ apiUrl?: string;
6
6
  projectName: string;
7
7
  workspaceName: string;
8
8
  }