@corti/sdk 1.0.0-alpha → 1.0.0-alpha.1

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 (399) hide show
  1. package/README.md +126 -44
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/api/errors/ForbiddenError.d.ts +1 -2
  4. package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +6 -0
  5. package/dist/cjs/api/errors/UnprocessableEntityError.js +54 -0
  6. package/dist/cjs/api/errors/index.d.ts +1 -0
  7. package/dist/cjs/api/errors/index.js +1 -0
  8. package/dist/cjs/api/resources/agents/client/Client.d.ts +6 -0
  9. package/dist/cjs/api/resources/agents/client/Client.js +42 -0
  10. package/dist/cjs/api/resources/codes/client/Client.d.ts +15 -3
  11. package/dist/cjs/api/resources/codes/client/Client.js +16 -10
  12. package/dist/cjs/api/resources/codes/client/requests/CodesGeneralPredictRequest.d.ts +16 -4
  13. package/dist/cjs/api/resources/documents/client/Client.js +5 -35
  14. package/dist/cjs/api/resources/interactions/client/Client.js +5 -35
  15. package/dist/cjs/api/resources/recordings/client/Client.js +4 -28
  16. package/dist/cjs/api/resources/stream/client/Client.d.ts +2 -2
  17. package/dist/cjs/api/resources/stream/client/Client.js +4 -2
  18. package/dist/cjs/api/resources/stream/client/Socket.d.ts +1 -1
  19. package/dist/cjs/api/resources/transcribe/client/Client.d.ts +2 -2
  20. package/dist/cjs/api/resources/transcribe/client/Client.js +4 -2
  21. package/dist/cjs/api/resources/transcribe/client/Socket.d.ts +1 -1
  22. package/dist/cjs/api/resources/transcripts/client/Client.js +4 -28
  23. package/dist/cjs/api/types/AgentsErrorResponse.d.ts +12 -0
  24. package/dist/cjs/api/types/AgentsErrorResponse.js +3 -0
  25. package/dist/cjs/api/types/AgentsValidationError.d.ts +8 -0
  26. package/dist/cjs/api/types/AgentsValidationError.js +3 -0
  27. package/dist/cjs/api/types/AgentsValidationErrorErrorsItem.d.ts +4 -0
  28. package/dist/cjs/api/types/AgentsValidationErrorErrorsItem.js +3 -0
  29. package/dist/cjs/api/types/AgentsValidationErrorResponse.d.ts +4 -0
  30. package/dist/cjs/api/types/AgentsValidationErrorResponse.js +3 -0
  31. package/dist/cjs/api/types/CodesFilter.d.ts +11 -0
  32. package/dist/cjs/api/types/CodesFilter.js +3 -0
  33. package/dist/cjs/api/types/CodesGeneralReadResponse.d.ts +2 -0
  34. package/dist/cjs/api/types/CodesGeneralReadResponseAlternativesItem.d.ts +9 -0
  35. package/dist/cjs/api/types/CodesGeneralReadResponseAlternativesItem.js +3 -0
  36. package/dist/cjs/api/types/CodesGeneralReadResponseEvidencesItem.d.ts +6 -2
  37. package/dist/cjs/api/types/CodesGeneralResponse.d.ts +2 -2
  38. package/dist/cjs/api/types/CommonCodingSystemEnum.d.ts +2 -1
  39. package/dist/cjs/api/types/CommonCodingSystemEnum.js +2 -1
  40. package/dist/cjs/api/types/StreamConfigMessage.d.ts +1 -1
  41. package/dist/cjs/api/types/StreamEndMessage.d.ts +1 -2
  42. package/dist/cjs/api/types/StreamEndedMessage.d.ts +1 -2
  43. package/dist/cjs/api/types/StreamErrorMessage.d.ts +1 -1
  44. package/dist/cjs/api/types/StreamFactsMessage.d.ts +1 -1
  45. package/dist/cjs/api/types/StreamFlushMessage.d.ts +1 -2
  46. package/dist/cjs/api/types/StreamFlushedMessage.d.ts +1 -2
  47. package/dist/cjs/api/types/StreamTranscriptMessage.d.ts +1 -1
  48. package/dist/cjs/api/types/StreamUsageMessage.d.ts +1 -2
  49. package/dist/cjs/api/types/TranscribeCommandMessage.d.ts +1 -1
  50. package/dist/cjs/api/types/TranscribeCommandVariable.d.ts +1 -2
  51. package/dist/cjs/api/types/TranscribeConfigMessage.d.ts +1 -1
  52. package/dist/cjs/api/types/TranscribeEndMessage.d.ts +1 -2
  53. package/dist/cjs/api/types/TranscribeEndedMessage.d.ts +1 -2
  54. package/dist/cjs/api/types/TranscribeErrorMessage.d.ts +1 -1
  55. package/dist/cjs/api/types/TranscribeFlushMessage.d.ts +1 -2
  56. package/dist/cjs/api/types/TranscribeFlushedMessage.d.ts +1 -2
  57. package/dist/cjs/api/types/TranscribeFormattingDates.d.ts +4 -4
  58. package/dist/cjs/api/types/TranscribeFormattingDates.js +4 -4
  59. package/dist/cjs/api/types/TranscribeFormattingNumbers.d.ts +2 -2
  60. package/dist/cjs/api/types/TranscribeFormattingNumbers.js +2 -2
  61. package/dist/cjs/api/types/TranscribeFormattingNumericRanges.d.ts +1 -1
  62. package/dist/cjs/api/types/TranscribeFormattingNumericRanges.js +1 -1
  63. package/dist/cjs/api/types/TranscribeFormattingOrdinals.d.ts +1 -0
  64. package/dist/cjs/api/types/TranscribeFormattingOrdinals.js +1 -0
  65. package/dist/cjs/api/types/TranscribeFormattingTimes.d.ts +3 -2
  66. package/dist/cjs/api/types/TranscribeFormattingTimes.js +3 -2
  67. package/dist/cjs/api/types/TranscribeTranscriptMessage.d.ts +1 -1
  68. package/dist/cjs/api/types/TranscribeUsageMessage.d.ts +1 -2
  69. package/dist/cjs/api/types/index.d.ts +6 -19
  70. package/dist/cjs/api/types/index.js +6 -19
  71. package/dist/cjs/auth/OAuthAuthProvider.d.ts +1 -99
  72. package/dist/cjs/auth/OAuthAuthProvider.js +4 -276
  73. package/dist/cjs/core/fetcher/index.d.ts +2 -11
  74. package/dist/cjs/core/fetcher/index.js +16 -15
  75. package/dist/cjs/custom/CortiClient.d.ts +15 -4
  76. package/dist/cjs/custom/CortiClient.js +8 -5
  77. package/dist/cjs/custom/CortiWebSocketProxyClient.d.ts +10 -40
  78. package/dist/cjs/custom/CortiWebSocketProxyClient.js +12 -74
  79. package/dist/cjs/custom/OAuthAuthProvider.d.ts +99 -0
  80. package/dist/cjs/custom/OAuthAuthProvider.js +290 -0
  81. package/dist/cjs/custom/auth/CortiAuth.d.ts +129 -0
  82. package/dist/cjs/custom/auth/CortiAuth.js +195 -0
  83. package/dist/cjs/custom/auth/OAuthAuthCodeAuthProvider.d.ts +23 -0
  84. package/dist/cjs/custom/auth/OAuthAuthCodeAuthProvider.js +164 -0
  85. package/dist/cjs/custom/auth/OAuthPkceAuthProvider.d.ts +23 -0
  86. package/dist/cjs/custom/auth/OAuthPkceAuthProvider.js +164 -0
  87. package/dist/cjs/custom/auth/OAuthRopcAuthProvider.d.ts +22 -0
  88. package/dist/cjs/custom/auth/OAuthRopcAuthProvider.js +137 -0
  89. package/dist/cjs/custom/fetcher.d.ts +3 -0
  90. package/dist/cjs/custom/fetcher.js +8 -0
  91. package/dist/cjs/custom/index.d.ts +10 -0
  92. package/dist/cjs/custom/index.js +55 -1
  93. package/dist/cjs/custom/overrides/OAuthAuthProvider.d.ts +99 -0
  94. package/dist/cjs/custom/overrides/OAuthAuthProvider.js +289 -0
  95. package/dist/cjs/custom/overrides/fetcher/index.d.ts +12 -0
  96. package/dist/cjs/custom/overrides/fetcher/index.js +18 -0
  97. package/dist/cjs/custom/overrides/index.d.ts +14 -0
  98. package/dist/cjs/custom/overrides/index.js +61 -0
  99. package/dist/cjs/custom/proxy/CustomProxyStream.d.ts +17 -0
  100. package/dist/cjs/custom/proxy/CustomProxyStream.js +18 -0
  101. package/dist/cjs/custom/proxy/CustomProxyTranscribe.d.ts +17 -0
  102. package/dist/cjs/custom/proxy/CustomProxyTranscribe.js +21 -0
  103. package/dist/cjs/custom/stream/CustomStream.d.ts +39 -0
  104. package/dist/cjs/custom/stream/CustomStream.js +183 -0
  105. package/dist/cjs/custom/stream/CustomStreamSocket.d.ts +7 -0
  106. package/dist/cjs/custom/stream/CustomStreamSocket.js +17 -0
  107. package/dist/cjs/custom/stream/parseStreamResponseType.d.ts +2 -0
  108. package/dist/cjs/custom/stream/parseStreamResponseType.js +49 -0
  109. package/dist/cjs/custom/transcribe/CustomTranscribe.d.ts +38 -0
  110. package/dist/cjs/custom/transcribe/CustomTranscribe.js +181 -0
  111. package/dist/cjs/custom/transcribe/CustomTranscribeSocket.d.ts +7 -0
  112. package/dist/cjs/custom/transcribe/CustomTranscribeSocket.js +17 -0
  113. package/dist/cjs/custom/transcribe/parseTranscribeResponseType.d.ts +2 -0
  114. package/dist/cjs/custom/transcribe/parseTranscribeResponseType.js +49 -0
  115. package/dist/cjs/custom/utils/encodeHeadersAsWsProtocols.d.ts +30 -0
  116. package/dist/cjs/custom/utils/encodeHeadersAsWsProtocols.js +102 -0
  117. package/dist/cjs/custom/utils/index.d.ts +3 -0
  118. package/dist/cjs/custom/utils/index.js +10 -0
  119. package/dist/cjs/custom/utils/localStorageHelpers.js +11 -9
  120. package/dist/cjs/custom/utils/withCredentialsConfig.d.ts +2 -0
  121. package/dist/cjs/custom/utils/withCredentialsConfig.js +15 -0
  122. package/dist/cjs/index.d.ts +1 -16
  123. package/dist/cjs/index.js +1 -47
  124. package/dist/cjs/serialization/resources/codes/client/requests/CodesGeneralPredictRequest.d.ts +2 -1
  125. package/dist/cjs/serialization/resources/codes/client/requests/CodesGeneralPredictRequest.js +2 -1
  126. package/dist/cjs/serialization/resources/stream/client/socket/StreamSocketResponse.d.ts +2 -2
  127. package/dist/cjs/serialization/resources/stream/client/socket/StreamSocketResponse.js +1 -1
  128. package/dist/cjs/serialization/resources/transcribe/client/socket/TranscribeSocketResponse.d.ts +2 -2
  129. package/dist/cjs/serialization/resources/transcribe/client/socket/TranscribeSocketResponse.js +1 -1
  130. package/dist/cjs/serialization/types/AgentsErrorResponse.d.ts +13 -0
  131. package/dist/cjs/serialization/types/AgentsErrorResponse.js +46 -0
  132. package/dist/cjs/serialization/types/AgentsValidationError.d.ts +14 -0
  133. package/dist/cjs/serialization/types/AgentsValidationError.js +46 -0
  134. package/dist/cjs/serialization/types/AgentsValidationErrorErrorsItem.d.ts +10 -0
  135. package/dist/cjs/serialization/types/AgentsValidationErrorErrorsItem.js +42 -0
  136. package/dist/cjs/serialization/types/AgentsValidationErrorResponse.d.ts +10 -0
  137. package/dist/cjs/serialization/types/AgentsValidationErrorResponse.js +45 -0
  138. package/dist/cjs/serialization/types/CodesFilter.d.ts +11 -0
  139. package/dist/cjs/serialization/types/CodesFilter.js +43 -0
  140. package/dist/cjs/serialization/types/CodesGeneralReadResponse.d.ts +2 -0
  141. package/dist/cjs/serialization/types/CodesGeneralReadResponse.js +2 -0
  142. package/dist/cjs/serialization/types/CodesGeneralReadResponseAlternativesItem.d.ts +10 -0
  143. package/dist/cjs/serialization/types/CodesGeneralReadResponseAlternativesItem.js +42 -0
  144. package/dist/cjs/serialization/types/CodesGeneralReadResponseEvidencesItem.d.ts +4 -2
  145. package/dist/cjs/serialization/types/CodesGeneralReadResponseEvidencesItem.js +4 -2
  146. package/dist/cjs/serialization/types/CommonCodingSystemEnum.d.ts +1 -1
  147. package/dist/cjs/serialization/types/CommonCodingSystemEnum.js +1 -1
  148. package/dist/cjs/serialization/types/StreamConfigMessage.d.ts +1 -2
  149. package/dist/cjs/serialization/types/StreamConfigMessage.js +1 -2
  150. package/dist/cjs/serialization/types/StreamEndMessage.d.ts +1 -2
  151. package/dist/cjs/serialization/types/StreamEndMessage.js +1 -2
  152. package/dist/cjs/serialization/types/StreamEndedMessage.d.ts +1 -2
  153. package/dist/cjs/serialization/types/StreamEndedMessage.js +1 -2
  154. package/dist/cjs/serialization/types/StreamErrorMessage.d.ts +1 -2
  155. package/dist/cjs/serialization/types/StreamErrorMessage.js +1 -2
  156. package/dist/cjs/serialization/types/StreamFactsMessage.d.ts +1 -2
  157. package/dist/cjs/serialization/types/StreamFactsMessage.js +1 -2
  158. package/dist/cjs/serialization/types/StreamFlushMessage.d.ts +1 -2
  159. package/dist/cjs/serialization/types/StreamFlushMessage.js +1 -2
  160. package/dist/cjs/serialization/types/StreamFlushedMessage.d.ts +1 -2
  161. package/dist/cjs/serialization/types/StreamFlushedMessage.js +1 -2
  162. package/dist/cjs/serialization/types/StreamTranscriptMessage.d.ts +1 -2
  163. package/dist/cjs/serialization/types/StreamTranscriptMessage.js +1 -2
  164. package/dist/cjs/serialization/types/StreamUsageMessage.d.ts +1 -2
  165. package/dist/cjs/serialization/types/StreamUsageMessage.js +1 -2
  166. package/dist/cjs/serialization/types/TranscribeCommandMessage.d.ts +1 -2
  167. package/dist/cjs/serialization/types/TranscribeCommandMessage.js +1 -2
  168. package/dist/cjs/serialization/types/TranscribeCommandVariable.d.ts +1 -2
  169. package/dist/cjs/serialization/types/TranscribeCommandVariable.js +1 -2
  170. package/dist/cjs/serialization/types/TranscribeConfigMessage.d.ts +1 -2
  171. package/dist/cjs/serialization/types/TranscribeConfigMessage.js +1 -2
  172. package/dist/cjs/serialization/types/TranscribeEndMessage.d.ts +1 -2
  173. package/dist/cjs/serialization/types/TranscribeEndMessage.js +1 -2
  174. package/dist/cjs/serialization/types/TranscribeEndedMessage.d.ts +1 -2
  175. package/dist/cjs/serialization/types/TranscribeEndedMessage.js +1 -2
  176. package/dist/cjs/serialization/types/TranscribeErrorMessage.d.ts +1 -2
  177. package/dist/cjs/serialization/types/TranscribeErrorMessage.js +1 -2
  178. package/dist/cjs/serialization/types/TranscribeFlushMessage.d.ts +1 -2
  179. package/dist/cjs/serialization/types/TranscribeFlushMessage.js +1 -2
  180. package/dist/cjs/serialization/types/TranscribeFlushedMessage.d.ts +1 -2
  181. package/dist/cjs/serialization/types/TranscribeFlushedMessage.js +1 -2
  182. package/dist/cjs/serialization/types/TranscribeFormattingDates.d.ts +1 -1
  183. package/dist/cjs/serialization/types/TranscribeFormattingDates.js +1 -1
  184. package/dist/cjs/serialization/types/TranscribeFormattingNumbers.d.ts +1 -1
  185. package/dist/cjs/serialization/types/TranscribeFormattingNumbers.js +1 -1
  186. package/dist/cjs/serialization/types/TranscribeFormattingNumericRanges.d.ts +1 -1
  187. package/dist/cjs/serialization/types/TranscribeFormattingNumericRanges.js +1 -1
  188. package/dist/cjs/serialization/types/TranscribeFormattingOrdinals.d.ts +1 -1
  189. package/dist/cjs/serialization/types/TranscribeFormattingOrdinals.js +1 -1
  190. package/dist/cjs/serialization/types/TranscribeFormattingTimes.d.ts +1 -1
  191. package/dist/cjs/serialization/types/TranscribeFormattingTimes.js +1 -1
  192. package/dist/cjs/serialization/types/TranscribeTranscriptMessage.d.ts +1 -2
  193. package/dist/cjs/serialization/types/TranscribeTranscriptMessage.js +1 -2
  194. package/dist/cjs/serialization/types/TranscribeUsageMessage.d.ts +1 -2
  195. package/dist/cjs/serialization/types/TranscribeUsageMessage.js +1 -2
  196. package/dist/cjs/serialization/types/index.d.ts +6 -19
  197. package/dist/cjs/serialization/types/index.js +6 -19
  198. package/dist/cjs/version.d.ts +1 -1
  199. package/dist/cjs/version.js +1 -1
  200. package/dist/esm/BaseClient.mjs +2 -2
  201. package/dist/esm/api/errors/ForbiddenError.d.mts +1 -2
  202. package/dist/esm/api/errors/UnprocessableEntityError.d.mts +6 -0
  203. package/dist/esm/api/errors/UnprocessableEntityError.mjs +17 -0
  204. package/dist/esm/api/errors/index.d.mts +1 -0
  205. package/dist/esm/api/errors/index.mjs +1 -0
  206. package/dist/esm/api/resources/agents/client/Client.d.mts +6 -0
  207. package/dist/esm/api/resources/agents/client/Client.mjs +42 -0
  208. package/dist/esm/api/resources/codes/client/Client.d.mts +15 -3
  209. package/dist/esm/api/resources/codes/client/Client.mjs +16 -10
  210. package/dist/esm/api/resources/codes/client/requests/CodesGeneralPredictRequest.d.mts +16 -4
  211. package/dist/esm/api/resources/documents/client/Client.mjs +5 -35
  212. package/dist/esm/api/resources/interactions/client/Client.mjs +5 -35
  213. package/dist/esm/api/resources/recordings/client/Client.mjs +4 -28
  214. package/dist/esm/api/resources/stream/client/Client.d.mts +2 -2
  215. package/dist/esm/api/resources/stream/client/Client.mjs +5 -3
  216. package/dist/esm/api/resources/stream/client/Socket.d.mts +1 -1
  217. package/dist/esm/api/resources/transcribe/client/Client.d.mts +2 -2
  218. package/dist/esm/api/resources/transcribe/client/Client.mjs +5 -3
  219. package/dist/esm/api/resources/transcribe/client/Socket.d.mts +1 -1
  220. package/dist/esm/api/resources/transcripts/client/Client.mjs +4 -28
  221. package/dist/esm/api/types/AgentsErrorResponse.d.mts +12 -0
  222. package/dist/esm/api/types/AgentsErrorResponse.mjs +2 -0
  223. package/dist/esm/api/types/AgentsValidationError.d.mts +8 -0
  224. package/dist/esm/api/types/AgentsValidationError.mjs +2 -0
  225. package/dist/esm/api/types/AgentsValidationErrorErrorsItem.d.mts +4 -0
  226. package/dist/esm/api/types/AgentsValidationErrorErrorsItem.mjs +2 -0
  227. package/dist/esm/api/types/AgentsValidationErrorResponse.d.mts +4 -0
  228. package/dist/esm/api/types/AgentsValidationErrorResponse.mjs +2 -0
  229. package/dist/esm/api/types/CodesFilter.d.mts +11 -0
  230. package/dist/esm/api/types/CodesFilter.mjs +2 -0
  231. package/dist/esm/api/types/CodesGeneralReadResponse.d.mts +2 -0
  232. package/dist/esm/api/types/CodesGeneralReadResponseAlternativesItem.d.mts +9 -0
  233. package/dist/esm/api/types/CodesGeneralReadResponseAlternativesItem.mjs +2 -0
  234. package/dist/esm/api/types/CodesGeneralReadResponseEvidencesItem.d.mts +6 -2
  235. package/dist/esm/api/types/CodesGeneralResponse.d.mts +2 -2
  236. package/dist/esm/api/types/CommonCodingSystemEnum.d.mts +2 -1
  237. package/dist/esm/api/types/CommonCodingSystemEnum.mjs +2 -1
  238. package/dist/esm/api/types/StreamConfigMessage.d.mts +1 -1
  239. package/dist/esm/api/types/StreamEndMessage.d.mts +1 -2
  240. package/dist/esm/api/types/StreamEndedMessage.d.mts +1 -2
  241. package/dist/esm/api/types/StreamErrorMessage.d.mts +1 -1
  242. package/dist/esm/api/types/StreamFactsMessage.d.mts +1 -1
  243. package/dist/esm/api/types/StreamFlushMessage.d.mts +1 -2
  244. package/dist/esm/api/types/StreamFlushedMessage.d.mts +1 -2
  245. package/dist/esm/api/types/StreamTranscriptMessage.d.mts +1 -1
  246. package/dist/esm/api/types/StreamUsageMessage.d.mts +1 -2
  247. package/dist/esm/api/types/TranscribeCommandMessage.d.mts +1 -1
  248. package/dist/esm/api/types/TranscribeCommandVariable.d.mts +1 -2
  249. package/dist/esm/api/types/TranscribeConfigMessage.d.mts +1 -1
  250. package/dist/esm/api/types/TranscribeEndMessage.d.mts +1 -2
  251. package/dist/esm/api/types/TranscribeEndedMessage.d.mts +1 -2
  252. package/dist/esm/api/types/TranscribeErrorMessage.d.mts +1 -1
  253. package/dist/esm/api/types/TranscribeFlushMessage.d.mts +1 -2
  254. package/dist/esm/api/types/TranscribeFlushedMessage.d.mts +1 -2
  255. package/dist/esm/api/types/TranscribeFormattingDates.d.mts +4 -4
  256. package/dist/esm/api/types/TranscribeFormattingDates.mjs +4 -4
  257. package/dist/esm/api/types/TranscribeFormattingNumbers.d.mts +2 -2
  258. package/dist/esm/api/types/TranscribeFormattingNumbers.mjs +2 -2
  259. package/dist/esm/api/types/TranscribeFormattingNumericRanges.d.mts +1 -1
  260. package/dist/esm/api/types/TranscribeFormattingNumericRanges.mjs +1 -1
  261. package/dist/esm/api/types/TranscribeFormattingOrdinals.d.mts +1 -0
  262. package/dist/esm/api/types/TranscribeFormattingOrdinals.mjs +1 -0
  263. package/dist/esm/api/types/TranscribeFormattingTimes.d.mts +3 -2
  264. package/dist/esm/api/types/TranscribeFormattingTimes.mjs +3 -2
  265. package/dist/esm/api/types/TranscribeTranscriptMessage.d.mts +1 -1
  266. package/dist/esm/api/types/TranscribeUsageMessage.d.mts +1 -2
  267. package/dist/esm/api/types/index.d.mts +6 -19
  268. package/dist/esm/api/types/index.mjs +6 -19
  269. package/dist/esm/auth/OAuthAuthProvider.d.mts +1 -99
  270. package/dist/esm/auth/OAuthAuthProvider.mjs +2 -239
  271. package/dist/esm/core/fetcher/index.d.mts +2 -11
  272. package/dist/esm/core/fetcher/index.mjs +2 -6
  273. package/dist/esm/custom/CortiClient.d.mts +15 -4
  274. package/dist/esm/custom/CortiClient.mjs +8 -5
  275. package/dist/esm/custom/CortiWebSocketProxyClient.d.mts +10 -40
  276. package/dist/esm/custom/CortiWebSocketProxyClient.mjs +10 -39
  277. package/dist/esm/custom/OAuthAuthProvider.d.mts +99 -0
  278. package/dist/esm/custom/OAuthAuthProvider.mjs +239 -0
  279. package/dist/esm/custom/auth/CortiAuth.d.mts +129 -0
  280. package/dist/esm/custom/auth/CortiAuth.mjs +158 -0
  281. package/dist/esm/custom/auth/OAuthAuthCodeAuthProvider.d.mts +23 -0
  282. package/dist/esm/custom/auth/OAuthAuthCodeAuthProvider.mjs +127 -0
  283. package/dist/esm/custom/auth/OAuthPkceAuthProvider.d.mts +23 -0
  284. package/dist/esm/custom/auth/OAuthPkceAuthProvider.mjs +127 -0
  285. package/dist/esm/custom/auth/OAuthRopcAuthProvider.d.mts +22 -0
  286. package/dist/esm/custom/auth/OAuthRopcAuthProvider.mjs +100 -0
  287. package/dist/esm/custom/fetcher.d.mts +3 -0
  288. package/dist/esm/custom/fetcher.mjs +4 -0
  289. package/dist/esm/custom/index.d.mts +10 -0
  290. package/dist/esm/custom/index.mjs +10 -0
  291. package/dist/esm/custom/overrides/OAuthAuthProvider.d.mts +99 -0
  292. package/dist/esm/custom/overrides/OAuthAuthProvider.mjs +238 -0
  293. package/dist/esm/custom/overrides/fetcher/index.d.mts +12 -0
  294. package/dist/esm/custom/overrides/fetcher/index.mjs +7 -0
  295. package/dist/esm/custom/overrides/index.d.mts +14 -0
  296. package/dist/esm/custom/overrides/index.mjs +14 -0
  297. package/dist/esm/custom/proxy/CustomProxyStream.d.mts +17 -0
  298. package/dist/esm/custom/proxy/CustomProxyStream.mjs +15 -0
  299. package/dist/esm/custom/proxy/CustomProxyTranscribe.d.mts +17 -0
  300. package/dist/esm/custom/proxy/CustomProxyTranscribe.mjs +18 -0
  301. package/dist/esm/custom/stream/CustomStream.d.mts +39 -0
  302. package/dist/esm/custom/stream/CustomStream.mjs +146 -0
  303. package/dist/esm/custom/stream/CustomStreamSocket.d.mts +7 -0
  304. package/dist/esm/custom/stream/CustomStreamSocket.mjs +13 -0
  305. package/dist/esm/custom/stream/parseStreamResponseType.d.mts +2 -0
  306. package/dist/esm/custom/stream/parseStreamResponseType.mjs +13 -0
  307. package/dist/esm/custom/transcribe/CustomTranscribe.d.mts +38 -0
  308. package/dist/esm/custom/transcribe/CustomTranscribe.mjs +144 -0
  309. package/dist/esm/custom/transcribe/CustomTranscribeSocket.d.mts +7 -0
  310. package/dist/esm/custom/transcribe/CustomTranscribeSocket.mjs +13 -0
  311. package/dist/esm/custom/transcribe/parseTranscribeResponseType.d.mts +2 -0
  312. package/dist/esm/custom/transcribe/parseTranscribeResponseType.mjs +13 -0
  313. package/dist/esm/custom/utils/encodeHeadersAsWsProtocols.d.mts +30 -0
  314. package/dist/esm/custom/utils/encodeHeadersAsWsProtocols.mjs +65 -0
  315. package/dist/esm/custom/utils/index.d.mts +3 -0
  316. package/dist/esm/custom/utils/index.mjs +3 -0
  317. package/dist/esm/custom/utils/localStorageHelpers.mjs +11 -9
  318. package/dist/esm/custom/utils/withCredentialsConfig.d.mts +2 -0
  319. package/dist/esm/custom/utils/withCredentialsConfig.mjs +11 -0
  320. package/dist/esm/index.d.mts +1 -16
  321. package/dist/esm/index.mjs +1 -15
  322. package/dist/esm/serialization/resources/codes/client/requests/CodesGeneralPredictRequest.d.mts +2 -1
  323. package/dist/esm/serialization/resources/codes/client/requests/CodesGeneralPredictRequest.mjs +2 -1
  324. package/dist/esm/serialization/resources/stream/client/socket/StreamSocketResponse.d.mts +2 -2
  325. package/dist/esm/serialization/resources/stream/client/socket/StreamSocketResponse.mjs +1 -1
  326. package/dist/esm/serialization/resources/transcribe/client/socket/TranscribeSocketResponse.d.mts +2 -2
  327. package/dist/esm/serialization/resources/transcribe/client/socket/TranscribeSocketResponse.mjs +1 -1
  328. package/dist/esm/serialization/types/AgentsErrorResponse.d.mts +13 -0
  329. package/dist/esm/serialization/types/AgentsErrorResponse.mjs +10 -0
  330. package/dist/esm/serialization/types/AgentsValidationError.d.mts +14 -0
  331. package/dist/esm/serialization/types/AgentsValidationError.mjs +10 -0
  332. package/dist/esm/serialization/types/AgentsValidationErrorErrorsItem.d.mts +10 -0
  333. package/dist/esm/serialization/types/AgentsValidationErrorErrorsItem.mjs +6 -0
  334. package/dist/esm/serialization/types/AgentsValidationErrorResponse.d.mts +10 -0
  335. package/dist/esm/serialization/types/AgentsValidationErrorResponse.mjs +9 -0
  336. package/dist/esm/serialization/types/CodesFilter.d.mts +11 -0
  337. package/dist/esm/serialization/types/CodesFilter.mjs +7 -0
  338. package/dist/esm/serialization/types/CodesGeneralReadResponse.d.mts +2 -0
  339. package/dist/esm/serialization/types/CodesGeneralReadResponse.mjs +2 -0
  340. package/dist/esm/serialization/types/CodesGeneralReadResponseAlternativesItem.d.mts +10 -0
  341. package/dist/esm/serialization/types/CodesGeneralReadResponseAlternativesItem.mjs +6 -0
  342. package/dist/esm/serialization/types/CodesGeneralReadResponseEvidencesItem.d.mts +4 -2
  343. package/dist/esm/serialization/types/CodesGeneralReadResponseEvidencesItem.mjs +4 -2
  344. package/dist/esm/serialization/types/CommonCodingSystemEnum.d.mts +1 -1
  345. package/dist/esm/serialization/types/CommonCodingSystemEnum.mjs +1 -1
  346. package/dist/esm/serialization/types/StreamConfigMessage.d.mts +1 -2
  347. package/dist/esm/serialization/types/StreamConfigMessage.mjs +1 -2
  348. package/dist/esm/serialization/types/StreamEndMessage.d.mts +1 -2
  349. package/dist/esm/serialization/types/StreamEndMessage.mjs +1 -2
  350. package/dist/esm/serialization/types/StreamEndedMessage.d.mts +1 -2
  351. package/dist/esm/serialization/types/StreamEndedMessage.mjs +1 -2
  352. package/dist/esm/serialization/types/StreamErrorMessage.d.mts +1 -2
  353. package/dist/esm/serialization/types/StreamErrorMessage.mjs +1 -2
  354. package/dist/esm/serialization/types/StreamFactsMessage.d.mts +1 -2
  355. package/dist/esm/serialization/types/StreamFactsMessage.mjs +1 -2
  356. package/dist/esm/serialization/types/StreamFlushMessage.d.mts +1 -2
  357. package/dist/esm/serialization/types/StreamFlushMessage.mjs +1 -2
  358. package/dist/esm/serialization/types/StreamFlushedMessage.d.mts +1 -2
  359. package/dist/esm/serialization/types/StreamFlushedMessage.mjs +1 -2
  360. package/dist/esm/serialization/types/StreamTranscriptMessage.d.mts +1 -2
  361. package/dist/esm/serialization/types/StreamTranscriptMessage.mjs +1 -2
  362. package/dist/esm/serialization/types/StreamUsageMessage.d.mts +1 -2
  363. package/dist/esm/serialization/types/StreamUsageMessage.mjs +1 -2
  364. package/dist/esm/serialization/types/TranscribeCommandMessage.d.mts +1 -2
  365. package/dist/esm/serialization/types/TranscribeCommandMessage.mjs +1 -2
  366. package/dist/esm/serialization/types/TranscribeCommandVariable.d.mts +1 -2
  367. package/dist/esm/serialization/types/TranscribeCommandVariable.mjs +1 -2
  368. package/dist/esm/serialization/types/TranscribeConfigMessage.d.mts +1 -2
  369. package/dist/esm/serialization/types/TranscribeConfigMessage.mjs +1 -2
  370. package/dist/esm/serialization/types/TranscribeEndMessage.d.mts +1 -2
  371. package/dist/esm/serialization/types/TranscribeEndMessage.mjs +1 -2
  372. package/dist/esm/serialization/types/TranscribeEndedMessage.d.mts +1 -2
  373. package/dist/esm/serialization/types/TranscribeEndedMessage.mjs +1 -2
  374. package/dist/esm/serialization/types/TranscribeErrorMessage.d.mts +1 -2
  375. package/dist/esm/serialization/types/TranscribeErrorMessage.mjs +1 -2
  376. package/dist/esm/serialization/types/TranscribeFlushMessage.d.mts +1 -2
  377. package/dist/esm/serialization/types/TranscribeFlushMessage.mjs +1 -2
  378. package/dist/esm/serialization/types/TranscribeFlushedMessage.d.mts +1 -2
  379. package/dist/esm/serialization/types/TranscribeFlushedMessage.mjs +1 -2
  380. package/dist/esm/serialization/types/TranscribeFormattingDates.d.mts +1 -1
  381. package/dist/esm/serialization/types/TranscribeFormattingDates.mjs +1 -1
  382. package/dist/esm/serialization/types/TranscribeFormattingNumbers.d.mts +1 -1
  383. package/dist/esm/serialization/types/TranscribeFormattingNumbers.mjs +1 -1
  384. package/dist/esm/serialization/types/TranscribeFormattingNumericRanges.d.mts +1 -1
  385. package/dist/esm/serialization/types/TranscribeFormattingNumericRanges.mjs +1 -1
  386. package/dist/esm/serialization/types/TranscribeFormattingOrdinals.d.mts +1 -1
  387. package/dist/esm/serialization/types/TranscribeFormattingOrdinals.mjs +1 -1
  388. package/dist/esm/serialization/types/TranscribeFormattingTimes.d.mts +1 -1
  389. package/dist/esm/serialization/types/TranscribeFormattingTimes.mjs +1 -1
  390. package/dist/esm/serialization/types/TranscribeTranscriptMessage.d.mts +1 -2
  391. package/dist/esm/serialization/types/TranscribeTranscriptMessage.mjs +1 -2
  392. package/dist/esm/serialization/types/TranscribeUsageMessage.d.mts +1 -2
  393. package/dist/esm/serialization/types/TranscribeUsageMessage.mjs +1 -2
  394. package/dist/esm/serialization/types/index.d.mts +6 -19
  395. package/dist/esm/serialization/types/index.mjs +6 -19
  396. package/dist/esm/version.d.mts +1 -1
  397. package/dist/esm/version.mjs +1 -1
  398. package/package.json +10 -120
  399. package/reference.md +0 -2748
package/reference.md DELETED
@@ -1,2748 +0,0 @@
1
- # Reference
2
- ## Auth
3
- <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">getToken</a>({ ...params }) -> Corti.AuthTokenResponse</code></summary>
4
- <dl>
5
- <dd>
6
-
7
- #### 🔌 Usage
8
-
9
- <dl>
10
- <dd>
11
-
12
- <dl>
13
- <dd>
14
-
15
- ```typescript
16
- await client.auth.getToken({
17
- clientId: "client_id",
18
- clientSecret: "client_secret"
19
- });
20
-
21
- ```
22
- </dd>
23
- </dl>
24
- </dd>
25
- </dl>
26
-
27
- #### ⚙️ Parameters
28
-
29
- <dl>
30
- <dd>
31
-
32
- <dl>
33
- <dd>
34
-
35
- **request:** `Corti.OAuthTokenRequest`
36
-
37
- </dd>
38
- </dl>
39
-
40
- <dl>
41
- <dd>
42
-
43
- **requestOptions:** `AuthClient.RequestOptions`
44
-
45
- </dd>
46
- </dl>
47
- </dd>
48
- </dl>
49
-
50
-
51
- </dd>
52
- </dl>
53
- </details>
54
-
55
- <details><summary><code>client.auth.<a href="/src/api/resources/auth/client/Client.ts">token</a>(tenantName, { ...params }) -> Corti.AuthTokenResponse</code></summary>
56
- <dl>
57
- <dd>
58
-
59
- #### 📝 Description
60
-
61
- <dl>
62
- <dd>
63
-
64
- <dl>
65
- <dd>
66
-
67
- Exchange credentials for a short-lived access token. Supports grant_type client_credentials (server-to-server),
68
- authorization_code (with client_secret), authorization_code with PKCE (code_verifier), password (ROPC), or refresh_token. Use the returned access_token in the Authorization header when calling the Corti API.
69
- </dd>
70
- </dl>
71
- </dd>
72
- </dl>
73
-
74
- #### 🔌 Usage
75
-
76
- <dl>
77
- <dd>
78
-
79
- <dl>
80
- <dd>
81
-
82
- ```typescript
83
- await client.auth.token("tenantName", {
84
- clientId: "client_id",
85
- clientSecret: "client_secret",
86
- grantType: "client_credentials"
87
- });
88
-
89
- ```
90
- </dd>
91
- </dl>
92
- </dd>
93
- </dl>
94
-
95
- #### ⚙️ Parameters
96
-
97
- <dl>
98
- <dd>
99
-
100
- <dl>
101
- <dd>
102
-
103
- **tenantName:** `string`
104
-
105
- </dd>
106
- </dl>
107
-
108
- <dl>
109
- <dd>
110
-
111
- **request:** `Corti.AuthTokenRequestBody`
112
-
113
- </dd>
114
- </dl>
115
-
116
- <dl>
117
- <dd>
118
-
119
- **requestOptions:** `AuthClient.RequestOptions`
120
-
121
- </dd>
122
- </dl>
123
- </dd>
124
- </dl>
125
-
126
-
127
- </dd>
128
- </dl>
129
- </details>
130
-
131
- ## Interactions
132
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">list</a>({ ...params }) -> core.Page&lt;Corti.InteractionsGetResponse, Corti.InteractionsListResponse&gt;</code></summary>
133
- <dl>
134
- <dd>
135
-
136
- #### 📝 Description
137
-
138
- <dl>
139
- <dd>
140
-
141
- <dl>
142
- <dd>
143
-
144
- Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
145
- </dd>
146
- </dl>
147
- </dd>
148
- </dl>
149
-
150
- #### 🔌 Usage
151
-
152
- <dl>
153
- <dd>
154
-
155
- <dl>
156
- <dd>
157
-
158
- ```typescript
159
- const pageableResponse = await client.interactions.list();
160
- for await (const item of pageableResponse) {
161
- console.log(item);
162
- }
163
-
164
- // Or you can manually iterate page-by-page
165
- let page = await client.interactions.list();
166
- while (page.hasNextPage()) {
167
- page = page.getNextPage();
168
- }
169
-
170
- // You can also access the underlying response
171
- const response = page.response;
172
-
173
- ```
174
- </dd>
175
- </dl>
176
- </dd>
177
- </dl>
178
-
179
- #### ⚙️ Parameters
180
-
181
- <dl>
182
- <dd>
183
-
184
- <dl>
185
- <dd>
186
-
187
- **request:** `Corti.InteractionsListRequest`
188
-
189
- </dd>
190
- </dl>
191
-
192
- <dl>
193
- <dd>
194
-
195
- **requestOptions:** `InteractionsClient.RequestOptions`
196
-
197
- </dd>
198
- </dl>
199
- </dd>
200
- </dl>
201
-
202
-
203
- </dd>
204
- </dl>
205
- </details>
206
-
207
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">create</a>({ ...params }) -> Corti.InteractionsCreateResponse</code></summary>
208
- <dl>
209
- <dd>
210
-
211
- #### 📝 Description
212
-
213
- <dl>
214
- <dd>
215
-
216
- <dl>
217
- <dd>
218
-
219
- Creates a new interaction.
220
- </dd>
221
- </dl>
222
- </dd>
223
- </dl>
224
-
225
- #### 🔌 Usage
226
-
227
- <dl>
228
- <dd>
229
-
230
- <dl>
231
- <dd>
232
-
233
- ```typescript
234
- await client.interactions.create({
235
- encounter: {
236
- identifier: "identifier",
237
- status: "planned",
238
- type: "first_consultation"
239
- }
240
- });
241
-
242
- ```
243
- </dd>
244
- </dl>
245
- </dd>
246
- </dl>
247
-
248
- #### ⚙️ Parameters
249
-
250
- <dl>
251
- <dd>
252
-
253
- <dl>
254
- <dd>
255
-
256
- **request:** `Corti.InteractionsCreateRequest`
257
-
258
- </dd>
259
- </dl>
260
-
261
- <dl>
262
- <dd>
263
-
264
- **requestOptions:** `InteractionsClient.RequestOptions`
265
-
266
- </dd>
267
- </dl>
268
- </dd>
269
- </dl>
270
-
271
-
272
- </dd>
273
- </dl>
274
- </details>
275
-
276
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">get</a>(id) -> Corti.InteractionsGetResponse</code></summary>
277
- <dl>
278
- <dd>
279
-
280
- #### 📝 Description
281
-
282
- <dl>
283
- <dd>
284
-
285
- <dl>
286
- <dd>
287
-
288
- Retrieves a previously recorded interaction by its unique identifier (interaction ID).
289
- </dd>
290
- </dl>
291
- </dd>
292
- </dl>
293
-
294
- #### 🔌 Usage
295
-
296
- <dl>
297
- <dd>
298
-
299
- <dl>
300
- <dd>
301
-
302
- ```typescript
303
- await client.interactions.get("f47ac10b-58cc-4372-a567-0e02b2c3d479");
304
-
305
- ```
306
- </dd>
307
- </dl>
308
- </dd>
309
- </dl>
310
-
311
- #### ⚙️ Parameters
312
-
313
- <dl>
314
- <dd>
315
-
316
- <dl>
317
- <dd>
318
-
319
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
320
-
321
- </dd>
322
- </dl>
323
-
324
- <dl>
325
- <dd>
326
-
327
- **requestOptions:** `InteractionsClient.RequestOptions`
328
-
329
- </dd>
330
- </dl>
331
- </dd>
332
- </dl>
333
-
334
-
335
- </dd>
336
- </dl>
337
- </details>
338
-
339
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">delete</a>(id) -> void</code></summary>
340
- <dl>
341
- <dd>
342
-
343
- #### 📝 Description
344
-
345
- <dl>
346
- <dd>
347
-
348
- <dl>
349
- <dd>
350
-
351
- Deletes an existing interaction.
352
- </dd>
353
- </dl>
354
- </dd>
355
- </dl>
356
-
357
- #### 🔌 Usage
358
-
359
- <dl>
360
- <dd>
361
-
362
- <dl>
363
- <dd>
364
-
365
- ```typescript
366
- await client.interactions.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479");
367
-
368
- ```
369
- </dd>
370
- </dl>
371
- </dd>
372
- </dl>
373
-
374
- #### ⚙️ Parameters
375
-
376
- <dl>
377
- <dd>
378
-
379
- <dl>
380
- <dd>
381
-
382
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
383
-
384
- </dd>
385
- </dl>
386
-
387
- <dl>
388
- <dd>
389
-
390
- **requestOptions:** `InteractionsClient.RequestOptions`
391
-
392
- </dd>
393
- </dl>
394
- </dd>
395
- </dl>
396
-
397
-
398
- </dd>
399
- </dl>
400
- </details>
401
-
402
- <details><summary><code>client.interactions.<a href="/src/api/resources/interactions/client/Client.ts">update</a>(id, { ...params }) -> Corti.InteractionsGetResponse</code></summary>
403
- <dl>
404
- <dd>
405
-
406
- #### 📝 Description
407
-
408
- <dl>
409
- <dd>
410
-
411
- <dl>
412
- <dd>
413
-
414
- Modifies an existing interaction by updating specific fields without overwriting the entire record.
415
- </dd>
416
- </dl>
417
- </dd>
418
- </dl>
419
-
420
- #### 🔌 Usage
421
-
422
- <dl>
423
- <dd>
424
-
425
- <dl>
426
- <dd>
427
-
428
- ```typescript
429
- await client.interactions.update("f47ac10b-58cc-4372-a567-0e02b2c3d479");
430
-
431
- ```
432
- </dd>
433
- </dl>
434
- </dd>
435
- </dl>
436
-
437
- #### ⚙️ Parameters
438
-
439
- <dl>
440
- <dd>
441
-
442
- <dl>
443
- <dd>
444
-
445
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
446
-
447
- </dd>
448
- </dl>
449
-
450
- <dl>
451
- <dd>
452
-
453
- **request:** `Corti.InteractionsUpdateRequest`
454
-
455
- </dd>
456
- </dl>
457
-
458
- <dl>
459
- <dd>
460
-
461
- **requestOptions:** `InteractionsClient.RequestOptions`
462
-
463
- </dd>
464
- </dl>
465
- </dd>
466
- </dl>
467
-
468
-
469
- </dd>
470
- </dl>
471
- </details>
472
-
473
- ## Recordings
474
- <details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">list</a>(id) -> Corti.RecordingsListResponse</code></summary>
475
- <dl>
476
- <dd>
477
-
478
- #### 📝 Description
479
-
480
- <dl>
481
- <dd>
482
-
483
- <dl>
484
- <dd>
485
-
486
- Retrieve a list of recordings for a given interaction.
487
- </dd>
488
- </dl>
489
- </dd>
490
- </dl>
491
-
492
- #### 🔌 Usage
493
-
494
- <dl>
495
- <dd>
496
-
497
- <dl>
498
- <dd>
499
-
500
- ```typescript
501
- await client.recordings.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
502
-
503
- ```
504
- </dd>
505
- </dl>
506
- </dd>
507
- </dl>
508
-
509
- #### ⚙️ Parameters
510
-
511
- <dl>
512
- <dd>
513
-
514
- <dl>
515
- <dd>
516
-
517
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
518
-
519
- </dd>
520
- </dl>
521
-
522
- <dl>
523
- <dd>
524
-
525
- **requestOptions:** `RecordingsClient.RequestOptions`
526
-
527
- </dd>
528
- </dl>
529
- </dd>
530
- </dl>
531
-
532
-
533
- </dd>
534
- </dl>
535
- </details>
536
-
537
- <details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">get</a>(id, recordingId) -> core.BinaryResponse</code></summary>
538
- <dl>
539
- <dd>
540
-
541
- #### 📝 Description
542
-
543
- <dl>
544
- <dd>
545
-
546
- <dl>
547
- <dd>
548
-
549
- Retrieve a specific recording for a given interaction.
550
- </dd>
551
- </dl>
552
- </dd>
553
- </dl>
554
-
555
- #### 🔌 Usage
556
-
557
- <dl>
558
- <dd>
559
-
560
- <dl>
561
- <dd>
562
-
563
- ```typescript
564
- await client.recordings.get("id", "recordingId");
565
-
566
- ```
567
- </dd>
568
- </dl>
569
- </dd>
570
- </dl>
571
-
572
- #### ⚙️ Parameters
573
-
574
- <dl>
575
- <dd>
576
-
577
- <dl>
578
- <dd>
579
-
580
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
581
-
582
- </dd>
583
- </dl>
584
-
585
- <dl>
586
- <dd>
587
-
588
- **recordingId:** `Corti.Uuid` — The unique identifier of the recording. Must be a valid UUID.
589
-
590
- </dd>
591
- </dl>
592
-
593
- <dl>
594
- <dd>
595
-
596
- **requestOptions:** `RecordingsClient.RequestOptions`
597
-
598
- </dd>
599
- </dl>
600
- </dd>
601
- </dl>
602
-
603
-
604
- </dd>
605
- </dl>
606
- </details>
607
-
608
- <details><summary><code>client.recordings.<a href="/src/api/resources/recordings/client/Client.ts">delete</a>(id, recordingId) -> void</code></summary>
609
- <dl>
610
- <dd>
611
-
612
- #### 📝 Description
613
-
614
- <dl>
615
- <dd>
616
-
617
- <dl>
618
- <dd>
619
-
620
- Delete a specific recording for a given interaction.
621
- </dd>
622
- </dl>
623
- </dd>
624
- </dl>
625
-
626
- #### 🔌 Usage
627
-
628
- <dl>
629
- <dd>
630
-
631
- <dl>
632
- <dd>
633
-
634
- ```typescript
635
- await client.recordings.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
636
-
637
- ```
638
- </dd>
639
- </dl>
640
- </dd>
641
- </dl>
642
-
643
- #### ⚙️ Parameters
644
-
645
- <dl>
646
- <dd>
647
-
648
- <dl>
649
- <dd>
650
-
651
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
652
-
653
- </dd>
654
- </dl>
655
-
656
- <dl>
657
- <dd>
658
-
659
- **recordingId:** `Corti.Uuid` — The unique identifier of the recording. Must be a valid UUID.
660
-
661
- </dd>
662
- </dl>
663
-
664
- <dl>
665
- <dd>
666
-
667
- **requestOptions:** `RecordingsClient.RequestOptions`
668
-
669
- </dd>
670
- </dl>
671
- </dd>
672
- </dl>
673
-
674
-
675
- </dd>
676
- </dl>
677
- </details>
678
-
679
- ## Transcripts
680
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">list</a>(id, { ...params }) -> Corti.TranscriptsListResponse</code></summary>
681
- <dl>
682
- <dd>
683
-
684
- #### 📝 Description
685
-
686
- <dl>
687
- <dd>
688
-
689
- <dl>
690
- <dd>
691
-
692
- Retrieves a list of transcripts for a given interaction.
693
- </dd>
694
- </dl>
695
- </dd>
696
- </dl>
697
-
698
- #### 🔌 Usage
699
-
700
- <dl>
701
- <dd>
702
-
703
- <dl>
704
- <dd>
705
-
706
- ```typescript
707
- await client.transcripts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
708
-
709
- ```
710
- </dd>
711
- </dl>
712
- </dd>
713
- </dl>
714
-
715
- #### ⚙️ Parameters
716
-
717
- <dl>
718
- <dd>
719
-
720
- <dl>
721
- <dd>
722
-
723
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
724
-
725
- </dd>
726
- </dl>
727
-
728
- <dl>
729
- <dd>
730
-
731
- **request:** `Corti.TranscriptsListRequest`
732
-
733
- </dd>
734
- </dl>
735
-
736
- <dl>
737
- <dd>
738
-
739
- **requestOptions:** `TranscriptsClient.RequestOptions`
740
-
741
- </dd>
742
- </dl>
743
- </dd>
744
- </dl>
745
-
746
-
747
- </dd>
748
- </dl>
749
- </details>
750
-
751
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">create</a>(id, { ...params }) -> Corti.TranscriptsResponse</code></summary>
752
- <dl>
753
- <dd>
754
-
755
- #### 📝 Description
756
-
757
- <dl>
758
- <dd>
759
-
760
- <dl>
761
- <dd>
762
-
763
- Create a transcript from an audio file attached, via `/recordings` endpoint, to the interaction.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. While audio files up to 60min in total duration, or 150MB in total size, may be attached to an interaction, synchronous processing is only supported for audio files less than ~2min in duration.<br/><br/>If an audio file takes longer to transcribe than the 25sec synchronous processing timeout, then it will continue to process asynchronously. In this scenario, an incomplete or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the final transcript.<br/><br/>The client can poll the Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status changes:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
764
- </dd>
765
- </dl>
766
- </dd>
767
- </dl>
768
-
769
- #### 🔌 Usage
770
-
771
- <dl>
772
- <dd>
773
-
774
- <dl>
775
- <dd>
776
-
777
- ```typescript
778
- await client.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
779
- recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
780
- primaryLanguage: "en"
781
- });
782
-
783
- ```
784
- </dd>
785
- </dl>
786
- </dd>
787
- </dl>
788
-
789
- #### ⚙️ Parameters
790
-
791
- <dl>
792
- <dd>
793
-
794
- <dl>
795
- <dd>
796
-
797
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
798
-
799
- </dd>
800
- </dl>
801
-
802
- <dl>
803
- <dd>
804
-
805
- **request:** `Corti.TranscriptsCreateRequest`
806
-
807
- </dd>
808
- </dl>
809
-
810
- <dl>
811
- <dd>
812
-
813
- **requestOptions:** `TranscriptsClient.RequestOptions`
814
-
815
- </dd>
816
- </dl>
817
- </dd>
818
- </dl>
819
-
820
-
821
- </dd>
822
- </dl>
823
- </details>
824
-
825
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">get</a>(id, transcriptId) -> Corti.TranscriptsResponse</code></summary>
826
- <dl>
827
- <dd>
828
-
829
- #### 📝 Description
830
-
831
- <dl>
832
- <dd>
833
-
834
- <dl>
835
- <dd>
836
-
837
- Retrieve a transcript from a specific interaction.<br/><Note>Each interaction may have more than one transcript associated with it. Use the List Transcript request (`GET /interactions/{id}/transcripts/`) to see all transcriptIds available for the interaction.<br/><br/>The client can poll this Get Transcript endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status changes:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>Status of `completed` indicates the transcript is finalized. If the transcript is retrieved while status is `processing`, then it will be incomplete.</Note>
838
- </dd>
839
- </dl>
840
- </dd>
841
- </dl>
842
-
843
- #### 🔌 Usage
844
-
845
- <dl>
846
- <dd>
847
-
848
- <dl>
849
- <dd>
850
-
851
- ```typescript
852
- await client.transcripts.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
853
-
854
- ```
855
- </dd>
856
- </dl>
857
- </dd>
858
- </dl>
859
-
860
- #### ⚙️ Parameters
861
-
862
- <dl>
863
- <dd>
864
-
865
- <dl>
866
- <dd>
867
-
868
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
869
-
870
- </dd>
871
- </dl>
872
-
873
- <dl>
874
- <dd>
875
-
876
- **transcriptId:** `Corti.Uuid` — The unique identifier of the transcript. Must be a valid UUID.
877
-
878
- </dd>
879
- </dl>
880
-
881
- <dl>
882
- <dd>
883
-
884
- **requestOptions:** `TranscriptsClient.RequestOptions`
885
-
886
- </dd>
887
- </dl>
888
- </dd>
889
- </dl>
890
-
891
-
892
- </dd>
893
- </dl>
894
- </details>
895
-
896
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">delete</a>(id, transcriptId) -> void</code></summary>
897
- <dl>
898
- <dd>
899
-
900
- #### 📝 Description
901
-
902
- <dl>
903
- <dd>
904
-
905
- <dl>
906
- <dd>
907
-
908
- Deletes a specific transcript associated with an interaction.
909
- </dd>
910
- </dl>
911
- </dd>
912
- </dl>
913
-
914
- #### 🔌 Usage
915
-
916
- <dl>
917
- <dd>
918
-
919
- <dl>
920
- <dd>
921
-
922
- ```typescript
923
- await client.transcripts.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
924
-
925
- ```
926
- </dd>
927
- </dl>
928
- </dd>
929
- </dl>
930
-
931
- #### ⚙️ Parameters
932
-
933
- <dl>
934
- <dd>
935
-
936
- <dl>
937
- <dd>
938
-
939
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
940
-
941
- </dd>
942
- </dl>
943
-
944
- <dl>
945
- <dd>
946
-
947
- **transcriptId:** `Corti.Uuid` — The unique identifier of the transcript. Must be a valid UUID.
948
-
949
- </dd>
950
- </dl>
951
-
952
- <dl>
953
- <dd>
954
-
955
- **requestOptions:** `TranscriptsClient.RequestOptions`
956
-
957
- </dd>
958
- </dl>
959
- </dd>
960
- </dl>
961
-
962
-
963
- </dd>
964
- </dl>
965
- </details>
966
-
967
- <details><summary><code>client.transcripts.<a href="/src/api/resources/transcripts/client/Client.ts">getStatus</a>(id, transcriptId) -> Corti.TranscriptsStatusResponse</code></summary>
968
- <dl>
969
- <dd>
970
-
971
- #### 📝 Description
972
-
973
- <dl>
974
- <dd>
975
-
976
- <dl>
977
- <dd>
978
-
979
- Poll for transcript creation status.<br/><Note>Status of `completed` indicates the transcript is finalized.<br/>If the transcript is retrieved while status is `processing`, then it will be incomplete.<br/>Status of `failed` indicate the transcript was not created successfully; please retry.</Note>
980
- </dd>
981
- </dl>
982
- </dd>
983
- </dl>
984
-
985
- #### 🔌 Usage
986
-
987
- <dl>
988
- <dd>
989
-
990
- <dl>
991
- <dd>
992
-
993
- ```typescript
994
- await client.transcripts.getStatus("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
995
-
996
- ```
997
- </dd>
998
- </dl>
999
- </dd>
1000
- </dl>
1001
-
1002
- #### ⚙️ Parameters
1003
-
1004
- <dl>
1005
- <dd>
1006
-
1007
- <dl>
1008
- <dd>
1009
-
1010
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1011
-
1012
- </dd>
1013
- </dl>
1014
-
1015
- <dl>
1016
- <dd>
1017
-
1018
- **transcriptId:** `Corti.Uuid` — The unique identifier of the transcript. Must be a valid UUID.
1019
-
1020
- </dd>
1021
- </dl>
1022
-
1023
- <dl>
1024
- <dd>
1025
-
1026
- **requestOptions:** `TranscriptsClient.RequestOptions`
1027
-
1028
- </dd>
1029
- </dl>
1030
- </dd>
1031
- </dl>
1032
-
1033
-
1034
- </dd>
1035
- </dl>
1036
- </details>
1037
-
1038
- ## Facts
1039
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">factGroupsList</a>() -> Corti.FactsFactGroupsListResponse</code></summary>
1040
- <dl>
1041
- <dd>
1042
-
1043
- #### 📝 Description
1044
-
1045
- <dl>
1046
- <dd>
1047
-
1048
- <dl>
1049
- <dd>
1050
-
1051
- Returns a list of available fact groups, used to categorize facts associated with an interaction.
1052
- </dd>
1053
- </dl>
1054
- </dd>
1055
- </dl>
1056
-
1057
- #### 🔌 Usage
1058
-
1059
- <dl>
1060
- <dd>
1061
-
1062
- <dl>
1063
- <dd>
1064
-
1065
- ```typescript
1066
- await client.facts.factGroupsList();
1067
-
1068
- ```
1069
- </dd>
1070
- </dl>
1071
- </dd>
1072
- </dl>
1073
-
1074
- #### ⚙️ Parameters
1075
-
1076
- <dl>
1077
- <dd>
1078
-
1079
- <dl>
1080
- <dd>
1081
-
1082
- **requestOptions:** `FactsClient.RequestOptions`
1083
-
1084
- </dd>
1085
- </dl>
1086
- </dd>
1087
- </dl>
1088
-
1089
-
1090
- </dd>
1091
- </dl>
1092
- </details>
1093
-
1094
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">list</a>(id) -> Corti.FactsListResponse</code></summary>
1095
- <dl>
1096
- <dd>
1097
-
1098
- #### 📝 Description
1099
-
1100
- <dl>
1101
- <dd>
1102
-
1103
- <dl>
1104
- <dd>
1105
-
1106
- Retrieves a list of facts for a given interaction.
1107
- </dd>
1108
- </dl>
1109
- </dd>
1110
- </dl>
1111
-
1112
- #### 🔌 Usage
1113
-
1114
- <dl>
1115
- <dd>
1116
-
1117
- <dl>
1118
- <dd>
1119
-
1120
- ```typescript
1121
- await client.facts.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
1122
-
1123
- ```
1124
- </dd>
1125
- </dl>
1126
- </dd>
1127
- </dl>
1128
-
1129
- #### ⚙️ Parameters
1130
-
1131
- <dl>
1132
- <dd>
1133
-
1134
- <dl>
1135
- <dd>
1136
-
1137
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1138
-
1139
- </dd>
1140
- </dl>
1141
-
1142
- <dl>
1143
- <dd>
1144
-
1145
- **requestOptions:** `FactsClient.RequestOptions`
1146
-
1147
- </dd>
1148
- </dl>
1149
- </dd>
1150
- </dl>
1151
-
1152
-
1153
- </dd>
1154
- </dl>
1155
- </details>
1156
-
1157
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">create</a>(id, { ...params }) -> Corti.FactsCreateResponse</code></summary>
1158
- <dl>
1159
- <dd>
1160
-
1161
- #### 📝 Description
1162
-
1163
- <dl>
1164
- <dd>
1165
-
1166
- <dl>
1167
- <dd>
1168
-
1169
- Adds new facts to an interaction.
1170
- </dd>
1171
- </dl>
1172
- </dd>
1173
- </dl>
1174
-
1175
- #### 🔌 Usage
1176
-
1177
- <dl>
1178
- <dd>
1179
-
1180
- <dl>
1181
- <dd>
1182
-
1183
- ```typescript
1184
- await client.facts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
1185
- facts: [{
1186
- text: "text",
1187
- group: "other"
1188
- }]
1189
- });
1190
-
1191
- ```
1192
- </dd>
1193
- </dl>
1194
- </dd>
1195
- </dl>
1196
-
1197
- #### ⚙️ Parameters
1198
-
1199
- <dl>
1200
- <dd>
1201
-
1202
- <dl>
1203
- <dd>
1204
-
1205
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1206
-
1207
- </dd>
1208
- </dl>
1209
-
1210
- <dl>
1211
- <dd>
1212
-
1213
- **request:** `Corti.FactsCreateRequest`
1214
-
1215
- </dd>
1216
- </dl>
1217
-
1218
- <dl>
1219
- <dd>
1220
-
1221
- **requestOptions:** `FactsClient.RequestOptions`
1222
-
1223
- </dd>
1224
- </dl>
1225
- </dd>
1226
- </dl>
1227
-
1228
-
1229
- </dd>
1230
- </dl>
1231
- </details>
1232
-
1233
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">batchUpdate</a>(id, { ...params }) -> Corti.FactsBatchUpdateResponse</code></summary>
1234
- <dl>
1235
- <dd>
1236
-
1237
- #### 📝 Description
1238
-
1239
- <dl>
1240
- <dd>
1241
-
1242
- <dl>
1243
- <dd>
1244
-
1245
- Updates multiple facts associated with an interaction.
1246
- </dd>
1247
- </dl>
1248
- </dd>
1249
- </dl>
1250
-
1251
- #### 🔌 Usage
1252
-
1253
- <dl>
1254
- <dd>
1255
-
1256
- <dl>
1257
- <dd>
1258
-
1259
- ```typescript
1260
- await client.facts.batchUpdate("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
1261
- facts: [{
1262
- factId: "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08"
1263
- }]
1264
- });
1265
-
1266
- ```
1267
- </dd>
1268
- </dl>
1269
- </dd>
1270
- </dl>
1271
-
1272
- #### ⚙️ Parameters
1273
-
1274
- <dl>
1275
- <dd>
1276
-
1277
- <dl>
1278
- <dd>
1279
-
1280
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1281
-
1282
- </dd>
1283
- </dl>
1284
-
1285
- <dl>
1286
- <dd>
1287
-
1288
- **request:** `Corti.FactsBatchUpdateRequest`
1289
-
1290
- </dd>
1291
- </dl>
1292
-
1293
- <dl>
1294
- <dd>
1295
-
1296
- **requestOptions:** `FactsClient.RequestOptions`
1297
-
1298
- </dd>
1299
- </dl>
1300
- </dd>
1301
- </dl>
1302
-
1303
-
1304
- </dd>
1305
- </dl>
1306
- </details>
1307
-
1308
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">update</a>(id, factId, { ...params }) -> Corti.FactsUpdateResponse</code></summary>
1309
- <dl>
1310
- <dd>
1311
-
1312
- #### 📝 Description
1313
-
1314
- <dl>
1315
- <dd>
1316
-
1317
- <dl>
1318
- <dd>
1319
-
1320
- Updates an existing fact associated with a specific interaction.
1321
- </dd>
1322
- </dl>
1323
- </dd>
1324
- </dl>
1325
-
1326
- #### 🔌 Usage
1327
-
1328
- <dl>
1329
- <dd>
1330
-
1331
- <dl>
1332
- <dd>
1333
-
1334
- ```typescript
1335
- await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08");
1336
-
1337
- ```
1338
- </dd>
1339
- </dl>
1340
- </dd>
1341
- </dl>
1342
-
1343
- #### ⚙️ Parameters
1344
-
1345
- <dl>
1346
- <dd>
1347
-
1348
- <dl>
1349
- <dd>
1350
-
1351
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1352
-
1353
- </dd>
1354
- </dl>
1355
-
1356
- <dl>
1357
- <dd>
1358
-
1359
- **factId:** `string` — The unique identifier of the fact to update. Must be a valid UUID.
1360
-
1361
- </dd>
1362
- </dl>
1363
-
1364
- <dl>
1365
- <dd>
1366
-
1367
- **request:** `Corti.FactsUpdateRequest`
1368
-
1369
- </dd>
1370
- </dl>
1371
-
1372
- <dl>
1373
- <dd>
1374
-
1375
- **requestOptions:** `FactsClient.RequestOptions`
1376
-
1377
- </dd>
1378
- </dl>
1379
- </dd>
1380
- </dl>
1381
-
1382
-
1383
- </dd>
1384
- </dl>
1385
- </details>
1386
-
1387
- <details><summary><code>client.facts.<a href="/src/api/resources/facts/client/Client.ts">extract</a>({ ...params }) -> Corti.FactsExtractResponse</code></summary>
1388
- <dl>
1389
- <dd>
1390
-
1391
- #### 📝 Description
1392
-
1393
- <dl>
1394
- <dd>
1395
-
1396
- <dl>
1397
- <dd>
1398
-
1399
- Extract facts from provided text, without storing them.
1400
- </dd>
1401
- </dl>
1402
- </dd>
1403
- </dl>
1404
-
1405
- #### 🔌 Usage
1406
-
1407
- <dl>
1408
- <dd>
1409
-
1410
- <dl>
1411
- <dd>
1412
-
1413
- ```typescript
1414
- await client.facts.extract({
1415
- context: [{
1416
- type: "text",
1417
- text: "text"
1418
- }],
1419
- outputLanguage: "outputLanguage"
1420
- });
1421
-
1422
- ```
1423
- </dd>
1424
- </dl>
1425
- </dd>
1426
- </dl>
1427
-
1428
- #### ⚙️ Parameters
1429
-
1430
- <dl>
1431
- <dd>
1432
-
1433
- <dl>
1434
- <dd>
1435
-
1436
- **request:** `Corti.FactsExtractRequest`
1437
-
1438
- </dd>
1439
- </dl>
1440
-
1441
- <dl>
1442
- <dd>
1443
-
1444
- **requestOptions:** `FactsClient.RequestOptions`
1445
-
1446
- </dd>
1447
- </dl>
1448
- </dd>
1449
- </dl>
1450
-
1451
-
1452
- </dd>
1453
- </dl>
1454
- </details>
1455
-
1456
- ## Documents
1457
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">list</a>(id) -> Corti.DocumentsListResponse</code></summary>
1458
- <dl>
1459
- <dd>
1460
-
1461
- #### 📝 Description
1462
-
1463
- <dl>
1464
- <dd>
1465
-
1466
- <dl>
1467
- <dd>
1468
-
1469
- List Documents
1470
- </dd>
1471
- </dl>
1472
- </dd>
1473
- </dl>
1474
-
1475
- #### 🔌 Usage
1476
-
1477
- <dl>
1478
- <dd>
1479
-
1480
- <dl>
1481
- <dd>
1482
-
1483
- ```typescript
1484
- await client.documents.list("f47ac10b-58cc-4372-a567-0e02b2c3d479");
1485
-
1486
- ```
1487
- </dd>
1488
- </dl>
1489
- </dd>
1490
- </dl>
1491
-
1492
- #### ⚙️ Parameters
1493
-
1494
- <dl>
1495
- <dd>
1496
-
1497
- <dl>
1498
- <dd>
1499
-
1500
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1501
-
1502
- </dd>
1503
- </dl>
1504
-
1505
- <dl>
1506
- <dd>
1507
-
1508
- **requestOptions:** `DocumentsClient.RequestOptions`
1509
-
1510
- </dd>
1511
- </dl>
1512
- </dd>
1513
- </dl>
1514
-
1515
-
1516
- </dd>
1517
- </dl>
1518
- </details>
1519
-
1520
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">create</a>(id, { ...params }) -> Corti.DocumentsGetResponse</code></summary>
1521
- <dl>
1522
- <dd>
1523
-
1524
- #### 📝 Description
1525
-
1526
- <dl>
1527
- <dd>
1528
-
1529
- <dl>
1530
- <dd>
1531
-
1532
- This endpoint offers different ways to generate a document. Find guides to document generation [here](/textgen/documents-standard).
1533
- </dd>
1534
- </dl>
1535
- </dd>
1536
- </dl>
1537
-
1538
- #### 🔌 Usage
1539
-
1540
- <dl>
1541
- <dd>
1542
-
1543
- <dl>
1544
- <dd>
1545
-
1546
- ```typescript
1547
- await client.documents.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
1548
- context: [{
1549
- type: "facts",
1550
- data: [{
1551
- text: "text"
1552
- }]
1553
- }],
1554
- templateKey: "templateKey",
1555
- outputLanguage: "outputLanguage"
1556
- });
1557
-
1558
- ```
1559
- </dd>
1560
- </dl>
1561
- </dd>
1562
- </dl>
1563
-
1564
- #### ⚙️ Parameters
1565
-
1566
- <dl>
1567
- <dd>
1568
-
1569
- <dl>
1570
- <dd>
1571
-
1572
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1573
-
1574
- </dd>
1575
- </dl>
1576
-
1577
- <dl>
1578
- <dd>
1579
-
1580
- **request:** `Corti.DocumentsCreateRequest`
1581
-
1582
- </dd>
1583
- </dl>
1584
-
1585
- <dl>
1586
- <dd>
1587
-
1588
- **requestOptions:** `DocumentsClient.RequestOptions`
1589
-
1590
- </dd>
1591
- </dl>
1592
- </dd>
1593
- </dl>
1594
-
1595
-
1596
- </dd>
1597
- </dl>
1598
- </details>
1599
-
1600
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">get</a>(id, documentId) -> Corti.DocumentsGetResponse</code></summary>
1601
- <dl>
1602
- <dd>
1603
-
1604
- #### 📝 Description
1605
-
1606
- <dl>
1607
- <dd>
1608
-
1609
- <dl>
1610
- <dd>
1611
-
1612
- Get Document.
1613
- </dd>
1614
- </dl>
1615
- </dd>
1616
- </dl>
1617
-
1618
- #### 🔌 Usage
1619
-
1620
- <dl>
1621
- <dd>
1622
-
1623
- <dl>
1624
- <dd>
1625
-
1626
- ```typescript
1627
- await client.documents.get("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1628
-
1629
- ```
1630
- </dd>
1631
- </dl>
1632
- </dd>
1633
- </dl>
1634
-
1635
- #### ⚙️ Parameters
1636
-
1637
- <dl>
1638
- <dd>
1639
-
1640
- <dl>
1641
- <dd>
1642
-
1643
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1644
-
1645
- </dd>
1646
- </dl>
1647
-
1648
- <dl>
1649
- <dd>
1650
-
1651
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1652
-
1653
- </dd>
1654
- </dl>
1655
-
1656
- <dl>
1657
- <dd>
1658
-
1659
- **requestOptions:** `DocumentsClient.RequestOptions`
1660
-
1661
- </dd>
1662
- </dl>
1663
- </dd>
1664
- </dl>
1665
-
1666
-
1667
- </dd>
1668
- </dl>
1669
- </details>
1670
-
1671
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">delete</a>(id, documentId) -> void</code></summary>
1672
- <dl>
1673
- <dd>
1674
-
1675
- #### 🔌 Usage
1676
-
1677
- <dl>
1678
- <dd>
1679
-
1680
- <dl>
1681
- <dd>
1682
-
1683
- ```typescript
1684
- await client.documents.delete("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1685
-
1686
- ```
1687
- </dd>
1688
- </dl>
1689
- </dd>
1690
- </dl>
1691
-
1692
- #### ⚙️ Parameters
1693
-
1694
- <dl>
1695
- <dd>
1696
-
1697
- <dl>
1698
- <dd>
1699
-
1700
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1701
-
1702
- </dd>
1703
- </dl>
1704
-
1705
- <dl>
1706
- <dd>
1707
-
1708
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1709
-
1710
- </dd>
1711
- </dl>
1712
-
1713
- <dl>
1714
- <dd>
1715
-
1716
- **requestOptions:** `DocumentsClient.RequestOptions`
1717
-
1718
- </dd>
1719
- </dl>
1720
- </dd>
1721
- </dl>
1722
-
1723
-
1724
- </dd>
1725
- </dl>
1726
- </details>
1727
-
1728
- <details><summary><code>client.documents.<a href="/src/api/resources/documents/client/Client.ts">update</a>(id, documentId, { ...params }) -> Corti.DocumentsGetResponse</code></summary>
1729
- <dl>
1730
- <dd>
1731
-
1732
- #### 🔌 Usage
1733
-
1734
- <dl>
1735
- <dd>
1736
-
1737
- <dl>
1738
- <dd>
1739
-
1740
- ```typescript
1741
- await client.documents.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "f47ac10b-58cc-4372-a567-0e02b2c3d479");
1742
-
1743
- ```
1744
- </dd>
1745
- </dl>
1746
- </dd>
1747
- </dl>
1748
-
1749
- #### ⚙️ Parameters
1750
-
1751
- <dl>
1752
- <dd>
1753
-
1754
- <dl>
1755
- <dd>
1756
-
1757
- **id:** `Corti.Uuid` — The unique identifier of the interaction. Must be a valid UUID.
1758
-
1759
- </dd>
1760
- </dl>
1761
-
1762
- <dl>
1763
- <dd>
1764
-
1765
- **documentId:** `Corti.Uuid` — The document ID representing the context for the request. Must be a valid UUID.
1766
-
1767
- </dd>
1768
- </dl>
1769
-
1770
- <dl>
1771
- <dd>
1772
-
1773
- **request:** `Corti.DocumentsUpdateRequest`
1774
-
1775
- </dd>
1776
- </dl>
1777
-
1778
- <dl>
1779
- <dd>
1780
-
1781
- **requestOptions:** `DocumentsClient.RequestOptions`
1782
-
1783
- </dd>
1784
- </dl>
1785
- </dd>
1786
- </dl>
1787
-
1788
-
1789
- </dd>
1790
- </dl>
1791
- </details>
1792
-
1793
- ## Templates
1794
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">sectionList</a>({ ...params }) -> Corti.TemplatesSectionListResponse</code></summary>
1795
- <dl>
1796
- <dd>
1797
-
1798
- #### 📝 Description
1799
-
1800
- <dl>
1801
- <dd>
1802
-
1803
- <dl>
1804
- <dd>
1805
-
1806
- Retrieves a list of template sections with optional filters for organization and language.
1807
- </dd>
1808
- </dl>
1809
- </dd>
1810
- </dl>
1811
-
1812
- #### 🔌 Usage
1813
-
1814
- <dl>
1815
- <dd>
1816
-
1817
- <dl>
1818
- <dd>
1819
-
1820
- ```typescript
1821
- await client.templates.sectionList();
1822
-
1823
- ```
1824
- </dd>
1825
- </dl>
1826
- </dd>
1827
- </dl>
1828
-
1829
- #### ⚙️ Parameters
1830
-
1831
- <dl>
1832
- <dd>
1833
-
1834
- <dl>
1835
- <dd>
1836
-
1837
- **request:** `Corti.TemplatesSectionListRequest`
1838
-
1839
- </dd>
1840
- </dl>
1841
-
1842
- <dl>
1843
- <dd>
1844
-
1845
- **requestOptions:** `TemplatesClient.RequestOptions`
1846
-
1847
- </dd>
1848
- </dl>
1849
- </dd>
1850
- </dl>
1851
-
1852
-
1853
- </dd>
1854
- </dl>
1855
- </details>
1856
-
1857
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">list</a>({ ...params }) -> Corti.TemplatesListResponse</code></summary>
1858
- <dl>
1859
- <dd>
1860
-
1861
- #### 📝 Description
1862
-
1863
- <dl>
1864
- <dd>
1865
-
1866
- <dl>
1867
- <dd>
1868
-
1869
- Retrieves a list of templates with optional filters for organization, language, and status.
1870
- </dd>
1871
- </dl>
1872
- </dd>
1873
- </dl>
1874
-
1875
- #### 🔌 Usage
1876
-
1877
- <dl>
1878
- <dd>
1879
-
1880
- <dl>
1881
- <dd>
1882
-
1883
- ```typescript
1884
- await client.templates.list();
1885
-
1886
- ```
1887
- </dd>
1888
- </dl>
1889
- </dd>
1890
- </dl>
1891
-
1892
- #### ⚙️ Parameters
1893
-
1894
- <dl>
1895
- <dd>
1896
-
1897
- <dl>
1898
- <dd>
1899
-
1900
- **request:** `Corti.TemplatesListRequest`
1901
-
1902
- </dd>
1903
- </dl>
1904
-
1905
- <dl>
1906
- <dd>
1907
-
1908
- **requestOptions:** `TemplatesClient.RequestOptions`
1909
-
1910
- </dd>
1911
- </dl>
1912
- </dd>
1913
- </dl>
1914
-
1915
-
1916
- </dd>
1917
- </dl>
1918
- </details>
1919
-
1920
- <details><summary><code>client.templates.<a href="/src/api/resources/templates/client/Client.ts">get</a>(key) -> Corti.TemplatesItem</code></summary>
1921
- <dl>
1922
- <dd>
1923
-
1924
- #### 📝 Description
1925
-
1926
- <dl>
1927
- <dd>
1928
-
1929
- <dl>
1930
- <dd>
1931
-
1932
- Retrieves template by key.
1933
- </dd>
1934
- </dl>
1935
- </dd>
1936
- </dl>
1937
-
1938
- #### 🔌 Usage
1939
-
1940
- <dl>
1941
- <dd>
1942
-
1943
- <dl>
1944
- <dd>
1945
-
1946
- ```typescript
1947
- await client.templates.get("key");
1948
-
1949
- ```
1950
- </dd>
1951
- </dl>
1952
- </dd>
1953
- </dl>
1954
-
1955
- #### ⚙️ Parameters
1956
-
1957
- <dl>
1958
- <dd>
1959
-
1960
- <dl>
1961
- <dd>
1962
-
1963
- **key:** `string` — The key of the template
1964
-
1965
- </dd>
1966
- </dl>
1967
-
1968
- <dl>
1969
- <dd>
1970
-
1971
- **requestOptions:** `TemplatesClient.RequestOptions`
1972
-
1973
- </dd>
1974
- </dl>
1975
- </dd>
1976
- </dl>
1977
-
1978
-
1979
- </dd>
1980
- </dl>
1981
- </details>
1982
-
1983
- ## Codes
1984
- <details><summary><code>client.codes.<a href="/src/api/resources/codes/client/Client.ts">predict</a>({ ...params }) -> Corti.CodesGeneralResponse</code></summary>
1985
- <dl>
1986
- <dd>
1987
-
1988
- #### 📝 Description
1989
-
1990
- <dl>
1991
- <dd>
1992
-
1993
- <dl>
1994
- <dd>
1995
-
1996
- Predict medical codes from provided context.<br/><Note>This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, and CPT codes based on input text string or documentId.<br/><br/>More than one code system may be defined in a single request, and the maximum number of codes to return per system can also be defined.<br/><br/>Code prediction requests have two possible values for context:<br/>- `text`: One set of code prediction results will be returned based on all input text defined.<br/>- `documentId`: Code prediction will be based on that defined document only.<br/><br/>The response includes two sets of results:<br/>- `Codes`: Highest confidence bundle of codes, as selected by the code prediction model<br/>- `Candidates`: Full list of candidate codes as predicted by the model, rank sorted by model confidence with maximum possible value of 50.<br/><br/>All predicted code results are based on input context defined in the request only (not other external data or assets associated with an interaction).</Note>
1997
- </dd>
1998
- </dl>
1999
- </dd>
2000
- </dl>
2001
-
2002
- #### 🔌 Usage
2003
-
2004
- <dl>
2005
- <dd>
2006
-
2007
- <dl>
2008
- <dd>
2009
-
2010
- ```typescript
2011
- await client.codes.predict({
2012
- system: ["icd10cm", "cpt"],
2013
- context: [{
2014
- type: "text",
2015
- text: "Short arm splint applied in ED for pain control."
2016
- }],
2017
- maxCandidates: 5
2018
- });
2019
-
2020
- ```
2021
- </dd>
2022
- </dl>
2023
- </dd>
2024
- </dl>
2025
-
2026
- #### ⚙️ Parameters
2027
-
2028
- <dl>
2029
- <dd>
2030
-
2031
- <dl>
2032
- <dd>
2033
-
2034
- **request:** `Corti.CodesGeneralPredictRequest`
2035
-
2036
- </dd>
2037
- </dl>
2038
-
2039
- <dl>
2040
- <dd>
2041
-
2042
- **requestOptions:** `CodesClient.RequestOptions`
2043
-
2044
- </dd>
2045
- </dl>
2046
- </dd>
2047
- </dl>
2048
-
2049
-
2050
- </dd>
2051
- </dl>
2052
- </details>
2053
-
2054
- ## Agents
2055
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>({ ...params }) -> Corti.AgentsAgentResponse[]</code></summary>
2056
- <dl>
2057
- <dd>
2058
-
2059
- #### 📝 Description
2060
-
2061
- <dl>
2062
- <dd>
2063
-
2064
- <dl>
2065
- <dd>
2066
-
2067
- This endpoint retrieves a list of all agents that can be called by the Corti Agent Framework.
2068
- </dd>
2069
- </dl>
2070
- </dd>
2071
- </dl>
2072
-
2073
- #### 🔌 Usage
2074
-
2075
- <dl>
2076
- <dd>
2077
-
2078
- <dl>
2079
- <dd>
2080
-
2081
- ```typescript
2082
- await client.agents.list();
2083
-
2084
- ```
2085
- </dd>
2086
- </dl>
2087
- </dd>
2088
- </dl>
2089
-
2090
- #### ⚙️ Parameters
2091
-
2092
- <dl>
2093
- <dd>
2094
-
2095
- <dl>
2096
- <dd>
2097
-
2098
- **request:** `Corti.AgentsListRequest`
2099
-
2100
- </dd>
2101
- </dl>
2102
-
2103
- <dl>
2104
- <dd>
2105
-
2106
- **requestOptions:** `AgentsClient.RequestOptions`
2107
-
2108
- </dd>
2109
- </dl>
2110
- </dd>
2111
- </dl>
2112
-
2113
-
2114
- </dd>
2115
- </dl>
2116
- </details>
2117
-
2118
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>({ ...params }) -> Corti.AgentsAgent</code></summary>
2119
- <dl>
2120
- <dd>
2121
-
2122
- #### 📝 Description
2123
-
2124
- <dl>
2125
- <dd>
2126
-
2127
- <dl>
2128
- <dd>
2129
-
2130
- This endpoint allows the creation of a new agent that can be utilized in the `POST /agents/{id}/v1/message:send` endpoint.
2131
- </dd>
2132
- </dl>
2133
- </dd>
2134
- </dl>
2135
-
2136
- #### 🔌 Usage
2137
-
2138
- <dl>
2139
- <dd>
2140
-
2141
- <dl>
2142
- <dd>
2143
-
2144
- ```typescript
2145
- await client.agents.create({
2146
- name: "name",
2147
- description: "description"
2148
- });
2149
-
2150
- ```
2151
- </dd>
2152
- </dl>
2153
- </dd>
2154
- </dl>
2155
-
2156
- #### ⚙️ Parameters
2157
-
2158
- <dl>
2159
- <dd>
2160
-
2161
- <dl>
2162
- <dd>
2163
-
2164
- **request:** `Corti.AgentsCreateAgent`
2165
-
2166
- </dd>
2167
- </dl>
2168
-
2169
- <dl>
2170
- <dd>
2171
-
2172
- **requestOptions:** `AgentsClient.RequestOptions`
2173
-
2174
- </dd>
2175
- </dl>
2176
- </dd>
2177
- </dl>
2178
-
2179
-
2180
- </dd>
2181
- </dl>
2182
- </details>
2183
-
2184
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(id) -> Corti.AgentsAgentResponse</code></summary>
2185
- <dl>
2186
- <dd>
2187
-
2188
- #### 📝 Description
2189
-
2190
- <dl>
2191
- <dd>
2192
-
2193
- <dl>
2194
- <dd>
2195
-
2196
- This endpoint retrieves an agent by its identifier. The agent contains information about its capabilities and the experts it can call.
2197
- </dd>
2198
- </dl>
2199
- </dd>
2200
- </dl>
2201
-
2202
- #### 🔌 Usage
2203
-
2204
- <dl>
2205
- <dd>
2206
-
2207
- <dl>
2208
- <dd>
2209
-
2210
- ```typescript
2211
- await client.agents.get("12345678-90ab-cdef-gh12-34567890abc");
2212
-
2213
- ```
2214
- </dd>
2215
- </dl>
2216
- </dd>
2217
- </dl>
2218
-
2219
- #### ⚙️ Parameters
2220
-
2221
- <dl>
2222
- <dd>
2223
-
2224
- <dl>
2225
- <dd>
2226
-
2227
- **id:** `string` — The identifier of the agent associated with the context.
2228
-
2229
- </dd>
2230
- </dl>
2231
-
2232
- <dl>
2233
- <dd>
2234
-
2235
- **requestOptions:** `AgentsClient.RequestOptions`
2236
-
2237
- </dd>
2238
- </dl>
2239
- </dd>
2240
- </dl>
2241
-
2242
-
2243
- </dd>
2244
- </dl>
2245
- </details>
2246
-
2247
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(id) -> void</code></summary>
2248
- <dl>
2249
- <dd>
2250
-
2251
- #### 📝 Description
2252
-
2253
- <dl>
2254
- <dd>
2255
-
2256
- <dl>
2257
- <dd>
2258
-
2259
- This endpoint deletes an agent by its identifier. Once deleted, the agent can no longer be used in threads.
2260
- </dd>
2261
- </dl>
2262
- </dd>
2263
- </dl>
2264
-
2265
- #### 🔌 Usage
2266
-
2267
- <dl>
2268
- <dd>
2269
-
2270
- <dl>
2271
- <dd>
2272
-
2273
- ```typescript
2274
- await client.agents.delete("12345678-90ab-cdef-gh12-34567890abc");
2275
-
2276
- ```
2277
- </dd>
2278
- </dl>
2279
- </dd>
2280
- </dl>
2281
-
2282
- #### ⚙️ Parameters
2283
-
2284
- <dl>
2285
- <dd>
2286
-
2287
- <dl>
2288
- <dd>
2289
-
2290
- **id:** `string` — The identifier of the agent associated with the context.
2291
-
2292
- </dd>
2293
- </dl>
2294
-
2295
- <dl>
2296
- <dd>
2297
-
2298
- **requestOptions:** `AgentsClient.RequestOptions`
2299
-
2300
- </dd>
2301
- </dl>
2302
- </dd>
2303
- </dl>
2304
-
2305
-
2306
- </dd>
2307
- </dl>
2308
- </details>
2309
-
2310
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">update</a>(id, { ...params }) -> Corti.AgentsAgent</code></summary>
2311
- <dl>
2312
- <dd>
2313
-
2314
- #### 📝 Description
2315
-
2316
- <dl>
2317
- <dd>
2318
-
2319
- <dl>
2320
- <dd>
2321
-
2322
- This endpoint updates an existing agent. Only the fields provided in the request body will be updated; other fields will remain unchanged.
2323
- </dd>
2324
- </dl>
2325
- </dd>
2326
- </dl>
2327
-
2328
- #### 🔌 Usage
2329
-
2330
- <dl>
2331
- <dd>
2332
-
2333
- <dl>
2334
- <dd>
2335
-
2336
- ```typescript
2337
- await client.agents.update("12345678-90ab-cdef-gh12-34567890abc");
2338
-
2339
- ```
2340
- </dd>
2341
- </dl>
2342
- </dd>
2343
- </dl>
2344
-
2345
- #### ⚙️ Parameters
2346
-
2347
- <dl>
2348
- <dd>
2349
-
2350
- <dl>
2351
- <dd>
2352
-
2353
- **id:** `string` — The identifier of the agent associated with the context.
2354
-
2355
- </dd>
2356
- </dl>
2357
-
2358
- <dl>
2359
- <dd>
2360
-
2361
- **request:** `Corti.AgentsUpdateAgent`
2362
-
2363
- </dd>
2364
- </dl>
2365
-
2366
- <dl>
2367
- <dd>
2368
-
2369
- **requestOptions:** `AgentsClient.RequestOptions`
2370
-
2371
- </dd>
2372
- </dl>
2373
- </dd>
2374
- </dl>
2375
-
2376
-
2377
- </dd>
2378
- </dl>
2379
- </details>
2380
-
2381
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getCard</a>(id) -> Corti.AgentsAgentCard</code></summary>
2382
- <dl>
2383
- <dd>
2384
-
2385
- #### 📝 Description
2386
-
2387
- <dl>
2388
- <dd>
2389
-
2390
- <dl>
2391
- <dd>
2392
-
2393
- This endpoint retrieves the agent card in JSON format, which provides metadata about the agent, including its name, description, and the experts it can call.
2394
- </dd>
2395
- </dl>
2396
- </dd>
2397
- </dl>
2398
-
2399
- #### 🔌 Usage
2400
-
2401
- <dl>
2402
- <dd>
2403
-
2404
- <dl>
2405
- <dd>
2406
-
2407
- ```typescript
2408
- await client.agents.getCard("12345678-90ab-cdef-gh12-34567890abc");
2409
-
2410
- ```
2411
- </dd>
2412
- </dl>
2413
- </dd>
2414
- </dl>
2415
-
2416
- #### ⚙️ Parameters
2417
-
2418
- <dl>
2419
- <dd>
2420
-
2421
- <dl>
2422
- <dd>
2423
-
2424
- **id:** `string` — The identifier of the agent associated with the context.
2425
-
2426
- </dd>
2427
- </dl>
2428
-
2429
- <dl>
2430
- <dd>
2431
-
2432
- **requestOptions:** `AgentsClient.RequestOptions`
2433
-
2434
- </dd>
2435
- </dl>
2436
- </dd>
2437
- </dl>
2438
-
2439
-
2440
- </dd>
2441
- </dl>
2442
- </details>
2443
-
2444
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">messageSend</a>(id, { ...params }) -> Corti.AgentsMessageSendResponse</code></summary>
2445
- <dl>
2446
- <dd>
2447
-
2448
- #### 📝 Description
2449
-
2450
- <dl>
2451
- <dd>
2452
-
2453
- <dl>
2454
- <dd>
2455
-
2456
- This endpoint sends a message to the specified agent to start or continue a task. The agent processes the message and returns a response. If the message contains a task ID that matches an ongoing task, the agent will continue that task; otherwise, it will start a new task.
2457
- </dd>
2458
- </dl>
2459
- </dd>
2460
- </dl>
2461
-
2462
- #### 🔌 Usage
2463
-
2464
- <dl>
2465
- <dd>
2466
-
2467
- <dl>
2468
- <dd>
2469
-
2470
- ```typescript
2471
- await client.agents.messageSend("12345678-90ab-cdef-gh12-34567890abc", {
2472
- message: {
2473
- role: "user",
2474
- parts: [{
2475
- kind: "text",
2476
- text: "text"
2477
- }],
2478
- messageId: "messageId",
2479
- kind: "message"
2480
- }
2481
- });
2482
-
2483
- ```
2484
- </dd>
2485
- </dl>
2486
- </dd>
2487
- </dl>
2488
-
2489
- #### ⚙️ Parameters
2490
-
2491
- <dl>
2492
- <dd>
2493
-
2494
- <dl>
2495
- <dd>
2496
-
2497
- **id:** `string` — The identifier of the agent associated with the context.
2498
-
2499
- </dd>
2500
- </dl>
2501
-
2502
- <dl>
2503
- <dd>
2504
-
2505
- **request:** `Corti.AgentsMessageSendParams`
2506
-
2507
- </dd>
2508
- </dl>
2509
-
2510
- <dl>
2511
- <dd>
2512
-
2513
- **requestOptions:** `AgentsClient.RequestOptions`
2514
-
2515
- </dd>
2516
- </dl>
2517
- </dd>
2518
- </dl>
2519
-
2520
-
2521
- </dd>
2522
- </dl>
2523
- </details>
2524
-
2525
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getTask</a>(id, taskId, { ...params }) -> Corti.AgentsTask</code></summary>
2526
- <dl>
2527
- <dd>
2528
-
2529
- #### 📝 Description
2530
-
2531
- <dl>
2532
- <dd>
2533
-
2534
- <dl>
2535
- <dd>
2536
-
2537
- This endpoint retrieves the status and details of a specific task associated with the given agent. It provides information about the task's current state, history, and any artifacts produced during its execution.
2538
- </dd>
2539
- </dl>
2540
- </dd>
2541
- </dl>
2542
-
2543
- #### 🔌 Usage
2544
-
2545
- <dl>
2546
- <dd>
2547
-
2548
- <dl>
2549
- <dd>
2550
-
2551
- ```typescript
2552
- await client.agents.getTask("12345678-90ab-cdef-gh12-34567890abc", "taskId");
2553
-
2554
- ```
2555
- </dd>
2556
- </dl>
2557
- </dd>
2558
- </dl>
2559
-
2560
- #### ⚙️ Parameters
2561
-
2562
- <dl>
2563
- <dd>
2564
-
2565
- <dl>
2566
- <dd>
2567
-
2568
- **id:** `string` — The identifier of the agent associated with the context.
2569
-
2570
- </dd>
2571
- </dl>
2572
-
2573
- <dl>
2574
- <dd>
2575
-
2576
- **taskId:** `string` — The identifier of the task to retrieve.
2577
-
2578
- </dd>
2579
- </dl>
2580
-
2581
- <dl>
2582
- <dd>
2583
-
2584
- **request:** `Corti.AgentsGetTaskRequest`
2585
-
2586
- </dd>
2587
- </dl>
2588
-
2589
- <dl>
2590
- <dd>
2591
-
2592
- **requestOptions:** `AgentsClient.RequestOptions`
2593
-
2594
- </dd>
2595
- </dl>
2596
- </dd>
2597
- </dl>
2598
-
2599
-
2600
- </dd>
2601
- </dl>
2602
- </details>
2603
-
2604
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getContext</a>(id, contextId, { ...params }) -> Corti.AgentsContext</code></summary>
2605
- <dl>
2606
- <dd>
2607
-
2608
- #### 📝 Description
2609
-
2610
- <dl>
2611
- <dd>
2612
-
2613
- <dl>
2614
- <dd>
2615
-
2616
- This endpoint retrieves all tasks and top-level messages associated with a specific context for the given agent.
2617
- </dd>
2618
- </dl>
2619
- </dd>
2620
- </dl>
2621
-
2622
- #### 🔌 Usage
2623
-
2624
- <dl>
2625
- <dd>
2626
-
2627
- <dl>
2628
- <dd>
2629
-
2630
- ```typescript
2631
- await client.agents.getContext("12345678-90ab-cdef-gh12-34567890abc", "contextId");
2632
-
2633
- ```
2634
- </dd>
2635
- </dl>
2636
- </dd>
2637
- </dl>
2638
-
2639
- #### ⚙️ Parameters
2640
-
2641
- <dl>
2642
- <dd>
2643
-
2644
- <dl>
2645
- <dd>
2646
-
2647
- **id:** `string` — The identifier of the agent associated with the context.
2648
-
2649
- </dd>
2650
- </dl>
2651
-
2652
- <dl>
2653
- <dd>
2654
-
2655
- **contextId:** `string` — The identifier of the context (thread) to retrieve tasks for.
2656
-
2657
- </dd>
2658
- </dl>
2659
-
2660
- <dl>
2661
- <dd>
2662
-
2663
- **request:** `Corti.AgentsGetContextRequest`
2664
-
2665
- </dd>
2666
- </dl>
2667
-
2668
- <dl>
2669
- <dd>
2670
-
2671
- **requestOptions:** `AgentsClient.RequestOptions`
2672
-
2673
- </dd>
2674
- </dl>
2675
- </dd>
2676
- </dl>
2677
-
2678
-
2679
- </dd>
2680
- </dl>
2681
- </details>
2682
-
2683
- <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">getRegistryExperts</a>({ ...params }) -> Corti.AgentsRegistryExpertsResponse</code></summary>
2684
- <dl>
2685
- <dd>
2686
-
2687
- #### 📝 Description
2688
-
2689
- <dl>
2690
- <dd>
2691
-
2692
- <dl>
2693
- <dd>
2694
-
2695
- This endpoint retrieves the experts registry, which contains information about all available experts that can be referenced when creating agents through the AgentsCreateExpertReference schema.
2696
- </dd>
2697
- </dl>
2698
- </dd>
2699
- </dl>
2700
-
2701
- #### 🔌 Usage
2702
-
2703
- <dl>
2704
- <dd>
2705
-
2706
- <dl>
2707
- <dd>
2708
-
2709
- ```typescript
2710
- await client.agents.getRegistryExperts({
2711
- limit: 100,
2712
- offset: 0
2713
- });
2714
-
2715
- ```
2716
- </dd>
2717
- </dl>
2718
- </dd>
2719
- </dl>
2720
-
2721
- #### ⚙️ Parameters
2722
-
2723
- <dl>
2724
- <dd>
2725
-
2726
- <dl>
2727
- <dd>
2728
-
2729
- **request:** `Corti.AgentsGetRegistryExpertsRequest`
2730
-
2731
- </dd>
2732
- </dl>
2733
-
2734
- <dl>
2735
- <dd>
2736
-
2737
- **requestOptions:** `AgentsClient.RequestOptions`
2738
-
2739
- </dd>
2740
- </dl>
2741
- </dd>
2742
- </dl>
2743
-
2744
-
2745
- </dd>
2746
- </dl>
2747
- </details>
2748
-