@proveanything/smartlinks 1.7.6 → 1.7.8
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/README.md +68 -0
- package/dist/api/ai.d.ts +63 -8
- package/dist/api/ai.js +206 -31
- package/dist/docs/API_SUMMARY.md +192 -85
- package/dist/docs/ai.md +236 -34
- package/dist/openapi.yaml +272 -11
- package/dist/types/ai.d.ts +87 -0
- package/docs/API_SUMMARY.md +192 -85
- package/docs/ai.md +236 -34
- package/openapi.yaml +272 -11
- package/package.json +1 -1
package/dist/openapi.yaml
CHANGED
|
@@ -7,13 +7,14 @@ servers:
|
|
|
7
7
|
- url: "https://smartlinks.app/api/v1"
|
|
8
8
|
description: Production
|
|
9
9
|
tags:
|
|
10
|
+
- name: responses
|
|
10
11
|
- name: completions
|
|
11
12
|
- name: models
|
|
12
13
|
- name: rag
|
|
13
14
|
- name: sessions
|
|
14
15
|
- name: podcast
|
|
15
16
|
- name: tts
|
|
16
|
-
- name:
|
|
17
|
+
- name: publicClient
|
|
17
18
|
- name: voice
|
|
18
19
|
- name: userAppData
|
|
19
20
|
- name: appConfiguration
|
|
@@ -691,7 +692,7 @@ paths:
|
|
|
691
692
|
post:
|
|
692
693
|
tags:
|
|
693
694
|
- rag
|
|
694
|
-
summary: "List available AI models / export async function list(collectionId: string): Promise<
|
|
695
|
+
summary: "List available AI models / export async function list(collectionId: string, params?: AIModelListParams): Promise<AIModel"
|
|
695
696
|
operationId: rag_indexDocument
|
|
696
697
|
security:
|
|
697
698
|
- bearerAuth: []
|
|
@@ -720,11 +721,38 @@ paths:
|
|
|
720
721
|
application/json:
|
|
721
722
|
schema:
|
|
722
723
|
$ref: "#/components/schemas/IndexDocumentRequest"
|
|
724
|
+
/admin/collection/{collectionId}/ai/models)}:
|
|
725
|
+
get:
|
|
726
|
+
tags:
|
|
727
|
+
- models
|
|
728
|
+
summary: List available AI models
|
|
729
|
+
operationId: models_list
|
|
730
|
+
security:
|
|
731
|
+
- bearerAuth: []
|
|
732
|
+
parameters:
|
|
733
|
+
- name: collectionId
|
|
734
|
+
in: path
|
|
735
|
+
required: true
|
|
736
|
+
schema:
|
|
737
|
+
type: string
|
|
738
|
+
responses:
|
|
739
|
+
200:
|
|
740
|
+
description: Success
|
|
741
|
+
content:
|
|
742
|
+
application/json:
|
|
743
|
+
schema:
|
|
744
|
+
$ref: "#/components/schemas/AIModelListResponse"
|
|
745
|
+
400:
|
|
746
|
+
description: Bad request
|
|
747
|
+
401:
|
|
748
|
+
description: Unauthorized
|
|
749
|
+
404:
|
|
750
|
+
description: Not found
|
|
723
751
|
/admin/collection/{collectionId}/ai/models/{modelId}:
|
|
724
752
|
get:
|
|
725
753
|
tags:
|
|
726
754
|
- models
|
|
727
|
-
summary: "List available AI models / export async function list(collectionId: string): Promise<
|
|
755
|
+
summary: "List available AI models / export async function list(collectionId: string, params?: AIModelListParams): Promise<AIModel"
|
|
728
756
|
operationId: models_get
|
|
729
757
|
security:
|
|
730
758
|
- bearerAuth: []
|
|
@@ -938,6 +966,39 @@ paths:
|
|
|
938
966
|
application/json:
|
|
939
967
|
schema:
|
|
940
968
|
$ref: "#/components/schemas/ChatCompletionRequest"
|
|
969
|
+
/admin/collection/{collectionId}/ai/v1/responses:
|
|
970
|
+
post:
|
|
971
|
+
tags:
|
|
972
|
+
- responses
|
|
973
|
+
summary: Create a Responses API request (streaming or non-streaming)
|
|
974
|
+
operationId: responses_create
|
|
975
|
+
security:
|
|
976
|
+
- bearerAuth: []
|
|
977
|
+
parameters:
|
|
978
|
+
- name: collectionId
|
|
979
|
+
in: path
|
|
980
|
+
required: true
|
|
981
|
+
schema:
|
|
982
|
+
type: string
|
|
983
|
+
responses:
|
|
984
|
+
200:
|
|
985
|
+
description: Success
|
|
986
|
+
content:
|
|
987
|
+
application/json:
|
|
988
|
+
schema:
|
|
989
|
+
$ref: "#/components/schemas/ResponsesResult"
|
|
990
|
+
400:
|
|
991
|
+
description: Bad request
|
|
992
|
+
401:
|
|
993
|
+
description: Unauthorized
|
|
994
|
+
404:
|
|
995
|
+
description: Not found
|
|
996
|
+
requestBody:
|
|
997
|
+
required: true
|
|
998
|
+
content:
|
|
999
|
+
application/json:
|
|
1000
|
+
schema:
|
|
1001
|
+
$ref: "#/components/schemas/ResponsesRequest"
|
|
941
1002
|
/admin/collection/{collectionId}/assignSN/{codeId}:
|
|
942
1003
|
post:
|
|
943
1004
|
tags:
|
|
@@ -6871,9 +6932,9 @@ paths:
|
|
|
6871
6932
|
/public/collection/{collectionId}/ai/chat:
|
|
6872
6933
|
post:
|
|
6873
6934
|
tags:
|
|
6874
|
-
-
|
|
6935
|
+
- publicClient
|
|
6875
6936
|
summary: "Generate text-to-speech audio / export async function generate( collectionId: string, request: TTSRequest ): Promise<Blo"
|
|
6876
|
-
operationId:
|
|
6937
|
+
operationId: publicClient_chat
|
|
6877
6938
|
security: []
|
|
6878
6939
|
parameters:
|
|
6879
6940
|
- name: collectionId
|
|
@@ -6903,9 +6964,9 @@ paths:
|
|
|
6903
6964
|
/public/collection/{collectionId}/ai/rate-limit/{userId}:
|
|
6904
6965
|
get:
|
|
6905
6966
|
tags:
|
|
6906
|
-
-
|
|
6967
|
+
- publicClient
|
|
6907
6968
|
summary: "Get session history / export async function getSession(collectionId: string, sessionId: string): Promise<Session> { cons"
|
|
6908
|
-
operationId:
|
|
6969
|
+
operationId: publicClient_getRateLimit
|
|
6909
6970
|
security: []
|
|
6910
6971
|
parameters:
|
|
6911
6972
|
- name: collectionId
|
|
@@ -6934,9 +6995,9 @@ paths:
|
|
|
6934
6995
|
/public/collection/{collectionId}/ai/session/{sessionId}:
|
|
6935
6996
|
get:
|
|
6936
6997
|
tags:
|
|
6937
|
-
-
|
|
6998
|
+
- publicClient
|
|
6938
6999
|
summary: "Chat with product assistant (RAG) / export async function chat( collectionId: string, request: PublicChatRequest ): Prom"
|
|
6939
|
-
operationId:
|
|
7000
|
+
operationId: publicClient_getSession
|
|
6940
7001
|
security: []
|
|
6941
7002
|
parameters:
|
|
6942
7003
|
- name: collectionId
|
|
@@ -6965,9 +7026,9 @@ paths:
|
|
|
6965
7026
|
/public/collection/{collectionId}/ai/token:
|
|
6966
7027
|
post:
|
|
6967
7028
|
tags:
|
|
6968
|
-
-
|
|
7029
|
+
- publicClient
|
|
6969
7030
|
summary: "Clear session history / export async function clearSession(collectionId: string, sessionId: string): Promise<{ success:"
|
|
6970
|
-
operationId:
|
|
7031
|
+
operationId: publicClient_getToken
|
|
6971
7032
|
security: []
|
|
6972
7033
|
parameters:
|
|
6973
7034
|
- name: collectionId
|
|
@@ -9780,6 +9841,177 @@ components:
|
|
|
9780
9841
|
- type
|
|
9781
9842
|
- properties
|
|
9782
9843
|
- type
|
|
9844
|
+
ResponseTool:
|
|
9845
|
+
type: object
|
|
9846
|
+
properties:
|
|
9847
|
+
type:
|
|
9848
|
+
type: string
|
|
9849
|
+
name:
|
|
9850
|
+
type: string
|
|
9851
|
+
description:
|
|
9852
|
+
type: string
|
|
9853
|
+
parameters:
|
|
9854
|
+
type: object
|
|
9855
|
+
additionalProperties: true
|
|
9856
|
+
required:
|
|
9857
|
+
- type
|
|
9858
|
+
ResponseInputItem:
|
|
9859
|
+
type: object
|
|
9860
|
+
properties:
|
|
9861
|
+
role:
|
|
9862
|
+
type: string
|
|
9863
|
+
enum:
|
|
9864
|
+
- system
|
|
9865
|
+
- user
|
|
9866
|
+
- assistant
|
|
9867
|
+
- function
|
|
9868
|
+
- tool
|
|
9869
|
+
type:
|
|
9870
|
+
type: string
|
|
9871
|
+
content:
|
|
9872
|
+
type: array
|
|
9873
|
+
items:
|
|
9874
|
+
type: object
|
|
9875
|
+
additionalProperties: true
|
|
9876
|
+
name:
|
|
9877
|
+
type: string
|
|
9878
|
+
function_call:
|
|
9879
|
+
$ref: "#/components/schemas/FunctionCall"
|
|
9880
|
+
tool_calls:
|
|
9881
|
+
type: array
|
|
9882
|
+
items:
|
|
9883
|
+
$ref: "#/components/schemas/ToolCall"
|
|
9884
|
+
tool_call_id:
|
|
9885
|
+
type: string
|
|
9886
|
+
ResponsesRequest:
|
|
9887
|
+
type: object
|
|
9888
|
+
properties:
|
|
9889
|
+
model:
|
|
9890
|
+
type: string
|
|
9891
|
+
input:
|
|
9892
|
+
type: array
|
|
9893
|
+
items:
|
|
9894
|
+
type: object
|
|
9895
|
+
additionalProperties: true
|
|
9896
|
+
messages:
|
|
9897
|
+
type: array
|
|
9898
|
+
items:
|
|
9899
|
+
$ref: "#/components/schemas/ResponseInputItem"
|
|
9900
|
+
previous_response_id:
|
|
9901
|
+
type: string
|
|
9902
|
+
conversation:
|
|
9903
|
+
type: object
|
|
9904
|
+
additionalProperties: true
|
|
9905
|
+
tools:
|
|
9906
|
+
type: array
|
|
9907
|
+
items:
|
|
9908
|
+
oneOf:
|
|
9909
|
+
- $ref: "#/components/schemas/ToolDefinition"
|
|
9910
|
+
- $ref: "#/components/schemas/ResponseTool"
|
|
9911
|
+
stream:
|
|
9912
|
+
type: boolean
|
|
9913
|
+
temperature:
|
|
9914
|
+
type: number
|
|
9915
|
+
max_output_tokens:
|
|
9916
|
+
type: number
|
|
9917
|
+
store:
|
|
9918
|
+
type: boolean
|
|
9919
|
+
instructions:
|
|
9920
|
+
type: string
|
|
9921
|
+
include:
|
|
9922
|
+
type: array
|
|
9923
|
+
items:
|
|
9924
|
+
type: string
|
|
9925
|
+
reasoning:
|
|
9926
|
+
type: object
|
|
9927
|
+
additionalProperties: true
|
|
9928
|
+
parallel_tool_calls:
|
|
9929
|
+
type: boolean
|
|
9930
|
+
truncation:
|
|
9931
|
+
type: string
|
|
9932
|
+
enum:
|
|
9933
|
+
- auto
|
|
9934
|
+
- disabled
|
|
9935
|
+
text:
|
|
9936
|
+
type: object
|
|
9937
|
+
additionalProperties: true
|
|
9938
|
+
metadata:
|
|
9939
|
+
type: object
|
|
9940
|
+
additionalProperties:
|
|
9941
|
+
type: string
|
|
9942
|
+
prompt_cache_key:
|
|
9943
|
+
type: string
|
|
9944
|
+
ResponsesResult:
|
|
9945
|
+
type: object
|
|
9946
|
+
properties:
|
|
9947
|
+
id:
|
|
9948
|
+
type: string
|
|
9949
|
+
object:
|
|
9950
|
+
type: string
|
|
9951
|
+
enum:
|
|
9952
|
+
- response
|
|
9953
|
+
created:
|
|
9954
|
+
type: number
|
|
9955
|
+
model:
|
|
9956
|
+
type: string
|
|
9957
|
+
status:
|
|
9958
|
+
type: string
|
|
9959
|
+
enum:
|
|
9960
|
+
- completed
|
|
9961
|
+
- failed
|
|
9962
|
+
- in_progress
|
|
9963
|
+
- queued
|
|
9964
|
+
- cancelled
|
|
9965
|
+
- incomplete
|
|
9966
|
+
output:
|
|
9967
|
+
type: array
|
|
9968
|
+
items: {}
|
|
9969
|
+
output_text:
|
|
9970
|
+
type: string
|
|
9971
|
+
usage:
|
|
9972
|
+
type: object
|
|
9973
|
+
additionalProperties: true
|
|
9974
|
+
input_tokens:
|
|
9975
|
+
type: number
|
|
9976
|
+
output_tokens:
|
|
9977
|
+
type: number
|
|
9978
|
+
total_tokens:
|
|
9979
|
+
type: number
|
|
9980
|
+
error: {}
|
|
9981
|
+
incomplete_details:
|
|
9982
|
+
type: string
|
|
9983
|
+
enum:
|
|
9984
|
+
- max_output_tokens
|
|
9985
|
+
- content_filter
|
|
9986
|
+
previous_response_id:
|
|
9987
|
+
type: string
|
|
9988
|
+
conversation: {}
|
|
9989
|
+
provider:
|
|
9990
|
+
type: string
|
|
9991
|
+
enum:
|
|
9992
|
+
- openai
|
|
9993
|
+
responseTime:
|
|
9994
|
+
type: number
|
|
9995
|
+
required:
|
|
9996
|
+
- id
|
|
9997
|
+
- object
|
|
9998
|
+
- created
|
|
9999
|
+
- model
|
|
10000
|
+
- output
|
|
10001
|
+
- output_text
|
|
10002
|
+
- usage
|
|
10003
|
+
- input_tokens
|
|
10004
|
+
- output_tokens
|
|
10005
|
+
- total_tokens
|
|
10006
|
+
- provider
|
|
10007
|
+
- responseTime
|
|
10008
|
+
ResponsesStreamEvent:
|
|
10009
|
+
type: object
|
|
10010
|
+
properties:
|
|
10011
|
+
type:
|
|
10012
|
+
type: string
|
|
10013
|
+
required:
|
|
10014
|
+
- type
|
|
9783
10015
|
ChatCompletionRequest:
|
|
9784
10016
|
type: object
|
|
9785
10017
|
properties:
|
|
@@ -9961,6 +10193,35 @@ components:
|
|
|
9961
10193
|
- input
|
|
9962
10194
|
- output
|
|
9963
10195
|
- features
|
|
10196
|
+
AIModelListParams:
|
|
10197
|
+
type: object
|
|
10198
|
+
properties:
|
|
10199
|
+
provider:
|
|
10200
|
+
type: string
|
|
10201
|
+
enum:
|
|
10202
|
+
- gemini
|
|
10203
|
+
- openai
|
|
10204
|
+
capability:
|
|
10205
|
+
type: string
|
|
10206
|
+
enum:
|
|
10207
|
+
- text
|
|
10208
|
+
- vision
|
|
10209
|
+
- audio
|
|
10210
|
+
- code
|
|
10211
|
+
AIModelListResponse:
|
|
10212
|
+
type: object
|
|
10213
|
+
properties:
|
|
10214
|
+
object:
|
|
10215
|
+
type: string
|
|
10216
|
+
enum:
|
|
10217
|
+
- list
|
|
10218
|
+
data:
|
|
10219
|
+
type: array
|
|
10220
|
+
items:
|
|
10221
|
+
$ref: "#/components/schemas/AIModel"
|
|
10222
|
+
required:
|
|
10223
|
+
- object
|
|
10224
|
+
- data
|
|
9964
10225
|
DocumentChunk:
|
|
9965
10226
|
type: object
|
|
9966
10227
|
properties:
|
package/dist/types/ai.d.ts
CHANGED
|
@@ -50,6 +50,83 @@ export interface ToolDefinition {
|
|
|
50
50
|
};
|
|
51
51
|
};
|
|
52
52
|
}
|
|
53
|
+
/** Additional/native tool definition accepted by the Responses API. */
|
|
54
|
+
export interface ResponseTool {
|
|
55
|
+
type: string;
|
|
56
|
+
name?: string;
|
|
57
|
+
description?: string;
|
|
58
|
+
parameters?: Record<string, any>;
|
|
59
|
+
[key: string]: any;
|
|
60
|
+
}
|
|
61
|
+
/** Structured input item accepted by the Responses API. */
|
|
62
|
+
export interface ResponseInputItem {
|
|
63
|
+
role?: 'system' | 'user' | 'assistant' | 'function' | 'tool';
|
|
64
|
+
type?: string;
|
|
65
|
+
content?: string | ContentPart[];
|
|
66
|
+
name?: string;
|
|
67
|
+
function_call?: FunctionCall;
|
|
68
|
+
tool_calls?: ToolCall[];
|
|
69
|
+
tool_call_id?: string;
|
|
70
|
+
[key: string]: any;
|
|
71
|
+
}
|
|
72
|
+
/** Request for the Responses API. */
|
|
73
|
+
export interface ResponsesRequest {
|
|
74
|
+
model?: string;
|
|
75
|
+
input?: string | ResponseInputItem[];
|
|
76
|
+
messages?: ResponseInputItem[];
|
|
77
|
+
previous_response_id?: string;
|
|
78
|
+
conversation?: string | Record<string, any>;
|
|
79
|
+
tools?: Array<ToolDefinition | ResponseTool>;
|
|
80
|
+
tool_choice?: 'none' | 'auto' | 'required' | {
|
|
81
|
+
type: 'function';
|
|
82
|
+
function: {
|
|
83
|
+
name: string;
|
|
84
|
+
};
|
|
85
|
+
} | {
|
|
86
|
+
type: 'function';
|
|
87
|
+
name: string;
|
|
88
|
+
};
|
|
89
|
+
stream?: boolean;
|
|
90
|
+
temperature?: number;
|
|
91
|
+
max_output_tokens?: number;
|
|
92
|
+
store?: boolean;
|
|
93
|
+
instructions?: string;
|
|
94
|
+
include?: string[];
|
|
95
|
+
reasoning?: Record<string, any>;
|
|
96
|
+
parallel_tool_calls?: boolean;
|
|
97
|
+
truncation?: 'auto' | 'disabled';
|
|
98
|
+
text?: Record<string, any>;
|
|
99
|
+
metadata?: Record<string, string>;
|
|
100
|
+
prompt_cache_key?: string;
|
|
101
|
+
}
|
|
102
|
+
/** Response from the Responses API. */
|
|
103
|
+
export interface ResponsesResult {
|
|
104
|
+
id: string;
|
|
105
|
+
object: 'response';
|
|
106
|
+
created: number;
|
|
107
|
+
model: string;
|
|
108
|
+
status?: 'completed' | 'failed' | 'in_progress' | 'queued' | 'cancelled' | 'incomplete';
|
|
109
|
+
output: any[];
|
|
110
|
+
output_text: string;
|
|
111
|
+
usage: {
|
|
112
|
+
input_tokens: number;
|
|
113
|
+
output_tokens: number;
|
|
114
|
+
total_tokens: number;
|
|
115
|
+
};
|
|
116
|
+
error?: any;
|
|
117
|
+
incomplete_details?: {
|
|
118
|
+
reason?: 'max_output_tokens' | 'content_filter';
|
|
119
|
+
} | null;
|
|
120
|
+
previous_response_id?: string | null;
|
|
121
|
+
conversation?: unknown;
|
|
122
|
+
provider: 'openai';
|
|
123
|
+
responseTime: number;
|
|
124
|
+
}
|
|
125
|
+
/** Generic SSE event emitted by the Responses API. */
|
|
126
|
+
export interface ResponsesStreamEvent {
|
|
127
|
+
type: string;
|
|
128
|
+
[key: string]: any;
|
|
129
|
+
}
|
|
53
130
|
/** Chat completion request */
|
|
54
131
|
export interface ChatCompletionRequest {
|
|
55
132
|
messages: ChatMessage[];
|
|
@@ -120,6 +197,16 @@ export interface AIModel {
|
|
|
120
197
|
features: string[];
|
|
121
198
|
recommended?: string;
|
|
122
199
|
}
|
|
200
|
+
/** Filter parameters when listing models. */
|
|
201
|
+
export interface AIModelListParams {
|
|
202
|
+
provider?: 'gemini' | 'openai';
|
|
203
|
+
capability?: 'text' | 'vision' | 'audio' | 'code';
|
|
204
|
+
}
|
|
205
|
+
/** Model list response. */
|
|
206
|
+
export interface AIModelListResponse {
|
|
207
|
+
object: 'list';
|
|
208
|
+
data: AIModel[];
|
|
209
|
+
}
|
|
123
210
|
/** Document chunk with embedding */
|
|
124
211
|
export interface DocumentChunk {
|
|
125
212
|
text: string;
|