@arizeai/phoenix-client 1.0.0 → 1.0.2

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 (150) hide show
  1. package/README.md +2 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +90 -0
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/client.d.ts +24 -6
  5. package/dist/esm/client.d.ts.map +1 -1
  6. package/dist/esm/client.js +21 -3
  7. package/dist/esm/client.js.map +1 -1
  8. package/dist/esm/experiments/runExperiment.d.ts +6 -0
  9. package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
  10. package/dist/esm/experiments/runExperiment.js +3 -3
  11. package/dist/esm/experiments/runExperiment.js.map +1 -1
  12. package/dist/esm/prompts/constants.d.ts +1 -1
  13. package/dist/esm/prompts/constants.js +1 -1
  14. package/dist/esm/prompts/createPrompt.d.ts +20 -5
  15. package/dist/esm/prompts/createPrompt.d.ts.map +1 -1
  16. package/dist/esm/prompts/createPrompt.js +12 -3
  17. package/dist/esm/prompts/createPrompt.js.map +1 -1
  18. package/dist/esm/prompts/getPrompt.d.ts +4 -1
  19. package/dist/esm/prompts/getPrompt.d.ts.map +1 -1
  20. package/dist/esm/prompts/getPrompt.js +4 -1
  21. package/dist/esm/prompts/getPrompt.js.map +1 -1
  22. package/dist/esm/prompts/sdks/toAI.d.ts.map +1 -1
  23. package/dist/esm/prompts/sdks/toAI.js +7 -7
  24. package/dist/esm/prompts/sdks/toAI.js.map +1 -1
  25. package/dist/esm/prompts/sdks/toAnthropic.d.ts.map +1 -1
  26. package/dist/esm/prompts/sdks/toOpenAI.d.ts.map +1 -1
  27. package/dist/esm/prompts/sdks/toSDK.d.ts +13 -2
  28. package/dist/esm/prompts/sdks/toSDK.d.ts.map +1 -1
  29. package/dist/esm/prompts/sdks/toSDK.js +12 -1
  30. package/dist/esm/prompts/sdks/toSDK.js.map +1 -1
  31. package/dist/esm/schemas/llm/constants.d.ts +1689 -1
  32. package/dist/esm/schemas/llm/constants.d.ts.map +1 -1
  33. package/dist/esm/schemas/llm/constants.js +2 -2
  34. package/dist/esm/schemas/llm/constants.js.map +1 -1
  35. package/dist/esm/schemas/llm/converters.d.ts +12444 -5692
  36. package/dist/esm/schemas/llm/converters.d.ts.map +1 -1
  37. package/dist/esm/schemas/llm/converters.js +2 -2
  38. package/dist/esm/schemas/llm/converters.js.map +1 -1
  39. package/dist/esm/schemas/llm/openai/converters.d.ts +1692 -0
  40. package/dist/esm/schemas/llm/openai/converters.d.ts.map +1 -1
  41. package/dist/esm/schemas/llm/openai/converters.js +12 -0
  42. package/dist/esm/schemas/llm/openai/converters.js.map +1 -1
  43. package/dist/esm/schemas/llm/phoenixPrompt/messagePartSchemas.d.ts.map +1 -1
  44. package/dist/esm/schemas/llm/types.d.ts +2 -1
  45. package/dist/esm/schemas/llm/types.d.ts.map +1 -1
  46. package/dist/esm/schemas/llm/utils.d.ts.map +1 -1
  47. package/dist/esm/schemas/llm/utils.js +5 -0
  48. package/dist/esm/schemas/llm/utils.js.map +1 -1
  49. package/dist/esm/schemas/llm/vercel/toolSchemas.d.ts +42 -0
  50. package/dist/esm/schemas/llm/vercel/toolSchemas.d.ts.map +1 -0
  51. package/dist/esm/schemas/llm/vercel/toolSchemas.js +17 -0
  52. package/dist/esm/schemas/llm/vercel/toolSchemas.js.map +1 -0
  53. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  54. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  55. package/dist/esm/utils/{getDatasetLike.d.ts → getDatasetBySelector.d.ts} +6 -3
  56. package/dist/esm/utils/getDatasetBySelector.d.ts.map +1 -0
  57. package/dist/esm/utils/{getDatasetLike.js → getDatasetBySelector.js} +3 -3
  58. package/dist/esm/utils/getDatasetBySelector.js.map +1 -0
  59. package/dist/esm/utils/{getPromptVersionLike.d.ts → getPromptBySelector.d.ts} +7 -1
  60. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -0
  61. package/dist/esm/utils/{getPromptVersionLike.js → getPromptBySelector.js} +4 -1
  62. package/dist/esm/utils/getPromptBySelector.js.map +1 -0
  63. package/dist/esm/utils/schemaMatches.d.ts.map +1 -1
  64. package/dist/src/__generated__/api/v1.d.ts +90 -0
  65. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  66. package/dist/src/client.d.ts +24 -6
  67. package/dist/src/client.d.ts.map +1 -1
  68. package/dist/src/client.js +21 -3
  69. package/dist/src/client.js.map +1 -1
  70. package/dist/src/experiments/runExperiment.d.ts +6 -0
  71. package/dist/src/experiments/runExperiment.d.ts.map +1 -1
  72. package/dist/src/experiments/runExperiment.js +3 -3
  73. package/dist/src/experiments/runExperiment.js.map +1 -1
  74. package/dist/src/prompts/constants.d.ts +1 -1
  75. package/dist/src/prompts/constants.js +1 -1
  76. package/dist/src/prompts/createPrompt.d.ts +20 -5
  77. package/dist/src/prompts/createPrompt.d.ts.map +1 -1
  78. package/dist/src/prompts/createPrompt.js +12 -3
  79. package/dist/src/prompts/createPrompt.js.map +1 -1
  80. package/dist/src/prompts/getPrompt.d.ts +4 -1
  81. package/dist/src/prompts/getPrompt.d.ts.map +1 -1
  82. package/dist/src/prompts/getPrompt.js +5 -2
  83. package/dist/src/prompts/getPrompt.js.map +1 -1
  84. package/dist/src/prompts/sdks/toAI.d.ts.map +1 -1
  85. package/dist/src/prompts/sdks/toAI.js +6 -6
  86. package/dist/src/prompts/sdks/toAI.js.map +1 -1
  87. package/dist/src/prompts/sdks/toAnthropic.d.ts.map +1 -1
  88. package/dist/src/prompts/sdks/toOpenAI.d.ts.map +1 -1
  89. package/dist/src/prompts/sdks/toSDK.d.ts +13 -2
  90. package/dist/src/prompts/sdks/toSDK.d.ts.map +1 -1
  91. package/dist/src/prompts/sdks/toSDK.js +12 -1
  92. package/dist/src/prompts/sdks/toSDK.js.map +1 -1
  93. package/dist/src/schemas/llm/constants.d.ts +1689 -1
  94. package/dist/src/schemas/llm/constants.d.ts.map +1 -1
  95. package/dist/src/schemas/llm/constants.js +1 -1
  96. package/dist/src/schemas/llm/constants.js.map +1 -1
  97. package/dist/src/schemas/llm/converters.d.ts +12444 -5692
  98. package/dist/src/schemas/llm/converters.d.ts.map +1 -1
  99. package/dist/src/schemas/llm/converters.js +2 -2
  100. package/dist/src/schemas/llm/converters.js.map +1 -1
  101. package/dist/src/schemas/llm/openai/converters.d.ts +1692 -0
  102. package/dist/src/schemas/llm/openai/converters.d.ts.map +1 -1
  103. package/dist/src/schemas/llm/openai/converters.js +13 -1
  104. package/dist/src/schemas/llm/openai/converters.js.map +1 -1
  105. package/dist/src/schemas/llm/phoenixPrompt/messagePartSchemas.d.ts.map +1 -1
  106. package/dist/src/schemas/llm/types.d.ts +2 -1
  107. package/dist/src/schemas/llm/types.d.ts.map +1 -1
  108. package/dist/src/schemas/llm/utils.d.ts.map +1 -1
  109. package/dist/src/schemas/llm/utils.js +5 -0
  110. package/dist/src/schemas/llm/utils.js.map +1 -1
  111. package/dist/src/schemas/llm/vercel/toolSchemas.d.ts +42 -0
  112. package/dist/src/schemas/llm/vercel/toolSchemas.d.ts.map +1 -0
  113. package/dist/src/schemas/llm/vercel/toolSchemas.js +20 -0
  114. package/dist/src/schemas/llm/vercel/toolSchemas.js.map +1 -0
  115. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  116. package/dist/src/utils/{getDatasetLike.d.ts → getDatasetBySelector.d.ts} +6 -3
  117. package/dist/src/utils/getDatasetBySelector.d.ts.map +1 -0
  118. package/dist/src/utils/{getDatasetLike.js → getDatasetBySelector.js} +4 -4
  119. package/dist/src/utils/getDatasetBySelector.js.map +1 -0
  120. package/dist/src/utils/{getPromptVersionLike.d.ts → getPromptBySelector.d.ts} +7 -1
  121. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -0
  122. package/dist/src/utils/{getPromptVersionLike.js → getPromptBySelector.js} +4 -1
  123. package/dist/src/utils/getPromptBySelector.js.map +1 -0
  124. package/dist/src/utils/schemaMatches.d.ts.map +1 -1
  125. package/dist/tsconfig.tsbuildinfo +1 -1
  126. package/package.json +15 -12
  127. package/src/__generated__/api/v1.ts +90 -0
  128. package/src/client.ts +24 -6
  129. package/src/experiments/runExperiment.ts +9 -3
  130. package/src/prompts/constants.ts +1 -1
  131. package/src/prompts/createPrompt.ts +20 -5
  132. package/src/prompts/getPrompt.ts +5 -2
  133. package/src/prompts/sdks/toAI.ts +7 -6
  134. package/src/prompts/sdks/toSDK.ts +12 -1
  135. package/src/schemas/llm/constants.ts +2 -1
  136. package/src/schemas/llm/converters.ts +6 -2
  137. package/src/schemas/llm/openai/converters.ts +17 -0
  138. package/src/schemas/llm/types.ts +2 -1
  139. package/src/schemas/llm/utils.ts +6 -0
  140. package/src/schemas/llm/vercel/toolSchemas.ts +21 -0
  141. package/src/utils/{getDatasetLike.ts → getDatasetBySelector.ts} +5 -2
  142. package/src/utils/{getPromptVersionLike.ts → getPromptBySelector.ts} +6 -0
  143. package/dist/esm/utils/getDatasetLike.d.ts.map +0 -1
  144. package/dist/esm/utils/getDatasetLike.js.map +0 -1
  145. package/dist/esm/utils/getPromptVersionLike.d.ts.map +0 -1
  146. package/dist/esm/utils/getPromptVersionLike.js.map +0 -1
  147. package/dist/src/utils/getDatasetLike.d.ts.map +0 -1
  148. package/dist/src/utils/getDatasetLike.js.map +0 -1
  149. package/dist/src/utils/getPromptVersionLike.d.ts.map +0 -1
  150. package/dist/src/utils/getPromptVersionLike.js.map +0 -1
@@ -1 +1 @@
1
- {"version":3,"file":"createPrompt.js","sourceRoot":"","sources":["../../../src/prompts/createPrompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAYzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAoB/D;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,GAAG,YAAY,EACI;IACnB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE;QAChD,IAAI,EAAE;YACJ,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,OAAO;SACjB;KACF,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AA+CD;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,MAA0B;IACtD,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,aAAa,EAAE,cAAc,EAC7B,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,eAAe,GAAG,UAAU,EAC5C,oBAAoB,EAAE,qBAAqB,GAC5C,GAAG,MAAM,CAAC;IACX,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,QAAQ;YACX,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,qBAAqB,IAAI,EAAE;iBACpC;aACF,CAAC;QACJ,KAAK,cAAc;YACjB,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,qBAAqB,IAAI,EAAE;iBAC1C;aACF,CAAC;QACJ,KAAK,WAAW;YACd,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,WAAW;oBACjB,SAAS,EAAE,qBAAqB;iBACjC;aACF,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,qBAAqB,IAAI,EAAE;iBACpC;aACF,CAAC;QACJ;YACE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"createPrompt.js","sourceRoot":"","sources":["../../../src/prompts/createPrompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAYzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAoB/D;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,EACjC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,GAAG,YAAY,EACI;IACnB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE;QAChD,IAAI,EAAE;YACJ,MAAM,EAAE,YAAY;YACpB,OAAO,EAAE,OAAO;SACjB;KACF,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACjD,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAqDD;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,MAA0B;IACtD,MAAM,EACJ,WAAW,GAAG,EAAE,EAChB,aAAa,EAAE,cAAc,EAC7B,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,eAAe,GAAG,UAAU,EAC5C,oBAAoB,EAAE,qBAAqB,GAC5C,GAAG,MAAM,CAAC;IACX,QAAQ,cAAc,EAAE,CAAC;QACvB,KAAK,QAAQ;YACX,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,qBAAqB,IAAI,EAAE;iBACpC;aACF,CAAC;QACJ,KAAK,cAAc;YACjB,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,cAAc;oBACpB,YAAY,EAAE,qBAAqB,IAAI,EAAE;iBAC1C;aACF,CAAC;QACJ,KAAK,WAAW;YACd,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,WAAW;oBACjB,SAAS,EAAE,qBAAqB;iBACjC;aACF,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO;gBACL,WAAW;gBACX,cAAc;gBACd,UAAU;gBACV,aAAa,EAAE,MAAM;gBACrB,eAAe;gBACf,QAAQ,EAAE;oBACR,IAAI,EAAE,MAAM;oBACZ,QAAQ,EAAE,gBAAgB;iBAC3B;gBACD,qBAAqB,EAAE;oBACrB,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,qBAAqB,IAAI,EAAE;iBACpC;aACF,CAAC;QACJ;YACE,iBAAiB,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;AACH,CAAC"}
@@ -1,7 +1,7 @@
1
1
  import { ClientFn } from "../types/core.js";
2
2
  import { PromptSelector, PromptVersion } from "../types/prompts.js";
3
3
  /**
4
- * Parameters for the getPrompt function
4
+ * Parameters for getting a prompt from Phoenix.
5
5
  */
6
6
  export interface GetPromptParams extends ClientFn {
7
7
  /**
@@ -11,6 +11,9 @@ export interface GetPromptParams extends ClientFn {
11
11
  }
12
12
  /**
13
13
  * Get a prompt from the Phoenix API.
14
+ *
15
+ * @param params - The parameters to get a prompt.
16
+ * @returns The prompt version, or null if it does not exist.
14
17
  */
15
18
  export declare function getPrompt({ client: _client, prompt: _prompt, }: GetPromptParams): Promise<PromptVersion | null>;
16
19
  //# sourceMappingURL=getPrompt.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getPrompt.d.ts","sourceRoot":"","sources":["../../../src/prompts/getPrompt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjE;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED;;GAEG;AACH,wBAAsB,SAAS,CAAC,EAC9B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,GAChB,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAIjD"}
1
+ {"version":3,"file":"getPrompt.d.ts","sourceRoot":"","sources":["../../../src/prompts/getPrompt.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjE;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,EAC9B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,GAChB,EAAE,eAAe,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAIjD"}
@@ -1,7 +1,10 @@
1
1
  import { createClient } from "../client.js";
2
- import { getPromptBySelector } from "../utils/getPromptVersionLike.js";
2
+ import { getPromptBySelector } from "../utils/getPromptBySelector.js";
3
3
  /**
4
4
  * Get a prompt from the Phoenix API.
5
+ *
6
+ * @param params - The parameters to get a prompt.
7
+ * @returns The prompt version, or null if it does not exist.
5
8
  */
6
9
  export async function getPrompt({ client: _client, prompt: _prompt, }) {
7
10
  const client = _client ?? createClient();
@@ -1 +1 @@
1
- {"version":3,"file":"getPrompt.js","sourceRoot":"","sources":["../../../src/prompts/getPrompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAYpE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC9B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,GACC;IAChB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7E,OAAO,aAAa,CAAC;AACvB,CAAC"}
1
+ {"version":3,"file":"getPrompt.js","sourceRoot":"","sources":["../../../src/prompts/getPrompt.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAYnE;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAC9B,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,OAAO,GACC;IAChB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,aAAa,GAAG,MAAM,mBAAmB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7E,OAAO,aAAa,CAAC;AACvB,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"toAI.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAI.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EACL,KAAK,UAAU,EACf,KAAK,YAAY,EAIlB,MAAM,IAAI,CAAC;AAGZ,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,EACrE,OAAO,CACR,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,SAAS,0BAGrC,UAAU,CAAC,CAAC,CAAC,KAAG,uBAAuB,GAAG,IAwE5C,CAAC"}
1
+ {"version":3,"file":"toAI.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAI.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EACL,KAAK,UAAU,EACf,KAAK,YAAY,EAGlB,MAAM,IAAI,CAAC;AAGZ,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,EACrE,OAAO,CACR,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,SAAS,EAAE,wBAGvC,UAAU,CAAC,CAAC,CAAC,KAAG,uBAAuB,GAAG,IAyE5C,CAAC"}
@@ -1,7 +1,6 @@
1
1
  import invariant from "tiny-invariant";
2
- import { safelyConvertMessageToProvider, safelyConvertToolChoiceToProvider, } from "../../schemas/llm/converters.js";
2
+ import { safelyConvertMessageToProvider, safelyConvertToolChoiceToProvider, safelyConvertToolDefinitionToProvider, } from "../../schemas/llm/converters.js";
3
3
  import { formatPromptMessages } from "../../utils/formatPromptMessages.js";
4
- import { jsonSchema, } from "ai";
5
4
  /**
6
5
  * Converts a Phoenix prompt to Vercel AI sdk params.
7
6
  *
@@ -36,11 +35,12 @@ export const toAI = ({ prompt, variables, }) => {
36
35
  if (!tool.function.parameters) {
37
36
  return acc;
38
37
  }
39
- acc[tool.function.name] = {
40
- type: "function",
41
- parameters: jsonSchema(tool.function.parameters),
42
- description: tool.function.description,
43
- };
38
+ const vercelAIToolDefinition = safelyConvertToolDefinitionToProvider({
39
+ toolDefinition: tool,
40
+ targetProvider: "VERCEL_AI",
41
+ });
42
+ invariant(vercelAIToolDefinition, "Tool definition is not valid");
43
+ acc[tool.function.name] = vercelAIToolDefinition;
44
44
  return acc;
45
45
  }, {});
46
46
  const hasTools = Object.keys(tools ?? {}).length > 0;
@@ -1 +1 @@
1
- {"version":3,"file":"toAI.js","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAI.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,8BAA8B,EAC9B,iCAAiC,GAClC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,OAAO,EAKL,UAAU,GACX,MAAM,IAAI,CAAC;AAUZ;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAsB,EACxC,MAAM,EACN,SAAS,GACK,EAAkC,EAAE;IAClD,sCAAsC;IACtC,OAAO,CAAC,IAAI,CACV,+GAA+G,CAChH,CAAC;IACF,IAAI,CAAC;QACH,sEAAsE;QACtE,MAAM,oBAAoB,GAAG;QAC3B,0DAA0D;SAChB,CAAC;QAE7C,IAAI,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAEjD,IAAI,SAAS,EAAE,CAAC;YACd,iBAAiB,GAAG,oBAAoB,CACtC,MAAM,CAAC,eAAe,EACtB,iBAAiB,EACjB,SAAS,CACV,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,eAAe,GAAG,8BAA8B,CAAC;gBACrD,OAAO;gBACP,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC;YACH,SAAS,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;YACnD,OAAO,eAAe,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,2EAA2E;QAC3E,IAAI,KAAK,GAAwB,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACxE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAC9B,OAAO,GAAG,CAAC;YACb,CAAC;YACD,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG;gBACxB,IAAI,EAAE,UAAU;gBAChB,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;gBAChD,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,WAAW;aACxB,CAAC;YACjB,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAa,CAAC,CAAC;QAClB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACrD,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QAErC,IAAI,UAAU,GACZ,iCAAiC,CAAC;YAChC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW;YACrC,cAAc,EAAE,WAAW;SAC5B,CAAC,IAAI,SAAS,CAAC;QAClB,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE/C,mCAAmC;QACnC,MAAM,gBAAgB,GAAG;YACvB,GAAG,oBAAoB;YACvB,QAAQ;YACR,KAAK;YACL,UAAU;SACgC,CAAC;QAE7C,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,sCAAsC;QACtC,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;QACtD,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}
1
+ {"version":3,"file":"toAI.js","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAI.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,8BAA8B,EAC9B,iCAAiC,EACjC,qCAAqC,GACtC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAiBxE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAsB,EACxC,MAAM,EACN,SAAS,GACK,EAAkC,EAAE;IAClD,sCAAsC;IACtC,OAAO,CAAC,IAAI,CACV,+GAA+G,CAChH,CAAC;IACF,IAAI,CAAC;QACH,sEAAsE;QACtE,MAAM,oBAAoB,GAAG;QAC3B,0DAA0D;SAChB,CAAC;QAE7C,IAAI,CAAC,CAAC,UAAU,IAAI,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,iBAAiB,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAEjD,IAAI,SAAS,EAAE,CAAC;YACd,iBAAiB,GAAG,oBAAoB,CACtC,MAAM,CAAC,eAAe,EACtB,iBAAiB,EACjB,SAAS,CACV,CAAC;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YACjD,MAAM,eAAe,GAAG,8BAA8B,CAAC;gBACrD,OAAO;gBACP,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC;YACH,SAAS,CAAC,eAAe,EAAE,sBAAsB,CAAC,CAAC;YACnD,OAAO,eAAe,CAAC;QACzB,CAAC,CAAC,CAAC;QAEH,2EAA2E;QAC3E,IAAI,KAAK,GAAwB,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACxE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAC9B,OAAO,GAAG,CAAC;YACb,CAAC;YACD,MAAM,sBAAsB,GAAG,qCAAqC,CAAC;gBACnE,cAAc,EAAE,IAAI;gBACpB,cAAc,EAAE,WAAW;aAC5B,CAAC,CAAC;YACH,SAAS,CAAC,sBAAsB,EAAE,8BAA8B,CAAC,CAAC;YAClE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,sBAAqC,CAAC;YAChE,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAa,CAAC,CAAC;QAClB,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACrD,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QAErC,IAAI,UAAU,GACZ,iCAAiC,CAAC;YAChC,UAAU,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW;YACrC,cAAc,EAAE,WAAW;SAC5B,CAAC,IAAI,SAAS,CAAC;QAClB,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;QAE/C,mCAAmC;QACnC,MAAM,gBAAgB,GAAG;YACvB,GAAG,oBAAoB;YACvB,QAAQ;YACR,KAAK;YACL,UAAU;SACgC,CAAC;QAE7C,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,sCAAsC;QACtC,OAAO,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;QACtD,sCAAsC;QACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"toAnthropic.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAnthropic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAY1D,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEpC,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,SAAS,sCAG5C,iBAAiB,CAAC,CAAC,CAAC,KAAG,mBAAmB,GAAG,IA0E/C,CAAC"}
1
+ {"version":3,"file":"toAnthropic.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toAnthropic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+CAA+C,CAAC;AACzF,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAY1D,YAAY,EAAE,mBAAmB,EAAE,CAAC;AAEpC,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,wBAG1D,iBAAiB,CAAC,CAAC,CAAC,KAAG,mBAAmB,GAAG,IA0E/C,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"toOpenAI.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toOpenAI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAa1D,YAAY,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,wBAAwB,GACzB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,SAAS,sCAGzC,cAAc,CAAC,CAAC,CAAC,KAAG,0BAA0B,GAAG,IAgFnD,CAAC"}
1
+ {"version":3,"file":"toOpenAI.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toOpenAI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAa1D,YAAY,EACV,0BAA0B,EAC1B,0BAA0B,EAC1B,wBAAwB,GACzB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,IAAI,eAAe,CAAC,CAAC,CAAC,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,wBAGvD,cAAc,CAAC,CAAC,CAAC,KAAG,0BAA0B,GAAG,IAgFnD,CAAC"}
@@ -13,7 +13,7 @@ export type SDKParams<T extends SupportedSDK> = Parameters<(typeof PROVIDER_TO_S
13
13
  * Map of SDK names to their corresponding conversion functions
14
14
  */
15
15
  declare const PROVIDER_TO_SDK: {
16
- openai: <V extends Variables = Variables>({ prompt, variables, }: import("./toOpenAI.js").ToOpenAIParams<V>) => import("openai/resources/chat/completions").ChatCompletionCreateParams | null;
16
+ openai: <V extends Variables = Variables>({ prompt, variables, }: import("./toOpenAI.js").ToOpenAIParams<V>) => import("openai/resources/chat/completions/completions").ChatCompletionCreateParams | null;
17
17
  anthropic: <V extends Variables = Variables>({ prompt, variables, }: import("./toAnthropic.js").ToAnthropicParams<V>) => import("@anthropic-ai/sdk/resources/messages/messages").MessageCreateParams | null;
18
18
  ai: <V extends Variables>({ prompt, variables, }: import("./toAI.js").ToAIParams<V>) => import("./toAI.js").PartialStreamTextParams | null;
19
19
  };
@@ -35,12 +35,23 @@ type ToSDKParams<T extends SupportedSDK, V extends Variables = Variables> = {
35
35
  /**
36
36
  * Convert a Phoenix prompt to a specific SDK's parameters
37
37
  *
38
- * @example
38
+ * @example quickstart
39
39
  * ```ts
40
+ * // Get a prompt from Phoenix, use it via openai sdk
40
41
  * const prompt = await getPrompt({ prompt: { name: "my-prompt" } });
41
42
  * const openaiParams = toSDK({ sdk: "openai", prompt });
42
43
  * const response = await openai.chat.completions.create(openaiParams);
43
44
  * ```
45
+ *
46
+ * @example type safety
47
+ * ```ts
48
+ * // Enforce variable types via Generic argument
49
+ * const prompt = await getPrompt({ prompt: { name: "my-prompt" } });
50
+ * const openaiParams = toSDK<"openai", { name: string }>({ sdk: "openai", prompt, variables: { name: "John" } });
51
+ * ```
52
+ *
53
+ * @param params - The parameters to convert a prompt to an SDK's parameters
54
+ * @returns The SDK's parameters
44
55
  */
45
56
  export declare const toSDK: <T extends SupportedSDK, V extends Variables = Variables>({ sdk: _sdk, ...rest }: ToSDKParams<T, V> & SDKParams<T>) => ReturnType<(typeof PROVIDER_TO_SDK)[T]>;
46
57
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"toSDK.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toSDK.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnE;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,YAAY,IAAI,UAAU,CACxD,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC,MAAM,CAAC,SAAS,eAAe,GAC7B,UAAU,CAAC,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAC/C,KAAK,CAAC;AAEV;;GAEG;AACH,QAAA,MAAM,eAAe;;;;CAIpB,CAAC;AAkBF;;GAEG;AACH,KAAK,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC1E;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;IACP;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC;CACf,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,SAAS,sCAG9D,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,KAGV,UAAU,CAAC,CAAC,OAAO,eAAe,EAAE,CAAC,CAAC,CAC9D,CAAC"}
1
+ {"version":3,"file":"toSDK.d.ts","sourceRoot":"","sources":["../../../../src/prompts/sdks/toSDK.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnE;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,YAAY,IAAI,UAAU,CACxD,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAC5B,CAAC,MAAM,CAAC,SAAS,eAAe,GAC7B,UAAU,CAAC,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAC/C,KAAK,CAAC;AAEV;;GAEG;AACH,QAAA,MAAM,eAAe;;;;CAIpB,CAAC;AAkBF;;GAEG;AACH,KAAK,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI;IAC1E;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC;IACP;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,SAAS,GAAG,SAAS,EAAE,wBAG5E,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,KAGV,UAAU,CAAC,CAAC,OAAO,eAAe,EAAE,CAAC,CAAC,CAC9D,CAAC"}
@@ -29,12 +29,23 @@ const getTargetSDK = (sdk) => {
29
29
  /**
30
30
  * Convert a Phoenix prompt to a specific SDK's parameters
31
31
  *
32
- * @example
32
+ * @example quickstart
33
33
  * ```ts
34
+ * // Get a prompt from Phoenix, use it via openai sdk
34
35
  * const prompt = await getPrompt({ prompt: { name: "my-prompt" } });
35
36
  * const openaiParams = toSDK({ sdk: "openai", prompt });
36
37
  * const response = await openai.chat.completions.create(openaiParams);
37
38
  * ```
39
+ *
40
+ * @example type safety
41
+ * ```ts
42
+ * // Enforce variable types via Generic argument
43
+ * const prompt = await getPrompt({ prompt: { name: "my-prompt" } });
44
+ * const openaiParams = toSDK<"openai", { name: string }>({ sdk: "openai", prompt, variables: { name: "John" } });
45
+ * ```
46
+ *
47
+ * @param params - The parameters to convert a prompt to an SDK's parameters
48
+ * @returns The SDK's parameters
38
49
  */
39
50
  export const toSDK = ({ sdk: _sdk, ...rest }) => {
40
51
  const sdk = getTargetSDK(_sdk);
@@ -1 +1 @@
1
- {"version":3,"file":"toSDK.js","sourceRoot":"","sources":["../../../../src/prompts/sdks/toSDK.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAiBlE;;GAEG;AACH,MAAM,eAAe,GAAG;IACtB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,EAAE,EAAE,IAAI;CACT,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAG,CAAyB,GAAM,EAAE,EAAE;IACtD,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,WAAW;YACd,OAAO,eAAe,CAAC,SAAS,CAAC;QACnC,KAAK,IAAI;YACP,OAAO,eAAe,CAAC,EAAE,CAAC;QAC5B;YACE,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AAkBF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAA0D,EAC7E,GAAG,EAAE,IAAI,EACT,GAAG,IAAI,EAC0B,EAAE,EAAE;IACrC,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,SAAS,CAAC,GAAG,EAAE,6BAA6B,IAAI,EAAE,CAAC,CAAC;IACpD,OAAO,GAAG,CAAI,IAAI,CAA4C,CAAC;AACjE,CAAC,CAAC"}
1
+ {"version":3,"file":"toSDK.js","sourceRoot":"","sources":["../../../../src/prompts/sdks/toSDK.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAiBlE;;GAEG;AACH,MAAM,eAAe,GAAG;IACtB,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,EAAE,EAAE,IAAI;CACT,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAG,CAAyB,GAAM,EAAE,EAAE;IACtD,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,eAAe,CAAC,MAAM,CAAC;QAChC,KAAK,WAAW;YACd,OAAO,eAAe,CAAC,SAAS,CAAC;QACnC,KAAK,IAAI;YACP,OAAO,eAAe,CAAC,EAAE,CAAC;QAC5B;YACE,iBAAiB,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;AACH,CAAC,CAAC;AAkBF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAA0D,EAC7E,GAAG,EAAE,IAAI,EACT,GAAG,IAAI,EAC0B,EAAE,EAAE;IACrC,MAAM,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAC/B,SAAS,CAAC,GAAG,EAAE,6BAA6B,IAAI,EAAE,CAAC,CAAC;IACpD,OAAO,GAAG,CAAI,IAAI,CAA4C,CAAC;AACjE,CAAC,CAAC"}