@squidcloud/client 1.0.449 → 1.0.450
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-common.public-types.d.ts +25 -0
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +3 -3
- package/dist/internal-common/src/public-types/ai-query.public-types.d.ts +14 -0
- package/dist/internal-common/src/public-types/backend.public-types.d.ts +11 -0
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +1 -1
- package/dist/typescript-client/src/query/query.types.d.ts +2 -0
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -68,6 +68,31 @@ export declare const AI_EMBEDDINGS_MODEL_NAMES: readonly ["text-embedding-3-smal
|
|
|
68
68
|
* @category AI
|
|
69
69
|
*/
|
|
70
70
|
export declare function isAiEmbeddingsModelName(modelName: unknown): modelName is AiEmbeddingsModelName;
|
|
71
|
+
/**
|
|
72
|
+
* Represents an embedding model provided by an OpenAI-compatible integration.
|
|
73
|
+
* Unlike chat's `IntegrationModelSpec`, this includes `dimensions` because the same
|
|
74
|
+
* embedding model can be configured with different output dimensions.
|
|
75
|
+
* @category AI
|
|
76
|
+
*/
|
|
77
|
+
export interface IntegrationEmbeddingModelSpec {
|
|
78
|
+
/** The ID of the integration providing the embedding model. */
|
|
79
|
+
integrationId: string;
|
|
80
|
+
/** The model name as recognized by the provider. */
|
|
81
|
+
model: string;
|
|
82
|
+
/** The number of dimensions in the embedding vector output. */
|
|
83
|
+
dimensions: number;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Type guard for `IntegrationEmbeddingModelSpec`.
|
|
87
|
+
* @category AI
|
|
88
|
+
*/
|
|
89
|
+
export declare function isIntegrationEmbeddingModelSpec(model: unknown): model is IntegrationEmbeddingModelSpec;
|
|
90
|
+
/**
|
|
91
|
+
* Type for specifying which embedding model to use.
|
|
92
|
+
* Can be either a vendor model name (string) or an integration-based embedding model (object).
|
|
93
|
+
* @category AI
|
|
94
|
+
*/
|
|
95
|
+
export type AiEmbeddingsModelSelection = AiEmbeddingsModelName | IntegrationEmbeddingModelSpec;
|
|
71
96
|
/**
|
|
72
97
|
* The supported AI image generation model names.
|
|
73
98
|
* @category AI
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } from './ai-agent.public-types';
|
|
2
|
-
import {
|
|
2
|
+
import { AiEmbeddingsModelSelection, AiRerankProvider } from './ai-common.public-types';
|
|
3
3
|
import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types';
|
|
4
4
|
import { DocumentExtractionMethod } from './extraction.public-types';
|
|
5
5
|
/**
|
|
@@ -15,8 +15,8 @@ export interface AiKnowledgeBase {
|
|
|
15
15
|
description: string;
|
|
16
16
|
/** A set of predefined metadata fields for the knowledge base that can be used for filtering.*/
|
|
17
17
|
metadataFields: Array<AiKnowledgeBaseMetadataField>;
|
|
18
|
-
/** The embedding model
|
|
19
|
-
embeddingModel:
|
|
18
|
+
/** The embedding model that should be used for this knowledge base.*/
|
|
19
|
+
embeddingModel: AiEmbeddingsModelSelection;
|
|
20
20
|
/** The model name that should be used when asking questions of this knowledge base. */
|
|
21
21
|
chatModel: AiChatModelSelection;
|
|
22
22
|
/** The timestamp the knowledge base was last updated */
|
|
@@ -33,6 +33,10 @@ export interface AiQueryOptions {
|
|
|
33
33
|
sessionContext?: PartialBy<AiSessionContext, 'agentId'>;
|
|
34
34
|
/** memory options */
|
|
35
35
|
memoryOptions?: AiAgentMemoryOptions;
|
|
36
|
+
/** When true, returns generated queries without executing or analyzing them. Default: false. */
|
|
37
|
+
generateQueriesOnly?: boolean;
|
|
38
|
+
/** Optional AI validation of generated queries. Can be used independently or with generateQueriesOnly. */
|
|
39
|
+
validateWithAiOptions?: AiQueryValidateWithAiOptions;
|
|
36
40
|
}
|
|
37
41
|
/**
|
|
38
42
|
* Request to execute an AI query using a specific integration.
|
|
@@ -110,6 +114,16 @@ export interface AiQueryAnalyzeResultsOptions {
|
|
|
110
114
|
*/
|
|
111
115
|
agentId?: AiAgentId;
|
|
112
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* Options for AI-based validation of generated queries.
|
|
119
|
+
* @category AI
|
|
120
|
+
*/
|
|
121
|
+
export interface AiQueryValidateWithAiOptions {
|
|
122
|
+
/** Whether AI validation is enabled. */
|
|
123
|
+
enabled: boolean;
|
|
124
|
+
/** Defaults to the same model used for query generation. */
|
|
125
|
+
aiOptions?: AiChatOptions;
|
|
126
|
+
}
|
|
113
127
|
/**
|
|
114
128
|
* Information about an executed query.
|
|
115
129
|
* @category AI
|
|
@@ -48,3 +48,14 @@ export type LlmModelMetadata = {
|
|
|
48
48
|
/** Total context window size: input (aka prompt) + output (aka completion) tokens combined. */
|
|
49
49
|
contextWindowTokens: number;
|
|
50
50
|
};
|
|
51
|
+
/**
|
|
52
|
+
* Stats about a given embedding model.
|
|
53
|
+
*/
|
|
54
|
+
export type EmbeddingModelMetadata = {
|
|
55
|
+
/** A friendly name for the model, to display in UIs. */
|
|
56
|
+
displayName: string;
|
|
57
|
+
/** The number of dimensions produced by this embedding model. */
|
|
58
|
+
dimensions: number;
|
|
59
|
+
/** Maximum input tokens per request. */
|
|
60
|
+
maxTokens: number;
|
|
61
|
+
};
|
|
@@ -1,6 +1,6 @@
|
|
|
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", "bedrock", "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", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible"];
|
|
3
|
+
export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "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", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding"];
|
|
4
4
|
/**
|
|
5
5
|
* @category Database
|
|
6
6
|
*/
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { Alias, SquidDocument } from '../public-types';
|
|
2
|
+
/** Two transactions cannot run in parallel - this mutex is used for blocking a second transaction. */
|
|
3
|
+
export declare const RUN_IN_TRANSACTION_MUTEX = "dataManager_runInTransaction";
|
|
2
4
|
/**
|
|
3
5
|
* Represents a collection of documents associated with a specific alias
|
|
4
6
|
* in a query, typically used in joined query results.
|