@arizeai/phoenix-client 7.12.0 → 7.14.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/CHANGELOG.md +14 -0
- package/README.md +27 -0
- package/dist/esm/__generated__/api/v1.d.ts +3 -3
- package/dist/esm/constants/serverRequirements.d.ts +3 -0
- package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.js +21 -0
- package/dist/esm/constants/serverRequirements.js.map +1 -1
- package/dist/esm/datasets/createDatasetSplit.d.ts +39 -0
- package/dist/esm/datasets/createDatasetSplit.d.ts.map +1 -0
- package/dist/esm/datasets/createDatasetSplit.js +42 -0
- package/dist/esm/datasets/createDatasetSplit.js.map +1 -0
- package/dist/esm/datasets/deleteDatasetSplit.d.ts +24 -0
- package/dist/esm/datasets/deleteDatasetSplit.d.ts.map +1 -0
- package/dist/esm/datasets/deleteDatasetSplit.js +31 -0
- package/dist/esm/datasets/deleteDatasetSplit.js.map +1 -0
- package/dist/esm/datasets/index.d.ts +4 -0
- package/dist/esm/datasets/index.d.ts.map +1 -1
- package/dist/esm/datasets/index.js +3 -0
- package/dist/esm/datasets/index.js.map +1 -1
- package/dist/esm/datasets/resolveDatasetIdentifier.d.ts +4 -0
- package/dist/esm/datasets/resolveDatasetIdentifier.d.ts.map +1 -0
- package/dist/esm/datasets/resolveDatasetIdentifier.js +5 -0
- package/dist/esm/datasets/resolveDatasetIdentifier.js.map +1 -0
- package/dist/esm/datasets/updateDatasetSplit.d.ts +48 -0
- package/dist/esm/datasets/updateDatasetSplit.d.ts.map +1 -0
- package/dist/esm/datasets/updateDatasetSplit.js +55 -0
- package/dist/esm/datasets/updateDatasetSplit.js.map +1 -0
- package/dist/esm/secrets/index.d.ts +2 -0
- package/dist/esm/secrets/index.d.ts.map +1 -0
- package/dist/esm/secrets/index.js +2 -0
- package/dist/esm/secrets/index.js.map +1 -0
- package/dist/esm/secrets/upsertOrDeleteSecrets.d.ts +60 -0
- package/dist/esm/secrets/upsertOrDeleteSecrets.d.ts.map +1 -0
- package/dist/esm/secrets/upsertOrDeleteSecrets.js +47 -0
- package/dist/esm/secrets/upsertOrDeleteSecrets.js.map +1 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/datasets.d.ts +10 -5
- package/dist/esm/types/datasets.d.ts.map +1 -1
- package/dist/src/__generated__/api/v1.d.ts +3 -3
- package/dist/src/constants/serverRequirements.d.ts +3 -0
- package/dist/src/constants/serverRequirements.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.js +22 -1
- package/dist/src/constants/serverRequirements.js.map +1 -1
- package/dist/src/datasets/createDatasetSplit.d.ts +39 -0
- package/dist/src/datasets/createDatasetSplit.d.ts.map +1 -0
- package/dist/src/datasets/createDatasetSplit.js +42 -0
- package/dist/src/datasets/createDatasetSplit.js.map +1 -0
- package/dist/src/datasets/deleteDatasetSplit.d.ts +24 -0
- package/dist/src/datasets/deleteDatasetSplit.d.ts.map +1 -0
- package/dist/src/datasets/deleteDatasetSplit.js +34 -0
- package/dist/src/datasets/deleteDatasetSplit.js.map +1 -0
- package/dist/src/datasets/index.d.ts +4 -0
- package/dist/src/datasets/index.d.ts.map +1 -1
- package/dist/src/datasets/index.js +3 -0
- package/dist/src/datasets/index.js.map +1 -1
- package/dist/src/datasets/resolveDatasetIdentifier.d.ts +4 -0
- package/dist/src/datasets/resolveDatasetIdentifier.d.ts.map +1 -0
- package/dist/src/datasets/resolveDatasetIdentifier.js +8 -0
- package/dist/src/datasets/resolveDatasetIdentifier.js.map +1 -0
- package/dist/src/datasets/updateDatasetSplit.d.ts +48 -0
- package/dist/src/datasets/updateDatasetSplit.d.ts.map +1 -0
- package/dist/src/datasets/updateDatasetSplit.js +54 -0
- package/dist/src/datasets/updateDatasetSplit.js.map +1 -0
- package/dist/src/secrets/index.d.ts +2 -0
- package/dist/src/secrets/index.d.ts.map +1 -0
- package/dist/src/secrets/index.js +18 -0
- package/dist/src/secrets/index.js.map +1 -0
- package/dist/src/secrets/upsertOrDeleteSecrets.d.ts +60 -0
- package/dist/src/secrets/upsertOrDeleteSecrets.d.ts.map +1 -0
- package/dist/src/secrets/upsertOrDeleteSecrets.js +50 -0
- package/dist/src/secrets/upsertOrDeleteSecrets.js.map +1 -0
- package/dist/src/types/datasets.d.ts +10 -5
- package/dist/src/types/datasets.d.ts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/datasets.mdx +74 -1
- package/docs/overview.mdx +4 -1
- package/docs/secrets.mdx +68 -0
- package/package.json +6 -2
- package/src/__generated__/api/v1.ts +3 -3
- package/src/constants/serverRequirements.ts +24 -0
- package/src/datasets/createDatasetSplit.ts +80 -0
- package/src/datasets/deleteDatasetSplit.ts +46 -0
- package/src/datasets/index.ts +4 -0
- package/src/datasets/resolveDatasetIdentifier.ts +6 -0
- package/src/datasets/updateDatasetSplit.ts +99 -0
- package/src/secrets/index.ts +1 -0
- package/src/secrets/upsertOrDeleteSecrets.ts +87 -0
- package/src/types/datasets.ts +8 -3
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.upsertOrDeleteSecrets = upsertOrDeleteSecrets;
|
|
4
|
+
const client_1 = require("../client");
|
|
5
|
+
/**
|
|
6
|
+
* Atomically create, update, or delete a batch of Phoenix secrets.
|
|
7
|
+
*
|
|
8
|
+
* A non-null value creates or updates a secret, while `null` deletes it.
|
|
9
|
+
* Duplicate keys use the last occurrence in the batch. The result contains
|
|
10
|
+
* key names only; submitted values are never returned or logged.
|
|
11
|
+
*
|
|
12
|
+
* @param params - The secrets update.
|
|
13
|
+
* @param params.client - Optional Phoenix client instance.
|
|
14
|
+
* @param params.secrets - Ordered key/value-or-null updates.
|
|
15
|
+
* @returns The names of the keys that were upserted and deleted.
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* ```ts
|
|
19
|
+
* import { upsertOrDeleteSecrets } from "@arizeai/phoenix-client/secrets";
|
|
20
|
+
*
|
|
21
|
+
* const apiKey = process.env.OPENAI_API_KEY;
|
|
22
|
+
* if (!apiKey) throw new Error("OPENAI_API_KEY is required");
|
|
23
|
+
*
|
|
24
|
+
* const result = await upsertOrDeleteSecrets({
|
|
25
|
+
* secrets: [
|
|
26
|
+
* { key: "OPENAI_API_KEY", value: apiKey },
|
|
27
|
+
* { key: "OLD_PROVIDER_API_KEY", value: null },
|
|
28
|
+
* ],
|
|
29
|
+
* });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
async function upsertOrDeleteSecrets({ client: _client, secrets, }) {
|
|
33
|
+
const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
|
|
34
|
+
const { data, error } = await client.PUT("/v1/secrets", {
|
|
35
|
+
body: { secrets },
|
|
36
|
+
});
|
|
37
|
+
// Do not include the server error payload here: validation responses can be
|
|
38
|
+
// influenced by submitted data, which must never enter helper error text.
|
|
39
|
+
if (error) {
|
|
40
|
+
throw new Error("Failed to upsert or delete secrets");
|
|
41
|
+
}
|
|
42
|
+
if (!(data === null || data === void 0 ? void 0 : data.data)) {
|
|
43
|
+
throw new Error("Failed to upsert or delete secrets: no data returned");
|
|
44
|
+
}
|
|
45
|
+
return {
|
|
46
|
+
upsertedKeys: data.data.upserted_keys,
|
|
47
|
+
deletedKeys: data.data.deleted_keys,
|
|
48
|
+
};
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=upsertOrDeleteSecrets.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"upsertOrDeleteSecrets.js","sourceRoot":"","sources":["../../../src/secrets/upsertOrDeleteSecrets.ts"],"names":[],"mappings":";;;AAAA,sCAAyC;AAoCzC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,KAAK,gCAAgC,EAC1C,MAAM,EAAE,OAAO,EACf,OAAO,GACqB;IAC5B,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE;QACtD,IAAI,EAAE,EAAE,OAAO,EAAE;KAClB,CAAC,CAAC;IAEH,4EAA4E;IAC5E,0EAA0E;IAC1E,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,EAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC1E,CAAC;IAED,OAAO;QACL,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,aAAa;QACrC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY;KACpC,CAAC;AACJ,CAAC"}
|
|
@@ -1,16 +1,21 @@
|
|
|
1
|
+
import type { components } from "../__generated__/api/v1";
|
|
1
2
|
import type { Node } from "./core";
|
|
3
|
+
/** A named subset of examples in a dataset. */
|
|
4
|
+
export type DatasetSplit = components["schemas"]["DatasetSplit"];
|
|
2
5
|
type DatasetSelectorBase = {
|
|
3
6
|
versionId?: string;
|
|
4
7
|
splits?: string[];
|
|
5
8
|
};
|
|
9
|
+
/** A dataset identified by either its GlobalID or name. */
|
|
10
|
+
export type DatasetIdentifier = {
|
|
11
|
+
datasetId: string;
|
|
12
|
+
} | {
|
|
13
|
+
datasetName: string;
|
|
14
|
+
};
|
|
6
15
|
/**
|
|
7
16
|
* A dataset can be identified by its datasetId, datasetName, or datasetVersionId
|
|
8
17
|
*/
|
|
9
|
-
export type DatasetSelector =
|
|
10
|
-
datasetId: string;
|
|
11
|
-
}) | (DatasetSelectorBase & {
|
|
12
|
-
datasetName: string;
|
|
13
|
-
});
|
|
18
|
+
export type DatasetSelector = DatasetSelectorBase & DatasetIdentifier;
|
|
14
19
|
/**
|
|
15
20
|
* Overview information about a dataset
|
|
16
21
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,KAAK,mBAAmB,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAErE
|
|
1
|
+
{"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,+CAA+C;AAC/C,MAAM,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,CAAC;AAEjE,KAAK,mBAAmB,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAErE,2DAA2D;AAC3D,MAAM,MAAM,iBAAiB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC9C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAC1C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC;IAClC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO;IAC5C,iEAAiE;IACjE,EAAE,EAAE,MAAM,CAAC;IACX,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD,WAAW,EAAE,kBAAkB,CAAC;CACjC"}
|