diff --git a/.changeset/eleven-plums-prove.md b/.changeset/eleven-plums-prove.md
new file mode 100644
index 0000000000000000000000000000000000000000..6963e134fea89bb3618cdcb2289127e4db9a1d6b
--- /dev/null
+++ b/.changeset/eleven-plums-prove.md
@@ -0,0 +1,5 @@
+---
+"@llamaindex/cloud": patch
+---
+
+chore: bump llamacloud openapi
diff --git a/packages/cloud/openapi.json b/packages/cloud/openapi.json
index 6ba89f840441b04216adea5611e7717dd8152616..9dd030c85eac52306368a2f9ac823784a3046d0d 100644
--- a/packages/cloud/openapi.json
+++ b/packages/cloud/openapi.json
@@ -412,6 +412,23 @@
}
],
"parameters": [
+ {
+ "name": "existing_data_source_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Existing Data Source Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -5113,6 +5130,22 @@
}
],
"parameters": [
+ {
+ "name": "expires_at_seconds",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Expires At Seconds"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -5211,6 +5244,22 @@
}
],
"parameters": [
+ {
+ "name": "external_file_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "External File Id"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -5515,6 +5564,22 @@
"title": "Id"
}
},
+ {
+ "name": "expires_at_seconds",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Expires At Seconds"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -5801,12 +5866,11 @@
}
}
},
- "/api/v1/pipelines": {
+ "/api/v1/files/{id}/page-figures": {
"get": {
- "tags": ["Pipelines"],
- "summary": "Search Pipelines",
- "description": "Search for pipelines by various parameters.",
- "operationId": "search_pipelines_api_v1_pipelines_get",
+ "tags": ["Files"],
+ "summary": "List File Pages Figures",
+ "operationId": "list_file_pages_figures_api_v1_files__id__page_figures_get",
"security": [
{
"HTTPBearer": []
@@ -5817,68 +5881,30 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "project_name",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Name"
- }
- },
- {
- "name": "pipeline_name",
- "in": "query",
- "required": false,
+ "name": "id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Pipeline Name"
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
}
},
{
- "name": "pipeline_type",
+ "name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "$ref": "#/components/schemas/PipelineType"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Pipeline Type"
+ "title": "Project Id"
}
},
{
@@ -5923,9 +5949,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Pipeline"
+ "$ref": "#/components/schemas/PageFigureMetadata"
},
- "title": "Response Search Pipelines Api V1 Pipelines Get"
+ "title": "Response List File Pages Figures Api V1 Files Id Page Figures Get"
}
}
}
@@ -5941,12 +5967,13 @@
}
}
}
- },
- "post": {
- "tags": ["Pipelines"],
- "summary": "Create Pipeline",
- "description": "Create a new pipeline for a project.",
- "operationId": "create_pipeline_api_v1_pipelines_post",
+ }
+ },
+ "/api/v1/files/{id}/page-figures/{page_index}": {
+ "get": {
+ "tags": ["Files"],
+ "summary": "List File Page Figures",
+ "operationId": "list_file_page_figures_api_v1_files__id__page_figures__page_index__get",
"security": [
{
"HTTPBearer": []
@@ -5956,6 +5983,25 @@
}
],
"parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ }
+ },
+ {
+ "name": "page_index",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "title": "Page Index"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -6007,23 +6053,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PageFigureMetadata"
+ },
+ "title": "Response List File Page Figures Api V1 Files Id Page Figures Page Index Get"
}
}
}
@@ -6039,12 +6079,13 @@
}
}
}
- },
- "put": {
- "tags": ["Pipelines"],
- "summary": "Upsert Pipeline",
- "description": "Upsert a pipeline for a project.\nUpdates if a pipeline with the same name and project_id already exists. Otherwise, creates a new pipeline.",
- "operationId": "upsert_pipeline_api_v1_pipelines_put",
+ }
+ },
+ "/api/v1/files/{id}/page-figures/{page_index}/{figure_name}": {
+ "get": {
+ "tags": ["Files"],
+ "summary": "Get File Page Figure",
+ "operationId": "get_file_page_figure_api_v1_files__id__page_figures__page_index___figure_name__get",
"security": [
{
"HTTPBearer": []
@@ -6054,6 +6095,34 @@
}
],
"parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ }
+ },
+ {
+ "name": "page_index",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "title": "Page Index"
+ }
+ },
+ {
+ "name": "figure_name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Figure Name"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -6105,24 +6174,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Pipeline"
- }
+ "schema": {}
}
}
},
@@ -6139,12 +6196,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}": {
+ "/api/v1/pipelines": {
"get": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline",
- "description": "Get a pipeline by ID for a given project.",
- "operationId": "get_pipeline_api_v1_pipelines__pipeline_id__get",
+ "summary": "Search Pipelines",
+ "description": "Search for pipelines by various parameters.",
+ "operationId": "search_pipelines_api_v1_pipelines_get",
"security": [
{
"HTTPBearer": []
@@ -6155,18 +6212,25 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "session",
- "in": "cookie",
+ "name": "project_name",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
@@ -6177,17 +6241,86 @@
"type": "null"
}
],
- "title": "Session"
+ "title": "Project Name"
}
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
+ },
+ {
+ "name": "pipeline_name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pipeline Name"
+ }
+ },
+ {
+ "name": "pipeline_type",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/PipelineType"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pipeline Type"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Pipeline"
+ },
+ "title": "Response Search Pipelines Api V1 Pipelines Get"
}
}
}
@@ -6204,11 +6337,11 @@
}
}
},
- "put": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Update Existing Pipeline",
- "description": "Update an existing pipeline for a project.",
- "operationId": "update_existing_pipeline_api_v1_pipelines__pipeline_id__put",
+ "summary": "Create Pipeline",
+ "description": "Create a new pipeline for a project.",
+ "operationId": "create_pipeline_api_v1_pipelines_post",
"security": [
{
"HTTPBearer": []
@@ -6219,13 +6352,37 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -6250,7 +6407,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineUpdate"
+ "$ref": "#/components/schemas/PipelineCreate"
}
}
}
@@ -6278,11 +6435,11 @@
}
}
},
- "delete": {
+ "put": {
"tags": ["Pipelines"],
- "summary": "Delete Pipeline",
- "description": "Delete a pipeline by ID.",
- "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete",
+ "summary": "Upsert Pipeline",
+ "description": "Upsert a pipeline for a project.\nUpdates if a pipeline with the same name and project_id already exists. Otherwise, creates a new pipeline.",
+ "operationId": "upsert_pipeline_api_v1_pipelines_put",
"security": [
{
"HTTPBearer": []
@@ -6293,13 +6450,37 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -6319,9 +6500,26 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineCreate"
+ }
+ }
+ }
+ },
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Pipeline"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -6336,12 +6534,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/status": {
+ "/api/v1/pipelines/{pipeline_id}": {
"get": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline Status",
- "description": "Get the status of a pipeline by ID.",
- "operationId": "get_pipeline_status_api_v1_pipelines__pipeline_id__status_get",
+ "summary": "Get Pipeline",
+ "description": "Get a pipeline by ID for a given project.",
+ "operationId": "get_pipeline_api_v1_pipelines__pipeline_id__get",
"security": [
{
"HTTPBearer": []
@@ -6384,7 +6582,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -6400,14 +6598,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/sync": {
- "post": {
+ },
+ "put": {
"tags": ["Pipelines"],
- "summary": "Sync Pipeline",
- "description": "Run ingestion for the pipeline by incrementally updating the data-sink with upstream changes from data-sources & files.",
- "operationId": "sync_pipeline_api_v1_pipelines__pipeline_id__sync_post",
+ "summary": "Update Existing Pipeline",
+ "description": "Update an existing pipeline for a project.",
+ "operationId": "update_existing_pipeline_api_v1_pipelines__pipeline_id__put",
"security": [
{
"HTTPBearer": []
@@ -6444,6 +6640,16 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
@@ -6466,14 +6672,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/copy": {
- "post": {
+ },
+ "delete": {
"tags": ["Pipelines"],
- "summary": "Copy Pipeline",
- "description": "Copy a pipeline by ID.",
- "operationId": "copy_pipeline_api_v1_pipelines__pipeline_id__copy_post",
+ "summary": "Delete Pipeline",
+ "description": "Delete a pipeline by ID.",
+ "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete",
"security": [
{
"HTTPBearer": []
@@ -6511,15 +6715,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Pipeline"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -6534,12 +6731,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute": {
- "post": {
+ "/api/v1/pipelines/{pipeline_id}/status": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Execute Eval Dataset",
- "description": "Execute a dataset.",
- "operationId": "execute_eval_dataset_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_post",
+ "summary": "Get Pipeline Status",
+ "description": "Get the status of a pipeline by ID.",
+ "operationId": "get_pipeline_status_api_v1_pipelines__pipeline_id__status_get",
"security": [
{
"HTTPBearer": []
@@ -6550,15 +6747,71 @@
],
"parameters": [
{
- "name": "eval_dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Eval Dataset Id"
+ "title": "Pipeline Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
}
+ }
+ }
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/sync": {
+ "post": {
+ "tags": ["Pipelines"],
+ "summary": "Sync Pipeline",
+ "description": "Run ingestion for the pipeline by incrementally updating the data-sink with upstream changes from data-sources & files.",
+ "operationId": "sync_pipeline_api_v1_pipelines__pipeline_id__sync_post",
+ "security": [
+ {
+ "HTTPBearer": []
},
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
{
"name": "pipeline_id",
"in": "path",
@@ -6586,23 +6839,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalExecutionCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDatasetJobRecord"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -6618,12 +6861,13 @@
}
}
}
- },
- "get": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/sync/cancel": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Get Eval Dataset Executions",
- "description": "Get the status of an EvalDatasetExecution.",
- "operationId": "get_eval_dataset_executions_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_get",
+ "summary": "Cancel Pipeline Sync",
+ "operationId": "cancel_pipeline_sync_api_v1_pipelines__pipeline_id__sync_cancel_post",
"security": [
{
"HTTPBearer": []
@@ -6633,16 +6877,6 @@
}
],
"parameters": [
- {
- "name": "eval_dataset_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
- }
- },
{
"name": "pipeline_id",
"in": "path",
@@ -6676,11 +6910,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalDatasetJobRecord"
- },
- "title": "Response Get Eval Dataset Executions Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Get"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -6698,12 +6928,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/result": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/copy": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Get Eval Dataset Execution Result",
- "description": "Get the result of an EvalDatasetExecution.\nIf eval_question_ids is specified, only the results for the specified\nquestions will be returned.\nIf any of the specified questions do not have a result, they will be ignored.",
- "operationId": "get_eval_dataset_execution_result_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_result_get",
+ "summary": "Copy Pipeline",
+ "description": "Copy a pipeline by ID.",
+ "operationId": "copy_pipeline_api_v1_pipelines__pipeline_id__copy_post",
"security": [
{
"HTTPBearer": []
@@ -6713,16 +6943,6 @@
}
],
"parameters": [
- {
- "name": "eval_dataset_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
- }
- },
{
"name": "pipeline_id",
"in": "path",
@@ -6756,11 +6976,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalQuestionResult"
- },
- "title": "Response Get Eval Dataset Execution Result Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Result Get"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -6778,12 +6994,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/{eval_dataset_execution_id}": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Get Eval Dataset Execution",
- "description": "Get the status of an EvalDatasetExecution.",
- "operationId": "get_eval_dataset_execution_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute__eval_dataset_execution_id__get",
+ "summary": "Execute Eval Dataset",
+ "description": "Execute a dataset.",
+ "operationId": "execute_eval_dataset_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_post",
"security": [
{
"HTTPBearer": []
@@ -6803,16 +7019,6 @@
"title": "Eval Dataset Id"
}
},
- {
- "name": "eval_dataset_execution_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Execution Id"
- }
- },
{
"name": "pipeline_id",
"in": "path",
@@ -6840,6 +7046,16 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalExecutionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
@@ -6862,15 +7078,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/files": {
+ },
"get": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Files",
- "description": "Get files for a pipeline.",
- "operationId": "list_pipeline_files_api_v1_pipelines__pipeline_id__files_get",
- "deprecated": true,
+ "summary": "Get Eval Dataset Executions",
+ "description": "Get the status of an EvalDatasetExecution.",
+ "operationId": "get_eval_dataset_executions_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_get",
"security": [
{
"HTTPBearer": []
@@ -6881,40 +7094,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "eval_dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
- }
- },
- {
- "name": "data_source_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data Source Id"
+ "title": "Eval Dataset Id"
}
},
{
- "name": "only_manually_uploaded",
- "in": "query",
- "required": false,
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Only Manually Uploaded"
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -6942,9 +7138,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PipelineFile"
+ "$ref": "#/components/schemas/EvalDatasetJobRecord"
},
- "title": "Response List Pipeline Files Api V1 Pipelines Pipeline Id Files Get"
+ "title": "Response Get Eval Dataset Executions Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Get"
}
}
}
@@ -6960,12 +7156,14 @@
}
}
}
- },
- "put": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/result": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Add Files To Pipeline",
- "description": "Add files to a pipeline.",
- "operationId": "add_files_to_pipeline_api_v1_pipelines__pipeline_id__files_put",
+ "summary": "Get Eval Dataset Execution Result",
+ "description": "Get the result of an EvalDatasetExecution.\nIf eval_question_ids is specified, only the results for the specified\nquestions will be returned.\nIf any of the specified questions do not have a result, they will be ignored.",
+ "operationId": "get_eval_dataset_execution_result_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute_result_get",
"security": [
{
"HTTPBearer": []
@@ -6975,6 +7173,16 @@
}
],
"parameters": [
+ {
+ "name": "eval_dataset_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Eval Dataset Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -7002,20 +7210,6 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineFileCreate"
- },
- "title": "Pipeline File Creates"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
@@ -7024,9 +7218,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PipelineFile"
+ "$ref": "#/components/schemas/EvalQuestionResult"
},
- "title": "Response Add Files To Pipeline Api V1 Pipelines Pipeline Id Files Put"
+ "title": "Response Get Eval Dataset Execution Result Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Result Get"
}
}
}
@@ -7044,12 +7238,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/files2": {
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/{eval_dataset_execution_id}": {
"get": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Files2",
- "description": "Get files for a pipeline.",
- "operationId": "list_pipeline_files2_api_v1_pipelines__pipeline_id__files2_get",
+ "summary": "Get Eval Dataset Execution",
+ "description": "Get the status of an EvalDatasetExecution.",
+ "operationId": "get_eval_dataset_execution_api_v1_pipelines__pipeline_id__eval_datasets__eval_dataset_id__execute__eval_dataset_execution_id__get",
"security": [
{
"HTTPBearer": []
@@ -7060,72 +7254,33 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "eval_dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Eval Dataset Id"
}
},
{
- "name": "data_source_id",
- "in": "query",
- "required": false,
+ "name": "eval_dataset_execution_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data Source Id"
- }
- },
- {
- "name": "only_manually_uploaded",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Only Manually Uploaded"
- }
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Limit"
+ "type": "string",
+ "format": "uuid",
+ "title": "Eval Dataset Execution Id"
}
},
{
- "name": "offset",
- "in": "query",
- "required": false,
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Offset"
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7151,7 +7306,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PaginatedListPipelineFilesResponse"
+ "$ref": "#/components/schemas/EvalDatasetJobRecord"
}
}
}
@@ -7169,12 +7324,13 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/files/{file_id}/status": {
+ "/api/v1/pipelines/{pipeline_id}/files": {
"get": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline File Status",
- "description": "Get status of a file for a pipeline.",
- "operationId": "get_pipeline_file_status_api_v1_pipelines__pipeline_id__files__file_id__status_get",
+ "summary": "List Pipeline Files",
+ "description": "Get files for a pipeline.",
+ "operationId": "list_pipeline_files_api_v1_pipelines__pipeline_id__files_get",
+ "deprecated": true,
"security": [
{
"HTTPBearer": []
@@ -7185,23 +7341,40 @@
],
"parameters": [
{
- "name": "file_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "File Id"
+ "title": "Pipeline Id"
}
},
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "data_source_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data Source Id"
+ }
+ },
+ {
+ "name": "only_manually_uploaded",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Only Manually Uploaded"
}
},
{
@@ -7227,7 +7400,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineFile"
+ },
+ "title": "Response List Pipeline Files Api V1 Pipelines Pipeline Id Files Get"
}
}
}
@@ -7243,14 +7420,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/files/{file_id}": {
+ },
"put": {
"tags": ["Pipelines"],
- "summary": "Update Pipeline File",
- "description": "Update a file for a pipeline.",
- "operationId": "update_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__put",
+ "summary": "Add Files To Pipeline",
+ "description": "Add files to a pipeline.",
+ "operationId": "add_files_to_pipeline_api_v1_pipelines__pipeline_id__files_put",
"security": [
{
"HTTPBearer": []
@@ -7260,16 +7435,6 @@
}
],
"parameters": [
- {
- "name": "file_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "File Id"
- }
- },
{
"name": "pipeline_id",
"in": "path",
@@ -7302,7 +7467,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineFileUpdate"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineFileCreate"
+ },
+ "title": "Pipeline File Creates"
}
}
}
@@ -7313,7 +7482,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineFile"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineFile"
+ },
+ "title": "Response Add Files To Pipeline Api V1 Pipelines Pipeline Id Files Put"
}
}
}
@@ -7329,12 +7502,14 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/files2": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Delete Pipeline File",
- "description": "Delete a file from a pipeline.",
- "operationId": "delete_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__delete",
+ "summary": "List Pipeline Files2",
+ "description": "Get files for a pipeline.",
+ "operationId": "list_pipeline_files2_api_v1_pipelines__pipeline_id__files2_get",
"security": [
{
"HTTPBearer": []
@@ -7345,23 +7520,72 @@
],
"parameters": [
{
- "name": "file_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "File Id"
+ "title": "Pipeline Id"
}
},
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "data_source_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data Source Id"
+ }
+ },
+ {
+ "name": "only_manually_uploaded",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Only Manually Uploaded"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Limit"
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Offset"
}
},
{
@@ -7382,8 +7606,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PaginatedListPipelineFilesResponse"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -7398,12 +7629,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/metadata": {
- "put": {
+ "/api/v1/pipelines/{pipeline_id}/files/{file_id}/status": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Import Pipeline Metadata",
- "description": "Import metadata for a pipeline.",
- "operationId": "import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put",
+ "summary": "Get Pipeline File Status",
+ "description": "Get status of a file for a pipeline.",
+ "operationId": "get_pipeline_file_status_api_v1_pipelines__pipeline_id__files__file_id__status_get",
"security": [
{
"HTTPBearer": []
@@ -7413,6 +7644,16 @@
}
],
"parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -7440,15 +7681,234 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put"
- }
- }
- }
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/files/{file_id}": {
+ "put": {
+ "tags": ["Pipelines"],
+ "summary": "Update Pipeline File",
+ "description": "Update a file for a pipeline.",
+ "operationId": "update_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__put",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineFileUpdate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineFile"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": ["Pipelines"],
+ "summary": "Delete Pipeline File",
+ "description": "Delete a file from a pipeline.",
+ "operationId": "delete_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__delete",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/metadata": {
+ "put": {
+ "tags": ["Pipelines"],
+ "summary": "Import Pipeline Metadata",
+ "description": "Import metadata for a pipeline.",
+ "operationId": "import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put"
+ }
+ }
+ }
},
"responses": {
"200": {
@@ -8939,12 +9399,12 @@
}
}
},
- "/api/v1/jobs/": {
- "get": {
- "tags": ["Jobs"],
- "summary": "Get Jobs",
- "description": "Get jobs for a project.",
- "operationId": "get_jobs_api_v1_jobs__get",
+ "/api/v1/retrievers": {
+ "post": {
+ "tags": ["Retrievers"],
+ "summary": "Create Retriever",
+ "description": "Create a new Retriever.",
+ "operationId": "create_retriever_api_v1_retrievers_post",
"security": [
{
"HTTPBearer": []
@@ -8955,51 +9415,215 @@
],
"parameters": [
{
- "name": "job_name",
+ "name": "project_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Job Name"
- }
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 100,
- "default": 50,
- "title": "Limit"
+ "title": "Project Id"
}
},
{
- "name": "offset",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
- "type": "integer",
- "minimum": 0,
- "default": 0,
- "title": "Offset"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
- "name": "include_usage_metrics",
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RetrieverCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Retriever"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": ["Retrievers"],
+ "summary": "Upsert Retriever",
+ "description": "Upsert a new Retriever.",
+ "operationId": "upsert_retriever_api_v1_retrievers_put",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "project_id",
"in": "query",
"required": false,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Include Usage Metrics"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RetrieverCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Retriever"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "get": {
+ "tags": ["Retrievers"],
+ "summary": "List Retrievers",
+ "description": "List Retrievers for a project.",
+ "operationId": "list_retrievers_api_v1_retrievers_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
}
},
{
@@ -9059,7 +9683,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PaginatedJobsHistoryWithMetrics"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Retriever"
+ },
+ "title": "Response List Retrievers Api V1 Retrievers Get"
}
}
}
@@ -9077,12 +9705,12 @@
}
}
},
- "/api/v1/evals/datasets/{dataset_id}": {
+ "/api/v1/retrievers/{retriever_id}": {
"get": {
- "tags": ["Evals"],
- "summary": "Get Dataset",
- "description": "Get a dataset by ID.",
- "operationId": "get_dataset_api_v1_evals_datasets__dataset_id__get",
+ "tags": ["Retrievers"],
+ "summary": "Get Retriever",
+ "description": "Get a Retriever by ID.",
+ "operationId": "get_retriever_api_v1_retrievers__retriever_id__get",
"security": [
{
"HTTPBearer": []
@@ -9093,13 +9721,47 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "retriever_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Retriever Id"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -9125,7 +9787,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDataset"
+ "$ref": "#/components/schemas/Retriever"
}
}
}
@@ -9143,10 +9805,10 @@
}
},
"put": {
- "tags": ["Evals"],
- "summary": "Update Dataset",
- "description": "Update a dataset.",
- "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put",
+ "tags": ["Retrievers"],
+ "summary": "Update Retriever",
+ "description": "Update an existing Retriever.",
+ "operationId": "update_retriever_api_v1_retrievers__retriever_id__put",
"security": [
{
"HTTPBearer": []
@@ -9157,13 +9819,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "retriever_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Retriever Id"
}
},
{
@@ -9188,7 +9850,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDatasetUpdate"
+ "$ref": "#/components/schemas/RetrieverUpdate"
}
}
}
@@ -9199,7 +9861,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDataset"
+ "$ref": "#/components/schemas/Retriever"
}
}
}
@@ -9217,10 +9879,10 @@
}
},
"delete": {
- "tags": ["Evals"],
- "summary": "Delete Dataset",
- "description": "Delete a dataset.",
- "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete",
+ "tags": ["Retrievers"],
+ "summary": "Delete Retriever",
+ "description": "Delete a Retriever by ID.",
+ "operationId": "delete_retriever_api_v1_retrievers__retriever_id__delete",
"security": [
{
"HTTPBearer": []
@@ -9231,13 +9893,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "retriever_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Retriever Id"
}
},
{
@@ -9274,12 +9936,12 @@
}
}
},
- "/api/v1/evals/datasets/{dataset_id}/question": {
+ "/api/v1/retrievers/{retriever_id}/retrieve": {
"post": {
- "tags": ["Evals"],
- "summary": "Create Question",
- "description": "Create a new question.",
- "operationId": "create_question_api_v1_evals_datasets__dataset_id__question_post",
+ "tags": ["Retrievers"],
+ "summary": "Retrieve",
+ "description": "Retrieve data using a Retriever.",
+ "operationId": "retrieve_api_v1_retrievers__retriever_id__retrieve_post",
"security": [
{
"HTTPBearer": []
@@ -9290,13 +9952,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "retriever_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Retriever Id"
}
},
{
@@ -9321,7 +9983,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
+ "$ref": "#/components/schemas/CompositeRetrievalParams"
}
}
}
@@ -9332,7 +9994,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "$ref": "#/components/schemas/CompositeRetrievalResult"
}
}
}
@@ -9348,14 +10010,16 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/jobs/": {
"get": {
- "tags": ["Evals"],
- "summary": "List Questions",
- "description": "List questions for a dataset.",
- "operationId": "list_questions_api_v1_evals_datasets__dataset_id__question_get",
- "security": [
- {
+ "tags": ["Jobs"],
+ "summary": "Get Jobs",
+ "description": "Get jobs for a project.",
+ "operationId": "get_jobs_api_v1_jobs__get",
+ "security": [
+ {
"HTTPBearer": []
},
{
@@ -9364,18 +10028,8 @@
],
"parameters": [
{
- "name": "dataset_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Dataset Id"
- }
- },
- {
- "name": "session",
- "in": "cookie",
+ "name": "job_name",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
@@ -9386,61 +10040,73 @@
"type": "null"
}
],
- "title": "Session"
+ "title": "Job Name"
}
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalQuestion"
- },
- "title": "Response List Questions Api V1 Evals Datasets Dataset Id Question Get"
- }
- }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 100,
+ "default": 50,
+ "title": "Limit"
}
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
+ {
+ "name": "offset",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0,
+ "title": "Offset"
}
- }
- }
- }
- },
- "/api/v1/evals/datasets/{dataset_id}/questions": {
- "post": {
- "tags": ["Evals"],
- "summary": "Create Questions",
- "description": "Create a new question.",
- "operationId": "create_questions_api_v1_evals_datasets__dataset_id__questions_post",
- "security": [
+ },
{
- "HTTPBearer": []
+ "name": "include_usage_metrics",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Include Usage Metrics"
+ }
},
{
- "HTTPBearer": []
- }
- ],
- "parameters": [
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
{
- "name": "dataset_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Dataset Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -9460,31 +10126,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
- },
- "title": "Payload"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalQuestion"
- },
- "title": "Response Create Questions Api V1 Evals Datasets Dataset Id Questions Post"
+ "$ref": "#/components/schemas/PaginatedJobsHistoryWithMetrics"
}
}
}
@@ -9502,12 +10150,12 @@
}
}
},
- "/api/v1/evals/questions/{question_id}": {
+ "/api/v1/evals/datasets/{dataset_id}": {
"get": {
"tags": ["Evals"],
- "summary": "Get Question",
- "description": "Get a question by ID.",
- "operationId": "get_question_api_v1_evals_questions__question_id__get",
+ "summary": "Get Dataset",
+ "description": "Get a dataset by ID.",
+ "operationId": "get_dataset_api_v1_evals_datasets__dataset_id__get",
"security": [
{
"HTTPBearer": []
@@ -9518,13 +10166,13 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Dataset Id"
}
},
{
@@ -9550,7 +10198,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "$ref": "#/components/schemas/EvalDataset"
}
}
}
@@ -9569,9 +10217,9 @@
},
"put": {
"tags": ["Evals"],
- "summary": "Replace Question",
- "description": "Replace a question.",
- "operationId": "replace_question_api_v1_evals_questions__question_id__put",
+ "summary": "Update Dataset",
+ "description": "Update a dataset.",
+ "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put",
"security": [
{
"HTTPBearer": []
@@ -9582,13 +10230,13 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Dataset Id"
}
},
{
@@ -9613,7 +10261,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
+ "$ref": "#/components/schemas/EvalDatasetUpdate"
}
}
}
@@ -9624,7 +10272,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "$ref": "#/components/schemas/EvalDataset"
}
}
}
@@ -9643,9 +10291,9 @@
},
"delete": {
"tags": ["Evals"],
- "summary": "Delete Question",
- "description": "Delete a question.",
- "operationId": "delete_question_api_v1_evals_questions__question_id__delete",
+ "summary": "Delete Dataset",
+ "description": "Delete a dataset.",
+ "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete",
"security": [
{
"HTTPBearer": []
@@ -9656,13 +10304,13 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Dataset Id"
}
},
{
@@ -9699,12 +10347,12 @@
}
}
},
- "/api/v1/evals/models": {
- "get": {
+ "/api/v1/evals/datasets/{dataset_id}/question": {
+ "post": {
"tags": ["Evals"],
- "summary": "List Supported Models",
- "description": "List supported models.",
- "operationId": "list_supported_models_api_v1_evals_models_get",
+ "summary": "Create Question",
+ "description": "Create a new question.",
+ "operationId": "create_question_api_v1_evals_datasets__dataset_id__question_post",
"security": [
{
"HTTPBearer": []
@@ -9714,6 +10362,16 @@
}
],
"parameters": [
+ {
+ "name": "dataset_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9731,17 +10389,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalQuestionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SupportedLLMModel"
- },
- "title": "Response List Supported Models Api V1 Evals Models Get"
+ "$ref": "#/components/schemas/EvalQuestion"
}
}
}
@@ -9757,14 +10421,12 @@
}
}
}
- }
- },
- "/api/v1/parsing/job/{job_id}/result/image/{name}": {
+ },
"get": {
- "tags": ["Parsing"],
- "summary": "Get Job Image Result",
- "description": "Get a job by id",
- "operationId": "get_job_image_result_api_v1_parsing_job__job_id__result_image__name__get",
+ "tags": ["Evals"],
+ "summary": "List Questions",
+ "description": "List questions for a dataset.",
+ "operationId": "list_questions_api_v1_evals_datasets__dataset_id__question_get",
"security": [
{
"HTTPBearer": []
@@ -9775,22 +10437,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
- }
- },
- {
- "name": "name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Name"
+ "title": "Dataset Id"
}
},
{
@@ -9814,7 +10467,15 @@
"200": {
"description": "Successful Response",
"content": {
- "image/jpeg": {}
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalQuestion"
+ },
+ "title": "Response List Questions Api V1 Evals Datasets Dataset Id Question Get"
+ }
+ }
}
},
"422": {
@@ -9830,36 +10491,12 @@
}
}
},
- "/api/v1/parsing/supported_file_extensions": {
- "get": {
- "tags": ["Parsing"],
- "summary": "Get Supported File Extensions",
- "description": "Get a list of supported file extensions",
- "operationId": "get_supported_file_extensions_api_v1_parsing_supported_file_extensions_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/LlamaParseSupportedFileExtensions"
- },
- "type": "array",
- "title": "Response Get Supported File Extensions Api V1 Parsing Supported File Extensions Get"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/parsing/upload": {
+ "/api/v1/evals/datasets/{dataset_id}/questions": {
"post": {
- "tags": ["Parsing"],
- "summary": "Upload File",
- "description": "Upload a file to s3 and create a job. return a job id",
- "operationId": "upload_file_api_v1_parsing_upload_post",
+ "tags": ["Evals"],
+ "summary": "Create Questions",
+ "description": "Create a new question.",
+ "operationId": "create_questions_api_v1_evals_datasets__dataset_id__questions_post",
"security": [
{
"HTTPBearer": []
@@ -9870,37 +10507,13 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
+ "name": "dataset_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
}
},
{
@@ -9921,10 +10534,15 @@
}
],
"requestBody": {
+ "required": true,
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_v1_parsing_upload_post"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalQuestionCreate"
+ },
+ "title": "Payload"
}
}
}
@@ -9935,7 +10553,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJob"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalQuestion"
+ },
+ "title": "Response Create Questions Api V1 Evals Datasets Dataset Id Questions Post"
}
}
}
@@ -9953,12 +10575,12 @@
}
}
},
- "/api/v1/parsing/usage": {
+ "/api/v1/evals/questions/{question_id}": {
"get": {
- "tags": ["Parsing"],
- "summary": "Usage",
- "description": "DEPRECATED: use either /organizations/{organization_id}/usage or /projects/{project_id}/usage instead\nGet parsing usage for user",
- "operationId": "usage_api_v1_parsing_usage_get",
+ "tags": ["Evals"],
+ "summary": "Get Question",
+ "description": "Get a question by ID.",
+ "operationId": "get_question_api_v1_evals_questions__question_id__get",
"security": [
{
"HTTPBearer": []
@@ -9968,6 +10590,16 @@
}
],
"parameters": [
+ {
+ "name": "question_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Question Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9991,7 +10623,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingUsage"
+ "$ref": "#/components/schemas/EvalQuestion"
}
}
}
@@ -10007,14 +10639,12 @@
}
}
}
- }
- },
- "/api/v1/parsing/job/{job_id}": {
- "get": {
- "tags": ["Parsing"],
- "summary": "Get Job",
- "description": "Get a job by id",
- "operationId": "get_job_api_v1_parsing_job__job_id__get",
+ },
+ "put": {
+ "tags": ["Evals"],
+ "summary": "Replace Question",
+ "description": "Replace a question.",
+ "operationId": "replace_question_api_v1_evals_questions__question_id__put",
"security": [
{
"HTTPBearer": []
@@ -10025,13 +10655,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "question_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Question Id"
}
},
{
@@ -10051,13 +10681,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalQuestionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJob"
+ "$ref": "#/components/schemas/EvalQuestion"
}
}
}
@@ -10073,14 +10713,12 @@
}
}
}
- }
- },
- "/api/v1/parsing/job/{job_id}/details": {
- "get": {
- "tags": ["Parsing"],
- "summary": "Get Parsing Job Details",
- "description": "Get a job by id",
- "operationId": "get_parsing_job_details_api_v1_parsing_job__job_id__details_get",
+ },
+ "delete": {
+ "tags": ["Evals"],
+ "summary": "Delete Question",
+ "description": "Delete a question.",
+ "operationId": "delete_question_api_v1_evals_questions__question_id__delete",
"security": [
{
"HTTPBearer": []
@@ -10091,13 +10729,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "question_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Question Id"
}
},
{
@@ -10118,15 +10756,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "title": "Response Get Parsing Job Details Api V1 Parsing Job Job Id Details Get"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -10141,12 +10772,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/text": {
+ "/api/v1/evals/models": {
"get": {
- "tags": ["Parsing"],
- "summary": "Get Job Text Result",
- "description": "Get a job by id",
- "operationId": "get_job_text_result_api_v1_parsing_job__job_id__result_text_get",
+ "tags": ["Evals"],
+ "summary": "List Supported Models",
+ "description": "List supported models.",
+ "operationId": "list_supported_models_api_v1_evals_models_get",
"security": [
{
"HTTPBearer": []
@@ -10156,16 +10787,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10189,7 +10810,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobTextResult"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SupportedLLMModel"
+ },
+ "title": "Response List Supported Models Api V1 Evals Models Get"
}
}
}
@@ -10207,12 +10832,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/text": {
+ "/api/v1/parsing/job/{job_id}/result/image/{name}": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Text Result",
+ "summary": "Get Job Image Result",
"description": "Get a job by id",
- "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_raw_text_get",
+ "operationId": "get_job_image_result_api_v1_parsing_job__job_id__result_image__name__get",
"security": [
{
"HTTPBearer": []
@@ -10232,6 +10857,15 @@
"title": "Job Id"
}
},
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Name"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10253,9 +10887,7 @@
"200": {
"description": "Successful Response",
"content": {
- "application/json": {
- "schema": {}
- }
+ "image/jpeg": {}
}
},
"422": {
@@ -10271,12 +10903,35 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/pdf": {
+ "/api/v1/parsing/supported_file_extensions": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Text Result",
- "description": "Get a job by id",
- "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_pdf_get",
+ "summary": "Get Supported File Extensions",
+ "description": "Get a list of supported file extensions",
+ "operationId": "get_supported_file_extensions_api_v1_parsing_supported_file_extensions_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/LlamaParseSupportedFileExtensions"
+ },
+ "type": "array",
+ "title": "Response Get Supported File Extensions Api V1 Parsing Supported File Extensions Get"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/parsing/screenshot": {
+ "post": {
+ "tags": ["Parsing"],
+ "summary": "Screenshot",
+ "operationId": "screenshot_api_v1_parsing_screenshot_post",
"security": [
{
"HTTPBearer": []
@@ -10287,38 +10942,73 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
- {
- "name": "session",
- "in": "cookie",
+ "name": "organization_id",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Session"
+ "title": "Organization Id"
}
- }
+ },
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_screenshot_api_v1_parsing_screenshot_post"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJob"
+ }
}
}
},
@@ -10335,12 +11025,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/pdf": {
- "get": {
+ "/api/v1/parsing/upload": {
+ "post": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Text Result",
- "description": "Get a job by id",
- "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_raw_pdf_get",
+ "summary": "Upload File",
+ "description": "Upload a file to s3 and create a job. return a job id",
+ "operationId": "upload_file_api_v1_parsing_upload_post",
"security": [
{
"HTTPBearer": []
@@ -10351,13 +11041,37 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
@@ -10377,12 +11091,23 @@
}
}
],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_parsing_upload_post"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJob"
+ }
}
}
},
@@ -10399,12 +11124,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/structured": {
+ "/api/v1/parsing/usage": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Structured Result",
- "description": "Get a job by id",
- "operationId": "get_job_structured_result_api_v1_parsing_job__job_id__result_structured_get",
+ "summary": "Usage",
+ "description": "DEPRECATED: use either /organizations/{organization_id}/usage or /projects/{project_id}/usage instead\nGet parsing usage for user",
+ "operationId": "usage_api_v1_parsing_usage_get",
"security": [
{
"HTTPBearer": []
@@ -10415,13 +11140,20 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -10447,7 +11179,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobStructuredResult"
+ "$ref": "#/components/schemas/ParsingUsage"
}
}
}
@@ -10465,12 +11197,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/structured": {
+ "/api/v1/parsing/job/{job_id}": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Structured Result",
+ "summary": "Get Job",
"description": "Get a job by id",
- "operationId": "get_job_raw_structured_result_api_v1_parsing_job__job_id__result_raw_structured_get",
+ "operationId": "get_job_api_v1_parsing_job__job_id__get",
"security": [
{
"HTTPBearer": []
@@ -10512,7 +11244,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJob"
+ }
}
}
},
@@ -10529,12 +11263,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/xlsx": {
+ "/api/v1/parsing/job/{job_id}/details": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Xlsx Result",
+ "summary": "Get Parsing Job Details",
"description": "Get a job by id",
- "operationId": "get_job_raw_xlsx_result_api_v1_parsing_job__job_id__result_xlsx_get",
+ "operationId": "get_parsing_job_details_api_v1_parsing_job__job_id__details_get",
"security": [
{
"HTTPBearer": []
@@ -10576,7 +11310,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "title": "Response Get Parsing Job Details Api V1 Parsing Job Job Id Details Get"
+ }
}
}
},
@@ -10593,12 +11329,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/xlsx": {
+ "/api/v1/parsing/job/{job_id}/result/text": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Xlsx Result",
+ "summary": "Get Job Text Result",
"description": "Get a job by id",
- "operationId": "get_job_raw_xlsx_result_api_v1_parsing_job__job_id__result_raw_xlsx_get",
+ "operationId": "get_job_text_result_api_v1_parsing_job__job_id__result_text_get",
"security": [
{
"HTTPBearer": []
@@ -10618,6 +11354,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10640,7 +11393,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobTextResult"
+ }
}
}
},
@@ -10657,12 +11412,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/markdown": {
+ "/api/v1/parsing/job/{job_id}/result/raw/text": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Result",
+ "summary": "Get Job Raw Text Result",
"description": "Get a job by id",
- "operationId": "get_job_result_api_v1_parsing_job__job_id__result_markdown_get",
+ "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_raw_text_get",
"security": [
{
"HTTPBearer": []
@@ -10704,9 +11459,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ParsingJobMarkdownResult"
- }
+ "schema": {}
}
}
},
@@ -10723,12 +11476,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/markdown": {
+ "/api/v1/parsing/job/{job_id}/result/pdf": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Raw Md Result",
+ "summary": "Get Job Raw Text Result",
"description": "Get a job by id",
- "operationId": "get_job_raw_md_result_api_v1_parsing_job__job_id__result_raw_markdown_get",
+ "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_pdf_get",
"security": [
{
"HTTPBearer": []
@@ -10787,12 +11540,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/json": {
+ "/api/v1/parsing/job/{job_id}/result/raw/pdf": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Json Result",
+ "summary": "Get Job Raw Text Result",
"description": "Get a job by id",
- "operationId": "get_job_json_result_api_v1_parsing_job__job_id__result_json_get",
+ "operationId": "get_job_raw_text_result_api_v1_parsing_job__job_id__result_raw_pdf_get",
"security": [
{
"HTTPBearer": []
@@ -10834,9 +11587,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ParsingJobJsonResult"
- }
+ "schema": {}
}
}
},
@@ -10853,12 +11604,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/json": {
+ "/api/v1/parsing/job/{job_id}/result/structured": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Job Json Raw Result",
+ "summary": "Get Job Structured Result",
"description": "Get a job by id",
- "operationId": "get_job_json_raw_result_api_v1_parsing_job__job_id__result_raw_json_get",
+ "operationId": "get_job_structured_result_api_v1_parsing_job__job_id__result_structured_get",
"security": [
{
"HTTPBearer": []
@@ -10878,6 +11629,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10900,7 +11668,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobStructuredResult"
+ }
}
}
},
@@ -10917,12 +11687,12 @@
}
}
},
- "/api/v1/parsing/history": {
+ "/api/v1/parsing/job/{job_id}/result/raw/structured": {
"get": {
"tags": ["Parsing"],
- "summary": "Get Parsing History Result",
- "description": "Get parsing history for user",
- "operationId": "get_parsing_history_result_api_v1_parsing_history_get",
+ "summary": "Get Job Raw Structured Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_structured_result_api_v1_parsing_job__job_id__result_raw_structured_get",
"security": [
{
"HTTPBearer": []
@@ -10932,6 +11702,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10954,13 +11734,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ParsingHistoryItem"
- },
- "title": "Response Get Parsing History Result Api V1 Parsing History Get"
- }
+ "schema": {}
}
}
},
@@ -10977,12 +11751,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/read/{filename}": {
+ "/api/v1/parsing/job/{job_id}/result/xlsx": {
"get": {
"tags": ["Parsing"],
- "summary": "Generate Presigned Url",
- "description": "Generate a presigned URL for a job",
- "operationId": "generate_presigned_url_api_v1_parsing_job__job_id__read__filename__get",
+ "summary": "Get Job Raw Xlsx Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_xlsx_result_api_v1_parsing_job__job_id__result_xlsx_get",
"security": [
{
"HTTPBearer": []
@@ -11002,15 +11776,6 @@
"title": "Job Id"
}
},
- {
- "name": "filename",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Filename"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -11033,9 +11798,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PresignedUrl"
- }
+ "schema": {}
}
}
},
@@ -11052,71 +11815,63 @@
}
}
},
- "/api/v1/component-definition/configurable-transformations": {
+ "/api/v1/parsing/job/{job_id}/result/raw/xlsx": {
"get": {
- "tags": ["Component Definitions"],
- "summary": "List Transformation Definitions",
- "description": "List transformation component definitions.",
- "operationId": "list_transformation_definitions_api_v1_component_definition_configurable_transformations_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/ConfigurableTransformationDefinition"
- },
- "type": "array",
- "title": "Response List Transformation Definitions Api V1 Component Definition Configurable Transformations Get"
+ "tags": ["Parsing"],
+ "summary": "Get Job Raw Xlsx Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_xlsx_result_api_v1_parsing_job__job_id__result_raw_xlsx_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Session"
}
}
- }
- }
- },
- "/api/v1/component-definition/data-sources": {
- "get": {
- "tags": ["Component Definitions"],
- "summary": "List Data Source Definitions",
- "description": "List data source component definitions.",
- "operationId": "list_data_source_definitions_api_v1_component_definition_data_sources_get",
+ ],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/DataSourceDefinition"
- },
- "type": "array",
- "title": "Response List Data Source Definitions Api V1 Component Definition Data Sources Get"
- }
+ "schema": {}
}
}
- }
- }
- }
- },
- "/api/v1/component-definition/data-sinks": {
- "get": {
- "tags": ["Component Definitions"],
- "summary": "List Data Sink Definitions",
- "description": "List data sink component definitions.",
- "operationId": "list_data_sink_definitions_api_v1_component_definition_data_sinks_get",
- "responses": {
- "200": {
- "description": "Successful Response",
+ },
+ "422": {
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "items": {
- "$ref": "#/components/schemas/DataSinkDefinition"
- },
- "type": "array",
- "title": "Response List Data Sink Definitions Api V1 Component Definition Data Sinks Get"
+ "$ref": "#/components/schemas/HTTPValidationError"
}
}
}
@@ -11124,12 +11879,12 @@
}
}
},
- "/api/v1/apps/": {
- "post": {
- "tags": ["Chat Apps"],
- "summary": "Create Chat App",
- "description": "Create a new chat app.",
- "operationId": "create_chat_app_api_v1_apps__post",
+ "/api/v1/parsing/job/{job_id}/result/markdown": {
+ "get": {
+ "tags": ["Parsing"],
+ "summary": "Get Job Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_result_api_v1_parsing_job__job_id__result_markdown_get",
"security": [
{
"HTTPBearer": []
@@ -11140,20 +11895,13 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "query",
- "required": false,
+ "name": "job_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
}
},
{
@@ -11190,23 +11938,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChatAppCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ChatApp"
+ "$ref": "#/components/schemas/ParsingJobMarkdownResult"
}
}
}
@@ -11224,21 +11962,45 @@
}
}
},
- "/api/v1/apps/{id}": {
+ "/api/v1/parsing/job/{job_id}/result/raw/markdown": {
"get": {
- "tags": ["Chat Apps"],
- "summary": "Get Chat App",
- "description": "Get a chat app by ID.",
- "operationId": "get_chat_app_api_v1_apps__id__get",
+ "tags": ["Parsing"],
+ "summary": "Get Job Raw Md Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_md_result_api_v1_parsing_job__job_id__result_raw_markdown_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
"parameters": [
{
- "name": "id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Id"
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
}
}
],
@@ -11247,9 +12009,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChatApp"
- }
+ "schema": {}
}
}
},
@@ -11264,12 +12024,14 @@
}
}
}
- },
- "patch": {
- "tags": ["Chat Apps"],
- "summary": "Update Chat App",
- "description": "Update a chat app.",
- "operationId": "update_chat_app_api_v1_apps__id__patch",
+ }
+ },
+ "/api/v1/parsing/job/{job_id}/result/json": {
+ "get": {
+ "tags": ["Parsing"],
+ "summary": "Get Job Json Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_json_result_api_v1_parsing_job__job_id__result_json_get",
"security": [
{
"HTTPBearer": []
@@ -11280,30 +12042,13 @@
],
"parameters": [
{
- "name": "id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Id"
- }
- },
- {
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
+ "title": "Job Id"
}
},
{
@@ -11340,23 +12085,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChatAppUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ChatApp"
+ "$ref": "#/components/schemas/ParsingJobJsonResult"
}
}
}
@@ -11374,34 +12109,48 @@
}
}
},
- "/api/v1/apps/{id}/chat": {
- "post": {
- "tags": ["Chat Apps"],
- "summary": "Chat With Chat App",
- "description": "Chat with a chat app.",
- "operationId": "chat_with_chat_app_api_v1_apps__id__chat_post",
+ "/api/v1/parsing/job/{job_id}/result/raw/json": {
+ "get": {
+ "tags": ["Parsing"],
+ "summary": "Get Job Json Raw Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_json_raw_result_api_v1_parsing_job__job_id__result_raw_json_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
"parameters": [
{
- "name": "id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Id"
+ "title": "Job Id"
}
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AppChatInputParams"
- }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Successful Response",
@@ -11424,12 +12173,12 @@
}
}
},
- "/api/v1/billing/checkout-session": {
- "post": {
- "tags": ["Billing"],
- "summary": "Create Checkout Session",
- "description": "Create a new checkout session.",
- "operationId": "create_checkout_session_api_v1_billing_checkout_session_post",
+ "/api/v1/parsing/history": {
+ "get": {
+ "tags": ["Parsing"],
+ "summary": "Get Parsing History Result",
+ "description": "Get parsing history for user",
+ "operationId": "get_parsing_history_result_api_v1_parsing_history_get",
"security": [
{
"HTTPBearer": []
@@ -11456,24 +12205,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CheckoutSessionCreatePayload"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "string",
- "title": "Response Create Checkout Session Api V1 Billing Checkout Session Post"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParsingHistoryItem"
+ },
+ "title": "Response Get Parsing History Result Api V1 Parsing History Get"
}
}
}
@@ -11491,12 +12233,12 @@
}
}
},
- "/api/v1/billing/customer-portal-session": {
- "post": {
- "tags": ["Billing"],
- "summary": "Create Customer Portal Session",
- "description": "Create a new customer portal session.",
- "operationId": "create_customer_portal_session_api_v1_billing_customer_portal_session_post",
+ "/api/v1/parsing/job/{job_id}/read/{filename}": {
+ "get": {
+ "tags": ["Parsing"],
+ "summary": "Generate Presigned Url",
+ "description": "Generate a presigned URL for a job",
+ "operationId": "generate_presigned_url_api_v1_parsing_job__job_id__read__filename__get",
"security": [
{
"HTTPBearer": []
@@ -11506,6 +12248,25 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "filename",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Filename"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -11523,24 +12284,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CustomerPortalSessionCreatePayload"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "string",
- "title": "Response Create Customer Portal Session Api V1 Billing Customer Portal Session Post"
+ "$ref": "#/components/schemas/PresignedUrl"
}
}
}
@@ -11558,38 +12308,71 @@
}
}
},
- "/api/v1/billing/webhook": {
- "post": {
- "tags": ["Billing"],
- "summary": "Stripe Webhook",
- "description": "Stripe webhook endpoint.",
- "operationId": "stripe_webhook_api_v1_billing_webhook_post",
- "parameters": [
- {
- "name": "stripe-signature",
- "in": "header",
- "required": false,
- "schema": {
- "type": "string",
- "title": "Stripe-Signature"
+ "/api/v1/component-definition/configurable-transformations": {
+ "get": {
+ "tags": ["Component Definitions"],
+ "summary": "List Transformation Definitions",
+ "description": "List transformation component definitions.",
+ "operationId": "list_transformation_definitions_api_v1_component_definition_configurable_transformations_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/ConfigurableTransformationDefinition"
+ },
+ "type": "array",
+ "title": "Response List Transformation Definitions Api V1 Component Definition Configurable Transformations Get"
+ }
+ }
}
}
- ],
+ }
+ }
+ },
+ "/api/v1/component-definition/data-sources": {
+ "get": {
+ "tags": ["Component Definitions"],
+ "summary": "List Data Source Definitions",
+ "description": "List data source component definitions.",
+ "operationId": "list_data_source_definitions_api_v1_component_definition_data_sources_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/DataSourceDefinition"
+ },
+ "type": "array",
+ "title": "Response List Data Source Definitions Api V1 Component Definition Data Sources Get"
+ }
}
}
- },
- "422": {
- "description": "Validation Error",
+ }
+ }
+ }
+ },
+ "/api/v1/component-definition/data-sinks": {
+ "get": {
+ "tags": ["Component Definitions"],
+ "summary": "List Data Sink Definitions",
+ "description": "List data sink component definitions.",
+ "operationId": "list_data_sink_definitions_api_v1_component_definition_data_sinks_get",
+ "responses": {
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "items": {
+ "$ref": "#/components/schemas/DataSinkDefinition"
+ },
+ "type": "array",
+ "title": "Response List Data Sink Definitions Api V1 Component Definition Data Sinks Get"
}
}
}
@@ -11597,11 +12380,12 @@
}
}
},
- "/api/v1/extraction/schemas": {
+ "/api/v1/apps/": {
"post": {
- "tags": ["Extraction"],
- "summary": "Create Schema",
- "operationId": "create_schema_api_v1_extraction_schemas_post",
+ "tags": ["Chat Apps"],
+ "summary": "Create Chat App",
+ "description": "Create a new chat app.",
+ "operationId": "create_chat_app_api_v1_apps__post",
"security": [
{
"HTTPBearer": []
@@ -11611,6 +12395,40 @@
}
],
"parameters": [
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -11633,7 +12451,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionSchemaCreate"
+ "$ref": "#/components/schemas/ChatAppCreate"
}
}
}
@@ -11644,7 +12462,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
+ "$ref": "#/components/schemas/ChatApp"
}
}
}
@@ -11662,9 +12480,9 @@
}
},
"get": {
- "tags": ["Extraction"],
- "summary": "List Schemas",
- "operationId": "list_schemas_api_v1_extraction_schemas_get",
+ "tags": ["Chat Apps"],
+ "summary": "Get Chat Apps",
+ "operationId": "get_chat_apps_api_v1_apps__get",
"security": [
{
"HTTPBearer": []
@@ -11691,6 +12509,23 @@
"title": "Project Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -11716,9 +12551,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ExtractionSchema"
+ "$ref": "#/components/schemas/ChatAppResponse"
},
- "title": "Response List Schemas Api V1 Extraction Schemas Get"
+ "title": "Response Get Chat Apps Api V1 Apps Get"
}
}
}
@@ -11736,11 +12571,12 @@
}
}
},
- "/api/v1/extraction/schemas/infer": {
- "post": {
- "tags": ["Extraction"],
- "summary": "Infer Schema",
- "operationId": "infer_schema_api_v1_extraction_schemas_infer_post",
+ "/api/v1/apps/{id}": {
+ "get": {
+ "tags": ["Chat Apps"],
+ "summary": "Get Chat App",
+ "description": "Get a chat app by ID.",
+ "operationId": "get_chat_app_api_v1_apps__id__get",
"security": [
{
"HTTPBearer": []
@@ -11750,6 +12586,16 @@
}
],
"parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -11767,23 +12613,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchemaInfer"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
+ "$ref": "#/components/schemas/ChatApp"
}
}
}
@@ -11799,13 +12635,12 @@
}
}
}
- }
- },
- "/api/v1/extraction/schemas/{schema_id}": {
- "get": {
- "tags": ["Extraction"],
- "summary": "Get Schema",
- "operationId": "get_schema_api_v1_extraction_schemas__schema_id__get",
+ },
+ "put": {
+ "tags": ["Chat Apps"],
+ "summary": "Update Chat App",
+ "description": "Update a chat app.",
+ "operationId": "update_chat_app_api_v1_apps__id__put",
"security": [
{
"HTTPBearer": []
@@ -11816,13 +12651,47 @@
],
"parameters": [
{
- "name": "schema_id",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Id"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -11842,13 +12711,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ChatAppUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
+ "$ref": "#/components/schemas/ChatApp"
}
}
}
@@ -11865,10 +12744,10 @@
}
}
},
- "put": {
- "tags": ["Extraction"],
- "summary": "Update Schema",
- "operationId": "update_schema_api_v1_extraction_schemas__schema_id__put",
+ "delete": {
+ "tags": ["Chat Apps"],
+ "summary": "Delete Chat App",
+ "operationId": "delete_chat_app_api_v1_apps__id__delete",
"security": [
{
"HTTPBearer": []
@@ -11879,13 +12758,13 @@
],
"parameters": [
{
- "name": "schema_id",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Id"
}
},
{
@@ -11905,24 +12784,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchemaUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
- }
+ "schema": {}
}
}
},
@@ -11939,11 +12806,12 @@
}
}
},
- "/api/v1/extraction/jobs": {
- "get": {
- "tags": ["Extraction"],
- "summary": "List Jobs",
- "operationId": "list_jobs_api_v1_extraction_jobs_get",
+ "/api/v1/apps/{id}/chat": {
+ "post": {
+ "tags": ["Chat Apps"],
+ "summary": "Chat With Chat App",
+ "description": "Chat with a chat app.",
+ "operationId": "chat_with_chat_app_api_v1_apps__id__chat_post",
"security": [
{
"HTTPBearer": []
@@ -11954,13 +12822,13 @@
],
"parameters": [
{
- "name": "schema_id",
- "in": "query",
+ "name": "id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Id"
}
},
{
@@ -11980,18 +12848,22 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AppChatInputParams"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractionJob"
- },
- "title": "Response List Jobs Api V1 Extraction Jobs Get"
- }
+ "schema": {}
}
}
},
@@ -12006,11 +12878,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/billing/checkout-session": {
"post": {
- "tags": ["Extraction"],
- "summary": "Run Job",
- "operationId": "run_job_api_v1_extraction_jobs_post",
+ "tags": ["Billing"],
+ "summary": "Create Checkout Session",
+ "description": "Create a new checkout session.",
+ "operationId": "create_checkout_session_api_v1_billing_checkout_session_post",
"security": [
{
"HTTPBearer": []
@@ -12020,6 +12895,23 @@
}
],
"parameters": [
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -12042,7 +12934,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionJobCreate"
+ "$ref": "#/components/schemas/CheckoutSessionCreatePayload"
}
}
}
@@ -12053,7 +12945,8 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionJob"
+ "type": "string",
+ "title": "Response Create Checkout Session Api V1 Billing Checkout Session Post"
}
}
}
@@ -12071,11 +12964,12 @@
}
}
},
- "/api/v1/extraction/jobs/{job_id}": {
- "get": {
- "tags": ["Extraction"],
- "summary": "Get Job",
- "operationId": "get_job_api_v1_extraction_jobs__job_id__get",
+ "/api/v1/billing/customer-portal-session": {
+ "post": {
+ "tags": ["Billing"],
+ "summary": "Create Customer Portal Session",
+ "description": "Create a new customer portal session.",
+ "operationId": "create_customer_portal_session_api_v1_billing_customer_portal_session_post",
"security": [
{
"HTTPBearer": []
@@ -12086,13 +12980,20 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -12112,13 +13013,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomerPortalSessionCreatePayload"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionJob"
+ "type": "string",
+ "title": "Response Create Customer Portal Session Api V1 Billing Customer Portal Session Post"
}
}
}
@@ -12136,58 +13048,38 @@
}
}
},
- "/api/v1/extraction/jobs/batch": {
+ "/api/v1/billing/webhook": {
"post": {
- "tags": ["Extraction"],
- "summary": "Run Jobs In Batch",
- "operationId": "run_jobs_in_batch_api_v1_extraction_jobs_batch_post",
- "security": [
- {
- "HTTPBearer": []
- },
- {
- "HTTPBearer": []
- }
- ],
+ "tags": ["Billing"],
+ "summary": "Stripe Webhook",
+ "description": "Stripe webhook endpoint.",
+ "operationId": "stripe_webhook_api_v1_billing_webhook_post",
"parameters": [
{
- "name": "session",
- "in": "cookie",
+ "name": "stripe-signature",
+ "in": "header",
"required": false,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Session"
+ "type": "string",
+ "title": "Stripe-Signature"
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionJobCreateBatch"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractionJob"
+ "type": "object",
+ "additionalProperties": {
+ "const": "success",
+ "type": "string"
},
- "title": "Response Run Jobs In Batch Api V1 Extraction Jobs Batch Post"
+ "propertyNames": {
+ "const": "status"
+ },
+ "title": "Response Stripe Webhook Api V1 Billing Webhook Post"
}
}
}
@@ -12205,11 +13097,11 @@
}
}
},
- "/api/v1/extraction/jobs/{job_id}/result": {
- "get": {
- "tags": ["Extraction"],
- "summary": "Get Job Result",
- "operationId": "get_job_result_api_v1_extraction_jobs__job_id__result_get",
+ "/api/v1/billing/downgrade-plan": {
+ "post": {
+ "tags": ["Billing"],
+ "summary": "Downgrade Plan",
+ "operationId": "downgrade_plan_api_v1_billing_downgrade_plan_post",
"security": [
{
"HTTPBearer": []
@@ -12220,13 +13112,13 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
+ "name": "organization_id",
+ "in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Organization Id"
}
},
{
@@ -12252,7 +13144,15 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionResult"
+ "type": "object",
+ "additionalProperties": {
+ "const": "success",
+ "type": "string"
+ },
+ "propertyNames": {
+ "const": "status"
+ },
+ "title": "Response Downgrade Plan Api V1 Billing Downgrade Plan Post"
}
}
}
@@ -12270,11 +13170,12 @@
}
}
},
- "/api/v1/extractionv2/extraction_agent": {
+ "/api/v1/billing/create-intent-and-customer-session": {
"post": {
- "tags": ["LlamaExtract"],
- "summary": "Create Extraction Agent",
- "operationId": "create_extraction_agent_api_v1_extractionv2_extraction_agent_post",
+ "tags": ["Billing"],
+ "summary": "Create Intent And Customer Session",
+ "description": "Create a new setup intent and and a customer session.\n\nSee https://docs.stripe.com/payments/existing-customers?platform=web&ui=elements",
+ "operationId": "create_intent_and_customer_session_api_v1_billing_create_intent_and_customer_session_post",
"security": [
{
"HTTPBearer": []
@@ -12285,7 +13186,7 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -12298,24 +13199,7 @@
"type": "null"
}
],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
+ "title": "Organization Id"
}
},
{
@@ -12335,23 +13219,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractAgentCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractAgent"
+ "$ref": "#/components/schemas/CreateIntentAndCustomerSessionResponse"
}
}
}
@@ -12369,11 +13243,11 @@
}
}
},
- "/api/v1/extractionv2/extraction_agents": {
- "get": {
+ "/api/v1/extractionv2/extraction-agents": {
+ "post": {
"tags": ["LlamaExtract"],
- "summary": "List Extraction Agents",
- "operationId": "list_extraction_agents_api_v1_extractionv2_extraction_agents_get",
+ "summary": "Create Extraction Agent",
+ "operationId": "create_extraction_agent_api_v1_extractionv2_extraction_agents_post",
"security": [
{
"HTTPBearer": []
@@ -12386,10 +13260,17 @@
{
"name": "project_id",
"in": "query",
- "required": true,
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Project Id"
}
},
@@ -12427,17 +13308,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractAgentCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractAgent"
- },
- "title": "Response List Extraction Agents Api V1 Extractionv2 Extraction Agents Get"
+ "$ref": "#/components/schemas/ExtractAgent"
}
}
}
@@ -12453,13 +13340,11 @@
}
}
}
- }
- },
- "/api/v1/extractionv2/extraction_agents/{extraction_agent_id}": {
+ },
"get": {
"tags": ["LlamaExtract"],
- "summary": "Get Extraction Agent",
- "operationId": "get_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__get",
+ "summary": "List Extraction Agents",
+ "operationId": "list_extraction_agents_api_v1_extractionv2_extraction_agents_get",
"security": [
{
"HTTPBearer": []
@@ -12469,16 +13354,6 @@
}
],
"parameters": [
- {
- "name": "extraction_agent_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Extraction Agent Id"
- }
- },
{
"name": "project_id",
"in": "query",
@@ -12496,23 +13371,6 @@
"title": "Project Id"
}
},
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -12536,7 +13394,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractAgent"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtractAgent"
+ },
+ "title": "Response List Extraction Agents Api V1 Extractionv2 Extraction Agents Get"
}
}
}
@@ -12552,11 +13414,14 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/extractionv2/extraction-agents/schema/validation": {
+ "post": {
"tags": ["LlamaExtract"],
- "summary": "Delete Extraction Agent",
- "operationId": "delete_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__delete",
+ "summary": "Validate Extraction Schema",
+ "description": "Validates an extraction agent's schema definition.\nReturns the normalized and validated schema if valid, otherwise raises an HTTP 400.",
+ "operationId": "validate_extraction_schema_api_v1_extractionv2_extraction_agents_schema_validation_post",
"security": [
{
"HTTPBearer": []
@@ -12566,50 +13431,6 @@
}
],
"parameters": [
- {
- "name": "extraction_agent_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Extraction Agent Id"
- }
- },
- {
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -12627,12 +13448,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractSchemaValidateRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ExtractSchemaValidateResponse"
+ }
}
}
},
@@ -12647,11 +13480,13 @@
}
}
}
- },
- "put": {
+ }
+ },
+ "/api/v1/extractionv2/extraction-agents/by-name/{name}": {
+ "get": {
"tags": ["LlamaExtract"],
- "summary": "Update Extraction Agent",
- "operationId": "update_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__put",
+ "summary": "Get Extraction Agent By Name",
+ "operationId": "get_extraction_agent_by_name_api_v1_extractionv2_extraction_agents_by_name__name__get",
"security": [
{
"HTTPBearer": []
@@ -12662,13 +13497,12 @@
],
"parameters": [
{
- "name": "extraction_agent_id",
+ "name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Extraction Agent Id"
+ "title": "Name"
}
},
{
@@ -12688,23 +13522,6 @@
"title": "Project Id"
}
},
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -12722,16 +13539,6 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractAgentUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
@@ -12756,11 +13563,11 @@
}
}
},
- "/api/v1/extractionv2/jobs": {
+ "/api/v1/extractionv2/extraction-agents/{extraction_agent_id}": {
"get": {
"tags": ["LlamaExtract"],
- "summary": "List Jobs",
- "operationId": "list_jobs_api_v1_extractionv2_jobs_get",
+ "summary": "Get Extraction Agent",
+ "operationId": "get_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__get",
"security": [
{
"HTTPBearer": []
@@ -12772,7 +13579,7 @@
"parameters": [
{
"name": "extraction_agent_id",
- "in": "query",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
@@ -12780,40 +13587,6 @@
"title": "Extraction Agent Id"
}
},
- {
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -12837,11 +13610,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractJob"
- },
- "title": "Response List Jobs Api V1 Extractionv2 Jobs Get"
+ "$ref": "#/components/schemas/ExtractAgent"
}
}
}
@@ -12858,10 +13627,10 @@
}
}
},
- "post": {
+ "delete": {
"tags": ["LlamaExtract"],
- "summary": "Run Job",
- "operationId": "run_job_api_v1_extractionv2_jobs_post",
+ "summary": "Delete Extraction Agent",
+ "operationId": "delete_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__delete",
"security": [
{
"HTTPBearer": []
@@ -12872,37 +13641,74 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "query",
- "required": false,
+ "name": "extraction_agent_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
+ "type": "string",
+ "format": "uuid",
+ "title": "Extraction Agent Id"
}
},
{
- "name": "organization_id",
- "in": "query",
+ "name": "session",
+ "in": "cookie",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Organization Id"
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": ["LlamaExtract"],
+ "summary": "Update Extraction Agent",
+ "operationId": "update_extraction_agent_api_v1_extractionv2_extraction_agents__extraction_agent_id__put",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "extraction_agent_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Extraction Agent Id"
}
},
{
@@ -12927,7 +13733,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractJobCreate"
+ "$ref": "#/components/schemas/ExtractAgentUpdate"
}
}
}
@@ -12938,7 +13744,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractJob"
+ "$ref": "#/components/schemas/ExtractAgent"
}
}
}
@@ -12956,11 +13762,11 @@
}
}
},
- "/api/v1/extractionv2/jobs/{job_id}": {
+ "/api/v1/extractionv2/jobs": {
"get": {
"tags": ["LlamaExtract"],
- "summary": "Get Job",
- "operationId": "get_job_api_v1_extractionv2_jobs__job_id__get",
+ "summary": "List Jobs",
+ "operationId": "list_jobs_api_v1_extractionv2_jobs_get",
"security": [
{
"HTTPBearer": []
@@ -12971,47 +13777,13 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
+ "name": "extraction_agent_id",
+ "in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
- }
- },
- {
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
+ "title": "Extraction Agent Id"
}
},
{
@@ -13037,7 +13809,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractJob"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtractJob"
+ },
+ "title": "Response List Jobs Api V1 Extractionv2 Jobs Get"
}
}
}
@@ -13053,13 +13829,11 @@
}
}
}
- }
- },
- "/api/v1/extractionv2/jobs/parsed": {
+ },
"post": {
"tags": ["LlamaExtract"],
- "summary": "Run Job With Parsed File",
- "operationId": "run_job_with_parsed_file_api_v1_extractionv2_jobs_parsed_post",
+ "summary": "Run Job",
+ "operationId": "run_job_api_v1_extractionv2_jobs_post",
"security": [
{
"HTTPBearer": []
@@ -13069,40 +13843,6 @@
}
],
"parameters": [
- {
- "name": "project_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
- }
- },
- {
- "name": "organization_id",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -13136,15 +13876,7 @@
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ExtractResultset"
- },
- {
- "type": "null"
- }
- ],
- "title": "Response Run Job With Parsed File Api V1 Extractionv2 Jobs Parsed Post"
+ "$ref": "#/components/schemas/ExtractJob"
}
}
}
@@ -13162,11 +13894,11 @@
}
}
},
- "/api/v1/extractionv2/jobs/batch": {
- "post": {
+ "/api/v1/extractionv2/jobs/{job_id}": {
+ "get": {
"tags": ["LlamaExtract"],
- "summary": "Run Jobs In Batch",
- "operationId": "run_jobs_in_batch_api_v1_extractionv2_jobs_batch_post",
+ "summary": "Get Job",
+ "operationId": "get_job_api_v1_extractionv2_jobs__job_id__get",
"security": [
{
"HTTPBearer": []
@@ -13177,39 +13909,70 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "query",
- "required": false,
+ "name": "job_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id"
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
}
},
{
- "name": "organization_id",
- "in": "query",
+ "name": "session",
+ "in": "cookie",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Organization Id"
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractJob"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
}
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/jobs/parsed/test": {
+ "post": {
+ "tags": ["LlamaExtract"],
+ "summary": "Run Job With Parsed File Test",
+ "operationId": "run_job_with_parsed_file_test_api_v1_extractionv2_jobs_parsed_test_post",
+ "security": [
+ {
+ "HTTPBearer": []
},
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
{
"name": "session",
"in": "cookie",
@@ -13232,7 +13995,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractJobCreateBatch"
+ "$ref": "#/components/schemas/Body_run_job_with_parsed_file_test_api_v1_extractionv2_jobs_parsed_test_post"
}
}
}
@@ -13243,11 +14006,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractJob"
- },
- "title": "Response Run Jobs In Batch Api V1 Extractionv2 Jobs Batch Post"
+ "$ref": "#/components/schemas/ExtractResultset"
}
}
}
@@ -13265,10 +14024,140 @@
}
}
},
- "/api/v1/extractionv2/jobs/{job_id}/result": {
- "get": {
+ "/api/v1/extractionv2/jobs/parsed": {
+ "post": {
"tags": ["LlamaExtract"],
- "summary": "Get Job Result",
+ "summary": "Run Job With Parsed File",
+ "operationId": "run_job_with_parsed_file_api_v1_extractionv2_jobs_parsed_post",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractJobCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractResultset"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/jobs/test": {
+ "post": {
+ "tags": ["LlamaExtract"],
+ "summary": "Run Job Test User",
+ "operationId": "run_job_test_user_api_v1_extractionv2_jobs_test_post",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_run_job_test_user_api_v1_extractionv2_jobs_test_post"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractJob"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/jobs/{job_id}/result": {
+ "get": {
+ "tags": ["LlamaExtract"],
+ "summary": "Get Job Result",
"operationId": "get_job_result_api_v1_extractionv2_jobs__job_id__result_get",
"security": [
{
@@ -13290,37 +14179,137 @@
}
},
{
- "name": "project_id",
- "in": "query",
+ "name": "session",
+ "in": "cookie",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Session"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractResultset"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/runs": {
+ "get": {
+ "tags": ["LlamaExtract"],
+ "summary": "List Extract Runs",
+ "operationId": "list_extract_runs_api_v1_extractionv2_runs_get",
+ "security": [
+ {
+ "HTTPBearer": []
},
{
- "name": "organization_id",
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "extraction_agent_id",
"in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Extraction Agent Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Organization Id"
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtractRun"
+ },
+ "title": "Response List Extract Runs Api V1 Extractionv2 Runs Get"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/runs/by-job/{job_id}": {
+ "get": {
+ "tags": ["LlamaExtract"],
+ "summary": "Get Run By Job Id",
+ "operationId": "get_run_by_job_id_api_v1_extractionv2_runs_by_job__job_id__get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
}
},
{
@@ -13346,7 +14335,72 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractResultset"
+ "$ref": "#/components/schemas/ExtractRun"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extractionv2/runs/{run_id}": {
+ "get": {
+ "tags": ["LlamaExtract"],
+ "summary": "Get Run",
+ "operationId": "get_run_api_v1_extractionv2_runs__run_id__get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "run_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Run Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractRun"
}
}
}
@@ -13945,6 +14999,18 @@
"title": "Report Id"
}
},
+ {
+ "name": "cascade_delete",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Whether to delete associated retriever and pipeline data",
+ "default": false,
+ "title": "Cascade Delete"
+ },
+ "description": "Whether to delete associated retriever and pipeline data"
+ },
{
"name": "project_id",
"in": "query",
@@ -14577,12 +15643,12 @@
}
}
},
- "/api/v1/reports/{report_id}/retry": {
+ "/api/v1/reports/{report_id}/restart": {
"post": {
"tags": ["Reports"],
"summary": "Restart Report",
- "description": "Restart a report.",
- "operationId": "restart_report_api_v1_reports__report_id__retry_post",
+ "description": "Restart a report from scratch.",
+ "operationId": "restart_report_api_v1_reports__report_id__restart_post",
"security": [
{
"HTTPBearer": []
@@ -14770,12 +15836,11 @@
}
}
},
- "/api/parsing/upload": {
+ "/api/parsing/screenshot": {
"post": {
"tags": ["Deprecated"],
- "summary": "Upload File",
- "description": "Upload a file to s3 and create a job. return a job id",
- "operationId": "upload_file_api_parsing_upload_post",
+ "summary": "Screenshot",
+ "operationId": "screenshot_api_parsing_screenshot_post",
"security": [
{
"HTTPBearer": []
@@ -14785,6 +15850,23 @@
}
],
"parameters": [
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "project_id",
"in": "query",
@@ -14802,6 +15884,71 @@
"title": "Project Id"
}
},
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_screenshot_api_parsing_screenshot_post"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJob"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/upload": {
+ "post": {
+ "tags": ["Deprecated"],
+ "summary": "Upload File",
+ "description": "Upload a file to s3 and create a job. return a job id",
+ "operationId": "upload_file_api_parsing_upload_post",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
{
"name": "organization_id",
"in": "query",
@@ -14819,6 +15966,23 @@
"title": "Organization Id"
}
},
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -14884,6 +16048,23 @@
}
],
"parameters": [
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -15082,6 +16263,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -15340,6 +16538,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -15598,6 +16813,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -15728,6 +16960,23 @@
"title": "Job Id"
}
},
+ {
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -16179,7 +17428,7 @@
},
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"description": "Chunk size for the transformation.",
"default": 1024
@@ -16205,8 +17454,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -16263,7 +17512,7 @@
"type": "number",
"title": "Timeout",
"description": "Timeout for each request.",
- "default": 60.0,
+ "default": 60,
"gte": 0
},
"default_headers": {
@@ -16349,11 +17598,6 @@
"type": "object",
"title": "AzureOpenAIEmbeddingConfig"
},
- "Base": {
- "properties": {},
- "type": "object",
- "title": "Base"
- },
"BaseConnectionValidation": {
"properties": {
"success": {
@@ -16441,8 +17685,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -16521,7 +17765,7 @@
},
"max_retries": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Max Retries",
"description": "The maximum number of API retries.",
"default": 10
@@ -16530,7 +17774,7 @@
"type": "number",
"title": "Timeout",
"description": "The timeout for the Bedrock API request in seconds. It will be used for both connect and read timeouts.",
- "default": 60.0
+ "default": 60
},
"additional_kwargs": {
"type": "object",
@@ -16574,9 +17818,28 @@
"title": "Template Text"
},
"template_instructions": {
- "type": "string",
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Template Instructions"
},
+ "existing_retriever_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Existing Retriever Id"
+ },
"files": {
"items": {
"type": "string",
@@ -16586,8 +17849,15 @@
"title": "Files"
},
"template_file": {
- "type": "string",
- "format": "binary",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "binary"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Template File"
}
},
@@ -16607,6 +17877,388 @@
"required": ["upload_file"],
"title": "Body_import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put"
},
+ "Body_run_job_test_user_api_v1_extractionv2_jobs_test_post": {
+ "properties": {
+ "job_create": {
+ "$ref": "#/components/schemas/ExtractJobCreate"
+ },
+ "extract_settings": {
+ "$ref": "#/components/schemas/LlamaExtractSettings",
+ "default": {
+ "max_file_size": 5242880,
+ "max_tokens": 128000,
+ "max_pages": 200,
+ "chunk_mode": "PAGE",
+ "max_chunk_size": 5000,
+ "extraction_agent_config": {
+ "default": {
+ "model": "gpt-4o",
+ "temperature": 0,
+ "relaxation_mode": "LEAF",
+ "struct_mode": "STRUCT_PARSE",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nGiven a JSON schema, extract the data from the provided text according to the schema.\nOnly output the data as given in the text, nothing else.\n"
+ }
+ },
+ "mapper": {
+ "model": "gpt-4o",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nYou are an expert data analyst. Extract the data from the text according to the schema.\n1. Only extract from the data that is provided in the text. \n2. Only output the JSON keys that have non-null values.\n"
+ },
+ "relaxation_mode": "FULL",
+ "struct_mode": "JSON_MODE",
+ "temperature": 0
+ },
+ "reducer": {
+ "model": "gpt-4o",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nYou are an expert data analyst. You are given a list of JSON objects that\ncontain partial extracted information from a source document along with (i) index \nindicating the order of the extracted information from the source document and \n(ii) (start_page, end_page) indicating the range of pages that the information \nwas extracted from. \n\nCombine this data to answer the question in the provided JSON template.\n- **Only** use the data that is provided in the text.\n- If using a tool, make only a single tool call.\n- There might be multiple sources with the same information. Aim to combine the data\n without duplicating information.\n- Take the index and page number into account when combining the data, e.g. if some \n information needs to be combined from multiple pages, use the index and page \n number to determine the order of the data.\n"
+ },
+ "relaxation_mode": "LEAF",
+ "struct_mode": "FUNC_CALL",
+ "temperature": 0
+ }
+ },
+ "llama_parse_params": {
+ "annotate_links": true,
+ "auto_mode": false,
+ "auto_mode_trigger_on_image_in_page": false,
+ "auto_mode_trigger_on_table_in_page": false,
+ "bounding_box": "",
+ "continuous_mode": false,
+ "disable_image_extraction": false,
+ "disable_ocr": false,
+ "disable_reconstruction": false,
+ "do_not_cache": false,
+ "do_not_unroll_columns": false,
+ "extract_charts": false,
+ "extract_layout": false,
+ "fast_mode": false,
+ "gpt4o_api_key": "",
+ "gpt4o_mode": false,
+ "guess_xlsx_sheet_name": false,
+ "html_make_all_elements_visible": false,
+ "html_remove_fixed_elements": false,
+ "html_remove_navigation_elements": false,
+ "ignore_document_elements_for_layout_detection": false,
+ "input_s3_region": "",
+ "internal_is_screenshot_job": false,
+ "invalidate_cache": false,
+ "is_formatting_instruction": true,
+ "languages": ["en"],
+ "output_pdf_of_document": false,
+ "output_s3_region": "",
+ "output_tables_as_HTML": false,
+ "page_prefix": "",
+ "page_suffix": "",
+ "parsing_instruction": "",
+ "premium_mode": false,
+ "preserve_layout_alignment_across_pages": false,
+ "s3_input_path": "",
+ "s3_output_path_prefix": "",
+ "skip_diagonal_text": false,
+ "spreadsheet_extract_sub_tables": false,
+ "strict_mode_buggy_font": false,
+ "strict_mode_image_extraction": false,
+ "strict_mode_image_ocr": false,
+ "strict_mode_reconstruction": false,
+ "structured_output": false,
+ "take_screenshot": false,
+ "target_pages": "",
+ "use_vendor_multimodal_model": false,
+ "vendor_multimodal_api_key": "",
+ "vendor_multimodal_model_name": "",
+ "webhook_url": ""
+ }
+ }
+ }
+ },
+ "type": "object",
+ "required": ["job_create"],
+ "title": "Body_run_job_test_user_api_v1_extractionv2_jobs_test_post"
+ },
+ "Body_run_job_with_parsed_file_test_api_v1_extractionv2_jobs_parsed_test_post": {
+ "properties": {
+ "job_create": {
+ "$ref": "#/components/schemas/ExtractJobCreate"
+ },
+ "extract_settings": {
+ "$ref": "#/components/schemas/LlamaExtractSettings",
+ "default": {
+ "max_file_size": 5242880,
+ "max_tokens": 128000,
+ "max_pages": 200,
+ "chunk_mode": "PAGE",
+ "max_chunk_size": 5000,
+ "extraction_agent_config": {
+ "default": {
+ "model": "gpt-4o",
+ "temperature": 0,
+ "relaxation_mode": "LEAF",
+ "struct_mode": "STRUCT_PARSE",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nGiven a JSON schema, extract the data from the provided text according to the schema.\nOnly output the data as given in the text, nothing else.\n"
+ }
+ },
+ "mapper": {
+ "model": "gpt-4o",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nYou are an expert data analyst. Extract the data from the text according to the schema.\n1. Only extract from the data that is provided in the text. \n2. Only output the JSON keys that have non-null values.\n"
+ },
+ "relaxation_mode": "FULL",
+ "struct_mode": "JSON_MODE",
+ "temperature": 0
+ },
+ "reducer": {
+ "model": "gpt-4o",
+ "prompt_conf": {
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field.",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "system_prompt": "\nYou are an expert data analyst. You are given a list of JSON objects that\ncontain partial extracted information from a source document along with (i) index \nindicating the order of the extracted information from the source document and \n(ii) (start_page, end_page) indicating the range of pages that the information \nwas extracted from. \n\nCombine this data to answer the question in the provided JSON template.\n- **Only** use the data that is provided in the text.\n- If using a tool, make only a single tool call.\n- There might be multiple sources with the same information. Aim to combine the data\n without duplicating information.\n- Take the index and page number into account when combining the data, e.g. if some \n information needs to be combined from multiple pages, use the index and page \n number to determine the order of the data.\n"
+ },
+ "relaxation_mode": "LEAF",
+ "struct_mode": "FUNC_CALL",
+ "temperature": 0
+ }
+ },
+ "llama_parse_params": {
+ "annotate_links": true,
+ "auto_mode": false,
+ "auto_mode_trigger_on_image_in_page": false,
+ "auto_mode_trigger_on_table_in_page": false,
+ "bounding_box": "",
+ "continuous_mode": false,
+ "disable_image_extraction": false,
+ "disable_ocr": false,
+ "disable_reconstruction": false,
+ "do_not_cache": false,
+ "do_not_unroll_columns": false,
+ "extract_charts": false,
+ "extract_layout": false,
+ "fast_mode": false,
+ "gpt4o_api_key": "",
+ "gpt4o_mode": false,
+ "guess_xlsx_sheet_name": false,
+ "html_make_all_elements_visible": false,
+ "html_remove_fixed_elements": false,
+ "html_remove_navigation_elements": false,
+ "ignore_document_elements_for_layout_detection": false,
+ "input_s3_region": "",
+ "internal_is_screenshot_job": false,
+ "invalidate_cache": false,
+ "is_formatting_instruction": true,
+ "languages": ["en"],
+ "output_pdf_of_document": false,
+ "output_s3_region": "",
+ "output_tables_as_HTML": false,
+ "page_prefix": "",
+ "page_suffix": "",
+ "parsing_instruction": "",
+ "premium_mode": false,
+ "preserve_layout_alignment_across_pages": false,
+ "s3_input_path": "",
+ "s3_output_path_prefix": "",
+ "skip_diagonal_text": false,
+ "spreadsheet_extract_sub_tables": false,
+ "strict_mode_buggy_font": false,
+ "strict_mode_image_extraction": false,
+ "strict_mode_image_ocr": false,
+ "strict_mode_reconstruction": false,
+ "structured_output": false,
+ "take_screenshot": false,
+ "target_pages": "",
+ "use_vendor_multimodal_model": false,
+ "vendor_multimodal_api_key": "",
+ "vendor_multimodal_model_name": "",
+ "webhook_url": ""
+ }
+ }
+ }
+ },
+ "type": "object",
+ "required": ["job_create"],
+ "title": "Body_run_job_with_parsed_file_test_api_v1_extractionv2_jobs_parsed_test_post"
+ },
+ "Body_screenshot_api_parsing_screenshot_post": {
+ "properties": {
+ "file": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "binary"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File"
+ },
+ "do_not_cache": {
+ "type": "boolean",
+ "title": "Do Not Cache",
+ "default": false
+ },
+ "http_proxy": {
+ "type": "string",
+ "title": "Http Proxy"
+ },
+ "input_s3_path": {
+ "type": "string",
+ "title": "Input S3 Path",
+ "default": ""
+ },
+ "input_s3_region": {
+ "type": "string",
+ "title": "Input S3 Region",
+ "default": ""
+ },
+ "input_url": {
+ "type": "string",
+ "title": "Input Url"
+ },
+ "invalidate_cache": {
+ "type": "boolean",
+ "title": "Invalidate Cache",
+ "default": false
+ },
+ "max_pages": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Pages"
+ },
+ "output_s3_path_prefix": {
+ "type": "string",
+ "title": "Output S3 Path Prefix",
+ "default": ""
+ },
+ "output_s3_region": {
+ "type": "string",
+ "title": "Output S3 Region",
+ "default": ""
+ },
+ "target_pages": {
+ "type": "string",
+ "title": "Target Pages",
+ "default": ""
+ },
+ "webhook_url": {
+ "type": "string",
+ "title": "Webhook Url",
+ "default": ""
+ },
+ "job_timeout_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout In Seconds"
+ },
+ "job_timeout_extra_time_per_page_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout Extra Time Per Page In Seconds"
+ }
+ },
+ "type": "object",
+ "title": "Body_screenshot_api_parsing_screenshot_post"
+ },
+ "Body_screenshot_api_v1_parsing_screenshot_post": {
+ "properties": {
+ "file": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "binary"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File"
+ },
+ "do_not_cache": {
+ "type": "boolean",
+ "title": "Do Not Cache",
+ "default": false
+ },
+ "http_proxy": {
+ "type": "string",
+ "title": "Http Proxy"
+ },
+ "input_s3_path": {
+ "type": "string",
+ "title": "Input S3 Path",
+ "default": ""
+ },
+ "input_s3_region": {
+ "type": "string",
+ "title": "Input S3 Region",
+ "default": ""
+ },
+ "input_url": {
+ "type": "string",
+ "title": "Input Url"
+ },
+ "invalidate_cache": {
+ "type": "boolean",
+ "title": "Invalidate Cache",
+ "default": false
+ },
+ "max_pages": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Pages"
+ },
+ "output_s3_path_prefix": {
+ "type": "string",
+ "title": "Output S3 Path Prefix",
+ "default": ""
+ },
+ "output_s3_region": {
+ "type": "string",
+ "title": "Output S3 Region",
+ "default": ""
+ },
+ "target_pages": {
+ "type": "string",
+ "title": "Target Pages",
+ "default": ""
+ },
+ "webhook_url": {
+ "type": "string",
+ "title": "Webhook Url",
+ "default": ""
+ },
+ "job_timeout_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout In Seconds"
+ },
+ "job_timeout_extra_time_per_page_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout Extra Time Per Page In Seconds"
+ }
+ },
+ "type": "object",
+ "title": "Body_screenshot_api_v1_parsing_screenshot_post"
+ },
"Body_upload_file_api_parsing_upload_post": {
"properties": {
"file": {
@@ -16681,11 +18333,6 @@
"type": "number",
"title": "Bbox Top"
},
- "continuous_mode": {
- "type": "boolean",
- "title": "Continuous Mode",
- "default": false
- },
"disable_ocr": {
"type": "boolean",
"title": "Disable Ocr",
@@ -16716,11 +18363,6 @@
"title": "Extract Charts",
"default": false
},
- "fast_mode": {
- "type": "boolean",
- "title": "Fast Mode",
- "default": false
- },
"guess_xlsx_sheet_name": {
"type": "boolean",
"title": "Guess Xlsx Sheet Name",
@@ -16750,19 +18392,19 @@
"title": "Input S3 Path",
"default": ""
},
+ "input_s3_region": {
+ "type": "string",
+ "title": "Input S3 Region",
+ "default": ""
+ },
"input_url": {
"type": "string",
"title": "Input Url"
},
"invalidate_cache": {
"type": "boolean",
- "title": "Invalidate Cache",
- "default": false
- },
- "is_formatting_instruction": {
- "type": "boolean",
- "title": "Is Formatting Instruction",
- "default": true
+ "title": "Invalidate Cache",
+ "default": false
},
"language": {
"items": {
@@ -16798,6 +18440,11 @@
"title": "Output S3 Path Prefix",
"default": ""
},
+ "output_s3_region": {
+ "type": "string",
+ "title": "Output S3 Region",
+ "default": ""
+ },
"page_prefix": {
"type": "string",
"title": "Page Prefix",
@@ -16812,14 +18459,9 @@
"title": "Page Suffix",
"default": ""
},
- "parsing_instruction": {
- "type": "string",
- "title": "Parsing Instruction",
- "default": ""
- },
- "premium_mode": {
+ "preserve_layout_alignment_across_pages": {
"type": "boolean",
- "title": "Premium Mode",
+ "title": "Preserve Layout Alignment Across Pages",
"default": false
},
"skip_diagonal_text": {
@@ -16827,6 +18469,11 @@
"title": "Skip Diagonal Text",
"default": false
},
+ "spreadsheet_extract_sub_tables": {
+ "type": "boolean",
+ "title": "Spreadsheet Extract Sub Tables",
+ "default": true
+ },
"structured_output": {
"type": "boolean",
"title": "Structured Output",
@@ -16850,11 +18497,6 @@
"title": "Target Pages",
"default": ""
},
- "use_vendor_multimodal_model": {
- "type": "boolean",
- "title": "Use Vendor Multimodal Model",
- "default": false
- },
"vendor_multimodal_api_key": {
"type": "string",
"title": "Vendor Multimodal Api Key",
@@ -16869,6 +18511,74 @@
"title": "Webhook Url",
"default": ""
},
+ "parse_mode": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ParsingMode"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "system_prompt": {
+ "type": "string",
+ "title": "System Prompt",
+ "default": ""
+ },
+ "system_prompt_append": {
+ "type": "string",
+ "title": "System Prompt Append",
+ "default": ""
+ },
+ "user_prompt": {
+ "type": "string",
+ "title": "User Prompt",
+ "default": ""
+ },
+ "job_timeout_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout In Seconds"
+ },
+ "job_timeout_extra_time_per_page_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout Extra Time Per Page In Seconds"
+ },
+ "strict_mode_image_extraction": {
+ "type": "boolean",
+ "title": "Strict Mode Image Extraction",
+ "default": false
+ },
+ "strict_mode_image_ocr": {
+ "type": "boolean",
+ "title": "Strict Mode Image Ocr",
+ "default": false
+ },
+ "strict_mode_reconstruction": {
+ "type": "boolean",
+ "title": "Strict Mode Reconstruction",
+ "default": false
+ },
+ "strict_mode_buggy_font": {
+ "type": "boolean",
+ "title": "Strict Mode Buggy Font",
+ "default": false
+ },
+ "ignore_document_elements_for_layout_detection": {
+ "type": "boolean",
+ "title": "Ignore Document Elements For Layout Detection",
+ "default": false
+ },
+ "output_tables_as_HTML": {
+ "type": "boolean",
+ "title": "Output Tables As Html",
+ "default": false
+ },
+ "use_vendor_multimodal_model": {
+ "type": "boolean",
+ "title": "Use Vendor Multimodal Model",
+ "default": false
+ },
"bounding_box": {
"type": "string",
"title": "Bounding Box",
@@ -16883,6 +18593,43 @@
"type": "string",
"title": "Gpt4O Api Key",
"default": ""
+ },
+ "complemental_formatting_instruction": {
+ "type": "string",
+ "title": "Complemental Formatting Instruction"
+ },
+ "content_guideline_instruction": {
+ "type": "string",
+ "title": "Content Guideline Instruction"
+ },
+ "premium_mode": {
+ "type": "boolean",
+ "title": "Premium Mode",
+ "default": false
+ },
+ "is_formatting_instruction": {
+ "type": "boolean",
+ "title": "Is Formatting Instruction",
+ "default": true
+ },
+ "continuous_mode": {
+ "type": "boolean",
+ "title": "Continuous Mode",
+ "default": false
+ },
+ "parsing_instruction": {
+ "type": "string",
+ "title": "Parsing Instruction",
+ "default": ""
+ },
+ "fast_mode": {
+ "type": "boolean",
+ "title": "Fast Mode",
+ "default": false
+ },
+ "formatting_instruction": {
+ "type": "string",
+ "title": "Formatting Instruction"
}
},
"type": "object",
@@ -16974,11 +18721,6 @@
"type": "number",
"title": "Bbox Top"
},
- "continuous_mode": {
- "type": "boolean",
- "title": "Continuous Mode",
- "default": false
- },
"disable_ocr": {
"type": "boolean",
"title": "Disable Ocr",
@@ -17009,11 +18751,6 @@
"title": "Extract Charts",
"default": false
},
- "fast_mode": {
- "type": "boolean",
- "title": "Fast Mode",
- "default": false
- },
"guess_xlsx_sheet_name": {
"type": "boolean",
"title": "Guess Xlsx Sheet Name",
@@ -17043,6 +18780,11 @@
"title": "Input S3 Path",
"default": ""
},
+ "input_s3_region": {
+ "type": "string",
+ "title": "Input S3 Region",
+ "default": ""
+ },
"input_url": {
"type": "string",
"title": "Input Url"
@@ -17052,11 +18794,6 @@
"title": "Invalidate Cache",
"default": false
},
- "is_formatting_instruction": {
- "type": "boolean",
- "title": "Is Formatting Instruction",
- "default": true
- },
"language": {
"items": {
"$ref": "#/components/schemas/ParserLanguages"
@@ -17091,6 +18828,11 @@
"title": "Output S3 Path Prefix",
"default": ""
},
+ "output_s3_region": {
+ "type": "string",
+ "title": "Output S3 Region",
+ "default": ""
+ },
"page_prefix": {
"type": "string",
"title": "Page Prefix",
@@ -17105,14 +18847,9 @@
"title": "Page Suffix",
"default": ""
},
- "parsing_instruction": {
- "type": "string",
- "title": "Parsing Instruction",
- "default": ""
- },
- "premium_mode": {
+ "preserve_layout_alignment_across_pages": {
"type": "boolean",
- "title": "Premium Mode",
+ "title": "Preserve Layout Alignment Across Pages",
"default": false
},
"skip_diagonal_text": {
@@ -17120,6 +18857,11 @@
"title": "Skip Diagonal Text",
"default": false
},
+ "spreadsheet_extract_sub_tables": {
+ "type": "boolean",
+ "title": "Spreadsheet Extract Sub Tables",
+ "default": true
+ },
"structured_output": {
"type": "boolean",
"title": "Structured Output",
@@ -17143,11 +18885,6 @@
"title": "Target Pages",
"default": ""
},
- "use_vendor_multimodal_model": {
- "type": "boolean",
- "title": "Use Vendor Multimodal Model",
- "default": false
- },
"vendor_multimodal_api_key": {
"type": "string",
"title": "Vendor Multimodal Api Key",
@@ -17162,6 +18899,74 @@
"title": "Webhook Url",
"default": ""
},
+ "parse_mode": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ParsingMode"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "system_prompt": {
+ "type": "string",
+ "title": "System Prompt",
+ "default": ""
+ },
+ "system_prompt_append": {
+ "type": "string",
+ "title": "System Prompt Append",
+ "default": ""
+ },
+ "user_prompt": {
+ "type": "string",
+ "title": "User Prompt",
+ "default": ""
+ },
+ "job_timeout_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout In Seconds"
+ },
+ "job_timeout_extra_time_per_page_in_seconds": {
+ "type": "number",
+ "title": "Job Timeout Extra Time Per Page In Seconds"
+ },
+ "strict_mode_image_extraction": {
+ "type": "boolean",
+ "title": "Strict Mode Image Extraction",
+ "default": false
+ },
+ "strict_mode_image_ocr": {
+ "type": "boolean",
+ "title": "Strict Mode Image Ocr",
+ "default": false
+ },
+ "strict_mode_reconstruction": {
+ "type": "boolean",
+ "title": "Strict Mode Reconstruction",
+ "default": false
+ },
+ "strict_mode_buggy_font": {
+ "type": "boolean",
+ "title": "Strict Mode Buggy Font",
+ "default": false
+ },
+ "ignore_document_elements_for_layout_detection": {
+ "type": "boolean",
+ "title": "Ignore Document Elements For Layout Detection",
+ "default": false
+ },
+ "output_tables_as_HTML": {
+ "type": "boolean",
+ "title": "Output Tables As Html",
+ "default": false
+ },
+ "use_vendor_multimodal_model": {
+ "type": "boolean",
+ "title": "Use Vendor Multimodal Model",
+ "default": false
+ },
"bounding_box": {
"type": "string",
"title": "Bounding Box",
@@ -17176,6 +18981,43 @@
"type": "string",
"title": "Gpt4O Api Key",
"default": ""
+ },
+ "complemental_formatting_instruction": {
+ "type": "string",
+ "title": "Complemental Formatting Instruction"
+ },
+ "content_guideline_instruction": {
+ "type": "string",
+ "title": "Content Guideline Instruction"
+ },
+ "premium_mode": {
+ "type": "boolean",
+ "title": "Premium Mode",
+ "default": false
+ },
+ "is_formatting_instruction": {
+ "type": "boolean",
+ "title": "Is Formatting Instruction",
+ "default": true
+ },
+ "continuous_mode": {
+ "type": "boolean",
+ "title": "Continuous Mode",
+ "default": false
+ },
+ "parsing_instruction": {
+ "type": "string",
+ "title": "Parsing Instruction",
+ "default": ""
+ },
+ "fast_mode": {
+ "type": "boolean",
+ "title": "Fast Mode",
+ "default": false
+ },
+ "formatting_instruction": {
+ "type": "string",
+ "title": "Formatting Instruction"
}
},
"type": "object",
@@ -17190,7 +19032,7 @@
"properties": {
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"default": 1024
},
@@ -17241,14 +19083,14 @@
},
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"description": "The token chunk size for each chunk.",
"default": 1024
},
"chunk_overlap": {
"type": "integer",
- "minimum": 0.0,
+ "minimum": 0,
"title": "Chunk Overlap",
"description": "The token overlap of each chunk when splitting.",
"default": 200
@@ -17274,100 +19116,200 @@
"type": "null"
}
],
- "title": "Secondary Chunking Regex",
- "description": "Backup regex for splitting into sentences.",
- "default": "[^,.;。？ï¼]+[,.;。？ï¼]?"
- },
- "class_name": {
- "type": "string",
- "title": "Class Name",
- "default": "SentenceSplitter"
- }
- },
- "type": "object",
- "title": "CharacterSplitter",
- "description": "A splitter that splits text into characters."
- },
- "ChatApp": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "pipeline_id": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "title": "Secondary Chunking Regex",
+ "description": "Backup regex for splitting into sentences.",
+ "default": "[^,.;。？ï¼]+[,.;。？ï¼]?"
+ },
+ "class_name": {
+ "type": "string",
+ "title": "Class Name",
+ "default": "SentenceSplitter"
+ }
+ },
+ "type": "object",
+ "title": "CharacterSplitter",
+ "description": "A splitter that splits text into characters."
+ },
+ "ChatApp": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id",
+ "description": "Unique identifier"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At",
+ "description": "Creation datetime"
+ },
+ "updated_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Updated At",
+ "description": "Update datetime"
},
"name": {
"type": "string",
- "title": "Name"
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name",
+ "description": "Name of the chat app"
},
- "project_id": {
+ "retriever_id": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Retriever Id",
+ "description": "ID of the retriever to use for the chat app"
},
"llm_config": {
- "$ref": "#/components/schemas/LLMParameters"
+ "$ref": "#/components/schemas/LLMParameters",
+ "description": "Configuration for the LLM model to use for the chat app"
},
"retrieval_config": {
- "$ref": "#/components/schemas/PresetRetrievalParams"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At"
+ "$ref": "#/components/schemas/PresetCompositeRetrievalParams",
+ "description": "Configuration for the retrieval model to use for the chat app"
},
- "updated_at": {
+ "project_id": {
"type": "string",
- "format": "date-time",
- "title": "Updated At"
+ "format": "uuid",
+ "title": "Project Id",
+ "description": "ID of the project the chat app belongs to"
}
},
"type": "object",
"required": [
"id",
- "pipeline_id",
"name",
- "project_id",
+ "retriever_id",
"llm_config",
"retrieval_config",
- "created_at",
- "updated_at"
+ "project_id"
],
"title": "ChatApp",
"description": "Schema for a chat app"
},
"ChatAppCreate": {
"properties": {
- "pipeline_id": {
+ "name": {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name",
+ "description": "Name of the chat app"
+ },
+ "retriever_id": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Retriever Id",
+ "description": "ID of the retriever to use for the chat app"
},
"llm_config": {
- "$ref": "#/components/schemas/LLMParameters"
+ "$ref": "#/components/schemas/LLMParameters",
+ "description": "Configuration for the LLM model to use for the chat app"
},
"retrieval_config": {
- "$ref": "#/components/schemas/PresetRetrievalParams"
+ "$ref": "#/components/schemas/PresetCompositeRetrievalParams",
+ "description": "Configuration for the retrieval model to use for the chat app"
+ }
+ },
+ "type": "object",
+ "required": ["name", "retriever_id", "llm_config", "retrieval_config"],
+ "title": "ChatAppCreate",
+ "description": "Schema for creating a new chat app"
+ },
+ "ChatAppResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id",
+ "description": "Unique identifier"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At",
+ "description": "Creation datetime"
+ },
+ "updated_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Updated At",
+ "description": "Update datetime"
+ },
+ "name": {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name",
+ "description": "Name of the chat app"
+ },
+ "retriever_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Retriever Id",
+ "description": "ID of the retriever to use for the chat app"
+ },
+ "llm_config": {
+ "$ref": "#/components/schemas/LLMParameters",
+ "description": "Configuration for the LLM model to use for the chat app"
+ },
+ "retrieval_config": {
+ "$ref": "#/components/schemas/PresetCompositeRetrievalParams",
+ "description": "Configuration for the retrieval model to use for the chat app"
},
"project_id": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Project Id",
+ "description": "ID of the project the chat app belongs to"
+ },
+ "retriever_name": {
+ "type": "string",
+ "title": "Retriever Name"
}
},
"type": "object",
"required": [
- "pipeline_id",
+ "id",
+ "name",
+ "retriever_id",
"llm_config",
"retrieval_config",
- "project_id"
+ "project_id",
+ "retriever_name"
],
- "title": "ChatAppCreate",
- "description": "Schema for creating a new chat app"
+ "title": "ChatAppResponse"
},
"ChatAppUpdate": {
"properties": {
@@ -17395,7 +19337,7 @@
"retrieval_config": {
"anyOf": [
{
- "$ref": "#/components/schemas/PresetRetrievalParams"
+ "$ref": "#/components/schemas/PresetCompositeRetrievalParams"
},
{
"type": "null"
@@ -17471,6 +19413,11 @@
"required": ["success_url", "cancel_url"],
"title": "CheckoutSessionCreatePayload"
},
+ "ChunkMode": {
+ "type": "string",
+ "enum": ["PAGE", "DOCUMENT", "SECTION"],
+ "title": "ChunkMode"
+ },
"CloudAzStorageBlobDataSource": {
"properties": {
"supports_access_control": {
@@ -18213,6 +20160,17 @@
],
"title": "Fulltext Index Name"
},
+ "embedding_dimension": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Embedding Dimension"
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -18845,21 +20803,21 @@
},
"chunk_lines": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Lines",
"description": "The number of lines to include in each chunk.",
"default": 40
},
"chunk_lines_overlap": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Lines Overlap",
"description": "How many lines of code each chunk overlaps with.",
"default": 15
},
"max_chars": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Max Chars",
"description": "Maximum number of characters per chunk.",
"default": 1500
@@ -18885,8 +20843,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -18942,29 +20900,178 @@
"class_name": {
"type": "string",
"title": "Class Name",
- "default": "CohereEmbedding"
- }
- },
- "type": "object",
- "required": ["api_key"],
- "title": "CohereEmbedding"
- },
- "CohereEmbeddingConfig": {
- "properties": {
- "type": {
- "type": "string",
- "const": "COHERE_EMBEDDING",
- "title": "Type",
- "description": "Type of the embedding model.",
- "default": "COHERE_EMBEDDING"
- },
- "component": {
- "$ref": "#/components/schemas/CohereEmbedding",
- "description": "Configuration for the Cohere embedding model."
+ "default": "CohereEmbedding"
+ }
+ },
+ "type": "object",
+ "required": ["api_key"],
+ "title": "CohereEmbedding"
+ },
+ "CohereEmbeddingConfig": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "const": "COHERE_EMBEDDING",
+ "title": "Type",
+ "description": "Type of the embedding model.",
+ "default": "COHERE_EMBEDDING"
+ },
+ "component": {
+ "$ref": "#/components/schemas/CohereEmbedding",
+ "description": "Configuration for the Cohere embedding model."
+ }
+ },
+ "type": "object",
+ "title": "CohereEmbeddingConfig"
+ },
+ "CompositeRetrievalMode": {
+ "type": "string",
+ "enum": ["routing", "full"],
+ "title": "CompositeRetrievalMode",
+ "description": "Enum for the mode of composite retrieval."
+ },
+ "CompositeRetrievalParams": {
+ "properties": {
+ "mode": {
+ "$ref": "#/components/schemas/CompositeRetrievalMode",
+ "description": "The mode of composite retrieval.",
+ "default": "full"
+ },
+ "rerank_top_n": {
+ "type": "integer",
+ "title": "Rerank Top N",
+ "description": "The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.",
+ "default": 6
+ },
+ "query": {
+ "type": "string",
+ "title": "Query",
+ "description": "The query to retrieve against."
+ }
+ },
+ "type": "object",
+ "required": ["query"],
+ "title": "CompositeRetrievalParams"
+ },
+ "CompositeRetrievalResult": {
+ "properties": {
+ "nodes": {
+ "items": {
+ "$ref": "#/components/schemas/CompositeRetrievedTextNodeWithScore"
+ },
+ "type": "array",
+ "title": "Nodes",
+ "description": "The retrieved nodes from the composite retrieval."
+ },
+ "image_nodes": {
+ "items": {
+ "$ref": "#/components/schemas/PageScreenshotNodeWithScore"
+ },
+ "type": "array",
+ "title": "Image Nodes",
+ "description": "The image nodes retrieved by the pipeline for the given query."
+ }
+ },
+ "type": "object",
+ "title": "CompositeRetrievalResult"
+ },
+ "CompositeRetrievedTextNode": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id",
+ "description": "The ID of the retrieved node."
+ },
+ "retriever_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Retriever Id",
+ "description": "The ID of the retriever this node was retrieved from."
+ },
+ "retriever_pipeline_name": {
+ "type": "string",
+ "title": "Retriever Pipeline Name",
+ "description": "The name of the retrieval pipeline this node was retrieved from."
+ },
+ "pipeline_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id",
+ "description": "The ID of the pipeline this node was retrieved from."
+ },
+ "metadata": {
+ "type": "object",
+ "title": "Metadata",
+ "description": "Metadata associated with the retrieved node."
+ },
+ "text": {
+ "type": "string",
+ "title": "Text",
+ "description": "The text of the retrieved node."
+ },
+ "start_char_idx": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Char Idx",
+ "description": "The start character index of the retrieved node in the document"
+ },
+ "end_char_idx": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "End Char Idx",
+ "description": "The end character index of the retrieved node in the document"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "retriever_id",
+ "retriever_pipeline_name",
+ "pipeline_id",
+ "text",
+ "start_char_idx",
+ "end_char_idx"
+ ],
+ "title": "CompositeRetrievedTextNode"
+ },
+ "CompositeRetrievedTextNodeWithScore": {
+ "properties": {
+ "node": {
+ "$ref": "#/components/schemas/CompositeRetrievedTextNode"
+ },
+ "score": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Score"
+ },
+ "class_name": {
+ "type": "string",
+ "title": "Class Name",
+ "default": "CompositeRetrievedTextNodeWithScore"
}
},
"type": "object",
- "title": "CohereEmbeddingConfig"
+ "required": ["node"],
+ "title": "CompositeRetrievedTextNodeWithScore"
},
"ConfigurableDataSinkNames": {
"type": "string",
@@ -19085,6 +21192,28 @@
"title": "ConfiguredTransformationItem",
"description": "Configured transformations for pipelines.\n\nSimilar to ConfigurableTransformation but includes a few\nmore fields that are useful to the platform."
},
+ "CreateIntentAndCustomerSessionResponse": {
+ "properties": {
+ "client_secret": {
+ "type": "string",
+ "title": "Client Secret"
+ },
+ "customer_session_client_secret": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Customer Session Client Secret"
+ }
+ },
+ "type": "object",
+ "required": ["client_secret", "customer_session_client_secret"],
+ "title": "CreateIntentAndCustomerSessionResponse"
+ },
"CustomerPortalSessionCreatePayload": {
"properties": {
"return_url": {
@@ -19664,24 +21793,30 @@
"type": "string",
"title": "Justification"
},
- "start_line": {
- "type": "integer",
- "title": "Start Line"
- },
- "end_line": {
- "type": "integer",
- "title": "End Line"
- },
"blocks": {
"items": {
- "$ref": "#/components/schemas/ReportBlock"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ReportBlock"
+ },
+ {
+ "$ref": "#/components/schemas/ReportPlanBlock"
+ }
+ ]
},
"type": "array",
"title": "Blocks"
+ },
+ "removed_indices": {
+ "items": {
+ "type": "integer"
+ },
+ "type": "array",
+ "title": "Removed Indices"
}
},
"type": "object",
- "required": ["justification", "start_line", "end_line", "blocks"],
+ "required": ["justification", "blocks"],
"title": "EditSuggestion",
"description": "A suggestion for an edit to a report."
},
@@ -20187,13 +22322,12 @@
},
"data": {
"anyOf": [
- {
- "$ref": "#/components/schemas/Base"
- },
+ {},
{
"type": "null"
}
],
+ "title": "Data",
"description": "Additional metadata for the job execution."
}
},
@@ -20529,33 +22663,40 @@
"description": "The name of the extraction schema"
},
"data_schema": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
},
- {
- "type": "null"
- }
- ]
- },
- "type": "object",
+ "type": "object"
+ },
+ {
+ "type": "string"
+ }
+ ],
"title": "Data Schema",
"description": "The schema of the data."
},
@@ -20572,33 +22713,40 @@
"ExtractAgentUpdate": {
"properties": {
"data_schema": {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "object"
- },
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
},
- {
- "type": "null"
- }
- ]
- },
- "type": "object",
+ "type": "object"
+ },
+ {
+ "type": "string"
+ }
+ ],
"title": "Data Schema",
"description": "The schema of the data"
},
@@ -20614,10 +22762,15 @@
},
"ExtractConfig": {
"properties": {
+ "extraction_target": {
+ "$ref": "#/components/schemas/ExtractTarget",
+ "description": "The extraction target specified.",
+ "default": "PER_DOC"
+ },
"extraction_mode": {
"$ref": "#/components/schemas/ExtractMode",
"description": "The extraction mode specified.",
- "default": "PER_DOC"
+ "default": "ACCURATE"
},
"handle_missing": {
"type": "boolean",
@@ -20650,17 +22803,33 @@
"title": "Id",
"description": "The id of the extraction job"
},
+ "extraction_agent": {
+ "$ref": "#/components/schemas/ExtractAgent",
+ "description": "The agent that the job was run on."
+ },
"status": {
"$ref": "#/components/schemas/StatusEnum",
"description": "The status of the extraction job"
},
+ "error": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error",
+ "description": "The error that occurred during extraction"
+ },
"file": {
"$ref": "#/components/schemas/File",
"description": "The file that the extract was extracted from"
}
},
"type": "object",
- "required": ["id", "status", "file"],
+ "required": ["id", "extraction_agent", "status", "file"],
"title": "ExtractJob"
},
"ExtractJobCreate": {
@@ -20708,6 +22877,9 @@
},
"type": "object"
},
+ {
+ "type": "string"
+ },
{
"type": "null"
}
@@ -20732,68 +22904,18 @@
"title": "ExtractJobCreate",
"description": "Schema for creating an extraction job."
},
- "ExtractJobCreateBatch": {
- "properties": {
- "extraction_agent_id": {
- "type": "string",
- "format": "uuid",
- "title": "Extraction Agent Id",
- "description": "The id of the extraction agent"
- },
- "file_ids": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "minItems": 1,
- "title": "File Ids",
- "description": "The ids of the files"
- }
- },
- "type": "object",
- "required": ["extraction_agent_id", "file_ids"],
- "title": "ExtractJobCreateBatch",
- "description": "Schema for creating extraction jobs in batch."
- },
- "ExtractMode": {
- "type": "string",
- "enum": ["PER_DOC", "PER_PAGE"],
- "title": "ExtractMode"
- },
- "ExtractResultset": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "Unique identifier"
- },
- "created_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created At",
- "description": "Creation datetime"
- },
- "updated_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Updated At",
- "description": "Update datetime"
+ "ExtractMode": {
+ "type": "string",
+ "enum": ["FAST", "ACCURATE"],
+ "title": "ExtractMode"
+ },
+ "ExtractResultset": {
+ "properties": {
+ "run_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Run Id",
+ "description": "The id of the extraction run"
},
"extraction_agent_id": {
"type": "string",
@@ -20901,95 +23023,25 @@
"type": "object",
"title": "Extraction Metadata",
"description": "The metadata extracted from the file"
- },
- "file": {
- "$ref": "#/components/schemas/File",
- "description": "The file that the extract was extracted from"
}
},
"type": "object",
"required": [
- "id",
+ "run_id",
"extraction_agent_id",
"data",
- "extraction_metadata",
- "file"
+ "extraction_metadata"
],
"title": "ExtractResultset",
- "description": "Schema for an extraction result."
- },
- "ExtractionJob": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "The id of the extraction job"
- },
- "status": {
- "$ref": "#/components/schemas/StatusEnum",
- "description": "The status of the extraction job"
- },
- "file": {
- "$ref": "#/components/schemas/File",
- "description": "The file that the extract was extracted from"
- }
- },
- "type": "object",
- "required": ["id", "status", "file"],
- "title": "ExtractionJob"
- },
- "ExtractionJobCreate": {
- "properties": {
- "schema_id": {
- "type": "string",
- "format": "uuid",
- "title": "Schema Id",
- "description": "The id of the schema"
- },
- "file_id": {
- "type": "string",
- "format": "uuid",
- "title": "File Id",
- "description": "The id of the file"
- }
- },
- "type": "object",
- "required": ["schema_id", "file_id"],
- "title": "ExtractionJobCreate",
- "description": "Schema for creating an extraction job."
- },
- "ExtractionJobCreateBatch": {
- "properties": {
- "schema_id": {
- "type": "string",
- "format": "uuid",
- "title": "Schema Id",
- "description": "The id of the schema"
- },
- "file_ids": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "minItems": 1,
- "title": "File Ids",
- "description": "The ids of the files"
- }
- },
- "type": "object",
- "required": ["schema_id", "file_ids"],
- "title": "ExtractionJobCreateBatch",
- "description": "Schema for creating extraction jobs in batch."
+ "description": "Schema for an extraction resultset."
},
- "ExtractionResult": {
+ "ExtractRun": {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id",
- "description": "Unique identifier"
+ "description": "The id of the extraction run"
},
"created_at": {
"anyOf": [
@@ -21017,13 +23069,13 @@
"title": "Updated At",
"description": "Update datetime"
},
- "schema_id": {
+ "extraction_agent_id": {
"type": "string",
"format": "uuid",
- "title": "Schema Id",
- "description": "The id of the schema"
+ "title": "Extraction Agent Id",
+ "description": "The id of the extraction agent"
},
- "data": {
+ "data_schema": {
"additionalProperties": {
"anyOf": [
{
@@ -21051,65 +23103,47 @@
]
},
"type": "object",
- "title": "Data",
- "description": "The data extracted from the file"
+ "title": "Data Schema",
+ "description": "The schema used for extraction"
+ },
+ "config": {
+ "$ref": "#/components/schemas/ExtractConfig",
+ "description": "The config used for extraction"
},
"file": {
"$ref": "#/components/schemas/File",
"description": "The file that the extract was extracted from"
- }
- },
- "type": "object",
- "required": ["id", "schema_id", "data", "file"],
- "title": "ExtractionResult",
- "description": "Schema for an extraction result."
- },
- "ExtractionSchema": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "Unique identifier"
},
- "created_at": {
+ "status": {
+ "$ref": "#/components/schemas/ExtractState",
+ "description": "The status of the extraction run"
+ },
+ "error": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Created At",
- "description": "Creation datetime"
+ "title": "Error",
+ "description": "The error that occurred during extraction"
},
- "updated_at": {
+ "job_id": {
"anyOf": [
{
"type": "string",
- "format": "date-time"
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Updated At",
- "description": "Update datetime"
- },
- "name": {
- "type": "string",
- "title": "Name",
- "description": "The name of the extraction schema"
- },
- "project_id": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id",
- "description": "The ID of the project that the extraction schema belongs to"
+ "title": "Job Id",
+ "description": "The id of the job that the extraction run belongs to"
},
- "data_schema": {
+ "data": {
"anyOf": [
{
"additionalProperties": {
@@ -21141,135 +23175,96 @@
"type": "object"
},
{
- "type": "null"
- }
- ],
- "title": "Data Schema",
- "description": "The schema of the data"
- }
- },
- "type": "object",
- "required": ["id", "name", "project_id"],
- "title": "ExtractionSchema",
- "description": "Schema for extraction schema."
- },
- "ExtractionSchemaCreate": {
- "properties": {
- "name": {
- "type": "string",
- "maxLength": 3000,
- "minLength": 1,
- "title": "Name",
- "description": "The name of the extraction schema"
- },
- "project_id": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id",
- "description": "The ID of the project that the extraction schema belongs to"
- },
- "data_schema": {
- "additionalProperties": {
- "anyOf": [
- {
+ "items": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
"type": "object"
},
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ]
- },
- "type": "object",
- "title": "Data Schema",
- "description": "The schema of the data"
- }
- },
- "type": "object",
- "required": ["name", "data_schema"],
- "title": "ExtractionSchemaCreate",
- "description": "Schema for creating an extraction schema."
- },
- "ExtractionSchemaInfer": {
- "properties": {
- "schema_id": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Schema Id",
- "description": "The ID of a schema to update with the new schema"
- },
- "name": {
- "type": "string",
- "maxLength": 3000,
- "minLength": 1,
- "title": "Name",
- "description": "The name of the extraction schema"
+ "title": "Data",
+ "description": "The data extracted from the file"
},
- "project_id": {
+ "extraction_metadata": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Id",
- "description": "The ID of the project that the extraction schema belongs to"
- },
- "file_ids": {
- "items": {
- "type": "string",
- "format": "uuid"
- },
- "type": "array",
- "minItems": 1,
- "title": "File Ids",
- "description": "The IDs of the files that the extraction schema contains"
- },
- "stream": {
- "type": "boolean",
- "title": "Stream",
- "description": "Whether to stream the results of the extraction schema",
- "default": false
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Extraction Metadata",
+ "description": "The metadata extracted from the file"
}
},
"type": "object",
- "required": ["name", "file_ids"],
- "title": "ExtractionSchemaInfer",
- "description": "Schema for inferring an extraction schema."
+ "required": [
+ "id",
+ "extraction_agent_id",
+ "data_schema",
+ "config",
+ "file",
+ "status"
+ ],
+ "title": "ExtractRun",
+ "description": "Schema for an extraction run."
},
- "ExtractionSchemaUpdate": {
+ "ExtractSchemaValidateRequest": {
"properties": {
"data_schema": {
"anyOf": [
@@ -21303,16 +23298,62 @@
"type": "object"
},
{
- "type": "null"
+ "type": "string"
}
],
- "title": "Data Schema",
- "description": "The schema of the data"
+ "title": "Data Schema"
+ }
+ },
+ "type": "object",
+ "required": ["data_schema"],
+ "title": "ExtractSchemaValidateRequest"
+ },
+ "ExtractSchemaValidateResponse": {
+ "properties": {
+ "data_schema": {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object",
+ "title": "Data Schema"
}
},
"type": "object",
- "title": "ExtractionSchemaUpdate",
- "description": "Schema for updating an extraction schema."
+ "required": ["data_schema"],
+ "title": "ExtractSchemaValidateResponse"
+ },
+ "ExtractState": {
+ "type": "string",
+ "enum": ["CREATED", "PENDING", "SUCCESS", "ERROR"],
+ "title": "ExtractState"
+ },
+ "ExtractTarget": {
+ "type": "string",
+ "enum": ["PER_DOC", "PER_PAGE"],
+ "title": "ExtractTarget"
},
"File": {
"properties": {
@@ -21363,7 +23404,7 @@
"anyOf": [
{
"type": "integer",
- "minimum": 0.0
+ "minimum": 0
},
{
"type": "null"
@@ -21524,7 +23565,7 @@
"anyOf": [
{
"type": "integer",
- "minimum": 0.0
+ "minimum": 0
},
{
"type": "null"
@@ -21756,11 +23797,11 @@
"type": "string",
"enum": [
"==",
- ">",
- "<",
+ "\u003E",
+ "\u003C",
"!=",
- ">=",
- "<=",
+ "\u003E=",
+ "\u003C=",
"in",
"nin",
"any",
@@ -21783,8 +23824,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -21918,8 +23959,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -22319,13 +24360,12 @@
},
"parameters": {
"anyOf": [
- {
- "$ref": "#/components/schemas/Base"
- },
+ {},
{
"type": "null"
}
],
+ "title": "Parameters",
"description": "Additional metadata for the job execution."
},
"session_id": {
@@ -22474,13 +24514,12 @@
},
"data": {
"anyOf": [
- {
- "$ref": "#/components/schemas/Base"
- },
+ {},
{
"type": "null"
}
],
+ "title": "Data",
"description": "Additional metadata for the job execution."
}
},
@@ -22646,6 +24685,19 @@
"title": "Use Chain Of Thought Reasoning",
"description": "Whether to use chain of thought reasoning."
},
+ "use_citation": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Use Citation",
+ "description": "Whether to show citations in the response.",
+ "default": true
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -22655,6 +24707,105 @@
"type": "object",
"title": "LLMParameters"
},
+ "LlamaExtractSettings": {
+ "properties": {
+ "max_file_size": {
+ "type": "integer",
+ "title": "Max File Size",
+ "description": "The maximum file size (in bytes) allowed for the document.",
+ "default": 5242880
+ },
+ "max_tokens": {
+ "type": "integer",
+ "title": "Max Tokens",
+ "description": "The maximum number of tokens allowed for the document.",
+ "default": 128000
+ },
+ "max_pages": {
+ "type": "integer",
+ "title": "Max Pages",
+ "description": "The maximum number of pages allowed for the document.",
+ "default": 200
+ },
+ "chunk_mode": {
+ "$ref": "#/components/schemas/ChunkMode",
+ "description": "The mode to use for chunking the document.",
+ "default": "PAGE"
+ },
+ "max_chunk_size": {
+ "type": "integer",
+ "title": "Max Chunk Size",
+ "description": "The maximum size of the chunks (in tokens) to use for chunking the document.",
+ "default": 5000
+ },
+ "extraction_agent_config": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/StructParseConf"
+ },
+ "type": "object",
+ "title": "Extraction Agent Config",
+ "description": "The configuration for the extraction agent."
+ },
+ "llama_parse_params": {
+ "$ref": "#/components/schemas/LlamaParseParameters",
+ "description": "LlamaParse related settings.",
+ "default": {
+ "languages": ["en"],
+ "parsing_instruction": "",
+ "disable_ocr": false,
+ "annotate_links": true,
+ "disable_reconstruction": false,
+ "disable_image_extraction": false,
+ "invalidate_cache": false,
+ "output_pdf_of_document": false,
+ "do_not_cache": false,
+ "fast_mode": false,
+ "skip_diagonal_text": false,
+ "preserve_layout_alignment_across_pages": false,
+ "gpt4o_mode": false,
+ "gpt4o_api_key": "",
+ "do_not_unroll_columns": false,
+ "extract_layout": false,
+ "html_make_all_elements_visible": false,
+ "html_remove_navigation_elements": false,
+ "html_remove_fixed_elements": false,
+ "guess_xlsx_sheet_name": false,
+ "bounding_box": "",
+ "target_pages": "",
+ "use_vendor_multimodal_model": false,
+ "vendor_multimodal_model_name": "",
+ "vendor_multimodal_api_key": "",
+ "page_prefix": "",
+ "page_suffix": "",
+ "webhook_url": "",
+ "take_screenshot": false,
+ "is_formatting_instruction": true,
+ "premium_mode": false,
+ "continuous_mode": false,
+ "s3_input_path": "",
+ "input_s3_region": "",
+ "s3_output_path_prefix": "",
+ "output_s3_region": "",
+ "auto_mode": false,
+ "auto_mode_trigger_on_table_in_page": false,
+ "auto_mode_trigger_on_image_in_page": false,
+ "structured_output": false,
+ "extract_charts": false,
+ "spreadsheet_extract_sub_tables": false,
+ "strict_mode_image_extraction": false,
+ "strict_mode_image_ocr": false,
+ "strict_mode_reconstruction": false,
+ "strict_mode_buggy_font": false,
+ "ignore_document_elements_for_layout_detection": false,
+ "output_tables_as_HTML": false,
+ "internal_is_screenshot_job": false
+ }
+ }
+ },
+ "type": "object",
+ "title": "LlamaExtractSettings",
+ "description": "All settings for the extraction agent. Only the settings in ExtractConfig\nare exposed to the user."
+ },
"LlamaParseParameters": {
"properties": {
"languages": {
@@ -22715,6 +24866,11 @@
"title": "Skip Diagonal Text",
"default": false
},
+ "preserve_layout_alignment_across_pages": {
+ "type": "boolean",
+ "title": "Preserve Layout Alignment Across Pages",
+ "default": false
+ },
"gpt4o_mode": {
"type": "boolean",
"title": "Gpt4O Mode",
@@ -22875,11 +25031,21 @@
"title": "S3 Input Path",
"default": ""
},
+ "input_s3_region": {
+ "type": "string",
+ "title": "Input S3 Region",
+ "default": ""
+ },
"s3_output_path_prefix": {
"type": "string",
"title": "S3 Output Path Prefix",
"default": ""
},
+ "output_s3_region": {
+ "type": "string",
+ "title": "Output S3 Region",
+ "default": ""
+ },
"project_id": {
"anyOf": [
{
@@ -23047,6 +25213,144 @@
"type": "boolean",
"title": "Extract Charts",
"default": false
+ },
+ "formatting_instruction": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Formatting Instruction"
+ },
+ "complemental_formatting_instruction": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Complemental Formatting Instruction"
+ },
+ "content_guideline_instruction": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Content Guideline Instruction"
+ },
+ "spreadsheet_extract_sub_tables": {
+ "type": "boolean",
+ "title": "Spreadsheet Extract Sub Tables",
+ "default": false
+ },
+ "job_timeout_in_seconds": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Job Timeout In Seconds"
+ },
+ "job_timeout_extra_time_per_page_in_seconds": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Job Timeout Extra Time Per Page In Seconds"
+ },
+ "strict_mode_image_extraction": {
+ "type": "boolean",
+ "title": "Strict Mode Image Extraction",
+ "default": false
+ },
+ "strict_mode_image_ocr": {
+ "type": "boolean",
+ "title": "Strict Mode Image Ocr",
+ "default": false
+ },
+ "strict_mode_reconstruction": {
+ "type": "boolean",
+ "title": "Strict Mode Reconstruction",
+ "default": false
+ },
+ "strict_mode_buggy_font": {
+ "type": "boolean",
+ "title": "Strict Mode Buggy Font",
+ "default": false
+ },
+ "ignore_document_elements_for_layout_detection": {
+ "type": "boolean",
+ "title": "Ignore Document Elements For Layout Detection",
+ "default": false
+ },
+ "output_tables_as_HTML": {
+ "type": "boolean",
+ "title": "Output Tables As Html",
+ "default": false
+ },
+ "internal_is_screenshot_job": {
+ "type": "boolean",
+ "title": "Internal Is Screenshot Job",
+ "default": false
+ },
+ "parse_mode": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ParsingMode"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "system_prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "System Prompt"
+ },
+ "system_prompt_append": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "System Prompt Append"
+ },
+ "user_prompt": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "User Prompt"
}
},
"type": "object",
@@ -23342,7 +25646,8 @@
"IN_PROGRESS",
"SUCCESS",
"ERROR",
- "PARTIAL_SUCCESS"
+ "PARTIAL_SUCCESS",
+ "CANCELLED"
],
"title": "ManagedIngestionStatus",
"description": "Status of managed ingestion with partial Updates."
@@ -23776,8 +26081,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -23848,7 +26153,7 @@
"type": "number",
"title": "Timeout",
"description": "Timeout for each request.",
- "default": 60.0,
+ "default": 60,
"gte": 0
},
"default_headers": {
@@ -23992,29 +26297,72 @@
"OrganizationUpdate": {
"properties": {
"name": {
- "anyOf": [
- {
- "type": "string",
- "maxLength": 3000,
- "minLength": 1
- },
- {
- "type": "null"
- }
- ],
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
"title": "Name",
"description": "A name for the organization."
}
},
"type": "object",
+ "required": ["name"],
"title": "OrganizationUpdate",
"description": "Schema for updating an organization."
},
+ "PageFigureMetadata": {
+ "properties": {
+ "figure_name": {
+ "type": "string",
+ "title": "Figure Name",
+ "description": "The name of the figure"
+ },
+ "file_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id",
+ "description": "The ID of the file that the figure was taken from"
+ },
+ "page_index": {
+ "type": "integer",
+ "minimum": 0,
+ "title": "Page Index",
+ "description": "The index of the page for which the figure is taken (0-indexed)"
+ },
+ "figure_size": {
+ "type": "integer",
+ "minimum": 0,
+ "title": "Figure Size",
+ "description": "The size of the figure in bytes"
+ },
+ "is_likely_noise": {
+ "type": "boolean",
+ "title": "Is Likely Noise",
+ "description": "Whether the figure is likely to be noise",
+ "default": false
+ },
+ "confidence": {
+ "type": "number",
+ "maximum": 1,
+ "minimum": 0,
+ "title": "Confidence",
+ "description": "The confidence of the figure"
+ }
+ },
+ "type": "object",
+ "required": [
+ "figure_name",
+ "file_id",
+ "page_index",
+ "figure_size",
+ "confidence"
+ ],
+ "title": "PageFigureMetadata"
+ },
"PageScreenshotMetadata": {
"properties": {
"page_index": {
"type": "integer",
- "minimum": 0.0,
+ "minimum": 0,
"title": "Page Index",
"description": "The index of the page for which the screenshot is taken (0-indexed)"
},
@@ -24026,9 +26374,21 @@
},
"image_size": {
"type": "integer",
- "minimum": 0.0,
+ "minimum": 0,
"title": "Image Size",
"description": "The size of the image in bytes"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Metadata",
+ "description": "Metadata for the screenshot"
}
},
"type": "object",
@@ -24476,6 +26836,18 @@
"required": ["text", "job_metadata"],
"title": "ParsingJobTextResult"
},
+ "ParsingMode": {
+ "type": "string",
+ "enum": [
+ "parse_page_without_llm",
+ "parse_page_with_llm",
+ "parse_page_with_lvm",
+ "parse_page_with_agent",
+ "parse_document_with_llm"
+ ],
+ "title": "ParsingMode",
+ "description": "Enum for representing the mode of parsing to be used"
+ },
"ParsingUsage": {
"properties": {
"usage_pdf_pages": {
@@ -25317,7 +27689,7 @@
"anyOf": [
{
"type": "integer",
- "minimum": 0.0
+ "minimum": 0
},
{
"type": "null"
@@ -25843,6 +28215,16 @@
},
"Plan": {
"properties": {
+ "id": {
+ "type": "string",
+ "title": "Id",
+ "description": "The ID of the plan"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "default": "free"
+ },
"total_users": {
"type": "integer",
"title": "Total Users",
@@ -25885,9 +28267,34 @@
"title": "Allowed External Index",
"description": "If is allowed to use external data sources or sinks in indexes",
"default": false
+ },
+ "starting_on": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Starting On"
+ },
+ "ending_before": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Ending Before"
}
},
"type": "object",
+ "required": ["id"],
"title": "Plan"
},
"PlaygroundSession": {
@@ -25977,14 +28384,31 @@
"title": "Pooling",
"description": "Enum of possible pooling choices with pooling behaviors."
},
+ "PresetCompositeRetrievalParams": {
+ "properties": {
+ "mode": {
+ "$ref": "#/components/schemas/CompositeRetrievalMode",
+ "description": "The mode of composite retrieval.",
+ "default": "full"
+ },
+ "rerank_top_n": {
+ "type": "integer",
+ "title": "Rerank Top N",
+ "description": "The number of nodes to retrieve after reranking over retrieved nodes from all retrieval tools.",
+ "default": 6
+ }
+ },
+ "type": "object",
+ "title": "PresetCompositeRetrievalParams"
+ },
"PresetRetrievalParams": {
"properties": {
"dense_similarity_top_k": {
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -25998,8 +28422,8 @@
"anyOf": [
{
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0
+ "maximum": 1,
+ "minimum": 0
},
{
"type": "null"
@@ -26007,14 +28431,14 @@
],
"title": "Dense Similarity Cutoff",
"description": "Minimum similarity score wrt query for retrieval",
- "default": 0.0
+ "default": 0
},
"sparse_similarity_top_k": {
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -26040,8 +28464,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -26055,8 +28479,8 @@
"anyOf": [
{
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0
+ "maximum": 1,
+ "minimum": 0
},
{
"type": "null"
@@ -26080,8 +28504,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 5.0,
- "minimum": 1.0
+ "maximum": 5,
+ "minimum": 1
},
{
"type": "null"
@@ -26185,8 +28609,8 @@
"anyOf": [
{
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0
+ "maximum": 1,
+ "minimum": 0
},
{
"type": "null"
@@ -26318,6 +28742,30 @@
"title": "ProjectUpdate",
"description": "Schema for updating a project."
},
+ "PromptConf": {
+ "properties": {
+ "system_prompt": {
+ "type": "string",
+ "title": "System Prompt",
+ "description": "The system prompt to use for the extraction.",
+ "default": "\nGiven a JSON schema, extract the data from the provided text according to the schema.\nOnly output the data as given in the text, nothing else.\n"
+ },
+ "extraction_prompt": {
+ "type": "string",
+ "title": "Extraction Prompt",
+ "description": "The prompt to use for the extraction.",
+ "default": "The extracted data using the given JSON schema."
+ },
+ "error_handling_prompt": {
+ "type": "string",
+ "title": "Error Handling Prompt",
+ "description": "The prompt to use for error handling.",
+ "default": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field."
+ }
+ },
+ "type": "object",
+ "title": "PromptConf"
+ },
"PromptMixinPrompts": {
"properties": {
"project_id": {
@@ -26614,6 +29062,53 @@
"state": {
"$ref": "#/components/schemas/ReportState",
"description": "The state of the report"
+ },
+ "input_files": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Input Files"
+ },
+ "template_file": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Template File"
+ },
+ "template_text": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Template Text"
+ },
+ "template_instructions": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Template Instructions"
}
},
"type": "object",
@@ -26859,8 +29354,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -26874,8 +29369,8 @@
"anyOf": [
{
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0
+ "maximum": 1,
+ "minimum": 0
},
{
"type": "null"
@@ -26883,14 +29378,14 @@
],
"title": "Dense Similarity Cutoff",
"description": "Minimum similarity score wrt query for retrieval",
- "default": 0.0
+ "default": 0
},
"sparse_similarity_top_k": {
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -26916,8 +29411,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 100.0,
- "minimum": 1.0
+ "maximum": 100,
+ "minimum": 1
},
{
"type": "null"
@@ -26931,8 +29426,8 @@
"anyOf": [
{
"type": "number",
- "maximum": 1.0,
- "minimum": 0.0
+ "maximum": 1,
+ "minimum": 0
},
{
"type": "null"
@@ -26956,8 +29451,8 @@
"anyOf": [
{
"type": "integer",
- "maximum": 5.0,
- "minimum": 1.0
+ "maximum": 5,
+ "minimum": 1
},
{
"type": "null"
@@ -27045,6 +29540,167 @@
"title": "RetrieveResults",
"description": "Schema for the result of an retrieval execution."
},
+ "Retriever": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name",
+ "description": "A name for the retriever tool. Will default to the pipeline name if not provided."
+ },
+ "pipelines": {
+ "items": {
+ "$ref": "#/components/schemas/RetrieverPipeline"
+ },
+ "type": "array",
+ "title": "Pipelines",
+ "description": "The pipelines this retriever uses."
+ },
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id",
+ "description": "Unique identifier"
+ },
+ "created_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Created At",
+ "description": "Creation datetime"
+ },
+ "updated_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Updated At",
+ "description": "Update datetime"
+ },
+ "project_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id",
+ "description": "The ID of the project this retriever resides in."
+ }
+ },
+ "type": "object",
+ "required": ["name", "id", "project_id"],
+ "title": "Retriever",
+ "description": "An entity that retrieves context nodes from several sub RetrieverTools."
+ },
+ "RetrieverCreate": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name",
+ "description": "A name for the retriever tool. Will default to the pipeline name if not provided."
+ },
+ "pipelines": {
+ "items": {
+ "$ref": "#/components/schemas/RetrieverPipeline"
+ },
+ "type": "array",
+ "title": "Pipelines",
+ "description": "The pipelines this retriever uses."
+ }
+ },
+ "type": "object",
+ "required": ["name"],
+ "title": "RetrieverCreate"
+ },
+ "RetrieverPipeline": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "A name for the retriever tool. Will default to the pipeline name if not provided."
+ },
+ "description": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 15000
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Description",
+ "description": "A description of the retriever tool."
+ },
+ "pipeline_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id",
+ "description": "The ID of the pipeline this tool uses."
+ },
+ "preset_retrieval_parameters": {
+ "$ref": "#/components/schemas/PresetRetrievalParams",
+ "description": "Parameters for retrieval configuration."
+ }
+ },
+ "type": "object",
+ "required": ["name", "description", "pipeline_id"],
+ "title": "RetrieverPipeline"
+ },
+ "RetrieverUpdate": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "A name for the retriever."
+ },
+ "pipelines": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/RetrieverPipeline"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pipelines",
+ "description": "The pipelines this retriever uses."
+ }
+ },
+ "type": "object",
+ "required": ["pipelines"],
+ "title": "RetrieverUpdate"
+ },
"Role": {
"properties": {
"id": {
@@ -27113,6 +29769,11 @@
"title": "Role",
"description": "Schema for a role."
},
+ "SchemaRelaxMode": {
+ "type": "string",
+ "enum": ["FULL", "TOP_LEVEL", "LEAF"],
+ "title": "SchemaRelaxMode"
+ },
"SemanticChunkingConfig": {
"properties": {
"mode": {
@@ -27139,7 +29800,7 @@
"properties": {
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"default": 1024
},
@@ -27200,14 +29861,14 @@
},
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"description": "The token chunk size for each chunk.",
"default": 1024
},
"chunk_overlap": {
"type": "integer",
- "minimum": 0.0,
+ "minimum": 0,
"title": "Chunk Overlap",
"description": "The token overlap of each chunk when splitting.",
"default": 200
@@ -27249,10 +29910,53 @@
},
"StatusEnum": {
"type": "string",
- "enum": ["PENDING", "SUCCESS", "ERROR", "PARTIAL_SUCCESS"],
+ "enum": ["PENDING", "SUCCESS", "ERROR", "PARTIAL_SUCCESS", "CANCELLED"],
"title": "StatusEnum",
"description": "Enum for representing the status of a job"
},
+ "StructMode": {
+ "type": "string",
+ "enum": ["STRUCT_PARSE", "JSON_MODE", "FUNC_CALL", "UNSTRUCTURED"],
+ "title": "StructMode"
+ },
+ "StructParseConf": {
+ "properties": {
+ "model": {
+ "type": "string",
+ "title": "Model",
+ "description": "The model to use for the structured parsing.",
+ "default": "gpt-4o"
+ },
+ "temperature": {
+ "type": "number",
+ "title": "Temperature",
+ "description": "The temperature to use for the structured parsing.",
+ "default": 0
+ },
+ "relaxation_mode": {
+ "$ref": "#/components/schemas/SchemaRelaxMode",
+ "description": "The relaxation mode to use for the structured parsing.",
+ "default": "LEAF"
+ },
+ "struct_mode": {
+ "$ref": "#/components/schemas/StructMode",
+ "description": "The struct mode to use for the structured parsing.",
+ "default": "STRUCT_PARSE"
+ },
+ "prompt_conf": {
+ "$ref": "#/components/schemas/PromptConf",
+ "description": "The prompt configuration for the structured parsing.",
+ "default": {
+ "system_prompt": "\nGiven a JSON schema, extract the data from the provided text according to the schema.\nOnly output the data as given in the text, nothing else.\n",
+ "extraction_prompt": "The extracted data using the given JSON schema.",
+ "error_handling_prompt": "If the text does not contain enough information to comply with the schema, explain the reason. Else, output null and fill out the 'extracted' field."
+ }
+ }
+ },
+ "type": "object",
+ "title": "StructParseConf",
+ "description": "Configuration for the structured parsing agent."
+ },
"SupportedLLMModel": {
"properties": {
"name": {
@@ -27283,8 +29987,13 @@
"GPT_4_TURBO",
"GPT_4O",
"GPT_4O_MINI",
- "AZURE_OPENAI",
- "CLAUDE_3_5_SONNET"
+ "AZURE_OPENAI_GPT_3_5_TURBO",
+ "AZURE_OPENAI_GPT_4O",
+ "AZURE_OPENAI_GPT_4O_MINI",
+ "AZURE_OPENAI_GPT_4",
+ "CLAUDE_3_5_SONNET",
+ "BEDROCK_CLAUDE_3_5_SONNET",
+ "VERTEX_AI_CLAUDE_3_5_SONNET"
],
"title": "SupportedLLMModelNames"
},
@@ -27464,7 +30173,7 @@
"properties": {
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"default": 1024
},
@@ -27520,14 +30229,14 @@
},
"chunk_size": {
"type": "integer",
- "exclusiveMinimum": 0.0,
+ "exclusiveMinimum": 0,
"title": "Chunk Size",
"description": "The token chunk size for each chunk.",
"default": 1024
},
"chunk_overlap": {
"type": "integer",
- "minimum": 0.0,
+ "minimum": 0,
"title": "Chunk Overlap",
"description": "The token overlap of each chunk when splitting.",
"default": 20
@@ -27992,8 +30701,8 @@
},
"embed_batch_size": {
"type": "integer",
- "maximum": 2048.0,
- "exclusiveMinimum": 0.0,
+ "maximum": 2048,
+ "exclusiveMinimum": 0,
"title": "Embed Batch Size",
"description": "The batch size for embedding calls.",
"default": 10
@@ -28116,7 +30825,8 @@
"description": "Retrieval annotations for the message."
},
"role": {
- "$ref": "#/components/schemas/MessageRole"
+ "$ref": "#/components/schemas/MessageRole",
+ "description": "The role of the message."
},
"content": {
"anyOf": [
diff --git a/packages/cloud/src/reader.ts b/packages/cloud/src/reader.ts
index d8197e7864b7de652c7f5ac5d891e7b15fc557fe..f977425217b6039e69ebec868860db9fc3587877 100644
--- a/packages/cloud/src/reader.ts
+++ b/packages/cloud/src/reader.ts
@@ -4,6 +4,7 @@ import { fs, getEnv, path } from "@llamaindex/env";
import {
type Body_upload_file_api_v1_parsing_upload_post,
type ParserLanguages,
+ type ParsingMode,
getJobApiV1ParsingJobJobIdGet,
getJobImageResultApiV1ParsingJobJobIdResultImageNameGet,
getJobJsonResultApiV1ParsingJobJobIdResultJsonGet,
@@ -127,6 +128,26 @@ export class LlamaParseReader extends FileReader {
readonly #client: Client;
+ output_tables_as_HTML: boolean = false;
+ input_s3_region?: string | undefined;
+ output_s3_region?: string | undefined;
+ preserve_layout_alignment_across_pages?: boolean | undefined;
+ spreadsheet_extract_sub_tables?: boolean | undefined;
+ formatting_instruction?: string | undefined;
+ parse_mode?: ParsingMode | undefined;
+ system_prompt?: string | undefined;
+ system_prompt_append?: string | undefined;
+ user_prompt?: string | undefined;
+ job_timeout_in_seconds?: number | undefined;
+ job_timeout_extra_time_per_page_in_seconds?: number | undefined;
+ strict_mode_image_extraction?: boolean | undefined;
+ strict_mode_image_ocr?: boolean | undefined;
+ strict_mode_reconstruction?: boolean | undefined;
+ strict_mode_buggy_font?: boolean | undefined;
+ ignore_document_elements_for_layout_detection?: boolean | undefined;
+ complemental_formatting_instruction?: string | undefined;
+ content_guideline_instruction?: string | undefined;
+
constructor(
params: Partial<Omit<LlamaParseReader, "language" | "apiKey">> & {
language?: ParserLanguages | ParserLanguages[] | undefined;
@@ -252,6 +273,29 @@ export class LlamaParseReader extends FileReader {
structured_output_json_schema_name:
this.structured_output_json_schema_name,
extract_layout: this.extract_layout,
+ output_tables_as_HTML: this.output_tables_as_HTML,
+ input_s3_region: this.input_s3_region,
+ output_s3_region: this.output_s3_region,
+ preserve_layout_alignment_across_pages:
+ this.preserve_layout_alignment_across_pages,
+ spreadsheet_extract_sub_tables: this.spreadsheet_extract_sub_tables,
+ formatting_instruction: this.formatting_instruction,
+ parse_mode: this.parse_mode,
+ system_prompt: this.system_prompt,
+ system_prompt_append: this.system_prompt_append,
+ user_prompt: this.user_prompt,
+ job_timeout_in_seconds: this.job_timeout_in_seconds,
+ job_timeout_extra_time_per_page_in_seconds:
+ this.job_timeout_extra_time_per_page_in_seconds,
+ strict_mode_image_extraction: this.strict_mode_image_extraction,
+ strict_mode_image_ocr: this.strict_mode_image_ocr,
+ strict_mode_reconstruction: this.strict_mode_reconstruction,
+ strict_mode_buggy_font: this.strict_mode_buggy_font,
+ ignore_document_elements_for_layout_detection:
+ this.ignore_document_elements_for_layout_detection,
+ complemental_formatting_instruction:
+ this.complemental_formatting_instruction,
+ content_guideline_instruction: this.content_guideline_instruction,
} satisfies {
[Key in keyof Body_upload_file_api_v1_parsing_upload_post]-?:
| Body_upload_file_api_v1_parsing_upload_post[Key]