@squidcloud/client 1.0.421 → 1.0.422

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 (41) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/esm/index.js +1 -1
  3. package/dist/internal-common/src/metric-name.d.ts +9 -0
  4. package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts +30 -0
  5. package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts +148 -0
  6. package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +72 -0
  7. package/dist/internal-common/src/public-types-backend/query.public-context.d.ts +177 -0
  8. package/dist/internal-common/src/types/ai-agent.types.d.ts +199 -0
  9. package/dist/internal-common/src/types/ai-assistant.types.d.ts +1 -0
  10. package/dist/internal-common/src/types/ai-knowledge-base.types.d.ts +202 -0
  11. package/dist/internal-common/src/types/ai-matchmaking.types.d.ts +59 -0
  12. package/dist/internal-common/src/types/backend-function.types.d.ts +1 -0
  13. package/dist/internal-common/src/types/communication.types.d.ts +1 -0
  14. package/dist/internal-common/src/types/document.types.d.ts +1 -0
  15. package/dist/internal-common/src/types/file.types.d.ts +6 -0
  16. package/dist/internal-common/src/types/headers.types.d.ts +17 -0
  17. package/dist/internal-common/src/types/mutation.types.d.ts +1 -0
  18. package/dist/internal-common/src/types/notification.types.d.ts +5 -0
  19. package/dist/internal-common/src/types/observability.types.d.ts +78 -0
  20. package/dist/internal-common/src/types/query.types.d.ts +13 -0
  21. package/dist/internal-common/src/types/secret.types.d.ts +7 -0
  22. package/dist/internal-common/src/types/socket.types.d.ts +1 -0
  23. package/dist/internal-common/src/types/stage.d.ts +9 -0
  24. package/dist/internal-common/src/types/time-units.d.ts +1 -0
  25. package/dist/internal-common/src/types/url-shortener.types.d.ts +41 -0
  26. package/dist/internal-common/src/utils/array.d.ts +7 -0
  27. package/dist/internal-common/src/utils/e2e-test-utils.d.ts +2 -0
  28. package/dist/internal-common/src/utils/global.utils.d.ts +1 -0
  29. package/dist/internal-common/src/utils/http.d.ts +5 -0
  30. package/dist/internal-common/src/utils/lock.manager.d.ts +14 -0
  31. package/dist/internal-common/src/utils/metric-utils.d.ts +4 -0
  32. package/dist/internal-common/src/utils/metrics.types.d.ts +7 -0
  33. package/dist/internal-common/src/utils/object.d.ts +58 -0
  34. package/dist/internal-common/src/utils/serialization.d.ts +17 -0
  35. package/dist/internal-common/src/utils/squid.constants.d.ts +1 -0
  36. package/dist/internal-common/src/utils/trace-id-generator.d.ts +1 -0
  37. package/dist/internal-common/src/utils/validation.d.ts +19 -0
  38. package/dist/internal-common/src/websocket.impl.d.ts +26 -0
  39. package/dist/typescript-client/src/ai-client.d.ts +11 -4
  40. package/dist/typescript-client/src/version.d.ts +1 -1
  41. package/package.json +1 -1
@@ -7,7 +7,7 @@ import { AiFilesClient } from './ai-files-client';
7
7
  import { AiImageClient } from './ai-image-client';
8
8
  import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
9
9
  import { AiMatchMakingClient } from './ai-matchmaking-client';
10
- import { AiAgent, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
10
+ import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
11
11
  /**
12
12
  * AiClient class serves as a facade for interacting with different AI services.
13
13
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -99,10 +99,17 @@ export declare class AiClient {
99
99
  */
100
100
  executeAiQuery(integrationId: IntegrationId, prompt: string, options?: AiQueryOptions): Promise<AiQueryResponse>;
101
101
  /**
102
- * Request to execute an AI-powered API call.
103
- * Allows specifying allowed endpoints and whether to provide an explanation.
102
+ * Executes an AI-powered API call using a specific integration.
103
+ * The AI will select appropriate endpoints, generate request bodies,
104
+ * and analyze responses to answer the provided prompt.
105
+ *
106
+ * @param integrationId - The API integration to use
107
+ * @param prompt - Natural language description of what to accomplish
108
+ * @param options - Optional configuration including allowed endpoints and verbose updates
109
+ * @param sessionContext - Optional session context for audit trails and tracing
110
+ * @returns Promise resolving to the API call result with answer and execution details
104
111
  */
105
- executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean, generateApiCallAgentId?: AiAgentId, sessionContext?: AiSessionContext): Promise<ExecuteAiApiResponse>;
112
+ executeAiApiCall(integrationId: IntegrationId, prompt: string, options?: AiAgentApiIntegrationOptions, sessionContext?: AiSessionContext): Promise<ExecuteAiApiResponse>;
106
113
  /**
107
114
  * Returns name of the secret that stores API key for the given AI provider type.
108
115
  * This API key is used for all requests to the AI provider done from the application.
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.421";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.422";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.421",
3
+ "version": "1.0.422",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",