@squidcloud/client 1.0.499 → 1.0.500

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.
@@ -488,11 +488,28 @@ export interface BackupModelOptions {
488
488
  /** Response length and detail level; supported by OpenAI models only. */
489
489
  verbosity?: AiVerbosityLevel;
490
490
  }
491
- /**
492
- * The base AI agent chat options, should not be used directly.
493
- * @category AI
494
- */
491
+ /** Configures independent answer validation and bounded correction. @category AI */
492
+ export interface AiAnswerValidationOptions {
493
+ /** Judge model; defaults to the model that produced the initial answer. */
494
+ model?: AiChatModelSelection;
495
+ /** Additional acceptance criteria for the judge. */
496
+ instructions?: string;
497
+ /** Maximum answer attempts, including the initial answer. Defaults to 2; accepts 1–5. */
498
+ maxAttempts?: number;
499
+ }
500
+ /** Reports the judge's verdict for the returned answer. @category AI */
501
+ export interface AiAnswerValidationResult {
502
+ /** Whether the returned answer passed validation; false also covers incomplete validation. */
503
+ passed: boolean;
504
+ /** Concise explanation of the verdict or validation failure. */
505
+ summary: string;
506
+ /** Actionable defects or reasons validation could not complete. */
507
+ issues: Array<string>;
508
+ }
509
+ /** Shared options for agent chat requests. @category AI */
495
510
  export interface BaseAiChatOptions {
511
+ /** Enables validation for non-CLI models; an empty object uses defaults. Judge read-only behavior is instruction-based. */
512
+ validation?: AiAnswerValidationOptions;
496
513
  /**
497
514
  * The maximum number of input tokens that Squid can use when making the request to the AI model.
498
515
  * Defaults to the max tokens the model can accept.
@@ -1445,6 +1462,8 @@ export interface DeleteAgentRequest {
1445
1462
  * @category AI
1446
1463
  */
1447
1464
  export interface AiAskResponse {
1465
+ /** Judge verdict, present when answer validation is enabled. */
1466
+ validation?: AiAnswerValidationResult;
1448
1467
  /** The response string from the agent */
1449
1468
  responseString: string;
1450
1469
  /** Optional annotations (e.g., file references) in the response */
@@ -1189,6 +1189,11 @@ export interface GeneratedMetadataFieldDescription {
1189
1189
  export interface GetKnowledgeBaseGraphStatusRequest {
1190
1190
  /** The id of the AiKnowledgeBase. */
1191
1191
  knowledgeBaseId: AiKnowledgeBaseId;
1192
+ /**
1193
+ * Whether to include the topic table (`topics`, `topicEdges`). Default true. A poller that reads only the
1194
+ * build state can pass false: on a large graph the table runs to thousands of topics.
1195
+ */
1196
+ includeTopics?: boolean;
1192
1197
  }
1193
1198
  /**
1194
1199
  * Response structure for a knowledge base's GraphRAG build/readiness status. Drives the ai-eval
@@ -1552,17 +1557,20 @@ export interface RebuildKnowledgeBaseGraphRequest {
1552
1557
  */
1553
1558
  ignoreActiveBulkJobs?: boolean;
1554
1559
  }
1560
+ /** Hard ceiling on the nodes one graph explore returns: a larger `nodeLimit` is clamped down to this value. */
1561
+ export declare const KNOWLEDGE_BASE_GRAPH_EXPLORE_MAX_NODES = 1000;
1562
+ /** Longest `search` text a graph explore accepts; a longer one is rejected. */
1563
+ export declare const KNOWLEDGE_BASE_GRAPH_SEARCH_MAX_LENGTH = 200;
1555
1564
  /**
1556
- * Request structure for exploring a bounded subgraph of a knowledge base's graph (Phase 3 visualization).
1557
- * Returns the highest-degree entities and the relationships among them. Seed-based exploration
1558
- * (prompt/entity-name seeding + traversal depth) is a planned extension; its fields will be added
1559
- * here once implemented.
1565
+ * Request structure for exploring a bounded subgraph of a knowledge base's graph (visualization). By default
1566
+ * it returns the highest-degree entities and the relationships among them; `topicId`, `entityId` and `search`
1567
+ * select other entity pools, and `contextMetadataFilter` narrows any of them.
1560
1568
  * @category AI
1561
1569
  */
1562
1570
  export interface ExploreKnowledgeBaseGraphRequest {
1563
1571
  /** The id of the AiKnowledgeBase. */
1564
1572
  knowledgeBaseId: AiKnowledgeBaseId;
1565
- /** Hard cap on returned nodes. Default 200, max 1000. */
1573
+ /** Hard cap on returned nodes. Default 200, at most {@link KNOWLEDGE_BASE_GRAPH_EXPLORE_MAX_NODES}. */
1566
1574
  nodeLimit?: number;
1567
1575
  /**
1568
1576
  * Restricts the subgraph to entities under the given topic node id — any hierarchy level; an entity
@@ -1570,6 +1578,30 @@ export interface ExploreKnowledgeBaseGraphRequest {
1570
1578
  * `TOPIC_NOT_FOUND`. Ids come from {@link KnowledgeBaseGraphTopic.id} and churn on rebuild.
1571
1579
  */
1572
1580
  topicId?: string;
1581
+ /**
1582
+ * Centers the subgraph on one entity: the entity plus its neighbors, strongest relationships first. Ids
1583
+ * come from {@link KnowledgeBaseGraphNode.id} and churn on rebuild; an unknown id fails with
1584
+ * `ENTITY_NOT_FOUND`. Cannot be combined with `topicId` or `search`.
1585
+ */
1586
+ entityId?: string;
1587
+ /**
1588
+ * Finds entities by name: exact names and aliases first, then prefixes, then substrings, each by degree.
1589
+ * When no name matches, returns the entities nearest in meaning instead (`searchMatch: 'similar'`).
1590
+ * At most {@link KNOWLEDGE_BASE_GRAPH_SEARCH_MAX_LENGTH} characters. Cannot be combined with `topicId` or
1591
+ * `entityId`.
1592
+ */
1593
+ search?: string;
1594
+ /**
1595
+ * Keeps only the entities mentioned by contexts matching the filter. Without `entityId` or `search`, they
1596
+ * are ranked by how many matching contexts mention them. Filters on context-record metadata only, not on
1597
+ * per-chunk keys.
1598
+ */
1599
+ contextMetadataFilter?: AiContextMetadataFilter;
1600
+ /**
1601
+ * Whether to attach the topic table (`topics`). Default true. A caller that already holds it can pass false:
1602
+ * on a large graph the table runs to thousands of topics.
1603
+ */
1604
+ includeTopics?: boolean;
1573
1605
  }
1574
1606
  /** A node in an {@link ExploreKnowledgeBaseGraphResponse}. @category AI */
1575
1607
  export interface KnowledgeBaseGraphNode {
@@ -1608,14 +1640,32 @@ export interface KnowledgeBaseGraphEdge {
1608
1640
  export interface ExploreKnowledgeBaseGraphResponse {
1609
1641
  /** The subgraph nodes. */
1610
1642
  nodes: Array<KnowledgeBaseGraphNode>;
1611
- /** The subgraph edges (outgoing only, both endpoints present in `nodes`). */
1643
+ /**
1644
+ * The subgraph edges (outgoing only, both endpoints present in `nodes`). Capped: past the cap only the
1645
+ * heaviest are returned and {@link edgesTruncated} is set.
1646
+ */
1612
1647
  edges: Array<KnowledgeBaseGraphEdge>;
1648
+ /** True when the nodes are linked by more relationships than `edges` carries. */
1649
+ edgesTruncated?: boolean;
1613
1650
  /**
1614
1651
  * The KB's topic (theme) nodes — the id→name/hierarchy table for the nodes' `topicPath` ids, so a
1615
1652
  * visualization can label and group by theme without extra round trips. Present when the concept
1616
- * layer has been built (a rebuild ran).
1653
+ * layer has been built (a rebuild ran). Under `contextMetadataFilter`, `docCount` counts only the
1654
+ * matching contexts.
1617
1655
  */
1618
1656
  topics?: Array<KnowledgeBaseGraphTopic>;
1657
+ /**
1658
+ * Size of the pool the subgraph was cut from — the entities in scope, the topic's members, the entity's
1659
+ * neighbors or the search matches. Compare with `nodes.length` to offer more. Absent when not counted.
1660
+ */
1661
+ totalCount?: number;
1662
+ /** How a `search` matched: by entity name, or by meaning when no name matched. */
1663
+ searchMatch?: 'name' | 'similar';
1664
+ /**
1665
+ * True when `contextMetadataFilter` matched more contexts than one request reads; the subgraph then
1666
+ * covers only the first of them.
1667
+ */
1668
+ scopeTruncated?: boolean;
1619
1669
  }
1620
1670
  /**
1621
1671
  * A topic (theme) node of the graph's concept layer, as referenced by
@@ -1656,12 +1706,14 @@ export interface KnowledgeBaseGraphTopicEdge {
1656
1706
  * round trip with a complete answer — no per-level walking.
1657
1707
  * @category AI
1658
1708
  */
1659
- export type KnowledgeBaseGraphQueryOp = 'overview' | 'resolve' | 'describe' | 'subtree' | 'docsUnder' | 'conceptsOf' | 'neighborhood' | 'pathBetween' | 'globalSummary';
1709
+ export type KnowledgeBaseGraphQueryOp = 'overview' | 'resolve' | 'describe' | 'subtree' | 'docsUnder' | 'conceptsOf' | 'neighborhood' | 'pathBetween' | 'globalSummary' | 'relationship';
1660
1710
  /**
1661
1711
  * Request structure for querying a knowledge base's graph (documents, entities, topics, facets) through
1662
1712
  * the closed op set. `ref` accepts a facet nodeId (`facet_…` — exact; the only persistable concept
1663
- * handles) or a name, resolved server-side (exact → alias → similarity). An unresolvable ref fails with
1664
- * `CONCEPT_NOT_FOUND` plus the nearest matching names.
1713
+ * handles), a topic id from {@link KnowledgeBaseGraphTopic.id} or an entity id from
1714
+ * {@link KnowledgeBaseGraphNode.id} (both exact, both churn on rebuild) or a name, resolved server-side
1715
+ * (exact → alias → similarity). An unresolvable ref fails with `CONCEPT_NOT_FOUND` plus the nearest
1716
+ * matching names.
1665
1717
  * @category AI
1666
1718
  */
1667
1719
  export interface QueryKnowledgeBaseGraphRequest {
@@ -1669,9 +1721,12 @@ export interface QueryKnowledgeBaseGraphRequest {
1669
1721
  knowledgeBaseId: AiKnowledgeBaseId;
1670
1722
  /** The operation to run. */
1671
1723
  op: KnowledgeBaseGraphQueryOp;
1672
- /** Node ref (name or facet nodeId). Required by resolve/describe/subtree/docsUnder/neighborhood/pathBetween. */
1724
+ /**
1725
+ * Node ref (name, facet nodeId, topic id or entity id). Required by resolve/describe/subtree/docsUnder/
1726
+ * neighborhood/pathBetween/relationship.
1727
+ */
1673
1728
  ref?: string;
1674
- /** Second node ref for `pathBetween`. */
1729
+ /** Second node ref for `pathBetween`, and the target entity for `relationship`. */
1675
1730
  refB?: string;
1676
1731
  /** The document's contextId for `conceptsOf`. */
1677
1732
  contextId?: string;
@@ -1683,8 +1738,16 @@ export interface QueryKnowledgeBaseGraphRequest {
1683
1738
  hops?: number;
1684
1739
  /** `docsUnder`: when true (default), include documents under the whole subtree, not just the node itself. */
1685
1740
  recursive?: boolean;
1686
- /** `docsUnder`: maximum documents returned. Default 25, max 100 (`totalDocs` always reports the full count). */
1741
+ /**
1742
+ * `docsUnder` and `relationship`: maximum documents returned. Default 25, max 100 (`totalDocs` always
1743
+ * reports the full count).
1744
+ */
1687
1745
  limit?: number;
1746
+ /**
1747
+ * `docsUnder` and `relationship`: keeps only the documents whose context matches the filter. Filters on
1748
+ * context-record metadata only, not on per-chunk keys.
1749
+ */
1750
+ contextMetadataFilter?: AiContextMetadataFilter;
1688
1751
  }
1689
1752
  /** One node matched by a graph query (`resolve`, and the anchors of other ops). @category AI */
1690
1753
  export interface KnowledgeBaseGraphQueryMatch {
@@ -1767,6 +1830,27 @@ export interface KnowledgeBaseGraphQueryPath {
1767
1830
  /** Thematic tier: names of concepts both refs sit under. */
1768
1831
  sharedConcepts?: Array<string>;
1769
1832
  }
1833
+ /**
1834
+ * A `relationship` answer: the direct relationship between two entities, in its asserted direction, and
1835
+ * the documents asserting it.
1836
+ * @category AI
1837
+ */
1838
+ export interface KnowledgeBaseGraphQueryRelationship {
1839
+ /** Source entity name. */
1840
+ source: string;
1841
+ /** Target entity name. */
1842
+ target: string;
1843
+ /** Relationship label. */
1844
+ type: string;
1845
+ /** Relationship description, when the extraction produced one. */
1846
+ description?: string;
1847
+ /** How many times the relationship was asserted. */
1848
+ weight: number;
1849
+ /** Documents asserting the relationship (capped by `limit`). */
1850
+ documents: Array<KnowledgeBaseGraphQueryDoc>;
1851
+ /** Number of documents asserting it (compare with `documents.length` for truncation). */
1852
+ totalDocs: number;
1853
+ }
1770
1854
  /**
1771
1855
  * Response structure for a graph query. `op` echoes the request; exactly the fields that op produces
1772
1856
  * are set (e.g. `matches` for `resolve`, `tree` for `subtree`).
@@ -1803,6 +1887,13 @@ export interface QueryKnowledgeBaseGraphResponse {
1803
1887
  pathBetween?: KnowledgeBaseGraphQueryPath;
1804
1888
  /** `globalSummary`: the KB's topic summaries ranked against the query, most relevant first. */
1805
1889
  summaries?: Array<KnowledgeBaseGraphQueryGlobalSummary>;
1890
+ /** `relationship`: the relationship between `ref` and `refB` and the documents asserting it. */
1891
+ relationship?: KnowledgeBaseGraphQueryRelationship;
1892
+ /**
1893
+ * True when `contextMetadataFilter` matched more contexts than one request reads; the documents then come
1894
+ * from only the first of them.
1895
+ */
1896
+ scopeTruncated?: boolean;
1806
1897
  }
1807
1898
  /**
1808
1899
  * One context to stage through bulk ingestion. Unlike the sync request, `imageExtractionModel` is not
@@ -1,4 +1,4 @@
1
- import { AgentContextRequest, AiAgent, AiAgentContext, AiAgentMcpServerConfig, AiAnnotation, AiAudioCreateSpeechOptions, AiChatMessage, AiChatOptions, AiChatRequestOptions, AiGenerateImageOptions, AiModelRoutingResult, ApplicationAiSettings, BuildAgentOptions } from '../public-types/ai-agent.public-types';
1
+ import { AgentContextRequest, AiAgent, AiAgentContext, AiAgentMcpServerConfig, AiAnnotation, AiAnswerValidationResult, AiAudioCreateSpeechOptions, AiChatMessage, AiChatOptions, AiChatRequestOptions, AiGenerateImageOptions, AiModelRoutingResult, ApplicationAiSettings, BuildAgentOptions } from '../public-types/ai-agent.public-types';
2
2
  import { AiProviderType, ModelIdSpec } from '../public-types/ai-common.public-types';
3
3
  import { AiContextMetadata, AiContextMetadataFilter } from '../public-types/ai-knowledge-base.public-types';
4
4
  import { AiAgentId, AiKnowledgeBaseId, AppId, ClientRequestId } from '../public-types/communication.public-types';
@@ -63,6 +63,7 @@ export interface AiContextSizeResponse {
63
63
  sizeBytes: number;
64
64
  }
65
65
  export interface AiAskResponse {
66
+ validation?: AiAnswerValidationResult;
66
67
  responseString: string;
67
68
  annotations?: Record<string, AiAnnotation>;
68
69
  routing?: AiModelRoutingResult;
@@ -193,7 +193,7 @@ export interface AiKnowledgeBaseSearchResponse {
193
193
  /** Traversed subgraph for a `searchMode:'graph'` query with `includeGraphContext`; absent otherwise. */
194
194
  graphContext?: AiKnowledgeBaseGraphContext;
195
195
  }
196
- export type { ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GetKnowledgeBaseGraphStatusRequest, GetKnowledgeBaseGraphStatusResponse, KnowledgeBaseGraphBuildStageUsage, KnowledgeBaseGraphBuildUsage, KnowledgeBaseGraphEdge, KnowledgeBaseGraphFacetStatus, KnowledgeBaseGraphModelUsage, KnowledgeBaseGraphNode, KnowledgeBaseGraphQueryConcepts, KnowledgeBaseGraphQueryDoc, KnowledgeBaseGraphQueryGlobalSummary, KnowledgeBaseGraphQueryMatch, KnowledgeBaseGraphQueryOp, KnowledgeBaseGraphQueryPath, KnowledgeBaseGraphQuerySubtreeNode, KnowledgeBaseGraphQueuedRebuild, KnowledgeBaseGraphRebuildMode, KnowledgeBaseGraphResolutionProgress, KnowledgeBaseGraphResolutionStatus, KnowledgeBaseGraphStructuralBuildSkip, KnowledgeBaseGraphStructuralBuildSkipReason, KnowledgeBaseGraphTopic, KnowledgeBaseGraphTopicEdge, KnowledgeBaseGraphUsage, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, } from '../public-types/ai-knowledge-base.public-types';
196
+ export type { ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GetKnowledgeBaseGraphStatusRequest, GetKnowledgeBaseGraphStatusResponse, KnowledgeBaseGraphBuildStageUsage, KnowledgeBaseGraphBuildUsage, KnowledgeBaseGraphEdge, KnowledgeBaseGraphFacetStatus, KnowledgeBaseGraphModelUsage, KnowledgeBaseGraphNode, KnowledgeBaseGraphQueryConcepts, KnowledgeBaseGraphQueryDoc, KnowledgeBaseGraphQueryGlobalSummary, KnowledgeBaseGraphQueryMatch, KnowledgeBaseGraphQueryOp, KnowledgeBaseGraphQueryPath, KnowledgeBaseGraphQueryRelationship, KnowledgeBaseGraphQuerySubtreeNode, KnowledgeBaseGraphQueuedRebuild, KnowledgeBaseGraphRebuildMode, KnowledgeBaseGraphResolutionProgress, KnowledgeBaseGraphResolutionStatus, KnowledgeBaseGraphStructuralBuildSkip, KnowledgeBaseGraphStructuralBuildSkipReason, KnowledgeBaseGraphTopic, KnowledgeBaseGraphTopicEdge, KnowledgeBaseGraphUsage, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, } from '../public-types/ai-knowledge-base.public-types';
197
197
  /**
198
198
  * Request structure for getting the size of context
199
199
  * for an AiKnowledgeBase
@@ -132,6 +132,8 @@ export declare class AiAgentReference {
132
132
  * knows it can look up the job’s status.
133
133
  */
134
134
  ask<T extends AiAskModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
135
+ /** Returns the answer, annotations, routing information, and optional validation verdict. */
136
+ askWithResult<T extends AiAskModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
135
137
  /**
136
138
  * Sends a prompt and returns the string response and file annotations.
137
139
  * @param prompt The text prompt to send to the agent.
@@ -1,5 +1,5 @@
1
1
  import { Observable } from 'rxjs';
2
- import { AiAnnotation, AiAskModelSelection, AiChatModelSelection, AiChatOptions, AiChatRequestCredentials, AiModelRoutingResult } from '../../../internal-common/src/public-types/ai-agent.public-types';
2
+ import { AiAnnotation, AiAnswerValidationResult, AiAskModelSelection, AiChatModelSelection, AiChatOptions, AiChatRequestCredentials, AiModelRoutingResult } from '../../../internal-common/src/public-types/ai-agent.public-types';
3
3
  /**
4
4
  * Response format for transcribing audio and generating a chat response.
5
5
  * Contains the transcribed text and a stream of AI-generated responses.
@@ -29,6 +29,8 @@ export interface TranscribeAndAskWithVoiceResponse {
29
29
  * @category AI
30
30
  */
31
31
  export interface AskResponse {
32
+ /** Judge verdict, present when answer validation is enabled. */
33
+ validation?: AiAnswerValidationResult;
32
34
  /** The main text response from the AI agent. */
33
35
  responseString: string;
34
36
  /** Optional annotations that provide additional context or metadata about the response. */
@@ -1,5 +1,5 @@
1
1
  import { Observable } from 'rxjs';
2
- import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseFileStatusInfo, AiKnowledgeBaseFolderStatusResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResponse, AiKnowledgeBaseSearchResultChunk, BulkIngestionContext, BulkIngestionCreateUploadUrlsResponse, BulkIngestionJobStatusResponse, BulkIngestionUpsertContextsOptions, BulkIngestionUpsertContextsResponse, ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, GetKnowledgeBaseGraphStatusResponse, GrepKnowledgeBaseOptions, GrepKnowledgeBaseResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
2
+ import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseContextWithReasoning, AiKnowledgeBaseDownloadContextResponse, AiKnowledgeBaseFileStatusInfo, AiKnowledgeBaseFolderStatusResponse, AiKnowledgeBaseSearchContextsWithContextIdRequest, AiKnowledgeBaseSearchContextsWithPromptRequest, AiKnowledgeBaseSearchResponse, AiKnowledgeBaseSearchResultChunk, BulkIngestionContext, BulkIngestionCreateUploadUrlsResponse, BulkIngestionJobStatusResponse, BulkIngestionUpsertContextsOptions, BulkIngestionUpsertContextsResponse, ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GenerateMetadataFieldDescriptionsRequest, GenerateMetadataFieldDescriptionsResponse, GetKnowledgeBaseGraphStatusRequest, GetKnowledgeBaseGraphStatusResponse, GrepKnowledgeBaseOptions, GrepKnowledgeBaseResponse, ListAiKnowledgeBaseContextsPageResponse, ListKnowledgeBaseContextsOptions, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, UpsertKnowledgeBaseContextResponse, UpsertKnowledgeBaseContextsResponse } from '../../../internal-common/src/public-types/ai-knowledge-base.public-types';
3
3
  import { AiContextId } from '../../../internal-common/src/public-types/communication.public-types';
4
4
  /**
5
5
  * Parameters for creating or updating an AI agent.
@@ -197,16 +197,17 @@ export declare class AiKnowledgeBaseReference {
197
197
  /**
198
198
  * Queries the knowledge base's graph (documents, entities, themes, facets) through the closed op set
199
199
  * — overview / resolve / describe / subtree / docsUnder / conceptsOf / neighborhood / pathBetween /
200
- * globalSummary. Requires `graphRag.enabled` on the knowledge base. Refused on a knowledge base with
201
- * `accessControl.mode: 'enforced'` — the graph carries no access scopes, so its answers cannot be
202
- * filtered per caller.
200
+ * globalSummary / relationship. Requires `graphRag.enabled` on the knowledge base. Refused on a knowledge
201
+ * base with `accessControl.mode: 'enforced'` — the graph carries no access scopes, so its answers cannot
202
+ * be filtered per caller.
203
203
  */
204
204
  queryGraph(request: Omit<QueryKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<QueryKnowledgeBaseGraphResponse>;
205
205
  /**
206
206
  * Returns the knowledge base's graph build/readiness status: counts, facets, staleness, the most
207
207
  * recent rebuild job, and the graph's LLM token/cost usage (`ingestUsage`, `lastRebuildUsage`).
208
+ * Pass `includeTopics: false` to poll it without the topic table.
208
209
  */
209
- getGraphStatus(): Promise<GetKnowledgeBaseGraphStatusResponse>;
210
+ getGraphStatus(options?: Omit<GetKnowledgeBaseGraphStatusRequest, 'knowledgeBaseId'>): Promise<GetKnowledgeBaseGraphStatusResponse>;
210
211
  /**
211
212
  * Looks up the durable ingestion status of one file by path (`folderPath/filename`, or just
212
213
  * `filename` at the upload root): `'completed'`, `'failed'` (with `errorMessage`/`errorCode`),
@@ -231,8 +232,9 @@ export declare class AiKnowledgeBaseReference {
231
232
  */
232
233
  rebuildGraph(request?: Omit<RebuildKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<void>;
233
234
  /**
234
- * Returns a bounded slice of the knowledge base's entity graph (highest-degree entities and the
235
- * relationships among them) for exploration/visualization. Requires `graphRag.enabled`.
235
+ * Returns a bounded slice of the knowledge base's entity graph for exploration/visualization: the
236
+ * highest-degree entities, a topic's members, an entity's neighborhood or a name search, optionally
237
+ * narrowed by a context metadata filter, with the relationships among them. Requires `graphRag.enabled`.
236
238
  */
237
239
  exploreGraph(request?: Omit<ExploreKnowledgeBaseGraphRequest, 'knowledgeBaseId'>): Promise<ExploreKnowledgeBaseGraphResponse>;
238
240
  /**
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.499";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.500";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.499",
3
+ "version": "1.0.500",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",