@arizeai/phoenix-client 7.5.0 → 7.7.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 +781 -0
- package/README.md +27 -3
- package/dist/esm/__generated__/api/v1.d.ts +749 -203
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.d.ts +2 -0
- package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.js +14 -0
- package/dist/esm/constants/serverRequirements.js.map +1 -1
- package/dist/esm/projects/index.d.ts +1 -0
- package/dist/esm/projects/index.d.ts.map +1 -1
- package/dist/esm/projects/index.js +1 -0
- package/dist/esm/projects/index.js.map +1 -1
- package/dist/esm/projects/setProjectRetentionPolicy.d.ts +49 -0
- package/dist/esm/projects/setProjectRetentionPolicy.d.ts.map +1 -0
- package/dist/esm/projects/setProjectRetentionPolicy.js +52 -0
- package/dist/esm/projects/setProjectRetentionPolicy.js.map +1 -0
- package/dist/esm/prompts/deletePrompt.d.ts +39 -0
- package/dist/esm/prompts/deletePrompt.d.ts.map +1 -0
- package/dist/esm/prompts/deletePrompt.js +52 -0
- package/dist/esm/prompts/deletePrompt.js.map +1 -0
- package/dist/esm/prompts/index.d.ts +1 -0
- package/dist/esm/prompts/index.d.ts.map +1 -1
- package/dist/esm/prompts/index.js +1 -0
- package/dist/esm/prompts/index.js.map +1 -1
- package/dist/esm/testing/reporter-format.d.ts.map +1 -1
- package/dist/esm/testing/reporter-format.js +13 -3
- package/dist/esm/testing/reporter-format.js.map +1 -1
- package/dist/esm/traces/getTraces.d.ts +1 -1
- package/dist/esm/traces/getTraces.d.ts.map +1 -1
- package/dist/esm/traces/index.d.ts +1 -0
- package/dist/esm/traces/index.d.ts.map +1 -1
- package/dist/esm/traces/index.js +1 -0
- package/dist/esm/traces/index.js.map +1 -1
- package/dist/esm/traces/transferTraces.d.ts +56 -0
- package/dist/esm/traces/transferTraces.d.ts.map +1 -0
- package/dist/esm/traces/transferTraces.js +56 -0
- package/dist/esm/traces/transferTraces.js.map +1 -0
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/prompts.d.ts +9 -0
- package/dist/esm/types/prompts.d.ts.map +1 -1
- package/dist/esm/types/prompts.js.map +1 -1
- package/dist/esm/users/getCurrentUser.d.ts +25 -0
- package/dist/esm/users/getCurrentUser.d.ts.map +1 -0
- package/dist/esm/users/getCurrentUser.js +30 -0
- package/dist/esm/users/getCurrentUser.js.map +1 -0
- package/dist/esm/users/index.d.ts +2 -0
- package/dist/esm/users/index.d.ts.map +1 -0
- package/dist/esm/users/index.js +2 -0
- package/dist/esm/users/index.js.map +1 -0
- package/dist/esm/utils/resolvePromptIdentifier.d.ts +17 -0
- package/dist/esm/utils/resolvePromptIdentifier.d.ts.map +1 -0
- package/dist/esm/utils/resolvePromptIdentifier.js +36 -0
- package/dist/esm/utils/resolvePromptIdentifier.js.map +1 -0
- package/dist/src/__generated__/api/v1.d.ts +749 -203
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.d.ts +2 -0
- package/dist/src/constants/serverRequirements.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.js +15 -1
- package/dist/src/constants/serverRequirements.js.map +1 -1
- package/dist/src/projects/index.d.ts +1 -0
- package/dist/src/projects/index.d.ts.map +1 -1
- package/dist/src/projects/index.js +1 -0
- package/dist/src/projects/index.js.map +1 -1
- package/dist/src/projects/setProjectRetentionPolicy.d.ts +49 -0
- package/dist/src/projects/setProjectRetentionPolicy.d.ts.map +1 -0
- package/dist/src/projects/setProjectRetentionPolicy.js +59 -0
- package/dist/src/projects/setProjectRetentionPolicy.js.map +1 -0
- package/dist/src/prompts/deletePrompt.d.ts +39 -0
- package/dist/src/prompts/deletePrompt.d.ts.map +1 -0
- package/dist/src/prompts/deletePrompt.js +55 -0
- package/dist/src/prompts/deletePrompt.js.map +1 -0
- package/dist/src/prompts/index.d.ts +1 -0
- package/dist/src/prompts/index.d.ts.map +1 -1
- package/dist/src/prompts/index.js +1 -0
- package/dist/src/prompts/index.js.map +1 -1
- package/dist/src/testing/reporter-format.d.ts.map +1 -1
- package/dist/src/testing/reporter-format.js +13 -3
- package/dist/src/testing/reporter-format.js.map +1 -1
- package/dist/src/traces/getTraces.d.ts +1 -1
- package/dist/src/traces/getTraces.d.ts.map +1 -1
- package/dist/src/traces/index.d.ts +1 -0
- package/dist/src/traces/index.d.ts.map +1 -1
- package/dist/src/traces/index.js +1 -0
- package/dist/src/traces/index.js.map +1 -1
- package/dist/src/traces/transferTraces.d.ts +56 -0
- package/dist/src/traces/transferTraces.d.ts.map +1 -0
- package/dist/src/traces/transferTraces.js +59 -0
- package/dist/src/traces/transferTraces.js.map +1 -0
- package/dist/src/types/prompts.d.ts +9 -0
- package/dist/src/types/prompts.d.ts.map +1 -1
- package/dist/src/types/prompts.js.map +1 -1
- package/dist/src/users/getCurrentUser.d.ts +25 -0
- package/dist/src/users/getCurrentUser.d.ts.map +1 -0
- package/dist/src/users/getCurrentUser.js +36 -0
- package/dist/src/users/getCurrentUser.js.map +1 -0
- package/dist/src/users/index.d.ts +2 -0
- package/dist/src/users/index.d.ts.map +1 -0
- package/dist/src/users/index.js +18 -0
- package/dist/src/users/index.js.map +1 -0
- package/dist/src/utils/resolvePromptIdentifier.d.ts +17 -0
- package/dist/src/utils/resolvePromptIdentifier.d.ts.map +1 -0
- package/dist/src/utils/resolvePromptIdentifier.js +39 -0
- package/dist/src/utils/resolvePromptIdentifier.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/overview.mdx +8 -4
- package/docs/projects.mdx +71 -0
- package/docs/prompts.mdx +19 -1
- package/docs/traces.mdx +28 -2
- package/docs/users.mdx +44 -0
- package/package.json +16 -12
- package/src/__generated__/api/v1.ts +749 -203
- package/src/constants/serverRequirements.ts +16 -0
- package/src/projects/index.ts +1 -0
- package/src/projects/setProjectRetentionPolicy.ts +80 -0
- package/src/prompts/deletePrompt.ts +70 -0
- package/src/prompts/index.ts +1 -0
- package/src/testing/reporter-format.ts +13 -3
- package/src/traces/getTraces.ts +1 -1
- package/src/traces/index.ts +1 -0
- package/src/traces/transferTraces.ts +89 -0
- package/src/types/prompts.ts +10 -0
- package/src/users/getCurrentUser.ts +39 -0
- package/src/users/index.ts +1 -0
- package/src/utils/resolvePromptIdentifier.ts +41 -0
|
@@ -44,6 +44,15 @@ export interface GetPromptByTagSelector {
|
|
|
44
44
|
* Can be a prompt id, a prompt name, a prompt version id, or a prompt name + tag.
|
|
45
45
|
*/
|
|
46
46
|
export type PromptSelector = GetPromptByIdSelector | GetPromptByNameSelector | GetPromptByVersionSelector | GetPromptByTagSelector;
|
|
47
|
+
/**
|
|
48
|
+
* A selector for a prompt as a whole, rather than for one of its versions.
|
|
49
|
+
*
|
|
50
|
+
* Narrower than {@link PromptSelector}: a version id or a name + tag picks out a
|
|
51
|
+
* single version, which is not what operations on the prompt itself act on. Use
|
|
52
|
+
* this wherever the API needs the `{prompt_identifier}` path segment — the name
|
|
53
|
+
* and the prompt id are the two things the Phoenix REST API accepts there.
|
|
54
|
+
*/
|
|
55
|
+
export type PromptIdentifier = GetPromptByIdSelector | GetPromptByNameSelector;
|
|
47
56
|
/**
|
|
48
57
|
* The prompt data needed to create a prompt.
|
|
49
58
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,cAAc,GACd,WAAW,GACX,QAAQ,GACR,UAAU,GACV,KAAK,GACL,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,MAAM,GACN,UAAU,GACV,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,cAAc,GACd,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,GAC1B,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,UAAU,CAAC,SAAS,CAAC,CAAC,8CAA8C,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,4CAA4C,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,2CAA2C,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,aAAa,CAAC,UAAU,CAAC,EACzB;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CACxB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,GAC5C,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AAEnD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,IAAI,aAAa,CAEvE;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,UAAU,GACf,IAAI,IAAI,kBAAkB,CAE5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CACpD,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,cAAc,GACd,WAAW,GACX,QAAQ,GACR,UAAU,GACV,KAAK,GACL,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,MAAM,GACN,UAAU,GACV,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,cAAc,GACd,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,GAC1B,sBAAsB,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,UAAU,CAAC,SAAS,CAAC,CAAC,8CAA8C,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,4CAA4C,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,2CAA2C,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,aAAa,CAAC,UAAU,CAAC,EACzB;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CACxB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,GAC5C,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AAEnD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,IAAI,aAAa,CAEvE;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,UAAU,GACf,IAAI,IAAI,kBAAkB,CAE5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CACpD,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAqLA,MAAM,UAAU,eAAe,CAAC,IAAgB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,IAAgB;IAEhB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAClC,CAAC"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { components } from "../__generated__/api/v1.js";
|
|
2
|
+
import type { ClientFn } from "../types/core.js";
|
|
3
|
+
/** The user profile returned for the current Phoenix client credentials. */
|
|
4
|
+
export type CurrentUser = components["schemas"]["GetViewerResponseBody"]["data"];
|
|
5
|
+
/**
|
|
6
|
+
* Get the currently authenticated user.
|
|
7
|
+
*
|
|
8
|
+
* When authentication is disabled, Phoenix returns an anonymous user with
|
|
9
|
+
* `auth_method: "ANONYMOUS"`.
|
|
10
|
+
*
|
|
11
|
+
* @param params - The parameters for fetching the current user.
|
|
12
|
+
* @param params.client - An optional Phoenix client instance.
|
|
13
|
+
* @returns The current user's generated API profile shape.
|
|
14
|
+
* @throws {HttpError} If the request is not authenticated or is forbidden.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* import { getCurrentUser } from "@arizeai/phoenix-client/users";
|
|
19
|
+
*
|
|
20
|
+
* const user = await getCurrentUser();
|
|
21
|
+
* console.log(user.auth_method);
|
|
22
|
+
* ```
|
|
23
|
+
*/
|
|
24
|
+
export declare function getCurrentUser({ client: _client, }?: ClientFn): Promise<CurrentUser>;
|
|
25
|
+
//# sourceMappingURL=getCurrentUser.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getCurrentUser.d.ts","sourceRoot":"","sources":["../../../src/users/getCurrentUser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,4EAA4E;AAC5E,MAAM,MAAM,WAAW,GACrB,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,GAChB,GAAE,QAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAOtC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import invariant from "tiny-invariant";
|
|
2
|
+
import { createClient } from "../client.js";
|
|
3
|
+
/**
|
|
4
|
+
* Get the currently authenticated user.
|
|
5
|
+
*
|
|
6
|
+
* When authentication is disabled, Phoenix returns an anonymous user with
|
|
7
|
+
* `auth_method: "ANONYMOUS"`.
|
|
8
|
+
*
|
|
9
|
+
* @param params - The parameters for fetching the current user.
|
|
10
|
+
* @param params.client - An optional Phoenix client instance.
|
|
11
|
+
* @returns The current user's generated API profile shape.
|
|
12
|
+
* @throws {HttpError} If the request is not authenticated or is forbidden.
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* import { getCurrentUser } from "@arizeai/phoenix-client/users";
|
|
17
|
+
*
|
|
18
|
+
* const user = await getCurrentUser();
|
|
19
|
+
* console.log(user.auth_method);
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
export async function getCurrentUser({ client: _client, } = {}) {
|
|
23
|
+
const client = _client ?? createClient();
|
|
24
|
+
const { data, error } = await client.GET("/v1/user");
|
|
25
|
+
if (error)
|
|
26
|
+
throw error;
|
|
27
|
+
invariant(data?.data, "Failed to get current user");
|
|
28
|
+
return data.data;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=getCurrentUser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getCurrentUser.js","sourceRoot":"","sources":["../../../src/users/getCurrentUser.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAGvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAOzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,GAChB,GAAa,EAAE;IACd,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAErD,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACpD,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/users/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/users/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { PromptIdentifier } from "../types/prompts.js";
|
|
2
|
+
/**
|
|
3
|
+
* Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
|
|
4
|
+
* Phoenix REST API expects.
|
|
5
|
+
*
|
|
6
|
+
* Version-level selectors are rejected rather than silently widened: structural
|
|
7
|
+
* typing lets a `{ name, tag }` or `{ versionId }` value reach a
|
|
8
|
+
* {@link PromptIdentifier} parameter, and quietly dropping the version would
|
|
9
|
+
* point the caller at the whole prompt instead of the version they named.
|
|
10
|
+
*
|
|
11
|
+
* @param prompt - the prompt, selected by `name` or by `promptId`
|
|
12
|
+
* @returns The identifier to interpolate into the request path.
|
|
13
|
+
* @throws An error if the selector is empty, or selects a version rather than a
|
|
14
|
+
* prompt.
|
|
15
|
+
*/
|
|
16
|
+
export declare function resolvePromptIdentifier(prompt: PromptIdentifier): string;
|
|
17
|
+
//# sourceMappingURL=resolvePromptIdentifier.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolvePromptIdentifier.d.ts","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAwBxE"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
|
|
3
|
+
* Phoenix REST API expects.
|
|
4
|
+
*
|
|
5
|
+
* Version-level selectors are rejected rather than silently widened: structural
|
|
6
|
+
* typing lets a `{ name, tag }` or `{ versionId }` value reach a
|
|
7
|
+
* {@link PromptIdentifier} parameter, and quietly dropping the version would
|
|
8
|
+
* point the caller at the whole prompt instead of the version they named.
|
|
9
|
+
*
|
|
10
|
+
* @param prompt - the prompt, selected by `name` or by `promptId`
|
|
11
|
+
* @returns The identifier to interpolate into the request path.
|
|
12
|
+
* @throws An error if the selector is empty, or selects a version rather than a
|
|
13
|
+
* prompt.
|
|
14
|
+
*/
|
|
15
|
+
export function resolvePromptIdentifier(prompt) {
|
|
16
|
+
if ("versionId" in prompt) {
|
|
17
|
+
throw new Error("A prompt version id selects a single version, not a prompt. Select the prompt by name or promptId.");
|
|
18
|
+
}
|
|
19
|
+
if ("tag" in prompt) {
|
|
20
|
+
throw new Error("A tag selects a single version, not a prompt. Select the prompt by name or promptId.");
|
|
21
|
+
}
|
|
22
|
+
if ("promptId" in prompt) {
|
|
23
|
+
if (!prompt.promptId) {
|
|
24
|
+
throw new Error("promptId must be a non-empty prompt id.");
|
|
25
|
+
}
|
|
26
|
+
return prompt.promptId;
|
|
27
|
+
}
|
|
28
|
+
if ("name" in prompt) {
|
|
29
|
+
if (!prompt.name) {
|
|
30
|
+
throw new Error("name must be a non-empty prompt name.");
|
|
31
|
+
}
|
|
32
|
+
return prompt.name;
|
|
33
|
+
}
|
|
34
|
+
throw new Error("A prompt must be selected by either name or promptId.");
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=resolvePromptIdentifier.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"resolvePromptIdentifier.js","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAwB;IAC9D,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;AAC3E,CAAC"}
|