@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
@@ -24,7 +24,7 @@ import { APICall, APIPromise } from "../types/async.js";
24
24
  import { Result } from "../types/fp.js";
25
25
 
26
26
  /**
27
- * Creates new one-time report.
27
+ * Creates new one-time report
28
28
  *
29
29
  * @remarks
30
30
  * Creates a new one-time report and executes its batch job.
@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
25
25
  import { Result } from "../types/fp.js";
26
26
 
27
27
  /**
28
- * Downloads violations CSV for report.
28
+ * Downloads violations CSV for report
29
29
  *
30
30
  * @remarks
31
31
  * Downloads CSV violations report for a specific report id.
@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
25
25
  import { Result } from "../types/fp.js";
26
26
 
27
27
  /**
28
- * Fetches report run status.
28
+ * Fetches report run status
29
29
  *
30
30
  * @remarks
31
31
  * Fetches the status of the run corresponding to the report-id.
@@ -24,7 +24,7 @@ import { APICall, APIPromise } from "../types/async.js";
24
24
  import { Result } from "../types/fp.js";
25
25
 
26
26
  /**
27
- * Hide/Un-hide docs.
27
+ * Hide or unhide docs
28
28
  *
29
29
  * @remarks
30
30
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
25
25
  import { Result } from "../types/fp.js";
26
26
 
27
27
  /**
28
- * Fetches documents visibility.
28
+ * Fetches documents visibility
29
29
  *
30
30
  * @remarks
31
31
  * Fetches the visibility override status of the documents passed.
package/src/lib/config.ts CHANGED
@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
64
64
  export const SDK_METADATA = {
65
65
  language: "typescript",
66
66
  openapiDocVersion: "0.9.0",
67
- sdkVersion: "0.4.4",
67
+ sdkVersion: "0.5.3",
68
68
  genVersion: "2.610.0",
69
69
  userAgent:
70
- "speakeasy-sdk/typescript 0.4.4 2.610.0 0.9.0 @gleanwork/api-client",
70
+ "speakeasy-sdk/typescript 0.5.3 2.610.0 0.9.0 @gleanwork/api-client",
71
71
  } as const;
@@ -12,20 +12,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
12
12
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
13
13
 
14
14
  /**
15
- * The agent metadata.
15
+ * The agent metadata. Currently not implemented.
16
16
  */
17
17
  export type AgentMetadata = {};
18
18
 
19
19
  /**
20
- * 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).
20
+ * Describes features that the agent supports. example: {
21
+ *
22
+ * @remarks
23
+ * "ap.io.messages": true,
24
+ * "ap.io.streaming": true
25
+ * }
21
26
  */
22
27
  export type AgentCapabilities = {
23
28
  /**
24
- * Whether the agent supports Messages as input/output/state. If true, the agent uses the `messages` key in threads/runs endpoints.
29
+ * Whether the agent supports messages as an input. If true, you'll pass `messages` as an input when running the agent.
25
30
  */
26
31
  apIoMessages?: boolean | undefined;
27
32
  /**
28
- * Whether the agent supports streaming output.
33
+ * Whether the agent supports streaming output. If true, you you can stream agent ouput. All agents currently support streaming.
29
34
  */
30
35
  apIoStreaming?: boolean | undefined;
31
36
  additionalProperties?: { [k: string]: any };
@@ -45,11 +50,16 @@ export type Agent = {
45
50
  */
46
51
  description?: string | undefined;
47
52
  /**
48
- * The agent metadata.
53
+ * The agent metadata. Currently not implemented.
49
54
  */
50
55
  metadata?: AgentMetadata | undefined;
51
56
  /**
52
- * 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).
57
+ * Describes features that the agent supports. example: {
58
+ *
59
+ * @remarks
60
+ * "ap.io.messages": true,
61
+ * "ap.io.streaming": true
62
+ * }
53
63
  */
54
64
  capabilities: AgentCapabilities;
55
65
  };
@@ -26,7 +26,7 @@ export type AgentRun = {
26
26
  /**
27
27
  * The ID of the agent to run.
28
28
  */
29
- agentId?: string | undefined;
29
+ agentId: string;
30
30
  /**
31
31
  * The input to the agent.
32
32
  */
@@ -47,7 +47,7 @@ export const AgentRun$inboundSchema: z.ZodType<
47
47
  z.ZodTypeDef,
48
48
  unknown
49
49
  > = z.object({
50
- agent_id: z.string().optional(),
50
+ agent_id: z.string(),
51
51
  input: z.record(z.any()).optional(),
52
52
  messages: z.array(Message$inboundSchema).optional(),
53
53
  status: AgentExecutionStatus$inboundSchema.optional(),
@@ -59,7 +59,7 @@ export const AgentRun$inboundSchema: z.ZodType<
59
59
 
60
60
  /** @internal */
61
61
  export type AgentRun$Outbound = {
62
- agent_id?: string | undefined;
62
+ agent_id: string;
63
63
  input?: { [k: string]: any } | undefined;
64
64
  messages?: Array<Message$Outbound> | undefined;
65
65
  status?: string | undefined;
@@ -71,7 +71,7 @@ export const AgentRun$outboundSchema: z.ZodType<
71
71
  z.ZodTypeDef,
72
72
  AgentRun
73
73
  > = z.object({
74
- agentId: z.string().optional(),
74
+ agentId: z.string(),
75
75
  input: z.record(z.any()).optional(),
76
76
  messages: z.array(Message$outboundSchema).optional(),
77
77
  status: AgentExecutionStatus$outboundSchema.optional(),
@@ -21,7 +21,7 @@ export type AgentRunCreate = {
21
21
  /**
22
22
  * The ID of the agent to run.
23
23
  */
24
- agentId?: string | undefined;
24
+ agentId: string;
25
25
  /**
26
26
  * The input to the agent.
27
27
  */
@@ -38,7 +38,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
38
38
  z.ZodTypeDef,
39
39
  unknown
40
40
  > = z.object({
41
- agent_id: z.string().optional(),
41
+ agent_id: z.string(),
42
42
  input: z.record(z.any()).optional(),
43
43
  messages: z.array(Message$inboundSchema).optional(),
44
44
  }).transform((v) => {
@@ -49,7 +49,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
49
49
 
50
50
  /** @internal */
51
51
  export type AgentRunCreate$Outbound = {
52
- agent_id?: string | undefined;
52
+ agent_id: string;
53
53
  input?: { [k: string]: any } | undefined;
54
54
  messages?: Array<Message$Outbound> | undefined;
55
55
  };
@@ -60,7 +60,7 @@ export const AgentRunCreate$outboundSchema: z.ZodType<
60
60
  z.ZodTypeDef,
61
61
  AgentRunCreate
62
62
  > = z.object({
63
- agentId: z.string().optional(),
63
+ agentId: z.string(),
64
64
  input: z.record(z.any()).optional(),
65
65
  messages: z.array(Message$outboundSchema).optional(),
66
66
  }).transform((v) => {
@@ -9,12 +9,12 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * The schema for the agent input. In JSON Schema format.
12
+ * The schema for the agent input. In JSON schema format.
13
13
  */
14
14
  export type InputSchema = {};
15
15
 
16
16
  /**
17
- * The schema for the agent output. In JSON Schema format.
17
+ * The schema for the agent output. In JSON schema format.
18
18
  */
19
19
  export type OutputSchema = {};
20
20
 
@@ -27,11 +27,11 @@ export type AgentSchemas = {
27
27
  */
28
28
  agentId: string;
29
29
  /**
30
- * The schema for the agent input. In JSON Schema format.
30
+ * The schema for the agent input. In JSON schema format.
31
31
  */
32
32
  inputSchema: InputSchema;
33
33
  /**
34
- * The schema for the agent output. In JSON Schema format.
34
+ * The schema for the agent output. In JSON schema format.
35
35
  */
36
36
  outputSchema: OutputSchema;
37
37
  };
@@ -24,6 +24,12 @@ import {
24
24
  ChatRestrictionFilters$Outbound,
25
25
  ChatRestrictionFilters$outboundSchema,
26
26
  } from "./chatrestrictionfilters.js";
27
+ import {
28
+ SessionInfo,
29
+ SessionInfo$inboundSchema,
30
+ SessionInfo$Outbound,
31
+ SessionInfo$outboundSchema,
32
+ } from "./sessioninfo.js";
27
33
 
28
34
  export type ChatRequest = {
29
35
  /**
@@ -48,6 +54,7 @@ export type ChatRequest = {
48
54
  * Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
49
55
  */
50
56
  timeoutMillis?: number | undefined;
57
+ sessionInfo?: SessionInfo | undefined;
51
58
  /**
52
59
  * The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used.
53
60
  */
@@ -71,6 +78,7 @@ export const ChatRequest$inboundSchema: z.ZodType<
71
78
  inclusions: ChatRestrictionFilters$inboundSchema.optional(),
72
79
  exclusions: ChatRestrictionFilters$inboundSchema.optional(),
73
80
  timeoutMillis: z.number().int().optional(),
81
+ sessionInfo: SessionInfo$inboundSchema.optional(),
74
82
  applicationId: z.string().optional(),
75
83
  stream: z.boolean().optional(),
76
84
  });
@@ -84,6 +92,7 @@ export type ChatRequest$Outbound = {
84
92
  inclusions?: ChatRestrictionFilters$Outbound | undefined;
85
93
  exclusions?: ChatRestrictionFilters$Outbound | undefined;
86
94
  timeoutMillis?: number | undefined;
95
+ sessionInfo?: SessionInfo$Outbound | undefined;
87
96
  applicationId?: string | undefined;
88
97
  stream?: boolean | undefined;
89
98
  };
@@ -101,6 +110,7 @@ export const ChatRequest$outboundSchema: z.ZodType<
101
110
  inclusions: ChatRestrictionFilters$outboundSchema.optional(),
102
111
  exclusions: ChatRestrictionFilters$outboundSchema.optional(),
103
112
  timeoutMillis: z.number().int().optional(),
113
+ sessionInfo: SessionInfo$outboundSchema.optional(),
104
114
  applicationId: z.string().optional(),
105
115
  stream: z.boolean().optional(),
106
116
  });
@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type SearchAgentsRequest = {
11
11
  /**
12
- * Filters on the name of the agent. If empty, acts as no filter.
12
+ * Filters on the name of the agent. The keyword search is case-insensitive. If search string is ommited or empty, acts as no filter.
13
13
  */
14
14
  name?: string | undefined;
15
15
  };
@@ -20,6 +20,10 @@ import {
20
20
  } from "./person.js";
21
21
 
22
22
  export type Workflow = {
23
+ /**
24
+ * The name of the workflow.
25
+ */
26
+ name?: string | undefined;
23
27
  author?: Person | undefined;
24
28
  /**
25
29
  * Server Unix timestamp of the creation time.
@@ -31,10 +35,6 @@ export type Workflow = {
31
35
  lastUpdateTimestamp?: number | undefined;
32
36
  lastUpdatedBy?: Person | undefined;
33
37
  permissions?: ObjectPermissions | undefined;
34
- /**
35
- * The name of the workflow.
36
- */
37
- name?: string | undefined;
38
38
  /**
39
39
  * The ID of the workflow.
40
40
  */
@@ -47,23 +47,23 @@ export const Workflow$inboundSchema: z.ZodType<
47
47
  z.ZodTypeDef,
48
48
  unknown
49
49
  > = z.object({
50
+ name: z.string().optional(),
50
51
  author: Person$inboundSchema.optional(),
51
52
  createTimestamp: z.number().int().optional(),
52
53
  lastUpdateTimestamp: z.number().int().optional(),
53
54
  lastUpdatedBy: Person$inboundSchema.optional(),
54
55
  permissions: ObjectPermissions$inboundSchema.optional(),
55
- name: z.string().optional(),
56
56
  id: z.string().optional(),
57
57
  });
58
58
 
59
59
  /** @internal */
60
60
  export type Workflow$Outbound = {
61
+ name?: string | undefined;
61
62
  author?: Person$Outbound | undefined;
62
63
  createTimestamp?: number | undefined;
63
64
  lastUpdateTimestamp?: number | undefined;
64
65
  lastUpdatedBy?: Person$Outbound | undefined;
65
66
  permissions?: ObjectPermissions$Outbound | undefined;
66
- name?: string | undefined;
67
67
  id?: string | undefined;
68
68
  };
69
69
 
@@ -73,12 +73,12 @@ export const Workflow$outboundSchema: z.ZodType<
73
73
  z.ZodTypeDef,
74
74
  Workflow
75
75
  > = z.object({
76
+ name: z.string().optional(),
76
77
  author: Person$outboundSchema.optional(),
77
78
  createTimestamp: z.number().int().optional(),
78
79
  lastUpdateTimestamp: z.number().int().optional(),
79
80
  lastUpdatedBy: Person$outboundSchema.optional(),
80
81
  permissions: ObjectPermissions$outboundSchema.optional(),
81
- name: z.string().optional(),
82
82
  id: z.string().optional(),
83
83
  });
84
84
 
@@ -24,10 +24,10 @@ export type ClientAgentsListMutationVariables = {
24
24
  export type ClientAgentsListMutationData = components.SearchAgentsResponse;
25
25
 
26
26
  /**
27
- * Search Agents
27
+ * Search agents
28
28
  *
29
29
  * @remarks
30
- * 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.
30
+ * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
31
31
  */
32
32
  export function useClientAgentsListMutation(
33
33
  options?: MutationHookOptions<
@@ -28,10 +28,10 @@ import {
28
28
  export type ClientAgentsRetrieveQueryData = components.Agent;
29
29
 
30
30
  /**
31
- * Get Agent
31
+ * Retrieve an agent
32
32
  *
33
33
  * @remarks
34
- * 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.
34
+ * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
35
35
  */
36
36
  export function useClientAgentsRetrieve(
37
37
  agentId: string,
@@ -51,10 +51,10 @@ export function useClientAgentsRetrieve(
51
51
  }
52
52
 
53
53
  /**
54
- * Get Agent
54
+ * Retrieve an agent
55
55
  *
56
56
  * @remarks
57
- * 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.
57
+ * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
58
58
  */
59
59
  export function useClientAgentsRetrieveSuspense(
60
60
  agentId: string,
@@ -28,10 +28,10 @@ import {
28
28
  export type ClientAgentsRetrieveSchemasQueryData = components.AgentSchemas;
29
29
 
30
30
  /**
31
- * Get Agent Schemas
31
+ * List an agent's schemas
32
32
  *
33
33
  * @remarks
34
- * 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.
34
+ * 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.
35
35
  */
36
36
  export function useClientAgentsRetrieveSchemas(
37
37
  agentId: string,
@@ -51,10 +51,10 @@ export function useClientAgentsRetrieveSchemas(
51
51
  }
52
52
 
53
53
  /**
54
- * Get Agent Schemas
54
+ * List an agent's schemas
55
55
  *
56
56
  * @remarks
57
- * 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.
57
+ * 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.
58
58
  */
59
59
  export function useClientAgentsRetrieveSchemasSuspense(
60
60
  agentId: string,
@@ -24,10 +24,10 @@ export type ClientAgentsRunMutationVariables = {
24
24
  export type ClientAgentsRunMutationData = components.AgentRunWaitResponse;
25
25
 
26
26
  /**
27
- * Create Run, Wait for Output
27
+ * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
28
28
  *
29
29
  * @remarks
30
- * 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.
30
+ * Executes an agent run and returns the final response.
31
31
  */
32
32
  export function useClientAgentsRunMutation(
33
33
  options?: MutationHookOptions<
@@ -24,10 +24,10 @@ export type ClientAgentsRunStreamMutationVariables = {
24
24
  export type ClientAgentsRunStreamMutationData = string;
25
25
 
26
26
  /**
27
- * Create Run, Stream Output
27
+ * Create an agent run and stream the response
28
28
  *
29
29
  * @remarks
30
- * 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.
30
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
31
31
  */
32
32
  export function useClientAgentsRunStreamMutation(
33
33
  options?: MutationHookOptions<
@@ -25,7 +25,7 @@ export type ClientGovernanceDataPoliciesCreateMutationData =
25
25
  components.CreateDlpReportResponse;
26
26
 
27
27
  /**
28
- * Creates new policy.
28
+ * Creates new policy
29
29
  *
30
30
  * @remarks
31
31
  * Creates a new policy with specified specifications and returns its id.
@@ -27,7 +27,7 @@ import {
27
27
  export type ClientGovernanceDataPoliciesDownloadQueryData = string;
28
28
 
29
29
  /**
30
- * Downloads violations CSV for policy.
30
+ * Downloads violations CSV for policy
31
31
  *
32
32
  * @remarks
33
33
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -48,7 +48,7 @@ export function useClientGovernanceDataPoliciesDownload(
48
48
  }
49
49
 
50
50
  /**
51
- * Downloads violations CSV for policy.
51
+ * Downloads violations CSV for policy
52
52
  *
53
53
  * @remarks
54
54
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -29,7 +29,7 @@ export type ClientGovernanceDataPoliciesListQueryData =
29
29
  components.ListDlpReportsResponse;
30
30
 
31
31
  /**
32
- * Lists policies.
32
+ * Lists policies
33
33
  *
34
34
  * @remarks
35
35
  * Lists policies with filtering.
@@ -52,7 +52,7 @@ export function useClientGovernanceDataPoliciesList(
52
52
  }
53
53
 
54
54
  /**
55
- * Lists policies.
55
+ * Lists policies
56
56
  *
57
57
  * @remarks
58
58
  * Lists policies with filtering.
@@ -29,7 +29,7 @@ export type ClientGovernanceDataPoliciesRetrieveQueryData =
29
29
  components.GetDlpReportResponse;
30
30
 
31
31
  /**
32
- * Gets specified Policy.
32
+ * Gets specified policy
33
33
  *
34
34
  * @remarks
35
35
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -52,7 +52,7 @@ export function useClientGovernanceDataPoliciesRetrieve(
52
52
  }
53
53
 
54
54
  /**
55
- * Gets specified Policy.
55
+ * Gets specified policy
56
56
  *
57
57
  * @remarks
58
58
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -26,7 +26,7 @@ export type ClientGovernanceDataPoliciesUpdateMutationData =
26
26
  components.UpdateDlpReportResponse;
27
27
 
28
28
  /**
29
- * Updates an existing policy.
29
+ * Updates an existing policy
30
30
  *
31
31
  * @remarks
32
32
  * Updates an existing policy.
@@ -25,7 +25,7 @@ export type ClientGovernanceDataReportsCreateMutationData =
25
25
  components.UpdateDlpConfigResponse;
26
26
 
27
27
  /**
28
- * Creates new one-time report.
28
+ * Creates new one-time report
29
29
  *
30
30
  * @remarks
31
31
  * Creates a new one-time report and executes its batch job.
@@ -27,7 +27,7 @@ import {
27
27
  export type ClientGovernanceDataReportsDownloadQueryData = string;
28
28
 
29
29
  /**
30
- * Downloads violations CSV for report.
30
+ * Downloads violations CSV for report
31
31
  *
32
32
  * @remarks
33
33
  * Downloads CSV violations report for a specific report id.
@@ -48,7 +48,7 @@ export function useClientGovernanceDataReportsDownload(
48
48
  }
49
49
 
50
50
  /**
51
- * Downloads violations CSV for report.
51
+ * Downloads violations CSV for report
52
52
  *
53
53
  * @remarks
54
54
  * Downloads CSV violations report for a specific report id.
@@ -29,7 +29,7 @@ export type ClientGovernanceDataReportsStatusQueryData =
29
29
  components.ReportStatusResponse;
30
30
 
31
31
  /**
32
- * Fetches report run status.
32
+ * Fetches report run status
33
33
  *
34
34
  * @remarks
35
35
  * Fetches the status of the run corresponding to the report-id.
@@ -50,7 +50,7 @@ export function useClientGovernanceDataReportsStatus(
50
50
  }
51
51
 
52
52
  /**
53
- * Fetches report run status.
53
+ * Fetches report run status
54
54
  *
55
55
  * @remarks
56
56
  * Fetches the status of the run corresponding to the report-id.
@@ -26,7 +26,7 @@ export type ClientGovernanceDocumentsVisibilityoverridesCreateMutationData =
26
26
  components.UpdateDocumentVisibilityOverridesResponse;
27
27
 
28
28
  /**
29
- * Hide/Un-hide docs.
29
+ * Hide or unhide docs
30
30
  *
31
31
  * @remarks
32
32
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.
@@ -29,7 +29,7 @@ export type ClientGovernanceDocumentsVisibilityoverridesListQueryData =
29
29
  components.GetDocumentVisibilityOverridesResponse;
30
30
 
31
31
  /**
32
- * Fetches documents visibility.
32
+ * Fetches documents visibility
33
33
  *
34
34
  * @remarks
35
35
  * Fetches the visibility override status of the documents passed.
@@ -55,7 +55,7 @@ export function useClientGovernanceDocumentsVisibilityoverridesList(
55
55
  }
56
56
 
57
57
  /**
58
- * Fetches documents visibility.
58
+ * Fetches documents visibility
59
59
  *
60
60
  * @remarks
61
61
  * Fetches the visibility override status of the documents passed.
package/src/sdk/agents.ts CHANGED
@@ -13,10 +13,10 @@ import { unwrapAsync } from "../types/fp.js";
13
13
 
14
14
  export class Agents extends ClientSDK {
15
15
  /**
16
- * Get Agent
16
+ * Retrieve an agent
17
17
  *
18
18
  * @remarks
19
- * 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.
19
+ * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
20
20
  */
21
21
  async retrieve(
22
22
  agentId: string,
@@ -32,10 +32,10 @@ export class Agents extends ClientSDK {
32
32
  }
33
33
 
34
34
  /**
35
- * Get Agent Schemas
35
+ * List an agent's schemas
36
36
  *
37
37
  * @remarks
38
- * 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.
38
+ * 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.
39
39
  */
40
40
  async retrieveSchemas(
41
41
  agentId: string,
@@ -51,10 +51,10 @@ export class Agents extends ClientSDK {
51
51
  }
52
52
 
53
53
  /**
54
- * Search Agents
54
+ * Search agents
55
55
  *
56
56
  * @remarks
57
- * 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.
57
+ * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
58
58
  */
59
59
  async list(
60
60
  request: components.SearchAgentsRequest,
@@ -68,10 +68,10 @@ export class Agents extends ClientSDK {
68
68
  }
69
69
 
70
70
  /**
71
- * Create Run, Stream Output
71
+ * Create an agent run and stream the response
72
72
  *
73
73
  * @remarks
74
- * 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.
74
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
75
75
  */
76
76
  async runStream(
77
77
  request: components.AgentRunCreate,
@@ -85,10 +85,10 @@ export class Agents extends ClientSDK {
85
85
  }
86
86
 
87
87
  /**
88
- * Create Run, Wait for Output
88
+ * Create an [agent](https://developers.glean.com/agents/agents-api) run and wait for the response
89
89
  *
90
90
  * @remarks
91
- * 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.
91
+ * Executes an agent run and returns the final response.
92
92
  */
93
93
  async run(
94
94
  request: components.AgentRunCreate,