llama-stack-client 0.4.4 → 0.4.5
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/.github/workflows/ci.yml +4 -4
- package/.github/workflows/release-doctor.yml +1 -1
- package/.release-please-manifest.json +1 -1
- package/.stats.yml +4 -4
- package/CHANGELOG.md +41 -0
- package/LICENSE +1 -1
- package/README.md +41 -27
- package/api.md +32 -25
- package/dist/CHANGELOG.md +41 -0
- package/dist/LICENSE +1 -1
- package/dist/README.md +41 -27
- package/dist/core.d.ts.map +1 -1
- package/dist/core.js +5 -0
- package/dist/core.js.map +1 -1
- package/dist/core.mjs +5 -0
- package/dist/core.mjs.map +1 -1
- package/dist/index.d.mts +12 -6
- package/dist/index.d.ts +12 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/dist/package.json +1 -1
- package/dist/resources/alpha/admin.d.ts +41 -0
- package/dist/resources/alpha/admin.d.ts.map +1 -0
- package/dist/resources/alpha/admin.js +46 -0
- package/dist/resources/alpha/admin.js.map +1 -0
- package/dist/resources/alpha/admin.mjs +42 -0
- package/dist/resources/alpha/admin.mjs.map +1 -0
- package/dist/resources/alpha/alpha.d.ts +8 -4
- package/dist/resources/alpha/alpha.d.ts.map +1 -1
- package/dist/resources/alpha/alpha.js +6 -2
- package/dist/resources/alpha/alpha.js.map +1 -1
- package/dist/resources/alpha/alpha.mjs +6 -2
- package/dist/resources/alpha/alpha.mjs.map +1 -1
- package/dist/resources/alpha/benchmarks.d.ts +37 -1
- package/dist/resources/alpha/benchmarks.d.ts.map +1 -1
- package/dist/resources/alpha/eval/eval.d.ts +28 -7
- package/dist/resources/alpha/eval/eval.d.ts.map +1 -1
- package/dist/resources/alpha/eval/eval.js.map +1 -1
- package/dist/resources/alpha/eval/eval.mjs.map +1 -1
- package/dist/resources/alpha/index.d.ts +2 -1
- package/dist/resources/alpha/index.d.ts.map +1 -1
- package/dist/resources/alpha/index.js +3 -1
- package/dist/resources/alpha/index.js.map +1 -1
- package/dist/resources/alpha/index.mjs +1 -0
- package/dist/resources/alpha/index.mjs.map +1 -1
- package/dist/resources/alpha/inference.d.ts +58 -7
- package/dist/resources/alpha/inference.d.ts.map +1 -1
- package/dist/resources/alpha/post-training/index.d.ts +2 -2
- package/dist/resources/alpha/post-training/index.d.ts.map +1 -1
- package/dist/resources/alpha/post-training/index.js.map +1 -1
- package/dist/resources/alpha/post-training/index.mjs +1 -1
- package/dist/resources/alpha/post-training/index.mjs.map +1 -1
- package/dist/resources/alpha/post-training/job.d.ts +4 -16
- package/dist/resources/alpha/post-training/job.d.ts.map +1 -1
- package/dist/resources/alpha/post-training/job.js +5 -6
- package/dist/resources/alpha/post-training/job.js.map +1 -1
- package/dist/resources/alpha/post-training/job.mjs +5 -6
- package/dist/resources/alpha/post-training/job.mjs.map +1 -1
- package/dist/resources/alpha/post-training/post-training.d.ts +38 -11
- package/dist/resources/alpha/post-training/post-training.d.ts.map +1 -1
- package/dist/resources/alpha/post-training/post-training.js.map +1 -1
- package/dist/resources/alpha/post-training/post-training.mjs +1 -1
- package/dist/resources/alpha/post-training/post-training.mjs.map +1 -1
- package/dist/resources/beta/datasets.d.ts +102 -8
- package/dist/resources/beta/datasets.d.ts.map +1 -1
- package/dist/resources/chat/chat.d.ts +119 -17
- package/dist/resources/chat/chat.d.ts.map +1 -1
- package/dist/resources/chat/chat.js.map +1 -1
- package/dist/resources/chat/chat.mjs.map +1 -1
- package/dist/resources/chat/completions.d.ts +1130 -73
- package/dist/resources/chat/completions.d.ts.map +1 -1
- package/dist/resources/chat/completions.js +0 -2
- package/dist/resources/chat/completions.js.map +1 -1
- package/dist/resources/chat/completions.mjs +0 -2
- package/dist/resources/chat/completions.mjs.map +1 -1
- package/dist/resources/completions.d.ts +135 -26
- package/dist/resources/completions.d.ts.map +1 -1
- package/dist/resources/completions.js.map +1 -1
- package/dist/resources/completions.mjs.map +1 -1
- package/dist/resources/conversations/conversations.d.ts +56 -12
- package/dist/resources/conversations/conversations.d.ts.map +1 -1
- package/dist/resources/conversations/conversations.js +0 -8
- package/dist/resources/conversations/conversations.js.map +1 -1
- package/dist/resources/conversations/conversations.mjs +0 -8
- package/dist/resources/conversations/conversations.mjs.map +1 -1
- package/dist/resources/conversations/items.d.ts +364 -81
- package/dist/resources/conversations/items.d.ts.map +1 -1
- package/dist/resources/conversations/items.js +0 -6
- package/dist/resources/conversations/items.js.map +1 -1
- package/dist/resources/conversations/items.mjs +0 -6
- package/dist/resources/conversations/items.mjs.map +1 -1
- package/dist/resources/embeddings.d.ts +46 -8
- package/dist/resources/embeddings.d.ts.map +1 -1
- package/dist/resources/embeddings.js +0 -2
- package/dist/resources/embeddings.js.map +1 -1
- package/dist/resources/embeddings.mjs +0 -2
- package/dist/resources/embeddings.mjs.map +1 -1
- package/dist/resources/files.d.ts +58 -31
- package/dist/resources/files.d.ts.map +1 -1
- package/dist/resources/files.js +4 -16
- package/dist/resources/files.js.map +1 -1
- package/dist/resources/files.mjs +4 -16
- package/dist/resources/files.mjs.map +1 -1
- package/dist/resources/index.d.ts +3 -3
- package/dist/resources/index.d.ts.map +1 -1
- package/dist/resources/index.js.map +1 -1
- package/dist/resources/index.mjs.map +1 -1
- package/dist/resources/inspect.d.ts +3 -45
- package/dist/resources/inspect.d.ts.map +1 -1
- package/dist/resources/inspect.js +0 -4
- package/dist/resources/inspect.js.map +1 -1
- package/dist/resources/inspect.mjs +0 -4
- package/dist/resources/inspect.mjs.map +1 -1
- package/dist/resources/models/models.d.ts +21 -6
- package/dist/resources/models/models.d.ts.map +1 -1
- package/dist/resources/models/models.js +0 -6
- package/dist/resources/models/models.js.map +1 -1
- package/dist/resources/models/models.mjs +0 -6
- package/dist/resources/models/models.mjs.map +1 -1
- package/dist/resources/moderations.d.ts +38 -5
- package/dist/resources/moderations.d.ts.map +1 -1
- package/dist/resources/moderations.js +1 -3
- package/dist/resources/moderations.js.map +1 -1
- package/dist/resources/moderations.mjs +1 -3
- package/dist/resources/moderations.mjs.map +1 -1
- package/dist/resources/prompts/prompts.d.ts +24 -10
- package/dist/resources/prompts/prompts.d.ts.map +1 -1
- package/dist/resources/prompts/prompts.js +2 -10
- package/dist/resources/prompts/prompts.js.map +1 -1
- package/dist/resources/prompts/prompts.mjs +2 -10
- package/dist/resources/prompts/prompts.mjs.map +1 -1
- package/dist/resources/prompts/versions.d.ts +0 -2
- package/dist/resources/prompts/versions.d.ts.map +1 -1
- package/dist/resources/prompts/versions.js +0 -2
- package/dist/resources/prompts/versions.js.map +1 -1
- package/dist/resources/prompts/versions.mjs +0 -2
- package/dist/resources/prompts/versions.mjs.map +1 -1
- package/dist/resources/providers.d.ts +5 -12
- package/dist/resources/providers.d.ts.map +1 -1
- package/dist/resources/providers.js +0 -4
- package/dist/resources/providers.js.map +1 -1
- package/dist/resources/providers.mjs +0 -4
- package/dist/resources/providers.mjs.map +1 -1
- package/dist/resources/responses/input-items.d.ts +108 -9
- package/dist/resources/responses/input-items.d.ts.map +1 -1
- package/dist/resources/responses/responses.d.ts +881 -124
- package/dist/resources/responses/responses.d.ts.map +1 -1
- package/dist/resources/responses/responses.js.map +1 -1
- package/dist/resources/responses/responses.mjs.map +1 -1
- package/dist/resources/routes.d.ts +10 -9
- package/dist/resources/routes.d.ts.map +1 -1
- package/dist/resources/routes.js.map +1 -1
- package/dist/resources/routes.mjs.map +1 -1
- package/dist/resources/safety.d.ts +131 -9
- package/dist/resources/safety.d.ts.map +1 -1
- package/dist/resources/safety.js +1 -3
- package/dist/resources/safety.js.map +1 -1
- package/dist/resources/safety.mjs +1 -3
- package/dist/resources/safety.mjs.map +1 -1
- package/dist/resources/scoring-functions.d.ts +23 -1
- package/dist/resources/scoring-functions.d.ts.map +1 -1
- package/dist/resources/scoring.d.ts +24 -0
- package/dist/resources/scoring.d.ts.map +1 -1
- package/dist/resources/shared.d.ts +139 -7
- package/dist/resources/shared.d.ts.map +1 -1
- package/dist/resources/shields.d.ts +21 -0
- package/dist/resources/shields.d.ts.map +1 -1
- package/dist/resources/vector-io.d.ts +75 -58
- package/dist/resources/vector-io.d.ts.map +1 -1
- package/dist/resources/vector-io.js +1 -1
- package/dist/resources/vector-io.mjs +1 -1
- package/dist/resources/vector-stores/file-batches.d.ts +13 -7
- package/dist/resources/vector-stores/file-batches.d.ts.map +1 -1
- package/dist/resources/vector-stores/file-batches.js +3 -6
- package/dist/resources/vector-stores/file-batches.js.map +1 -1
- package/dist/resources/vector-stores/file-batches.mjs +3 -6
- package/dist/resources/vector-stores/file-batches.mjs.map +1 -1
- package/dist/resources/vector-stores/files.d.ts +31 -9
- package/dist/resources/vector-stores/files.d.ts.map +1 -1
- package/dist/resources/vector-stores/files.js +4 -4
- package/dist/resources/vector-stores/files.js.map +1 -1
- package/dist/resources/vector-stores/files.mjs +4 -4
- package/dist/resources/vector-stores/files.mjs.map +1 -1
- package/dist/resources/vector-stores/vector-stores.d.ts +87 -13
- package/dist/resources/vector-stores/vector-stores.d.ts.map +1 -1
- package/dist/resources/vector-stores/vector-stores.js +5 -10
- package/dist/resources/vector-stores/vector-stores.js.map +1 -1
- package/dist/resources/vector-stores/vector-stores.mjs +5 -10
- package/dist/resources/vector-stores/vector-stores.mjs.map +1 -1
- package/dist/src/core.ts +6 -0
- package/dist/src/index.ts +11 -16
- package/dist/src/resources/alpha/admin.ts +84 -0
- package/dist/src/resources/alpha/alpha.ts +16 -8
- package/dist/src/resources/alpha/benchmarks.ts +37 -1
- package/dist/src/resources/alpha/eval/eval.ts +28 -7
- package/dist/src/resources/alpha/index.ts +2 -0
- package/dist/src/resources/alpha/inference.ts +58 -7
- package/dist/src/resources/alpha/post-training/index.ts +2 -10
- package/dist/src/resources/alpha/post-training/job.ts +5 -26
- package/dist/src/resources/alpha/post-training/post-training.ts +38 -22
- package/dist/src/resources/beta/datasets.ts +103 -8
- package/dist/src/resources/chat/chat.ts +122 -20
- package/dist/src/resources/chat/completions.ts +1138 -79
- package/dist/src/resources/completions.ts +137 -28
- package/dist/src/resources/conversations/conversations.ts +67 -15
- package/dist/src/resources/conversations/items.ts +479 -110
- package/dist/src/resources/embeddings.ts +46 -8
- package/dist/src/resources/files.ts +58 -31
- package/dist/src/resources/index.ts +3 -3
- package/dist/src/resources/inspect.ts +3 -57
- package/dist/src/resources/models/models.ts +21 -6
- package/dist/src/resources/moderations.ts +38 -5
- package/dist/src/resources/prompts/prompts.ts +26 -12
- package/dist/src/resources/prompts/versions.ts +0 -2
- package/dist/src/resources/providers.ts +5 -16
- package/dist/src/resources/responses/input-items.ts +138 -15
- package/dist/src/resources/responses/responses.ts +1076 -196
- package/dist/src/resources/routes.ts +10 -14
- package/dist/src/resources/safety.ts +131 -8
- package/dist/src/resources/scoring-functions.ts +23 -1
- package/dist/src/resources/scoring.ts +24 -0
- package/dist/src/resources/shared.ts +148 -7
- package/dist/src/resources/shields.ts +21 -0
- package/dist/src/resources/vector-io.ts +95 -78
- package/dist/src/resources/vector-stores/file-batches.ts +13 -7
- package/dist/src/resources/vector-stores/files.ts +31 -11
- package/dist/src/resources/vector-stores/vector-stores.ts +89 -15
- package/dist/src/version.ts +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.mjs +1 -1
- package/package.json +1 -1
- package/src/core.ts +6 -0
- package/src/index.ts +11 -16
- package/src/resources/alpha/admin.ts +84 -0
- package/src/resources/alpha/alpha.ts +16 -8
- package/src/resources/alpha/benchmarks.ts +37 -1
- package/src/resources/alpha/eval/eval.ts +28 -7
- package/src/resources/alpha/index.ts +2 -0
- package/src/resources/alpha/inference.ts +58 -7
- package/src/resources/alpha/post-training/index.ts +2 -10
- package/src/resources/alpha/post-training/job.ts +5 -26
- package/src/resources/alpha/post-training/post-training.ts +38 -22
- package/src/resources/beta/datasets.ts +103 -8
- package/src/resources/chat/chat.ts +122 -20
- package/src/resources/chat/completions.ts +1138 -79
- package/src/resources/completions.ts +137 -28
- package/src/resources/conversations/conversations.ts +67 -15
- package/src/resources/conversations/items.ts +479 -110
- package/src/resources/embeddings.ts +46 -8
- package/src/resources/files.ts +58 -31
- package/src/resources/index.ts +3 -3
- package/src/resources/inspect.ts +3 -57
- package/src/resources/models/models.ts +21 -6
- package/src/resources/moderations.ts +38 -5
- package/src/resources/prompts/prompts.ts +26 -12
- package/src/resources/prompts/versions.ts +0 -2
- package/src/resources/providers.ts +5 -16
- package/src/resources/responses/input-items.ts +138 -15
- package/src/resources/responses/responses.ts +1076 -196
- package/src/resources/routes.ts +10 -14
- package/src/resources/safety.ts +131 -8
- package/src/resources/scoring-functions.ts +23 -1
- package/src/resources/scoring.ts +24 -0
- package/src/resources/shared.ts +148 -7
- package/src/resources/shields.ts +21 -0
- package/src/resources/vector-io.ts +95 -78
- package/src/resources/vector-stores/file-batches.ts +13 -7
- package/src/resources/vector-stores/files.ts +31 -11
- package/src/resources/vector-stores/vector-stores.ts +89 -15
- package/src/version.ts +1 -1
- package/tests/api-resources/alpha/admin.test.ts +111 -0
- package/tests/api-resources/alpha/eval/eval.test.ts +40 -20
- package/tests/api-resources/alpha/inference.test.ts +1 -1
- package/tests/api-resources/alpha/post-training/job.test.ts +21 -12
- package/tests/api-resources/alpha/post-training/post-training.test.ts +12 -2
- package/tests/api-resources/beta/datasets.test.ts +9 -3
- package/tests/api-resources/chat/completions.test.ts +20 -7
- package/tests/api-resources/completions.test.ts +5 -5
- package/tests/api-resources/conversations/items.test.ts +22 -3
- package/tests/api-resources/embeddings.test.ts +2 -2
- package/tests/api-resources/files.test.ts +6 -1
- package/tests/api-resources/responses/input-items.test.ts +7 -1
- package/tests/api-resources/responses/responses.test.ts +19 -5
- package/tests/api-resources/safety.test.ts +9 -5
- package/tests/api-resources/tool-runtime.test.ts +9 -2
- package/tests/api-resources/vector-io.test.ts +13 -4
- package/tests/api-resources/vector-stores/file-batches.test.ts +7 -1
- package/tests/api-resources/vector-stores/files.test.ts +7 -1
- package/tests/api-resources/vector-stores/vector-stores.test.ts +14 -2
|
@@ -9,33 +9,28 @@ export declare class VectorStores extends APIResource {
|
|
|
9
9
|
files: FilesAPI.Files;
|
|
10
10
|
fileBatches: FileBatchesAPI.FileBatches;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* Generate an OpenAI-compatible vector store with the given parameters.
|
|
12
|
+
* Create a vector store (OpenAI-compatible).
|
|
15
13
|
*/
|
|
16
14
|
create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
|
|
17
15
|
/**
|
|
18
|
-
*
|
|
16
|
+
* Retrieve a vector store (OpenAI-compatible).
|
|
19
17
|
*/
|
|
20
18
|
retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
|
|
21
19
|
/**
|
|
22
|
-
*
|
|
20
|
+
* Update a vector store (OpenAI-compatible).
|
|
23
21
|
*/
|
|
24
22
|
update(vectorStoreId: string, body: VectorStoreUpdateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore>;
|
|
25
23
|
/**
|
|
26
|
-
*
|
|
24
|
+
* List vector stores (OpenAI-compatible).
|
|
27
25
|
*/
|
|
28
26
|
list(query?: VectorStoreListParams, options?: Core.RequestOptions): Core.PagePromise<VectorStoresOpenAICursorPage, VectorStore>;
|
|
29
27
|
list(options?: Core.RequestOptions): Core.PagePromise<VectorStoresOpenAICursorPage, VectorStore>;
|
|
30
28
|
/**
|
|
31
|
-
* Delete a vector store.
|
|
29
|
+
* Delete a vector store (OpenAI-compatible).
|
|
32
30
|
*/
|
|
33
31
|
delete(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleteResponse>;
|
|
34
32
|
/**
|
|
35
|
-
* Search
|
|
36
|
-
*
|
|
37
|
-
* Searches a vector store for relevant chunks based on a query and optional file
|
|
38
|
-
* attribute filters.
|
|
33
|
+
* Search a vector store (OpenAI-compatible).
|
|
39
34
|
*/
|
|
40
35
|
search(vectorStoreId: string, body: VectorStoreSearchParams, options?: Core.RequestOptions): Core.APIPromise<VectorStoreSearchResponse>;
|
|
41
36
|
}
|
|
@@ -148,8 +143,6 @@ export declare namespace VectorStoreSearchResponse {
|
|
|
148
143
|
* the context during inference.
|
|
149
144
|
*/
|
|
150
145
|
interface ChunkMetadata {
|
|
151
|
-
chunk_embedding_dimension?: number | null;
|
|
152
|
-
chunk_embedding_model?: string | null;
|
|
153
146
|
chunk_id?: string | null;
|
|
154
147
|
chunk_tokenizer?: string | null;
|
|
155
148
|
chunk_window?: string | null;
|
|
@@ -206,38 +199,119 @@ export declare namespace VectorStoreCreateParams {
|
|
|
206
199
|
}
|
|
207
200
|
}
|
|
208
201
|
export interface VectorStoreUpdateParams {
|
|
202
|
+
/**
|
|
203
|
+
* Expiration policy for the vector store.
|
|
204
|
+
*/
|
|
209
205
|
expires_after?: {
|
|
210
206
|
[key: string]: unknown;
|
|
211
207
|
} | null;
|
|
208
|
+
/**
|
|
209
|
+
* Metadata to associate with the vector store.
|
|
210
|
+
*/
|
|
212
211
|
metadata?: {
|
|
213
212
|
[key: string]: unknown;
|
|
214
213
|
} | null;
|
|
214
|
+
/**
|
|
215
|
+
* The new name for the vector store.
|
|
216
|
+
*/
|
|
215
217
|
name?: string | null;
|
|
216
218
|
}
|
|
217
219
|
export interface VectorStoreListParams extends OpenAICursorPageParams {
|
|
220
|
+
/**
|
|
221
|
+
* Pagination cursor (before).
|
|
222
|
+
*/
|
|
218
223
|
before?: string | null;
|
|
224
|
+
/**
|
|
225
|
+
* Sort order by created_at: asc or desc.
|
|
226
|
+
*/
|
|
219
227
|
order?: string | null;
|
|
220
228
|
}
|
|
221
229
|
export interface VectorStoreSearchParams {
|
|
230
|
+
/**
|
|
231
|
+
* The search query string or list of query strings.
|
|
232
|
+
*/
|
|
222
233
|
query: string | Array<string>;
|
|
234
|
+
/**
|
|
235
|
+
* Filters to apply to the search.
|
|
236
|
+
*/
|
|
223
237
|
filters?: {
|
|
224
238
|
[key: string]: unknown;
|
|
225
239
|
} | null;
|
|
240
|
+
/**
|
|
241
|
+
* Maximum number of results to return.
|
|
242
|
+
*/
|
|
226
243
|
max_num_results?: number | null;
|
|
227
244
|
/**
|
|
228
245
|
* Options for ranking and filtering search results.
|
|
246
|
+
*
|
|
247
|
+
* This class configures how search results are ranked and filtered. You can use
|
|
248
|
+
* algorithm-based rerankers (weighted, RRF) or neural rerankers. Defaults from
|
|
249
|
+
* VectorStoresConfig are used when parameters are not provided.
|
|
250
|
+
*
|
|
251
|
+
* Examples: # Weighted ranker with custom alpha
|
|
252
|
+
* SearchRankingOptions(ranker="weighted", alpha=0.7)
|
|
253
|
+
*
|
|
254
|
+
* # RRF ranker with custom impact factor
|
|
255
|
+
* SearchRankingOptions(ranker="rrf", impact_factor=50.0)
|
|
256
|
+
*
|
|
257
|
+
* # Use config defaults (just specify ranker type)
|
|
258
|
+
* SearchRankingOptions(ranker="weighted") # Uses alpha from VectorStoresConfig
|
|
259
|
+
*
|
|
260
|
+
* # Score threshold filtering
|
|
261
|
+
* SearchRankingOptions(ranker="weighted", score_threshold=0.5)
|
|
229
262
|
*/
|
|
230
263
|
ranking_options?: VectorStoreSearchParams.RankingOptions | null;
|
|
264
|
+
/**
|
|
265
|
+
* Whether to rewrite the query for better results.
|
|
266
|
+
*/
|
|
231
267
|
rewrite_query?: boolean | null;
|
|
268
|
+
/**
|
|
269
|
+
* The search mode to use (e.g., 'vector', 'keyword').
|
|
270
|
+
*/
|
|
232
271
|
search_mode?: string | null;
|
|
233
272
|
}
|
|
234
273
|
export declare namespace VectorStoreSearchParams {
|
|
235
274
|
/**
|
|
236
275
|
* Options for ranking and filtering search results.
|
|
276
|
+
*
|
|
277
|
+
* This class configures how search results are ranked and filtered. You can use
|
|
278
|
+
* algorithm-based rerankers (weighted, RRF) or neural rerankers. Defaults from
|
|
279
|
+
* VectorStoresConfig are used when parameters are not provided.
|
|
280
|
+
*
|
|
281
|
+
* Examples: # Weighted ranker with custom alpha
|
|
282
|
+
* SearchRankingOptions(ranker="weighted", alpha=0.7)
|
|
283
|
+
*
|
|
284
|
+
* # RRF ranker with custom impact factor
|
|
285
|
+
* SearchRankingOptions(ranker="rrf", impact_factor=50.0)
|
|
286
|
+
*
|
|
287
|
+
* # Use config defaults (just specify ranker type)
|
|
288
|
+
* SearchRankingOptions(ranker="weighted") # Uses alpha from VectorStoresConfig
|
|
289
|
+
*
|
|
290
|
+
* # Score threshold filtering
|
|
291
|
+
* SearchRankingOptions(ranker="weighted", score_threshold=0.5)
|
|
237
292
|
*/
|
|
238
293
|
interface RankingOptions {
|
|
294
|
+
/**
|
|
295
|
+
* Weight factor for weighted ranker
|
|
296
|
+
*/
|
|
297
|
+
alpha?: number | null;
|
|
298
|
+
/**
|
|
299
|
+
* Impact factor for RRF algorithm
|
|
300
|
+
*/
|
|
301
|
+
impact_factor?: number | null;
|
|
302
|
+
/**
|
|
303
|
+
* Model identifier for neural reranker
|
|
304
|
+
*/
|
|
305
|
+
model?: string | null;
|
|
239
306
|
ranker?: string | null;
|
|
240
307
|
score_threshold?: number | null;
|
|
308
|
+
/**
|
|
309
|
+
* Weights for combining vector, keyword, and neural scores. Keys: 'vector',
|
|
310
|
+
* 'keyword', 'neural'
|
|
311
|
+
*/
|
|
312
|
+
weights?: {
|
|
313
|
+
[key: string]: number;
|
|
314
|
+
} | null;
|
|
241
315
|
}
|
|
242
316
|
}
|
|
243
317
|
export declare namespace VectorStores {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vector-stores.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,cAAc,MAAM,gBAAgB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,WAAW,EACX,mCAAmC,EACnC,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,gCAAgC,EACjC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAEjF,qBAAa,YAAa,SAAQ,WAAW;IAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF
|
|
1
|
+
{"version":3,"file":"vector-stores.d.ts","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,KAAK,cAAc,MAAM,gBAAgB,CAAC;AACjD,OAAO,EACL,qBAAqB,EACrB,wBAAwB,EACxB,WAAW,EACX,mCAAmC,EACnC,sBAAsB,EACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,QAAQ,MAAM,SAAS,CAAC;AACpC,OAAO,EACL,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,gCAAgC,EACjC,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAEjF,qBAAa,YAAa,SAAQ,WAAW;IAC3C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IACzD,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAIlG;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAI5F;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;IAI/B;;OAEG;IACH,IAAI,CACF,KAAK,CAAC,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,WAAW,CAAC;IAC9D,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,WAAW,CAAC;IAWhG;;OAEG;IACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAIxG;;OAEG;IACH,MAAM,CACJ,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;CAG9C;AAED,qBAAa,4BAA6B,SAAQ,gBAAgB,CAAC,WAAW,CAAC;CAAG;AAElF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAEzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,UAAU,CAAC;IAEpC,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElD,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,WAAW,CAAC;IAC3B;;OAEG;IACH,UAAiB,UAAU;QACzB,SAAS,EAAE,MAAM,CAAC;QAElB,SAAS,EAAE,MAAM,CAAC;QAElB,MAAM,EAAE,MAAM,CAAC;QAEf,WAAW,EAAE,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IAEX,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAE5C,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE7B,OAAO,EAAE,MAAM,CAAC;QAEhB,QAAQ,EAAE,MAAM,CAAC;QAEjB,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAClE;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,OAAO;YACtB,IAAI,EAAE,MAAM,CAAC;YAEb,IAAI,EAAE,MAAM,CAAC;YAEb;;;;;;;eAOG;YACH,cAAc,CAAC,EAAE,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;YAE9C,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;YAEjC,QAAQ,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,GAAG,IAAI,CAAC;SAC9C;QAED,UAAiB,OAAO,CAAC;YACvB;;;;;;;eAOG;YACH,UAAiB,aAAa;gBAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEzB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEhC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE7B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEpC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAE5B,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAErC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEvB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACnC;SACF;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,iBAAiB,CAAC,EACd,uBAAuB,CAAC,+BAA+B,GACvD,uBAAuB,CAAC,iCAAiC,GACzD,IAAI,CAAC;IAET,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElD,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEhC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;OAEG;IACH,UAAiB,+BAA+B;QAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,iCAAiC;QAChD;;WAEG;QACH,MAAM,EAAE,iCAAiC,CAAC,MAAM,CAAC;QAEjD,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB;IAED,UAAiB,iCAAiC,CAAC;QACjD;;WAEG;QACH,UAAiB,MAAM;YACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;YAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;KACF;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElD;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE7C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,qBAAsB,SAAQ,sBAAsB;IACnE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,uBAAuB,CAAC,cAAc,GAAG,IAAI,CAAC;IAEhE;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,uBAAuB,CAAC;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEvB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;;WAGG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GAAG,IAAI,CAAC;KAC5C;CACF;AAOD,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,4BAA4B,IAAI,4BAA4B,EAC5D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,gCAAgC,IAAI,gCAAgC,EACpE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
|
|
@@ -45,21 +45,19 @@ class VectorStores extends resource_1.APIResource {
|
|
|
45
45
|
this.fileBatches = new FileBatchesAPI.FileBatches(this._client);
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* Generate an OpenAI-compatible vector store with the given parameters.
|
|
48
|
+
* Create a vector store (OpenAI-compatible).
|
|
51
49
|
*/
|
|
52
50
|
create(body, options) {
|
|
53
51
|
return this._client.post('/v1/vector_stores', { body, ...options });
|
|
54
52
|
}
|
|
55
53
|
/**
|
|
56
|
-
*
|
|
54
|
+
* Retrieve a vector store (OpenAI-compatible).
|
|
57
55
|
*/
|
|
58
56
|
retrieve(vectorStoreId, options) {
|
|
59
57
|
return this._client.get(`/v1/vector_stores/${vectorStoreId}`, options);
|
|
60
58
|
}
|
|
61
59
|
/**
|
|
62
|
-
*
|
|
60
|
+
* Update a vector store (OpenAI-compatible).
|
|
63
61
|
*/
|
|
64
62
|
update(vectorStoreId, body, options) {
|
|
65
63
|
return this._client.post(`/v1/vector_stores/${vectorStoreId}`, { body, ...options });
|
|
@@ -71,16 +69,13 @@ class VectorStores extends resource_1.APIResource {
|
|
|
71
69
|
return this._client.getAPIList('/v1/vector_stores', VectorStoresOpenAICursorPage, { query, ...options });
|
|
72
70
|
}
|
|
73
71
|
/**
|
|
74
|
-
* Delete a vector store.
|
|
72
|
+
* Delete a vector store (OpenAI-compatible).
|
|
75
73
|
*/
|
|
76
74
|
delete(vectorStoreId, options) {
|
|
77
75
|
return this._client.delete(`/v1/vector_stores/${vectorStoreId}`, options);
|
|
78
76
|
}
|
|
79
77
|
/**
|
|
80
|
-
* Search
|
|
81
|
-
*
|
|
82
|
-
* Searches a vector store for relevant chunks based on a query and optional file
|
|
83
|
-
* attribute filters.
|
|
78
|
+
* Search a vector store (OpenAI-compatible).
|
|
84
79
|
*/
|
|
85
80
|
search(vectorStoreId, body, options) {
|
|
86
81
|
return this._client.post(`/v1/vector_stores/${vectorStoreId}/search`, { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vector-stores.js","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,kEAAiD;AACjD,oDAMwB;AACxB,qDAAoC;AACpC,sCAUiB;AACjB,oDAAiF;AAEjF,MAAa,YAAa,SAAQ,sBAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"vector-stores.js","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":";AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,gDAA6C;AAC7C,wCAA8C;AAE9C,kEAAiD;AACjD,oDAMwB;AACxB,qDAAoC;AACpC,sCAUiB;AACjB,oDAAiF;AAEjF,MAAa,YAAa,SAAQ,sBAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8DzF,CAAC;IA5DC;;OAEG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAUD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,IAAA,uBAAgB,EAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,aAAa,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AAhED,oCAgEC;AAED,MAAa,4BAA6B,SAAQ,6BAA6B;CAAG;AAAlF,oEAAkF;AAmVlF,YAAY,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;AACzE,YAAY,CAAC,KAAK,GAAG,aAAK,CAAC;AAC3B,YAAY,CAAC,gCAAgC,GAAG,wCAAgC,CAAC;AACjF,YAAY,CAAC,WAAW,GAAG,0BAAW,CAAC"}
|
|
@@ -19,21 +19,19 @@ export class VectorStores extends APIResource {
|
|
|
19
19
|
this.fileBatches = new FileBatchesAPI.FileBatches(this._client);
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
* Generate an OpenAI-compatible vector store with the given parameters.
|
|
22
|
+
* Create a vector store (OpenAI-compatible).
|
|
25
23
|
*/
|
|
26
24
|
create(body, options) {
|
|
27
25
|
return this._client.post('/v1/vector_stores', { body, ...options });
|
|
28
26
|
}
|
|
29
27
|
/**
|
|
30
|
-
*
|
|
28
|
+
* Retrieve a vector store (OpenAI-compatible).
|
|
31
29
|
*/
|
|
32
30
|
retrieve(vectorStoreId, options) {
|
|
33
31
|
return this._client.get(`/v1/vector_stores/${vectorStoreId}`, options);
|
|
34
32
|
}
|
|
35
33
|
/**
|
|
36
|
-
*
|
|
34
|
+
* Update a vector store (OpenAI-compatible).
|
|
37
35
|
*/
|
|
38
36
|
update(vectorStoreId, body, options) {
|
|
39
37
|
return this._client.post(`/v1/vector_stores/${vectorStoreId}`, { body, ...options });
|
|
@@ -45,16 +43,13 @@ export class VectorStores extends APIResource {
|
|
|
45
43
|
return this._client.getAPIList('/v1/vector_stores', VectorStoresOpenAICursorPage, { query, ...options });
|
|
46
44
|
}
|
|
47
45
|
/**
|
|
48
|
-
* Delete a vector store.
|
|
46
|
+
* Delete a vector store (OpenAI-compatible).
|
|
49
47
|
*/
|
|
50
48
|
delete(vectorStoreId, options) {
|
|
51
49
|
return this._client.delete(`/v1/vector_stores/${vectorStoreId}`, options);
|
|
52
50
|
}
|
|
53
51
|
/**
|
|
54
|
-
* Search
|
|
55
|
-
*
|
|
56
|
-
* Searches a vector store for relevant chunks based on a query and optional file
|
|
57
|
-
* attribute filters.
|
|
52
|
+
* Search a vector store (OpenAI-compatible).
|
|
58
53
|
*/
|
|
59
54
|
search(vectorStoreId, body, options) {
|
|
60
55
|
return this._client.post(`/v1/vector_stores/${vectorStoreId}/search`, { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"vector-stores.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,cAAc;OACnB,EAGL,WAAW,GAGZ;OACM,KAAK,QAAQ;OACb,EAOL,KAAK,EAEL,gCAAgC,GACjC;OACM,EAAE,gBAAgB,EAA+B;AAExD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"vector-stores.mjs","sourceRoot":"","sources":["../../src/resources/vector-stores/vector-stores.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,uBAAuB;AACvB,EAAE;AACF,gFAAgF;AAChF,0CAA0C;AAC1C,EAAE;AACF,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,EAAE,gBAAgB,EAAE;OAEpB,KAAK,cAAc;OACnB,EAGL,WAAW,GAGZ;OACM,KAAK,QAAQ;OACb,EAOL,KAAK,EAEL,gCAAgC,GACjC;OACM,EAAE,gBAAgB,EAA+B;AAExD,MAAM,OAAO,YAAa,SAAQ,WAAW;IAA7C;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzD,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA8DzF,CAAC;IA5DC;;OAEG;IACH,MAAM,CAAC,IAA6B,EAAE,OAA6B;QACjE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,aAAqB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,aAAa,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAUD,IAAI,CACF,QAAqD,EAAE,EACvD,OAA6B;QAE7B,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,aAAqB,EAAE,OAA6B;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,qBAAqB,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,aAAqB,EACrB,IAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,aAAa,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF;AAED,MAAM,OAAO,4BAA6B,SAAQ,gBAA6B;CAAG;AAmVlF,YAAY,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;AACzE,YAAY,CAAC,KAAK,GAAG,KAAK,CAAC;AAC3B,YAAY,CAAC,gCAAgC,GAAG,gCAAgC,CAAC;AACjF,YAAY,CAAC,WAAW,GAAG,WAAW,CAAC"}
|
package/dist/src/core.ts
CHANGED
|
@@ -90,6 +90,12 @@ async function defaultParseResponse<T>(props: APIResponseProps): Promise<T> {
|
|
|
90
90
|
const mediaType = contentType?.split(';')[0]?.trim();
|
|
91
91
|
const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
|
|
92
92
|
if (isJSON) {
|
|
93
|
+
const contentLength = response.headers.get('content-length');
|
|
94
|
+
if (contentLength === '0') {
|
|
95
|
+
// if there is no content we can't do anything
|
|
96
|
+
return undefined as T;
|
|
97
|
+
}
|
|
98
|
+
|
|
93
99
|
const json = await response.json();
|
|
94
100
|
|
|
95
101
|
debug('response', response.status, response.url, response.headers, json);
|
package/dist/src/index.ts
CHANGED
|
@@ -48,10 +48,10 @@ import {
|
|
|
48
48
|
FilesOpenAICursorPage,
|
|
49
49
|
ListFilesResponse,
|
|
50
50
|
} from './resources/files';
|
|
51
|
-
import {
|
|
51
|
+
import { Inspect } from './resources/inspect';
|
|
52
52
|
import { CreateResponse, ModerationCreateParams, Moderations } from './resources/moderations';
|
|
53
|
-
import {
|
|
54
|
-
import {
|
|
53
|
+
import { ProviderListResponse, Providers } from './resources/providers';
|
|
54
|
+
import { RouteListParams, RouteListResponse, Routes } from './resources/routes';
|
|
55
55
|
import { RunShieldResponse, Safety, SafetyRunShieldParams } from './resources/safety';
|
|
56
56
|
import {
|
|
57
57
|
Scoring,
|
|
@@ -431,13 +431,7 @@ export declare namespace LlamaStackClient {
|
|
|
431
431
|
type ConversationUpdateParams as ConversationUpdateParams,
|
|
432
432
|
};
|
|
433
433
|
|
|
434
|
-
export {
|
|
435
|
-
Inspect as Inspect,
|
|
436
|
-
type HealthInfo as HealthInfo,
|
|
437
|
-
type ProviderInfo as ProviderInfo,
|
|
438
|
-
type RouteInfo as RouteInfo,
|
|
439
|
-
type VersionInfo as VersionInfo,
|
|
440
|
-
};
|
|
434
|
+
export { Inspect as Inspect };
|
|
441
435
|
|
|
442
436
|
export {
|
|
443
437
|
Embeddings as Embeddings,
|
|
@@ -485,15 +479,10 @@ export declare namespace LlamaStackClient {
|
|
|
485
479
|
type ModelRegisterParams as ModelRegisterParams,
|
|
486
480
|
};
|
|
487
481
|
|
|
488
|
-
export {
|
|
489
|
-
Providers as Providers,
|
|
490
|
-
type ListProvidersResponse as ListProvidersResponse,
|
|
491
|
-
type ProviderListResponse as ProviderListResponse,
|
|
492
|
-
};
|
|
482
|
+
export { Providers as Providers, type ProviderListResponse as ProviderListResponse };
|
|
493
483
|
|
|
494
484
|
export {
|
|
495
485
|
Routes as Routes,
|
|
496
|
-
type ListRoutesResponse as ListRoutesResponse,
|
|
497
486
|
type RouteListResponse as RouteListResponse,
|
|
498
487
|
type RouteListParams as RouteListParams,
|
|
499
488
|
};
|
|
@@ -561,13 +550,19 @@ export declare namespace LlamaStackClient {
|
|
|
561
550
|
|
|
562
551
|
export { Beta as Beta };
|
|
563
552
|
|
|
553
|
+
export type HealthInfo = API.HealthInfo;
|
|
564
554
|
export type InterleavedContent = API.InterleavedContent;
|
|
565
555
|
export type InterleavedContentItem = API.InterleavedContentItem;
|
|
556
|
+
export type ListProvidersResponse = API.ListProvidersResponse;
|
|
557
|
+
export type ListRoutesResponse = API.ListRoutesResponse;
|
|
566
558
|
export type ParamType = API.ParamType;
|
|
559
|
+
export type ProviderInfo = API.ProviderInfo;
|
|
560
|
+
export type RouteInfo = API.RouteInfo;
|
|
567
561
|
export type SafetyViolation = API.SafetyViolation;
|
|
568
562
|
export type SamplingParams = API.SamplingParams;
|
|
569
563
|
export type ScoringResult = API.ScoringResult;
|
|
570
564
|
export type SystemMessage = API.SystemMessage;
|
|
565
|
+
export type VersionInfo = API.VersionInfo;
|
|
571
566
|
}
|
|
572
567
|
|
|
573
568
|
export { getResponseOutputText } from './lib/response-helpers';
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
// Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
2
|
+
// All rights reserved.
|
|
3
|
+
//
|
|
4
|
+
// This source code is licensed under the terms described in the LICENSE file in
|
|
5
|
+
// the root directory of this source tree.
|
|
6
|
+
//
|
|
7
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
8
|
+
|
|
9
|
+
import { APIResource } from '../../resource';
|
|
10
|
+
import { isRequestOptions } from '../../core';
|
|
11
|
+
import * as Core from '../../core';
|
|
12
|
+
import * as ProvidersAPI from '../providers';
|
|
13
|
+
import * as RoutesAPI from '../routes';
|
|
14
|
+
import * as Shared from '../shared';
|
|
15
|
+
|
|
16
|
+
export class Admin extends APIResource {
|
|
17
|
+
/**
|
|
18
|
+
* Get the current health status of the service.
|
|
19
|
+
*/
|
|
20
|
+
health(options?: Core.RequestOptions): Core.APIPromise<Shared.HealthInfo> {
|
|
21
|
+
return this._client.get('/v1alpha/admin/health', options);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Get detailed information about a specific provider.
|
|
26
|
+
*/
|
|
27
|
+
inspectProvider(providerId: string, options?: Core.RequestOptions): Core.APIPromise<Shared.ProviderInfo> {
|
|
28
|
+
return this._client.get(`/v1alpha/admin/providers/${providerId}`, options);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* List all available providers with their configuration and health status.
|
|
33
|
+
*/
|
|
34
|
+
listProviders(options?: Core.RequestOptions): Core.APIPromise<ProvidersAPI.ProviderListResponse> {
|
|
35
|
+
return (
|
|
36
|
+
this._client.get('/v1alpha/admin/providers', options) as Core.APIPromise<{
|
|
37
|
+
data: ProvidersAPI.ProviderListResponse;
|
|
38
|
+
}>
|
|
39
|
+
)._thenUnwrap((obj) => obj.data);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* List all available API routes with their methods and implementing providers.
|
|
44
|
+
*/
|
|
45
|
+
listRoutes(
|
|
46
|
+
query?: AdminListRoutesParams,
|
|
47
|
+
options?: Core.RequestOptions,
|
|
48
|
+
): Core.APIPromise<RoutesAPI.RouteListResponse>;
|
|
49
|
+
listRoutes(options?: Core.RequestOptions): Core.APIPromise<RoutesAPI.RouteListResponse>;
|
|
50
|
+
listRoutes(
|
|
51
|
+
query: AdminListRoutesParams | Core.RequestOptions = {},
|
|
52
|
+
options?: Core.RequestOptions,
|
|
53
|
+
): Core.APIPromise<RoutesAPI.RouteListResponse> {
|
|
54
|
+
if (isRequestOptions(query)) {
|
|
55
|
+
return this.listRoutes({}, query);
|
|
56
|
+
}
|
|
57
|
+
return (
|
|
58
|
+
this._client.get('/v1alpha/admin/inspect/routes', { query, ...options }) as Core.APIPromise<{
|
|
59
|
+
data: RoutesAPI.RouteListResponse;
|
|
60
|
+
}>
|
|
61
|
+
)._thenUnwrap((obj) => obj.data);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Get the version of the service.
|
|
66
|
+
*/
|
|
67
|
+
version(options?: Core.RequestOptions): Core.APIPromise<Shared.VersionInfo> {
|
|
68
|
+
return this._client.get('/v1alpha/admin/version', options);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
export interface AdminListRoutesParams {
|
|
73
|
+
/**
|
|
74
|
+
* Filter to control which routes are returned. Can be an API level ('v1',
|
|
75
|
+
* 'v1alpha', 'v1beta') to show non-deprecated routes at that level, or
|
|
76
|
+
* 'deprecated' to show deprecated routes across all levels. If not specified,
|
|
77
|
+
* returns all non-deprecated routes.
|
|
78
|
+
*/
|
|
79
|
+
api_filter?: 'v1' | 'v1alpha' | 'v1beta' | 'deprecated' | null;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export declare namespace Admin {
|
|
83
|
+
export { type AdminListRoutesParams as AdminListRoutesParams };
|
|
84
|
+
}
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
8
8
|
|
|
9
9
|
import { APIResource } from '../../resource';
|
|
10
|
+
import * as AdminAPI from './admin';
|
|
11
|
+
import { Admin, AdminListRoutesParams } from './admin';
|
|
10
12
|
import * as BenchmarksAPI from './benchmarks';
|
|
11
13
|
import {
|
|
12
14
|
Benchmark,
|
|
@@ -31,6 +33,7 @@ import {
|
|
|
31
33
|
import * as PostTrainingAPI from './post-training/post-training';
|
|
32
34
|
import {
|
|
33
35
|
AlgorithmConfig,
|
|
36
|
+
ListPostTrainingJobsResponse,
|
|
34
37
|
PostTraining,
|
|
35
38
|
PostTrainingJob,
|
|
36
39
|
PostTrainingPreferenceOptimizeParams,
|
|
@@ -38,27 +41,24 @@ import {
|
|
|
38
41
|
} from './post-training/post-training';
|
|
39
42
|
|
|
40
43
|
export class Alpha extends APIResource {
|
|
41
|
-
inference: InferenceAPI.Inference = new InferenceAPI.Inference(this._client);
|
|
42
44
|
postTraining: PostTrainingAPI.PostTraining = new PostTrainingAPI.PostTraining(this._client);
|
|
43
45
|
benchmarks: BenchmarksAPI.Benchmarks = new BenchmarksAPI.Benchmarks(this._client);
|
|
44
46
|
eval: EvalAPI.Eval = new EvalAPI.Eval(this._client);
|
|
47
|
+
admin: AdminAPI.Admin = new AdminAPI.Admin(this._client);
|
|
48
|
+
inference: InferenceAPI.Inference = new InferenceAPI.Inference(this._client);
|
|
45
49
|
}
|
|
46
50
|
|
|
47
|
-
Alpha.Inference = Inference;
|
|
48
51
|
Alpha.PostTraining = PostTraining;
|
|
49
52
|
Alpha.Benchmarks = Benchmarks;
|
|
50
53
|
Alpha.Eval = Eval;
|
|
54
|
+
Alpha.Admin = Admin;
|
|
55
|
+
Alpha.Inference = Inference;
|
|
51
56
|
|
|
52
57
|
export declare namespace Alpha {
|
|
53
|
-
export {
|
|
54
|
-
Inference as Inference,
|
|
55
|
-
type InferenceRerankResponse as InferenceRerankResponse,
|
|
56
|
-
type InferenceRerankParams as InferenceRerankParams,
|
|
57
|
-
};
|
|
58
|
-
|
|
59
58
|
export {
|
|
60
59
|
PostTraining as PostTraining,
|
|
61
60
|
type AlgorithmConfig as AlgorithmConfig,
|
|
61
|
+
type ListPostTrainingJobsResponse as ListPostTrainingJobsResponse,
|
|
62
62
|
type PostTrainingJob as PostTrainingJob,
|
|
63
63
|
type PostTrainingPreferenceOptimizeParams as PostTrainingPreferenceOptimizeParams,
|
|
64
64
|
type PostTrainingSupervisedFineTuneParams as PostTrainingSupervisedFineTuneParams,
|
|
@@ -82,4 +82,12 @@ export declare namespace Alpha {
|
|
|
82
82
|
type EvalRunEvalParams as EvalRunEvalParams,
|
|
83
83
|
type EvalRunEvalAlphaParams as EvalRunEvalAlphaParams,
|
|
84
84
|
};
|
|
85
|
+
|
|
86
|
+
export { Admin as Admin, type AdminListRoutesParams as AdminListRoutesParams };
|
|
87
|
+
|
|
88
|
+
export {
|
|
89
|
+
Inference as Inference,
|
|
90
|
+
type InferenceRerankResponse as InferenceRerankResponse,
|
|
91
|
+
type InferenceRerankParams as InferenceRerankParams,
|
|
92
|
+
};
|
|
85
93
|
}
|
|
@@ -59,6 +59,9 @@ export class Benchmarks extends APIResource {
|
|
|
59
59
|
* A benchmark resource for evaluating model performance.
|
|
60
60
|
*/
|
|
61
61
|
export interface Benchmark {
|
|
62
|
+
/**
|
|
63
|
+
* Identifier of the dataset to use for the benchmark evaluation.
|
|
64
|
+
*/
|
|
62
65
|
dataset_id: string;
|
|
63
66
|
|
|
64
67
|
/**
|
|
@@ -71,10 +74,13 @@ export interface Benchmark {
|
|
|
71
74
|
*/
|
|
72
75
|
provider_id: string;
|
|
73
76
|
|
|
77
|
+
/**
|
|
78
|
+
* List of scoring function identifiers to apply during evaluation.
|
|
79
|
+
*/
|
|
74
80
|
scoring_functions: Array<string>;
|
|
75
81
|
|
|
76
82
|
/**
|
|
77
|
-
* Metadata for this evaluation task
|
|
83
|
+
* Metadata for this evaluation task.
|
|
78
84
|
*/
|
|
79
85
|
metadata?: { [key: string]: unknown };
|
|
80
86
|
|
|
@@ -83,26 +89,56 @@ export interface Benchmark {
|
|
|
83
89
|
*/
|
|
84
90
|
provider_resource_id?: string | null;
|
|
85
91
|
|
|
92
|
+
/**
|
|
93
|
+
* The resource type, always benchmark.
|
|
94
|
+
*/
|
|
86
95
|
type?: 'benchmark';
|
|
87
96
|
}
|
|
88
97
|
|
|
98
|
+
/**
|
|
99
|
+
* Response containing a list of benchmark objects.
|
|
100
|
+
*/
|
|
89
101
|
export interface ListBenchmarksResponse {
|
|
102
|
+
/**
|
|
103
|
+
* List of benchmark objects.
|
|
104
|
+
*/
|
|
90
105
|
data: BenchmarkListResponse;
|
|
91
106
|
}
|
|
92
107
|
|
|
108
|
+
/**
|
|
109
|
+
* List of benchmark objects.
|
|
110
|
+
*/
|
|
93
111
|
export type BenchmarkListResponse = Array<Benchmark>;
|
|
94
112
|
|
|
95
113
|
export interface BenchmarkRegisterParams {
|
|
114
|
+
/**
|
|
115
|
+
* The ID of the benchmark to register.
|
|
116
|
+
*/
|
|
96
117
|
benchmark_id: string;
|
|
97
118
|
|
|
119
|
+
/**
|
|
120
|
+
* The ID of the dataset to use for the benchmark.
|
|
121
|
+
*/
|
|
98
122
|
dataset_id: string;
|
|
99
123
|
|
|
124
|
+
/**
|
|
125
|
+
* The scoring functions to use for the benchmark.
|
|
126
|
+
*/
|
|
100
127
|
scoring_functions: Array<string>;
|
|
101
128
|
|
|
129
|
+
/**
|
|
130
|
+
* The metadata to use for the benchmark.
|
|
131
|
+
*/
|
|
102
132
|
metadata?: { [key: string]: unknown } | null;
|
|
103
133
|
|
|
134
|
+
/**
|
|
135
|
+
* The ID of the provider benchmark to use for the benchmark.
|
|
136
|
+
*/
|
|
104
137
|
provider_benchmark_id?: string | null;
|
|
105
138
|
|
|
139
|
+
/**
|
|
140
|
+
* The ID of the provider to use for the benchmark.
|
|
141
|
+
*/
|
|
106
142
|
provider_id?: string | null;
|
|
107
143
|
}
|
|
108
144
|
|