@squidcloud/client 1.0.304 → 1.0.306

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.
@@ -1,2 +1 @@
1
1
  export declare function getApplicationUrl(regionPrefix: string, appId: string, path: string): string;
2
- export declare function getApplicationHttpHeaders(regionPrefix: string, appId: string): Record<string, string>;
@@ -7,10 +7,12 @@ import { AiMatchMakingClient } from './ai-matchmaking-client';
7
7
  export interface ExecuteAiQueryRequest {
8
8
  integrationId: IntegrationId;
9
9
  prompt: string;
10
+ options?: ExecuteAiQueryOptions;
10
11
  }
11
12
  export interface ExecuteAiQueryMultiRequest {
12
13
  integrationIds: Array<IntegrationId>;
13
14
  prompt: string;
15
+ options?: ExecuteAiQueryOptions;
14
16
  }
15
17
  export interface ExecuteAiApiRequest {
16
18
  integrationId: IntegrationId;
@@ -18,6 +20,10 @@ export interface ExecuteAiApiRequest {
18
20
  allowedEndpoints?: string[];
19
21
  provideExplanation?: boolean;
20
22
  }
23
+ export interface ExecuteAiQueryOptions {
24
+ instructions?: string;
25
+ collectionsToUse?: Array<string>;
26
+ }
21
27
  export interface ExecuteAiQueryResponse {
22
28
  answer: string;
23
29
  explanation?: string;
@@ -93,6 +99,7 @@ export declare class AiClient {
93
99
  * @param prompt The text prompt to send to the AI. This should be formulated in a way that the AI can
94
100
  * understand and respond to, taking into account the nature of the task or the information
95
101
  * sought.
102
+ * @param options Additional options to customize the query execution.
96
103
  * @returns A promise that resolves to an `ExecuteAiQueryResponse`. This response includes the AI's
97
104
  * reply to the provided prompt, along with any other relevant information that is part of
98
105
  * the AI's response. The promise can be awaited to handle the response asynchronously.
@@ -106,8 +113,8 @@ export declare class AiClient {
106
113
  * For more details on the usage and capabilities of the AI Assistant, refer to the documentation provided at
107
114
  * {@link https://docs.squid.cloud/docs/ai}.
108
115
  */
109
- executeAiQuery(integrationId: IntegrationId, prompt: string): Promise<ExecuteAiQueryResponse>;
110
- executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string): Promise<ExecuteAiQueryMultiResponse>;
116
+ executeAiQuery(integrationId: IntegrationId, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryResponse>;
117
+ executeAiQueryMulti(integrationIds: Array<IntegrationId>, prompt: string, options?: ExecuteAiQueryOptions): Promise<ExecuteAiQueryMultiResponse>;
111
118
  executeAiApiCall(integrationId: IntegrationId, prompt: string, allowedEndpoints?: string[], provideExplanation?: boolean): Promise<ExecuteAiApiResponse>;
112
119
  }
113
120
  export {};
@@ -1 +1 @@
1
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.304";
1
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.306";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.304",
3
+ "version": "1.0.306",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "types": "dist/typescript-client/src/index.d.ts",