@squidcloud/client 1.0.481 → 1.0.482
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.public-types.d.ts +26 -0
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +643 -4
- package/dist/internal-common/src/public-types/ai-matchmaking.public-types.d.ts +4 -3
- package/dist/internal-common/src/public-types/connector.public-types.d.ts +1 -1
- package/dist/internal-common/src/public-types/extraction.public-types.d.ts +4 -1
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +1 -1
- package/dist/internal-common/src/public-types/metadata-filter.public-types.d.ts +6 -2
- package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts +34 -1
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/dist/typescript-client/src/web-client.d.ts +4 -1
- package/package.json +1 -1
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { AiContextMetadata
|
|
1
|
+
import { AiContextMetadata } from './ai-knowledge-base.public-types';
|
|
2
|
+
import { MetadataFilter } from './metadata-filter.public-types';
|
|
2
3
|
/**
|
|
3
4
|
* Represents a category in the matchmaker.
|
|
4
5
|
* The description is used by the AI to extract features from the content.
|
|
@@ -56,7 +57,7 @@ export interface MmEntityMatch extends MmEntity {
|
|
|
56
57
|
*/
|
|
57
58
|
export interface MmFindMatchesOptions {
|
|
58
59
|
/** Optional metadata filter conditions to narrow down matching entities; defaults to none. */
|
|
59
|
-
metadataFilter?:
|
|
60
|
+
metadataFilter?: MetadataFilter;
|
|
60
61
|
/** The maximum number of matches to return; defaults to 100, with a maximum of 100. */
|
|
61
62
|
limit?: number;
|
|
62
63
|
/** The category ID to match entities against; defaults to the next or first category in the matchmaker. */
|
|
@@ -68,7 +69,7 @@ export interface MmFindMatchesOptions {
|
|
|
68
69
|
*/
|
|
69
70
|
export interface MmListEntitiesOptions {
|
|
70
71
|
/** Optional metadata filter conditions to narrow down listed entities; defaults to none. */
|
|
71
|
-
metadataFilter?:
|
|
72
|
+
metadataFilter?: MetadataFilter;
|
|
72
73
|
/** The maximum number of entities to return; defaults to 100. */
|
|
73
74
|
limit?: number;
|
|
74
75
|
}
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* 'CONNECTOR_PACKAGES_TO_EXCLUDE_FROM_AUTO_SYNC' in ConnectorsService (console-backend).
|
|
5
5
|
* @category Platform
|
|
6
6
|
*/
|
|
7
|
-
export declare const CONNECTOR_IDS: readonly ["confluence", "cotomi", "essentials", "freshdesk", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "zendesk"];
|
|
7
|
+
export declare const CONNECTOR_IDS: readonly ["confluence", "cotomi", "essentials", "freshdesk", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "zendesk"];
|
|
8
8
|
/**
|
|
9
9
|
* Unique connector package name.
|
|
10
10
|
* @category Platform
|
|
@@ -247,6 +247,9 @@ export interface DocumentMetadata {
|
|
|
247
247
|
docCreatedAt?: string;
|
|
248
248
|
/** Last-modified timestamp, ISO 8601. */
|
|
249
249
|
docModifiedAt?: string;
|
|
250
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Source document type: `pdf` | `docx` | `doc` | `pptx` | `ppt` | `xlsx` | `xlsm` | `xls` | `xlsb` |
|
|
252
|
+
* `eml` | `msg` | `csv` | `tsv` | `md` | `html` | `txt`.
|
|
253
|
+
*/
|
|
251
254
|
docType?: string;
|
|
252
255
|
}
|
|
@@ -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_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_azure_blob", "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", "azure-entra-external-id", "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", "sharepoint", "vertex"];
|
|
3
|
+
export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "built_in_azure_blob", "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", "azure-entra-external-id", "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", "outlook", "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", "sharepoint", "vertex"];
|
|
4
4
|
/**
|
|
5
5
|
* @category Database
|
|
6
6
|
*/
|
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
* `$lte`, `$in`, `$nin`, `$exists`) and boolean combinators (`$and`, `$or`).
|
|
7
7
|
*
|
|
8
8
|
* Originally created for AI knowledge base context filtering, these types are now
|
|
9
|
-
* shared across metrics tag filtering, matchmaking, and other subsystems.
|
|
9
|
+
* shared across metrics tag filtering, matchmaking, and other subsystems. Operators
|
|
10
|
+
* specific to one subsystem (e.g. the knowledge base's `$underPath` for hierarchical
|
|
11
|
+
* path scoping) live with that subsystem, not here.
|
|
10
12
|
*/
|
|
11
13
|
/** Primitive metadata value. */
|
|
12
14
|
export type MetadataValue = number | string | boolean | undefined;
|
|
@@ -57,7 +59,9 @@ export interface MetadataExistsFilter {
|
|
|
57
59
|
/** Whether the field must exist. */
|
|
58
60
|
$exists: boolean;
|
|
59
61
|
}
|
|
60
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* A single-field operator: one of `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`.
|
|
64
|
+
*/
|
|
61
65
|
export type MetadataSimpleFilter = MetadataEqFilter | MetadataNeFilter | MetadataGtFilter | MetadataGteFilter | MetadataLtFilter | MetadataLteFilter | MetadataInFilter | MetadataNinFilter | MetadataExistsFilter;
|
|
62
66
|
/**
|
|
63
67
|
* A filter for metadata based on field-specific conditions or direct values.
|
package/dist/typescript-client/src/ai-knowledge-base/ai-knowledge-base-client-reference.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResultChunk, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
|
|
1
|
+
import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResponse, AiKnowledgeBaseSearchResultChunk, ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, GetKnowledgeBaseGraphStatusResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, 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.
|
|
@@ -97,6 +97,39 @@ export declare class AiKnowledgeBaseReference {
|
|
|
97
97
|
search(options: AiKnowledgeBaseChatOptions & {
|
|
98
98
|
prompt: string;
|
|
99
99
|
}): Promise<Array<AiKnowledgeBaseSearchResultChunk>>;
|
|
100
|
+
/**
|
|
101
|
+
* Like {@link search}, but returns the full response — including `graphContext` (the traversed
|
|
102
|
+
* subgraph) when the search ran with `searchMode: 'graph'` and `graphOptions.includeGraphContext`.
|
|
103
|
+
* {@link search} predates `graphContext` and keeps returning only the chunks.
|
|
104
|
+
*/
|
|
105
|
+
searchWithGraphContext(options: AiKnowledgeBaseChatOptions & {
|
|
106
|
+
prompt: string;
|
|
107
|
+
}): Promise<AiKnowledgeBaseSearchResponse>;
|
|
108
|
+
/**
|
|
109
|
+
* Queries the knowledge base's graph (documents, entities, themes, facets) through the closed op set
|
|
110
|
+
* — overview / resolve / describe / subtree / docsUnder / conceptsOf / neighborhood / pathBetween /
|
|
111
|
+
* globalSummary. Requires `graphRag.enabled` on the knowledge base.
|
|
112
|
+
*/
|
|
113
|
+
queryGraph(request: Omit<QueryKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<QueryKnowledgeBaseGraphResponse>;
|
|
114
|
+
/**
|
|
115
|
+
* Returns the knowledge base's graph build/readiness status: counts, facets, staleness, the most
|
|
116
|
+
* recent rebuild job, and the graph's LLM token/cost usage (`ingestUsage`, `lastRebuildUsage`).
|
|
117
|
+
*/
|
|
118
|
+
getGraphStatus(): Promise<GetKnowledgeBaseGraphStatusResponse>;
|
|
119
|
+
/**
|
|
120
|
+
* Enqueues a graph rebuild/backfill. The default `'full'` mode re-extracts every context with an
|
|
121
|
+
* LLM and rebuilds the concept layer (topics + facets); `mode: 'structural'` keeps the
|
|
122
|
+
* already-extracted entity graph (extracting only contexts never graph-indexed) and rebuilds just
|
|
123
|
+
* the concept layer — a small fraction of a full rebuild's LLM cost. Requires `graphRag.enabled`.
|
|
124
|
+
* Track progress via {@link getGraphStatus}'s `buildJob`; only one rebuild can run per knowledge
|
|
125
|
+
* base at a time.
|
|
126
|
+
*/
|
|
127
|
+
rebuildGraph(request?: Omit<RebuildKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<void>;
|
|
128
|
+
/**
|
|
129
|
+
* Returns a bounded slice of the knowledge base's entity graph (highest-degree entities and the
|
|
130
|
+
* relationships among them) for exploration/visualization. Requires `graphRag.enabled`.
|
|
131
|
+
*/
|
|
132
|
+
exploreGraph(request?: Omit<ExploreKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<ExploreKnowledgeBaseGraphResponse>;
|
|
100
133
|
/**
|
|
101
134
|
* Performs a semantic search in the knowledge base and returns contexts with reasoning.
|
|
102
135
|
* Can be used for matchmaking or similarity search.
|
|
@@ -14,8 +14,11 @@ export declare class WebClient {
|
|
|
14
14
|
/**
|
|
15
15
|
* Search the web using AI. Returns a response containing Markdown text and cited URLs.
|
|
16
16
|
* @param query The keywords or query string to search for.
|
|
17
|
+
* @param abortSignal Optional signal used to abort the underlying request. When the signal aborts, the in-flight
|
|
18
|
+
* HTTP request is cancelled and its promise rejects, allowing callers to bound a single call
|
|
19
|
+
* without leaking the request.
|
|
17
20
|
*/
|
|
18
|
-
aiSearch(query: string): Promise<WebAiSearchResponse>;
|
|
21
|
+
aiSearch(query: string, abortSignal?: AbortSignal): Promise<WebAiSearchResponse>;
|
|
19
22
|
/**
|
|
20
23
|
* Fetch content from a URL.
|
|
21
24
|
* @param url The URL to fetch content from.
|