@squidcloud/client 1.0.404 → 1.0.406
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/metric-name.d.ts +1 -1
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +59 -1
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +2 -2
- package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +14 -2
- package/dist/internal-common/src/types/ai-knowledge-base.types.d.ts +1 -1
- package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts +1 -25
- package/dist/typescript-client/src/ai-client.d.ts +1 -0
- package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts +11 -3
- package/dist/typescript-client/src/ai-matchmaking-client.d.ts +1 -0
- package/dist/typescript-client/src/squid.d.ts +12 -0
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Should be in sync with MetricName.kt.
|
|
4
4
|
* See MetricName.kt for documentation on each value.
|
|
5
5
|
*/
|
|
6
|
-
export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "
|
|
6
|
+
export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
|
|
7
7
|
export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
|
|
8
8
|
/** Common prefix for all Squid metrics. */
|
|
9
9
|
export declare const SQUID_METRIC_NAME_PREFIX = "squid_";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AgentContextRequest, UpsertContextStatusError } from './ai-agent.public-types';
|
|
2
2
|
import { AiChatModelName, AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
|
|
3
|
-
import { AiContextId, AiKnowledgeBaseId } from './communication.public-types';
|
|
3
|
+
import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types';
|
|
4
4
|
import { DocumentExtractionMethod } from './extraction.public-types';
|
|
5
5
|
/**
|
|
6
6
|
* Represents an AI knowledge base that can be attached to an AI agent.
|
|
@@ -9,6 +9,8 @@ import { DocumentExtractionMethod } from './extraction.public-types';
|
|
|
9
9
|
export interface AiKnowledgeBase {
|
|
10
10
|
/** The unique identifier of the knowledge base.*/
|
|
11
11
|
id: AiKnowledgeBaseId;
|
|
12
|
+
/** The app id that the knowledge base belongs to. */
|
|
13
|
+
appId: AppId;
|
|
12
14
|
/** The description of the knowledge base - will be used by AI agents.*/
|
|
13
15
|
description: string;
|
|
14
16
|
/** A set of predefined metadata fields for the knowledge base that can be used for filtering.*/
|
|
@@ -17,6 +19,8 @@ export interface AiKnowledgeBase {
|
|
|
17
19
|
embeddingModel: AiEmbeddingsModelName;
|
|
18
20
|
/** The model name that should be used when asking questions of this knowledge base. */
|
|
19
21
|
chatModel: AiChatModelName;
|
|
22
|
+
/** The timestamp the knowledge base was last updated */
|
|
23
|
+
updatedAt: Date;
|
|
20
24
|
}
|
|
21
25
|
/**
|
|
22
26
|
* Represents a field in an AI knowledge base metadata.
|
|
@@ -263,6 +267,8 @@ export interface AiKnowledgeBaseSearchOptions {
|
|
|
263
267
|
* @category AI
|
|
264
268
|
*/
|
|
265
269
|
export interface AiKnowledgeBaseSearchResultChunk {
|
|
270
|
+
/** The unique identifier of the context. */
|
|
271
|
+
contextId: string;
|
|
266
272
|
/** The data content of the search result chunk. */
|
|
267
273
|
data: string;
|
|
268
274
|
/** Optional metadata associated with the chunk. */
|
|
@@ -298,6 +304,58 @@ export interface AiKnowledgeBaseSearchRequest {
|
|
|
298
304
|
/** The search options for this search */
|
|
299
305
|
options: AiKnowledgeBaseSearchOptions;
|
|
300
306
|
}
|
|
307
|
+
/**
|
|
308
|
+
* Request structure for searching AI contexts in the AiKnowledgeBase.
|
|
309
|
+
* @category AI
|
|
310
|
+
*/
|
|
311
|
+
export interface BaseAiKnowledgeBaseSearchContextsRequest {
|
|
312
|
+
/** The id of the AiKnowledgeBase */
|
|
313
|
+
knowledgeBaseId: AiKnowledgeBaseId;
|
|
314
|
+
/** The maximum number of results to return */
|
|
315
|
+
limit?: number;
|
|
316
|
+
/** A set of filters that will limit the context the AI can access. */
|
|
317
|
+
contextMetadataFilter?: AiContextMetadataFilter;
|
|
318
|
+
/** Whether to rerank the results with AI and provide reasoning - defaults to true */
|
|
319
|
+
rerank?: boolean;
|
|
320
|
+
/** Which chat model to use when doing reranking */
|
|
321
|
+
chatModel?: string;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* Request structure for searching AI contexts in the AiKnowledgeBase with prompt.
|
|
325
|
+
* @category AI
|
|
326
|
+
*/
|
|
327
|
+
export interface AiKnowledgeBaseSearchContextsWithPromptRequest extends BaseAiKnowledgeBaseSearchContextsRequest {
|
|
328
|
+
/** The user prompt to search on */
|
|
329
|
+
prompt: string;
|
|
330
|
+
}
|
|
331
|
+
/**
|
|
332
|
+
* Request structure for searching AI contexts in the AiKnowledgeBase with an existing context.
|
|
333
|
+
* @category AI
|
|
334
|
+
*/
|
|
335
|
+
export interface AiKnowledgeBaseSearchContextsWithContextIdRequest extends BaseAiKnowledgeBaseSearchContextsRequest {
|
|
336
|
+
/** The contextId to search with */
|
|
337
|
+
contextId: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* A context with reasoning and matching score.
|
|
341
|
+
* @category AI
|
|
342
|
+
*/
|
|
343
|
+
export interface AiKnowledgeBaseContextWithReasoning {
|
|
344
|
+
/** The actual context */
|
|
345
|
+
context: AiKnowledgeBaseContext;
|
|
346
|
+
/** The reasoning behind why this context was matched - can be undefined if no reasoning was requested */
|
|
347
|
+
reasoning?: string;
|
|
348
|
+
/** The score of the match, ranging from 0 to 100, where 100 is the best match. */
|
|
349
|
+
score: number;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* Response structure for searching contexts in an AiKnowledgeBase.
|
|
353
|
+
* @category AI
|
|
354
|
+
*/
|
|
355
|
+
export interface AiKnowledgeBaseSearchContextsResponse {
|
|
356
|
+
/** The resulting contexts, with reasoning if it was requested */
|
|
357
|
+
results: Array<AiKnowledgeBaseContextWithReasoning>;
|
|
358
|
+
}
|
|
301
359
|
/**
|
|
302
360
|
* Request structure for requesting a download link to the context file that you previously provided.
|
|
303
361
|
* @category AI
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { IntegrationId } from './communication.public-types';
|
|
2
2
|
/** List of all integration types supported by Squid. */
|
|
3
|
-
export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a"];
|
|
3
|
+
export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jwt_hmac", "jwt_rsa", "kafka", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce_crm", "sap_hana", "sentry", "servicenow", "snowflake", "spanner", "xata", "zendesk", "mail", "slack", "mcp", "a2a", "legend"];
|
|
4
4
|
/**
|
|
5
5
|
* @category Database
|
|
6
6
|
*/
|
|
7
|
-
export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch"];
|
|
7
|
+
export declare const DATA_INTEGRATION_TYPES: readonly ["bigquery", "built_in_db", "clickhouse", "cockroach", "mongo", "mssql", "databricks", "mysql", "oracledb", "postgres", "sap_hana", "snowflake", "elasticsearch", "legend"];
|
|
8
8
|
/**
|
|
9
9
|
* @category Auth
|
|
10
10
|
*/
|
|
@@ -3,7 +3,7 @@ import { IntegrationId } from '../public-types/communication.public-types';
|
|
|
3
3
|
* Represents the type of native query request, either relational, elastic or MongoDB.
|
|
4
4
|
* @category Database
|
|
5
5
|
*/
|
|
6
|
-
export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch';
|
|
6
|
+
export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
|
|
7
7
|
interface BaseNativeQueryContext {
|
|
8
8
|
/** Type of the native query request. */
|
|
9
9
|
type: NativeQueryRequestType;
|
|
@@ -52,9 +52,21 @@ export interface ElasticsearchNativeQueryContext {
|
|
|
52
52
|
/** Headers to include in the request. */
|
|
53
53
|
integrationId: IntegrationId;
|
|
54
54
|
}
|
|
55
|
+
/**
|
|
56
|
+
* Context for executing a pure database query.
|
|
57
|
+
* @category Database
|
|
58
|
+
*/
|
|
59
|
+
export interface PureNativeQueryContext extends BaseNativeQueryContext {
|
|
60
|
+
/** Specifies that the query is for a relational database. */
|
|
61
|
+
type: 'pure';
|
|
62
|
+
/** SQL query string to be executed. */
|
|
63
|
+
query: string;
|
|
64
|
+
/** Parameters to be used in the query. */
|
|
65
|
+
params: Record<string, any>;
|
|
66
|
+
}
|
|
55
67
|
/**
|
|
56
68
|
* Union type representing either a relational or MongoDB native query context.
|
|
57
69
|
* @category Database
|
|
58
70
|
*/
|
|
59
|
-
export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext;
|
|
71
|
+
export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
|
|
60
72
|
export {};
|
|
@@ -40,7 +40,7 @@ export interface DeleteAiKnowledgeBaseRequest {
|
|
|
40
40
|
*/
|
|
41
41
|
export interface UpsertAiKnowledgeBaseRequest {
|
|
42
42
|
/** The AiKnowledgeBase to upsert */
|
|
43
|
-
knowledgeBase: AiKnowledgeBaseWithOptionalChatModel
|
|
43
|
+
knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'appId' | 'updatedAt'>;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
46
|
* Response structure for listing AiKnowledgeBases
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Observable } from 'rxjs';
|
|
2
|
-
import {
|
|
2
|
+
import { AiAgent, AiChatMessage, AiConnectedAgentMetadata, AiSearchOptions, AiSearchResultChunk, AiStatusMessage, AiTranscribeAndAskResponse, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
|
|
3
3
|
import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
|
|
4
4
|
import { JobId } from '../../../internal-common/src/public-types/job.public-types';
|
|
5
5
|
import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskResponse, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
|
|
@@ -45,30 +45,6 @@ export declare class AiAgentReference {
|
|
|
45
45
|
* Updates the list of agents connected to this agent.
|
|
46
46
|
*/
|
|
47
47
|
updateConnectedAgents(connectedAgents: Array<AiConnectedAgentMetadata>): Promise<void>;
|
|
48
|
-
/**
|
|
49
|
-
* Retrieves a specific agent context by its ID.
|
|
50
|
-
*/
|
|
51
|
-
getContext(contextId: string): Promise<AiAgentContext | undefined>;
|
|
52
|
-
/**
|
|
53
|
-
* Lists all contexts associated with the agent.
|
|
54
|
-
*/
|
|
55
|
-
listContexts(): Promise<Array<AiAgentContext>>;
|
|
56
|
-
/**
|
|
57
|
-
* Deletes a specific context by its ID.
|
|
58
|
-
*/
|
|
59
|
-
deleteContext(contextId: string): Promise<void>;
|
|
60
|
-
/**
|
|
61
|
-
* Deletes multiple agent contexts.
|
|
62
|
-
*/
|
|
63
|
-
deleteContexts(contextIds: Array<string>): Promise<void>;
|
|
64
|
-
/**
|
|
65
|
-
* Adds or updates a single agent context.
|
|
66
|
-
*/
|
|
67
|
-
upsertContext(contextRequest: AgentContextRequest, file?: File): Promise<UpsertAgentContextResponse>;
|
|
68
|
-
/**
|
|
69
|
-
* Adds or updates multiple agent contexts.
|
|
70
|
-
*/
|
|
71
|
-
upsertContexts(contextRequests: Array<AgentContextRequest>, files?: Array<File>): Promise<UpsertAgentContextsResponse>;
|
|
72
48
|
/**
|
|
73
49
|
* Sends user feedback to the agent.
|
|
74
50
|
*/
|
package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
|
|
1
|
+
import { AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
|
|
2
2
|
import { AiContextId } from '../../../internal-common/src/public-types/communication.public-types';
|
|
3
3
|
/**
|
|
4
4
|
* Parameters for creating or updating an AI agent.
|
|
@@ -27,7 +27,7 @@ export declare class AiKnowledgeBaseReference {
|
|
|
27
27
|
* Upserts the AI knowledge base.
|
|
28
28
|
* @param knowledgeBase
|
|
29
29
|
*/
|
|
30
|
-
upsertKnowledgeBase(knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'id'>): Promise<void>;
|
|
30
|
+
upsertKnowledgeBase(knowledgeBase: Omit<AiKnowledgeBaseWithOptionalChatModel, 'id' | 'appId' | 'updatedAt'>): Promise<void>;
|
|
31
31
|
/**
|
|
32
32
|
* Deletes the AI knowledge base.
|
|
33
33
|
* @returns A promise that resolves when the deletion is complete.
|
|
@@ -62,11 +62,19 @@ export declare class AiKnowledgeBaseReference {
|
|
|
62
62
|
*/
|
|
63
63
|
upsertContexts(contextRequests: Array<AiKnowledgeBaseContextRequest>, files?: Array<File>): Promise<UpsertKnowledgeBaseContextsResponse>;
|
|
64
64
|
/**
|
|
65
|
-
* Performs a semantic search in the knowledge base.
|
|
65
|
+
* Performs a semantic search in the knowledge base and returns chunks from the different contexts.
|
|
66
66
|
*/
|
|
67
67
|
search(options: AiKnowledgeBaseChatOptions & {
|
|
68
68
|
prompt: string;
|
|
69
69
|
}): Promise<Array<AiKnowledgeBaseSearchResultChunk>>;
|
|
70
|
+
/**
|
|
71
|
+
* Performs a semantic search in the knowledge base and returns contexts with reasoning.
|
|
72
|
+
*/
|
|
73
|
+
searchContextsWithPrompt(request: Omit<AiKnowledgeBaseSearchContextsWithPromptRequest, 'knowledgeBaseId'>): Promise<Array<AiKnowledgeBaseContextWithReasoning>>;
|
|
74
|
+
/**
|
|
75
|
+
* Performs a semantic search in the knowledge base and returns contexts with reasoning.
|
|
76
|
+
*/
|
|
77
|
+
searchContextsWithContextId(request: Omit<AiKnowledgeBaseSearchContextsWithContextIdRequest, 'knowledgeBaseId'>): Promise<Array<AiKnowledgeBaseContextWithReasoning>>;
|
|
70
78
|
/**
|
|
71
79
|
* Gets the download URL for the requested context.
|
|
72
80
|
*
|
|
@@ -3,6 +3,7 @@ import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, M
|
|
|
3
3
|
* Client for the AI Matchmaking service. This service allows you to create matchmakers and insert entities into them.
|
|
4
4
|
* The service will then find matches for the entities.
|
|
5
5
|
* @category AI
|
|
6
|
+
* @deprecated - Use `knowledgebase('kbId').searchContextsWith*()` instead.
|
|
6
7
|
*/
|
|
7
8
|
export declare class AiMatchMakingClient {
|
|
8
9
|
private readonly rpcManager;
|
|
@@ -224,6 +224,18 @@ export declare class Squid {
|
|
|
224
224
|
* @returns A promise that resolves with the result of the query.
|
|
225
225
|
*/
|
|
226
226
|
executeNativeRelationalQuery<T = any>(integrationId: IntegrationId, query: string, params?: Record<string, any>): Promise<Array<T>>;
|
|
227
|
+
/**
|
|
228
|
+
* Executes a native pure query with the given parameters and returns a promise with the result.
|
|
229
|
+
* See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries.
|
|
230
|
+
*
|
|
231
|
+
* @param integrationId The id of the integration that the query is associated with.
|
|
232
|
+
* @param query The raw SQL or database-specific query string to execute. Use named bind variables enclosed in ${},
|
|
233
|
+
* e.g., ${firstName}.
|
|
234
|
+
* @param params (Optional) An object containing key-value pairs to bind to the query variables. Defaults to an empty
|
|
235
|
+
* object.
|
|
236
|
+
* @returns A promise that resolves with the result of the query.
|
|
237
|
+
*/
|
|
238
|
+
executeNativePureQuery<T = any>(integrationId: IntegrationId, query: string, params?: Record<string, any>): Promise<Array<T>>;
|
|
227
239
|
/**
|
|
228
240
|
* Executes a native Mongo/built-in-db query with the given pipeline and returns a promise with the result.
|
|
229
241
|
* See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries#native-mongodb-queries.
|