@gleanwork/api-client 0.4.4 → 0.5.3

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 (236) hide show
  1. package/README.md +45 -45
  2. package/dist/commonjs/__tests__/agents.test.js +3 -1
  3. package/dist/commonjs/__tests__/agents.test.js.map +1 -1
  4. package/dist/commonjs/funcs/clientAgentsList.d.ts +2 -2
  5. package/dist/commonjs/funcs/clientAgentsList.js +2 -2
  6. package/dist/commonjs/funcs/clientAgentsRetrieve.d.ts +2 -2
  7. package/dist/commonjs/funcs/clientAgentsRetrieve.js +2 -2
  8. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.d.ts +2 -2
  9. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.js +2 -2
  10. package/dist/commonjs/funcs/clientAgentsRun.d.ts +2 -2
  11. package/dist/commonjs/funcs/clientAgentsRun.js +2 -2
  12. package/dist/commonjs/funcs/clientAgentsRunStream.d.ts +2 -2
  13. package/dist/commonjs/funcs/clientAgentsRunStream.js +2 -2
  14. package/dist/commonjs/funcs/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  15. package/dist/commonjs/funcs/clientGovernanceDataPoliciesCreate.js +1 -1
  16. package/dist/commonjs/funcs/clientGovernanceDataPoliciesDownload.d.ts +1 -1
  17. package/dist/commonjs/funcs/clientGovernanceDataPoliciesDownload.js +1 -1
  18. package/dist/commonjs/funcs/clientGovernanceDataPoliciesList.d.ts +1 -1
  19. package/dist/commonjs/funcs/clientGovernanceDataPoliciesList.js +1 -1
  20. package/dist/commonjs/funcs/clientGovernanceDataPoliciesRetrieve.d.ts +1 -1
  21. package/dist/commonjs/funcs/clientGovernanceDataPoliciesRetrieve.js +1 -1
  22. package/dist/commonjs/funcs/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  23. package/dist/commonjs/funcs/clientGovernanceDataPoliciesUpdate.js +1 -1
  24. package/dist/commonjs/funcs/clientGovernanceDataReportsCreate.d.ts +1 -1
  25. package/dist/commonjs/funcs/clientGovernanceDataReportsCreate.js +1 -1
  26. package/dist/commonjs/funcs/clientGovernanceDataReportsDownload.d.ts +1 -1
  27. package/dist/commonjs/funcs/clientGovernanceDataReportsDownload.js +1 -1
  28. package/dist/commonjs/funcs/clientGovernanceDataReportsStatus.d.ts +1 -1
  29. package/dist/commonjs/funcs/clientGovernanceDataReportsStatus.js +1 -1
  30. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  31. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  32. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesList.d.ts +1 -1
  33. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesList.js +1 -1
  34. package/dist/commonjs/lib/config.d.ts +2 -2
  35. package/dist/commonjs/lib/config.js +2 -2
  36. package/dist/commonjs/models/components/agent.d.ts +16 -6
  37. package/dist/commonjs/models/components/agent.d.ts.map +1 -1
  38. package/dist/commonjs/models/components/agent.js.map +1 -1
  39. package/dist/commonjs/models/components/agentrun.d.ts +2 -2
  40. package/dist/commonjs/models/components/agentrun.d.ts.map +1 -1
  41. package/dist/commonjs/models/components/agentrun.js +2 -2
  42. package/dist/commonjs/models/components/agentrun.js.map +1 -1
  43. package/dist/commonjs/models/components/agentruncreate.d.ts +2 -2
  44. package/dist/commonjs/models/components/agentruncreate.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/agentruncreate.js +2 -2
  46. package/dist/commonjs/models/components/agentruncreate.js.map +1 -1
  47. package/dist/commonjs/models/components/agentschemas.d.ts +4 -4
  48. package/dist/commonjs/models/components/chatrequest.d.ts +3 -0
  49. package/dist/commonjs/models/components/chatrequest.d.ts.map +1 -1
  50. package/dist/commonjs/models/components/chatrequest.js +3 -0
  51. package/dist/commonjs/models/components/chatrequest.js.map +1 -1
  52. package/dist/commonjs/models/components/searchagentsrequest.d.ts +1 -1
  53. package/dist/commonjs/models/components/workflow.d.ts +5 -5
  54. package/dist/commonjs/models/components/workflow.d.ts.map +1 -1
  55. package/dist/commonjs/models/components/workflow.js +2 -2
  56. package/dist/commonjs/models/components/workflow.js.map +1 -1
  57. package/dist/commonjs/react-query/clientAgentsList.d.ts +2 -2
  58. package/dist/commonjs/react-query/clientAgentsList.js +2 -2
  59. package/dist/commonjs/react-query/clientAgentsRetrieve.d.ts +4 -4
  60. package/dist/commonjs/react-query/clientAgentsRetrieve.js +4 -4
  61. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.d.ts +4 -4
  62. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.js +4 -4
  63. package/dist/commonjs/react-query/clientAgentsRun.d.ts +2 -2
  64. package/dist/commonjs/react-query/clientAgentsRun.js +2 -2
  65. package/dist/commonjs/react-query/clientAgentsRunStream.d.ts +2 -2
  66. package/dist/commonjs/react-query/clientAgentsRunStream.js +2 -2
  67. package/dist/commonjs/react-query/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  68. package/dist/commonjs/react-query/clientGovernanceDataPoliciesCreate.js +1 -1
  69. package/dist/commonjs/react-query/clientGovernanceDataPoliciesDownload.d.ts +2 -2
  70. package/dist/commonjs/react-query/clientGovernanceDataPoliciesDownload.js +2 -2
  71. package/dist/commonjs/react-query/clientGovernanceDataPoliciesList.d.ts +2 -2
  72. package/dist/commonjs/react-query/clientGovernanceDataPoliciesList.js +2 -2
  73. package/dist/commonjs/react-query/clientGovernanceDataPoliciesRetrieve.d.ts +2 -2
  74. package/dist/commonjs/react-query/clientGovernanceDataPoliciesRetrieve.js +2 -2
  75. package/dist/commonjs/react-query/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  76. package/dist/commonjs/react-query/clientGovernanceDataPoliciesUpdate.js +1 -1
  77. package/dist/commonjs/react-query/clientGovernanceDataReportsCreate.d.ts +1 -1
  78. package/dist/commonjs/react-query/clientGovernanceDataReportsCreate.js +1 -1
  79. package/dist/commonjs/react-query/clientGovernanceDataReportsDownload.d.ts +2 -2
  80. package/dist/commonjs/react-query/clientGovernanceDataReportsDownload.js +2 -2
  81. package/dist/commonjs/react-query/clientGovernanceDataReportsStatus.d.ts +2 -2
  82. package/dist/commonjs/react-query/clientGovernanceDataReportsStatus.js +2 -2
  83. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  84. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  85. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesList.d.ts +2 -2
  86. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesList.js +2 -2
  87. package/dist/commonjs/sdk/agents.d.ts +10 -10
  88. package/dist/commonjs/sdk/agents.js +10 -10
  89. package/dist/commonjs/sdk/policies.d.ts +5 -5
  90. package/dist/commonjs/sdk/policies.js +5 -5
  91. package/dist/commonjs/sdk/reports.d.ts +3 -3
  92. package/dist/commonjs/sdk/reports.js +3 -3
  93. package/dist/commonjs/sdk/visibilityoverrides.d.ts +2 -2
  94. package/dist/commonjs/sdk/visibilityoverrides.js +2 -2
  95. package/dist/esm/__tests__/agents.test.js +3 -1
  96. package/dist/esm/__tests__/agents.test.js.map +1 -1
  97. package/dist/esm/funcs/clientAgentsList.d.ts +2 -2
  98. package/dist/esm/funcs/clientAgentsList.js +2 -2
  99. package/dist/esm/funcs/clientAgentsRetrieve.d.ts +2 -2
  100. package/dist/esm/funcs/clientAgentsRetrieve.js +2 -2
  101. package/dist/esm/funcs/clientAgentsRetrieveSchemas.d.ts +2 -2
  102. package/dist/esm/funcs/clientAgentsRetrieveSchemas.js +2 -2
  103. package/dist/esm/funcs/clientAgentsRun.d.ts +2 -2
  104. package/dist/esm/funcs/clientAgentsRun.js +2 -2
  105. package/dist/esm/funcs/clientAgentsRunStream.d.ts +2 -2
  106. package/dist/esm/funcs/clientAgentsRunStream.js +2 -2
  107. package/dist/esm/funcs/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  108. package/dist/esm/funcs/clientGovernanceDataPoliciesCreate.js +1 -1
  109. package/dist/esm/funcs/clientGovernanceDataPoliciesDownload.d.ts +1 -1
  110. package/dist/esm/funcs/clientGovernanceDataPoliciesDownload.js +1 -1
  111. package/dist/esm/funcs/clientGovernanceDataPoliciesList.d.ts +1 -1
  112. package/dist/esm/funcs/clientGovernanceDataPoliciesList.js +1 -1
  113. package/dist/esm/funcs/clientGovernanceDataPoliciesRetrieve.d.ts +1 -1
  114. package/dist/esm/funcs/clientGovernanceDataPoliciesRetrieve.js +1 -1
  115. package/dist/esm/funcs/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  116. package/dist/esm/funcs/clientGovernanceDataPoliciesUpdate.js +1 -1
  117. package/dist/esm/funcs/clientGovernanceDataReportsCreate.d.ts +1 -1
  118. package/dist/esm/funcs/clientGovernanceDataReportsCreate.js +1 -1
  119. package/dist/esm/funcs/clientGovernanceDataReportsDownload.d.ts +1 -1
  120. package/dist/esm/funcs/clientGovernanceDataReportsDownload.js +1 -1
  121. package/dist/esm/funcs/clientGovernanceDataReportsStatus.d.ts +1 -1
  122. package/dist/esm/funcs/clientGovernanceDataReportsStatus.js +1 -1
  123. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  124. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  125. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesList.d.ts +1 -1
  126. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesList.js +1 -1
  127. package/dist/esm/lib/config.d.ts +2 -2
  128. package/dist/esm/lib/config.js +2 -2
  129. package/dist/esm/models/components/agent.d.ts +16 -6
  130. package/dist/esm/models/components/agent.d.ts.map +1 -1
  131. package/dist/esm/models/components/agent.js.map +1 -1
  132. package/dist/esm/models/components/agentrun.d.ts +2 -2
  133. package/dist/esm/models/components/agentrun.d.ts.map +1 -1
  134. package/dist/esm/models/components/agentrun.js +2 -2
  135. package/dist/esm/models/components/agentrun.js.map +1 -1
  136. package/dist/esm/models/components/agentruncreate.d.ts +2 -2
  137. package/dist/esm/models/components/agentruncreate.d.ts.map +1 -1
  138. package/dist/esm/models/components/agentruncreate.js +2 -2
  139. package/dist/esm/models/components/agentruncreate.js.map +1 -1
  140. package/dist/esm/models/components/agentschemas.d.ts +4 -4
  141. package/dist/esm/models/components/chatrequest.d.ts +3 -0
  142. package/dist/esm/models/components/chatrequest.d.ts.map +1 -1
  143. package/dist/esm/models/components/chatrequest.js +3 -0
  144. package/dist/esm/models/components/chatrequest.js.map +1 -1
  145. package/dist/esm/models/components/searchagentsrequest.d.ts +1 -1
  146. package/dist/esm/models/components/workflow.d.ts +5 -5
  147. package/dist/esm/models/components/workflow.d.ts.map +1 -1
  148. package/dist/esm/models/components/workflow.js +2 -2
  149. package/dist/esm/models/components/workflow.js.map +1 -1
  150. package/dist/esm/react-query/clientAgentsList.d.ts +2 -2
  151. package/dist/esm/react-query/clientAgentsList.js +2 -2
  152. package/dist/esm/react-query/clientAgentsRetrieve.d.ts +4 -4
  153. package/dist/esm/react-query/clientAgentsRetrieve.js +4 -4
  154. package/dist/esm/react-query/clientAgentsRetrieveSchemas.d.ts +4 -4
  155. package/dist/esm/react-query/clientAgentsRetrieveSchemas.js +4 -4
  156. package/dist/esm/react-query/clientAgentsRun.d.ts +2 -2
  157. package/dist/esm/react-query/clientAgentsRun.js +2 -2
  158. package/dist/esm/react-query/clientAgentsRunStream.d.ts +2 -2
  159. package/dist/esm/react-query/clientAgentsRunStream.js +2 -2
  160. package/dist/esm/react-query/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  161. package/dist/esm/react-query/clientGovernanceDataPoliciesCreate.js +1 -1
  162. package/dist/esm/react-query/clientGovernanceDataPoliciesDownload.d.ts +2 -2
  163. package/dist/esm/react-query/clientGovernanceDataPoliciesDownload.js +2 -2
  164. package/dist/esm/react-query/clientGovernanceDataPoliciesList.d.ts +2 -2
  165. package/dist/esm/react-query/clientGovernanceDataPoliciesList.js +2 -2
  166. package/dist/esm/react-query/clientGovernanceDataPoliciesRetrieve.d.ts +2 -2
  167. package/dist/esm/react-query/clientGovernanceDataPoliciesRetrieve.js +2 -2
  168. package/dist/esm/react-query/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  169. package/dist/esm/react-query/clientGovernanceDataPoliciesUpdate.js +1 -1
  170. package/dist/esm/react-query/clientGovernanceDataReportsCreate.d.ts +1 -1
  171. package/dist/esm/react-query/clientGovernanceDataReportsCreate.js +1 -1
  172. package/dist/esm/react-query/clientGovernanceDataReportsDownload.d.ts +2 -2
  173. package/dist/esm/react-query/clientGovernanceDataReportsDownload.js +2 -2
  174. package/dist/esm/react-query/clientGovernanceDataReportsStatus.d.ts +2 -2
  175. package/dist/esm/react-query/clientGovernanceDataReportsStatus.js +2 -2
  176. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  177. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  178. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesList.d.ts +2 -2
  179. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesList.js +2 -2
  180. package/dist/esm/sdk/agents.d.ts +10 -10
  181. package/dist/esm/sdk/agents.js +10 -10
  182. package/dist/esm/sdk/policies.d.ts +5 -5
  183. package/dist/esm/sdk/policies.js +5 -5
  184. package/dist/esm/sdk/reports.d.ts +3 -3
  185. package/dist/esm/sdk/reports.js +3 -3
  186. package/dist/esm/sdk/visibilityoverrides.d.ts +2 -2
  187. package/dist/esm/sdk/visibilityoverrides.js +2 -2
  188. package/docs/sdks/agents/README.md +28 -16
  189. package/docs/sdks/policies/README.md +5 -5
  190. package/docs/sdks/reports/README.md +3 -3
  191. package/docs/sdks/visibilityoverrides/README.md +2 -2
  192. package/jsr.json +1 -1
  193. package/package.json +1 -1
  194. package/src/__tests__/agents.test.ts +3 -1
  195. package/src/funcs/clientAgentsList.ts +2 -2
  196. package/src/funcs/clientAgentsRetrieve.ts +2 -2
  197. package/src/funcs/clientAgentsRetrieveSchemas.ts +2 -2
  198. package/src/funcs/clientAgentsRun.ts +2 -2
  199. package/src/funcs/clientAgentsRunStream.ts +2 -2
  200. package/src/funcs/clientGovernanceDataPoliciesCreate.ts +1 -1
  201. package/src/funcs/clientGovernanceDataPoliciesDownload.ts +1 -1
  202. package/src/funcs/clientGovernanceDataPoliciesList.ts +1 -1
  203. package/src/funcs/clientGovernanceDataPoliciesRetrieve.ts +1 -1
  204. package/src/funcs/clientGovernanceDataPoliciesUpdate.ts +1 -1
  205. package/src/funcs/clientGovernanceDataReportsCreate.ts +1 -1
  206. package/src/funcs/clientGovernanceDataReportsDownload.ts +1 -1
  207. package/src/funcs/clientGovernanceDataReportsStatus.ts +1 -1
  208. package/src/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.ts +1 -1
  209. package/src/funcs/clientGovernanceDocumentsVisibilityoverridesList.ts +1 -1
  210. package/src/lib/config.ts +2 -2
  211. package/src/models/components/agent.ts +16 -6
  212. package/src/models/components/agentrun.ts +4 -4
  213. package/src/models/components/agentruncreate.ts +4 -4
  214. package/src/models/components/agentschemas.ts +4 -4
  215. package/src/models/components/chatrequest.ts +10 -0
  216. package/src/models/components/searchagentsrequest.ts +1 -1
  217. package/src/models/components/workflow.ts +7 -7
  218. package/src/react-query/clientAgentsList.ts +2 -2
  219. package/src/react-query/clientAgentsRetrieve.ts +4 -4
  220. package/src/react-query/clientAgentsRetrieveSchemas.ts +4 -4
  221. package/src/react-query/clientAgentsRun.ts +2 -2
  222. package/src/react-query/clientAgentsRunStream.ts +2 -2
  223. package/src/react-query/clientGovernanceDataPoliciesCreate.ts +1 -1
  224. package/src/react-query/clientGovernanceDataPoliciesDownload.ts +2 -2
  225. package/src/react-query/clientGovernanceDataPoliciesList.ts +2 -2
  226. package/src/react-query/clientGovernanceDataPoliciesRetrieve.ts +2 -2
  227. package/src/react-query/clientGovernanceDataPoliciesUpdate.ts +1 -1
  228. package/src/react-query/clientGovernanceDataReportsCreate.ts +1 -1
  229. package/src/react-query/clientGovernanceDataReportsDownload.ts +2 -2
  230. package/src/react-query/clientGovernanceDataReportsStatus.ts +2 -2
  231. package/src/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.ts +1 -1
  232. package/src/react-query/clientGovernanceDocumentsVisibilityoverridesList.ts +2 -2
  233. package/src/sdk/agents.ts +10 -10
  234. package/src/sdk/policies.ts +5 -5
  235. package/src/sdk/reports.ts +3 -3
  236. package/src/sdk/visibilityoverrides.ts +2 -2
package/README.md CHANGED
@@ -293,11 +293,11 @@ For more information on obtaining the appropriate token type, please contact you
293
293
 
294
294
  #### [client.agents](docs/sdks/agents/README.md)
295
295
 
296
- * [retrieve](docs/sdks/agents/README.md#retrieve) - Get Agent
297
- * [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
298
- * [list](docs/sdks/agents/README.md#list) - Search Agents
299
- * [runStream](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
300
- * [run](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
296
+ * [retrieve](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
297
+ * [retrieveSchemas](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
298
+ * [list](docs/sdks/agents/README.md#list) - Search agents
299
+ * [runStream](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
300
+ * [run](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
301
301
 
302
302
  #### [client.announcements](docs/sdks/announcements/README.md)
303
303
 
@@ -359,25 +359,25 @@ For more information on obtaining the appropriate token type, please contact you
359
359
 
360
360
  #### [client.governance.data.policies](docs/sdks/policies/README.md)
361
361
 
362
- * [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
363
- * [update](docs/sdks/policies/README.md#update) - Updates an existing policy.
364
- * [list](docs/sdks/policies/README.md#list) - Lists policies.
365
- * [create](docs/sdks/policies/README.md#create) - Creates new policy.
366
- * [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
362
+ * [retrieve](docs/sdks/policies/README.md#retrieve) - Gets specified policy
363
+ * [update](docs/sdks/policies/README.md#update) - Updates an existing policy
364
+ * [list](docs/sdks/policies/README.md#list) - Lists policies
365
+ * [create](docs/sdks/policies/README.md#create) - Creates new policy
366
+ * [download](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy
367
367
 
368
368
  #### [client.governance.data.reports](docs/sdks/reports/README.md)
369
369
 
370
- * [create](docs/sdks/reports/README.md#create) - Creates new one-time report.
371
- * [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
372
- * [status](docs/sdks/reports/README.md#status) - Fetches report run status.
370
+ * [create](docs/sdks/reports/README.md#create) - Creates new one-time report
371
+ * [download](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
372
+ * [status](docs/sdks/reports/README.md#status) - Fetches report run status
373
373
 
374
374
  #### [client.governance.documents](docs/sdks/governancedocuments/README.md)
375
375
 
376
376
 
377
377
  #### [client.governance.documents.visibilityoverrides](docs/sdks/visibilityoverrides/README.md)
378
378
 
379
- * [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
380
- * [create](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
379
+ * [list](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
380
+ * [create](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs
381
381
 
382
382
  #### [client.insights](docs/sdks/insights/README.md)
383
383
 
@@ -508,11 +508,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
508
508
 
509
509
  - [`clientActivityFeedback`](docs/sdks/activity/README.md#feedback) - Report client activity
510
510
  - [`clientActivityReport`](docs/sdks/activity/README.md#report) - Report document activity
511
- - [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search Agents
512
- - [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
513
- - [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
514
- - [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
515
- - [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
511
+ - [`clientAgentsList`](docs/sdks/agents/README.md#list) - Search agents
512
+ - [`clientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
513
+ - [`clientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
514
+ - [`clientAgentsRun`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
515
+ - [`clientAgentsRunStream`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
516
516
  - [`clientAnnouncementsCreate`](docs/sdks/announcements/README.md#create) - Create Announcement
517
517
  - [`clientAnnouncementsDelete`](docs/sdks/announcements/README.md#delete) - Delete Announcement
518
518
  - [`clientAnnouncementsUpdate`](docs/sdks/announcements/README.md#update) - Update Announcement
@@ -546,16 +546,16 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
546
546
  - [`clientDocumentsSummarize`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
547
547
  - [`clientEntitiesList`](docs/sdks/entities/README.md#list) - List entities
548
548
  - [`clientEntitiesReadPeople`](docs/sdks/entities/README.md#readpeople) - Read people
549
- - [`clientGovernanceDataPoliciesCreate`](docs/sdks/policies/README.md#create) - Creates new policy.
550
- - [`clientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
551
- - [`clientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies.
552
- - [`clientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
553
- - [`clientGovernanceDataPoliciesUpdate`](docs/sdks/policies/README.md#update) - Updates an existing policy.
554
- - [`clientGovernanceDataReportsCreate`](docs/sdks/reports/README.md#create) - Creates new one-time report.
555
- - [`clientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
556
- - [`clientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status.
557
- - [`clientGovernanceDocumentsVisibilityoverridesCreate`](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
558
- - [`clientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
549
+ - [`clientGovernanceDataPoliciesCreate`](docs/sdks/policies/README.md#create) - Creates new policy
550
+ - [`clientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy
551
+ - [`clientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies
552
+ - [`clientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified policy
553
+ - [`clientGovernanceDataPoliciesUpdate`](docs/sdks/policies/README.md#update) - Updates an existing policy
554
+ - [`clientGovernanceDataReportsCreate`](docs/sdks/reports/README.md#create) - Creates new one-time report
555
+ - [`clientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
556
+ - [`clientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status
557
+ - [`clientGovernanceDocumentsVisibilityoverridesCreate`](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs
558
+ - [`clientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
559
559
  - [`clientInsightsRetrieve`](docs/sdks/insights/README.md#retrieve) - Read insights
560
560
  - [`clientMessagesRetrieve`](docs/sdks/messages/README.md#retrieve) - Read messages
561
561
  - [`clientPinsCreate`](docs/sdks/pins/README.md#create) - Create pin
@@ -647,11 +647,11 @@ To learn about this feature and how to get started, check
647
647
 
648
648
  - [`useClientActivityFeedbackMutation`](docs/sdks/activity/README.md#feedback) - Report client activity
649
649
  - [`useClientActivityReportMutation`](docs/sdks/activity/README.md#report) - Report document activity
650
- - [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search Agents
651
- - [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Get Agent
652
- - [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - Get Agent Schemas
653
- - [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create Run, Wait for Output
654
- - [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create Run, Stream Output
650
+ - [`useClientAgentsListMutation`](docs/sdks/agents/README.md#list) - Search agents
651
+ - [`useClientAgentsRetrieve`](docs/sdks/agents/README.md#retrieve) - Retrieve an agent
652
+ - [`useClientAgentsRetrieveSchemas`](docs/sdks/agents/README.md#retrieveschemas) - List an agent's schemas
653
+ - [`useClientAgentsRunMutation`](docs/sdks/agents/README.md#run) - Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
654
+ - [`useClientAgentsRunStreamMutation`](docs/sdks/agents/README.md#runstream) - Create an agent run and stream the response
655
655
  - [`useClientAnnouncementsCreateMutation`](docs/sdks/announcements/README.md#create) - Create Announcement
656
656
  - [`useClientAnnouncementsDeleteMutation`](docs/sdks/announcements/README.md#delete) - Delete Announcement
657
657
  - [`useClientAnnouncementsUpdateMutation`](docs/sdks/announcements/README.md#update) - Update Announcement
@@ -685,16 +685,16 @@ To learn about this feature and how to get started, check
685
685
  - [`useClientDocumentsSummarizeMutation`](docs/sdks/clientdocuments/README.md#summarize) - Summarize documents
686
686
  - [`useClientEntitiesListMutation`](docs/sdks/entities/README.md#list) - List entities
687
687
  - [`useClientEntitiesReadPeopleMutation`](docs/sdks/entities/README.md#readpeople) - Read people
688
- - [`useClientGovernanceDataPoliciesCreateMutation`](docs/sdks/policies/README.md#create) - Creates new policy.
689
- - [`useClientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy.
690
- - [`useClientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies.
691
- - [`useClientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified Policy.
692
- - [`useClientGovernanceDataPoliciesUpdateMutation`](docs/sdks/policies/README.md#update) - Updates an existing policy.
693
- - [`useClientGovernanceDataReportsCreateMutation`](docs/sdks/reports/README.md#create) - Creates new one-time report.
694
- - [`useClientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report.
695
- - [`useClientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status.
696
- - [`useClientGovernanceDocumentsVisibilityoverridesCreateMutation`](docs/sdks/visibilityoverrides/README.md#create) - Hide/Un-hide docs.
697
- - [`useClientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility.
688
+ - [`useClientGovernanceDataPoliciesCreateMutation`](docs/sdks/policies/README.md#create) - Creates new policy
689
+ - [`useClientGovernanceDataPoliciesDownload`](docs/sdks/policies/README.md#download) - Downloads violations CSV for policy
690
+ - [`useClientGovernanceDataPoliciesList`](docs/sdks/policies/README.md#list) - Lists policies
691
+ - [`useClientGovernanceDataPoliciesRetrieve`](docs/sdks/policies/README.md#retrieve) - Gets specified policy
692
+ - [`useClientGovernanceDataPoliciesUpdateMutation`](docs/sdks/policies/README.md#update) - Updates an existing policy
693
+ - [`useClientGovernanceDataReportsCreateMutation`](docs/sdks/reports/README.md#create) - Creates new one-time report
694
+ - [`useClientGovernanceDataReportsDownload`](docs/sdks/reports/README.md#download) - Downloads violations CSV for report
695
+ - [`useClientGovernanceDataReportsStatus`](docs/sdks/reports/README.md#status) - Fetches report run status
696
+ - [`useClientGovernanceDocumentsVisibilityoverridesCreateMutation`](docs/sdks/visibilityoverrides/README.md#create) - Hide or unhide docs
697
+ - [`useClientGovernanceDocumentsVisibilityoverridesList`](docs/sdks/visibilityoverrides/README.md#list) - Fetches documents visibility
698
698
  - [`useClientInsightsRetrieveMutation`](docs/sdks/insights/README.md#retrieve) - Read insights
699
699
  - [`useClientMessagesRetrieveMutation`](docs/sdks/messages/README.md#retrieve) - Read messages
700
700
  - [`useClientPinsCreateMutation`](docs/sdks/pins/README.md#create) - Create pin
@@ -55,7 +55,9 @@ vitest_1.it.skip("Agents Create And Stream Run", async () => {
55
55
  httpClient: testHttpClient,
56
56
  apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
57
57
  });
58
- const result = await glean.client.agents.run({});
58
+ const result = await glean.client.agents.run({
59
+ agentId: "<id>",
60
+ });
59
61
  (0, vitest_1.expect)(result).toBeDefined();
60
62
  });
61
63
  //# sourceMappingURL=agents.test.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"agents.test.js","sourceRoot":"","sources":["../../../src/__tests__/agents.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,mCAAkD;AAClD,0CAAoC;AACpC,mDAAuD;AAEvD,WAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;IACpC,eAAM,CAAC,IAAI,CACT,8JAA8J,CAC/J,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACtC,eAAM,CAAC,IAAI,CACT,kKAAkK,CACnK,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;IAC1C,eAAM,CAAC,IAAI,CACT,0KAA0K,CAC3K,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;IAClC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1D,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;IAC1C,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,iBAAiB,CAAC,CAAC;IAE/D,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACjE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;IACtC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,cAAc,CAAC,CAAC;IAE5D,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClD,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;IACjD,eAAM,CAAC,IAAI,CACT,uLAAuL,CACxL,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;IAC5C,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,kBAAkB,CAAC,CAAC;IAEhE,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjD,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"agents.test.js","sourceRoot":"","sources":["../../../src/__tests__/agents.test.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAEH,mCAAkD;AAClD,0CAAoC;AACpC,mDAAuD;AAEvD,WAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;IACpC,eAAM,CAAC,IAAI,CACT,8JAA8J,CAC/J,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;IACtC,eAAM,CAAC,IAAI,CACT,kKAAkK,CACnK,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;IAC1C,eAAM,CAAC,IAAI,CACT,0KAA0K,CAC3K,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,kBAAkB,EAAE,KAAK,IAAI,EAAE;IAClC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,UAAU,CAAC,CAAC;IAExD,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1D,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;IAC1C,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,iBAAiB,CAAC,CAAC;IAE/D,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACjE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;IACtC,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,cAAc,CAAC,CAAC;IAE5D,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAClD,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,WAAE,CAAC,IAAI,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;IACjD,eAAM,CAAC,IAAI,CACT,uLAAuL,CACxL,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;IAC5C,MAAM,cAAc,GAAG,IAAA,oCAAoB,EAAC,kBAAkB,CAAC,CAAC;IAEhE,MAAM,KAAK,GAAG,IAAI,gBAAK,CAAC;QACtB,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,wBAAwB;QACrE,UAAU,EAAE,cAAc;QAC1B,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,OAAO;KACpD,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC;QAC3C,OAAO,EAAE,MAAM;KAChB,CAAC,CAAC;IACH,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC"}
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Search Agents
10
+ * Search agents
11
11
  *
12
12
  * @remarks
13
- * List Agents available in this service. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/POST/agents/search). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
13
+ * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
14
14
  */
15
15
  export declare function clientAgentsList(client: GleanCore, request: components.SearchAgentsRequest, options?: RequestOptions): APIPromise<Result<components.SearchAgentsResponse, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsList.d.ts.map
@@ -46,10 +46,10 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Search Agents
49
+ * Search agents
50
50
  *
51
51
  * @remarks
52
- * List Agents available in this service. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/POST/agents/search). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
52
+ * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
53
53
  */
54
54
  function clientAgentsList(client, request, options) {
55
55
  return new async_js_1.APIPromise($do(client, request, options));
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Get Agent
10
+ * Retrieve an agent
11
11
  *
12
12
  * @remarks
13
- * Get an agent by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
13
+ * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
14
14
  */
15
15
  export declare function clientAgentsRetrieve(client: GleanCore, agentId: string, timezoneOffset?: number | undefined, options?: RequestOptions): APIPromise<Result<components.Agent, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRetrieve.d.ts.map
@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Get Agent
50
+ * Retrieve an agent
51
51
  *
52
52
  * @remarks
53
- * Get an agent by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
53
+ * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
54
54
  */
55
55
  function clientAgentsRetrieve(client, agentId, timezoneOffset, options) {
56
56
  return new async_js_1.APIPromise($do(client, agentId, timezoneOffset, options));
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Get Agent Schemas
10
+ * List an agent's schemas
11
11
  *
12
12
  * @remarks
13
- * Get an agent's schemas by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}/schemas). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
13
+ * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.
14
14
  */
15
15
  export declare function clientAgentsRetrieveSchemas(client: GleanCore, agentId: string, timezoneOffset?: number | undefined, options?: RequestOptions): APIPromise<Result<components.AgentSchemas, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRetrieveSchemas.d.ts.map
@@ -47,10 +47,10 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Get Agent Schemas
50
+ * List an agent's schemas
51
51
  *
52
52
  * @remarks
53
- * Get an agent's schemas by ID. This endpoint implements the LangChain Agent Protocol, specifically part of the Agents stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/agents/GET/agents/{agent_id}/schemas). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol.
53
+ * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.
54
54
  */
55
55
  function clientAgentsRetrieveSchemas(client, agentId, timezoneOffset, options) {
56
56
  return new async_js_1.APIPromise($do(client, agentId, timezoneOffset, options));
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Create Run, Wait for Output
10
+ * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
11
11
  *
12
12
  * @remarks
13
- * Creates and triggers a run of an agent. Waits for final output and then returns it. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/wait). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
13
+ * Executes an agent run and returns the final response.
14
14
  */
15
15
  export declare function clientAgentsRun(client: GleanCore, request: components.AgentRunCreate, options?: RequestOptions): APIPromise<Result<components.AgentRunWaitResponse, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRun.d.ts.map
@@ -46,10 +46,10 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Create Run, Wait for Output
49
+ * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
50
50
  *
51
51
  * @remarks
52
- * Creates and triggers a run of an agent. Waits for final output and then returns it. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/wait). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
52
+ * Executes an agent run and returns the final response.
53
53
  */
54
54
  function clientAgentsRun(client, request, options) {
55
55
  return new async_js_1.APIPromise($do(client, request, options));
@@ -7,10 +7,10 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Create Run, Stream Output
10
+ * Create an agent run and stream the response
11
11
  *
12
12
  * @remarks
13
- * Creates and triggers a run of an agent. Streams the output in SSE format. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/stream). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
13
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
14
14
  */
15
15
  export declare function clientAgentsRunStream(client: GleanCore, request: components.AgentRunCreate, options?: RequestOptions): APIPromise<Result<string, GleanError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
16
16
  //# sourceMappingURL=clientAgentsRunStream.d.ts.map
@@ -47,10 +47,10 @@ const url_js_1 = require("../lib/url.js");
47
47
  const components = __importStar(require("../models/components/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Create Run, Stream Output
50
+ * Create an agent run and stream the response
51
51
  *
52
52
  * @remarks
53
- * Creates and triggers a run of an agent. Streams the output in SSE format. This endpoint implements the LangChain Agent Protocol, specifically part of the Runs stage (https://langchain-ai.github.io/agent-protocol/api.html#tag/runs/POST/runs/stream). It adheres to the standard contract defined for agent interoperability and can be used by agent runtimes that support the Agent Protocol. Note that running agents that reference third party platform write actions is unsupported as it requires user confirmation.
53
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
54
54
  */
55
55
  function clientAgentsRunStream(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Creates new policy.
10
+ * Creates new policy
11
11
  *
12
12
  * @remarks
13
13
  * Creates a new policy with specified specifications and returns its id.
@@ -46,7 +46,7 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Creates new policy.
49
+ * Creates new policy
50
50
  *
51
51
  * @remarks
52
52
  * Creates a new policy with specified specifications and returns its id.
@@ -6,7 +6,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
6
6
  import { APIPromise } from "../types/async.js";
7
7
  import { Result } from "../types/fp.js";
8
8
  /**
9
- * Downloads violations CSV for policy.
9
+ * Downloads violations CSV for policy
10
10
  *
11
11
  * @remarks
12
12
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -47,7 +47,7 @@ const url_js_1 = require("../lib/url.js");
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Downloads violations CSV for policy.
50
+ * Downloads violations CSV for policy
51
51
  *
52
52
  * @remarks
53
53
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Lists policies.
10
+ * Lists policies
11
11
  *
12
12
  * @remarks
13
13
  * Lists policies with filtering.
@@ -47,7 +47,7 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Lists policies.
50
+ * Lists policies
51
51
  *
52
52
  * @remarks
53
53
  * Lists policies with filtering.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Gets specified Policy.
10
+ * Gets specified policy
11
11
  *
12
12
  * @remarks
13
13
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -47,7 +47,7 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Gets specified Policy.
50
+ * Gets specified policy
51
51
  *
52
52
  * @remarks
53
53
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Updates an existing policy.
10
+ * Updates an existing policy
11
11
  *
12
12
  * @remarks
13
13
  * Updates an existing policy.
@@ -47,7 +47,7 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Updates an existing policy.
50
+ * Updates an existing policy
51
51
  *
52
52
  * @remarks
53
53
  * Updates an existing policy.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Creates new one-time report.
10
+ * Creates new one-time report
11
11
  *
12
12
  * @remarks
13
13
  * Creates a new one-time report and executes its batch job.
@@ -46,7 +46,7 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Creates new one-time report.
49
+ * Creates new one-time report
50
50
  *
51
51
  * @remarks
52
52
  * Creates a new one-time report and executes its batch job.
@@ -6,7 +6,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
6
6
  import { APIPromise } from "../types/async.js";
7
7
  import { Result } from "../types/fp.js";
8
8
  /**
9
- * Downloads violations CSV for report.
9
+ * Downloads violations CSV for report
10
10
  *
11
11
  * @remarks
12
12
  * Downloads CSV violations report for a specific report id.
@@ -47,7 +47,7 @@ const url_js_1 = require("../lib/url.js");
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Downloads violations CSV for report.
50
+ * Downloads violations CSV for report
51
51
  *
52
52
  * @remarks
53
53
  * Downloads CSV violations report for a specific report id.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Fetches report run status.
10
+ * Fetches report run status
11
11
  *
12
12
  * @remarks
13
13
  * Fetches the status of the run corresponding to the report-id.
@@ -47,7 +47,7 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Fetches report run status.
50
+ * Fetches report run status
51
51
  *
52
52
  * @remarks
53
53
  * Fetches the status of the run corresponding to the report-id.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Hide/Un-hide docs.
10
+ * Hide or unhide docs
11
11
  *
12
12
  * @remarks
13
13
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
@@ -46,7 +46,7 @@ const url_js_1 = require("../lib/url.js");
46
46
  const components = __importStar(require("../models/components/index.js"));
47
47
  const async_js_1 = require("../types/async.js");
48
48
  /**
49
- * Hide/Un-hide docs.
49
+ * Hide or unhide docs
50
50
  *
51
51
  * @remarks
52
52
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
@@ -7,7 +7,7 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
7
  import { APIPromise } from "../types/async.js";
8
8
  import { Result } from "../types/fp.js";
9
9
  /**
10
- * Fetches documents visibility.
10
+ * Fetches documents visibility
11
11
  *
12
12
  * @remarks
13
13
  * Fetches the visibility override status of the documents passed.
@@ -47,7 +47,7 @@ const components = __importStar(require("../models/components/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Fetches documents visibility.
50
+ * Fetches documents visibility
51
51
  *
52
52
  * @remarks
53
53
  * Fetches the visibility override status of the documents passed.
@@ -31,8 +31,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
31
31
  export declare const SDK_METADATA: {
32
32
  readonly language: "typescript";
33
33
  readonly openapiDocVersion: "0.9.0";
34
- readonly sdkVersion: "0.4.4";
34
+ readonly sdkVersion: "0.5.3";
35
35
  readonly genVersion: "2.610.0";
36
- readonly userAgent: "speakeasy-sdk/typescript 0.4.4 2.610.0 0.9.0 @gleanwork/api-client";
36
+ readonly userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client";
37
37
  };
38
38
  //# sourceMappingURL=config.d.ts.map
@@ -34,8 +34,8 @@ function serverURLFromOptions(options) {
34
34
  exports.SDK_METADATA = {
35
35
  language: "typescript",
36
36
  openapiDocVersion: "0.9.0",
37
- sdkVersion: "0.4.4",
37
+ sdkVersion: "0.5.3",
38
38
  genVersion: "2.610.0",
39
- userAgent: "speakeasy-sdk/typescript 0.4.4 2.610.0 0.9.0 @gleanwork/api-client",
39
+ userAgent: "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client",
40
40
  };
41
41
  //# sourceMappingURL=config.js.map
@@ -2,19 +2,24 @@ import * as z from "zod";
2
2
  import { Result as SafeParseResult } from "../../types/fp.js";
3
3
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  /**
5
- * The agent metadata.
5
+ * The agent metadata. Currently not implemented.
6
6
  */
7
7
  export type AgentMetadata = {};
8
8
  /**
9
- * Describes which protocol features the agent supports. In addition to the standard capabilities (prefixed with ap.), implementations can declare custom capabilities, named in reverse domain notation (eg. com.example.some.capability).
9
+ * Describes features that the agent supports. example: {
10
+ *
11
+ * @remarks
12
+ * "ap.io.messages": true,
13
+ * "ap.io.streaming": true
14
+ * }
10
15
  */
11
16
  export type AgentCapabilities = {
12
17
  /**
13
- * Whether the agent supports Messages as input/output/state. If true, the agent uses the `messages` key in threads/runs endpoints.
18
+ * Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent.
14
19
  */
15
20
  apIoMessages?: boolean | undefined;
16
21
  /**
17
- * Whether the agent supports streaming output.
22
+ * Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
18
23
  */
19
24
  apIoStreaming?: boolean | undefined;
20
25
  additionalProperties?: {
@@ -35,11 +40,16 @@ export type Agent = {
35
40
  */
36
41
  description?: string | undefined;
37
42
  /**
38
- * The agent metadata.
43
+ * The agent metadata. Currently not implemented.
39
44
  */
40
45
  metadata?: AgentMetadata | undefined;
41
46
  /**
42
- * Describes which protocol features the agent supports. In addition to the standard capabilities (prefixed with ap.), implementations can declare custom capabilities, named in reverse domain notation (eg. com.example.some.capability).
47
+ * Describes features that the agent supports. example: {
48
+ *
49
+ * @remarks
50
+ * "ap.io.messages": true,
51
+ * "ap.io.streaming": true
52
+ * }
43
53
  */
44
54
  capabilities: AgentCapabilities;
45
55
  };