@squidcloud/client 1.0.424 → 1.0.425
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-integrations.public-types.d.ts +2 -0
- package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +77 -5
- package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +12 -15
- package/dist/internal-common/src/public-types/ai-query.public-types.d.ts +14 -0
- package/dist/internal-common/src/public-types/integration.public-types.d.ts +2 -2
- package/dist/internal-common/src/public-types/web.public-types.d.ts +26 -0
- package/dist/internal-common/src/types/ai-agent.types.d.ts +1 -5
- package/dist/internal-common/src/types/observability.types.d.ts +23 -0
- package/dist/internal-common/src/types/url-shortener.types.d.ts +4 -0
- package/dist/internal-common/src/utils/file-utils.d.ts +2 -0
- package/dist/internal-common/src/utils/object.d.ts +28 -0
- package/dist/internal-common/src/utils/serialization.d.ts +1 -0
- package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts +17 -1
- package/dist/typescript-client/src/ai-client.d.ts +0 -7
- package/dist/typescript-client/src/index.d.ts +0 -2
- package/dist/typescript-client/src/public-types.d.ts +0 -1
- package/dist/typescript-client/src/version.d.ts +1 -1
- package/dist/typescript-client/src/web-client.d.ts +9 -14
- package/package.json +1 -1
- package/dist/internal-common/src/public-types/ai-assistant.public-types.d.ts +0 -31
- package/dist/internal-common/src/types/ai-assistant.types.d.ts +0 -1
- package/dist/node_modules/json-schema-typed/draft-2020-12.d.ts +0 -1239
- package/dist/typescript-client/src/ai-assistant-client.d.ts +0 -72
- package/dist/typescript-client/src/file-utils.d.ts +0 -1
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
import { AssistantToolType, QueryAssistantOptions } from './public-types';
|
|
2
|
-
/**
|
|
3
|
-
* Client class for interacting with an AI Assistant server.
|
|
4
|
-
* Provides functionalities like creating and deleting assistants and threads,
|
|
5
|
-
* querying assistants, and managing files associated with assistants and threads.
|
|
6
|
-
* @category AI
|
|
7
|
-
*/
|
|
8
|
-
export declare class AiAssistantClient {
|
|
9
|
-
private readonly rpcManager;
|
|
10
|
-
/**
|
|
11
|
-
* Creates a new AI assistant with specified characteristics.
|
|
12
|
-
* @param name - The name of the assistant.
|
|
13
|
-
* @param instructions - Instructions for the assistant.
|
|
14
|
-
* @param functions - Array of function names annotated with "@aiFunction" in your Squid backend that will be
|
|
15
|
-
* available to the assistant.
|
|
16
|
-
* @param toolTypes - Optional array of tool types. If you want to use files for retrieval, you must add them using
|
|
17
|
-
* the addFileToAssistant method.
|
|
18
|
-
* @returns A promise that resolves to the created assistant's ID.
|
|
19
|
-
*/
|
|
20
|
-
createAssistant(name: string, instructions: string, functions: Array<string>, toolTypes?: Array<AssistantToolType>): Promise<string>;
|
|
21
|
-
/**
|
|
22
|
-
* Deletes an AI assistant.
|
|
23
|
-
* @param assistantId - The ID of the assistant to be deleted.
|
|
24
|
-
* @returns A promise that resolves when the assistant is deleted.
|
|
25
|
-
*/
|
|
26
|
-
deleteAssistant(assistantId: string): Promise<void>;
|
|
27
|
-
/**
|
|
28
|
-
* Creates a new thread for an AI assistant. A thread is a long-lived conversation with the assistant that you can
|
|
29
|
-
* always send questions to.
|
|
30
|
-
* @param assistantId - The ID of the assistant for which the thread is created.
|
|
31
|
-
* @returns A promise that resolves to the created thread's ID.
|
|
32
|
-
*/
|
|
33
|
-
createThread(assistantId: string): Promise<string>;
|
|
34
|
-
/**
|
|
35
|
-
* Deletes a thread of an AI assistant.
|
|
36
|
-
* @param threadId - The ID of the thread to be deleted.
|
|
37
|
-
* @returns A promise that resolves when the thread is deleted.
|
|
38
|
-
*/
|
|
39
|
-
deleteThread(threadId: string): Promise<void>;
|
|
40
|
-
/**
|
|
41
|
-
* Queries an AI assistant within a specific thread.
|
|
42
|
-
* @param assistantId - The ID of the assistant.
|
|
43
|
-
* @param threadId - The ID of the thread.
|
|
44
|
-
* @param prompt - The query prompt.
|
|
45
|
-
* @param fileIds - Optional array of file IDs to include in the query. These file IDs need to be added using the
|
|
46
|
-
* addFileToThread method.
|
|
47
|
-
* @param options - Optional query options.
|
|
48
|
-
* @returns A promise that resolves to the assistant's response.
|
|
49
|
-
*/
|
|
50
|
-
queryAssistant(assistantId: string, threadId: string, prompt: string, fileIds?: string[], options?: QueryAssistantOptions): Promise<string>;
|
|
51
|
-
/**
|
|
52
|
-
* Adds a file to an AI assistant that can be available for retrieval or code analyzer.
|
|
53
|
-
* @param assistantId - The ID of the assistant.
|
|
54
|
-
* @param file - The file to be added.
|
|
55
|
-
* @returns A promise that resolves to the ID of the added file.
|
|
56
|
-
*/
|
|
57
|
-
addFileToAssistant(assistantId: string, file: File): Promise<string>;
|
|
58
|
-
/**
|
|
59
|
-
* Removes a file from an AI assistant.
|
|
60
|
-
* @param assistantId - The ID of the assistant.
|
|
61
|
-
* @param fileId - The ID of the file to be removed.
|
|
62
|
-
* @returns A promise that resolves when the file is removed.
|
|
63
|
-
*/
|
|
64
|
-
removeFileFromAssistant(assistantId: string, fileId: string): Promise<void>;
|
|
65
|
-
/**
|
|
66
|
-
* Adds a file to a specific thread of an AI assistant. These files can be used when asking a question in the thread.
|
|
67
|
-
* @param threadId - The ID of the thread.
|
|
68
|
-
* @param file - The file to be added.
|
|
69
|
-
* @returns A promise that resolves to the ID of the added file.
|
|
70
|
-
*/
|
|
71
|
-
addFileToThread(threadId: string, file: File): Promise<string>;
|
|
72
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|