honeyhive 0.3.0 → 0.3.6

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 (159) hide show
  1. package/README.md +76 -14
  2. package/dist/internal/utils/requestbody.js +28 -18
  3. package/dist/internal/utils/utils.js +2 -4
  4. package/dist/sdk/index.d.ts +1 -0
  5. package/dist/sdk/index.js +1 -0
  6. package/dist/sdk/models/operations/deletedatasetsname.d.ts +1 -1
  7. package/dist/sdk/models/operations/deletedatasetsname.js +1 -1
  8. package/dist/sdk/models/operations/deletemetrics.d.ts +1 -1
  9. package/dist/sdk/models/operations/deletemetrics.js +1 -1
  10. package/dist/sdk/models/operations/deletepromptsid.d.ts +1 -1
  11. package/dist/sdk/models/operations/deletepromptsid.js +1 -1
  12. package/dist/sdk/models/operations/deletetasks.d.ts +1 -1
  13. package/dist/sdk/models/operations/deletetasks.js +1 -1
  14. package/dist/sdk/models/operations/getdatasets.d.ts +5 -5
  15. package/dist/sdk/models/operations/getdatasets.js +5 -5
  16. package/dist/sdk/models/operations/getfinetunedmodels.d.ts +5 -5
  17. package/dist/sdk/models/operations/getfinetunedmodels.js +5 -5
  18. package/dist/sdk/models/operations/getfinetunedmodelsid.d.ts +1 -1
  19. package/dist/sdk/models/operations/getfinetunedmodelsid.js +1 -1
  20. package/dist/sdk/models/operations/getgenerations.d.ts +5 -5
  21. package/dist/sdk/models/operations/getgenerations.js +5 -5
  22. package/dist/sdk/models/operations/getmetrics.d.ts +5 -5
  23. package/dist/sdk/models/operations/getmetrics.js +5 -5
  24. package/dist/sdk/models/operations/getprompts.d.ts +5 -5
  25. package/dist/sdk/models/operations/getprompts.js +5 -5
  26. package/dist/sdk/models/operations/getsession.d.ts +6 -11
  27. package/dist/sdk/models/operations/getsession.js +7 -18
  28. package/dist/sdk/models/operations/getsessionsessionid.d.ts +1 -1
  29. package/dist/sdk/models/operations/getsessionsessionid.js +1 -1
  30. package/dist/sdk/models/operations/getsessionsessionidexport.d.ts +1 -1
  31. package/dist/sdk/models/operations/getsessionsessionidexport.js +1 -1
  32. package/dist/sdk/models/operations/gettasks.d.ts +2 -2
  33. package/dist/sdk/models/operations/gettasks.js +2 -2
  34. package/dist/sdk/models/operations/index.d.ts +1 -1
  35. package/dist/sdk/models/operations/index.js +1 -1
  36. package/dist/sdk/models/operations/postdatasets.d.ts +1 -1
  37. package/dist/sdk/models/operations/postdatasets.js +1 -1
  38. package/dist/sdk/models/operations/postevaluations.d.ts +1 -1
  39. package/dist/sdk/models/operations/postevaluations.js +1 -1
  40. package/dist/sdk/models/operations/postfeedback.d.ts +1 -1
  41. package/dist/sdk/models/operations/postfeedback.js +1 -1
  42. package/dist/sdk/models/operations/postgenerations.d.ts +1 -1
  43. package/dist/sdk/models/operations/postgenerations.js +1 -1
  44. package/dist/sdk/models/operations/postgenerationslog.d.ts +1 -1
  45. package/dist/sdk/models/operations/postgenerationslog.js +1 -1
  46. package/dist/sdk/models/operations/postmetrics.d.ts +1 -1
  47. package/dist/sdk/models/operations/postmetrics.js +1 -1
  48. package/dist/sdk/models/operations/postprompts.d.ts +1 -1
  49. package/dist/sdk/models/operations/postprompts.js +1 -1
  50. package/dist/sdk/models/operations/postsessionsessionidend.d.ts +1 -1
  51. package/dist/sdk/models/operations/postsessionsessionidend.js +1 -1
  52. package/dist/sdk/models/operations/postsessionsessionidevent.d.ts +1 -1
  53. package/dist/sdk/models/operations/postsessionsessionidevent.js +1 -1
  54. package/dist/sdk/models/operations/postsessionsessionidfeedback.d.ts +1 -1
  55. package/dist/sdk/models/operations/postsessionsessionidfeedback.js +1 -1
  56. package/dist/sdk/models/operations/postsessionsessionidtraces.d.ts +25 -0
  57. package/dist/sdk/models/operations/postsessionsessionidtraces.js +95 -0
  58. package/dist/sdk/models/operations/postsessionstart.d.ts +1 -1
  59. package/dist/sdk/models/operations/postsessionstart.js +1 -1
  60. package/dist/sdk/models/operations/posttasks.d.ts +1 -1
  61. package/dist/sdk/models/operations/posttasks.js +1 -1
  62. package/dist/sdk/models/operations/putpromptsid.d.ts +1 -1
  63. package/dist/sdk/models/operations/putpromptsid.js +1 -1
  64. package/dist/sdk/models/operations/puttasks.d.ts +1 -1
  65. package/dist/sdk/models/operations/puttasks.js +1 -1
  66. package/dist/sdk/models/shared/datasetresponse.d.ts +1 -3
  67. package/dist/sdk/models/shared/datasetresponse.js +2 -11
  68. package/dist/sdk/models/shared/evaluationloggingquery.d.ts +7 -21
  69. package/dist/sdk/models/shared/evaluationloggingquery.js +8 -71
  70. package/dist/sdk/models/shared/feedbackquery.d.ts +1 -6
  71. package/dist/sdk/models/shared/feedbackquery.js +2 -14
  72. package/dist/sdk/models/shared/feedbackresponse.d.ts +1 -6
  73. package/dist/sdk/models/shared/feedbackresponse.js +2 -14
  74. package/dist/sdk/models/shared/generatequery.d.ts +3 -18
  75. package/dist/sdk/models/shared/generatequery.js +4 -40
  76. package/dist/sdk/models/shared/generationloggingquery.d.ts +7 -32
  77. package/dist/sdk/models/shared/generationloggingquery.js +13 -73
  78. package/dist/sdk/models/shared/metricresponse.d.ts +1 -6
  79. package/dist/sdk/models/shared/metricresponse.js +2 -14
  80. package/dist/sdk/models/shared/promptcreationquery.d.ts +1 -3
  81. package/dist/sdk/models/shared/promptcreationquery.js +2 -11
  82. package/dist/sdk/models/shared/promptresponse.d.ts +1 -3
  83. package/dist/sdk/models/shared/promptresponse.js +2 -11
  84. package/dist/sdk/models/shared/promptupdatequery.d.ts +1 -3
  85. package/dist/sdk/models/shared/promptupdatequery.js +2 -11
  86. package/dist/sdk/models/shared/sessioneventquery.d.ts +33 -31
  87. package/dist/sdk/models/shared/sessioneventquery.js +40 -67
  88. package/dist/sdk/models/shared/sessionfeedback.d.ts +1 -6
  89. package/dist/sdk/models/shared/sessionfeedback.js +2 -14
  90. package/dist/sdk/models/shared/sessionstartquery.d.ts +1 -6
  91. package/dist/sdk/models/shared/sessionstartquery.js +2 -14
  92. package/dist/sdk/models/shared/uploaddataset.d.ts +1 -3
  93. package/dist/sdk/models/shared/uploaddataset.js +2 -11
  94. package/dist/sdk/sdk.d.ts +3 -3
  95. package/dist/sdk/sdk.js +24 -24
  96. package/dist/sdk/tracer.d.ts +140 -0
  97. package/dist/sdk/tracer.js +233 -0
  98. package/docs/models/operations/getdatasetsresponse.md +2 -2
  99. package/docs/models/operations/getfinetunedmodelsresponse.md +2 -2
  100. package/docs/models/operations/getgenerationsresponse.md +2 -2
  101. package/docs/models/operations/getmetricsresponse.md +2 -2
  102. package/docs/models/operations/getpromptsresponse.md +2 -2
  103. package/docs/models/operations/getsessionrequest.md +5 -5
  104. package/docs/models/operations/getsessionresponse.md +2 -2
  105. package/docs/models/operations/gettasksresponse.md +1 -1
  106. package/docs/models/operations/{postsessionssessionidtracesrequest.md → postsessionsessionidtracesrequest.md} +1 -1
  107. package/docs/models/operations/{postsessionssessionidtracesresponse.md → postsessionsessionidtracesresponse.md} +1 -1
  108. package/docs/models/shared/datasetresponse.md +1 -1
  109. package/docs/models/shared/evaluationloggingquery.md +16 -16
  110. package/docs/models/shared/feedbackquery.md +6 -6
  111. package/docs/models/shared/feedbackresponse.md +1 -1
  112. package/docs/models/shared/generatequery.md +14 -14
  113. package/docs/models/shared/generationloggingquery.md +16 -16
  114. package/docs/models/shared/{generatequerymetadata.md → metadata.md} +1 -1
  115. package/docs/models/shared/metricresponse.md +1 -1
  116. package/docs/models/shared/promptcreationquery.md +11 -11
  117. package/docs/models/shared/promptresponse.md +1 -1
  118. package/docs/models/shared/promptupdatequery.md +9 -9
  119. package/docs/models/shared/sessioneventquery.md +20 -14
  120. package/docs/models/shared/sessionfeedback.md +4 -4
  121. package/docs/models/shared/sessionstartquery.md +7 -7
  122. package/docs/models/shared/sessiontrace.md +3 -3
  123. package/docs/models/shared/taskcreationquery.md +4 -4
  124. package/docs/models/shared/taskresponse.md +4 -4
  125. package/docs/models/shared/taskupdatequery.md +9 -9
  126. package/docs/models/shared/uploaddataset.md +8 -8
  127. package/docs/sdks/honeyhive/README.md +313 -132
  128. package/package.json +7 -5
  129. package/docs/models/operations/getsessionquery.md +0 -9
  130. package/docs/models/shared/datasetresponsefile.md +0 -7
  131. package/docs/models/shared/evaluationloggingquerycomments.md +0 -7
  132. package/docs/models/shared/evaluationloggingquerydataset.md +0 -7
  133. package/docs/models/shared/evaluationloggingquerygenerations.md +0 -7
  134. package/docs/models/shared/evaluationloggingquerymetrics.md +0 -7
  135. package/docs/models/shared/evaluationloggingqueryprompts.md +0 -7
  136. package/docs/models/shared/evaluationloggingqueryresults.md +0 -7
  137. package/docs/models/shared/evaluationloggingquerysummary.md +0 -7
  138. package/docs/models/shared/feedbackqueryfeedbackjson.md +0 -9
  139. package/docs/models/shared/feedbackresponsefeedback.md +0 -9
  140. package/docs/models/shared/generatequeryinput.md +0 -9
  141. package/docs/models/shared/generatequeryuserproperties.md +0 -9
  142. package/docs/models/shared/generationloggingqueryfeedback.md +0 -9
  143. package/docs/models/shared/generationloggingqueryhyperparameters.md +0 -9
  144. package/docs/models/shared/generationloggingqueryinputs.md +0 -9
  145. package/docs/models/shared/generationloggingquerymetadata.md +0 -9
  146. package/docs/models/shared/generationloggingqueryusage.md +0 -9
  147. package/docs/models/shared/generationloggingqueryuserproperties.md +0 -9
  148. package/docs/models/shared/metricresponsethreshold.md +0 -9
  149. package/docs/models/shared/promptcreationqueryfewshotexamples.md +0 -7
  150. package/docs/models/shared/promptresponsefewshotexamples.md +0 -7
  151. package/docs/models/shared/promptupdatequeryfewshotexamples.md +0 -7
  152. package/docs/models/shared/sessioneventquerychildren.md +0 -7
  153. package/docs/models/shared/sessioneventqueryconfig.md +0 -9
  154. package/docs/models/shared/sessioneventqueryerror.md +0 -9
  155. package/docs/models/shared/sessioneventqueryinputs.md +0 -9
  156. package/docs/models/shared/sessioneventquerymetadata.md +0 -9
  157. package/docs/models/shared/sessionfeedbackfeedback.md +0 -9
  158. package/docs/models/shared/sessionstartqueryuserproperties.md +0 -9
  159. package/docs/models/shared/uploaddatasetfile.md +0 -7
package/docs/models/shared/evaluationloggingquery.md CHANGED
@@ -5,19 +5,19 @@ The request object for logging an evaluation
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
10
- | `comments` | [EvaluationLoggingQueryComments](../../models/shared/evaluationloggingquerycomments.md)[] | :heavy_minus_sign: | The comments for the evaluation |
11
- | `dataset` | [EvaluationLoggingQueryDataset](../../models/shared/evaluationloggingquerydataset.md)[] | :heavy_minus_sign: | The dataset for which the evaluation is being created |
12
- | `datasetName` | *string* | :heavy_minus_sign: | The name of the dataset for which the evaluation is being created |
13
- | `description` | *string* | :heavy_minus_sign: | The description of the evaluation |
14
- | `generations` | [EvaluationLoggingQueryGenerations](../../models/shared/evaluationloggingquerygenerations.md)[] | :heavy_minus_sign: | The completions for prompts that are being evaluated |
15
- | `id` | *string* | :heavy_minus_sign: | The id of the evaluation |
16
- | `metrics` | [EvaluationLoggingQueryMetrics](../../models/shared/evaluationloggingquerymetrics.md)[][] | :heavy_minus_sign: | The metrics that are computed for the completions |
17
- | `metricsToCompute` | *string*[] | :heavy_minus_sign: | The metrics that are computed for the completions |
18
- | `name` | *string* | :heavy_minus_sign: | The name of the evaluation |
19
- | `prompts` | [EvaluationLoggingQueryPrompts](../../models/shared/evaluationloggingqueryprompts.md)[] | :heavy_minus_sign: | The prompts for which the evaluation is being created |
20
- | `results` | [EvaluationLoggingQueryResults](../../models/shared/evaluationloggingqueryresults.md)[] | :heavy_minus_sign: | The results of the evaluation |
21
- | `summary` | [EvaluationLoggingQuerySummary](../../models/shared/evaluationloggingquerysummary.md)[] | :heavy_minus_sign: | The metric summary of the evaluation |
22
- | `task` | *string* | :heavy_minus_sign: | The task for which the evaluation is being created |
23
- | `user` | *string* | :heavy_minus_sign: | The user running the evaluation |
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- |
10
+ | `comments` | Record<string, *any*>[] | :heavy_minus_sign: | The comments for the evaluation |
11
+ | `dataset` | Record<string, *any*>[] | :heavy_minus_sign: | The dataset for which the evaluation is being created |
12
+ | `datasetName` | *string* | :heavy_minus_sign: | The name of the dataset for which the evaluation is being created |
13
+ | `description` | *string* | :heavy_minus_sign: | The description of the evaluation |
14
+ | `generations` | Record<string, *any*>[] | :heavy_minus_sign: | The completions for prompts that are being evaluated |
15
+ | `id` | *string* | :heavy_minus_sign: | The id of the evaluation |
16
+ | `metrics` | Record<string, *any*>[][] | :heavy_minus_sign: | The metrics that are computed for the completions |
17
+ | `metricsToCompute` | *string*[] | :heavy_minus_sign: | The metrics that are computed for the completions |
18
+ | `name` | *string* | :heavy_minus_sign: | The name of the evaluation |
19
+ | `prompts` | Record<string, *any*>[] | :heavy_minus_sign: | The prompts for which the evaluation is being created |
20
+ | `results` | Record<string, *any*>[] | :heavy_minus_sign: | The results of the evaluation |
21
+ | `summary` | Record<string, *any*>[] | :heavy_minus_sign: | The metric summary of the evaluation |
22
+ | `task` | *string* | :heavy_minus_sign: | The task for which the evaluation is being created |
23
+ | `user` | *string* | :heavy_minus_sign: | The user running the evaluation |
package/docs/models/shared/feedbackquery.md CHANGED
@@ -5,9 +5,9 @@ The request object for providing feedback
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
10
- | `feedbackJson` | [FeedbackQueryFeedbackJson](../../models/shared/feedbackqueryfeedbackjson.md) | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
11
- | `generationId` | *string* | :heavy_minus_sign: | The ID of the generation for which feedback is being submitted |
12
- | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
- | `task` | *string* | :heavy_minus_sign: | The task for which the feedback is being submitted |
8
+ | Field | Type | Required | Description |
9
+ | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
10
+ | `feedbackJson` | Record<string, *any*> | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
11
+ | `generationId` | *string* | :heavy_minus_sign: | The ID of the generation for which feedback is being submitted |
12
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
+ | `task` | *string* | :heavy_minus_sign: | The task for which the feedback is being submitted |
package/docs/models/shared/feedbackresponse.md CHANGED
@@ -8,7 +8,7 @@ The response object for providing feedback
8
8
  | Field | Type | Required | Description |
9
9
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
10
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the feedback was created |
11
- | `feedback` | [FeedbackResponseFeedback](../../models/shared/feedbackresponsefeedback.md) | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
11
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | The feedback JSON with one or many feedback items |
12
12
  | `generationId` | *string* | :heavy_minus_sign: | The ID of the generation for which feedback was submitted |
13
13
  | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
14
14
  | `task` | *string* | :heavy_minus_sign: | The task for which the feedback was submitted |
package/docs/models/shared/generatequery.md CHANGED
@@ -5,17 +5,17 @@ The request object for generating text
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
10
- | `bestOf` | *number* | :heavy_minus_sign: | The number of generations to be returned |
11
- | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth of the generation |
12
- | `input` | [GenerateQueryInput](../../models/shared/generatequeryinput.md) | :heavy_minus_sign: | The input variables for the generation |
13
- | `metadata` | [GenerateQueryMetadata](../../models/shared/generatequerymetadata.md) | :heavy_minus_sign: | The metadata to track for the generation |
14
- | `metric` | *string* | :heavy_minus_sign: | The metric used for sorting the generations |
15
- | `modelId` | *string* | :heavy_minus_sign: | The unique ID of the fine-tuned model to generate from |
16
- | `prompts` | *string*[] | :heavy_minus_sign: | The unique IDs of the prompts to generate from |
17
- | `sampling` | *string* | :heavy_minus_sign: | The sampling method used for generating the generations |
18
- | `source` | *string* | :heavy_minus_sign: | The source of the generation |
19
- | `stream` | *boolean* | :heavy_minus_sign: | A boolean flag that represents whether you want to generate a streaming output |
20
- | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being requested |
21
- | `userProperties` | [GenerateQueryUserProperties](../../models/shared/generatequeryuserproperties.md) | :heavy_minus_sign: | The user properties to track for the generation |
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
10
+ | `bestOf` | *number* | :heavy_minus_sign: | The number of generations to be returned |
11
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth of the generation |
12
+ | `input` | Record<string, *any*> | :heavy_minus_sign: | The input variables for the generation |
13
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | The metadata to track for the generation |
14
+ | `metric` | *string* | :heavy_minus_sign: | The metric used for sorting the generations |
15
+ | `modelId` | *string* | :heavy_minus_sign: | The unique ID of the fine-tuned model to generate from |
16
+ | `prompts` | *string*[] | :heavy_minus_sign: | The unique IDs of the prompts to generate from |
17
+ | `sampling` | *string* | :heavy_minus_sign: | The sampling method used for generating the generations |
18
+ | `source` | *string* | :heavy_minus_sign: | The source of the generation |
19
+ | `stream` | *boolean* | :heavy_minus_sign: | A boolean flag that represents whether you want to generate a streaming output |
20
+ | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being requested |
21
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | The user properties to track for the generation |
package/docs/models/shared/generationloggingquery.md CHANGED
@@ -5,19 +5,19 @@ The request object for logging a generation
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
10
- | `feedback` | [GenerationLoggingQueryFeedback](../../models/shared/generationloggingqueryfeedback.md) | :heavy_minus_sign: | The feedback associated with this generation |
11
- | `generation` | *string* | :heavy_minus_sign: | The text that was generated by the model provider |
12
- | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
- | `hyperparameters` | [GenerationLoggingQueryHyperparameters](../../models/shared/generationloggingqueryhyperparameters.md) | :heavy_minus_sign: | The hyperparameters that were used to generate the text |
14
- | `inputs` | [GenerationLoggingQueryInputs](../../models/shared/generationloggingqueryinputs.md) | :heavy_minus_sign: | The inputs filled into the prompt |
15
- | `latency` | *number* | :heavy_minus_sign: | The latency of the generation in milliseconds |
16
- | `metadata` | [GenerationLoggingQueryMetadata](../../models/shared/generationloggingquerymetadata.md) | :heavy_minus_sign: | The metadata to track for the generation |
17
- | `model` | *string* | :heavy_minus_sign: | The model that was used to generate the text |
18
- | `prompt` | *string* | :heavy_minus_sign: | The prompt used to generate the text |
19
- | `source` | *string* | :heavy_minus_sign: | The source of the generation |
20
- | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being logged |
21
- | `usage` | [GenerationLoggingQueryUsage](../../models/shared/generationloggingqueryusage.md) | :heavy_minus_sign: | The token usage for the generation |
22
- | `userProperties` | [GenerationLoggingQueryUserProperties](../../models/shared/generationloggingqueryuserproperties.md) | :heavy_minus_sign: | The user properties to track for the generation |
23
- | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
10
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | The feedback associated with this generation |
11
+ | `generation` | *string* | :heavy_minus_sign: | The text that was generated by the model provider |
12
+ | `groundTruth` | *string* | :heavy_minus_sign: | The ground truth for the generation |
13
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters that were used to generate the text |
14
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | The inputs filled into the prompt |
15
+ | `latency` | *number* | :heavy_minus_sign: | The latency of the generation in milliseconds |
16
+ | `metadata` | [shared.Metadata](../../models/shared/metadata.md) | :heavy_minus_sign: | The metadata to track for the generation |
17
+ | `model` | *string* | :heavy_minus_sign: | The model that was used to generate the text |
18
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt used to generate the text |
19
+ | `source` | *string* | :heavy_minus_sign: | The source of the generation |
20
+ | `task` | *string* | :heavy_minus_sign: | The task for which the generation is being logged |
21
+ | `usage` | Record<string, *any*> | :heavy_minus_sign: | The token usage for the generation |
22
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | The user properties to track for the generation |
23
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/{generatequerymetadata.md → metadata.md} RENAMED
@@ -1,4 +1,4 @@
1
- # GenerateQueryMetadata
1
+ # Metadata
2
2
 
3
3
  The metadata to track for the generation
4
4
 
package/docs/models/shared/metricresponse.md CHANGED
@@ -18,5 +18,5 @@ The response object for a metric
18
18
  | `prompt` | *string* | :heavy_minus_sign: | The prompt that this metric is calculated on |
19
19
  | `returnType` | *string* | :heavy_minus_sign: | The return type of the metric |
20
20
  | `task` | *string* | :heavy_minus_sign: | The task name for the metric |
21
- | `threshold` | [MetricResponseThreshold](../../models/shared/metricresponsethreshold.md) | :heavy_minus_sign: | The alerting thresholds of the metric |
21
+ | `threshold` | Record<string, *any*> | :heavy_minus_sign: | The alerting thresholds of the metric |
22
22
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp when the metric was last updated |
package/docs/models/shared/promptcreationquery.md CHANGED
@@ -5,14 +5,14 @@ The request object for creating a prompt
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
10
- | `chat` | *string* | :heavy_minus_sign: | The text of the chat prompt |
11
- | `fewShotExamples` | [PromptCreationQueryFewShotExamples](../../models/shared/promptcreationqueryfewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
12
- | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
13
- | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
14
- | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
15
- | `provider` | *string* | :heavy_minus_sign: | The model provider |
16
- | `task` | *string* | :heavy_minus_sign: | The task for which the prompt is being created |
17
- | `text` | *string* | :heavy_minus_sign: | The text of the prompt |
18
- | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
8
+ | Field | Type | Required | Description |
9
+ | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
10
+ | `chat` | *string* | :heavy_minus_sign: | The text of the chat prompt |
11
+ | `fewShotExamples` | Record<string, *any*>[] | :heavy_minus_sign: | The few shot examples for the prompt |
12
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
13
+ | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
14
+ | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
15
+ | `provider` | *string* | :heavy_minus_sign: | The model provider |
16
+ | `task` | *string* | :heavy_minus_sign: | The task for which the prompt is being created |
17
+ | `text` | *string* | :heavy_minus_sign: | The text of the prompt |
18
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/promptresponse.md CHANGED
@@ -8,7 +8,7 @@ The response object for a prompt
8
8
  | Field | Type | Required | Description |
9
9
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
10
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the prompt was created |
11
- | `fewShotExamples` | [PromptResponseFewShotExamples](../../models/shared/promptresponsefewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
11
+ | `fewShotExamples` | Record<string, *any*>[] | :heavy_minus_sign: | The few shot examples for the prompt |
12
12
  | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
13
13
  | `inputVariables` | *string*[] | :heavy_minus_sign: | The input variables to feed into the prompt |
14
14
  | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
package/docs/models/shared/promptupdatequery.md CHANGED
@@ -5,12 +5,12 @@ The request object for updating a prompt
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
- | `fewShotExamples` | [PromptUpdateQueryFewShotExamples](../../models/shared/promptupdatequeryfewshotexamples.md)[] | :heavy_minus_sign: | The few shot examples for the prompt |
11
- | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
12
- | `id` | *string* | :heavy_minus_sign: | The ID of the prompt |
13
- | `inputVariables` | *string*[] | :heavy_minus_sign: | The input variables to feed into the prompt |
14
- | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
15
- | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
16
- | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- |
10
+ | `fewShotExamples` | Record<string, *any*>[] | :heavy_minus_sign: | The few shot examples for the prompt |
11
+ | `hyperparameters` | Record<string, *any*> | :heavy_minus_sign: | The hyperparameters for the prompt |
12
+ | `id` | *string* | :heavy_minus_sign: | The ID of the prompt |
13
+ | `inputVariables` | *string*[] | :heavy_minus_sign: | The input variables to feed into the prompt |
14
+ | `isDeployed` | *boolean* | :heavy_minus_sign: | Flag indicating if the prompt is deployed |
15
+ | `model` | *string* | :heavy_minus_sign: | The model to be used for the prompt |
16
+ | `version` | *string* | :heavy_minus_sign: | The version of the prompt |
package/docs/models/shared/sessioneventquery.md CHANGED
@@ -5,17 +5,23 @@ The request object for querying session events
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
10
- | `children` | [SessionEventQueryChildren](../../models/shared/sessioneventquerychildren.md)[] | :heavy_minus_sign: | Child events |
11
- | `config` | [SessionEventQueryConfig](../../models/shared/sessioneventqueryconfig.md) | :heavy_minus_sign: | The configuration of LLM, Tool or other for the event |
12
- | `duration` | *number* | :heavy_minus_sign: | Duration of the event |
13
- | `error` | [SessionEventQueryError](../../models/shared/sessioneventqueryerror.md) | :heavy_minus_sign: | Error from the event |
14
- | `eventId` | *string* | :heavy_minus_sign: | The ID of the event |
15
- | `eventName` | *string* | :heavy_minus_sign: | The name for the event |
16
- | `eventType` | *string* | :heavy_minus_sign: | The type of the event |
17
- | `inputs` | [SessionEventQueryInputs](../../models/shared/sessioneventqueryinputs.md) | :heavy_minus_sign: | Inputs to the event |
18
- | `metadata` | [SessionEventQueryMetadata](../../models/shared/sessioneventquerymetadata.md) | :heavy_minus_sign: | Metadata of the event |
19
- | `output` | *string* | :heavy_minus_sign: | Output of the event |
20
- | `parentId` | *string* | :heavy_minus_sign: | The parent ID of the event |
21
- | `source` | *string* | :heavy_minus_sign: | Source of the event |
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
10
+ | `children` | Record<string, *any*>[] | :heavy_minus_sign: | Child events |
11
+ | `config` | Record<string, *any*> | :heavy_minus_sign: | The configuration of LLM, Tool or other for the event |
12
+ | `duration` | *number* | :heavy_minus_sign: | Duration of the event |
13
+ | `endTime` | *number* | :heavy_minus_sign: | End time of the event |
14
+ | `error` | *string* | :heavy_minus_sign: | Error from the event |
15
+ | `eventId` | *string* | :heavy_minus_sign: | The ID of the event |
16
+ | `eventName` | *string* | :heavy_minus_sign: | The name for the event |
17
+ | `eventType` | *string* | :heavy_minus_sign: | The type of the event |
18
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | Feedback for the event |
19
+ | `inputs` | Record<string, *any*> | :heavy_minus_sign: | Inputs to the event |
20
+ | `metadata` | Record<string, *any*> | :heavy_minus_sign: | Metadata of the event |
21
+ | `metrics` | Record<string, *any*> | :heavy_minus_sign: | Metrics for the event |
22
+ | `outputs` | Record<string, *any*> | :heavy_minus_sign: | Outputs of the event |
23
+ | `project` | *string* | :heavy_minus_sign: | The project that the event belongs to |
24
+ | `sessionId` | *string* | :heavy_minus_sign: | The ID of the session |
25
+ | `source` | *string* | :heavy_minus_sign: | Source of the event |
26
+ | `startTime` | *number* | :heavy_minus_sign: | Start time of the event |
27
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | User properties of the event |
package/docs/models/shared/sessionfeedback.md CHANGED
@@ -5,7 +5,7 @@ The request object for providing feedback for a session
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
10
- | `eventId` | *string* | :heavy_minus_sign: | The ID of the specific event to provide feedback for |
11
- | `feedback` | [SessionFeedbackFeedback](../../models/shared/sessionfeedbackfeedback.md) | :heavy_minus_sign: | The feedback for the session |
8
+ | Field | Type | Required | Description |
9
+ | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
10
+ | `eventId` | *string* | :heavy_minus_sign: | The ID of the specific event to provide feedback for |
11
+ | `feedback` | Record<string, *any*> | :heavy_minus_sign: | The feedback for the session |
package/docs/models/shared/sessionstartquery.md CHANGED
@@ -5,10 +5,10 @@ The request object for starting a session
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
10
- | `project` | *string* | :heavy_minus_sign: | The project name for the session |
11
- | `sessionId` | *string* | :heavy_minus_sign: | The ID of the session |
12
- | `sessionName` | *string* | :heavy_minus_sign: | The name for the session |
13
- | `source` | *string* | :heavy_minus_sign: | The source of the session |
14
- | `userProperties` | [SessionStartQueryUserProperties](../../models/shared/sessionstartqueryuserproperties.md) | :heavy_minus_sign: | The user properties for the session |
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
10
+ | `project` | *string* | :heavy_minus_sign: | The project name for the session |
11
+ | `sessionId` | *string* | :heavy_minus_sign: | The ID of the session |
12
+ | `sessionName` | *string* | :heavy_minus_sign: | The name for the session |
13
+ | `source` | *string* | :heavy_minus_sign: | The source of the session |
14
+ | `userProperties` | Record<string, *any*> | :heavy_minus_sign: | The user properties for the session |
package/docs/models/shared/sessiontrace.md CHANGED
@@ -5,6 +5,6 @@ The response object for a session trace
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
10
- | `logs` | [SessionEventQuery](../../models/shared/sessioneventquery.md)[] | :heavy_minus_sign: | The trace logs for the session |
8
+ | Field | Type | Required | Description |
9
+ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
10
+ | `logs` | [shared.SessionEventQuery](../../models/shared/sessioneventquery.md)[] | :heavy_minus_sign: | The trace logs for the session |
package/docs/models/shared/taskcreationquery.md CHANGED
@@ -8,11 +8,11 @@ The request object for creating a task
8
8
  | Field | Type | Required | Description |
9
9
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
10
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was created |
11
- | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
11
+ | `datasets` | [shared.DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
12
12
  | `description` | *string* | :heavy_minus_sign: | The description of the task |
13
- | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
14
- | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
13
+ | `fineTunedModels` | [shared.FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
14
+ | `metrics` | [shared.MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
15
15
  | `name` | *string* | :heavy_minus_sign: | The name of the task |
16
- | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
16
+ | `prompts` | [shared.PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
17
17
  | `type` | *string* | :heavy_minus_sign: | The type of the task |
18
18
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was last updated |
package/docs/models/shared/taskresponse.md CHANGED
@@ -8,13 +8,13 @@ The response object for a task
8
8
  | Field | Type | Required | Description |
9
9
  | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
10
  | `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was created |
11
- | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
11
+ | `datasets` | [shared.DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The datasets for the task |
12
12
  | `description` | *string* | :heavy_minus_sign: | The description of the task |
13
- | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
13
+ | `fineTunedModels` | [shared.FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The fine-tuned models for the task |
14
14
  | `id` | *string* | :heavy_minus_sign: | The ID of the task |
15
- | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
15
+ | `metrics` | [shared.MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The metrics for the task |
16
16
  | `name` | *string* | :heavy_minus_sign: | The name of the task |
17
- | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
17
+ | `prompts` | [shared.PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The prompts for the task |
18
18
  | `tenant` | *string* | :heavy_minus_sign: | The tenant that this task belongs to |
19
19
  | `type` | *string* | :heavy_minus_sign: | The type of the task |
20
20
  | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The timestamp of when the task was last updated |
package/docs/models/shared/taskupdatequery.md CHANGED
@@ -5,12 +5,12 @@ The request object for updating a task
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
10
- | `datasets` | [DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The new datasets for the task |
11
- | `fineTunedModels` | [FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The new fine-tuned models for the task |
12
- | `metrics` | [MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The new metrics for the task |
13
- | `name` | *string* | :heavy_minus_sign: | The new name of the task |
14
- | `prompts` | [PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The new prompts for the task |
15
- | `taskId` | *string* | :heavy_minus_sign: | The id of the task being updated |
16
- | `type` | *string* | :heavy_minus_sign: | The new type of the task |
8
+ | Field | Type | Required | Description |
9
+ | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
10
+ | `datasets` | [shared.DatasetResponse](../../models/shared/datasetresponse.md)[] | :heavy_minus_sign: | The new datasets for the task |
11
+ | `fineTunedModels` | [shared.FineTunedModelResponse](../../models/shared/finetunedmodelresponse.md)[] | :heavy_minus_sign: | The new fine-tuned models for the task |
12
+ | `metrics` | [shared.MetricResponse](../../models/shared/metricresponse.md)[] | :heavy_minus_sign: | The new metrics for the task |
13
+ | `name` | *string* | :heavy_minus_sign: | The new name of the task |
14
+ | `prompts` | [shared.PromptResponse](../../models/shared/promptresponse.md)[] | :heavy_minus_sign: | The new prompts for the task |
15
+ | `taskId` | *string* | :heavy_minus_sign: | The id of the task being updated |
16
+ | `type` | *string* | :heavy_minus_sign: | The new type of the task |
package/docs/models/shared/uploaddataset.md CHANGED
@@ -5,11 +5,11 @@ The request object for uploading a dataset
5
5
 
6
6
  ## Fields
7
7
 
8
- | Field | Type | Required | Description |
9
- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
10
- | `description` | *string* | :heavy_minus_sign: | The description of the dataset |
11
- | `file` | [UploadDatasetFile](../../models/shared/uploaddatasetfile.md)[] | :heavy_minus_sign: | N/A |
12
- | `name` | *string* | :heavy_minus_sign: | The name of the dataset |
13
- | `prompt` | *string* | :heavy_minus_sign: | The prompt related to the dataset |
14
- | `purpose` | *string* | :heavy_minus_sign: | The purpose of the dataset |
15
- | `task` | *string* | :heavy_minus_sign: | The task related to the dataset |
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
10
+ | `description` | *string* | :heavy_minus_sign: | The description of the dataset |
11
+ | `file` | Record<string, *any*>[] | :heavy_minus_sign: | N/A |
12
+ | `name` | *string* | :heavy_minus_sign: | The name of the dataset |
13
+ | `prompt` | *string* | :heavy_minus_sign: | The prompt related to the dataset |
14
+ | `purpose` | *string* | :heavy_minus_sign: | The purpose of the dataset |
15
+ | `task` | *string* | :heavy_minus_sign: | The task related to the dataset |