@squidcloud/client 1.0.439 → 1.0.441
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.
- package/dist/cjs/index.js +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/internal-common/src/public-types/ai-agent-integrations.public-types.d.ts +3 -17
- package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +7 -3
- package/dist/internal-common/src/public-types/ai-function.public-types.d.ts +50 -0
- package/dist/internal-common/src/types/ai-agent.types.d.ts +9 -0
- package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts +14 -0
- package/dist/typescript-client/src/ai-client.d.ts +6 -0
- package/dist/typescript-client/src/management-client.d.ts +3 -11
- package/dist/typescript-client/src/public-types.d.ts +2 -0
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -1,27 +1,13 @@
|
|
|
1
|
+
import { AiQueryOptions } from './ai-query.public-types';
|
|
1
2
|
import { AiAgentId } from './communication.public-types';
|
|
2
3
|
/**
|
|
3
4
|
* Configuration options for AI agent database integration.
|
|
4
5
|
*/
|
|
5
6
|
export interface AiAgentDatabaseIntegrationOptions {
|
|
6
|
-
/**
|
|
7
|
-
* A list of collection (or table) name filters that the AI agent can query data from.
|
|
8
|
-
*
|
|
9
|
-
* Currently, the following filters are supported:
|
|
10
|
-
* - Exact match: Only collection names that exactly match the filter can be used for AI queries. This is case-sensitive.
|
|
11
|
-
*
|
|
12
|
-
* When this list is not provided (i.e., it is `undefined`) or is empty, the AI agent has access to all collections.
|
|
13
|
-
*/
|
|
14
|
-
collectionsToUse?: string[];
|
|
15
|
-
/** If true, disables the code interpreter when analyzing query results. Default: false. */
|
|
16
|
-
disableCodeInterpreter?: boolean;
|
|
17
|
-
/** Disables the whole analyze stage (includes code interpreter). */
|
|
18
|
-
disableAnalyzeStage?: boolean;
|
|
19
|
-
/** Enables raw results in the response. */
|
|
20
|
-
enableRawResults?: boolean;
|
|
21
7
|
/** If true, provides more detailed status updates during AI query execution. Default: false. */
|
|
22
8
|
verboseStatusUpdates?: boolean;
|
|
23
|
-
/**
|
|
24
|
-
|
|
9
|
+
/** Full AI query options for advanced configuration of the query execution. */
|
|
10
|
+
aiQueryOptions?: AiQueryOptions;
|
|
25
11
|
}
|
|
26
12
|
/**
|
|
27
13
|
* Configuration options for AI agent API integration.
|
|
@@ -39,12 +39,12 @@ export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-4", "grok-4-1-fast-r
|
|
|
39
39
|
* Public Anthropic chat model names (active models only).
|
|
40
40
|
* @category AI
|
|
41
41
|
*/
|
|
42
|
-
export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929"];
|
|
42
|
+
export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-haiku-4-5-20251001", "claude-opus-4-6", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929"];
|
|
43
43
|
/**
|
|
44
44
|
* The supported AI model names.
|
|
45
45
|
* @category AI
|
|
46
46
|
*/
|
|
47
|
-
export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5-mini", "gpt-5-nano", "gpt-5.2", "gpt-5.2-pro", "claude-haiku-4-5-20251001", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929", "gemini-3-pro", "gemini-3-flash", "grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
|
|
47
|
+
export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-5-mini", "gpt-5-nano", "gpt-5.2", "gpt-5.2-pro", "claude-haiku-4-5-20251001", "claude-opus-4-6", "claude-opus-4-5-20251101", "claude-sonnet-4-5-20250929", "gemini-3-pro", "gemini-3-flash", "grok-4", "grok-4-1-fast-reasoning", "grok-4-1-fast-non-reasoning"];
|
|
48
48
|
/** Checks if the given model name is a global AI chat model name. */
|
|
49
49
|
export declare function isVendorAiChatModelName(modelName: unknown): modelName is VendorAiChatModelName;
|
|
50
50
|
/**
|
|
@@ -58,7 +58,11 @@ export declare const VOYAGE_EMBEDDING_MODEL_NAMES: readonly ["voyage-3-large"];
|
|
|
58
58
|
/**
|
|
59
59
|
* @category AI
|
|
60
60
|
*/
|
|
61
|
-
export declare const
|
|
61
|
+
export declare const BEDROCK_EMBEDDING_MODEL_NAMES: readonly ["titan-embed-text-v2"];
|
|
62
|
+
/**
|
|
63
|
+
* @category AI
|
|
64
|
+
*/
|
|
65
|
+
export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-small", "voyage-3-large", "titan-embed-text-v2"];
|
|
62
66
|
/**
|
|
63
67
|
* Checks if the given model name is a valid AI embeddings model name.
|
|
64
68
|
* @category AI
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { AiFileUrl } from './ai-agent.public-types';
|
|
2
|
+
import { ServiceFunctionName } from './backend.public-types';
|
|
3
|
+
import { IntegrationType } from './integration.public-types';
|
|
4
|
+
/** Represents the possible data types for an AI function parameter. */
|
|
5
|
+
export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date' | 'files';
|
|
6
|
+
/** Defines the structure of a parameter for an AI function. */
|
|
7
|
+
export interface AiFunctionParam {
|
|
8
|
+
/** Name of the parameter. */
|
|
9
|
+
name: string;
|
|
10
|
+
/** Description of the parameter's purpose. */
|
|
11
|
+
description: string;
|
|
12
|
+
/** Data type of the parameter. */
|
|
13
|
+
type: AiFunctionParamType;
|
|
14
|
+
/** Indicates if the parameter is mandatory. */
|
|
15
|
+
required: boolean;
|
|
16
|
+
/** List of possible values for the parameter, if applicable. */
|
|
17
|
+
enum?: Array<Omit<AiFunctionParamType, 'date'>>;
|
|
18
|
+
}
|
|
19
|
+
/** Represents an AI function response that also includes files. */
|
|
20
|
+
export interface AiFunctionResponseWithFiles<ResponseType = unknown> {
|
|
21
|
+
/** Indicates that this is an AI function response with files. */
|
|
22
|
+
__isAiFunctionResponseWithFiles: true;
|
|
23
|
+
/** The response from the AI function. */
|
|
24
|
+
response: ResponseType;
|
|
25
|
+
/** Optional list of files associated with the response. */
|
|
26
|
+
files: Array<AiFileUrl>;
|
|
27
|
+
}
|
|
28
|
+
/** Additional optional readonly metadata for AI function. */
|
|
29
|
+
export interface AiFunctionAttributes {
|
|
30
|
+
/**
|
|
31
|
+
* Type of integration this function is used for.
|
|
32
|
+
* Functions with defined 'integrationType' require 'integrationId' to be passed as part of the function context.
|
|
33
|
+
*/
|
|
34
|
+
integrationType?: Array<IntegrationType>;
|
|
35
|
+
}
|
|
36
|
+
/** Metadata describing an AI function available in the application. */
|
|
37
|
+
export interface AiFunctionMetadata {
|
|
38
|
+
/** The fully qualified name of the function (serviceName:functionName). */
|
|
39
|
+
serviceFunction: ServiceFunctionName;
|
|
40
|
+
/** Description of what the function does. */
|
|
41
|
+
description: string;
|
|
42
|
+
/** Parameters that the function accepts. */
|
|
43
|
+
params: Array<AiFunctionParam>;
|
|
44
|
+
/** Additional attributes for the function. */
|
|
45
|
+
attributes?: AiFunctionAttributes;
|
|
46
|
+
/** Categories this function belongs to. */
|
|
47
|
+
categories?: string[];
|
|
48
|
+
/** Whether this function is internal and not meant for direct use. */
|
|
49
|
+
internal?: boolean;
|
|
50
|
+
}
|
|
@@ -112,6 +112,10 @@ export interface SetAgentOptionInPathRequest {
|
|
|
112
112
|
path: string;
|
|
113
113
|
value: unknown;
|
|
114
114
|
}
|
|
115
|
+
export interface SetAgentDescriptionRequest {
|
|
116
|
+
agentId: AiAgentId;
|
|
117
|
+
description: string;
|
|
118
|
+
}
|
|
115
119
|
export interface ListAgentContextsRequest {
|
|
116
120
|
agentId: AiAgentId;
|
|
117
121
|
}
|
|
@@ -172,6 +176,11 @@ export interface ProvideAgentFeedbackRequest {
|
|
|
172
176
|
agentId: string;
|
|
173
177
|
feedback: string;
|
|
174
178
|
}
|
|
179
|
+
export interface BuildAgentRequest {
|
|
180
|
+
agentId: string;
|
|
181
|
+
request: string;
|
|
182
|
+
memoryId?: string;
|
|
183
|
+
}
|
|
175
184
|
export interface UploadAiFileRequest {
|
|
176
185
|
/** AI provider to upload file to. */
|
|
177
186
|
provider: AiProviderType;
|
|
@@ -176,12 +176,26 @@ export declare class AiAgentReference {
|
|
|
176
176
|
* Sets a value at a specific path within the agent's options.
|
|
177
177
|
*/
|
|
178
178
|
setAgentOptionInPath(path: Paths<AllAiAgentChatOptions> | string, value: unknown): Promise<void>;
|
|
179
|
+
/**
|
|
180
|
+
* Sets the agent's description.
|
|
181
|
+
*/
|
|
182
|
+
setAgentDescription(description: string): Promise<void>;
|
|
179
183
|
/**
|
|
180
184
|
* Submits a feedback string for the agent. Requires an API Key.
|
|
181
185
|
* This feedback may update the agent's instructions, connected integrations, and may be forwarded to connected agents.
|
|
182
186
|
* @param feedback The feedback to provide for the agent.
|
|
183
187
|
*/
|
|
184
188
|
provideFeedback(feedback: string): Promise<string>;
|
|
189
|
+
/**
|
|
190
|
+
* Uses an AI builder agent to modify this agent based on a natural language request. Requires an API Key.
|
|
191
|
+
* The builder can update instructions, connect/disconnect integrations, add/remove functions,
|
|
192
|
+
* connect other agents, manage knowledge bases, and configure guardrails.
|
|
193
|
+
*
|
|
194
|
+
* @param request A natural language description of what you want to build or change.
|
|
195
|
+
* @param memoryId Optional memory ID for conversation history. If not provided, defaults to 'no-memory' (no persistence).
|
|
196
|
+
* @returns A string describing what changes were made.
|
|
197
|
+
*/
|
|
198
|
+
build(request: string, memoryId?: string): Promise<string>;
|
|
185
199
|
/**
|
|
186
200
|
* Helper to replace ${id:fileId} tags in the AI output with their corresponding Markdown.
|
|
187
201
|
* @param aiResponse
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { Observable } from 'rxjs';
|
|
2
|
+
import { AiFunctionMetadata } from '../../internal-common/src/public-types/ai-function.public-types';
|
|
2
3
|
import { AiQueryOptions, AiQueryResponse, ExecuteAiApiResponse } from '../../internal-common/src/public-types/ai-query.public-types';
|
|
3
4
|
import { AiAgentClientOptions } from './agent/ai-agent-client';
|
|
4
5
|
import { AiAgentReference } from './agent/ai-agent-client-reference';
|
|
@@ -38,6 +39,11 @@ export declare class AiClient {
|
|
|
38
39
|
* Lists all available AI agents.
|
|
39
40
|
*/
|
|
40
41
|
listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
|
|
42
|
+
/**
|
|
43
|
+
* Lists all available AI functions in the application.
|
|
44
|
+
* @returns A promise that resolves to an array of AI function metadata.
|
|
45
|
+
*/
|
|
46
|
+
listFunctions(): Promise<Array<AiFunctionMetadata>>;
|
|
41
47
|
/**
|
|
42
48
|
* Retrieves an AI image client.
|
|
43
49
|
*/
|
|
@@ -1,9 +1,4 @@
|
|
|
1
1
|
import { SquidRegion } from '../../internal-common/src/public-types/regions.public-types';
|
|
2
|
-
/**
|
|
3
|
-
* Supported cloud providers for application creation.
|
|
4
|
-
* @category ManagementClient
|
|
5
|
-
*/
|
|
6
|
-
export type ManagementCloudId = 'aws' | 'gcp' | 'azure';
|
|
7
2
|
/**
|
|
8
3
|
* Options for creating a ManagementClient.
|
|
9
4
|
* @category ManagementClient
|
|
@@ -39,10 +34,8 @@ export interface ManagementCreateApplicationRequest {
|
|
|
39
34
|
organizationId: string;
|
|
40
35
|
/** Name of the application */
|
|
41
36
|
name: string;
|
|
42
|
-
/**
|
|
43
|
-
|
|
44
|
-
/** Region within the cloud provider (e.g., 'us-east-1') */
|
|
45
|
-
region: string;
|
|
37
|
+
/** Squid region (e.g., 'us-east-1.aws'). The cloud provider is parsed from this. */
|
|
38
|
+
region: SquidRegion;
|
|
46
39
|
}
|
|
47
40
|
/**
|
|
48
41
|
* Response from creating a new application.
|
|
@@ -80,8 +73,7 @@ export interface ManagementDeleteApplicationRequest {
|
|
|
80
73
|
* const { appId } = await client.createApplication({
|
|
81
74
|
* organizationId,
|
|
82
75
|
* name: 'My App',
|
|
83
|
-
*
|
|
84
|
-
* region: 'us-east-1'
|
|
76
|
+
* region: 'us-east-1.aws'
|
|
85
77
|
* });
|
|
86
78
|
*
|
|
87
79
|
* // Delete an application
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
|
|
2
2
|
export * from '../../internal-common/src/public-types/ai-agent.public-types';
|
|
3
|
+
/** AI function metadata types for listing and describing available functions. */
|
|
3
4
|
export * from '../../internal-common/src/public-types/ai-common.public-types';
|
|
5
|
+
export * from '../../internal-common/src/public-types/ai-function.public-types';
|
|
4
6
|
export * from '../../internal-common/src/public-types/ai-knowledge-base.public-types';
|
|
5
7
|
export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';
|
|
6
8
|
export * from '../../internal-common/src/public-types/ai-query.public-types';
|