@llamaindex/llama-cloud 2.9.0 → 2.10.0
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/CHANGELOG.md +14 -0
- package/client.d.mts +11 -8
- package/client.d.mts.map +1 -1
- package/client.d.ts +11 -8
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/batches.d.mts +4 -4
- package/resources/batches.d.mts.map +1 -1
- package/resources/batches.d.ts +4 -4
- package/resources/batches.d.ts.map +1 -1
- package/resources/beta/agent-data.d.mts +94 -94
- package/resources/beta/agent-data.d.mts.map +1 -1
- package/resources/beta/agent-data.d.ts +94 -94
- package/resources/beta/agent-data.d.ts.map +1 -1
- package/resources/beta/agent-data.js +41 -41
- package/resources/beta/agent-data.js.map +1 -1
- package/resources/beta/agent-data.mjs +41 -41
- package/resources/beta/agent-data.mjs.map +1 -1
- package/resources/beta/batch/batch.d.mts +36 -29
- package/resources/beta/batch/batch.d.mts.map +1 -1
- package/resources/beta/batch/batch.d.ts +36 -29
- package/resources/beta/batch/batch.d.ts.map +1 -1
- package/resources/beta/batch/batch.js +16 -16
- package/resources/beta/batch/batch.js.map +1 -1
- package/resources/beta/batch/batch.mjs +16 -16
- package/resources/beta/batch/batch.mjs.map +1 -1
- package/resources/beta/batch/index.d.mts +1 -1
- package/resources/beta/batch/index.d.mts.map +1 -1
- package/resources/beta/batch/index.d.ts +1 -1
- package/resources/beta/batch/index.d.ts.map +1 -1
- package/resources/beta/batch/job-items.d.mts +14 -7
- package/resources/beta/batch/job-items.d.mts.map +1 -1
- package/resources/beta/batch/job-items.d.ts +14 -7
- package/resources/beta/batch/job-items.d.ts.map +1 -1
- package/resources/beta/beta.d.mts +6 -6
- package/resources/beta/beta.d.mts.map +1 -1
- package/resources/beta/beta.d.ts +6 -6
- package/resources/beta/beta.d.ts.map +1 -1
- package/resources/beta/chat.d.mts +39 -39
- package/resources/beta/chat.d.mts.map +1 -1
- package/resources/beta/chat.d.ts +39 -39
- package/resources/beta/chat.d.ts.map +1 -1
- package/resources/beta/chat.js +14 -14
- package/resources/beta/chat.js.map +1 -1
- package/resources/beta/chat.mjs +14 -14
- package/resources/beta/chat.mjs.map +1 -1
- package/resources/beta/directories/directories.d.mts +48 -39
- package/resources/beta/directories/directories.d.mts.map +1 -1
- package/resources/beta/directories/directories.d.ts +48 -39
- package/resources/beta/directories/directories.d.ts.map +1 -1
- package/resources/beta/directories/directories.js +30 -30
- package/resources/beta/directories/directories.js.map +1 -1
- package/resources/beta/directories/directories.mjs +30 -30
- package/resources/beta/directories/directories.mjs.map +1 -1
- package/resources/beta/directories/files.d.mts +47 -47
- package/resources/beta/directories/files.d.mts.map +1 -1
- package/resources/beta/directories/files.d.ts +47 -47
- package/resources/beta/directories/files.d.ts.map +1 -1
- package/resources/beta/directories/files.js +32 -32
- package/resources/beta/directories/files.js.map +1 -1
- package/resources/beta/directories/files.mjs +32 -32
- package/resources/beta/directories/files.mjs.map +1 -1
- package/resources/beta/directories/index.d.mts +2 -2
- package/resources/beta/directories/index.d.mts.map +1 -1
- package/resources/beta/directories/index.d.ts +2 -2
- package/resources/beta/directories/index.d.ts.map +1 -1
- package/resources/beta/index.d.mts +6 -6
- package/resources/beta/index.d.mts.map +1 -1
- package/resources/beta/index.d.ts +6 -6
- package/resources/beta/index.d.ts.map +1 -1
- package/resources/beta/indexes.d.mts +44 -32
- package/resources/beta/indexes.d.mts.map +1 -1
- package/resources/beta/indexes.d.ts +44 -32
- package/resources/beta/indexes.d.ts.map +1 -1
- package/resources/beta/indexes.js +28 -28
- package/resources/beta/indexes.js.map +1 -1
- package/resources/beta/indexes.mjs +28 -28
- package/resources/beta/indexes.mjs.map +1 -1
- package/resources/beta/retrieval.d.mts +3 -3
- package/resources/beta/retrieval.d.mts.map +1 -1
- package/resources/beta/retrieval.d.ts +3 -3
- package/resources/beta/retrieval.d.ts.map +1 -1
- package/resources/beta/sheets.d.mts +37 -56
- package/resources/beta/sheets.d.mts.map +1 -1
- package/resources/beta/sheets.d.ts +37 -56
- package/resources/beta/sheets.d.ts.map +1 -1
- package/resources/beta/sheets.js +19 -52
- package/resources/beta/sheets.js.map +1 -1
- package/resources/beta/sheets.mjs +19 -52
- package/resources/beta/sheets.mjs.map +1 -1
- package/resources/beta/split.d.mts +2 -2
- package/resources/beta/split.d.mts.map +1 -1
- package/resources/beta/split.d.ts +2 -2
- package/resources/beta/split.d.ts.map +1 -1
- package/resources/classifier/jobs.d.mts +8 -1
- package/resources/classifier/jobs.d.mts.map +1 -1
- package/resources/classifier/jobs.d.ts +8 -1
- package/resources/classifier/jobs.d.ts.map +1 -1
- package/resources/classify.d.mts +27 -11
- package/resources/classify.d.mts.map +1 -1
- package/resources/classify.d.ts +27 -11
- package/resources/classify.d.ts.map +1 -1
- package/resources/configurations.d.mts +73 -43
- package/resources/configurations.d.mts.map +1 -1
- package/resources/configurations.d.ts +73 -43
- package/resources/configurations.d.ts.map +1 -1
- package/resources/configurations.js +9 -9
- package/resources/configurations.js.map +1 -1
- package/resources/configurations.mjs +9 -9
- package/resources/configurations.mjs.map +1 -1
- package/resources/data-sinks.d.mts +16 -16
- package/resources/data-sinks.d.mts.map +1 -1
- package/resources/data-sinks.d.ts +16 -16
- package/resources/data-sinks.d.ts.map +1 -1
- package/resources/data-sinks.js +12 -12
- package/resources/data-sinks.js.map +1 -1
- package/resources/data-sinks.mjs +12 -12
- package/resources/data-sinks.mjs.map +1 -1
- package/resources/data-sources.d.mts +17 -17
- package/resources/data-sources.d.mts.map +1 -1
- package/resources/data-sources.d.ts +17 -17
- package/resources/data-sources.d.ts.map +1 -1
- package/resources/data-sources.js +13 -13
- package/resources/data-sources.js.map +1 -1
- package/resources/data-sources.mjs +13 -13
- package/resources/data-sources.mjs.map +1 -1
- package/resources/extract.d.mts +62 -46
- package/resources/extract.d.mts.map +1 -1
- package/resources/extract.d.ts +62 -46
- package/resources/extract.d.ts.map +1 -1
- package/resources/extract.js +33 -33
- package/resources/extract.js.map +1 -1
- package/resources/extract.mjs +33 -33
- package/resources/extract.mjs.map +1 -1
- package/resources/files.d.mts +41 -41
- package/resources/files.d.mts.map +1 -1
- package/resources/files.d.ts +41 -41
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js +13 -13
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +13 -13
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.mts +9 -8
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +9 -8
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/parsing.d.mts +131 -51
- package/resources/parsing.d.mts.map +1 -1
- package/resources/parsing.d.ts +131 -51
- package/resources/parsing.d.ts.map +1 -1
- package/resources/parsing.js +33 -12
- package/resources/parsing.js.map +1 -1
- package/resources/parsing.mjs +33 -12
- package/resources/parsing.mjs.map +1 -1
- package/resources/pipelines/data-sources.d.mts +40 -30
- package/resources/pipelines/data-sources.d.mts.map +1 -1
- package/resources/pipelines/data-sources.d.ts +40 -30
- package/resources/pipelines/data-sources.d.ts.map +1 -1
- package/resources/pipelines/data-sources.js +23 -13
- package/resources/pipelines/data-sources.js.map +1 -1
- package/resources/pipelines/data-sources.mjs +23 -13
- package/resources/pipelines/data-sources.mjs.map +1 -1
- package/resources/pipelines/documents.d.mts +28 -12
- package/resources/pipelines/documents.d.mts.map +1 -1
- package/resources/pipelines/documents.d.ts +28 -12
- package/resources/pipelines/documents.d.ts.map +1 -1
- package/resources/pipelines/documents.js +30 -14
- package/resources/pipelines/documents.js.map +1 -1
- package/resources/pipelines/documents.mjs +30 -14
- package/resources/pipelines/documents.mjs.map +1 -1
- package/resources/pipelines/files.d.mts +34 -24
- package/resources/pipelines/files.d.mts.map +1 -1
- package/resources/pipelines/files.d.ts +34 -24
- package/resources/pipelines/files.d.ts.map +1 -1
- package/resources/pipelines/files.js +27 -17
- package/resources/pipelines/files.js.map +1 -1
- package/resources/pipelines/files.mjs +27 -17
- package/resources/pipelines/files.mjs.map +1 -1
- package/resources/pipelines/images.d.mts +17 -17
- package/resources/pipelines/images.d.mts.map +1 -1
- package/resources/pipelines/images.d.ts +17 -17
- package/resources/pipelines/images.d.ts.map +1 -1
- package/resources/pipelines/images.js +13 -13
- package/resources/pipelines/images.js.map +1 -1
- package/resources/pipelines/images.mjs +13 -13
- package/resources/pipelines/images.mjs.map +1 -1
- package/resources/pipelines/index.d.mts +5 -5
- package/resources/pipelines/index.d.mts.map +1 -1
- package/resources/pipelines/index.d.ts +5 -5
- package/resources/pipelines/index.d.ts.map +1 -1
- package/resources/pipelines/metadata.d.mts +4 -0
- package/resources/pipelines/metadata.d.mts.map +1 -1
- package/resources/pipelines/metadata.d.ts +4 -0
- package/resources/pipelines/metadata.d.ts.map +1 -1
- package/resources/pipelines/metadata.js +4 -0
- package/resources/pipelines/metadata.js.map +1 -1
- package/resources/pipelines/metadata.mjs +4 -0
- package/resources/pipelines/metadata.mjs.map +1 -1
- package/resources/pipelines/pipelines.d.mts +149 -126
- package/resources/pipelines/pipelines.d.mts.map +1 -1
- package/resources/pipelines/pipelines.d.ts +149 -126
- package/resources/pipelines/pipelines.d.ts.map +1 -1
- package/resources/pipelines/pipelines.js +39 -23
- package/resources/pipelines/pipelines.js.map +1 -1
- package/resources/pipelines/pipelines.mjs +39 -23
- package/resources/pipelines/pipelines.mjs.map +1 -1
- package/resources/pipelines/sync.d.mts +4 -0
- package/resources/pipelines/sync.d.mts.map +1 -1
- package/resources/pipelines/sync.d.ts +4 -0
- package/resources/pipelines/sync.d.ts.map +1 -1
- package/resources/pipelines/sync.js +4 -0
- package/resources/pipelines/sync.js.map +1 -1
- package/resources/pipelines/sync.mjs +4 -0
- package/resources/pipelines/sync.mjs.map +1 -1
- package/resources/retrievers/index.d.mts +1 -1
- package/resources/retrievers/index.d.mts.map +1 -1
- package/resources/retrievers/index.d.ts +1 -1
- package/resources/retrievers/index.d.ts.map +1 -1
- package/resources/retrievers/retrievers.d.mts +39 -39
- package/resources/retrievers/retrievers.d.mts.map +1 -1
- package/resources/retrievers/retrievers.d.ts +39 -39
- package/resources/retrievers/retrievers.d.ts.map +1 -1
- package/resources/retrievers/retrievers.js +20 -20
- package/resources/retrievers/retrievers.js.map +1 -1
- package/resources/retrievers/retrievers.mjs +20 -20
- package/resources/retrievers/retrievers.mjs.map +1 -1
- package/resources/shared.d.mts +11 -3
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +11 -3
- package/resources/shared.d.ts.map +1 -1
- package/resources/sheets.d.mts +206 -0
- package/resources/sheets.d.mts.map +1 -0
- package/resources/sheets.d.ts +206 -0
- package/resources/sheets.d.ts.map +1 -0
- package/resources/sheets.js +101 -0
- package/resources/sheets.js.map +1 -0
- package/resources/sheets.mjs +97 -0
- package/resources/sheets.mjs.map +1 -0
- package/src/client.ts +33 -12
- package/src/resources/batches.ts +4 -4
- package/src/resources/beta/agent-data.ts +131 -131
- package/src/resources/beta/batch/batch.ts +67 -54
- package/src/resources/beta/batch/index.ts +1 -1
- package/src/resources/beta/batch/job-items.ts +34 -21
- package/src/resources/beta/beta.ts +12 -12
- package/src/resources/beta/chat.ts +57 -57
- package/src/resources/beta/directories/directories.ts +80 -71
- package/src/resources/beta/directories/files.ts +66 -66
- package/src/resources/beta/directories/index.ts +5 -5
- package/src/resources/beta/index.ts +12 -12
- package/src/resources/beta/indexes.ts +68 -53
- package/src/resources/beta/retrieval.ts +3 -3
- package/src/resources/beta/sheets.ts +90 -97
- package/src/resources/beta/split.ts +2 -2
- package/src/resources/classifier/jobs.ts +9 -1
- package/src/resources/classify.ts +67 -39
- package/src/resources/configurations.ts +97 -63
- package/src/resources/data-sinks.ts +26 -26
- package/src/resources/data-sources.ts +43 -43
- package/src/resources/extract.ts +125 -97
- package/src/resources/files.ts +61 -61
- package/src/resources/index.ts +21 -12
- package/src/resources/parsing.ts +285 -204
- package/src/resources/pipelines/data-sources.ts +59 -49
- package/src/resources/pipelines/documents.ts +42 -26
- package/src/resources/pipelines/files.ts +62 -52
- package/src/resources/pipelines/images.ts +36 -36
- package/src/resources/pipelines/index.ts +10 -10
- package/src/resources/pipelines/metadata.ts +4 -0
- package/src/resources/pipelines/pipelines.ts +236 -207
- package/src/resources/pipelines/sync.ts +4 -0
- package/src/resources/retrievers/index.ts +3 -3
- package/src/resources/retrievers/retrievers.ts +64 -64
- package/src/resources/shared.ts +12 -3
- package/src/resources/sheets.ts +322 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -79,11 +79,25 @@ export class Pipelines extends APIResource {
|
|
|
79
79
|
metadata: MetadataAPI.Metadata = new MetadataAPI.Metadata(this._client);
|
|
80
80
|
documents: DocumentsAPI.Documents = new DocumentsAPI.Documents(this._client);
|
|
81
81
|
|
|
82
|
+
/**
|
|
83
|
+
* Search for pipelines by name, type, or project.
|
|
84
|
+
*
|
|
85
|
+
* @deprecated
|
|
86
|
+
*/
|
|
87
|
+
list(
|
|
88
|
+
query: PipelineListParams | null | undefined = {},
|
|
89
|
+
options?: RequestOptions,
|
|
90
|
+
): APIPromise<PipelineListResponse> {
|
|
91
|
+
return this._client.get('/api/v1/pipelines', { query, ...options });
|
|
92
|
+
}
|
|
93
|
+
|
|
82
94
|
/**
|
|
83
95
|
* Create a new managed ingestion pipeline.
|
|
84
96
|
*
|
|
85
97
|
* A pipeline connects data sources to a vector store for RAG. After creation, call
|
|
86
98
|
* `POST /pipelines/{id}/sync` to start ingesting documents.
|
|
99
|
+
*
|
|
100
|
+
* @deprecated
|
|
87
101
|
*/
|
|
88
102
|
create(params: PipelineCreateParams, options?: RequestOptions): APIPromise<Pipeline> {
|
|
89
103
|
const { organization_id, project_id, ...body } = params;
|
|
@@ -95,47 +109,30 @@ export class Pipelines extends APIResource {
|
|
|
95
109
|
}
|
|
96
110
|
|
|
97
111
|
/**
|
|
98
|
-
*
|
|
112
|
+
* Get a pipeline by ID.
|
|
99
113
|
*
|
|
100
|
-
*
|
|
101
|
-
* parameters. Supports dense, sparse, and hybrid search modes with configurable
|
|
102
|
-
* top-k and reranking.
|
|
114
|
+
* @deprecated
|
|
103
115
|
*/
|
|
104
|
-
|
|
105
|
-
pipelineID
|
|
106
|
-
params: PipelineRetrieveParams,
|
|
107
|
-
options?: RequestOptions,
|
|
108
|
-
): APIPromise<PipelineRetrieveResponse> {
|
|
109
|
-
const { organization_id, project_id, ...body } = params;
|
|
110
|
-
return this._client.post(path`/api/v1/pipelines/${pipelineID}/retrieve`, {
|
|
111
|
-
query: { organization_id, project_id },
|
|
112
|
-
body,
|
|
113
|
-
...options,
|
|
114
|
-
});
|
|
116
|
+
get(pipelineID: string, options?: RequestOptions): APIPromise<Pipeline> {
|
|
117
|
+
return this._client.get(path`/api/v1/pipelines/${pipelineID}`, options);
|
|
115
118
|
}
|
|
116
119
|
|
|
117
120
|
/**
|
|
118
121
|
* Update an existing pipeline's configuration.
|
|
122
|
+
*
|
|
123
|
+
* @deprecated
|
|
119
124
|
*/
|
|
120
125
|
update(pipelineID: string, body: PipelineUpdateParams, options?: RequestOptions): APIPromise<Pipeline> {
|
|
121
126
|
return this._client.put(path`/api/v1/pipelines/${pipelineID}`, { body, ...options });
|
|
122
127
|
}
|
|
123
128
|
|
|
124
|
-
/**
|
|
125
|
-
* Search for pipelines by name, type, or project.
|
|
126
|
-
*/
|
|
127
|
-
list(
|
|
128
|
-
query: PipelineListParams | null | undefined = {},
|
|
129
|
-
options?: RequestOptions,
|
|
130
|
-
): APIPromise<PipelineListResponse> {
|
|
131
|
-
return this._client.get('/api/v1/pipelines', { query, ...options });
|
|
132
|
-
}
|
|
133
|
-
|
|
134
129
|
/**
|
|
135
130
|
* Delete a pipeline and all associated resources.
|
|
136
131
|
*
|
|
137
132
|
* Removes pipeline files, data sources, and vector store data. This operation is
|
|
138
133
|
* irreversible.
|
|
134
|
+
*
|
|
135
|
+
* @deprecated
|
|
139
136
|
*/
|
|
140
137
|
delete(pipelineID: string, options?: RequestOptions): APIPromise<void> {
|
|
141
138
|
return this._client.delete(path`/api/v1/pipelines/${pipelineID}`, {
|
|
@@ -144,18 +141,13 @@ export class Pipelines extends APIResource {
|
|
|
144
141
|
});
|
|
145
142
|
}
|
|
146
143
|
|
|
147
|
-
/**
|
|
148
|
-
* Get a pipeline by ID.
|
|
149
|
-
*/
|
|
150
|
-
get(pipelineID: string, options?: RequestOptions): APIPromise<Pipeline> {
|
|
151
|
-
return this._client.get(path`/api/v1/pipelines/${pipelineID}`, options);
|
|
152
|
-
}
|
|
153
|
-
|
|
154
144
|
/**
|
|
155
145
|
* Get the ingestion status of a managed pipeline.
|
|
156
146
|
*
|
|
157
147
|
* Returns document counts, sync progress, and the last effective timestamp. Only
|
|
158
148
|
* available for managed pipelines.
|
|
149
|
+
*
|
|
150
|
+
* @deprecated
|
|
159
151
|
*/
|
|
160
152
|
getStatus(
|
|
161
153
|
pipelineID: string,
|
|
@@ -170,6 +162,8 @@ export class Pipelines extends APIResource {
|
|
|
170
162
|
*
|
|
171
163
|
* Updates the pipeline if one with the same name and project already exists,
|
|
172
164
|
* otherwise creates a new one.
|
|
165
|
+
*
|
|
166
|
+
* @deprecated
|
|
173
167
|
*/
|
|
174
168
|
upsert(params: PipelineUpsertParams, options?: RequestOptions): APIPromise<Pipeline> {
|
|
175
169
|
const { organization_id, project_id, ...body } = params;
|
|
@@ -179,6 +173,28 @@ export class Pipelines extends APIResource {
|
|
|
179
173
|
...options,
|
|
180
174
|
});
|
|
181
175
|
}
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* Run a retrieval query against a managed pipeline.
|
|
179
|
+
*
|
|
180
|
+
* Searches the pipeline's vector store using the provided query and retrieval
|
|
181
|
+
* parameters. Supports dense, sparse, and hybrid search modes with configurable
|
|
182
|
+
* top-k and reranking.
|
|
183
|
+
*
|
|
184
|
+
* @deprecated
|
|
185
|
+
*/
|
|
186
|
+
retrieve(
|
|
187
|
+
pipelineID: string,
|
|
188
|
+
params: PipelineRetrieveParams,
|
|
189
|
+
options?: RequestOptions,
|
|
190
|
+
): APIPromise<PipelineRetrieveResponse> {
|
|
191
|
+
const { organization_id, project_id, ...body } = params;
|
|
192
|
+
return this._client.post(path`/api/v1/pipelines/${pipelineID}/retrieve`, {
|
|
193
|
+
query: { organization_id, project_id },
|
|
194
|
+
body,
|
|
195
|
+
...options,
|
|
196
|
+
});
|
|
197
|
+
}
|
|
182
198
|
}
|
|
183
199
|
|
|
184
200
|
export interface AdvancedModeTransformConfig {
|
|
@@ -509,7 +525,7 @@ export interface DataSinkCreate {
|
|
|
509
525
|
*/
|
|
510
526
|
name: string;
|
|
511
527
|
|
|
512
|
-
sink_type: '
|
|
528
|
+
sink_type: 'ASTRA_DB' | 'AZUREAI_SEARCH' | 'MILVUS' | 'MONGODB_ATLAS' | 'PINECONE' | 'POSTGRES' | 'QDRANT';
|
|
513
529
|
}
|
|
514
530
|
|
|
515
531
|
export interface GeminiEmbedding {
|
|
@@ -615,7 +631,7 @@ export interface HuggingFaceInferenceAPIEmbedding {
|
|
|
615
631
|
/**
|
|
616
632
|
* Enum of possible pooling choices with pooling behaviors.
|
|
617
633
|
*/
|
|
618
|
-
pooling?: 'cls' | '
|
|
634
|
+
pooling?: 'cls' | 'last' | 'mean' | null;
|
|
619
635
|
|
|
620
636
|
/**
|
|
621
637
|
* Instruction to prepend during query embedding.
|
|
@@ -742,7 +758,7 @@ export interface LlamaParseParameters {
|
|
|
742
758
|
|
|
743
759
|
ignore_document_elements_for_layout_detection?: boolean | null;
|
|
744
760
|
|
|
745
|
-
images_to_save?: Array<'
|
|
761
|
+
images_to_save?: Array<'embedded' | 'layout' | 'screenshot'> | null;
|
|
746
762
|
|
|
747
763
|
inline_images_in_markdown?: boolean | null;
|
|
748
764
|
|
|
@@ -831,7 +847,7 @@ export interface LlamaParseParameters {
|
|
|
831
847
|
* The priority for the request. This field may be ignored or overwritten depending
|
|
832
848
|
* on the organization tier.
|
|
833
849
|
*/
|
|
834
|
-
priority?: '
|
|
850
|
+
priority?: 'critical' | 'high' | 'low' | 'medium' | null;
|
|
835
851
|
|
|
836
852
|
project_id?: string | null;
|
|
837
853
|
|
|
@@ -916,28 +932,33 @@ export namespace LlamaParseParameters {
|
|
|
916
932
|
* events are delivered.
|
|
917
933
|
*/
|
|
918
934
|
webhook_events?: Array<
|
|
919
|
-
| '
|
|
920
|
-
| '
|
|
935
|
+
| 'classify.cancelled'
|
|
936
|
+
| 'classify.error'
|
|
937
|
+
| 'classify.partial_success'
|
|
938
|
+
| 'classify.pending'
|
|
939
|
+
| 'classify.running'
|
|
940
|
+
| 'classify.success'
|
|
941
|
+
| 'extract.cancelled'
|
|
921
942
|
| 'extract.error'
|
|
922
943
|
| 'extract.partial_success'
|
|
923
|
-
| 'extract.
|
|
944
|
+
| 'extract.pending'
|
|
945
|
+
| 'extract.success'
|
|
946
|
+
| 'parse.cancelled'
|
|
947
|
+
| 'parse.error'
|
|
948
|
+
| 'parse.partial_success'
|
|
924
949
|
| 'parse.pending'
|
|
925
950
|
| 'parse.running'
|
|
926
951
|
| 'parse.success'
|
|
927
|
-
| '
|
|
928
|
-
| 'parse.partial_success'
|
|
929
|
-
| 'parse.cancelled'
|
|
930
|
-
| 'classify.pending'
|
|
931
|
-
| 'classify.running'
|
|
932
|
-
| 'classify.success'
|
|
933
|
-
| 'classify.error'
|
|
934
|
-
| 'classify.partial_success'
|
|
935
|
-
| 'classify.cancelled'
|
|
936
|
-
| 'sheets.pending'
|
|
937
|
-
| 'sheets.success'
|
|
952
|
+
| 'sheets.cancelled'
|
|
938
953
|
| 'sheets.error'
|
|
939
954
|
| 'sheets.partial_success'
|
|
940
|
-
| 'sheets.
|
|
955
|
+
| 'sheets.pending'
|
|
956
|
+
| 'sheets.success'
|
|
957
|
+
| 'split.cancelled'
|
|
958
|
+
| 'split.error'
|
|
959
|
+
| 'split.pending'
|
|
960
|
+
| 'split.processing'
|
|
961
|
+
| 'split.success'
|
|
941
962
|
| 'unmapped_event'
|
|
942
963
|
> | null;
|
|
943
964
|
|
|
@@ -951,6 +972,14 @@ export namespace LlamaParseParameters {
|
|
|
951
972
|
*/
|
|
952
973
|
webhook_output_format?: string | null;
|
|
953
974
|
|
|
975
|
+
/**
|
|
976
|
+
* Shared signing secret used to sign webhook deliveries. When set, each request
|
|
977
|
+
* includes an HMAC-SHA256 signature of the request body in the 'LC-Signature'
|
|
978
|
+
* header (value 'sha256=<hex>'). Recompute the HMAC over the raw request body with
|
|
979
|
+
* this secret to verify the delivery is authentic.
|
|
980
|
+
*/
|
|
981
|
+
webhook_signing_secret?: string | null;
|
|
982
|
+
|
|
954
983
|
/**
|
|
955
984
|
* URL to receive webhook POST notifications
|
|
956
985
|
*/
|
|
@@ -965,19 +994,19 @@ export interface LlmParameters {
|
|
|
965
994
|
* The name of the model to use for LLM completions.
|
|
966
995
|
*/
|
|
967
996
|
model_name?:
|
|
968
|
-
| 'GPT_4O'
|
|
969
|
-
| 'GPT_4O_MINI'
|
|
970
|
-
| 'GPT_4_1'
|
|
971
|
-
| 'GPT_4_1_NANO'
|
|
972
|
-
| 'GPT_4_1_MINI'
|
|
973
997
|
| 'AZURE_OPENAI_GPT_4O'
|
|
974
998
|
| 'AZURE_OPENAI_GPT_4O_MINI'
|
|
975
999
|
| 'AZURE_OPENAI_GPT_4_1'
|
|
976
1000
|
| 'AZURE_OPENAI_GPT_4_1_MINI'
|
|
977
1001
|
| 'AZURE_OPENAI_GPT_4_1_NANO'
|
|
978
|
-
| 'CLAUDE_4_5_SONNET'
|
|
979
1002
|
| 'BEDROCK_CLAUDE_3_5_SONNET_V1'
|
|
980
|
-
| 'BEDROCK_CLAUDE_3_5_SONNET_V2'
|
|
1003
|
+
| 'BEDROCK_CLAUDE_3_5_SONNET_V2'
|
|
1004
|
+
| 'CLAUDE_4_5_SONNET'
|
|
1005
|
+
| 'GPT_4O'
|
|
1006
|
+
| 'GPT_4O_MINI'
|
|
1007
|
+
| 'GPT_4_1'
|
|
1008
|
+
| 'GPT_4_1_MINI'
|
|
1009
|
+
| 'GPT_4_1_NANO';
|
|
981
1010
|
|
|
982
1011
|
/**
|
|
983
1012
|
* The system prompt to use for the completion.
|
|
@@ -1004,7 +1033,7 @@ export interface ManagedIngestionStatusResponse {
|
|
|
1004
1033
|
/**
|
|
1005
1034
|
* Status of the ingestion.
|
|
1006
1035
|
*/
|
|
1007
|
-
status: '
|
|
1036
|
+
status: 'CANCELLED' | 'ERROR' | 'IN_PROGRESS' | 'NOT_STARTED' | 'PARTIAL_SUCCESS' | 'SUCCESS';
|
|
1008
1037
|
|
|
1009
1038
|
/**
|
|
1010
1039
|
* Date of the deployment.
|
|
@@ -1043,13 +1072,13 @@ export namespace ManagedIngestionStatusResponse {
|
|
|
1043
1072
|
* Name of the job that failed.
|
|
1044
1073
|
*/
|
|
1045
1074
|
step:
|
|
1046
|
-
| 'MANAGED_INGESTION'
|
|
1047
1075
|
| 'DATA_SOURCE'
|
|
1048
1076
|
| 'FILE_UPDATER'
|
|
1049
|
-
| 'PARSE'
|
|
1050
|
-
| 'TRANSFORM'
|
|
1051
1077
|
| 'INGESTION'
|
|
1052
|
-
| '
|
|
1078
|
+
| 'MANAGED_INGESTION'
|
|
1079
|
+
| 'METADATA_UPDATE'
|
|
1080
|
+
| 'PARSE'
|
|
1081
|
+
| 'TRANSFORM';
|
|
1053
1082
|
}
|
|
1054
1083
|
}
|
|
1055
1084
|
|
|
@@ -1057,14 +1086,14 @@ export namespace ManagedIngestionStatusResponse {
|
|
|
1057
1086
|
* Message role.
|
|
1058
1087
|
*/
|
|
1059
1088
|
export type MessageRole =
|
|
1060
|
-
| 'system'
|
|
1061
|
-
| 'developer'
|
|
1062
|
-
| 'user'
|
|
1063
1089
|
| 'assistant'
|
|
1090
|
+
| 'chatbot'
|
|
1091
|
+
| 'developer'
|
|
1064
1092
|
| 'function'
|
|
1093
|
+
| 'model'
|
|
1094
|
+
| 'system'
|
|
1065
1095
|
| 'tool'
|
|
1066
|
-
| '
|
|
1067
|
-
| 'model';
|
|
1096
|
+
| 'user';
|
|
1068
1097
|
|
|
1069
1098
|
/**
|
|
1070
1099
|
* Metadata filters for vector stores.
|
|
@@ -1075,7 +1104,7 @@ export interface MetadataFilters {
|
|
|
1075
1104
|
/**
|
|
1076
1105
|
* Vector store filter conditions to combine different filters.
|
|
1077
1106
|
*/
|
|
1078
|
-
condition?: 'and' | '
|
|
1107
|
+
condition?: 'and' | 'not' | 'or' | null;
|
|
1079
1108
|
}
|
|
1080
1109
|
|
|
1081
1110
|
export namespace MetadataFilters {
|
|
@@ -1096,20 +1125,20 @@ export namespace MetadataFilters {
|
|
|
1096
1125
|
* Vector store filter operator.
|
|
1097
1126
|
*/
|
|
1098
1127
|
operator?:
|
|
1128
|
+
| '!='
|
|
1129
|
+
| '<'
|
|
1130
|
+
| '<='
|
|
1099
1131
|
| '=='
|
|
1100
1132
|
| '>'
|
|
1101
|
-
| '<'
|
|
1102
|
-
| '!='
|
|
1103
1133
|
| '>='
|
|
1104
|
-
| '
|
|
1134
|
+
| 'all'
|
|
1135
|
+
| 'any'
|
|
1136
|
+
| 'contains'
|
|
1105
1137
|
| 'in'
|
|
1138
|
+
| 'is_empty'
|
|
1106
1139
|
| 'nin'
|
|
1107
|
-
| 'any'
|
|
1108
|
-
| 'all'
|
|
1109
1140
|
| 'text_match'
|
|
1110
|
-
| 'text_match_insensitive'
|
|
1111
|
-
| 'contains'
|
|
1112
|
-
| 'is_empty';
|
|
1141
|
+
| 'text_match_insensitive';
|
|
1113
1142
|
}
|
|
1114
1143
|
}
|
|
1115
1144
|
|
|
@@ -1292,14 +1321,14 @@ export interface Pipeline {
|
|
|
1292
1321
|
id: string;
|
|
1293
1322
|
|
|
1294
1323
|
embedding_config:
|
|
1295
|
-
| Pipeline.ManagedOpenAIEmbeddingConfig
|
|
1296
1324
|
| AzureOpenAIEmbeddingConfig
|
|
1325
|
+
| BedrockEmbeddingConfig
|
|
1297
1326
|
| CohereEmbeddingConfig
|
|
1298
1327
|
| GeminiEmbeddingConfig
|
|
1299
1328
|
| HuggingFaceInferenceAPIEmbeddingConfig
|
|
1329
|
+
| Pipeline.ManagedOpenAIEmbeddingConfig
|
|
1300
1330
|
| OpenAIEmbeddingConfig
|
|
1301
|
-
| VertexAIEmbeddingConfig
|
|
1302
|
-
| BedrockEmbeddingConfig;
|
|
1331
|
+
| VertexAIEmbeddingConfig;
|
|
1303
1332
|
|
|
1304
1333
|
name: string;
|
|
1305
1334
|
|
|
@@ -1451,12 +1480,12 @@ export namespace Pipeline {
|
|
|
1451
1480
|
*/
|
|
1452
1481
|
embedding_config:
|
|
1453
1482
|
| PipelinesAPI.AzureOpenAIEmbeddingConfig
|
|
1483
|
+
| PipelinesAPI.BedrockEmbeddingConfig
|
|
1454
1484
|
| PipelinesAPI.CohereEmbeddingConfig
|
|
1455
1485
|
| PipelinesAPI.GeminiEmbeddingConfig
|
|
1456
1486
|
| PipelinesAPI.HuggingFaceInferenceAPIEmbeddingConfig
|
|
1457
1487
|
| PipelinesAPI.OpenAIEmbeddingConfig
|
|
1458
|
-
| PipelinesAPI.VertexAIEmbeddingConfig
|
|
1459
|
-
| PipelinesAPI.BedrockEmbeddingConfig;
|
|
1488
|
+
| PipelinesAPI.VertexAIEmbeddingConfig;
|
|
1460
1489
|
|
|
1461
1490
|
/**
|
|
1462
1491
|
* The name of the embedding model config.
|
|
@@ -1496,12 +1525,12 @@ export interface PipelineCreate {
|
|
|
1496
1525
|
|
|
1497
1526
|
embedding_config?:
|
|
1498
1527
|
| AzureOpenAIEmbeddingConfig
|
|
1528
|
+
| BedrockEmbeddingConfig
|
|
1499
1529
|
| CohereEmbeddingConfig
|
|
1500
1530
|
| GeminiEmbeddingConfig
|
|
1501
1531
|
| HuggingFaceInferenceAPIEmbeddingConfig
|
|
1502
1532
|
| OpenAIEmbeddingConfig
|
|
1503
1533
|
| VertexAIEmbeddingConfig
|
|
1504
|
-
| BedrockEmbeddingConfig
|
|
1505
1534
|
| null;
|
|
1506
1535
|
|
|
1507
1536
|
/**
|
|
@@ -1570,7 +1599,7 @@ export interface PipelineMetadataConfig {
|
|
|
1570
1599
|
/**
|
|
1571
1600
|
* Enum for representing the type of a pipeline
|
|
1572
1601
|
*/
|
|
1573
|
-
export type PipelineType = '
|
|
1602
|
+
export type PipelineType = 'MANAGED' | 'PLAYGROUND';
|
|
1574
1603
|
|
|
1575
1604
|
/**
|
|
1576
1605
|
* Schema for the search params for an retrieval execution that can be preset for a
|
|
@@ -1650,7 +1679,7 @@ export interface PresetRetrievalParams {
|
|
|
1650
1679
|
sparse_similarity_top_k?: number | null;
|
|
1651
1680
|
}
|
|
1652
1681
|
|
|
1653
|
-
export type RetrievalMode = '
|
|
1682
|
+
export type RetrievalMode = 'auto_routed' | 'chunks' | 'files_via_content' | 'files_via_metadata';
|
|
1654
1683
|
|
|
1655
1684
|
/**
|
|
1656
1685
|
* Configuration for sparse embedding models used in hybrid search.
|
|
@@ -1666,7 +1695,7 @@ export interface SparseModelConfig {
|
|
|
1666
1695
|
* for new pipelines), 'splade' uses HuggingFace Splade model, 'auto' selects based
|
|
1667
1696
|
* on deployment mode (BYOC uses term frequency, Cloud uses Splade).
|
|
1668
1697
|
*/
|
|
1669
|
-
model_type?: '
|
|
1698
|
+
model_type?: 'auto' | 'bm25' | 'splade';
|
|
1670
1699
|
}
|
|
1671
1700
|
|
|
1672
1701
|
export interface VertexAIEmbeddingConfig {
|
|
@@ -1727,7 +1756,7 @@ export interface VertexTextEmbedding {
|
|
|
1727
1756
|
/**
|
|
1728
1757
|
* The embedding mode to use.
|
|
1729
1758
|
*/
|
|
1730
|
-
embed_mode?: '
|
|
1759
|
+
embed_mode?: 'classification' | 'clustering' | 'default' | 'retrieval' | 'similarity';
|
|
1731
1760
|
|
|
1732
1761
|
/**
|
|
1733
1762
|
* The modelId of the VertexAI model to use.
|
|
@@ -1802,6 +1831,21 @@ export namespace PipelineRetrieveResponse {
|
|
|
1802
1831
|
|
|
1803
1832
|
export type PipelineListResponse = Array<Pipeline>;
|
|
1804
1833
|
|
|
1834
|
+
export interface PipelineListParams {
|
|
1835
|
+
organization_id?: string | null;
|
|
1836
|
+
|
|
1837
|
+
pipeline_name?: string | null;
|
|
1838
|
+
|
|
1839
|
+
/**
|
|
1840
|
+
* Enum for representing the type of a pipeline
|
|
1841
|
+
*/
|
|
1842
|
+
pipeline_type?: PipelineType | null;
|
|
1843
|
+
|
|
1844
|
+
project_id?: string | null;
|
|
1845
|
+
|
|
1846
|
+
project_name?: string | null;
|
|
1847
|
+
}
|
|
1848
|
+
|
|
1805
1849
|
export interface PipelineCreateParams {
|
|
1806
1850
|
/**
|
|
1807
1851
|
* Body param
|
|
@@ -1834,12 +1878,12 @@ export interface PipelineCreateParams {
|
|
|
1834
1878
|
*/
|
|
1835
1879
|
embedding_config?:
|
|
1836
1880
|
| AzureOpenAIEmbeddingConfig
|
|
1881
|
+
| BedrockEmbeddingConfig
|
|
1837
1882
|
| CohereEmbeddingConfig
|
|
1838
1883
|
| GeminiEmbeddingConfig
|
|
1839
1884
|
| HuggingFaceInferenceAPIEmbeddingConfig
|
|
1840
1885
|
| OpenAIEmbeddingConfig
|
|
1841
1886
|
| VertexAIEmbeddingConfig
|
|
1842
|
-
| BedrockEmbeddingConfig
|
|
1843
1887
|
| null;
|
|
1844
1888
|
|
|
1845
1889
|
/**
|
|
@@ -1893,98 +1937,6 @@ export interface PipelineCreateParams {
|
|
|
1893
1937
|
transform_config?: AutoTransformConfig | AdvancedModeTransformConfig | null;
|
|
1894
1938
|
}
|
|
1895
1939
|
|
|
1896
|
-
export interface PipelineRetrieveParams {
|
|
1897
|
-
/**
|
|
1898
|
-
* Body param: The query to retrieve against.
|
|
1899
|
-
*/
|
|
1900
|
-
query: string;
|
|
1901
|
-
|
|
1902
|
-
/**
|
|
1903
|
-
* Query param
|
|
1904
|
-
*/
|
|
1905
|
-
organization_id?: string | null;
|
|
1906
|
-
|
|
1907
|
-
/**
|
|
1908
|
-
* Query param
|
|
1909
|
-
*/
|
|
1910
|
-
project_id?: string | null;
|
|
1911
|
-
|
|
1912
|
-
/**
|
|
1913
|
-
* Body param: Alpha value for hybrid retrieval to determine the weights between
|
|
1914
|
-
* dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.
|
|
1915
|
-
*/
|
|
1916
|
-
alpha?: number | null;
|
|
1917
|
-
|
|
1918
|
-
/**
|
|
1919
|
-
* Body param
|
|
1920
|
-
*/
|
|
1921
|
-
class_name?: string;
|
|
1922
|
-
|
|
1923
|
-
/**
|
|
1924
|
-
* Body param: Minimum similarity score wrt query for retrieval
|
|
1925
|
-
*/
|
|
1926
|
-
dense_similarity_cutoff?: number | null;
|
|
1927
|
-
|
|
1928
|
-
/**
|
|
1929
|
-
* Body param: Number of nodes for dense retrieval.
|
|
1930
|
-
*/
|
|
1931
|
-
dense_similarity_top_k?: number | null;
|
|
1932
|
-
|
|
1933
|
-
/**
|
|
1934
|
-
* Body param: Enable reranking for retrieval
|
|
1935
|
-
*/
|
|
1936
|
-
enable_reranking?: boolean | null;
|
|
1937
|
-
|
|
1938
|
-
/**
|
|
1939
|
-
* Body param: Number of files to retrieve (only for retrieval mode
|
|
1940
|
-
* files_via_metadata and files_via_content).
|
|
1941
|
-
*/
|
|
1942
|
-
files_top_k?: number | null;
|
|
1943
|
-
|
|
1944
|
-
/**
|
|
1945
|
-
* Body param: Number of reranked nodes for returning.
|
|
1946
|
-
*/
|
|
1947
|
-
rerank_top_n?: number | null;
|
|
1948
|
-
|
|
1949
|
-
/**
|
|
1950
|
-
* Body param: The retrieval mode for the query.
|
|
1951
|
-
*/
|
|
1952
|
-
retrieval_mode?: RetrievalMode;
|
|
1953
|
-
|
|
1954
|
-
/**
|
|
1955
|
-
* @deprecated Body param: Whether to retrieve image nodes.
|
|
1956
|
-
*/
|
|
1957
|
-
retrieve_image_nodes?: boolean;
|
|
1958
|
-
|
|
1959
|
-
/**
|
|
1960
|
-
* Body param: Whether to retrieve page figure nodes.
|
|
1961
|
-
*/
|
|
1962
|
-
retrieve_page_figure_nodes?: boolean;
|
|
1963
|
-
|
|
1964
|
-
/**
|
|
1965
|
-
* Body param: Whether to retrieve page screenshot nodes.
|
|
1966
|
-
*/
|
|
1967
|
-
retrieve_page_screenshot_nodes?: boolean;
|
|
1968
|
-
|
|
1969
|
-
/**
|
|
1970
|
-
* Body param: Metadata filters for vector stores.
|
|
1971
|
-
*/
|
|
1972
|
-
search_filters?: MetadataFilters | null;
|
|
1973
|
-
|
|
1974
|
-
/**
|
|
1975
|
-
* Body param: JSON Schema that will be used to infer search_filters. Omit or leave
|
|
1976
|
-
* as null to skip inference.
|
|
1977
|
-
*/
|
|
1978
|
-
search_filters_inference_schema?: {
|
|
1979
|
-
[key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
|
|
1980
|
-
} | null;
|
|
1981
|
-
|
|
1982
|
-
/**
|
|
1983
|
-
* Body param: Number of nodes for sparse retrieval.
|
|
1984
|
-
*/
|
|
1985
|
-
sparse_similarity_top_k?: number | null;
|
|
1986
|
-
}
|
|
1987
|
-
|
|
1988
1940
|
export interface PipelineUpdateParams {
|
|
1989
1941
|
/**
|
|
1990
1942
|
* Schema for creating a data sink.
|
|
@@ -1999,12 +1951,12 @@ export interface PipelineUpdateParams {
|
|
|
1999
1951
|
|
|
2000
1952
|
embedding_config?:
|
|
2001
1953
|
| AzureOpenAIEmbeddingConfig
|
|
1954
|
+
| BedrockEmbeddingConfig
|
|
2002
1955
|
| CohereEmbeddingConfig
|
|
2003
1956
|
| GeminiEmbeddingConfig
|
|
2004
1957
|
| HuggingFaceInferenceAPIEmbeddingConfig
|
|
2005
1958
|
| OpenAIEmbeddingConfig
|
|
2006
1959
|
| VertexAIEmbeddingConfig
|
|
2007
|
-
| BedrockEmbeddingConfig
|
|
2008
1960
|
| null;
|
|
2009
1961
|
|
|
2010
1962
|
/**
|
|
@@ -2056,21 +2008,6 @@ export interface PipelineUpdateParams {
|
|
|
2056
2008
|
transform_config?: AutoTransformConfig | AdvancedModeTransformConfig | null;
|
|
2057
2009
|
}
|
|
2058
2010
|
|
|
2059
|
-
export interface PipelineListParams {
|
|
2060
|
-
organization_id?: string | null;
|
|
2061
|
-
|
|
2062
|
-
pipeline_name?: string | null;
|
|
2063
|
-
|
|
2064
|
-
/**
|
|
2065
|
-
* Enum for representing the type of a pipeline
|
|
2066
|
-
*/
|
|
2067
|
-
pipeline_type?: PipelineType | null;
|
|
2068
|
-
|
|
2069
|
-
project_id?: string | null;
|
|
2070
|
-
|
|
2071
|
-
project_name?: string | null;
|
|
2072
|
-
}
|
|
2073
|
-
|
|
2074
2011
|
export interface PipelineGetStatusParams {
|
|
2075
2012
|
full_details?: boolean | null;
|
|
2076
2013
|
}
|
|
@@ -2107,12 +2044,12 @@ export interface PipelineUpsertParams {
|
|
|
2107
2044
|
*/
|
|
2108
2045
|
embedding_config?:
|
|
2109
2046
|
| AzureOpenAIEmbeddingConfig
|
|
2047
|
+
| BedrockEmbeddingConfig
|
|
2110
2048
|
| CohereEmbeddingConfig
|
|
2111
2049
|
| GeminiEmbeddingConfig
|
|
2112
2050
|
| HuggingFaceInferenceAPIEmbeddingConfig
|
|
2113
2051
|
| OpenAIEmbeddingConfig
|
|
2114
2052
|
| VertexAIEmbeddingConfig
|
|
2115
|
-
| BedrockEmbeddingConfig
|
|
2116
2053
|
| null;
|
|
2117
2054
|
|
|
2118
2055
|
/**
|
|
@@ -2166,6 +2103,98 @@ export interface PipelineUpsertParams {
|
|
|
2166
2103
|
transform_config?: AutoTransformConfig | AdvancedModeTransformConfig | null;
|
|
2167
2104
|
}
|
|
2168
2105
|
|
|
2106
|
+
export interface PipelineRetrieveParams {
|
|
2107
|
+
/**
|
|
2108
|
+
* Body param: The query to retrieve against.
|
|
2109
|
+
*/
|
|
2110
|
+
query: string;
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* Query param
|
|
2114
|
+
*/
|
|
2115
|
+
organization_id?: string | null;
|
|
2116
|
+
|
|
2117
|
+
/**
|
|
2118
|
+
* Query param
|
|
2119
|
+
*/
|
|
2120
|
+
project_id?: string | null;
|
|
2121
|
+
|
|
2122
|
+
/**
|
|
2123
|
+
* Body param: Alpha value for hybrid retrieval to determine the weights between
|
|
2124
|
+
* dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval.
|
|
2125
|
+
*/
|
|
2126
|
+
alpha?: number | null;
|
|
2127
|
+
|
|
2128
|
+
/**
|
|
2129
|
+
* Body param
|
|
2130
|
+
*/
|
|
2131
|
+
class_name?: string;
|
|
2132
|
+
|
|
2133
|
+
/**
|
|
2134
|
+
* Body param: Minimum similarity score wrt query for retrieval
|
|
2135
|
+
*/
|
|
2136
|
+
dense_similarity_cutoff?: number | null;
|
|
2137
|
+
|
|
2138
|
+
/**
|
|
2139
|
+
* Body param: Number of nodes for dense retrieval.
|
|
2140
|
+
*/
|
|
2141
|
+
dense_similarity_top_k?: number | null;
|
|
2142
|
+
|
|
2143
|
+
/**
|
|
2144
|
+
* Body param: Enable reranking for retrieval
|
|
2145
|
+
*/
|
|
2146
|
+
enable_reranking?: boolean | null;
|
|
2147
|
+
|
|
2148
|
+
/**
|
|
2149
|
+
* Body param: Number of files to retrieve (only for retrieval mode
|
|
2150
|
+
* files_via_metadata and files_via_content).
|
|
2151
|
+
*/
|
|
2152
|
+
files_top_k?: number | null;
|
|
2153
|
+
|
|
2154
|
+
/**
|
|
2155
|
+
* Body param: Number of reranked nodes for returning.
|
|
2156
|
+
*/
|
|
2157
|
+
rerank_top_n?: number | null;
|
|
2158
|
+
|
|
2159
|
+
/**
|
|
2160
|
+
* Body param: The retrieval mode for the query.
|
|
2161
|
+
*/
|
|
2162
|
+
retrieval_mode?: RetrievalMode;
|
|
2163
|
+
|
|
2164
|
+
/**
|
|
2165
|
+
* @deprecated Body param: Whether to retrieve image nodes.
|
|
2166
|
+
*/
|
|
2167
|
+
retrieve_image_nodes?: boolean;
|
|
2168
|
+
|
|
2169
|
+
/**
|
|
2170
|
+
* Body param: Whether to retrieve page figure nodes.
|
|
2171
|
+
*/
|
|
2172
|
+
retrieve_page_figure_nodes?: boolean;
|
|
2173
|
+
|
|
2174
|
+
/**
|
|
2175
|
+
* Body param: Whether to retrieve page screenshot nodes.
|
|
2176
|
+
*/
|
|
2177
|
+
retrieve_page_screenshot_nodes?: boolean;
|
|
2178
|
+
|
|
2179
|
+
/**
|
|
2180
|
+
* Body param: Metadata filters for vector stores.
|
|
2181
|
+
*/
|
|
2182
|
+
search_filters?: MetadataFilters | null;
|
|
2183
|
+
|
|
2184
|
+
/**
|
|
2185
|
+
* Body param: JSON Schema that will be used to infer search_filters. Omit or leave
|
|
2186
|
+
* as null to skip inference.
|
|
2187
|
+
*/
|
|
2188
|
+
search_filters_inference_schema?: {
|
|
2189
|
+
[key: string]: { [key: string]: unknown } | Array<unknown> | string | number | boolean | null;
|
|
2190
|
+
} | null;
|
|
2191
|
+
|
|
2192
|
+
/**
|
|
2193
|
+
* Body param: Number of nodes for sparse retrieval.
|
|
2194
|
+
*/
|
|
2195
|
+
sparse_similarity_top_k?: number | null;
|
|
2196
|
+
}
|
|
2197
|
+
|
|
2169
2198
|
Pipelines.Sync = Sync;
|
|
2170
2199
|
Pipelines.DataSources = DataSources;
|
|
2171
2200
|
Pipelines.Images = Images;
|
|
@@ -2208,12 +2237,12 @@ export declare namespace Pipelines {
|
|
|
2208
2237
|
type VertexTextEmbedding as VertexTextEmbedding,
|
|
2209
2238
|
type PipelineRetrieveResponse as PipelineRetrieveResponse,
|
|
2210
2239
|
type PipelineListResponse as PipelineListResponse,
|
|
2240
|
+
type PipelineListParams as PipelineListParams,
|
|
2211
2241
|
type PipelineCreateParams as PipelineCreateParams,
|
|
2212
|
-
type PipelineRetrieveParams as PipelineRetrieveParams,
|
|
2213
2242
|
type PipelineUpdateParams as PipelineUpdateParams,
|
|
2214
|
-
type PipelineListParams as PipelineListParams,
|
|
2215
2243
|
type PipelineGetStatusParams as PipelineGetStatusParams,
|
|
2216
2244
|
type PipelineUpsertParams as PipelineUpsertParams,
|
|
2245
|
+
type PipelineRetrieveParams as PipelineRetrieveParams,
|
|
2217
2246
|
};
|
|
2218
2247
|
|
|
2219
2248
|
export { Sync as Sync };
|
|
@@ -2223,10 +2252,10 @@ export declare namespace Pipelines {
|
|
|
2223
2252
|
type PipelineDataSource as PipelineDataSource,
|
|
2224
2253
|
type DataSourceGetDataSourcesResponse as DataSourceGetDataSourcesResponse,
|
|
2225
2254
|
type DataSourceUpdateDataSourcesResponse as DataSourceUpdateDataSourcesResponse,
|
|
2255
|
+
type DataSourceUpdateDataSourcesParams as DataSourceUpdateDataSourcesParams,
|
|
2226
2256
|
type DataSourceUpdateParams as DataSourceUpdateParams,
|
|
2227
2257
|
type DataSourceGetStatusParams as DataSourceGetStatusParams,
|
|
2228
2258
|
type DataSourceSyncParams as DataSourceSyncParams,
|
|
2229
|
-
type DataSourceUpdateDataSourcesParams as DataSourceUpdateDataSourcesParams,
|
|
2230
2259
|
};
|
|
2231
2260
|
|
|
2232
2261
|
export {
|
|
@@ -2235,10 +2264,10 @@ export declare namespace Pipelines {
|
|
|
2235
2264
|
type ImageGetPageScreenshotResponse as ImageGetPageScreenshotResponse,
|
|
2236
2265
|
type ImageListPageFiguresResponse as ImageListPageFiguresResponse,
|
|
2237
2266
|
type ImageListPageScreenshotsResponse as ImageListPageScreenshotsResponse,
|
|
2238
|
-
type
|
|
2267
|
+
type ImageListPageScreenshotsParams as ImageListPageScreenshotsParams,
|
|
2239
2268
|
type ImageGetPageScreenshotParams as ImageGetPageScreenshotParams,
|
|
2269
|
+
type ImageGetPageFigureParams as ImageGetPageFigureParams,
|
|
2240
2270
|
type ImageListPageFiguresParams as ImageListPageFiguresParams,
|
|
2241
|
-
type ImageListPageScreenshotsParams as ImageListPageScreenshotsParams,
|
|
2242
2271
|
};
|
|
2243
2272
|
|
|
2244
2273
|
export {
|
|
@@ -2247,12 +2276,12 @@ export declare namespace Pipelines {
|
|
|
2247
2276
|
type FileCreateResponse as FileCreateResponse,
|
|
2248
2277
|
type FileGetStatusCountsResponse as FileGetStatusCountsResponse,
|
|
2249
2278
|
type PipelineFilesPaginatedPipelineFiles as PipelineFilesPaginatedPipelineFiles,
|
|
2279
|
+
type FileGetStatusCountsParams as FileGetStatusCountsParams,
|
|
2280
|
+
type FileGetStatusParams as FileGetStatusParams,
|
|
2250
2281
|
type FileCreateParams as FileCreateParams,
|
|
2251
2282
|
type FileUpdateParams as FileUpdateParams,
|
|
2252
|
-
type FileListParams as FileListParams,
|
|
2253
2283
|
type FileDeleteParams as FileDeleteParams,
|
|
2254
|
-
type
|
|
2255
|
-
type FileGetStatusCountsParams as FileGetStatusCountsParams,
|
|
2284
|
+
type FileListParams as FileListParams,
|
|
2256
2285
|
};
|
|
2257
2286
|
|
|
2258
2287
|
export {
|
|
@@ -2273,11 +2302,11 @@ export declare namespace Pipelines {
|
|
|
2273
2302
|
type CloudDocumentsPaginatedCloudDocuments as CloudDocumentsPaginatedCloudDocuments,
|
|
2274
2303
|
type DocumentCreateParams as DocumentCreateParams,
|
|
2275
2304
|
type DocumentListParams as DocumentListParams,
|
|
2276
|
-
type DocumentDeleteParams as DocumentDeleteParams,
|
|
2277
2305
|
type DocumentGetParams as DocumentGetParams,
|
|
2278
|
-
type
|
|
2306
|
+
type DocumentDeleteParams as DocumentDeleteParams,
|
|
2279
2307
|
type DocumentGetStatusParams as DocumentGetStatusParams,
|
|
2280
2308
|
type DocumentSyncParams as DocumentSyncParams,
|
|
2309
|
+
type DocumentGetChunksParams as DocumentGetChunksParams,
|
|
2281
2310
|
type DocumentUpsertParams as DocumentUpsertParams,
|
|
2282
2311
|
};
|
|
2283
2312
|
}
|