@gleanwork/api-client 0.14.1 → 0.14.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 (83) hide show
  1. package/dist/commonjs/__tests__/messages.test.js +1 -1
  2. package/dist/commonjs/__tests__/messages.test.js.map +1 -1
  3. package/dist/commonjs/__tests__/summarize.test.js +4 -2
  4. package/dist/commonjs/__tests__/summarize.test.js.map +1 -1
  5. package/dist/commonjs/funcs/clientAgentsRun.d.ts +1 -1
  6. package/dist/commonjs/funcs/clientAgentsRun.js +1 -1
  7. package/dist/commonjs/funcs/clientAgentsRunStream.d.ts +1 -1
  8. package/dist/commonjs/funcs/clientAgentsRunStream.js +1 -1
  9. package/dist/commonjs/lib/config.d.ts +3 -3
  10. package/dist/commonjs/lib/config.js +3 -3
  11. package/dist/commonjs/models/components/actionsummary.d.ts +20 -0
  12. package/dist/commonjs/models/components/actionsummary.d.ts.map +1 -0
  13. package/dist/commonjs/models/components/actionsummary.js +57 -0
  14. package/dist/commonjs/models/components/actionsummary.js.map +1 -0
  15. package/dist/commonjs/models/components/agentrun.d.ts +2 -2
  16. package/dist/commonjs/models/components/agentruncreate.d.ts +2 -2
  17. package/dist/commonjs/models/components/agentschemas.d.ts +5 -0
  18. package/dist/commonjs/models/components/agentschemas.d.ts.map +1 -1
  19. package/dist/commonjs/models/components/agentschemas.js +2 -0
  20. package/dist/commonjs/models/components/agentschemas.js.map +1 -1
  21. package/dist/commonjs/models/components/chatmessage.d.ts +3 -1
  22. package/dist/commonjs/models/components/chatmessage.d.ts.map +1 -1
  23. package/dist/commonjs/models/components/chatmessage.js.map +1 -1
  24. package/dist/commonjs/models/components/index.d.ts +1 -0
  25. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  26. package/dist/commonjs/models/components/index.js +1 -0
  27. package/dist/commonjs/models/components/index.js.map +1 -1
  28. package/dist/commonjs/react-query/clientAgentsRun.d.ts +1 -1
  29. package/dist/commonjs/react-query/clientAgentsRun.js +1 -1
  30. package/dist/commonjs/react-query/clientAgentsRunStream.d.ts +1 -1
  31. package/dist/commonjs/react-query/clientAgentsRunStream.js +1 -1
  32. package/dist/commonjs/sdk/agents.d.ts +2 -2
  33. package/dist/commonjs/sdk/agents.js +2 -2
  34. package/dist/esm/__tests__/messages.test.js +1 -1
  35. package/dist/esm/__tests__/messages.test.js.map +1 -1
  36. package/dist/esm/__tests__/summarize.test.js +4 -2
  37. package/dist/esm/__tests__/summarize.test.js.map +1 -1
  38. package/dist/esm/funcs/clientAgentsRun.d.ts +1 -1
  39. package/dist/esm/funcs/clientAgentsRun.js +1 -1
  40. package/dist/esm/funcs/clientAgentsRunStream.d.ts +1 -1
  41. package/dist/esm/funcs/clientAgentsRunStream.js +1 -1
  42. package/dist/esm/lib/config.d.ts +3 -3
  43. package/dist/esm/lib/config.js +3 -3
  44. package/dist/esm/models/components/actionsummary.d.ts +20 -0
  45. package/dist/esm/models/components/actionsummary.d.ts.map +1 -0
  46. package/dist/esm/models/components/actionsummary.js +20 -0
  47. package/dist/esm/models/components/actionsummary.js.map +1 -0
  48. package/dist/esm/models/components/agentrun.d.ts +2 -2
  49. package/dist/esm/models/components/agentruncreate.d.ts +2 -2
  50. package/dist/esm/models/components/agentschemas.d.ts +5 -0
  51. package/dist/esm/models/components/agentschemas.d.ts.map +1 -1
  52. package/dist/esm/models/components/agentschemas.js +2 -0
  53. package/dist/esm/models/components/agentschemas.js.map +1 -1
  54. package/dist/esm/models/components/chatmessage.d.ts +3 -1
  55. package/dist/esm/models/components/chatmessage.d.ts.map +1 -1
  56. package/dist/esm/models/components/chatmessage.js.map +1 -1
  57. package/dist/esm/models/components/index.d.ts +1 -0
  58. package/dist/esm/models/components/index.d.ts.map +1 -1
  59. package/dist/esm/models/components/index.js +1 -0
  60. package/dist/esm/models/components/index.js.map +1 -1
  61. package/dist/esm/react-query/clientAgentsRun.d.ts +1 -1
  62. package/dist/esm/react-query/clientAgentsRun.js +1 -1
  63. package/dist/esm/react-query/clientAgentsRunStream.d.ts +1 -1
  64. package/dist/esm/react-query/clientAgentsRunStream.js +1 -1
  65. package/dist/esm/sdk/agents.d.ts +2 -2
  66. package/dist/esm/sdk/agents.js +2 -2
  67. package/examples/package-lock.json +1 -1
  68. package/jsr.json +1 -1
  69. package/package.json +1 -1
  70. package/src/__tests__/messages.test.ts +1 -1
  71. package/src/__tests__/summarize.test.ts +4 -2
  72. package/src/funcs/clientAgentsRun.ts +1 -1
  73. package/src/funcs/clientAgentsRunStream.ts +1 -1
  74. package/src/lib/config.ts +3 -3
  75. package/src/models/components/actionsummary.ts +48 -0
  76. package/src/models/components/agentrun.ts +2 -2
  77. package/src/models/components/agentruncreate.ts +2 -2
  78. package/src/models/components/agentschemas.ts +6 -0
  79. package/src/models/components/chatmessage.ts +3 -1
  80. package/src/models/components/index.ts +1 -0
  81. package/src/react-query/clientAgentsRun.ts +1 -1
  82. package/src/react-query/clientAgentsRunStream.ts +1 -1
  83. package/src/sdk/agents.ts +2 -2
@@ -88,7 +88,9 @@ export type ChatMessage = {
88
88
  agentConfig?: AgentConfig | undefined;
89
89
  author?: Author | undefined;
90
90
  /**
91
- * A list of Citations that were used to generate the response.
91
+ * Deprecated: Use inline citations via ChatMessageFragment.citation instead. For detailed reference information, use ChatMessageCitation.referenceRanges. This field is still populated for backward compatibility.
92
+ *
93
+ * @deprecated field: Deprecated on 2026-02-06, removal scheduled for 2026-10-15: Use inline citations via ChatMessageFragment.citation and ChatMessageCitation.referenceRanges instead. This field is still populated for backward compatibility..
92
94
  */
93
95
  citations?: Array<ChatMessageCitation> | undefined;
94
96
  /**
@@ -2,6 +2,7 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
+ export * from "./actionsummary.js";
5
6
  export * from "./activity.js";
6
7
  export * from "./activityevent.js";
7
8
  export * from "./activityeventparams.js";
@@ -47,7 +47,7 @@ export type ClientAgentsRunMutationError =
47
47
  * Create an agent run and wait for the response
48
48
  *
49
49
  * @remarks
50
- * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
50
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
51
51
  */
52
52
  export function useClientAgentsRunMutation(
53
53
  options?: MutationHookOptions<
@@ -47,7 +47,7 @@ export type ClientAgentsRunStreamMutationError =
47
47
  * Create an agent run and stream the response
48
48
  *
49
49
  * @remarks
50
- * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
50
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
51
51
  */
52
52
  export function useClientAgentsRunStreamMutation(
53
53
  options?: MutationHookOptions<
package/src/sdk/agents.ts CHANGED
@@ -75,7 +75,7 @@ export class Agents extends ClientSDK {
75
75
  * Create an agent run and stream the response
76
76
  *
77
77
  * @remarks
78
- * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE).
78
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
79
79
  */
80
80
  async runStream(
81
81
  request: components.AgentRunCreate,
@@ -92,7 +92,7 @@ export class Agents extends ClientSDK {
92
92
  * Create an agent run and wait for the response
93
93
  *
94
94
  * @remarks
95
- * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response.
95
+ * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
96
96
  */
97
97
  async run(
98
98
  request: components.AgentRunCreate,