hume 0.9.3 → 0.9.4

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 (147) hide show
  1. package/.mock/definition/empathic-voice/__package__.yml +287 -14
  2. package/.mock/definition/empathic-voice/chatGroups.yml +25 -23
  3. package/.mock/definition/empathic-voice/chats.yml +14 -24
  4. package/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +8 -2
  5. package/api/resources/empathicVoice/resources/chatGroups/client/Client.js +12 -6
  6. package/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +5 -1
  7. package/api/resources/empathicVoice/resources/chats/client/Client.d.ts +4 -2
  8. package/api/resources/empathicVoice/resources/chats/client/Client.js +7 -5
  9. package/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
  10. package/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
  11. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
  12. package/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
  13. package/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  14. package/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  15. package/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  16. package/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
  17. package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
  18. package/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
  19. package/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
  20. package/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
  21. package/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
  22. package/api/resources/empathicVoice/types/PostedVoice.d.ts +2 -2
  23. package/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
  24. package/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
  25. package/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
  26. package/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +5 -0
  27. package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
  28. package/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
  29. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
  30. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +5 -0
  31. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
  32. package/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
  33. package/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
  34. package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
  35. package/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
  36. package/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
  37. package/api/resources/empathicVoice/types/ReturnVoice.d.ts +2 -2
  38. package/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
  39. package/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
  40. package/api/resources/empathicVoice/types/index.d.ts +8 -0
  41. package/api/resources/empathicVoice/types/index.js +8 -0
  42. package/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  43. package/api/resources/index.d.ts +1 -1
  44. package/api/resources/index.js +2 -2
  45. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.d.ts +8 -2
  46. package/dist/api/resources/empathicVoice/resources/chatGroups/client/Client.js +12 -6
  47. package/dist/api/resources/empathicVoice/resources/chatGroups/client/requests/ChatGroupsGetAudioRequest.d.ts +5 -1
  48. package/dist/api/resources/empathicVoice/resources/chats/client/Client.d.ts +4 -2
  49. package/dist/api/resources/empathicVoice/resources/chats/client/Client.js +7 -5
  50. package/dist/api/resources/empathicVoice/resources/configs/client/Client.d.ts +4 -4
  51. package/dist/api/resources/empathicVoice/resources/configs/client/Client.js +13 -13
  52. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfig.d.ts +2 -2
  53. package/dist/api/resources/empathicVoice/resources/configs/client/requests/PostedConfigVersion.d.ts +2 -2
  54. package/dist/api/resources/empathicVoice/resources/customVoices/client/Client.js +6 -6
  55. package/dist/api/resources/empathicVoice/resources/prompts/client/Client.js +9 -9
  56. package/dist/api/resources/empathicVoice/resources/tools/client/Client.js +9 -9
  57. package/dist/api/resources/empathicVoice/types/PostedLanguageModel.d.ts +1 -1
  58. package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +35 -0
  59. package/dist/api/resources/empathicVoice/types/PostedLanguageModelModelResource.js +34 -0
  60. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecs.d.ts +2 -2
  61. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsInactivity.d.ts +1 -1
  62. package/dist/api/resources/empathicVoice/types/PostedTimeoutSpecsMaxDuration.d.ts +1 -1
  63. package/dist/api/resources/empathicVoice/types/PostedVoice.d.ts +2 -2
  64. package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.d.ts +11 -0
  65. package/dist/api/resources/empathicVoice/types/PostedVoiceProvider.js +10 -0
  66. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +35 -0
  67. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +5 -0
  68. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +24 -0
  69. package/dist/api/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +13 -0
  70. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +37 -0
  71. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +5 -0
  72. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +13 -0
  73. package/dist/api/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +10 -0
  74. package/dist/api/resources/empathicVoice/types/ReturnLanguageModel.d.ts +1 -1
  75. package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +35 -0
  76. package/dist/api/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +34 -0
  77. package/dist/api/resources/empathicVoice/types/ReturnTimeoutSpecs.d.ts +2 -2
  78. package/dist/api/resources/empathicVoice/types/ReturnVoice.d.ts +2 -2
  79. package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +11 -0
  80. package/dist/api/resources/empathicVoice/types/ReturnVoiceProvider.js +10 -0
  81. package/dist/api/resources/empathicVoice/types/index.d.ts +8 -0
  82. package/dist/api/resources/empathicVoice/types/index.js +8 -0
  83. package/dist/api/resources/expressionMeasurement/resources/batch/client/Client.js +6 -6
  84. package/dist/api/resources/index.d.ts +1 -1
  85. package/dist/api/resources/index.js +2 -2
  86. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
  87. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
  88. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
  89. package/dist/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
  90. package/dist/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
  91. package/dist/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
  92. package/dist/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
  93. package/dist/serialization/resources/empathicVoice/types/PostedVoiceProvider.js +31 -0
  94. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
  95. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
  96. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
  97. package/dist/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +31 -0
  98. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
  99. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
  100. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
  101. package/dist/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +31 -0
  102. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
  103. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
  104. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
  105. package/dist/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
  106. package/dist/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
  107. package/dist/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
  108. package/dist/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
  109. package/dist/serialization/resources/empathicVoice/types/ReturnVoiceProvider.js +31 -0
  110. package/dist/serialization/resources/empathicVoice/types/index.d.ts +8 -0
  111. package/dist/serialization/resources/empathicVoice/types/index.js +8 -0
  112. package/dist/serialization/resources/index.d.ts +1 -1
  113. package/dist/serialization/resources/index.js +2 -2
  114. package/dist/version.d.ts +1 -1
  115. package/dist/version.js +1 -1
  116. package/package.json +1 -1
  117. package/reference.md +569 -535
  118. package/serialization/resources/empathicVoice/types/PostedLanguageModel.d.ts +2 -1
  119. package/serialization/resources/empathicVoice/types/PostedLanguageModel.js +2 -1
  120. package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.d.ts +10 -0
  121. package/serialization/resources/empathicVoice/types/PostedLanguageModelModelResource.js +58 -0
  122. package/serialization/resources/empathicVoice/types/PostedVoice.d.ts +2 -1
  123. package/serialization/resources/empathicVoice/types/PostedVoice.js +2 -1
  124. package/serialization/resources/empathicVoice/types/PostedVoiceProvider.d.ts +10 -0
  125. package/serialization/resources/empathicVoice/types/PostedVoiceProvider.js +31 -0
  126. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.d.ts +19 -0
  127. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstruction.js +40 -0
  128. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.d.ts +10 -0
  129. package/serialization/resources/empathicVoice/types/ReturnChatAudioReconstructionStatus.js +31 -0
  130. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.d.ts +21 -0
  131. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructions.js +42 -0
  132. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.d.ts +10 -0
  133. package/serialization/resources/empathicVoice/types/ReturnChatGroupPagedAudioReconstructionsPaginationDirection.js +31 -0
  134. package/serialization/resources/empathicVoice/types/ReturnLanguageModel.d.ts +2 -1
  135. package/serialization/resources/empathicVoice/types/ReturnLanguageModel.js +2 -1
  136. package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.d.ts +10 -0
  137. package/serialization/resources/empathicVoice/types/ReturnLanguageModelModelResource.js +58 -0
  138. package/serialization/resources/empathicVoice/types/ReturnVoice.d.ts +2 -1
  139. package/serialization/resources/empathicVoice/types/ReturnVoice.js +2 -1
  140. package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.d.ts +10 -0
  141. package/serialization/resources/empathicVoice/types/ReturnVoiceProvider.js +31 -0
  142. package/serialization/resources/empathicVoice/types/index.d.ts +8 -0
  143. package/serialization/resources/empathicVoice/types/index.js +8 -0
  144. package/serialization/resources/index.d.ts +1 -1
  145. package/serialization/resources/index.js +2 -2
  146. package/version.d.ts +1 -1
  147. package/version.js +1 -1
@@ -648,6 +648,62 @@ types:
648
648
  docs: The provider of the supplemental language model.
649
649
  source:
650
650
  openapi: stenographer-openapi.json
651
+ PostedLanguageModelModelResource:
652
+ enum:
653
+ - value: claude-3-5-sonnet-latest
654
+ name: Claude35SonnetLatest
655
+ - value: claude-3-5-sonnet-20240620
656
+ name: Claude35Sonnet20240620
657
+ - value: claude-3-opus-20240229
658
+ name: Claude3Opus20240229
659
+ - value: claude-3-sonnet-20240229
660
+ name: Claude3Sonnet20240229
661
+ - value: claude-3-haiku-20240307
662
+ name: Claude3Haiku20240307
663
+ - value: claude-2.1
664
+ name: Claude21
665
+ - value: claude-instant-1.2
666
+ name: ClaudeInstant12
667
+ - value: gemini-1.5-pro
668
+ name: Gemini15Pro
669
+ - value: gemini-1.5-flash
670
+ name: Gemini15Flash
671
+ - value: gemini-1.5-pro-002
672
+ name: Gemini15Pro002
673
+ - value: gemini-1.5-flash-002
674
+ name: Gemini15Flash002
675
+ - value: gpt-4-turbo-preview
676
+ name: Gpt4TurboPreview
677
+ - value: gpt-3.5-turbo-0125
678
+ name: Gpt35Turbo0125
679
+ - value: gpt-3.5-turbo
680
+ name: Gpt35Turbo
681
+ - value: gpt-4o
682
+ name: Gpt4O
683
+ - value: gpt-4o-mini
684
+ name: Gpt4OMini
685
+ - value: gemma-7b-it
686
+ name: Gemma7BIt
687
+ - value: llama3-8b-8192
688
+ name: Llama38B8192
689
+ - value: llama3-70b-8192
690
+ name: Llama370B8192
691
+ - value: llama-3.1-70b-versatile
692
+ name: Llama3170BVersatile
693
+ - value: llama-3.1-8b-instant
694
+ name: Llama318BInstant
695
+ - value: accounts/fireworks/models/mixtral-8x7b-instruct
696
+ name: AccountsFireworksModelsMixtral8X7BInstruct
697
+ - value: accounts/fireworks/models/llama-v3p1-405b-instruct
698
+ name: AccountsFireworksModelsLlamaV3P1405BInstruct
699
+ - value: accounts/fireworks/models/llama-v3p1-70b-instruct
700
+ name: AccountsFireworksModelsLlamaV3P170BInstruct
701
+ - value: accounts/fireworks/models/llama-v3p1-8b-instruct
702
+ name: AccountsFireworksModelsLlamaV3P18BInstruct
703
+ - ellm
704
+ docs: String that specifies the language model to use with `model_provider`.
705
+ source:
706
+ openapi: stenographer-openapi.json
651
707
  PostedLanguageModel:
652
708
  docs: A LanguageModel to be posted to the server
653
709
  properties:
@@ -655,7 +711,7 @@ types:
655
711
  type: optional<PostedLanguageModelModelProvider>
656
712
  docs: The provider of the supplemental language model.
657
713
  model_resource:
658
- type: optional<string>
714
+ type: optional<PostedLanguageModelModelResource>
659
715
  docs: String that specifies the language model to use with `model_provider`.
660
716
  temperature:
661
717
  type: optional<float>
@@ -686,7 +742,8 @@ types:
686
742
  seconds (10 minutes).
687
743
 
688
744
 
689
- Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
745
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
746
+ seconds.
690
747
  properties:
691
748
  enabled:
692
749
  type: boolean
@@ -712,7 +769,8 @@ types:
712
769
  seconds (30 minutes).
713
770
 
714
771
 
715
- Accepts a minimum value of 1 second and a maximum value of 1,800 seconds.
772
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
773
+ seconds.
716
774
  properties:
717
775
  enabled:
718
776
  type: boolean
@@ -749,7 +807,7 @@ types:
749
807
  is 600 seconds (10 minutes).
750
808
 
751
809
 
752
- Accepts a minimum value of 1 second and a maximum value of 1,800
810
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
753
811
  seconds.
754
812
  max_duration:
755
813
  type: optional<PostedTimeoutSpecsMaxDuration>
@@ -759,7 +817,7 @@ types:
759
817
  is 1,800 seconds (30 minutes).
760
818
 
761
819
 
762
- Accepts a minimum value of 1 second and a maximum value of 1,800
820
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
763
821
  seconds.
764
822
  source:
765
823
  openapi: stenographer-openapi.json
@@ -784,14 +842,23 @@ types:
784
842
  of the Tool. Each update to the Tool increments its version number.
785
843
  source:
786
844
  openapi: stenographer-openapi.json
845
+ PostedVoiceProvider:
846
+ enum:
847
+ - HUME_AI
848
+ - CUSTOM_VOICE
849
+ docs: >-
850
+ The provider of the voice to use. Supported values are `HUME_AI` and
851
+ `CUSTOM_VOICE`.
852
+ source:
853
+ openapi: stenographer-openapi.json
787
854
  PostedVoice:
788
855
  docs: A Voice specification posted to the server
789
856
  properties:
790
857
  provider:
791
- type: literal<"HUME_AI">
858
+ type: PostedVoiceProvider
792
859
  docs: >-
793
- The provider of the voice to use. Currently, only `HUME_AI` is
794
- supported as the voice provider.
860
+ The provider of the voice to use. Supported values are `HUME_AI` and
861
+ `CUSTOM_VOICE`.
795
862
  name:
796
863
  type: optional<string>
797
864
  docs: >-
@@ -999,6 +1066,62 @@ types:
999
1066
  docs: The provider of the supplemental language model.
1000
1067
  source:
1001
1068
  openapi: stenographer-openapi.json
1069
+ ReturnLanguageModelModelResource:
1070
+ enum:
1071
+ - value: claude-3-5-sonnet-latest
1072
+ name: Claude35SonnetLatest
1073
+ - value: claude-3-5-sonnet-20240620
1074
+ name: Claude35Sonnet20240620
1075
+ - value: claude-3-opus-20240229
1076
+ name: Claude3Opus20240229
1077
+ - value: claude-3-sonnet-20240229
1078
+ name: Claude3Sonnet20240229
1079
+ - value: claude-3-haiku-20240307
1080
+ name: Claude3Haiku20240307
1081
+ - value: claude-2.1
1082
+ name: Claude21
1083
+ - value: claude-instant-1.2
1084
+ name: ClaudeInstant12
1085
+ - value: gemini-1.5-pro
1086
+ name: Gemini15Pro
1087
+ - value: gemini-1.5-flash
1088
+ name: Gemini15Flash
1089
+ - value: gemini-1.5-pro-002
1090
+ name: Gemini15Pro002
1091
+ - value: gemini-1.5-flash-002
1092
+ name: Gemini15Flash002
1093
+ - value: gpt-4-turbo-preview
1094
+ name: Gpt4TurboPreview
1095
+ - value: gpt-3.5-turbo-0125
1096
+ name: Gpt35Turbo0125
1097
+ - value: gpt-3.5-turbo
1098
+ name: Gpt35Turbo
1099
+ - value: gpt-4o
1100
+ name: Gpt4O
1101
+ - value: gpt-4o-mini
1102
+ name: Gpt4OMini
1103
+ - value: gemma-7b-it
1104
+ name: Gemma7BIt
1105
+ - value: llama3-8b-8192
1106
+ name: Llama38B8192
1107
+ - value: llama3-70b-8192
1108
+ name: Llama370B8192
1109
+ - value: llama-3.1-70b-versatile
1110
+ name: Llama3170BVersatile
1111
+ - value: llama-3.1-8b-instant
1112
+ name: Llama318BInstant
1113
+ - value: accounts/fireworks/models/mixtral-8x7b-instruct
1114
+ name: AccountsFireworksModelsMixtral8X7BInstruct
1115
+ - value: accounts/fireworks/models/llama-v3p1-405b-instruct
1116
+ name: AccountsFireworksModelsLlamaV3P1405BInstruct
1117
+ - value: accounts/fireworks/models/llama-v3p1-70b-instruct
1118
+ name: AccountsFireworksModelsLlamaV3P170BInstruct
1119
+ - value: accounts/fireworks/models/llama-v3p1-8b-instruct
1120
+ name: AccountsFireworksModelsLlamaV3P18BInstruct
1121
+ - ellm
1122
+ docs: String that specifies the language model to use with `model_provider`.
1123
+ source:
1124
+ openapi: stenographer-openapi.json
1002
1125
  ReturnLanguageModel:
1003
1126
  docs: A specific LanguageModel
1004
1127
  properties:
@@ -1006,7 +1129,7 @@ types:
1006
1129
  type: optional<ReturnLanguageModelModelProvider>
1007
1130
  docs: The provider of the supplemental language model.
1008
1131
  model_resource:
1009
- type: optional<string>
1132
+ type: optional<ReturnLanguageModelModelResource>
1010
1133
  docs: String that specifies the language model to use with `model_provider`.
1011
1134
  temperature:
1012
1135
  type: optional<float>
@@ -1057,7 +1180,7 @@ types:
1057
1180
  is 600 seconds (10 minutes).
1058
1181
 
1059
1182
 
1060
- Accepts a minimum value of 1 second and a maximum value of 1,800
1183
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
1061
1184
  seconds.
1062
1185
  max_duration:
1063
1186
  type: ReturnTimeoutSpec
@@ -1067,18 +1190,27 @@ types:
1067
1190
  is 1,800 seconds (30 minutes).
1068
1191
 
1069
1192
 
1070
- Accepts a minimum value of 1 second and a maximum value of 1,800
1193
+ Accepts a minimum value of 30 seconds and a maximum value of 1,800
1071
1194
  seconds.
1072
1195
  source:
1073
1196
  openapi: stenographer-openapi.json
1197
+ ReturnVoiceProvider:
1198
+ enum:
1199
+ - HUME_AI
1200
+ - CUSTOM_VOICE
1201
+ docs: >-
1202
+ The provider of the voice to use. Supported values are `HUME_AI` and
1203
+ `CUSTOM_VOICE`.
1204
+ source:
1205
+ openapi: stenographer-openapi.json
1074
1206
  ReturnVoice:
1075
1207
  docs: A specific voice specification
1076
1208
  properties:
1077
1209
  provider:
1078
- type: literal<"HUME_AI">
1210
+ type: ReturnVoiceProvider
1079
1211
  docs: >-
1080
- The provider of the voice to use. Currently, only `HUME_AI` is
1081
- supported as the voice provider.
1212
+ The provider of the voice to use. Supported values are `HUME_AI` and
1213
+ `CUSTOM_VOICE`.
1082
1214
  name:
1083
1215
  type: optional<string>
1084
1216
  docs: >-
@@ -1632,6 +1764,83 @@ types:
1632
1764
  config: optional<ReturnConfigSpec>
1633
1765
  source:
1634
1766
  openapi: stenographer-openapi.json
1767
+ ReturnChatAudioReconstructionStatus:
1768
+ enum:
1769
+ - QUEUED
1770
+ - IN_PROGRESS
1771
+ - COMPLETE
1772
+ - ERROR
1773
+ - CANCELLED
1774
+ docs: >-
1775
+ Indicates the current state of the audio reconstruction job. There are
1776
+ five possible statuses:
1777
+
1778
+
1779
+ - `QUEUED`: The reconstruction job is waiting to be processed.
1780
+
1781
+
1782
+ - `IN_PROGRESS`: The reconstruction is currently being processed.
1783
+
1784
+
1785
+ - `COMPLETE`: The audio reconstruction is finished and ready for download.
1786
+
1787
+
1788
+ - `ERROR`: An error occurred during the reconstruction process.
1789
+
1790
+
1791
+ - `CANCELED`: The reconstruction job has been canceled.
1792
+ source:
1793
+ openapi: stenographer-openapi.json
1794
+ ReturnChatAudioReconstruction:
1795
+ docs: >-
1796
+ List of chat audio reconstructions returned for the specified page number
1797
+ and page size.
1798
+ properties:
1799
+ id:
1800
+ type: string
1801
+ docs: Identifier for the chat. Formatted as a UUID.
1802
+ user_id:
1803
+ type: string
1804
+ docs: Identifier for the user that owns this chat. Formatted as a UUID.
1805
+ status:
1806
+ type: ReturnChatAudioReconstructionStatus
1807
+ docs: >-
1808
+ Indicates the current state of the audio reconstruction job. There are
1809
+ five possible statuses:
1810
+
1811
+
1812
+ - `QUEUED`: The reconstruction job is waiting to be processed.
1813
+
1814
+
1815
+ - `IN_PROGRESS`: The reconstruction is currently being processed.
1816
+
1817
+
1818
+ - `COMPLETE`: The audio reconstruction is finished and ready for
1819
+ download.
1820
+
1821
+
1822
+ - `ERROR`: An error occurred during the reconstruction process.
1823
+
1824
+
1825
+ - `CANCELED`: The reconstruction job has been canceled.
1826
+ filename:
1827
+ type: optional<string>
1828
+ docs: Name of the chat audio reconstruction file.
1829
+ modified_at:
1830
+ type: optional<long>
1831
+ docs: >-
1832
+ The timestamp of the most recent status change for this audio
1833
+ reconstruction, formatted milliseconds since the Unix epoch.
1834
+ signed_audio_url:
1835
+ type: optional<string>
1836
+ docs: Signed URL used to download the chat audio reconstruction file.
1837
+ signed_url_expiration_timestamp_millis:
1838
+ type: optional<long>
1839
+ docs: >-
1840
+ The timestamp when the signed URL will expire, formatted as a Unix
1841
+ epoch milliseconds.
1842
+ source:
1843
+ openapi: stenographer-openapi.json
1635
1844
  ReturnActiveChatCount:
1636
1845
  docs: A description of current chat chat sessions for a user
1637
1846
  properties:
@@ -1891,6 +2100,70 @@ types:
1891
2100
  type: list<ReturnChatEvent>
1892
2101
  source:
1893
2102
  openapi: stenographer-openapi.json
2103
+ ReturnChatGroupPagedAudioReconstructionsPaginationDirection:
2104
+ enum:
2105
+ - ASC
2106
+ - DESC
2107
+ docs: >-
2108
+ Indicates the order in which the paginated results are presented, based on
2109
+ their creation date.
2110
+
2111
+
2112
+ It shows `ASC` for ascending order (chronological, with the oldest records
2113
+ first) or `DESC` for descending order (reverse-chronological, with the
2114
+ newest records first). This value corresponds to the `ascending_order`
2115
+ query parameter used in the request.
2116
+ source:
2117
+ openapi: stenographer-openapi.json
2118
+ ReturnChatGroupPagedAudioReconstructions:
2119
+ docs: A paginated list of chat reconstructions for a particular chatgroup
2120
+ properties:
2121
+ id:
2122
+ type: string
2123
+ docs: Identifier for the chat group. Formatted as a UUID.
2124
+ user_id:
2125
+ type: string
2126
+ docs: Identifier for the user that owns this chat. Formatted as a UUID.
2127
+ num_chats:
2128
+ type: integer
2129
+ docs: Total number of chats in this chatgroup
2130
+ page_number:
2131
+ type: integer
2132
+ docs: >-
2133
+ The page number of the returned list.
2134
+
2135
+
2136
+ This value corresponds to the `page_number` parameter specified in the
2137
+ request. Pagination uses zero-based indexing.
2138
+ page_size:
2139
+ type: integer
2140
+ docs: >-
2141
+ The maximum number of items returned per page.
2142
+
2143
+
2144
+ This value corresponds to the `page_size` parameter specified in the
2145
+ request.
2146
+ total_pages:
2147
+ type: integer
2148
+ docs: The total number of pages in the collection.
2149
+ pagination_direction:
2150
+ type: ReturnChatGroupPagedAudioReconstructionsPaginationDirection
2151
+ docs: >-
2152
+ Indicates the order in which the paginated results are presented,
2153
+ based on their creation date.
2154
+
2155
+
2156
+ It shows `ASC` for ascending order (chronological, with the oldest
2157
+ records first) or `DESC` for descending order (reverse-chronological,
2158
+ with the newest records first). This value corresponds to the
2159
+ `ascending_order` query parameter used in the request.
2160
+ audio_reconstructions_page:
2161
+ docs: >-
2162
+ List of chat audio reconstructions returned for the specified page
2163
+ number and page size.
2164
+ type: list<ReturnChatAudioReconstruction>
2165
+ source:
2166
+ openapi: stenographer-openapi.json
1894
2167
  PostedPromptSpec:
1895
2168
  docs: A Prompt associated with this Config.
1896
2169
  properties:
@@ -526,6 +526,10 @@ service:
526
526
  path: /v0/evi/chat_groups/{id}/audio
527
527
  method: GET
528
528
  auth: true
529
+ docs: >-
530
+ Fetches a paginated list of audio for each **Chat** within the specified
531
+ **Chat Group**. For more details, see our guide on audio reconstruction
532
+ [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
529
533
  path-parameters:
530
534
  id:
531
535
  type: string
@@ -563,35 +567,33 @@ service:
563
567
  true.
564
568
  response:
565
569
  docs: Success
566
- type: root.ReturnChatPagedEvents
570
+ type: root.ReturnChatGroupPagedAudioReconstructions
567
571
  errors:
568
572
  - root.BadRequestError
569
573
  examples:
570
574
  - path-parameters:
571
- id: id
575
+ id: 369846cf-6ad5-404d-905e-a8acb5cdfc78
576
+ query-parameters:
577
+ page_number: 0
578
+ page_size: 10
579
+ ascending_order: true
572
580
  response:
573
581
  body:
574
- id: id
575
- chat_group_id: chat_group_id
576
- status: ACTIVE
577
- start_timestamp: 1000000
578
- end_timestamp: 1000000
579
- pagination_direction: ASC
580
- events_page:
581
- - id: id
582
- chat_id: chat_id
583
- timestamp: 1000000
584
- role: USER
585
- type: SYSTEM_PROMPT
586
- message_text: message_text
587
- emotion_features: emotion_features
588
- metadata: metadata
589
- metadata: metadata
590
- page_number: 1
591
- page_size: 1
582
+ id: 369846cf-6ad5-404d-905e-a8acb5cdfc78
583
+ user_id: e6235940-cfda-3988-9147-ff531627cf42
584
+ num_chats: 1
585
+ page_number: 0
586
+ page_size: 10
592
587
  total_pages: 1
593
- config:
594
- id: id
595
- version: 1
588
+ pagination_direction: ASC
589
+ audio_reconstructions_page:
590
+ - id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
591
+ user_id: e6235940-cfda-3988-9147-ff531627cf42
592
+ status: COMPLETE
593
+ filename: >-
594
+ e6235940-cfda-3988-9147-ff531627cf42/470a49f6-1dec-4afe-8b61-035d3b2d63b0/reconstructed_audio.mp4
595
+ modified_at: 1729875432555
596
+ signed_audio_url: https://storage.googleapis.com/...etc.
597
+ signed_url_expiration_timestamp_millis: 1730232816964
596
598
  source:
597
599
  openapi: stenographer-openapi.json
@@ -459,6 +459,10 @@ service:
459
459
  path: /v0/evi/chats/{id}/audio
460
460
  method: GET
461
461
  auth: true
462
+ docs: >-
463
+ Fetches the audio of a previous **Chat**. For more details, see our
464
+ guide on audio reconstruction
465
+ [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
462
466
  path-parameters:
463
467
  id:
464
468
  type: string
@@ -466,35 +470,21 @@ service:
466
470
  display-name: Get chat audio
467
471
  response:
468
472
  docs: Success
469
- type: root.ReturnChatPagedEvents
473
+ type: root.ReturnChatAudioReconstruction
470
474
  errors:
471
475
  - root.BadRequestError
472
476
  examples:
473
477
  - path-parameters:
474
- id: id
478
+ id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
475
479
  response:
476
480
  body:
477
- id: id
478
- chat_group_id: chat_group_id
479
- status: ACTIVE
480
- start_timestamp: 1000000
481
- end_timestamp: 1000000
482
- pagination_direction: ASC
483
- events_page:
484
- - id: id
485
- chat_id: chat_id
486
- timestamp: 1000000
487
- role: USER
488
- type: SYSTEM_PROMPT
489
- message_text: message_text
490
- emotion_features: emotion_features
491
- metadata: metadata
492
- metadata: metadata
493
- page_number: 1
494
- page_size: 1
495
- total_pages: 1
496
- config:
497
- id: id
498
- version: 1
481
+ id: 470a49f6-1dec-4afe-8b61-035d3b2d63b0
482
+ user_id: e6235940-cfda-3988-9147-ff531627cf42
483
+ status: COMPLETE
484
+ filename: >-
485
+ e6235940-cfda-3988-9147-ff531627cf42/470a49f6-1dec-4afe-8b61-035d3b2d63b0/reconstructed_audio.mp4
486
+ modified_at: 1729875432555
487
+ signed_audio_url: https://storage.googleapis.com/...etc.
488
+ signed_url_expiration_timestamp_millis: 1730232816964
499
489
  source:
500
490
  openapi: stenographer-openapi.json
@@ -74,6 +74,8 @@ export declare class ChatGroups {
74
74
  */
75
75
  listChatGroupEvents(id: string, request?: Hume.empathicVoice.ChatGroupsListChatGroupEventsRequest, requestOptions?: ChatGroups.RequestOptions): Promise<Hume.empathicVoice.ReturnChatGroupPagedEvents>;
76
76
  /**
77
+ * Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
78
+ *
77
79
  * @param {string} id - Identifier for a chat. Formatted as a UUID.
78
80
  * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request
79
81
  * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -81,9 +83,13 @@ export declare class ChatGroups {
81
83
  * @throws {@link Hume.empathicVoice.BadRequestError}
82
84
  *
83
85
  * @example
84
- * await client.empathicVoice.chatGroups.getAudio("id")
86
+ * await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
87
+ * pageNumber: 0,
88
+ * pageSize: 10,
89
+ * ascendingOrder: true
90
+ * })
85
91
  */
86
- getAudio(id: string, request?: Hume.empathicVoice.ChatGroupsGetAudioRequest, requestOptions?: ChatGroups.RequestOptions): Promise<Hume.empathicVoice.ReturnChatPagedEvents>;
92
+ getAudio(id: string, request?: Hume.empathicVoice.ChatGroupsGetAudioRequest, requestOptions?: ChatGroups.RequestOptions): Promise<Hume.empathicVoice.ReturnChatGroupPagedAudioReconstructions>;
87
93
  protected _getCustomAuthorizationHeaders(): Promise<{
88
94
  "X-Hume-Api-Key": string | undefined;
89
95
  }>;
@@ -85,7 +85,7 @@ class ChatGroups {
85
85
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
86
86
  url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, "v0/evi/chat_groups"),
87
87
  method: "GET",
88
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.3", "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
88
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "hume/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
89
89
  contentType: "application/json",
90
90
  queryParameters: _queryParams,
91
91
  requestType: "json",
@@ -165,7 +165,7 @@ class ChatGroups {
165
165
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
166
166
  url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/chat_groups/${encodeURIComponent(id)}`),
167
167
  method: "GET",
168
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.3", "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
168
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "hume/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
169
169
  contentType: "application/json",
170
170
  queryParameters: _queryParams,
171
171
  requestType: "json",
@@ -245,7 +245,7 @@ class ChatGroups {
245
245
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
246
246
  url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/chat_groups/${encodeURIComponent(id)}/events`),
247
247
  method: "GET",
248
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.3", "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
248
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "hume/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
249
249
  contentType: "application/json",
250
250
  queryParameters: _queryParams,
251
251
  requestType: "json",
@@ -293,6 +293,8 @@ class ChatGroups {
293
293
  });
294
294
  }
295
295
  /**
296
+ * Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
297
+ *
296
298
  * @param {string} id - Identifier for a chat. Formatted as a UUID.
297
299
  * @param {Hume.empathicVoice.ChatGroupsGetAudioRequest} request
298
300
  * @param {ChatGroups.RequestOptions} requestOptions - Request-specific configuration.
@@ -300,7 +302,11 @@ class ChatGroups {
300
302
  * @throws {@link Hume.empathicVoice.BadRequestError}
301
303
  *
302
304
  * @example
303
- * await client.empathicVoice.chatGroups.getAudio("id")
305
+ * await client.empathicVoice.chatGroups.getAudio("369846cf-6ad5-404d-905e-a8acb5cdfc78", {
306
+ * pageNumber: 0,
307
+ * pageSize: 10,
308
+ * ascendingOrder: true
309
+ * })
304
310
  */
305
311
  getAudio(id, request = {}, requestOptions) {
306
312
  var _a, _b;
@@ -319,7 +325,7 @@ class ChatGroups {
319
325
  const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
320
326
  url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.HumeEnvironment.Production, `v0/evi/chat_groups/${encodeURIComponent(id)}/audio`),
321
327
  method: "GET",
322
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.3", "User-Agent": "hume/0.9.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
328
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "hume", "X-Fern-SDK-Version": "0.9.4", "User-Agent": "hume/0.9.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
323
329
  contentType: "application/json",
324
330
  queryParameters: _queryParams,
325
331
  requestType: "json",
@@ -328,7 +334,7 @@ class ChatGroups {
328
334
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
329
335
  });
330
336
  if (_response.ok) {
331
- return serializers.empathicVoice.ReturnChatPagedEvents.parseOrThrow(_response.body, {
337
+ return serializers.empathicVoice.ReturnChatGroupPagedAudioReconstructions.parseOrThrow(_response.body, {
332
338
  unrecognizedObjectKeys: "passthrough",
333
339
  allowUnrecognizedUnionMembers: true,
334
340
  allowUnrecognizedEnumValues: true,
@@ -3,7 +3,11 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * pageNumber: 0,
8
+ * pageSize: 10,
9
+ * ascendingOrder: true
10
+ * }
7
11
  */
8
12
  export interface ChatGroupsGetAudioRequest {
9
13
  /**
@@ -56,15 +56,17 @@ export declare class Chats {
56
56
  */
57
57
  listChatEvents(id: string, request?: Hume.empathicVoice.ChatsListChatEventsRequest, requestOptions?: Chats.RequestOptions): Promise<core.Page<Hume.empathicVoice.ReturnChatEvent>>;
58
58
  /**
59
+ * Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/empathic-voice-interface-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi).
60
+ *
59
61
  * @param {string} id - Identifier for a chat. Formatted as a UUID.
60
62
  * @param {Chats.RequestOptions} requestOptions - Request-specific configuration.
61
63
  *
62
64
  * @throws {@link Hume.empathicVoice.BadRequestError}
63
65
  *
64
66
  * @example
65
- * await client.empathicVoice.chats.getAudio("id")
67
+ * await client.empathicVoice.chats.getAudio("470a49f6-1dec-4afe-8b61-035d3b2d63b0")
66
68
  */
67
- getAudio(id: string, requestOptions?: Chats.RequestOptions): Promise<Hume.empathicVoice.ReturnChatPagedEvents>;
69
+ getAudio(id: string, requestOptions?: Chats.RequestOptions): Promise<Hume.empathicVoice.ReturnChatAudioReconstruction>;
68
70
  protected _getCustomAuthorizationHeaders(): Promise<{
69
71
  "X-Hume-Api-Key": string | undefined;
70
72
  }>;