@squidcloud/client 1.0.465 → 1.0.466
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 +18 -1
- package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +2 -0
- package/dist/internal-common/src/public-types/ai-function.public-types.d.ts +8 -0
- package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +26 -0
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { JSONSchema } from 'json-schema-typed';
|
|
2
|
-
import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat, OpenAiImageModelName } from './ai-common.public-types';
|
|
2
|
+
import { AiAudioCreateSpeechModelName, AiAudioTranscriptionModelName, AiChatModelName, AiImageModelName, AiProviderType, AiRerankProvider, AnthropicChatModelName, GeminiChatModelName, GrokChatModelName, ModelIdSpec, OpenAiAudioCreateSpeechModelName, OpenAiAudioTranscriptionModelName, OpenAiChatModelName, OpenAiCreateSpeechFormat, OpenAiImageModelName } from './ai-common.public-types';
|
|
3
3
|
import { AiContextMetadata, AiContextMetadataFilter, AiKnowledgeBaseContextType, AiRagType } from './ai-knowledge-base.public-types';
|
|
4
4
|
import { AiFunctionId, AiFunctionIdWithContext, UserAiChatModelName } from './backend.public-types';
|
|
5
5
|
import { AiAgentId, AiContextId, AiKnowledgeBaseId, AppId, IntegrationId } from './communication.public-types';
|
|
@@ -1029,4 +1029,21 @@ export interface BuildAgentOptions {
|
|
|
1029
1029
|
/** Whether the caller has permission to create or update integrations. Defaults to false. */
|
|
1030
1030
|
canManageIntegrations?: boolean;
|
|
1031
1031
|
}
|
|
1032
|
+
/**
|
|
1033
|
+
* Response containing the list of AI agents in an application.
|
|
1034
|
+
* @category AI
|
|
1035
|
+
*/
|
|
1036
|
+
export interface ListAgentsResponse {
|
|
1037
|
+
/** All AI agents defined for the application. */
|
|
1038
|
+
agents: Array<AiAgent>;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* Response containing the list of chat models available to an application.
|
|
1042
|
+
* Includes both Squid-provided vendor models and any custom integration models.
|
|
1043
|
+
* @category AI
|
|
1044
|
+
*/
|
|
1045
|
+
export interface ListChatModelsResponse {
|
|
1046
|
+
/** All chat models available to the application. */
|
|
1047
|
+
models: Array<ModelIdSpec>;
|
|
1048
|
+
}
|
|
1032
1049
|
export {};
|
|
@@ -212,6 +212,8 @@ export interface ModelIdSpec {
|
|
|
212
212
|
modelId: AiChatModelName;
|
|
213
213
|
/** The integration ID if this model comes from an integration (OpenAI-compatible, Bedrock). Is undefined for Squid-provided models. */
|
|
214
214
|
integrationId?: string;
|
|
215
|
+
/** Human-readable display name for the model (e.g. "GPT-4o"). */
|
|
216
|
+
displayName?: string;
|
|
215
217
|
}
|
|
216
218
|
/**
|
|
217
219
|
* Type guard to check if a model selection is integration-based.
|
|
@@ -48,3 +48,11 @@ export interface AiFunctionMetadata {
|
|
|
48
48
|
/** Whether this function is internal and not meant for direct use. */
|
|
49
49
|
internal?: boolean;
|
|
50
50
|
}
|
|
51
|
+
/**
|
|
52
|
+
* Response containing the list of AI functions registered in an application.
|
|
53
|
+
* @category AI
|
|
54
|
+
*/
|
|
55
|
+
export interface ListAiFunctionsResponse {
|
|
56
|
+
/** All AI functions registered for the application. */
|
|
57
|
+
functions: Array<AiFunctionMetadata>;
|
|
58
|
+
}
|
|
@@ -2,6 +2,17 @@ import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } f
|
|
|
2
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
|
+
/**
|
|
6
|
+
* The set of supported vector store backends for a knowledge base. The authoritative backend for a
|
|
7
|
+
* given KB is persisted on its record; reads/writes route through the matching vector provider.
|
|
8
|
+
* @category AI
|
|
9
|
+
*/
|
|
10
|
+
export declare const VECTOR_DB_TYPES: readonly ["postgres", "mongoAtlas"];
|
|
11
|
+
/**
|
|
12
|
+
* A vector store backend identifier. See {@link VECTOR_DB_TYPES}.
|
|
13
|
+
* @category AI
|
|
14
|
+
*/
|
|
15
|
+
export type VectorDbType = (typeof VECTOR_DB_TYPES)[number];
|
|
5
16
|
/**
|
|
6
17
|
* Represents an AI knowledge base that can be attached to an AI agent.
|
|
7
18
|
* @category AI
|
|
@@ -417,6 +428,13 @@ export type AiEmbeddingsModelWithOptionalFields = Omit<AiKnowledgeBase, 'chatMod
|
|
|
417
428
|
chatModel?: AiKnowledgeBase['chatModel'];
|
|
418
429
|
name?: string;
|
|
419
430
|
embeddingModel?: AiEmbeddingsModelSelection;
|
|
431
|
+
/**
|
|
432
|
+
* The vector store backend for this knowledge base. Optional: when omitted, newly-created KBs use
|
|
433
|
+
* the server's default backend (`SQUID_DEFAULT_VECTOR_DB_TYPE`, otherwise `'postgres'`). The backend
|
|
434
|
+
* cannot be changed once the KB exists, so on re-upsert this must either be omitted or match the
|
|
435
|
+
* existing value.
|
|
436
|
+
*/
|
|
437
|
+
vectorDbType?: VectorDbType;
|
|
420
438
|
};
|
|
421
439
|
/**
|
|
422
440
|
* API request for deleting an AiKnowledgeBase
|
|
@@ -460,4 +478,12 @@ export interface AiKnowledgeBaseSearchResponse {
|
|
|
460
478
|
/** Array of result chunks from the search */
|
|
461
479
|
chunks: Array<AiKnowledgeBaseSearchResultChunk>;
|
|
462
480
|
}
|
|
481
|
+
/**
|
|
482
|
+
* Response containing the list of AI knowledge bases in an application.
|
|
483
|
+
* @category AI
|
|
484
|
+
*/
|
|
485
|
+
export interface ListAiKnowledgeBasesResponse {
|
|
486
|
+
/** All AI knowledge bases defined for the application. */
|
|
487
|
+
knowledgeBases: Array<AiKnowledgeBase>;
|
|
488
|
+
}
|
|
463
489
|
export {};
|