@squidcloud/client
Advanced tools
@@ -72,2 +72,27 @@ import { UserAiChatModelName } from './backend.public-types'; | ||
| /** | ||
| * Represents an embedding model provided by an OpenAI-compatible integration. | ||
| * Unlike chat's `IntegrationModelSpec`, this includes `dimensions` because the same | ||
| * embedding model can be configured with different output dimensions. | ||
| * @category AI | ||
| */ | ||
| export interface IntegrationEmbeddingModelSpec { | ||
| /** The ID of the integration providing the embedding model. */ | ||
| integrationId: string; | ||
| /** The model name as recognized by the provider. */ | ||
| model: string; | ||
| /** The number of dimensions in the embedding vector output. */ | ||
| dimensions: number; | ||
| } | ||
| /** | ||
| * Type guard for `IntegrationEmbeddingModelSpec`. | ||
| * @category AI | ||
| */ | ||
| export declare function isIntegrationEmbeddingModelSpec(model: unknown): model is IntegrationEmbeddingModelSpec; | ||
| /** | ||
| * Type for specifying which embedding model to use. | ||
| * Can be either a vendor model name (string) or an integration-based embedding model (object). | ||
| * @category AI | ||
| */ | ||
| export type AiEmbeddingsModelSelection = AiEmbeddingsModelName | IntegrationEmbeddingModelSpec; | ||
| /** | ||
| * The supported AI image generation model names. | ||
@@ -74,0 +99,0 @@ * @category AI |
| import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } from './ai-agent.public-types'; | ||
| import { AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types'; | ||
| import { AiEmbeddingsModelSelection, AiRerankProvider } from './ai-common.public-types'; | ||
| import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types'; | ||
@@ -18,4 +18,4 @@ import { DocumentExtractionMethod } from './extraction.public-types'; | ||
| metadataFields: Array<AiKnowledgeBaseMetadataField>; | ||
| /** The embedding model name that should be used for this knowledge base.*/ | ||
| embeddingModel: AiEmbeddingsModelName; | ||
| /** The embedding model that should be used for this knowledge base.*/ | ||
| embeddingModel: AiEmbeddingsModelSelection; | ||
| /** The model name that should be used when asking questions of this knowledge base. */ | ||
@@ -22,0 +22,0 @@ chatModel: AiChatModelSelection; |
@@ -36,2 +36,6 @@ import { AiAgentMemoryOptions, AiChatOptions, AiFileUrl, AiSessionContext } from './ai-agent.public-types'; | ||
| memoryOptions?: AiAgentMemoryOptions; | ||
| /** When true, returns generated queries without executing or analyzing them. Default: false. */ | ||
| generateQueriesOnly?: boolean; | ||
| /** Optional AI validation of generated queries. Can be used independently or with generateQueriesOnly. */ | ||
| validateWithAiOptions?: AiQueryValidateWithAiOptions; | ||
| } | ||
@@ -115,2 +119,12 @@ /** | ||
| /** | ||
| * Options for AI-based validation of generated queries. | ||
| * @category AI | ||
| */ | ||
| export interface AiQueryValidateWithAiOptions { | ||
| /** Whether AI validation is enabled. */ | ||
| enabled: boolean; | ||
| /** Defaults to the same model used for query generation. */ | ||
| aiOptions?: AiChatOptions; | ||
| } | ||
| /** | ||
| * Information about an executed query. | ||
@@ -117,0 +131,0 @@ * @category AI |
@@ -51,1 +51,12 @@ /** Backend related public types that should be available on the client SDK */ | ||
| }; | ||
| /** | ||
| * Stats about a given embedding model. | ||
| */ | ||
| export type EmbeddingModelMetadata = { | ||
| /** A friendly name for the model, to display in UIs. */ | ||
| displayName: string; | ||
| /** The number of dimensions produced by this embedding model. */ | ||
| dimensions: number; | ||
| /** Maximum input tokens per request. */ | ||
| maxTokens: number; | ||
| }; |
| import { IntegrationId } from './communication.public-types'; | ||
| /** List of all integration types supported by Squid. */ | ||
| 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"]; | ||
| 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"]; | ||
| /** | ||
@@ -5,0 +5,0 @@ * @category Database |
| import { Alias, SquidDocument } from '../public-types'; | ||
| /** Two transactions cannot run in parallel - this mutex is used for blocking a second transaction. */ | ||
| export declare const RUN_IN_TRANSACTION_MUTEX = "dataManager_runInTransaction"; | ||
| /** | ||
@@ -3,0 +5,0 @@ * Represents a collection of documents associated with a specific alias |
@@ -5,2 +5,2 @@ /** | ||
| */ | ||
| export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.449"; | ||
| export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.450"; |
+1
-1
| { | ||
| "name": "@squidcloud/client", | ||
| "version": "1.0.449", | ||
| "version": "1.0.450", | ||
| "description": "A typescript implementation of the Squid client", | ||
@@ -5,0 +5,0 @@ "main": "dist/cjs/index.js", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Uses eval
Supply chain riskPackage uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 2 instances in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
Network access
Supply chain riskThis module accesses the network.
Found 1 instance in 1 package
Uses eval
Supply chain riskPackage uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.
Found 1 instance in 1 package
Environment variable access
Supply chain riskPackage accesses environment variables, which may be a sign of credential stuffing or data theft.
Found 2 instances in 1 package
Long strings
Supply chain riskContains long string literals, which may be a sign of obfuscated or packed code.
Found 1 instance in 1 package
URL strings
Supply chain riskPackage contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.
Found 1 instance in 1 package
664104
0.5%7488
0.7%