@arizeai/phoenix-client 7.3.1 → 7.4.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.
Files changed (31) hide show
  1. package/dist/esm/constants/serverRequirements.d.ts +1 -0
  2. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  3. package/dist/esm/constants/serverRequirements.js +7 -0
  4. package/dist/esm/constants/serverRequirements.js.map +1 -1
  5. package/dist/esm/prompts/index.d.ts +1 -0
  6. package/dist/esm/prompts/index.d.ts.map +1 -1
  7. package/dist/esm/prompts/index.js +1 -0
  8. package/dist/esm/prompts/index.js.map +1 -1
  9. package/dist/esm/prompts/updatePrompt.d.ts +51 -0
  10. package/dist/esm/prompts/updatePrompt.d.ts.map +1 -0
  11. package/dist/esm/prompts/updatePrompt.js +62 -0
  12. package/dist/esm/prompts/updatePrompt.js.map +1 -0
  13. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  14. package/dist/src/constants/serverRequirements.d.ts +1 -0
  15. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  16. package/dist/src/constants/serverRequirements.js +8 -1
  17. package/dist/src/constants/serverRequirements.js.map +1 -1
  18. package/dist/src/prompts/index.d.ts +1 -0
  19. package/dist/src/prompts/index.d.ts.map +1 -1
  20. package/dist/src/prompts/index.js +1 -0
  21. package/dist/src/prompts/index.js.map +1 -1
  22. package/dist/src/prompts/updatePrompt.d.ts +51 -0
  23. package/dist/src/prompts/updatePrompt.d.ts.map +1 -0
  24. package/dist/src/prompts/updatePrompt.js +66 -0
  25. package/dist/src/prompts/updatePrompt.js.map +1 -0
  26. package/dist/tsconfig.tsbuildinfo +1 -1
  27. package/docs/prompts.mdx +18 -1
  28. package/package.json +1 -1
  29. package/src/constants/serverRequirements.ts +8 -0
  30. package/src/prompts/index.ts +1 -0
  31. package/src/prompts/updatePrompt.ts +95 -0
@@ -28,6 +28,7 @@ export declare const DATASET_UPLOAD_EXAMPLE_IDS: ParameterRequirement;
28
28
  export declare const ADD_TRACE_NOTE_IDENTIFIER: ParameterRequirement;
29
29
  export declare const ADD_SPAN_NOTE_IDENTIFIER: ParameterRequirement;
30
30
  export declare const ADD_SESSION_NOTE_IDENTIFIER: ParameterRequirement;
31
+ export declare const PATCH_PROMPT: RouteRequirement;
31
32
  /**
32
33
  * Aggregate list of every known capability requirement.
33
34
  *
@@ -1 +1 @@
1
- {"version":3,"file":"serverRequirements.d.ts","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,gBAKzB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,gBAK7B,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,gBAKnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,gBAK/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAK9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,oBAMjC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,oBAMhC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,oBAM/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,oBAMpC,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,oBAMxC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,oBAMvC,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,oBAMtC,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,oBAMzC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,qBAAqB,EAiBnD,CAAC"}
1
+ {"version":3,"file":"serverRequirements.d.ts","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EACV,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AAErC,eAAO,MAAM,WAAW,EAAE,gBAKzB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,gBAK7B,CAAC;AAEF,eAAO,MAAM,qBAAqB,EAAE,gBAKnC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,gBAK/B,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,gBAK5B,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,gBAK9B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,oBAMjC,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,oBAMhC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,oBAM/B,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,gBAKjC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,oBAMpC,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,oBAMxC,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,oBAMvC,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,oBAMtC,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,oBAMzC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,gBAK1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,qBAAqB,EAkBnD,CAAC"}
@@ -13,7 +13,7 @@
13
13
  * function that uses it.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ALL_REQUIREMENTS = exports.ADD_SESSION_NOTE_IDENTIFIER = exports.ADD_SPAN_NOTE_IDENTIFIER = exports.ADD_TRACE_NOTE_IDENTIFIER = exports.DATASET_UPLOAD_EXAMPLE_IDS = exports.GET_SPANS_BY_ATTRIBUTE = exports.LIST_PROJECT_TRACES = exports.GET_SPANS_FILTERS = exports.GET_SPANS_SPAN_IDS = exports.GET_SPANS_TRACE_IDS = exports.ADD_SESSION_NOTE = exports.ADD_TRACE_NOTE = exports.ANNOTATE_SESSIONS = exports.LIST_PROJECT_SESSIONS = exports.DELETE_SESSIONS = exports.DELETE_SESSION = exports.GET_SESSION = void 0;
16
+ exports.ALL_REQUIREMENTS = exports.PATCH_PROMPT = exports.ADD_SESSION_NOTE_IDENTIFIER = exports.ADD_SPAN_NOTE_IDENTIFIER = exports.ADD_TRACE_NOTE_IDENTIFIER = exports.DATASET_UPLOAD_EXAMPLE_IDS = exports.GET_SPANS_BY_ATTRIBUTE = exports.LIST_PROJECT_TRACES = exports.GET_SPANS_FILTERS = exports.GET_SPANS_SPAN_IDS = exports.GET_SPANS_TRACE_IDS = exports.ADD_SESSION_NOTE = exports.ADD_TRACE_NOTE = exports.ANNOTATE_SESSIONS = exports.LIST_PROJECT_SESSIONS = exports.DELETE_SESSIONS = exports.DELETE_SESSION = exports.GET_SESSION = void 0;
17
17
  exports.GET_SESSION = {
18
18
  kind: "route",
19
19
  method: "GET",
@@ -118,6 +118,12 @@ exports.ADD_SESSION_NOTE_IDENTIFIER = {
118
118
  route: "POST /v1/session_notes",
119
119
  minServerVersion: [15, 5, 0],
120
120
  };
121
+ exports.PATCH_PROMPT = {
122
+ kind: "route",
123
+ method: "PATCH",
124
+ path: "/v1/prompts/{prompt_identifier}",
125
+ minServerVersion: [19, 18, 0],
126
+ };
121
127
  /**
122
128
  * Aggregate list of every known capability requirement.
123
129
  *
@@ -141,5 +147,6 @@ exports.ALL_REQUIREMENTS = [
141
147
  exports.ADD_TRACE_NOTE_IDENTIFIER,
142
148
  exports.ADD_SPAN_NOTE_IDENTIFIER,
143
149
  exports.ADD_SESSION_NOTE_IDENTIFIER,
150
+ exports.PATCH_PROMPT,
144
151
  ];
145
152
  //# sourceMappingURL=serverRequirements.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"serverRequirements.js","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAQU,QAAA,WAAW,GAAqB;IAC3C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,eAAe,GAAqB;IAC/C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,qBAAqB;IAC3B,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,qBAAqB,GAAqB;IACrD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,oCAAoC;IAC1C,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,iBAAiB,GAAqB;IACjD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,iBAAiB;IACvB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,gBAAgB,GAAqB;IAChD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,mBAAmB;IACzB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,mBAAmB,GAAyB;IACvD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,UAAU;IACzB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,kBAAkB,GAAyB;IACtD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,SAAS;IACxB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,iBAAiB,GAAyB;IACrD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,mBAAmB,GAAqB;IACnD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,0CAA0C;IAChD,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,sBAAsB,GAAyB;IAC1D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,aAAa;IAC5B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,yBAAyB,GAAyB;IAC7D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,sBAAsB;IAC7B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,wBAAwB,GAAyB;IAC5D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,qBAAqB;IAC5B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,2BAA2B,GAAyB;IAC/D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,wBAAwB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEF;;;;;GAKG;AACU,QAAA,gBAAgB,GAAqC;IAChE,QAAA,WAAW;IACX,QAAA,cAAc;IACd,QAAA,eAAe;IACf,QAAA,qBAAqB;IACrB,QAAA,iBAAiB;IACjB,QAAA,cAAc;IACd,QAAA,gBAAgB;IAChB,QAAA,mBAAmB;IACnB,QAAA,kBAAkB;IAClB,QAAA,iBAAiB;IACjB,QAAA,sBAAsB;IACtB,QAAA,mBAAmB;IACnB,QAAA,0BAA0B;IAC1B,QAAA,yBAAyB;IACzB,QAAA,wBAAwB;IACxB,QAAA,2BAA2B;CACnB,CAAC"}
1
+ {"version":3,"file":"serverRequirements.js","sourceRoot":"","sources":["../../../src/constants/serverRequirements.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;AAQU,QAAA,WAAW,GAAqB;IAC3C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,2BAA2B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,eAAe,GAAqB;IAC/C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,qBAAqB;IAC3B,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,qBAAqB,GAAqB;IACrD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,oCAAoC;IAC1C,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,iBAAiB,GAAqB;IACjD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,yBAAyB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,cAAc,GAAqB;IAC9C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,iBAAiB;IACvB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,gBAAgB,GAAqB;IAChD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,mBAAmB;IACzB,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,mBAAmB,GAAyB;IACvD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,UAAU;IACzB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,kBAAkB,GAAyB;IACtD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,SAAS;IACxB,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,iBAAiB,GAAyB;IACrD,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,mBAAmB,GAAqB;IACnD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,0CAA0C;IAChD,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEW,QAAA,sBAAsB,GAAyB;IAC1D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,WAAW;IAC1B,iBAAiB,EAAE,OAAO;IAC1B,KAAK,EAAE,6BAA6B;IACpC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,0BAA0B,GAAyB;IAC9D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,aAAa;IAC5B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,0BAA0B;IACjC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,yBAAyB,GAAyB;IAC7D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,sBAAsB;IAC7B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,wBAAwB,GAAyB;IAC5D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,qBAAqB;IAC5B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,2BAA2B,GAAyB;IAC/D,IAAI,EAAE,WAAW;IACjB,aAAa,EAAE,YAAY;IAC3B,iBAAiB,EAAE,MAAM;IACzB,KAAK,EAAE,wBAAwB;IAC/B,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;CAC7B,CAAC;AAEW,QAAA,YAAY,GAAqB;IAC5C,IAAI,EAAE,OAAO;IACb,MAAM,EAAE,OAAO;IACf,IAAI,EAAE,iCAAiC;IACvC,gBAAgB,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;CAC9B,CAAC;AAEF;;;;;GAKG;AACU,QAAA,gBAAgB,GAAqC;IAChE,QAAA,WAAW;IACX,QAAA,cAAc;IACd,QAAA,eAAe;IACf,QAAA,qBAAqB;IACrB,QAAA,iBAAiB;IACjB,QAAA,cAAc;IACd,QAAA,gBAAgB;IAChB,QAAA,mBAAmB;IACnB,QAAA,kBAAkB;IAClB,QAAA,iBAAiB;IACjB,QAAA,sBAAsB;IACtB,QAAA,mBAAmB;IACnB,QAAA,0BAA0B;IAC1B,QAAA,yBAAyB;IACzB,QAAA,wBAAwB;IACxB,QAAA,2BAA2B;IAC3B,QAAA,YAAY;CACJ,CAAC"}
@@ -1,5 +1,6 @@
1
1
  export * from "./getPrompt";
2
2
  export * from "./createPrompt";
3
3
  export * from "./listPrompts";
4
+ export * from "./updatePrompt";
4
5
  export * from "./sdks";
5
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC"}
@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./getPrompt"), exports);
18
18
  __exportStar(require("./createPrompt"), exports);
19
19
  __exportStar(require("./listPrompts"), exports);
20
+ __exportStar(require("./updatePrompt"), exports);
20
21
  __exportStar(require("./sdks"), exports);
21
22
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,gDAA8B;AAC9B,yCAAuB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,gDAA8B;AAC9B,iDAA+B;AAC/B,yCAAuB"}
@@ -0,0 +1,51 @@
1
+ import type { ClientFn } from "../types/core";
2
+ import type { Prompt } from "../types/prompts";
3
+ /**
4
+ * Parameters for updating a prompt's description and/or metadata.
5
+ *
6
+ * Omit a field to leave it unchanged. Pass `description: null` to clear the
7
+ * description. `metadata` replaces the existing metadata object as a whole.
8
+ */
9
+ export interface UpdatePromptParams extends ClientFn {
10
+ /**
11
+ * The prompt name or ID.
12
+ */
13
+ promptIdentifier: string;
14
+ /**
15
+ * New description for the prompt. Pass `null` to clear it. Omit to leave
16
+ * unchanged.
17
+ */
18
+ description?: string | null;
19
+ /**
20
+ * New metadata object for the prompt (full replace). Omit to leave unchanged.
21
+ */
22
+ metadata?: Record<string, unknown>;
23
+ }
24
+ /**
25
+ * Update a prompt's description and/or metadata via
26
+ * `PATCH /v1/prompts/{prompt_identifier}`.
27
+ *
28
+ * @param params - The parameters to update the prompt.
29
+ * @returns The updated prompt.
30
+ *
31
+ * @requires Phoenix server >= 19.18.0
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * import { updatePrompt } from "@arizeai/phoenix-client/prompts";
36
+ *
37
+ * const prompt = await updatePrompt({
38
+ * promptIdentifier: "my-prompt",
39
+ * description: "Production classifier",
40
+ * metadata: { team: "ml", env: "prod" },
41
+ * });
42
+ *
43
+ * // Clear the description only
44
+ * await updatePrompt({
45
+ * promptIdentifier: "my-prompt",
46
+ * description: null,
47
+ * });
48
+ * ```
49
+ */
50
+ export declare function updatePrompt({ client: _client, promptIdentifier, description, metadata, }: UpdatePromptParams): Promise<Prompt>;
51
+ //# sourceMappingURL=updatePrompt.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"updatePrompt.d.ts","sourceRoot":"","sources":["../../../src/prompts/updatePrompt.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG/C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAClD;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,gBAAgB,EAChB,WAAW,EACX,QAAQ,GACT,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAgCtC"}
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.updatePrompt = updatePrompt;
7
+ const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
8
+ const client_1 = require("../client");
9
+ const serverRequirements_1 = require("../constants/serverRequirements");
10
+ const errors_1 = require("../errors");
11
+ const serverVersionUtils_1 = require("../utils/serverVersionUtils");
12
+ /**
13
+ * Update a prompt's description and/or metadata via
14
+ * `PATCH /v1/prompts/{prompt_identifier}`.
15
+ *
16
+ * @param params - The parameters to update the prompt.
17
+ * @returns The updated prompt.
18
+ *
19
+ * @requires Phoenix server >= 19.18.0
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * import { updatePrompt } from "@arizeai/phoenix-client/prompts";
24
+ *
25
+ * const prompt = await updatePrompt({
26
+ * promptIdentifier: "my-prompt",
27
+ * description: "Production classifier",
28
+ * metadata: { team: "ml", env: "prod" },
29
+ * });
30
+ *
31
+ * // Clear the description only
32
+ * await updatePrompt({
33
+ * promptIdentifier: "my-prompt",
34
+ * description: null,
35
+ * });
36
+ * ```
37
+ */
38
+ async function updatePrompt({ client: _client, promptIdentifier, description, metadata, }) {
39
+ var _a;
40
+ if (description === undefined && metadata === undefined) {
41
+ throw new Error("At least one of description or metadata must be provided.");
42
+ }
43
+ const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
44
+ await (0, serverVersionUtils_1.ensureServerCapability)({ client, requirement: serverRequirements_1.PATCH_PROMPT });
45
+ try {
46
+ const response = await client.PATCH("/v1/prompts/{prompt_identifier}", {
47
+ params: {
48
+ path: {
49
+ prompt_identifier: promptIdentifier,
50
+ },
51
+ },
52
+ body: Object.assign(Object.assign({}, (description !== undefined ? { description } : {})), (metadata !== undefined ? { metadata } : {})),
53
+ });
54
+ (0, tiny_invariant_1.default)((_a = response.data) === null || _a === void 0 ? void 0 : _a.data, "Failed to update prompt");
55
+ return response.data.data;
56
+ }
57
+ catch (error) {
58
+ if (error instanceof errors_1.HttpError && error.status === 404) {
59
+ throw new Error(`Prompt not found: ${promptIdentifier}`, {
60
+ cause: error,
61
+ });
62
+ }
63
+ throw error;
64
+ }
65
+ }
66
+ //# sourceMappingURL=updatePrompt.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"updatePrompt.js","sourceRoot":"","sources":["../../../src/prompts/updatePrompt.ts"],"names":[],"mappings":";;;;;;AAAA,oEAAuC;AAEvC,sCAAyC;AACzC,wEAA+D;AAC/D,sCAAsC;AAGtC,oEAAqE;AAwBrE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,uBAAuB,EACjC,MAAM,EAAE,OAAO,EACf,gBAAgB,EAChB,WAAW,EACX,QAAQ,GACW;;IACnB,IAAI,WAAW,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QACxD,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,IAAA,2CAAsB,EAAC,EAAE,MAAM,EAAE,WAAW,EAAE,iCAAY,EAAE,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,iCAAiC,EAAE;YACrE,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,iBAAiB,EAAE,gBAAgB;iBACpC;aACF;YACD,IAAI,kCACC,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,GAClD,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAChD;SACF,CAAC,CAAC;QACH,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,yBAAyB,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;IAC5B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,kBAAS,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YACvD,MAAM,IAAI,KAAK,CAAC,qBAAqB,gBAAgB,EAAE,EAAE;gBACvD,KAAK,EAAE,KAAK;aACb,CAAC,CAAC;QACL,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}