diff --git a/.changeset/stupid-fishes-destroy.md b/.changeset/stupid-fishes-destroy.md
new file mode 100644
index 0000000000000000000000000000000000000000..54c559a876919bd8341bdda9ae919946faaa69b3
--- /dev/null
+++ b/.changeset/stupid-fishes-destroy.md
@@ -0,0 +1,5 @@
+---
+"@llamaindex/cloud": patch
+---
+
+chore: bump llamacloud sdk
diff --git a/apps/next/turbo.json b/apps/next/turbo.json
index 618d16c57ef4b3fc374398ce71a213df6a604d7f..a66621aff9a19c485a2f7748cf31345a1cc98eef 100644
--- a/apps/next/turbo.json
+++ b/apps/next/turbo.json
@@ -6,7 +6,8 @@
".next",
".source",
"next-env.d.ts",
- "src/content/docs/cloud/api/**"
+ "src/content/docs/cloud/api/**",
+ "src/content/docs/api/**"
]
},
"dev": {
diff --git a/packages/cloud/openapi.json b/packages/cloud/openapi.json
index d3f56b253b4dfc0257876570fff3404028548043..9ac02684e74de0d598de13b348f4e6739819872f 100644
--- a/packages/cloud/openapi.json
+++ b/packages/cloud/openapi.json
@@ -84,6 +84,23 @@
}
],
"parameters": [
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -516,7 +533,7 @@
"get": {
"tags": ["Data Sinks"],
"summary": "List Data Sinks",
- "description": "List data sinks for a given project.\nIf project_id is not provided, uses the default project.",
+ "description": "List data sinks for a given project.",
"operationId": "list_data_sinks_api_v1_data_sinks_get",
"security": [
{
@@ -544,6 +561,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",
@@ -1469,12 +1503,11 @@
}
}
},
- "/api/v1/organizations": {
- "post": {
- "tags": ["Organizations"],
- "summary": "Create Organization",
- "description": "Create a new organization.",
- "operationId": "create_organization_api_v1_organizations_post",
+ "/api/v1/embedding-model-configs": {
+ "get": {
+ "tags": ["Embedding Model Configs"],
+ "summary": "List Embedding Model Configs",
+ "operationId": "list_embedding_model_configs_api_v1_embedding_model_configs_get",
"security": [
{
"HTTPBearer": []
@@ -1484,6 +1517,14 @@
}
],
"parameters": [
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "title": "Project Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -1501,23 +1542,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/OrganizationCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Organization"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EmbeddingModelConfig"
+ },
+ "title": "Response List Embedding Model Configs Api V1 Embedding Model Configs Get"
}
}
}
@@ -1534,11 +1569,11 @@
}
}
},
- "put": {
- "tags": ["Organizations"],
- "summary": "Upsert Organization",
- "description": "Upsert a new organization.",
- "operationId": "upsert_organization_api_v1_organizations_put",
+ "post": {
+ "tags": ["Embedding Model Configs"],
+ "summary": "Create a new Embedding Model Configuration",
+ "description": "Create a new embedding model configuration within a specified project.",
+ "operationId": "create_embedding_model_config_api_v1_embedding_model_configs_post",
"security": [
{
"HTTPBearer": []
@@ -1548,6 +1583,16 @@
}
],
"parameters": [
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -1570,18 +1615,18 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrganizationCreate"
+ "$ref": "#/components/schemas/EmbeddingModelConfigCreate"
}
}
}
},
"responses": {
- "200": {
+ "201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Organization"
+ "$ref": "#/components/schemas/EmbeddingModelConfig"
}
}
}
@@ -1598,11 +1643,11 @@
}
}
},
- "get": {
- "tags": ["Organizations"],
- "summary": "List Organizations",
- "description": "List organizations for a user.",
- "operationId": "list_organizations_api_v1_organizations_get",
+ "put": {
+ "tags": ["Embedding Model Configs"],
+ "summary": "Upsert Embedding Model Config",
+ "description": "Upserts an embedding model config.\nUpdates if an embedding model config with the same name and project_id already exists. Otherwise, creates a new embedding model config.",
+ "operationId": "upsert_embedding_model_config_api_v1_embedding_model_configs_put",
"security": [
{
"HTTPBearer": []
@@ -1612,6 +1657,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",
@@ -1629,17 +1708,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EmbeddingModelConfigUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Organization"
- },
- "title": "Response List Organizations Api V1 Organizations Get"
+ "$ref": "#/components/schemas/EmbeddingModelConfig"
}
}
}
@@ -1657,12 +1742,12 @@
}
}
},
- "/api/v1/organizations/default": {
+ "/api/v1/embedding-model-configs/{embedding_model_config_id}": {
"put": {
- "tags": ["Organizations"],
- "summary": "Set Default Organization",
- "description": "Set the default organization for the user.",
- "operationId": "set_default_organization_api_v1_organizations_default_put",
+ "tags": ["Embedding Model Configs"],
+ "summary": "Update Embedding Model Config",
+ "description": "Update an embedding model config by ID.",
+ "operationId": "update_embedding_model_config_api_v1_embedding_model_configs__embedding_model_config_id__put",
"security": [
{
"HTTPBearer": []
@@ -1672,6 +1757,16 @@
}
],
"parameters": [
+ {
+ "name": "embedding_model_config_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Embedding Model Config Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -1694,7 +1789,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DefaultOrganizationUpdate"
+ "$ref": "#/components/schemas/EmbeddingModelConfigUpdate"
}
}
}
@@ -1705,7 +1800,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Organization"
+ "$ref": "#/components/schemas/EmbeddingModelConfig"
}
}
}
@@ -1722,11 +1817,11 @@
}
}
},
- "get": {
- "tags": ["Organizations"],
- "summary": "Get Default Organization",
- "description": "Get the default organization for the user.",
- "operationId": "get_default_organization_api_v1_organizations_default_get",
+ "delete": {
+ "tags": ["Embedding Model Configs"],
+ "summary": "Delete Embedding Model Config",
+ "description": "Delete an embedding model config by ID.",
+ "operationId": "delete_embedding_model_config_api_v1_embedding_model_configs__embedding_model_config_id__delete",
"security": [
{
"HTTPBearer": []
@@ -1736,6 +1831,16 @@
}
],
"parameters": [
+ {
+ "name": "embedding_model_config_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Embedding Model Config Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -1754,15 +1859,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -1777,12 +1875,12 @@
}
}
},
- "/api/v1/organizations/{organization_id}": {
- "get": {
+ "/api/v1/organizations": {
+ "post": {
"tags": ["Organizations"],
- "summary": "Get Organization",
- "description": "Get an organization by ID.",
- "operationId": "get_organization_api_v1_organizations__organization_id__get",
+ "summary": "Create Organization",
+ "description": "Create a new organization.",
+ "operationId": "create_organization_api_v1_organizations_post",
"security": [
{
"HTTPBearer": []
@@ -1792,16 +1890,6 @@
}
],
"parameters": [
- {
- "name": "organization_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -1819,6 +1907,16 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OrganizationCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
@@ -1844,9 +1942,9 @@
},
"put": {
"tags": ["Organizations"],
- "summary": "Update Organization",
- "description": "Update an existing organization.",
- "operationId": "update_organization_api_v1_organizations__organization_id__put",
+ "summary": "Upsert Organization",
+ "description": "Upsert a new organization.",
+ "operationId": "upsert_organization_api_v1_organizations_put",
"security": [
{
"HTTPBearer": []
@@ -1856,16 +1954,6 @@
}
],
"parameters": [
- {
- "name": "organization_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -1888,7 +1976,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/OrganizationUpdate"
+ "$ref": "#/components/schemas/OrganizationCreate"
}
}
}
@@ -1916,11 +2004,11 @@
}
}
},
- "delete": {
+ "get": {
"tags": ["Organizations"],
- "summary": "Delete Organization",
- "description": "Delete an organization by ID.",
- "operationId": "delete_organization_api_v1_organizations__organization_id__delete",
+ "summary": "List Organizations",
+ "description": "List organizations for a user.",
+ "operationId": "list_organizations_api_v1_organizations_get",
"security": [
{
"HTTPBearer": []
@@ -1930,16 +2018,6 @@
}
],
"parameters": [
- {
- "name": "organization_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -1958,28 +2036,39 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
- },
- "422": {
- "description": "Validation Error",
+ "200": {
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Organization"
+ },
+ "title": "Response List Organizations Api V1 Organizations Get"
}
}
}
- }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
}
}
},
- "/api/v1/organizations/{organization_id}/users": {
- "get": {
+ "/api/v1/organizations/default": {
+ "put": {
"tags": ["Organizations"],
- "summary": "List Organization Users",
- "description": "Get all users in an organization.",
- "operationId": "list_organization_users_api_v1_organizations__organization_id__users_get",
+ "summary": "Set Default Organization",
+ "description": "Set the default organization for the user.",
+ "operationId": "set_default_organization_api_v1_organizations_default_put",
"security": [
{
"HTTPBearer": []
@@ -1989,16 +2078,6 @@
}
],
"parameters": [
- {
- "name": "organization_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2016,17 +2095,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DefaultOrganizationUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserOrganization"
- },
- "title": "Response List Organization Users Api V1 Organizations Organization Id Users Get"
+ "$ref": "#/components/schemas/Organization"
}
}
}
@@ -2043,11 +2128,11 @@
}
}
},
- "put": {
+ "get": {
"tags": ["Organizations"],
- "summary": "Add Users To Organization",
- "description": "Add a user to an organization.",
- "operationId": "add_users_to_organization_api_v1_organizations__organization_id__users_put",
+ "summary": "Get Default Organization",
+ "description": "Get the default organization for the user.",
+ "operationId": "get_default_organization_api_v1_organizations_default_get",
"security": [
{
"HTTPBearer": []
@@ -2057,16 +2142,6 @@
}
],
"parameters": [
- {
- "name": "organization_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2084,31 +2159,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserOrganizationCreate"
- },
- "title": "Payload"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserOrganization"
- },
- "title": "Response Add Users To Organization Api V1 Organizations Organization Id Users Put"
+ "$ref": "#/components/schemas/Organization"
}
}
}
@@ -2126,12 +2183,12 @@
}
}
},
- "/api/v1/organizations/{organization_id}/users/{member_user_id}": {
- "delete": {
+ "/api/v1/organizations/{organization_id}": {
+ "get": {
"tags": ["Organizations"],
- "summary": "Remove Users From Organization",
- "description": "Remove users from an organization by email.",
- "operationId": "remove_users_from_organization_api_v1_organizations__organization_id__users__member_user_id__delete",
+ "summary": "Get Organization",
+ "description": "Get an organization by ID.",
+ "operationId": "get_organization_api_v1_organizations__organization_id__get",
"security": [
{
"HTTPBearer": []
@@ -2151,15 +2208,6 @@
"title": "Organization Id"
}
},
- {
- "name": "member_user_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Member User Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2178,8 +2226,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Organization"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -2192,14 +2247,12 @@
}
}
}
- }
- },
- "/api/v1/organizations/{organization_id}/users/remove": {
+ },
"put": {
"tags": ["Organizations"],
- "summary": "Batch Remove Users From Organization",
- "description": "Remove a batch of users from an organization.",
- "operationId": "batch_remove_users_from_organization_api_v1_organizations__organization_id__users_remove_put",
+ "summary": "Update Organization",
+ "description": "Update an existing organization.",
+ "operationId": "update_organization_api_v1_organizations__organization_id__put",
"security": [
{
"HTTPBearer": []
@@ -2241,18 +2294,21 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/UserOrganizationDelete"
- },
- "title": "Payload"
+ "$ref": "#/components/schemas/OrganizationUpdate"
}
}
}
},
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Organization"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -2265,14 +2321,12 @@
}
}
}
- }
- },
- "/api/v1/organizations/{organization_id}/roles": {
- "get": {
+ },
+ "delete": {
"tags": ["Organizations"],
- "summary": "List Roles",
- "description": "List all roles in an organization.",
- "operationId": "list_roles_api_v1_organizations__organization_id__roles_get",
+ "summary": "Delete Organization",
+ "description": "Delete an organization by ID.",
+ "operationId": "delete_organization_api_v1_organizations__organization_id__delete",
"security": [
{
"HTTPBearer": []
@@ -2310,19 +2364,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Role"
- },
- "title": "Response List Roles Api V1 Organizations Organization Id Roles Get"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -2337,12 +2380,12 @@
}
}
},
- "/api/v1/organizations/{organization_id}/users/roles": {
- "put": {
+ "/api/v1/organizations/{organization_id}/usage": {
+ "get": {
"tags": ["Organizations"],
- "summary": "Assign Role To User In Organization",
- "description": "Assign a role to a user in an organization.",
- "operationId": "assign_role_to_user_in_organization_api_v1_organizations__organization_id__users_roles_put",
+ "summary": "Get Organization Usage",
+ "description": "Get usage for a project",
+ "operationId": "get_organization_usage_api_v1_organizations__organization_id__usage_get",
"security": [
{
"HTTPBearer": []
@@ -2357,8 +2400,15 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Organization Id"
}
},
@@ -2379,23 +2429,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UserOrganizationRoleCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserOrganizationRole"
+ "$ref": "#/components/schemas/IntervalUsageAndPlan"
}
}
}
@@ -2411,12 +2451,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/organizations/{organization_id}/users": {
"get": {
"tags": ["Organizations"],
- "summary": "Get User Role",
- "description": "Get the role of a user in an organization.",
- "operationId": "get_user_role_api_v1_organizations__organization_id__users_roles_get",
+ "summary": "List Organization Users",
+ "description": "Get all users in an organization.",
+ "operationId": "list_organization_users_api_v1_organizations__organization_id__users_get",
"security": [
{
"HTTPBearer": []
@@ -2459,7 +2501,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/UserOrganizationRole"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserOrganization"
+ },
+ "title": "Response List Organization Users Api V1 Organizations Organization Id Users Get"
}
}
}
@@ -2475,14 +2521,12 @@
}
}
}
- }
- },
- "/api/v1/organizations/{organization_id}/users/{user_id}/projects": {
- "get": {
+ },
+ "put": {
"tags": ["Organizations"],
- "summary": "List Projects By User",
- "description": "List all projects for a user in an organization.",
- "operationId": "list_projects_by_user_api_v1_organizations__organization_id__users__user_id__projects_get",
+ "summary": "Add Users To Organization",
+ "description": "Add a user to an organization.",
+ "operationId": "add_users_to_organization_api_v1_organizations__organization_id__users_put",
"security": [
{
"HTTPBearer": []
@@ -2502,15 +2546,6 @@
"title": "Organization Id"
}
},
- {
- "name": "user_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "User Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2528,6 +2563,20 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserOrganizationCreate"
+ },
+ "title": "Payload"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
@@ -2536,9 +2585,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Project"
+ "$ref": "#/components/schemas/UserOrganization"
},
- "title": "Response List Projects By User Api V1 Organizations Organization Id Users User Id Projects Get"
+ "title": "Response Add Users To Organization Api V1 Organizations Organization Id Users Put"
}
}
}
@@ -2554,12 +2603,14 @@
}
}
}
- },
- "put": {
- "tags": ["Organizations"],
- "summary": "Add User To Project",
- "description": "Add a user to a project.",
- "operationId": "add_user_to_project_api_v1_organizations__organization_id__users__user_id__projects_put",
+ }
+ },
+ "/api/v1/organizations/{organization_id}/users/{member_user_id}": {
+ "delete": {
+ "tags": ["Organizations"],
+ "summary": "Remove Users From Organization",
+ "description": "Remove users from an organization by email.",
+ "operationId": "remove_users_from_organization_api_v1_organizations__organization_id__users__member_user_id__delete",
"security": [
{
"HTTPBearer": []
@@ -2580,22 +2631,12 @@
}
},
{
- "name": "user_id",
+ "name": "member_user_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "User Id"
- }
- },
- {
- "name": "project_id",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "Member User Id"
}
},
{
@@ -2616,13 +2657,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -2637,12 +2673,12 @@
}
}
},
- "/api/v1/organizations/{organization_id}/users/{user_id}/projects/{project_id}": {
- "delete": {
+ "/api/v1/organizations/{organization_id}/users/remove": {
+ "put": {
"tags": ["Organizations"],
- "summary": "Remove User From Project",
- "description": "Remove a user from a project.",
- "operationId": "remove_user_from_project_api_v1_organizations__organization_id__users__user_id__projects__project_id__delete",
+ "summary": "Batch Remove Users From Organization",
+ "description": "Remove a batch of users from an organization.",
+ "operationId": "batch_remove_users_from_organization_api_v1_organizations__organization_id__users_remove_put",
"security": [
{
"HTTPBearer": []
@@ -2662,25 +2698,6 @@
"title": "Organization Id"
}
},
- {
- "name": "user_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "User Id"
- }
- },
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2698,14 +2715,23 @@
}
}
],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/UserOrganizationDelete"
+ },
+ "title": "Payload"
}
}
+ }
+ },
+ "responses": {
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -2720,12 +2746,12 @@
}
}
},
- "/api/v1/projects": {
+ "/api/v1/organizations/{organization_id}/roles": {
"get": {
- "tags": ["Projects"],
- "summary": "List Projects",
- "description": "List projects or get one by name",
- "operationId": "list_projects_api_v1_projects_get",
+ "tags": ["Organizations"],
+ "summary": "List Roles",
+ "description": "List all roles in an organization.",
+ "operationId": "list_roles_api_v1_organizations__organization_id__roles_get",
"security": [
{
"HTTPBearer": []
@@ -2737,37 +2763,14 @@
"parameters": [
{
"name": "organization_id",
- "in": "query",
- "required": false,
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
+ "type": "string",
+ "format": "uuid",
"title": "Organization Id"
}
},
- {
- "name": "project_name",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Project Name"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -2793,9 +2796,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/Project"
+ "$ref": "#/components/schemas/Role"
},
- "title": "Response List Projects Api V1 Projects Get"
+ "title": "Response List Roles Api V1 Organizations Organization Id Roles Get"
}
}
}
@@ -2811,12 +2814,14 @@
}
}
}
- },
- "post": {
- "tags": ["Projects"],
- "summary": "Create Project",
- "description": "Create a new project.",
- "operationId": "create_project_api_v1_projects_post",
+ }
+ },
+ "/api/v1/organizations/{organization_id}/users/roles": {
+ "put": {
+ "tags": ["Organizations"],
+ "summary": "Assign Role To User In Organization",
+ "description": "Assign a role to a user in an organization.",
+ "operationId": "assign_role_to_user_in_organization_api_v1_organizations__organization_id__users_roles_put",
"security": [
{
"HTTPBearer": []
@@ -2828,18 +2833,11 @@
"parameters": [
{
"name": "organization_id",
- "in": "query",
- "required": false,
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
+ "type": "string",
+ "format": "uuid",
"title": "Organization Id"
}
},
@@ -2865,7 +2863,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ProjectCreate"
+ "$ref": "#/components/schemas/UserOrganizationRoleCreate"
}
}
}
@@ -2876,7 +2874,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Project"
+ "$ref": "#/components/schemas/UserOrganizationRole"
}
}
}
@@ -2893,11 +2891,11 @@
}
}
},
- "put": {
- "tags": ["Projects"],
- "summary": "Upsert Project",
- "description": "Upsert a project.\nUpdates if a project with the same name already exists. Otherwise, creates a new project.",
- "operationId": "upsert_project_api_v1_projects_put",
+ "get": {
+ "tags": ["Organizations"],
+ "summary": "Get User Role",
+ "description": "Get the role of a user in an organization.",
+ "operationId": "get_user_role_api_v1_organizations__organization_id__users_roles_get",
"security": [
{
"HTTPBearer": []
@@ -2909,18 +2907,11 @@
"parameters": [
{
"name": "organization_id",
- "in": "query",
- "required": false,
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
+ "type": "string",
+ "format": "uuid",
"title": "Organization Id"
}
},
@@ -2941,23 +2932,21 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProjectCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Project"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/UserOrganizationRole"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Response Get User Role Api V1 Organizations Organization Id Users Roles Get"
}
}
}
@@ -2975,12 +2964,12 @@
}
}
},
- "/api/v1/projects/{project_id}": {
- "delete": {
- "tags": ["Projects"],
- "summary": "Delete Project",
- "description": "Delete a project by ID.",
- "operationId": "delete_project_api_v1_projects__project_id__delete",
+ "/api/v1/organizations/{organization_id}/users/{user_id}/projects": {
+ "get": {
+ "tags": ["Organizations"],
+ "summary": "List Projects By User",
+ "description": "List all projects for a user in an organization.",
+ "operationId": "list_projects_by_user_api_v1_organizations__organization_id__users__user_id__projects_get",
"security": [
{
"HTTPBearer": []
@@ -2991,13 +2980,22 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "organization_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "user_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "User Id"
}
},
{
@@ -3018,8 +3016,19 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Project"
+ },
+ "title": "Response List Projects By User Api V1 Organizations Organization Id Users User Id Projects Get"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -3033,11 +3042,11 @@
}
}
},
- "get": {
- "tags": ["Projects"],
- "summary": "Get Project",
- "description": "Get a project by ID.",
- "operationId": "get_project_api_v1_projects__project_id__get",
+ "put": {
+ "tags": ["Organizations"],
+ "summary": "Add User To Project",
+ "description": "Add a user to a project.",
+ "operationId": "add_user_to_project_api_v1_organizations__organization_id__users__user_id__projects_put",
"security": [
{
"HTTPBearer": []
@@ -3048,13 +3057,32 @@
],
"parameters": [
{
- "name": "project_id",
+ "name": "organization_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Project Id"
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "user_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "User Id"
+ }
+ },
+ {
+ "name": "project_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
}
},
{
@@ -3079,9 +3107,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Project"
- }
+ "schema": {}
}
}
},
@@ -3096,12 +3122,14 @@
}
}
}
- },
- "put": {
- "tags": ["Projects"],
- "summary": "Update Existing Project",
- "description": "Update an existing project.",
- "operationId": "update_existing_project_api_v1_projects__project_id__put",
+ }
+ },
+ "/api/v1/organizations/{organization_id}/users/{user_id}/projects/{project_id}": {
+ "delete": {
+ "tags": ["Organizations"],
+ "summary": "Remove User From Project",
+ "description": "Remove a user from a project.",
+ "operationId": "remove_user_from_project_api_v1_organizations__organization_id__users__user_id__projects__project_id__delete",
"security": [
{
"HTTPBearer": []
@@ -3111,6 +3139,25 @@
}
],
"parameters": [
+ {
+ "name": "organization_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "user_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "User Id"
+ }
+ },
{
"name": "project_id",
"in": "path",
@@ -3138,24 +3185,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ProjectUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/Project"
- }
+ "schema": {}
}
}
},
@@ -3172,12 +3207,12 @@
}
}
},
- "/api/v1/projects/{project_id}/eval/dataset": {
- "post": {
+ "/api/v1/projects": {
+ "get": {
"tags": ["Projects"],
- "summary": "Create Eval Dataset For Project",
- "description": "Create a new eval dataset for a project.",
- "operationId": "create_eval_dataset_for_project_api_v1_projects__project_id__eval_dataset_post",
+ "summary": "List Projects",
+ "description": "List projects or get one by name",
+ "operationId": "list_projects_api_v1_projects_get",
"security": [
{
"HTTPBearer": []
@@ -3188,13 +3223,36 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "project_name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Name"
}
},
{
@@ -3214,23 +3272,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalDatasetCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDataset"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Project"
+ },
+ "title": "Response List Projects Api V1 Projects Get"
}
}
}
@@ -3247,11 +3299,11 @@
}
}
},
- "get": {
+ "post": {
"tags": ["Projects"],
- "summary": "List Datasets For Project",
- "description": "List eval datasets for a project.",
- "operationId": "list_datasets_for_project_api_v1_projects__project_id__eval_dataset_get",
+ "summary": "Create Project",
+ "description": "Create a new project.",
+ "operationId": "create_project_api_v1_projects_post",
"security": [
{
"HTTPBearer": []
@@ -3262,13 +3314,20 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -3288,17 +3347,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ProjectCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/EvalDataset"
- },
- "title": "Response List Datasets For Project Api V1 Projects Project Id Eval Dataset Get"
+ "$ref": "#/components/schemas/Project"
}
}
}
@@ -3314,14 +3379,12 @@
}
}
}
- }
- },
- "/api/v1/projects/{project_id}/localevalset": {
- "post": {
+ },
+ "put": {
"tags": ["Projects"],
- "summary": "Create Local Eval Set For Project",
- "description": "Create a new local eval set.",
- "operationId": "create_local_eval_set_for_project_api_v1_projects__project_id__localevalset_post",
+ "summary": "Upsert Project",
+ "description": "Upsert a project.\nUpdates if a project with the same name already exists. Otherwise, creates a new project.",
+ "operationId": "upsert_project_api_v1_projects_put",
"security": [
{
"HTTPBearer": []
@@ -3332,13 +3395,20 @@
],
"parameters": [
{
- "name": "project_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -3363,7 +3433,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LocalEvalSetCreate"
+ "$ref": "#/components/schemas/ProjectCreate"
}
}
}
@@ -3374,11 +3444,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalEvalResults"
- },
- "title": "Response Create Local Eval Set For Project Api V1 Projects Project Id Localevalset Post"
+ "$ref": "#/components/schemas/Project"
}
}
}
@@ -3396,12 +3462,12 @@
}
}
},
- "/api/v1/projects/{project_id}/localeval": {
- "get": {
+ "/api/v1/projects/{project_id}": {
+ "delete": {
"tags": ["Projects"],
- "summary": "List Local Evals For Project",
- "description": "List local eval results for a project.",
- "operationId": "list_local_evals_for_project_api_v1_projects__project_id__localeval_get",
+ "summary": "Delete Project",
+ "description": "Delete a project by ID.",
+ "operationId": "delete_project_api_v1_projects__project_id__delete",
"security": [
{
"HTTPBearer": []
@@ -3416,11 +3482,35 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "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",
@@ -3439,19 +3529,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalEvalResults"
- },
- "title": "Response List Local Evals For Project Api V1 Projects Project Id Localeval Get"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -3464,14 +3543,12 @@
}
}
}
- }
- },
- "/api/v1/projects/{project_id}/localevalsets": {
+ },
"get": {
"tags": ["Projects"],
- "summary": "List Local Eval Sets For Project",
- "description": "List local eval sets for a project.",
- "operationId": "list_local_eval_sets_for_project_api_v1_projects__project_id__localevalsets_get",
+ "summary": "Get Project",
+ "description": "Get a project by ID.",
+ "operationId": "get_project_api_v1_projects__project_id__get",
"security": [
{
"HTTPBearer": []
@@ -3486,11 +3563,35 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "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",
@@ -3514,11 +3615,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalEvalSets"
- },
- "title": "Response List Local Eval Sets For Project Api V1 Projects Project Id Localevalsets Get"
+ "$ref": "#/components/schemas/Project"
}
}
}
@@ -3534,14 +3631,12 @@
}
}
}
- }
- },
- "/api/v1/projects/{project_id}/localevalset/{local_eval_set_id}": {
- "delete": {
+ },
+ "put": {
"tags": ["Projects"],
- "summary": "Delete Local Eval Set",
- "description": "Delete a local eval set.",
- "operationId": "delete_local_eval_set_api_v1_projects__project_id__localevalset__local_eval_set_id__delete",
+ "summary": "Update Existing Project",
+ "description": "Update an existing project.",
+ "operationId": "update_existing_project_api_v1_projects__project_id__put",
"security": [
{
"HTTPBearer": []
@@ -3556,83 +3651,33 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Project Id"
}
},
{
- "name": "local_eval_set_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Local Eval Set Id"
- }
- },
- {
- "name": "session",
- "in": "cookie",
+ "name": "organization_id",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Session"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/projects/{project_id}/prompts": {
- "post": {
- "tags": ["Projects"],
- "summary": "Create Prompt Mixin Prompts",
- "description": "Create a new PromptMixin prompt set.",
- "operationId": "create_prompt_mixin_prompts_api_v1_projects__project_id__prompts_post",
- "security": [
- {
- "HTTPBearer": []
- },
- {
- "HTTPBearer": []
- }
- ],
- "parameters": [
- {
- "name": "project_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -3657,7 +3702,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PromptMixinPrompts"
+ "$ref": "#/components/schemas/ProjectUpdate"
}
}
}
@@ -3668,7 +3713,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PromptMixinPrompts"
+ "$ref": "#/components/schemas/Project"
}
}
}
@@ -3684,12 +3729,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/projects/{project_id}/usage": {
"get": {
"tags": ["Projects"],
- "summary": "List Promptmixin Prompts",
- "description": "List PromptMixin prompt sets for a project.",
- "operationId": "list_promptmixin_prompts_api_v1_projects__project_id__prompts_get",
+ "summary": "Get Project Usage",
+ "description": "Get usage for a project",
+ "operationId": "get_project_usage_api_v1_projects__project_id__usage_get",
"security": [
{
"HTTPBearer": []
@@ -3704,11 +3751,35 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "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",
@@ -3732,11 +3803,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PromptMixinPrompts"
- },
- "title": "Response List Promptmixin Prompts Api V1 Projects Project Id Prompts Get"
+ "$ref": "#/components/schemas/IntervalUsageAndPlan"
}
}
}
@@ -3754,12 +3821,12 @@
}
}
},
- "/api/v1/projects/{project_id}/prompts/{prompt_set_id}": {
- "put": {
+ "/api/v1/projects/{project_id}/eval/dataset": {
+ "post": {
"tags": ["Projects"],
- "summary": "Update Promptmixin Prompts",
- "description": "Update a PromptMixin prompt set.",
- "operationId": "update_promptmixin_prompts_api_v1_projects__project_id__prompts__prompt_set_id__put",
+ "summary": "Create Eval Dataset For Project",
+ "description": "Create a new eval dataset for a project.",
+ "operationId": "create_eval_dataset_for_project_api_v1_projects__project_id__eval_dataset_post",
"security": [
{
"HTTPBearer": []
@@ -3774,19 +3841,33 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Project Id"
}
},
{
- "name": "prompt_set_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Prompt Set Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -3811,7 +3892,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PromptMixinPrompts"
+ "$ref": "#/components/schemas/EvalDatasetCreate"
}
}
}
@@ -3822,7 +3903,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PromptMixinPrompts"
+ "$ref": "#/components/schemas/EvalDataset"
}
}
}
@@ -3839,11 +3920,11 @@
}
}
},
- "delete": {
+ "get": {
"tags": ["Projects"],
- "summary": "Delete Prompt Mixin Prompts",
- "description": "Delete a PromptMixin prompt set.",
- "operationId": "delete_prompt_mixin_prompts_api_v1_projects__project_id__prompts__prompt_set_id__delete",
+ "summary": "List Datasets For Project",
+ "description": "List eval datasets for a project.",
+ "operationId": "list_datasets_for_project_api_v1_projects__project_id__eval_dataset_get",
"security": [
{
"HTTPBearer": []
@@ -3858,19 +3939,33 @@
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
"title": "Project Id"
}
},
{
- "name": "prompt_set_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Prompt Set Id"
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -3895,7 +3990,13 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalDataset"
+ },
+ "title": "Response List Datasets For Project Api V1 Projects Project Id Eval Dataset Get"
+ }
}
}
},
@@ -3912,12 +4013,12 @@
}
}
},
- "/api/v1/files/{id}": {
- "get": {
- "tags": ["Files"],
- "summary": "Get File",
- "description": "Read File metadata objects.",
- "operationId": "get_file_api_v1_files__id__get",
+ "/api/v1/projects/{project_id}/localevalset": {
+ "post": {
+ "tags": ["Projects"],
+ "summary": "Create Local Eval Set For Project",
+ "description": "Create a new local eval set.",
+ "operationId": "create_local_eval_set_for_project_api_v1_projects__project_id__localevalset_post",
"security": [
{
"HTTPBearer": []
@@ -3928,17 +4029,24 @@
],
"parameters": [
{
- "name": "id",
+ "name": "project_id",
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -3951,7 +4059,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -3971,13 +4079,27 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LocalEvalSetCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LocalEvalResults"
+ },
+ "title": "Response Create Local Eval Set For Project Api V1 Projects Project Id Localevalset Post"
}
}
}
@@ -3993,12 +4115,14 @@
}
}
}
- },
- "delete": {
- "tags": ["Files"],
- "summary": "Delete File",
- "description": "Delete the file from S3.",
- "operationId": "delete_file_api_v1_files__id__delete",
+ }
+ },
+ "/api/v1/projects/{project_id}/localeval": {
+ "get": {
+ "tags": ["Projects"],
+ "summary": "List Local Evals For Project",
+ "description": "List local eval results for a project.",
+ "operationId": "list_local_evals_for_project_api_v1_projects__project_id__localeval_get",
"security": [
{
"HTTPBearer": []
@@ -4009,17 +4133,24 @@
],
"parameters": [
{
- "name": "id",
+ "name": "project_id",
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4032,7 +4163,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4053,8 +4184,19 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/LocalEvalResults"
+ },
+ "title": "Response List Local Evals For Project Api V1 Projects Project Id Localeval Get"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -4069,12 +4211,12 @@
}
}
},
- "/api/v1/files": {
+ "/api/v1/projects/{project_id}/localevalsets": {
"get": {
- "tags": ["Files"],
- "summary": "List Files",
- "description": "Read File metadata objects.",
- "operationId": "list_files_api_v1_files_get",
+ "tags": ["Projects"],
+ "summary": "List Local Eval Sets For Project",
+ "description": "List local eval sets for a project.",
+ "operationId": "list_local_eval_sets_for_project_api_v1_projects__project_id__localevalsets_get",
"security": [
{
"HTTPBearer": []
@@ -4086,6 +4228,23 @@
"parameters": [
{
"name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4098,7 +4257,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4126,9 +4285,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/LocalEvalSets"
},
- "title": "Response List Files Api V1 Files Get"
+ "title": "Response List Local Eval Sets For Project Api V1 Projects Project Id Localevalsets Get"
}
}
}
@@ -4144,12 +4303,14 @@
}
}
}
- },
- "put": {
- "tags": ["Files"],
- "summary": "Generate Presigned Url",
- "description": "Create a presigned url for uploading a file.",
- "operationId": "generate_presigned_url_api_v1_files_put",
+ }
+ },
+ "/api/v1/projects/{project_id}/localevalset/{local_eval_set_id}": {
+ "delete": {
+ "tags": ["Projects"],
+ "summary": "Delete Local Eval Set",
+ "description": "Delete a local eval set.",
+ "operationId": "delete_local_eval_set_api_v1_projects__project_id__localevalset__local_eval_set_id__delete",
"security": [
{
"HTTPBearer": []
@@ -4161,6 +4322,33 @@
"parameters": [
{
"name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "local_eval_set_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Local Eval Set Id"
+ }
+ },
+ {
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4173,7 +4361,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4193,24 +4381,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/FileCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/PresignedUrl"
- }
+ "schema": {}
}
}
},
@@ -4225,12 +4401,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/projects/{project_id}/prompts": {
"post": {
- "tags": ["Files"],
- "summary": "Upload File",
- "description": "Upload a file to S3.",
- "operationId": "upload_file_api_v1_files_post",
+ "tags": ["Projects"],
+ "summary": "Create Prompt Mixin Prompts",
+ "description": "Create a new PromptMixin prompt set.",
+ "operationId": "create_prompt_mixin_prompts_api_v1_projects__project_id__prompts_post",
"security": [
{
"HTTPBearer": []
@@ -4242,6 +4420,23 @@
"parameters": [
{
"name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4254,7 +4449,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4277,9 +4472,9 @@
"requestBody": {
"required": true,
"content": {
- "multipart/form-data": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_v1_files_post"
+ "$ref": "#/components/schemas/PromptMixinPrompts"
}
}
}
@@ -4290,7 +4485,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/PromptMixinPrompts"
}
}
}
@@ -4306,16 +4501,14 @@
}
}
}
- }
- },
- "/api/v1/files/sync": {
- "put": {
- "tags": ["Files"],
- "summary": "Sync Files",
- "description": "Sync Files API against file contents uploaded via S3 presigned urls.",
- "operationId": "sync_files_api_v1_files_sync_put",
- "security": [
- {
+ },
+ "get": {
+ "tags": ["Projects"],
+ "summary": "List Promptmixin Prompts",
+ "description": "List PromptMixin prompt sets for a project.",
+ "operationId": "list_promptmixin_prompts_api_v1_projects__project_id__prompts_get",
+ "security": [
+ {
"HTTPBearer": []
},
{
@@ -4325,6 +4518,23 @@
"parameters": [
{
"name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4337,7 +4547,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4365,9 +4575,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/File"
+ "$ref": "#/components/schemas/PromptMixinPrompts"
},
- "title": "Response Sync Files Api V1 Files Sync Put"
+ "title": "Response List Promptmixin Prompts Api V1 Projects Project Id Prompts Get"
}
}
}
@@ -4385,12 +4595,12 @@
}
}
},
- "/api/v1/files/{id}/content": {
- "get": {
- "tags": ["Files"],
- "summary": "Read File Content",
- "description": "Returns a presigned url to read the file content.",
- "operationId": "read_file_content_api_v1_files__id__content_get",
+ "/api/v1/projects/{project_id}/prompts/{prompt_set_id}": {
+ "put": {
+ "tags": ["Projects"],
+ "summary": "Update Promptmixin Prompts",
+ "description": "Update a PromptMixin prompt set.",
+ "operationId": "update_promptmixin_prompts_api_v1_projects__project_id__prompts__prompt_set_id__put",
"security": [
{
"HTTPBearer": []
@@ -4401,17 +4611,34 @@
],
"parameters": [
{
- "name": "id",
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "prompt_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Id"
+ "title": "Prompt Set Id"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4424,7 +4651,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4444,13 +4671,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PromptMixinPrompts"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PresignedUrl"
+ "$ref": "#/components/schemas/PromptMixinPrompts"
}
}
}
@@ -4466,14 +4703,12 @@
}
}
}
- }
- },
- "/api/v1/files/{id}/page_screenshots": {
- "get": {
- "tags": ["Files"],
- "summary": "List File Page Screenshots",
- "description": "List metadata for all screenshots of pages from a file.",
- "operationId": "list_file_page_screenshots_api_v1_files__id__page_screenshots_get",
+ },
+ "delete": {
+ "tags": ["Projects"],
+ "summary": "Delete Prompt Mixin Prompts",
+ "description": "Delete a PromptMixin prompt set.",
+ "operationId": "delete_prompt_mixin_prompts_api_v1_projects__project_id__prompts__prompt_set_id__delete",
"security": [
{
"HTTPBearer": []
@@ -4484,17 +4719,34 @@
],
"parameters": [
{
- "name": "id",
+ "name": "project_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ }
+ },
+ {
+ "name": "prompt_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Id"
+ "title": "Prompt Set Id"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4507,7 +4759,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4532,13 +4784,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PageScreenshotMetadata"
- },
- "title": "Response List File Page Screenshots Api V1 Files Id Page Screenshots Get"
- }
+ "schema": {}
}
}
},
@@ -4555,12 +4801,12 @@
}
}
},
- "/api/v1/files/{id}/page_screenshots/{page_index}": {
+ "/api/v1/files/{id}": {
"get": {
"tags": ["Files"],
- "summary": "Get File Page Screenshot",
- "description": "Get screenshot of a page from a file.",
- "operationId": "get_file_page_screenshot_api_v1_files__id__page_screenshots__page_index__get",
+ "summary": "Get File",
+ "description": "Read File metadata objects.",
+ "operationId": "get_file_api_v1_files__id__get",
"security": [
{
"HTTPBearer": []
@@ -4581,16 +4827,24 @@
}
},
{
- "name": "page_index",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "integer",
- "title": "Page Index"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4603,7 +4857,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4628,7 +4882,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/File"
+ }
}
}
},
@@ -4643,14 +4899,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines": {
- "get": {
- "tags": ["Pipelines"],
- "summary": "Search Pipelines",
- "description": "Search for pipelines by various parameters.",
- "operationId": "search_pipelines_api_v1_pipelines_get",
+ },
+ "delete": {
+ "tags": ["Files"],
+ "summary": "Delete File",
+ "description": "Delete the file from S3.",
+ "operationId": "delete_file_api_v1_files__id__delete",
"security": [
{
"HTTPBearer": []
@@ -4661,55 +4915,34 @@
],
"parameters": [
{
- "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"
}
},
{
- "name": "project_id",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
@@ -4722,7 +4955,7 @@
"type": "null"
}
],
- "title": "Project Id"
+ "title": "Organization Id"
}
},
{
@@ -4743,19 +4976,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Pipeline"
- },
- "title": "Response Search Pipelines Api V1 Pipelines Get"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -4768,12 +4990,14 @@
}
}
}
- },
- "post": {
- "tags": ["Pipelines"],
- "summary": "Create Pipeline",
- "description": "Create a new pipeline for a project.",
- "operationId": "create_pipeline_api_v1_pipelines_post",
+ }
+ },
+ "/api/v1/files": {
+ "get": {
+ "tags": ["Files"],
+ "summary": "List Files",
+ "description": "Read File metadata objects.",
+ "operationId": "list_files_api_v1_files_get",
"security": [
{
"HTTPBearer": []
@@ -4801,13 +5025,30 @@
}
},
{
- "name": "session",
- "in": "cookie",
+ "name": "organization_id",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
"type": "null"
@@ -4817,23 +5058,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/File"
+ },
+ "title": "Response List Files Api V1 Files Get"
}
}
}
@@ -4851,10 +5086,10 @@
}
},
"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",
+ "tags": ["Files"],
+ "summary": "Generate Presigned Url",
+ "description": "Create a presigned url for uploading a file.",
+ "operationId": "generate_presigned_url_api_v1_files_put",
"security": [
{
"HTTPBearer": []
@@ -4881,6 +5116,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",
@@ -4903,7 +5155,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineCreate"
+ "$ref": "#/components/schemas/FileCreate"
}
}
}
@@ -4914,7 +5166,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "$ref": "#/components/schemas/PresignedUrl"
}
}
}
@@ -4930,14 +5182,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}": {
- "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",
+ },
+ "post": {
+ "tags": ["Files"],
+ "summary": "Upload File",
+ "description": "Upload a file to S3.",
+ "operationId": "upload_file_api_v1_files_post",
"security": [
{
"HTTPBearer": []
@@ -4948,13 +5198,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"
}
},
{
@@ -4974,13 +5248,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_files_post"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "$ref": "#/components/schemas/File"
}
}
}
@@ -4996,12 +5280,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/files/sync": {
"put": {
- "tags": ["Pipelines"],
- "summary": "Update Existing Pipeline",
- "description": "Update an existing pipeline for a project.",
- "operationId": "update_existing_pipeline_api_v1_pipelines__pipeline_id__put",
+ "tags": ["Files"],
+ "summary": "Sync Files",
+ "description": "Sync Files API against file contents uploaded via S3 presigned urls.",
+ "operationId": "sync_files_api_v1_files_sync_put",
"security": [
{
"HTTPBearer": []
@@ -5012,13 +5298,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"
}
},
{
@@ -5038,23 +5348,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/File"
+ },
+ "title": "Response Sync Files Api V1 Files Sync Put"
}
}
}
@@ -5070,12 +5374,14 @@
}
}
}
- },
- "delete": {
- "tags": ["Pipelines"],
- "summary": "Delete Pipeline",
- "description": "Delete a pipeline by ID.",
- "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete",
+ }
+ },
+ "/api/v1/files/upload_from_url": {
+ "put": {
+ "tags": ["Files"],
+ "summary": "Upload File From Url",
+ "description": "Upload a file to S3 from a URL.",
+ "operationId": "upload_file_from_url_api_v1_files_upload_from_url_put",
"security": [
{
"HTTPBearer": []
@@ -5086,13 +5392,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"
}
},
{
@@ -5112,9 +5442,26 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FileCreateFromUrl"
+ }
+ }
+ }
+ },
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/File"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -5129,12 +5476,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/status": {
+ "/api/v1/files/{id}/content": {
"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",
+ "tags": ["Files"],
+ "summary": "Read File Content",
+ "description": "Returns a presigned url to read the file content.",
+ "operationId": "read_file_content_api_v1_files__id__content_get",
"security": [
{
"HTTPBearer": []
@@ -5145,79 +5492,47 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Id"
}
},
{
- "name": "session",
- "in": "cookie",
+ "name": "project_id",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"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"
- }
- }
+ "title": "Project Id"
}
- }
- }
- }
- },
- "/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",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -5243,7 +5558,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "$ref": "#/components/schemas/PresignedUrl"
}
}
}
@@ -5261,12 +5576,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/copy": {
- "post": {
- "tags": ["Pipelines"],
- "summary": "Copy Pipeline",
- "description": "Copy a pipeline by ID.",
- "operationId": "copy_pipeline_api_v1_pipelines__pipeline_id__copy_post",
+ "/api/v1/files/{id}/page_screenshots": {
+ "get": {
+ "tags": ["Files"],
+ "summary": "List File Page Screenshots",
+ "description": "List metadata for all screenshots of pages from a file.",
+ "operationId": "list_file_page_screenshots_api_v1_files__id__page_screenshots_get",
"security": [
{
"HTTPBearer": []
@@ -5277,13 +5592,47 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline 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"
}
},
{
@@ -5309,7 +5658,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PageScreenshotMetadata"
+ },
+ "title": "Response List File Page Screenshots Api V1 Files Id Page Screenshots Get"
}
}
}
@@ -5327,12 +5680,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute": {
- "post": {
- "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",
+ "/api/v1/files/{id}/page_screenshots/{page_index}": {
+ "get": {
+ "tags": ["Files"],
+ "summary": "Get File Page Screenshot",
+ "description": "Get screenshot of a page from a file.",
+ "operationId": "get_file_page_screenshot_api_v1_files__id__page_screenshots__page_index__get",
"security": [
{
"HTTPBearer": []
@@ -5343,23 +5696,56 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Id"
}
},
{
- "name": "eval_dataset_id",
+ "name": "page_index",
"in": "path",
"required": true,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
+ "type": "integer",
+ "title": "Page Index"
+ }
+ },
+ {
+ "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"
}
},
{
@@ -5379,24 +5765,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalExecutionCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalDatasetJobRecord"
- }
+ "schema": {}
}
}
},
@@ -5411,12 +5785,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/pipelines": {
"get": {
"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": "Search Pipelines",
+ "description": "Search for pipelines by various parameters.",
+ "operationId": "search_pipelines_api_v1_pipelines_get",
"security": [
{
"HTTPBearer": []
@@ -5427,28 +5803,25 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
- }
- },
- {
- "name": "eval_dataset_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "session",
- "in": "cookie",
+ "name": "project_name",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
@@ -5459,71 +5832,56 @@
"type": "null"
}
],
- "title": "Session"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "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"
- }
- }
+ "title": "Project Name"
}
},
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
+ {
+ "name": "pipeline_name",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Pipeline Name"
}
- }
- }
- }
- },
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/result": {
- "get": {
- "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",
- "security": [
- {
- "HTTPBearer": []
},
{
- "HTTPBearer": []
- }
- ],
- "parameters": [
- {
- "name": "pipeline_id",
- "in": "path",
- "required": true,
+ "name": "pipeline_type",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/PipelineType"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Pipeline Type"
}
},
{
- "name": "eval_dataset_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -5551,9 +5909,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/EvalQuestionResult"
+ "$ref": "#/components/schemas/Pipeline"
},
- "title": "Response Get Eval Dataset Execution Result Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Result Get"
+ "title": "Response Search Pipelines Api V1 Pipelines Get"
}
}
}
@@ -5569,14 +5927,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/{eval_dataset_execution_id}": {
- "get": {
+ },
+ "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": "Create Pipeline",
+ "description": "Create a new pipeline for a project.",
+ "operationId": "create_pipeline_api_v1_pipelines_post",
"security": [
{
"HTTPBearer": []
@@ -5587,33 +5943,37 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
- }
- },
- {
- "name": "eval_dataset_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
- "name": "eval_dataset_execution_id",
- "in": "path",
- "required": true,
+ "name": "organization_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Eval Dataset Execution Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -5633,13 +5993,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDatasetJobRecord"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -5655,14 +6025,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/files": {
- "get": {
+ },
+ "put": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Files",
- "description": "Get files for a pipeline.",
- "operationId": "list_pipeline_files_api_v1_pipelines__pipeline_id__files_get",
+ "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": []
@@ -5673,17 +6041,7 @@
],
"parameters": [
{
- "name": "pipeline_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Pipeline Id"
- }
- },
- {
- "name": "data_source_id",
+ "name": "project_id",
"in": "query",
"required": false,
"schema": {
@@ -5696,17 +6054,24 @@
"type": "null"
}
],
- "title": "Data Source Id"
+ "title": "Project Id"
}
},
{
- "name": "only_manually_uploaded",
+ "name": "organization_id",
"in": "query",
"required": false,
"schema": {
- "type": "boolean",
- "default": false,
- "title": "Only Manually Uploaded"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Organization Id"
}
},
{
@@ -5726,17 +6091,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineFile"
- },
- "title": "Response List Pipeline Files Api V1 Pipelines Pipeline Id Files Get"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -5752,12 +6123,14 @@
}
}
}
- },
- "put": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}": {
+ "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 Pipeline",
+ "description": "Get a pipeline by ID for a given project.",
+ "operationId": "get_pipeline_api_v1_pipelines__pipeline_id__get",
"security": [
{
"HTTPBearer": []
@@ -5794,31 +6167,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineFileCreate"
- },
- "title": "Pipeline File Creates"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineFile"
- },
- "title": "Response Add Files To Pipeline Api V1 Pipelines Pipeline Id Files Put"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -5834,14 +6189,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/files/{file_id}/status": {
- "get": {
+ },
+ "put": {
"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": "Update Existing Pipeline",
+ "description": "Update an existing pipeline for a project.",
+ "operationId": "update_existing_pipeline_api_v1_pipelines__pipeline_id__put",
"security": [
{
"HTTPBearer": []
@@ -5861,16 +6214,6 @@
"title": "Pipeline Id"
}
},
- {
- "name": "file_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "File Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -5888,13 +6231,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -5910,14 +6263,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/files/{file_id}": {
- "put": {
+ },
+ "delete": {
"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": "Delete Pipeline",
+ "description": "Delete a pipeline by ID.",
+ "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete",
"security": [
{
"HTTPBearer": []
@@ -5937,16 +6288,6 @@
"title": "Pipeline Id"
}
},
- {
- "name": "file_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "File Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -5964,26 +6305,9 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineFileUpdate"
- }
- }
- }
- },
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineFile"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -5996,12 +6320,14 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/status": {
+ "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": "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": []
@@ -6021,16 +6347,6 @@
"title": "Pipeline Id"
}
},
- {
- "name": "file_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "File Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -6049,8 +6365,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -6065,12 +6388,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/metadata": {
- "put": {
+ "/api/v1/pipelines/{pipeline_id}/sync": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Import Pipeline Metadata",
- "description": "Import metadata for a pipeline.",
- "operationId": "import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put",
+ "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": []
@@ -6107,27 +6430,13 @@
}
}
],
- "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": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "title": "Response Import Pipeline Metadata Api V1 Pipelines Pipeline Id Metadata Put"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -6143,12 +6452,14 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/copy": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Delete Pipeline Files Metadata",
- "description": "Delete metadata for all files in a pipeline.",
- "operationId": "delete_pipeline_files_metadata_api_v1_pipelines__pipeline_id__metadata_delete",
+ "summary": "Copy Pipeline",
+ "description": "Copy a pipeline by ID.",
+ "operationId": "copy_pipeline_api_v1_pipelines__pipeline_id__copy_post",
"security": [
{
"HTTPBearer": []
@@ -6186,8 +6497,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Pipeline"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -6202,12 +6520,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/data-sources": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Data Sources",
- "description": "Get data sources for a pipeline.",
- "operationId": "list_pipeline_data_sources_api_v1_pipelines__pipeline_id__data_sources_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": []
@@ -6217,6 +6535,16 @@
}
],
"parameters": [
+ {
+ "name": "eval_dataset_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Eval Dataset Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -6244,17 +6572,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalExecutionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineDataSource"
- },
- "title": "Response List Pipeline Data Sources Api V1 Pipelines Pipeline Id Data Sources Get"
+ "$ref": "#/components/schemas/EvalDatasetJobRecord"
}
}
}
@@ -6271,11 +6605,11 @@
}
}
},
- "put": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Add Data Sources To Pipeline",
- "description": "Add data sources to a pipeline.",
- "operationId": "add_data_sources_to_pipeline_api_v1_pipelines__pipeline_id__data_sources_put",
+ "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": []
@@ -6285,6 +6619,16 @@
}
],
"parameters": [
+ {
+ "name": "eval_dataset_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Eval Dataset Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -6312,20 +6656,6 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineDataSourceCreate"
- },
- "title": "Pipeline Data Source Creates"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
@@ -6334,9 +6664,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/PipelineDataSource"
+ "$ref": "#/components/schemas/EvalDatasetJobRecord"
},
- "title": "Response Add Data Sources To Pipeline Api V1 Pipelines Pipeline Id Data Sources Put"
+ "title": "Response Get Eval Dataset Executions Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Get"
}
}
}
@@ -6354,12 +6684,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}": {
- "put": {
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/result": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Update Pipeline Data Source",
- "description": "Update the configuration of a data source in a pipeline.",
- "operationId": "update_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__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": []
@@ -6370,23 +6700,23 @@
],
"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",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Data Source Id"
+ "title": "Pipeline Id"
}
},
{
@@ -6406,23 +6736,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PipelineDataSourceUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineDataSource"
+ "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"
}
}
}
@@ -6438,12 +6762,14 @@
}
}
}
- },
- "delete": {
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/{eval_dataset_execution_id}": {
+ "get": {
"tags": ["Pipelines"],
- "summary": "Delete Pipeline Data Source",
- "description": "Delete a data source from a pipeline.",
- "operationId": "delete_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__delete",
+ "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": []
@@ -6454,74 +6780,25 @@
],
"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",
+ "name": "eval_dataset_execution_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Data Source 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"
- }
- }
+ "title": "Eval Dataset Execution Id"
}
- }
- }
- }
- },
- "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync": {
- "post": {
- "tags": ["Pipelines"],
- "summary": "Sync Pipeline Data Source",
- "description": "Run ingestion for the pipeline data source by incrementally updating the data-sink with upstream changes from data-source.",
- "operationId": "sync_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__sync_post",
- "security": [
- {
- "HTTPBearer": []
},
- {
- "HTTPBearer": []
- }
- ],
- "parameters": [
{
"name": "pipeline_id",
"in": "path",
@@ -6532,16 +6809,6 @@
"title": "Pipeline Id"
}
},
- {
- "name": "data_source_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Data Source Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -6565,7 +6832,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Pipeline"
+ "$ref": "#/components/schemas/EvalDatasetJobRecord"
}
}
}
@@ -6583,12 +6850,13 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status": {
+ "/api/v1/pipelines/{pipeline_id}/files": {
"get": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline Data Source Status",
- "description": "Get the status of a data source for a pipeline.",
- "operationId": "get_pipeline_data_source_status_api_v1_pipelines__pipeline_id__data_sources__data_source_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": []
@@ -6610,14 +6878,31 @@
},
{
"name": "data_source_id",
- "in": "path",
- "required": true,
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
+ "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": "session",
"in": "cookie",
@@ -6641,7 +6926,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"
}
}
}
@@ -6657,14 +6946,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/retrieve": {
- "post": {
+ },
+ "put": {
"tags": ["Pipelines"],
- "summary": "Run Search",
- "description": "Get retrieval results for a managed pipeline and a query",
- "operationId": "run_search_api_v1_pipelines__pipeline_id__retrieve_post",
+ "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": []
@@ -6706,7 +6993,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RetrievalParams"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineFileCreate"
+ },
+ "title": "Pipeline File Creates"
}
}
}
@@ -6717,7 +7008,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/RetrieveResults"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineFile"
+ },
+ "title": "Response Add Files To Pipeline Api V1 Pipelines Pipeline Id Files Put"
}
}
}
@@ -6735,12 +7030,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/jobs": {
+ "/api/v1/pipelines/{pipeline_id}/files2": {
"get": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Jobs",
- "description": "Get jobs for a pipeline.",
- "operationId": "list_pipeline_jobs_api_v1_pipelines__pipeline_id__jobs_get",
+ "summary": "List Pipeline Files2",
+ "description": "Get files for a pipeline.",
+ "operationId": "list_pipeline_files2_api_v1_pipelines__pipeline_id__files2_get",
"security": [
{
"HTTPBearer": []
@@ -6760,6 +7055,65 @@
"title": "Pipeline Id"
}
},
+ {
+ "name": "data_source_id",
+ "in": "query",
+ "required": false,
+ "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"
+ }
+ },
+ {
+ "name": "offset",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Offset"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -6783,11 +7137,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PipelineDeployment"
- },
- "title": "Response List Pipeline Jobs Api V1 Pipelines Pipeline Id Jobs Get"
+ "$ref": "#/components/schemas/PaginatedListPipelineFilesResponse"
}
}
}
@@ -6805,12 +7155,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/jobs/{job_id}": {
+ "/api/v1/pipelines/{pipeline_id}/files/{file_id}/status": {
"get": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline Job",
- "description": "Get a job for a pipeline.",
- "operationId": "get_pipeline_job_api_v1_pipelines__pipeline_id__jobs__job_id__get",
+ "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": []
@@ -6821,23 +7171,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "file_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "File Id"
}
},
{
- "name": "job_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Pipeline Id"
}
},
{
@@ -6863,7 +7213,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PipelineDeployment"
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
}
}
}
@@ -6881,12 +7231,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/playground-session": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/files/{file_id}": {
+ "put": {
"tags": ["Pipelines"],
- "summary": "Get Playground Session",
- "description": "Get a playground session for a user and pipeline.",
- "operationId": "get_playground_session_api_v1_pipelines__pipeline_id__playground_session_get",
+ "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": []
@@ -6896,6 +7246,16 @@
}
],
"parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -6923,13 +7283,23 @@
}
}
],
- "responses": {
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineFileUpdate"
+ }
+ }
+ }
+ },
+ "responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PlaygroundSession"
+ "$ref": "#/components/schemas/PipelineFile"
}
}
}
@@ -6945,14 +7315,12 @@
}
}
}
- }
- },
- "/api/v1/pipelines/{pipeline_id}/chat": {
- "post": {
+ },
+ "delete": {
"tags": ["Pipelines"],
- "summary": "Chat",
- "description": "Make a retrieval query + chat completion for a managed pipeline.",
- "operationId": "chat_api_v1_pipelines__pipeline_id__chat_post",
+ "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": []
@@ -6962,6 +7330,16 @@
}
],
"parameters": [
+ {
+ "name": "file_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "File Id"
+ }
+ },
{
"name": "pipeline_id",
"in": "path",
@@ -6989,24 +7367,9 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChatInputParams"
- }
- }
- }
- },
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -7021,12 +7384,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/documents": {
- "post": {
+ "/api/v1/pipelines/{pipeline_id}/metadata": {
+ "put": {
"tags": ["Pipelines"],
- "summary": "Create Batch Pipeline Documents",
- "description": "Batch create documents for a pipeline.",
- "operationId": "create_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_post",
+ "summary": "Import Pipeline Metadata",
+ "description": "Import metadata for a pipeline.",
+ "operationId": "import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put",
"security": [
{
"HTTPBearer": []
@@ -7066,13 +7429,9 @@
"requestBody": {
"required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudDocumentCreate"
- },
- "title": "Documents"
+ "$ref": "#/components/schemas/Body_import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put"
}
}
}
@@ -7083,11 +7442,11 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudDocument"
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
},
- "title": "Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post"
+ "title": "Response Import Pipeline Metadata Api V1 Pipelines Pipeline Id Metadata Put"
}
}
}
@@ -7104,11 +7463,11 @@
}
}
},
- "get": {
+ "delete": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Documents",
- "description": "Return a list of documents for a pipeline.",
- "operationId": "list_pipeline_documents_api_v1_pipelines__pipeline_id__documents_get",
+ "summary": "Delete Pipeline Files Metadata",
+ "description": "Delete metadata for all files in a pipeline.",
+ "operationId": "delete_pipeline_files_metadata_api_v1_pipelines__pipeline_id__metadata_delete",
"security": [
{
"HTTPBearer": []
@@ -7129,59 +7488,62 @@
}
},
{
- "name": "skip",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 0,
- "default": 0,
- "title": "Skip"
- }
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "minimum": 0,
- "default": 10,
- "title": "Limit"
- }
- },
- {
- "name": "file_id",
- "in": "query",
+ "name": "session",
+ "in": "cookie",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "File Id"
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Successful Response"
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
}
+ }
+ }
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/data-sources": {
+ "get": {
+ "tags": ["Pipelines"],
+ "summary": "List Pipeline Data Sources",
+ "description": "Get data sources for a pipeline.",
+ "operationId": "list_pipeline_data_sources_api_v1_pipelines__pipeline_id__data_sources_get",
+ "security": [
+ {
+ "HTTPBearer": []
},
{
- "name": "only_direct_upload",
- "in": "query",
- "required": false,
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "default": false,
- "title": "Only Direct Upload"
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7209,9 +7571,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CloudDocument"
+ "$ref": "#/components/schemas/PipelineDataSource"
},
- "title": "Response List Pipeline Documents Api V1 Pipelines Pipeline Id Documents Get"
+ "title": "Response List Pipeline Data Sources Api V1 Pipelines Pipeline Id Data Sources Get"
}
}
}
@@ -7230,9 +7592,9 @@
},
"put": {
"tags": ["Pipelines"],
- "summary": "Upsert Batch Pipeline Documents",
- "description": "Batch create or update a document for a pipeline.",
- "operationId": "upsert_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_put",
+ "summary": "Add Data Sources To Pipeline",
+ "description": "Add data sources to a pipeline.",
+ "operationId": "add_data_sources_to_pipeline_api_v1_pipelines__pipeline_id__data_sources_put",
"security": [
{
"HTTPBearer": []
@@ -7276,9 +7638,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CloudDocumentCreate"
+ "$ref": "#/components/schemas/PipelineDataSourceCreate"
},
- "title": "Documents"
+ "title": "Pipeline Data Source Creates"
}
}
}
@@ -7291,9 +7653,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/CloudDocument"
+ "$ref": "#/components/schemas/PipelineDataSource"
},
- "title": "Response Upsert Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Put"
+ "title": "Response Add Data Sources To Pipeline Api V1 Pipelines Pipeline Id Data Sources Put"
}
}
}
@@ -7311,12 +7673,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/documents/{document_id}": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}": {
+ "put": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline Document",
- "description": "Return a single document for a pipeline.",
- "operationId": "get_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__get",
+ "summary": "Update Pipeline Data Source",
+ "description": "Update the configuration of a data source in a pipeline.",
+ "operationId": "update_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__put",
"security": [
{
"HTTPBearer": []
@@ -7327,22 +7689,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Data Source Id"
}
},
{
- "name": "document_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Document Id"
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7362,13 +7725,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineDataSourceUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/CloudDocument"
+ "$ref": "#/components/schemas/PipelineDataSource"
}
}
}
@@ -7387,9 +7760,9 @@
},
"delete": {
"tags": ["Pipelines"],
- "summary": "Delete Pipeline Document",
- "description": "Delete a document for a pipeline.",
- "operationId": "delete_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__delete",
+ "summary": "Delete Pipeline Data Source",
+ "description": "Delete a data source from a pipeline.",
+ "operationId": "delete_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__delete",
"security": [
{
"HTTPBearer": []
@@ -7400,22 +7773,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Data Source Id"
}
},
{
- "name": "document_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Document Id"
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7452,12 +7826,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status": {
- "get": {
+ "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync": {
+ "post": {
"tags": ["Pipelines"],
- "summary": "Get Pipeline Document Status",
- "description": "Return a single document for a pipeline.",
- "operationId": "get_pipeline_document_status_api_v1_pipelines__pipeline_id__documents__document_id__status_get",
+ "summary": "Sync Pipeline Data Source",
+ "description": "Run ingestion for the pipeline data source by incrementally updating the data-sink with upstream changes from data-source.",
+ "operationId": "sync_pipeline_data_source_api_v1_pipelines__pipeline_id__data_sources__data_source_id__sync_post",
"security": [
{
"HTTPBearer": []
@@ -7468,22 +7842,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Data Source Id"
}
},
{
- "name": "document_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Document Id"
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7509,7 +7884,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ "$ref": "#/components/schemas/Pipeline"
}
}
}
@@ -7527,12 +7902,12 @@
}
}
},
- "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks": {
+ "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status": {
"get": {
"tags": ["Pipelines"],
- "summary": "List Pipeline Document Chunks",
- "description": "Return a list of chunks for a pipeline document.",
- "operationId": "list_pipeline_document_chunks_api_v1_pipelines__pipeline_id__documents__document_id__chunks_get",
+ "summary": "Get Pipeline Data Source Status",
+ "description": "Get the status of a data source for a pipeline.",
+ "operationId": "get_pipeline_data_source_status_api_v1_pipelines__pipeline_id__data_sources__data_source_id__status_get",
"security": [
{
"HTTPBearer": []
@@ -7543,22 +7918,23 @@
],
"parameters": [
{
- "name": "pipeline_id",
+ "name": "data_source_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Pipeline Id"
+ "title": "Data Source Id"
}
},
{
- "name": "document_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Document Id"
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7584,11 +7960,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TextNode"
- },
- "title": "Response List Pipeline Document Chunks Api V1 Pipelines Pipeline Id Documents Document Id Chunks Get"
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
}
}
}
@@ -7606,12 +7978,12 @@
}
}
},
- "/api/v1/evals/datasets/{dataset_id}": {
- "get": {
- "tags": ["Evals"],
- "summary": "Get Dataset",
- "description": "Get a dataset by ID.",
- "operationId": "get_dataset_api_v1_evals_datasets__dataset_id__get",
+ "/api/v1/pipelines/{pipeline_id}/retrieve": {
+ "post": {
+ "tags": ["Pipelines"],
+ "summary": "Run Search",
+ "description": "Get retrieval results for a managed pipeline and a query",
+ "operationId": "run_search_api_v1_pipelines__pipeline_id__retrieve_post",
"security": [
{
"HTTPBearer": []
@@ -7622,13 +7994,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Pipeline Id"
}
},
{
@@ -7648,13 +8020,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RetrievalParams"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDataset"
+ "$ref": "#/components/schemas/RetrieveResults"
}
}
}
@@ -7670,12 +8052,14 @@
}
}
}
- },
- "put": {
- "tags": ["Evals"],
- "summary": "Update Dataset",
- "description": "Update a dataset.",
- "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put",
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/jobs": {
+ "get": {
+ "tags": ["Pipelines"],
+ "summary": "List Pipeline Jobs",
+ "description": "Get jobs for a pipeline.",
+ "operationId": "list_pipeline_jobs_api_v1_pipelines__pipeline_id__jobs_get",
"security": [
{
"HTTPBearer": []
@@ -7686,13 +8070,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Pipeline Id"
}
},
{
@@ -7712,23 +8096,17 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalDatasetUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalDataset"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PipelineDeployment"
+ },
+ "title": "Response List Pipeline Jobs Api V1 Pipelines Pipeline Id Jobs Get"
}
}
}
@@ -7744,12 +8122,14 @@
}
}
}
- },
- "delete": {
- "tags": ["Evals"],
- "summary": "Delete Dataset",
- "description": "Delete a dataset.",
- "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete",
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/jobs/{job_id}": {
+ "get": {
+ "tags": ["Pipelines"],
+ "summary": "Get Pipeline Job",
+ "description": "Get a job for a pipeline.",
+ "operationId": "get_pipeline_job_api_v1_pipelines__pipeline_id__jobs__job_id__get",
"security": [
{
"HTTPBearer": []
@@ -7760,13 +8140,23 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -7787,8 +8177,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PipelineDeployment"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -7803,12 +8200,12 @@
}
}
},
- "/api/v1/evals/datasets/{dataset_id}/question": {
- "post": {
- "tags": ["Evals"],
- "summary": "Create Question",
- "description": "Create a new question.",
- "operationId": "create_question_api_v1_evals_datasets__dataset_id__question_post",
+ "/api/v1/pipelines/{pipeline_id}/playground-session": {
+ "get": {
+ "tags": ["Pipelines"],
+ "summary": "Get Playground Session",
+ "description": "Get a playground session for a user and pipeline.",
+ "operationId": "get_playground_session_api_v1_pipelines__pipeline_id__playground_session_get",
"security": [
{
"HTTPBearer": []
@@ -7819,13 +8216,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Pipeline Id"
}
},
{
@@ -7845,23 +8242,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "$ref": "#/components/schemas/PlaygroundSession"
}
}
}
@@ -7877,12 +8264,14 @@
}
}
}
- },
- "get": {
- "tags": ["Evals"],
- "summary": "List Questions",
- "description": "List questions for a dataset.",
- "operationId": "list_questions_api_v1_evals_datasets__dataset_id__question_get",
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/chat": {
+ "post": {
+ "tags": ["Pipelines"],
+ "summary": "Chat",
+ "description": "Make a retrieval query + chat completion for a managed pipeline.",
+ "operationId": "chat_api_v1_pipelines__pipeline_id__chat_post",
"security": [
{
"HTTPBearer": []
@@ -7893,13 +8282,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Pipeline Id"
}
},
{
@@ -7919,18 +8308,22 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ChatInputParams"
+ }
+ }
+ }
+ },
"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"
- }
+ "schema": {}
}
}
},
@@ -7947,12 +8340,12 @@
}
}
},
- "/api/v1/evals/datasets/{dataset_id}/questions": {
+ "/api/v1/pipelines/{pipeline_id}/documents": {
"post": {
- "tags": ["Evals"],
- "summary": "Create Questions",
- "description": "Create a new question.",
- "operationId": "create_questions_api_v1_evals_datasets__dataset_id__questions_post",
+ "tags": ["Pipelines"],
+ "summary": "Create Batch Pipeline Documents",
+ "description": "Batch create documents for a pipeline.",
+ "operationId": "create_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_post",
"security": [
{
"HTTPBearer": []
@@ -7963,13 +8356,13 @@
],
"parameters": [
{
- "name": "dataset_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Dataset Id"
+ "title": "Pipeline Id"
}
},
{
@@ -7996,9 +8389,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
+ "$ref": "#/components/schemas/CloudDocumentCreate"
},
- "title": "Payload"
+ "title": "Documents"
}
}
}
@@ -8011,9 +8404,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "$ref": "#/components/schemas/CloudDocument"
},
- "title": "Response Create Questions Api V1 Evals Datasets Dataset Id Questions Post"
+ "title": "Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post"
}
}
}
@@ -8029,14 +8422,12 @@
}
}
}
- }
- },
- "/api/v1/evals/questions/{question_id}": {
+ },
"get": {
- "tags": ["Evals"],
- "summary": "Get Question",
- "description": "Get a question by ID.",
- "operationId": "get_question_api_v1_evals_questions__question_id__get",
+ "tags": ["Pipelines"],
+ "summary": "List Pipeline Documents",
+ "description": "Return a list of documents for a pipeline.",
+ "operationId": "list_pipeline_documents_api_v1_pipelines__pipeline_id__documents_get",
"security": [
{
"HTTPBearer": []
@@ -8047,29 +8438,85 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Pipeline Id"
}
},
{
- "name": "session",
- "in": "cookie",
+ "name": "skip",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 0,
+ "title": "Skip"
+ }
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 0,
+ "default": 10,
+ "title": "Limit"
+ }
+ },
+ {
+ "name": "file_id",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
],
- "title": "Session"
+ "title": "File Id"
+ }
+ },
+ {
+ "name": "only_direct_upload",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": false,
+ "title": "Only Direct Upload"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
}
}
],
@@ -8079,7 +8526,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudDocument"
+ },
+ "title": "Response List Pipeline Documents Api V1 Pipelines Pipeline Id Documents Get"
}
}
}
@@ -8097,10 +8548,10 @@
}
},
"put": {
- "tags": ["Evals"],
- "summary": "Replace Question",
- "description": "Replace a question.",
- "operationId": "replace_question_api_v1_evals_questions__question_id__put",
+ "tags": ["Pipelines"],
+ "summary": "Upsert Batch Pipeline Documents",
+ "description": "Batch create or update a document for a pipeline.",
+ "operationId": "upsert_batch_pipeline_documents_api_v1_pipelines__pipeline_id__documents_put",
"security": [
{
"HTTPBearer": []
@@ -8111,13 +8562,13 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Pipeline Id"
}
},
{
@@ -8142,7 +8593,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestionCreate"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudDocumentCreate"
+ },
+ "title": "Documents"
}
}
}
@@ -8153,7 +8608,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/EvalQuestion"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudDocument"
+ },
+ "title": "Response Upsert Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Put"
}
}
}
@@ -8169,12 +8628,14 @@
}
}
}
- },
- "delete": {
- "tags": ["Evals"],
- "summary": "Delete Question",
- "description": "Delete a question.",
- "operationId": "delete_question_api_v1_evals_questions__question_id__delete",
+ }
+ },
+ "/api/v1/pipelines/{pipeline_id}/documents/{document_id}": {
+ "get": {
+ "tags": ["Pipelines"],
+ "summary": "Get Pipeline Document",
+ "description": "Return a single document for a pipeline.",
+ "operationId": "get_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__get",
"security": [
{
"HTTPBearer": []
@@ -8185,13 +8646,22 @@
],
"parameters": [
{
- "name": "question_id",
+ "name": "document_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Document Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Question Id"
+ "title": "Pipeline Id"
}
},
{
@@ -8212,8 +8682,15 @@
}
],
"responses": {
- "204": {
- "description": "Successful Response"
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudDocument"
+ }
+ }
+ }
},
"422": {
"description": "Validation Error",
@@ -8226,14 +8703,12 @@
}
}
}
- }
- },
- "/api/v1/evals/models": {
- "get": {
- "tags": ["Evals"],
- "summary": "List Supported Models",
- "description": "List supported models.",
- "operationId": "list_supported_models_api_v1_evals_models_get",
+ },
+ "delete": {
+ "tags": ["Pipelines"],
+ "summary": "Delete Pipeline Document",
+ "description": "Delete a document for a pipeline.",
+ "operationId": "delete_pipeline_document_api_v1_pipelines__pipeline_id__documents__document_id__delete",
"security": [
{
"HTTPBearer": []
@@ -8243,6 +8718,25 @@
}
],
"parameters": [
+ {
+ "name": "document_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Document Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -8261,19 +8755,8 @@
}
],
"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"
- }
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -8288,12 +8771,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/image/{name}": {
+ "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status": {
"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": ["Pipelines"],
+ "summary": "Get Pipeline Document Status",
+ "description": "Return a single document for a pipeline.",
+ "operationId": "get_pipeline_document_status_api_v1_pipelines__pipeline_id__documents__document_id__status_get",
"security": [
{
"HTTPBearer": []
@@ -8304,22 +8787,22 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "document_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "format": "uuid",
- "title": "Job Id"
+ "title": "Document Id"
}
},
{
- "name": "name",
+ "name": "pipeline_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Name"
+ "format": "uuid",
+ "title": "Pipeline Id"
}
},
{
@@ -8343,7 +8826,11 @@
"200": {
"description": "Successful Response",
"content": {
- "image/jpeg": {}
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ManagedIngestionStatusResponse"
+ }
+ }
}
},
"422": {
@@ -8359,36 +8846,12 @@
}
}
},
- "/api/v1/parsing/supported_file_extensions": {
+ "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks": {
"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": {
- "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": ["Pipelines"],
+ "summary": "List Pipeline Document Chunks",
+ "description": "Return a list of chunks for a pipeline document.",
+ "operationId": "list_pipeline_document_chunks_api_v1_pipelines__pipeline_id__documents__document_id__chunks_get",
"security": [
{
"HTTPBearer": []
@@ -8398,6 +8861,25 @@
}
],
"parameters": [
+ {
+ "name": "document_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Document Id"
+ }
+ },
+ {
+ "name": "pipeline_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Pipeline Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -8415,22 +8897,17 @@
}
}
],
- "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": {
- "$ref": "#/components/schemas/ParsingJob"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TextNode"
+ },
+ "title": "Response List Pipeline Document Chunks Api V1 Pipelines Pipeline Id Documents Document Id Chunks Get"
}
}
}
@@ -8448,12 +8925,12 @@
}
}
},
- "/api/v1/parsing/usage": {
+ "/api/v1/evals/datasets/{dataset_id}": {
"get": {
- "tags": ["Parsing"],
- "summary": "Usage",
- "description": "Get parsing usage for user",
- "operationId": "usage_api_v1_parsing_usage_get",
+ "tags": ["Evals"],
+ "summary": "Get Dataset",
+ "description": "Get a dataset by ID.",
+ "operationId": "get_dataset_api_v1_evals_datasets__dataset_id__get",
"security": [
{
"HTTPBearer": []
@@ -8464,9 +8941,19 @@
],
"parameters": [
{
- "name": "session",
- "in": "cookie",
- "required": false,
+ "name": "dataset_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
"schema": {
"anyOf": [
{
@@ -8486,7 +8973,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingUsage"
+ "$ref": "#/components/schemas/EvalDataset"
}
}
}
@@ -8502,14 +8989,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": "Update Dataset",
+ "description": "Update a dataset.",
+ "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put",
"security": [
{
"HTTPBearer": []
@@ -8520,13 +9005,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Dataset Id"
}
},
{
@@ -8546,13 +9031,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalDatasetUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJob"
+ "$ref": "#/components/schemas/EvalDataset"
}
}
}
@@ -8568,14 +9063,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 Dataset",
+ "description": "Delete a dataset.",
+ "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete",
"security": [
{
"HTTPBearer": []
@@ -8586,13 +9079,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Dataset Id"
}
},
{
@@ -8613,15 +9106,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",
@@ -8636,12 +9122,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/text": {
- "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",
+ "/api/v1/evals/datasets/{dataset_id}/question": {
+ "post": {
+ "tags": ["Evals"],
+ "summary": "Create Question",
+ "description": "Create a new question.",
+ "operationId": "create_question_api_v1_evals_datasets__dataset_id__question_post",
"security": [
{
"HTTPBearer": []
@@ -8652,13 +9138,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Dataset Id"
}
},
{
@@ -8678,13 +9164,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalQuestionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobTextResult"
+ "$ref": "#/components/schemas/EvalQuestion"
}
}
}
@@ -8700,14 +9196,12 @@
}
}
}
- }
- },
- "/api/v1/parsing/job/{job_id}/result/raw/text": {
+ },
"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_raw_text_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": []
@@ -8718,13 +9212,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Dataset Id"
}
},
{
@@ -8749,7 +9243,13 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalQuestion"
+ },
+ "title": "Response List Questions Api V1 Evals Datasets Dataset Id Question Get"
+ }
}
}
},
@@ -8766,12 +9266,12 @@
}
}
},
- "/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",
+ "/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": []
@@ -8782,13 +9282,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Dataset Id"
}
},
{
@@ -8808,13 +9308,31 @@
}
}
],
+ "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": {
- "$ref": "#/components/schemas/ParsingJobMarkdownResult"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EvalQuestion"
+ },
+ "title": "Response Create Questions Api V1 Evals Datasets Dataset Id Questions Post"
}
}
}
@@ -8832,12 +9350,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/result/raw/markdown": {
+ "/api/v1/evals/questions/{question_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",
+ "tags": ["Evals"],
+ "summary": "Get Question",
+ "description": "Get a question by ID.",
+ "operationId": "get_question_api_v1_evals_questions__question_id__get",
"security": [
{
"HTTPBearer": []
@@ -8848,13 +9366,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "question_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Question Id"
}
},
{
@@ -8879,7 +9397,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/EvalQuestion"
+ }
}
}
},
@@ -8894,14 +9414,12 @@
}
}
}
- }
- },
- "/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",
+ },
+ "put": {
+ "tags": ["Evals"],
+ "summary": "Replace Question",
+ "description": "Replace a question.",
+ "operationId": "replace_question_api_v1_evals_questions__question_id__put",
"security": [
{
"HTTPBearer": []
@@ -8912,13 +9430,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "question_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Question Id"
}
},
{
@@ -8938,13 +9456,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EvalQuestionCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobJsonResult"
+ "$ref": "#/components/schemas/EvalQuestion"
}
}
}
@@ -8960,14 +9488,12 @@
}
}
}
- }
- },
- "/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",
+ },
+ "delete": {
+ "tags": ["Evals"],
+ "summary": "Delete Question",
+ "description": "Delete a question.",
+ "operationId": "delete_question_api_v1_evals_questions__question_id__delete",
"security": [
{
"HTTPBearer": []
@@ -8978,13 +9504,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "question_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
+ "title": "Question Id"
}
},
{
@@ -9005,13 +9531,8 @@
}
],
"responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
+ "204": {
+ "description": "Successful Response"
},
"422": {
"description": "Validation Error",
@@ -9026,12 +9547,12 @@
}
}
},
- "/api/v1/parsing/history": {
+ "/api/v1/evals/models": {
"get": {
- "tags": ["Parsing"],
- "summary": "Get Parsing History Result",
- "description": "Get parsing history for user",
- "operationId": "get_parsing_history_result_api_v1_parsing_history_get",
+ "tags": ["Evals"],
+ "summary": "List Supported Models",
+ "description": "List supported models.",
+ "operationId": "list_supported_models_api_v1_evals_models_get",
"security": [
{
"HTTPBearer": []
@@ -9066,9 +9587,9 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ParsingHistoryItem"
+ "$ref": "#/components/schemas/SupportedLLMModel"
},
- "title": "Response Get Parsing History Result Api V1 Parsing History Get"
+ "title": "Response List Supported Models Api V1 Evals Models Get"
}
}
}
@@ -9086,12 +9607,12 @@
}
}
},
- "/api/v1/parsing/job/{job_id}/read/{filename}": {
+ "/api/v1/parsing/job/{job_id}/result/image/{name}": {
"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 Image Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_image_result_api_v1_parsing_job__job_id__result_image__name__get",
"security": [
{
"HTTPBearer": []
@@ -9112,12 +9633,12 @@
}
},
{
- "name": "filename",
+ "name": "name",
"in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Filename"
+ "title": "Name"
}
},
{
@@ -9141,11 +9662,7 @@
"200": {
"description": "Successful Response",
"content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PresignedUrl"
- }
- }
+ "image/jpeg": {}
}
},
"422": {
@@ -9161,60 +9678,12 @@
}
}
},
- "/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": {
- "items": {
- "$ref": "#/components/schemas/DataSourceDefinition"
- },
- "type": "array",
- "title": "Response List Data Source Definitions Api V1 Component Definition Data Sources Get"
- }
- }
- }
- }
- }
- }
- },
- "/api/v1/component-definition/data-sinks": {
+ "/api/v1/parsing/supported_file_extensions": {
"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",
+ "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",
@@ -9222,10 +9691,10 @@
"application/json": {
"schema": {
"items": {
- "$ref": "#/components/schemas/DataSinkDefinition"
+ "$ref": "#/components/schemas/LlamaParseSupportedFileExtensions"
},
"type": "array",
- "title": "Response List Data Sink Definitions Api V1 Component Definition Data Sinks Get"
+ "title": "Response Get Supported File Extensions Api V1 Parsing Supported File Extensions Get"
}
}
}
@@ -9233,12 +9702,12 @@
}
}
},
- "/api/v1/billing/checkout-session": {
+ "/api/v1/parsing/upload": {
"post": {
- "tags": ["Billing"],
- "summary": "Create Checkout Session",
- "description": "Create a new checkout session.",
- "operationId": "create_checkout_session_api_v1_billing_checkout_session_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",
"security": [
{
"HTTPBearer": []
@@ -9248,6 +9717,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",
@@ -9266,11 +9769,10 @@
}
],
"requestBody": {
- "required": true,
"content": {
- "application/json": {
+ "multipart/form-data": {
"schema": {
- "$ref": "#/components/schemas/CheckoutSessionCreatePayload"
+ "$ref": "#/components/schemas/Body_upload_file_api_v1_parsing_upload_post"
}
}
}
@@ -9281,8 +9783,7 @@
"content": {
"application/json": {
"schema": {
- "type": "string",
- "title": "Response Create Checkout Session Api V1 Billing Checkout Session Post"
+ "$ref": "#/components/schemas/ParsingJob"
}
}
}
@@ -9300,12 +9801,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/usage": {
+ "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",
"security": [
{
"HTTPBearer": []
@@ -9332,24 +9833,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/ParsingUsage"
}
}
}
@@ -9367,20 +9857,45 @@
}
}
},
- "/api/v1/billing/webhook": {
- "post": {
- "tags": ["Billing"],
- "summary": "Stripe Webhook",
- "description": "Stripe webhook endpoint.",
- "operationId": "stripe_webhook_api_v1_billing_webhook_post",
+ "/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",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
"parameters": [
{
- "name": "stripe-signature",
- "in": "header",
- "required": false,
+ "name": "job_id",
+ "in": "path",
+ "required": true,
"schema": {
"type": "string",
- "title": "Stripe-Signature"
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
}
}
],
@@ -9389,7 +9904,9 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJob"
+ }
}
}
},
@@ -9406,11 +9923,12 @@
}
}
},
- "/api/v1/extraction/schemas": {
- "post": {
- "tags": ["Extraction"],
- "summary": "Create Schema",
- "operationId": "create_schema_api_v1_extraction_schemas_post",
+ "/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",
"security": [
{
"HTTPBearer": []
@@ -9420,6 +9938,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9437,23 +9965,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchemaCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
+ "title": "Response Get Parsing Job Details Api V1 Parsing Job Job Id Details Get"
}
}
}
@@ -9469,11 +9987,14 @@
}
}
}
- },
+ }
+ },
+ "/api/v1/parsing/job/{job_id}/result/text": {
"get": {
- "tags": ["Extraction"],
- "summary": "List Schemas",
- "operationId": "list_schemas_api_v1_extraction_schemas_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",
"security": [
{
"HTTPBearer": []
@@ -9484,20 +10005,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"
}
},
{
@@ -9523,11 +10037,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractionSchema"
- },
- "title": "Response List Schemas Api V1 Extraction Schemas Get"
+ "$ref": "#/components/schemas/ParsingJobTextResult"
}
}
}
@@ -9545,11 +10055,12 @@
}
}
},
- "/api/v1/extraction/schemas/infer": {
- "post": {
- "tags": ["Extraction"],
- "summary": "Infer Schema",
- "operationId": "infer_schema_api_v1_extraction_schemas_infer_post",
+ "/api/v1/parsing/job/{job_id}/result/raw/text": {
+ "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_raw_text_get",
"security": [
{
"HTTPBearer": []
@@ -9559,6 +10070,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9576,24 +10097,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchemaInfer"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
- }
+ "schema": {}
}
}
},
@@ -9610,11 +10119,12 @@
}
}
},
- "/api/v1/extraction/schemas/{schema_id}": {
+ "/api/v1/parsing/job/{job_id}/result/pdf": {
"get": {
- "tags": ["Extraction"],
- "summary": "Get Schema",
- "operationId": "get_schema_api_v1_extraction_schemas__schema_id__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",
"security": [
{
"HTTPBearer": []
@@ -9625,13 +10135,13 @@
],
"parameters": [
{
- "name": "schema_id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Job Id"
}
},
{
@@ -9656,9 +10166,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionSchema"
- }
+ "schema": {}
}
}
},
@@ -9673,11 +10181,14 @@
}
}
}
- },
- "put": {
- "tags": ["Extraction"],
- "summary": "Update Schema",
- "operationId": "update_schema_api_v1_extraction_schemas__schema_id__put",
+ }
+ },
+ "/api/v1/parsing/job/{job_id}/result/raw/pdf": {
+ "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_raw_pdf_get",
"security": [
{
"HTTPBearer": []
@@ -9688,13 +10199,13 @@
],
"parameters": [
{
- "name": "schema_id",
+ "name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Job Id"
}
},
{
@@ -9714,24 +10225,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": {}
}
}
},
@@ -9748,11 +10247,12 @@
}
}
},
- "/api/v1/extraction/jobs": {
+ "/api/v1/parsing/job/{job_id}/result/structured": {
"get": {
- "tags": ["Extraction"],
- "summary": "List Jobs",
- "operationId": "list_jobs_api_v1_extraction_jobs_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",
"security": [
{
"HTTPBearer": []
@@ -9763,13 +10263,13 @@
],
"parameters": [
{
- "name": "schema_id",
- "in": "query",
+ "name": "job_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Schema Id"
+ "title": "Job Id"
}
},
{
@@ -9795,11 +10295,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtractionJob"
- },
- "title": "Response List Jobs Api V1 Extraction Jobs Get"
+ "$ref": "#/components/schemas/ParsingJobStructuredResult"
}
}
}
@@ -9815,11 +10311,14 @@
}
}
}
- },
- "post": {
- "tags": ["Extraction"],
- "summary": "Run Job",
- "operationId": "run_job_api_v1_extraction_jobs_post",
+ }
+ },
+ "/api/v1/parsing/job/{job_id}/result/raw/structured": {
+ "get": {
+ "tags": ["Parsing"],
+ "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": []
@@ -9829,6 +10328,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9846,24 +10355,12 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionJobCreate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionJob"
- }
+ "schema": {}
}
}
},
@@ -9880,11 +10377,12 @@
}
}
},
- "/api/v1/extraction/jobs/{job_id}": {
+ "/api/v1/parsing/job/{job_id}/result/xlsx": {
"get": {
- "tags": ["Extraction"],
- "summary": "Get Job",
- "operationId": "get_job_api_v1_extraction_jobs__job_id__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_xlsx_get",
"security": [
{
"HTTPBearer": []
@@ -9926,9 +10424,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ExtractionJob"
- }
+ "schema": {}
}
}
},
@@ -9945,11 +10441,12 @@
}
}
},
- "/api/v1/extraction/jobs/batch": {
- "post": {
- "tags": ["Extraction"],
- "summary": "Run Jobs In Batch",
- "operationId": "run_jobs_in_batch_api_v1_extraction_jobs_batch_post",
+ "/api/v1/parsing/job/{job_id}/result/raw/xlsx": {
+ "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": []
@@ -9959,6 +10456,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -9976,28 +10483,12 @@
}
}
],
- "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"
- },
- "title": "Response Run Jobs In Batch Api V1 Extraction Jobs Batch Post"
- }
+ "schema": {}
}
}
},
@@ -10014,11 +10505,12 @@
}
}
},
- "/api/v1/extraction/jobs/{job_id}/result": {
+ "/api/v1/parsing/job/{job_id}/result/markdown": {
"get": {
- "tags": ["Extraction"],
+ "tags": ["Parsing"],
"summary": "Get Job Result",
- "operationId": "get_job_result_api_v1_extraction_jobs__job_id__result_get",
+ "description": "Get a job by id",
+ "operationId": "get_job_result_api_v1_parsing_job__job_id__result_markdown_get",
"security": [
{
"HTTPBearer": []
@@ -10061,7 +10553,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ExtractionResult"
+ "$ref": "#/components/schemas/ParsingJobMarkdownResult"
}
}
}
@@ -10079,12 +10571,12 @@
}
}
},
- "/api/parsing/job/{job_id}/result/image/{name}": {
+ "/api/v1/parsing/job/{job_id}/result/raw/markdown": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Image Result",
+ "tags": ["Parsing"],
+ "summary": "Get Job Raw Md Result",
"description": "Get a job by id",
- "operationId": "get_job_image_result_api_parsing_job__job_id__result_image__name__get",
+ "operationId": "get_job_raw_md_result_api_v1_parsing_job__job_id__result_raw_markdown_get",
"security": [
{
"HTTPBearer": []
@@ -10104,15 +10596,6 @@
"title": "Job Id"
}
},
- {
- "name": "name",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Name"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10134,7 +10617,9 @@
"200": {
"description": "Successful Response",
"content": {
- "image/jpeg": {}
+ "application/json": {
+ "schema": {}
+ }
}
},
"422": {
@@ -10150,36 +10635,12 @@
}
}
},
- "/api/parsing/supported_file_extensions": {
+ "/api/v1/parsing/job/{job_id}/result/json": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Supported File Extensions",
- "description": "Get a list of supported file extensions",
- "operationId": "get_supported_file_extensions_api_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 Parsing Supported File Extensions Get"
- }
- }
- }
- }
- }
- }
- },
- "/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",
+ "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": []
@@ -10190,9 +10651,19 @@
],
"parameters": [
{
- "name": "session",
- "in": "cookie",
- "required": false,
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
"schema": {
"anyOf": [
{
@@ -10206,22 +10677,13 @@
}
}
],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "$ref": "#/components/schemas/Body_upload_file_api_parsing_upload_post"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJob"
+ "$ref": "#/components/schemas/ParsingJobJsonResult"
}
}
}
@@ -10239,12 +10701,12 @@
}
}
},
- "/api/parsing/usage": {
+ "/api/v1/parsing/job/{job_id}/result/raw/json": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Usage",
- "description": "Get parsing usage for user",
- "operationId": "usage_api_parsing_usage_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": []
@@ -10254,6 +10716,16 @@
}
],
"parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10276,9 +10748,7 @@
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {
- "$ref": "#/components/schemas/ParsingUsage"
- }
+ "schema": {}
}
}
},
@@ -10295,12 +10765,12 @@
}
}
},
- "/api/parsing/job/{job_id}": {
+ "/api/v1/parsing/history": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Job",
- "description": "Get a job by id",
- "operationId": "get_job_api_parsing_job__job_id__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": []
@@ -10310,16 +10780,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10343,7 +10803,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJob"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParsingHistoryItem"
+ },
+ "title": "Response Get Parsing History Result Api V1 Parsing History Get"
}
}
}
@@ -10361,12 +10825,12 @@
}
}
},
- "/api/parsing/job/{job_id}/details": {
+ "/api/v1/parsing/job/{job_id}/read/{filename}": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Parsing Job Details",
- "description": "Get a job by id",
- "operationId": "get_parsing_job_details_api_parsing_job__job_id__details_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": []
@@ -10386,6 +10850,15 @@
"title": "Job Id"
}
},
+ {
+ "name": "filename",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Filename"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10409,7 +10882,7 @@
"content": {
"application/json": {
"schema": {
- "title": "Response Get Parsing Job Details Api Parsing Job Job Id Details Get"
+ "$ref": "#/components/schemas/PresignedUrl"
}
}
}
@@ -10427,65 +10900,71 @@
}
}
},
- "/api/parsing/job/{job_id}/result/text": {
+ "/api/v1/component-definition/configurable-transformations": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Text Result",
- "description": "Get a job by id",
- "operationId": "get_job_text_result_api_parsing_job__job_id__result_text_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"
+ "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"
}
- ],
- "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": {
- "$ref": "#/components/schemas/ParsingJobTextResult"
+ "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"
}
}
}
@@ -10493,12 +10972,12 @@
}
}
},
- "/api/parsing/job/{job_id}/result/raw/text": {
- "get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Raw Text Result",
- "description": "Get a job by id",
- "operationId": "get_job_raw_text_result_api_parsing_job__job_id__result_raw_text_get",
+ "/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",
"security": [
{
"HTTPBearer": []
@@ -10508,16 +10987,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10535,12 +11004,25 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CheckoutSessionCreatePayload"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "type": "string",
+ "title": "Response Create Checkout Session Api V1 Billing Checkout Session Post"
+ }
}
}
},
@@ -10557,12 +11039,12 @@
}
}
},
- "/api/parsing/job/{job_id}/result/markdown": {
- "get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Result",
- "description": "Get a job by id",
- "operationId": "get_job_result_api_parsing_job__job_id__result_markdown_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": []
@@ -10572,16 +11054,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10599,13 +11071,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CustomerPortalSessionCreatePayload"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobMarkdownResult"
+ "type": "string",
+ "title": "Response Create Customer Portal Session Api V1 Billing Customer Portal Session Post"
}
}
}
@@ -10623,12 +11106,50 @@
}
}
},
- "/api/parsing/job/{job_id}/result/raw/markdown": {
- "get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Raw Md Result",
- "description": "Get a job by id",
- "operationId": "get_job_raw_md_result_api_parsing_job__job_id__result_raw_markdown_get",
+ "/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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extraction/schemas": {
+ "post": {
+ "tags": ["Extraction"],
+ "summary": "Create Schema",
+ "operationId": "create_schema_api_v1_extraction_schemas_post",
"security": [
{
"HTTPBearer": []
@@ -10638,16 +11159,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10665,12 +11176,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionSchemaCreate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionSchema"
+ }
}
}
},
@@ -10685,14 +11208,11 @@
}
}
}
- }
- },
- "/api/parsing/job/{job_id}/result/json": {
+ },
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Json Result",
- "description": "Get a job by id",
- "operationId": "get_job_json_result_api_parsing_job__job_id__result_json_get",
+ "tags": ["Extraction"],
+ "summary": "List Schemas",
+ "operationId": "list_schemas_api_v1_extraction_schemas_get",
"security": [
{
"HTTPBearer": []
@@ -10703,13 +11223,20 @@
],
"parameters": [
{
- "name": "job_id",
- "in": "path",
- "required": true,
+ "name": "project_id",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
}
},
{
@@ -10735,7 +11262,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/ParsingJobJsonResult"
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtractionSchema"
+ },
+ "title": "Response List Schemas Api V1 Extraction Schemas Get"
}
}
}
@@ -10753,12 +11284,11 @@
}
}
},
- "/api/parsing/job/{job_id}/result/raw/json": {
- "get": {
- "tags": ["Deprecated"],
- "summary": "Get Job Json Raw Result",
- "description": "Get a job by id",
- "operationId": "get_job_json_raw_result_api_parsing_job__job_id__result_raw_json_get",
+ "/api/v1/extraction/schemas/infer": {
+ "post": {
+ "tags": ["Extraction"],
+ "summary": "Infer Schema",
+ "operationId": "infer_schema_api_v1_extraction_schemas_infer_post",
"security": [
{
"HTTPBearer": []
@@ -10768,16 +11298,6 @@
}
],
"parameters": [
- {
- "name": "job_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Job Id"
- }
- },
{
"name": "session",
"in": "cookie",
@@ -10795,12 +11315,24 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionSchemaInfer"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionSchema"
+ }
}
}
},
@@ -10817,12 +11349,11 @@
}
}
},
- "/api/parsing/history": {
+ "/api/v1/extraction/schemas/{schema_id}": {
"get": {
- "tags": ["Deprecated"],
- "summary": "Get Parsing History Result",
- "description": "Get parsing history for user",
- "operationId": "get_parsing_history_result_api_parsing_history_get",
+ "tags": ["Extraction"],
+ "summary": "Get Schema",
+ "operationId": "get_schema_api_v1_extraction_schemas__schema_id__get",
"security": [
{
"HTTPBearer": []
@@ -10832,6 +11363,16 @@
}
],
"parameters": [
+ {
+ "name": "schema_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Schema Id"
+ }
+ },
{
"name": "session",
"in": "cookie",
@@ -10855,11 +11396,7 @@
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ParsingHistoryItem"
- },
- "title": "Response Get Parsing History Result Api Parsing History Get"
+ "$ref": "#/components/schemas/ExtractionSchema"
}
}
}
@@ -10875,14 +11412,11 @@
}
}
}
- }
- },
- "/api/parsing/job/{job_id}/read/{filename}": {
- "get": {
- "tags": ["Deprecated"],
- "summary": "Generate Presigned Url",
- "description": "Generate a presigned URL for a job",
- "operationId": "generate_presigned_url_api_parsing_job__job_id__read__filename__get",
+ },
+ "put": {
+ "tags": ["Extraction"],
+ "summary": "Update Schema",
+ "operationId": "update_schema_api_v1_extraction_schemas__schema_id__put",
"security": [
{
"HTTPBearer": []
@@ -10893,22 +11427,13 @@
],
"parameters": [
{
- "name": "job_id",
+ "name": "schema_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
- "title": "Job Id"
- }
- },
- {
- "name": "filename",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Filename"
+ "title": "Schema Id"
}
},
{
@@ -10928,13 +11453,23 @@
}
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionSchemaUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/PresignedUrl"
+ "$ref": "#/components/schemas/ExtractionSchema"
}
}
}
@@ -10951,30 +11486,1654 @@
}
}
}
- }
- },
- "components": {
- "schemas": {
- "APIKey": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "Unique identifier"
+ },
+ "/api/v1/extraction/jobs": {
+ "get": {
+ "tags": ["Extraction"],
+ "summary": "List Jobs",
+ "operationId": "list_jobs_api_v1_extraction_jobs_get",
+ "security": [
+ {
+ "HTTPBearer": []
},
- "created_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created At",
- "description": "Creation datetime"
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "schema_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Schema Id"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "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"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": ["Extraction"],
+ "summary": "Run Job",
+ "operationId": "run_job_api_v1_extraction_jobs_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/ExtractionJobCreate"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionJob"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extraction/jobs/{job_id}": {
+ "get": {
+ "tags": ["Extraction"],
+ "summary": "Get Job",
+ "operationId": "get_job_api_v1_extraction_jobs__job_id__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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionJob"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/v1/extraction/jobs/batch": {
+ "post": {
+ "tags": ["Extraction"],
+ "summary": "Run Jobs In Batch",
+ "operationId": "run_jobs_in_batch_api_v1_extraction_jobs_batch_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/ExtractionJobCreateBatch"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtractionJob"
+ },
+ "title": "Response Run Jobs In Batch Api V1 Extraction Jobs Batch Post"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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",
+ "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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExtractionResult"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/image/{name}": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Image Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_image_result_api_parsing_job__job_id__result_image__name__get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "job_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Job Id"
+ }
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "title": "Name"
+ }
+ },
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "image/jpeg": {}
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/supported_file_extensions": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Supported File Extensions",
+ "description": "Get a list of supported file extensions",
+ "operationId": "get_supported_file_extensions_api_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 Parsing Supported File Extensions Get"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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": "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",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_upload_file_api_parsing_upload_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/usage": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Usage",
+ "description": "DEPRECATED: use either /organizations/{organization_id}/usage or /projects/{project_id}/usage instead\nGet parsing usage for user",
+ "operationId": "usage_api_parsing_usage_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "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/ParsingUsage"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job",
+ "description": "Get a job by id",
+ "operationId": "get_job_api_parsing_job__job_id__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"
+ }
+ }
+ ],
+ "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/job/{job_id}/details": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Parsing Job Details",
+ "description": "Get a job by id",
+ "operationId": "get_parsing_job_details_api_parsing_job__job_id__details_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "title": "Response Get Parsing Job Details Api Parsing Job Job Id Details Get"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/text": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Text Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_text_result_api_parsing_job__job_id__result_text_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobTextResult"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/text": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Text Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_text_result_api_parsing_job__job_id__result_raw_text_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/pdf": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Text Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_text_result_api_parsing_job__job_id__result_pdf_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/pdf": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Text Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_text_result_api_parsing_job__job_id__result_raw_pdf_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/structured": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Structured Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_structured_result_api_parsing_job__job_id__result_structured_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobStructuredResult"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/structured": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Structured Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_structured_result_api_parsing_job__job_id__result_raw_structured_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/xlsx": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Xlsx Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_xlsx_result_api_parsing_job__job_id__result_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/xlsx": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Xlsx Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_xlsx_result_api_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/markdown": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_result_api_parsing_job__job_id__result_markdown_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobMarkdownResult"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/markdown": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Raw Md Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_raw_md_result_api_parsing_job__job_id__result_raw_markdown_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/json": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Json Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_json_result_api_parsing_job__job_id__result_json_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ParsingJobJsonResult"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/result/raw/json": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Job Json Raw Result",
+ "description": "Get a job by id",
+ "operationId": "get_job_json_raw_result_api_parsing_job__job_id__result_raw_json_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"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/history": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Get Parsing History Result",
+ "description": "Get parsing history for user",
+ "operationId": "get_parsing_history_result_api_parsing_history_get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "session",
+ "in": "cookie",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ParsingHistoryItem"
+ },
+ "title": "Response Get Parsing History Result Api Parsing History Get"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/api/parsing/job/{job_id}/read/{filename}": {
+ "get": {
+ "tags": ["Deprecated"],
+ "summary": "Generate Presigned Url",
+ "description": "Generate a presigned URL for a job",
+ "operationId": "generate_presigned_url_api_parsing_job__job_id__read__filename__get",
+ "security": [
+ {
+ "HTTPBearer": []
+ },
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "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",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Session"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PresignedUrl"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "APIKey": {
+ "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": [
@@ -11002,6 +13161,18 @@
],
"title": "Name"
},
+ "project_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ },
"user_id": {
"type": "string",
"title": "User Id"
@@ -11030,6 +13201,19 @@
}
],
"title": "Name"
+ },
+ "project_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id",
+ "description": "The project ID to associate with the API key."
}
},
"type": "object",
@@ -11516,27 +13700,96 @@
},
"Body_upload_file_api_parsing_upload_post": {
"properties": {
- "language": {
- "items": {
- "$ref": "#/components/schemas/ParserLanguages"
- },
- "type": "array",
- "title": "Language",
- "default": ["en"]
+ "file": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "binary"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File"
},
- "parsing_instruction": {
+ "annotate_links": {
+ "type": "boolean",
+ "title": "Annotate Links",
+ "default": false
+ },
+ "auto_mode": {
+ "type": "boolean",
+ "title": "Auto Mode",
+ "default": false
+ },
+ "auto_mode_trigger_on_image_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Image In Page",
+ "default": false
+ },
+ "auto_mode_trigger_on_table_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Table In Page",
+ "default": false
+ },
+ "auto_mode_trigger_on_text_in_page": {
"type": "string",
- "title": "Parsing Instruction",
- "default": ""
+ "title": "Auto Mode Trigger On Text In Page"
},
- "skip_diagonal_text": {
+ "auto_mode_trigger_on_regexp_in_page": {
+ "type": "string",
+ "title": "Auto Mode Trigger On Regexp In Page"
+ },
+ "azure_openai_api_version": {
+ "type": "string",
+ "title": "Azure Openai Api Version"
+ },
+ "azure_openai_deployment_name": {
+ "type": "string",
+ "title": "Azure Openai Deployment Name"
+ },
+ "azure_openai_endpoint": {
+ "type": "string",
+ "title": "Azure Openai Endpoint"
+ },
+ "azure_openai_key": {
+ "type": "string",
+ "title": "Azure Openai Key"
+ },
+ "bbox_bottom": {
+ "type": "number",
+ "title": "Bbox Bottom"
+ },
+ "bbox_left": {
+ "type": "number",
+ "title": "Bbox Left"
+ },
+ "bbox_right": {
+ "type": "number",
+ "title": "Bbox Right"
+ },
+ "bbox_top": {
+ "type": "number",
+ "title": "Bbox Top"
+ },
+ "continuous_mode": {
"type": "boolean",
- "title": "Skip Diagonal Text",
+ "title": "Continuous Mode",
"default": false
},
- "invalidate_cache": {
+ "disable_ocr": {
"type": "boolean",
- "title": "Invalidate Cache",
+ "title": "Disable Ocr",
+ "default": false
+ },
+ "disable_reconstruction": {
+ "type": "boolean",
+ "title": "Disable Reconstruction",
+ "default": false
+ },
+ "disable_image_extraction": {
+ "type": "boolean",
+ "title": "Disable Image Extraction",
"default": false
},
"do_not_cache": {
@@ -11544,9 +13797,14 @@
"title": "Do Not Cache",
"default": false
},
- "gpt4o_mode": {
+ "do_not_unroll_columns": {
"type": "boolean",
- "title": "Gpt4O Mode",
+ "title": "Do Not Unroll Columns",
+ "default": false
+ },
+ "extract_charts": {
+ "type": "boolean",
+ "title": "Extract Charts",
"default": false
},
"fast_mode": {
@@ -11554,52 +13812,76 @@
"title": "Fast Mode",
"default": false
},
- "premium_mode": {
+ "guess_xlsx_sheet_name": {
"type": "boolean",
- "title": "Premium Mode",
+ "title": "Guess Xlsx Sheet Name",
"default": false
},
- "continuous_mode": {
+ "html_make_all_elements_visible": {
"type": "boolean",
- "title": "Continuous Mode",
+ "title": "Html Make All Elements Visible",
"default": false
},
- "gpt4o_api_key": {
- "type": "string",
- "title": "Gpt4O Api Key",
- "default": ""
+ "html_remove_fixed_elements": {
+ "type": "boolean",
+ "title": "Html Remove Fixed Elements",
+ "default": false
},
- "do_not_unroll_columns": {
+ "html_remove_navigation_elements": {
"type": "boolean",
- "title": "Do Not Unroll Columns",
+ "title": "Html Remove Navigation Elements",
"default": false
},
- "page_separator": {
+ "http_proxy": {
"type": "string",
- "title": "Page Separator"
+ "title": "Http Proxy"
},
- "bounding_box": {
+ "input_s3_path": {
"type": "string",
- "title": "Bounding Box",
+ "title": "Input S3 Path",
"default": ""
},
- "target_pages": {
+ "input_url": {
"type": "string",
- "title": "Target Pages",
- "default": ""
+ "title": "Input Url"
},
- "use_vendor_multimodal_model": {
+ "invalidate_cache": {
"type": "boolean",
- "title": "Use Vendor Multimodal Model",
+ "title": "Invalidate Cache",
"default": false
},
- "vendor_multimodal_model_name": {
- "type": "string",
- "title": "Vendor Multimodal Model Name"
+ "is_formatting_instruction": {
+ "type": "boolean",
+ "title": "Is Formatting Instruction",
+ "default": true
},
- "vendor_multimodal_api_key": {
+ "language": {
+ "items": {
+ "$ref": "#/components/schemas/ParserLanguages"
+ },
+ "type": "array",
+ "title": "Language",
+ "default": ["en"]
+ },
+ "max_pages": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Pages"
+ },
+ "output_pdf_of_document": {
+ "type": "boolean",
+ "title": "Output Pdf Of Document",
+ "default": false
+ },
+ "output_s3_path_prefix": {
"type": "string",
- "title": "Vendor Multimodal Api Key",
+ "title": "Output S3 Path Prefix",
"default": ""
},
"page_prefix": {
@@ -11607,78 +13889,86 @@
"title": "Page Prefix",
"default": ""
},
+ "page_separator": {
+ "type": "string",
+ "title": "Page Separator"
+ },
"page_suffix": {
"type": "string",
"title": "Page Suffix",
"default": ""
},
- "webhook_url": {
+ "parsing_instruction": {
"type": "string",
- "title": "Webhook Url",
+ "title": "Parsing Instruction",
"default": ""
},
- "take_screenshot": {
+ "premium_mode": {
"type": "boolean",
- "title": "Take Screenshot",
+ "title": "Premium Mode",
"default": false
},
- "is_formatting_instruction": {
- "type": "boolean",
- "title": "Is Formatting Instruction",
- "default": true
- },
- "disable_ocr": {
+ "skip_diagonal_text": {
"type": "boolean",
- "title": "Disable Ocr",
+ "title": "Skip Diagonal Text",
"default": false
},
- "annotate_links": {
+ "structured_output": {
"type": "boolean",
- "title": "Annotate Links",
+ "title": "Structured Output",
"default": false
},
- "disable_reconstruction": {
+ "structured_output_json_schema": {
+ "type": "string",
+ "title": "Structured Output Json Schema"
+ },
+ "structured_output_json_schema_name": {
+ "type": "string",
+ "title": "Structured Output Json Schema Name"
+ },
+ "take_screenshot": {
"type": "boolean",
- "title": "Disable Reconstruction",
+ "title": "Take Screenshot",
"default": false
},
- "input_s3_path": {
+ "target_pages": {
"type": "string",
- "title": "Input S3 Path",
+ "title": "Target Pages",
"default": ""
},
- "output_s3_path_prefix": {
+ "use_vendor_multimodal_model": {
+ "type": "boolean",
+ "title": "Use Vendor Multimodal Model",
+ "default": false
+ },
+ "vendor_multimodal_api_key": {
"type": "string",
- "title": "Output S3 Path Prefix",
+ "title": "Vendor Multimodal Api Key",
"default": ""
},
- "azure_openai_deployment_name": {
+ "vendor_multimodal_model_name": {
"type": "string",
- "title": "Azure Openai Deployment Name"
+ "title": "Vendor Multimodal Model Name"
},
- "azure_openai_endpoint": {
+ "webhook_url": {
"type": "string",
- "title": "Azure Openai Endpoint"
+ "title": "Webhook Url",
+ "default": ""
},
- "azure_openai_api_version": {
+ "bounding_box": {
"type": "string",
- "title": "Azure Openai Api Version"
+ "title": "Bounding Box",
+ "default": ""
},
- "azure_openai_key": {
- "type": "string",
- "title": "Azure Openai Key"
+ "gpt4o_mode": {
+ "type": "boolean",
+ "title": "Gpt4O Mode",
+ "default": false
},
- "file": {
- "anyOf": [
- {
- "type": "string",
- "format": "binary"
- },
- {
- "type": "null"
- }
- ],
- "title": "File"
+ "gpt4o_api_key": {
+ "type": "string",
+ "title": "Gpt4O Api Key",
+ "default": ""
}
},
"type": "object",
@@ -11698,27 +13988,96 @@
},
"Body_upload_file_api_v1_parsing_upload_post": {
"properties": {
- "language": {
- "items": {
- "$ref": "#/components/schemas/ParserLanguages"
- },
- "type": "array",
- "title": "Language",
- "default": ["en"]
+ "file": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "binary"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File"
},
- "parsing_instruction": {
+ "annotate_links": {
+ "type": "boolean",
+ "title": "Annotate Links",
+ "default": false
+ },
+ "auto_mode": {
+ "type": "boolean",
+ "title": "Auto Mode",
+ "default": false
+ },
+ "auto_mode_trigger_on_image_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Image In Page",
+ "default": false
+ },
+ "auto_mode_trigger_on_table_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Table In Page",
+ "default": false
+ },
+ "auto_mode_trigger_on_text_in_page": {
"type": "string",
- "title": "Parsing Instruction",
- "default": ""
+ "title": "Auto Mode Trigger On Text In Page"
},
- "skip_diagonal_text": {
+ "auto_mode_trigger_on_regexp_in_page": {
+ "type": "string",
+ "title": "Auto Mode Trigger On Regexp In Page"
+ },
+ "azure_openai_api_version": {
+ "type": "string",
+ "title": "Azure Openai Api Version"
+ },
+ "azure_openai_deployment_name": {
+ "type": "string",
+ "title": "Azure Openai Deployment Name"
+ },
+ "azure_openai_endpoint": {
+ "type": "string",
+ "title": "Azure Openai Endpoint"
+ },
+ "azure_openai_key": {
+ "type": "string",
+ "title": "Azure Openai Key"
+ },
+ "bbox_bottom": {
+ "type": "number",
+ "title": "Bbox Bottom"
+ },
+ "bbox_left": {
+ "type": "number",
+ "title": "Bbox Left"
+ },
+ "bbox_right": {
+ "type": "number",
+ "title": "Bbox Right"
+ },
+ "bbox_top": {
+ "type": "number",
+ "title": "Bbox Top"
+ },
+ "continuous_mode": {
"type": "boolean",
- "title": "Skip Diagonal Text",
+ "title": "Continuous Mode",
"default": false
},
- "invalidate_cache": {
+ "disable_ocr": {
"type": "boolean",
- "title": "Invalidate Cache",
+ "title": "Disable Ocr",
+ "default": false
+ },
+ "disable_reconstruction": {
+ "type": "boolean",
+ "title": "Disable Reconstruction",
+ "default": false
+ },
+ "disable_image_extraction": {
+ "type": "boolean",
+ "title": "Disable Image Extraction",
"default": false
},
"do_not_cache": {
@@ -11726,9 +14085,14 @@
"title": "Do Not Cache",
"default": false
},
- "gpt4o_mode": {
+ "do_not_unroll_columns": {
"type": "boolean",
- "title": "Gpt4O Mode",
+ "title": "Do Not Unroll Columns",
+ "default": false
+ },
+ "extract_charts": {
+ "type": "boolean",
+ "title": "Extract Charts",
"default": false
},
"fast_mode": {
@@ -11736,52 +14100,76 @@
"title": "Fast Mode",
"default": false
},
- "premium_mode": {
+ "guess_xlsx_sheet_name": {
"type": "boolean",
- "title": "Premium Mode",
+ "title": "Guess Xlsx Sheet Name",
"default": false
},
- "continuous_mode": {
+ "html_make_all_elements_visible": {
"type": "boolean",
- "title": "Continuous Mode",
+ "title": "Html Make All Elements Visible",
"default": false
},
- "gpt4o_api_key": {
- "type": "string",
- "title": "Gpt4O Api Key",
- "default": ""
+ "html_remove_fixed_elements": {
+ "type": "boolean",
+ "title": "Html Remove Fixed Elements",
+ "default": false
},
- "do_not_unroll_columns": {
+ "html_remove_navigation_elements": {
"type": "boolean",
- "title": "Do Not Unroll Columns",
+ "title": "Html Remove Navigation Elements",
"default": false
},
- "page_separator": {
+ "http_proxy": {
"type": "string",
- "title": "Page Separator"
+ "title": "Http Proxy"
},
- "bounding_box": {
+ "input_s3_path": {
"type": "string",
- "title": "Bounding Box",
+ "title": "Input S3 Path",
"default": ""
},
- "target_pages": {
+ "input_url": {
"type": "string",
- "title": "Target Pages",
- "default": ""
+ "title": "Input Url"
},
- "use_vendor_multimodal_model": {
+ "invalidate_cache": {
"type": "boolean",
- "title": "Use Vendor Multimodal Model",
+ "title": "Invalidate Cache",
"default": false
},
- "vendor_multimodal_model_name": {
- "type": "string",
- "title": "Vendor Multimodal Model Name"
+ "is_formatting_instruction": {
+ "type": "boolean",
+ "title": "Is Formatting Instruction",
+ "default": true
},
- "vendor_multimodal_api_key": {
+ "language": {
+ "items": {
+ "$ref": "#/components/schemas/ParserLanguages"
+ },
+ "type": "array",
+ "title": "Language",
+ "default": ["en"]
+ },
+ "max_pages": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Pages"
+ },
+ "output_pdf_of_document": {
+ "type": "boolean",
+ "title": "Output Pdf Of Document",
+ "default": false
+ },
+ "output_s3_path_prefix": {
"type": "string",
- "title": "Vendor Multimodal Api Key",
+ "title": "Output S3 Path Prefix",
"default": ""
},
"page_prefix": {
@@ -11789,78 +14177,86 @@
"title": "Page Prefix",
"default": ""
},
+ "page_separator": {
+ "type": "string",
+ "title": "Page Separator"
+ },
"page_suffix": {
"type": "string",
"title": "Page Suffix",
"default": ""
},
- "webhook_url": {
+ "parsing_instruction": {
"type": "string",
- "title": "Webhook Url",
+ "title": "Parsing Instruction",
"default": ""
},
- "take_screenshot": {
+ "premium_mode": {
"type": "boolean",
- "title": "Take Screenshot",
+ "title": "Premium Mode",
"default": false
},
- "is_formatting_instruction": {
- "type": "boolean",
- "title": "Is Formatting Instruction",
- "default": true
- },
- "disable_ocr": {
+ "skip_diagonal_text": {
"type": "boolean",
- "title": "Disable Ocr",
+ "title": "Skip Diagonal Text",
"default": false
},
- "annotate_links": {
+ "structured_output": {
"type": "boolean",
- "title": "Annotate Links",
+ "title": "Structured Output",
"default": false
},
- "disable_reconstruction": {
+ "structured_output_json_schema": {
+ "type": "string",
+ "title": "Structured Output Json Schema"
+ },
+ "structured_output_json_schema_name": {
+ "type": "string",
+ "title": "Structured Output Json Schema Name"
+ },
+ "take_screenshot": {
"type": "boolean",
- "title": "Disable Reconstruction",
+ "title": "Take Screenshot",
"default": false
},
- "input_s3_path": {
+ "target_pages": {
"type": "string",
- "title": "Input S3 Path",
+ "title": "Target Pages",
"default": ""
},
- "output_s3_path_prefix": {
+ "use_vendor_multimodal_model": {
+ "type": "boolean",
+ "title": "Use Vendor Multimodal Model",
+ "default": false
+ },
+ "vendor_multimodal_api_key": {
"type": "string",
- "title": "Output S3 Path Prefix",
+ "title": "Vendor Multimodal Api Key",
"default": ""
},
- "azure_openai_deployment_name": {
+ "vendor_multimodal_model_name": {
"type": "string",
- "title": "Azure Openai Deployment Name"
+ "title": "Vendor Multimodal Model Name"
},
- "azure_openai_endpoint": {
+ "webhook_url": {
"type": "string",
- "title": "Azure Openai Endpoint"
+ "title": "Webhook Url",
+ "default": ""
},
- "azure_openai_api_version": {
+ "bounding_box": {
"type": "string",
- "title": "Azure Openai Api Version"
+ "title": "Bounding Box",
+ "default": ""
},
- "azure_openai_key": {
- "type": "string",
- "title": "Azure Openai Key"
+ "gpt4o_mode": {
+ "type": "boolean",
+ "title": "Gpt4O Mode",
+ "default": false
},
- "file": {
- "anyOf": [
- {
- "type": "string",
- "format": "binary"
- },
- {
- "type": "null"
- }
- ],
- "title": "File"
+ "gpt4o_api_key": {
+ "type": "string",
+ "title": "Gpt4O Api Key",
+ "default": ""
}
},
"type": "object",
@@ -12093,6 +14489,13 @@
},
"CloudAzStorageBlobDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"container_name": {
"type": "string",
"title": "Container Name",
@@ -12312,6 +14715,13 @@
},
"CloudBoxDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"folder_id": {
"anyOf": [
{
@@ -12404,6 +14814,13 @@
},
"CloudConfluenceDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"server_url": {
"type": "string",
"title": "Server Url",
@@ -12609,6 +15026,13 @@
},
"CloudGoogleDriveDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"folder_id": {
"type": "string",
"title": "Folder Id",
@@ -12631,6 +15055,13 @@
},
"CloudJiraDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"email": {
"anyOf": [
{
@@ -12819,6 +15250,13 @@
},
"CloudNotionPageDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"integration_token": {
"type": "string",
"format": "password",
@@ -12862,6 +15300,13 @@
},
"CloudOneDriveDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [true],
+ "const": true,
+ "title": "Supports Access Control",
+ "default": true
+ },
"user_principal_name": {
"type": "string",
"title": "User Principal Name",
@@ -12908,6 +15353,21 @@
"title": "Tenant Id",
"description": "The tenant ID to use for authentication."
},
+ "required_exts": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Required Exts",
+ "description": "The list of required file extensions."
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -13000,7 +15460,7 @@
"writeOnly": true
},
"port": {
- "type": "string",
+ "type": "integer",
"title": "Port"
},
"user": {
@@ -13031,6 +15491,11 @@
"title": "Hybrid Search",
"default": true
},
+ "perform_setup": {
+ "type": "boolean",
+ "title": "Perform Setup",
+ "default": true
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -13095,6 +15560,13 @@
},
"CloudS3DataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"bucket": {
"type": "string",
"title": "Bucket",
@@ -13162,6 +15634,13 @@
},
"CloudSharepointDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [true],
+ "const": true,
+ "title": "Supports Access Control",
+ "default": true
+ },
"site_name": {
"anyOf": [
{
@@ -13239,6 +15718,21 @@
"title": "Tenant Id",
"description": "The tenant ID to use for authentication."
},
+ "required_exts": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Required Exts",
+ "description": "The list of required file extensions."
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -13251,6 +15745,13 @@
},
"CloudSlackDataSource": {
"properties": {
+ "supports_access_control": {
+ "type": "boolean",
+ "enum": [false],
+ "const": false,
+ "title": "Supports Access Control",
+ "default": false
+ },
"slack_token": {
"type": "string",
"format": "password",
@@ -13608,7 +16109,7 @@
"$ref": "#/components/schemas/MarkdownElementNodeParser"
}
],
- "title": "Component",
+ "title": "ConfiguredTransformationItemComponent",
"description": "Component that implements the transformation"
}
},
@@ -13696,7 +16197,8 @@
"$ref": "#/components/schemas/CloudMilvusVectorStore"
}
],
- "title": "Component"
+ "title": "DataSinkCreateComponent",
+ "description": "Component that implements the data sink"
},
"project_id": {
"type": "string",
@@ -13743,7 +16245,8 @@
"$ref": "#/components/schemas/CloudMilvusVectorStore"
}
],
- "title": "Component"
+ "title": "DataSinkCreateComponent",
+ "description": "Component that implements the data sink"
}
},
"type": "object",
@@ -13817,7 +16320,8 @@
"type": "null"
}
],
- "title": "Component"
+ "title": "DataSinkUpdateComponent",
+ "description": "Component that implements the data sink"
}
},
"type": "object",
@@ -13941,7 +16445,8 @@
"$ref": "#/components/schemas/CloudBoxDataSource"
}
],
- "title": "Component"
+ "title": "DataSourceCreateComponent",
+ "description": "Component that implements the data source"
},
"project_id": {
"type": "string",
@@ -14038,7 +16543,8 @@
"$ref": "#/components/schemas/CloudBoxDataSource"
}
],
- "title": "Component"
+ "title": "DataSourceCreateComponent",
+ "description": "Component that implements the data source"
}
},
"type": "object",
@@ -14150,52 +16656,257 @@
"$ref": "#/components/schemas/CloudNotionPageDataSource"
},
{
- "$ref": "#/components/schemas/CloudConfluenceDataSource"
+ "$ref": "#/components/schemas/CloudConfluenceDataSource"
+ },
+ {
+ "$ref": "#/components/schemas/CloudJiraDataSource"
+ },
+ {
+ "$ref": "#/components/schemas/CloudBoxDataSource"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "DataSourceUpdateComponent",
+ "description": "Component that implements the data source"
+ }
+ },
+ "type": "object",
+ "required": ["source_type"],
+ "title": "DataSourceUpdate",
+ "description": "Schema for updating a data source."
+ },
+ "DefaultOrganizationUpdate": {
+ "properties": {
+ "organization_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Organization Id",
+ "description": "The organization's ID."
+ }
+ },
+ "type": "object",
+ "required": ["organization_id"],
+ "title": "DefaultOrganizationUpdate",
+ "description": "Schema for updating the default organization for a user."
+ },
+ "ElementSegmentationConfig": {
+ "properties": {
+ "mode": {
+ "type": "string",
+ "enum": ["element"],
+ "const": "element",
+ "title": "Mode",
+ "default": "element"
+ }
+ },
+ "type": "object",
+ "title": "ElementSegmentationConfig"
+ },
+ "EmbeddingModelConfig": {
+ "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",
+ "description": "The name of the embedding model config."
+ },
+ "embedding_config": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/CohereEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/GeminiEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/VertexAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/BedrockEmbeddingConfig"
+ }
+ ],
+ "title": "Embedding Config",
+ "description": "The embedding configuration for the embedding model config.",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "AZURE_EMBEDDING": "#/components/schemas/AzureOpenAIEmbeddingConfig",
+ "BEDROCK_EMBEDDING": "#/components/schemas/BedrockEmbeddingConfig",
+ "COHERE_EMBEDDING": "#/components/schemas/CohereEmbeddingConfig",
+ "GEMINI_EMBEDDING": "#/components/schemas/GeminiEmbeddingConfig",
+ "HUGGINGFACE_API_EMBEDDING": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig",
+ "OPENAI_EMBEDDING": "#/components/schemas/OpenAIEmbeddingConfig",
+ "VERTEXAI_EMBEDDING": "#/components/schemas/VertexAIEmbeddingConfig"
+ }
+ }
+ },
+ "project_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Project Id"
+ }
+ },
+ "type": "object",
+ "required": ["id", "name", "embedding_config", "project_id"],
+ "title": "EmbeddingModelConfig",
+ "description": "Schema for an embedding model config."
+ },
+ "EmbeddingModelConfigCreate": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the embedding model config."
+ },
+ "embedding_config": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/CohereEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/GeminiEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/VertexAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/BedrockEmbeddingConfig"
+ }
+ ],
+ "title": "Embedding Config",
+ "description": "The embedding configuration for the embedding model config.",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "AZURE_EMBEDDING": "#/components/schemas/AzureOpenAIEmbeddingConfig",
+ "BEDROCK_EMBEDDING": "#/components/schemas/BedrockEmbeddingConfig",
+ "COHERE_EMBEDDING": "#/components/schemas/CohereEmbeddingConfig",
+ "GEMINI_EMBEDDING": "#/components/schemas/GeminiEmbeddingConfig",
+ "HUGGINGFACE_API_EMBEDDING": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig",
+ "OPENAI_EMBEDDING": "#/components/schemas/OpenAIEmbeddingConfig",
+ "VERTEXAI_EMBEDDING": "#/components/schemas/VertexAIEmbeddingConfig"
+ }
+ }
+ }
+ },
+ "type": "object",
+ "required": ["name", "embedding_config"],
+ "title": "EmbeddingModelConfigCreate"
+ },
+ "EmbeddingModelConfigUpdate": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
- "$ref": "#/components/schemas/CloudJiraDataSource"
- },
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "The name of the embedding model config."
+ },
+ "embedding_config": {
+ "anyOf": [
{
- "$ref": "#/components/schemas/CloudBoxDataSource"
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/CohereEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/GeminiEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/OpenAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/VertexAIEmbeddingConfig"
+ },
+ {
+ "$ref": "#/components/schemas/BedrockEmbeddingConfig"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "AZURE_EMBEDDING": "#/components/schemas/AzureOpenAIEmbeddingConfig",
+ "BEDROCK_EMBEDDING": "#/components/schemas/BedrockEmbeddingConfig",
+ "COHERE_EMBEDDING": "#/components/schemas/CohereEmbeddingConfig",
+ "GEMINI_EMBEDDING": "#/components/schemas/GeminiEmbeddingConfig",
+ "HUGGINGFACE_API_EMBEDDING": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig",
+ "OPENAI_EMBEDDING": "#/components/schemas/OpenAIEmbeddingConfig",
+ "VERTEXAI_EMBEDDING": "#/components/schemas/VertexAIEmbeddingConfig"
+ }
+ }
},
{
"type": "null"
}
],
- "title": "Component"
- }
- },
- "type": "object",
- "required": ["source_type"],
- "title": "DataSourceUpdate",
- "description": "Schema for updating a data source."
- },
- "DefaultOrganizationUpdate": {
- "properties": {
- "organization_id": {
- "type": "string",
- "format": "uuid",
- "title": "Organization Id",
- "description": "The organization's ID."
- }
- },
- "type": "object",
- "required": ["organization_id"],
- "title": "DefaultOrganizationUpdate",
- "description": "Schema for updating the default organization for a user."
- },
- "ElementSegmentationConfig": {
- "properties": {
- "mode": {
- "type": "string",
- "enum": ["element"],
- "const": "element",
- "title": "Mode",
- "default": "element"
+ "title": "Embedding Config",
+ "description": "The embedding configuration for the embedding model config."
}
},
"type": "object",
- "title": "ElementSegmentationConfig"
+ "title": "EmbeddingModelConfigUpdate"
},
"EvalDataset": {
"properties": {
@@ -15128,6 +17839,11 @@
"minLength": 1,
"title": "Name"
},
+ "external_file_id": {
+ "type": "string",
+ "title": "External File Id",
+ "description": "The ID of the file in the external system"
+ },
"file_size": {
"anyOf": [
{
@@ -15171,10 +17887,189 @@
"type": "null"
}
],
- "title": "Last Modified At",
- "description": "The last modified time of the file"
+ "title": "Last Modified At",
+ "description": "The last modified time of the file"
+ },
+ "resource_info": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Resource Info",
+ "description": "Resource information for the file"
+ },
+ "permission_info": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Permission Info",
+ "description": "Permission information for the file"
+ },
+ "data_source_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Data Source Id",
+ "description": "The ID of the data source that the file belongs to"
+ }
+ },
+ "type": "object",
+ "required": ["id", "name", "external_file_id", "project_id"],
+ "title": "File",
+ "description": "Schema for a file."
+ },
+ "FileCreate": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1,
+ "title": "Name"
+ },
+ "external_file_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "External File Id",
+ "description": "The ID of the file in the external system"
+ },
+ "file_size": {
+ "anyOf": [
+ {
+ "type": "integer",
+ "minimum": 0
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "File Size",
+ "description": "Size of the file in bytes"
+ },
+ "last_modified_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Modified At",
+ "description": "The last modified time of the file"
+ },
+ "resource_info": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Resource Info",
+ "description": "Resource information for the file"
},
- "resource_info": {
+ "permission_info": {
"anyOf": [
{
"additionalProperties": {
@@ -15209,8 +18104,8 @@
"type": "null"
}
],
- "title": "Resource Info",
- "description": "Resource information for the file"
+ "title": "Permission Info",
+ "description": "Permission information for the file"
},
"data_source_id": {
"anyOf": [
@@ -15227,43 +18122,71 @@
}
},
"type": "object",
- "required": ["id", "name", "project_id"],
- "title": "File",
- "description": "Schema for a file."
+ "required": ["name"],
+ "title": "FileCreate"
},
- "FileCreate": {
+ "FileCreateFromUrl": {
"properties": {
"name": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 3000,
+ "minLength": 1
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "url": {
"type": "string",
- "maxLength": 3000,
"minLength": 1,
- "title": "Name"
+ "format": "uri",
+ "title": "Url",
+ "description": "URL of the file to download"
},
- "file_size": {
+ "proxy_url": {
"anyOf": [
{
- "type": "integer",
- "minimum": 0
+ "type": "string",
+ "minLength": 1,
+ "format": "uri"
},
{
"type": "null"
}
],
- "title": "File Size",
- "description": "Size of the file in bytes"
+ "title": "Proxy Url",
+ "description": "URL of the proxy server to use for downloading the file"
},
- "last_modified_at": {
+ "request_headers": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Last Modified At",
- "description": "The last modified time of the file"
+ "title": "Request Headers",
+ "description": "Headers to include in the request when downloading the file"
+ },
+ "verify_ssl": {
+ "type": "boolean",
+ "title": "Verify Ssl",
+ "description": "Whether to verify the SSL certificate when downloading the file",
+ "default": true
+ },
+ "follow_redirects": {
+ "type": "boolean",
+ "title": "Follow Redirects",
+ "description": "Whether to follow redirects when downloading the file",
+ "default": true
},
"resource_info": {
"anyOf": [
@@ -15302,24 +18225,11 @@
],
"title": "Resource Info",
"description": "Resource information for the file"
- },
- "data_source_id": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Data Source Id",
- "description": "The ID of the data source that the file belongs to"
}
},
"type": "object",
- "required": ["name"],
- "title": "FileCreate"
+ "required": ["url"],
+ "title": "FileCreateFromUrl"
},
"FilterCondition": {
"type": "string",
@@ -15702,6 +18612,57 @@
"title": "InputMessage",
"description": "This is distinct from a ChatMessage because this schema is enforced by the AI Chat library used in the frontend"
},
+ "IntervalUsageAndPlan": {
+ "properties": {
+ "start_window": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Window"
+ },
+ "end_window": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "End Window"
+ },
+ "plan": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Plan"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "usage": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Usage"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ }
+ },
+ "type": "object",
+ "required": ["start_window", "end_window", "plan", "usage"],
+ "title": "IntervalUsageAndPlan"
+ },
"JobNameMapping": {
"type": "string",
"enum": [
@@ -15711,7 +18672,8 @@
"FILE_UPDATER",
"PARSE",
"TRANSFORM",
- "INGESTION"
+ "INGESTION",
+ "METADATA_UPDATE"
],
"title": "JobNameMapping",
"description": "Enum for mapping original job names to readable names."
@@ -15828,6 +18790,18 @@
"description": "The temperature value for the model.",
"default": 0.1
},
+ "use_chain_of_thought_reasoning": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Use Chain Of Thought Reasoning",
+ "description": "Whether to use chain of thought reasoning."
+ },
"class_name": {
"type": "string",
"title": "Class Name",
@@ -15867,11 +18841,21 @@
"title": "Disable Reconstruction",
"default": false
},
+ "disable_image_extraction": {
+ "type": "boolean",
+ "title": "Disable Image Extraction",
+ "default": false
+ },
"invalidate_cache": {
"type": "boolean",
"title": "Invalidate Cache",
"default": false
},
+ "output_pdf_of_document": {
+ "type": "boolean",
+ "title": "Output Pdf Of Document",
+ "default": false
+ },
"do_not_cache": {
"type": "boolean",
"title": "Do Not Cache",
@@ -15902,6 +18886,26 @@
"title": "Do Not Unroll Columns",
"default": false
},
+ "html_make_all_elements_visible": {
+ "type": "boolean",
+ "title": "Html Make All Elements Visible",
+ "default": false
+ },
+ "html_remove_navigation_elements": {
+ "type": "boolean",
+ "title": "Html Remove Navigation Elements",
+ "default": false
+ },
+ "html_remove_fixed_elements": {
+ "type": "boolean",
+ "title": "Html Remove Fixed Elements",
+ "default": false
+ },
+ "guess_xlsx_sheet_name": {
+ "type": "boolean",
+ "title": "Guess Xlsx Sheet Name",
+ "default": false
+ },
"page_separator": {
"anyOf": [
{
@@ -15918,6 +18922,50 @@
"title": "Bounding Box",
"default": ""
},
+ "bbox_top": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Bbox Top"
+ },
+ "bbox_right": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Bbox Right"
+ },
+ "bbox_bottom": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Bbox Bottom"
+ },
+ "bbox_left": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Bbox Left"
+ },
"target_pages": {
"type": "string",
"title": "Target Pages",
@@ -15968,22 +19016,104 @@
"title": "Premium Mode",
"default": false
},
- "continuous_mode": {
+ "continuous_mode": {
+ "type": "boolean",
+ "title": "Continuous Mode",
+ "default": false
+ },
+ "s3_input_path": {
+ "type": "string",
+ "title": "S3 Input Path",
+ "default": ""
+ },
+ "s3_output_path_prefix": {
+ "type": "string",
+ "title": "S3 Output Path Prefix",
+ "default": ""
+ },
+ "project_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Project Id"
+ },
+ "azure_openai_deployment_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Openai Deployment Name"
+ },
+ "azure_openai_endpoint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Openai Endpoint"
+ },
+ "azure_openai_api_version": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Openai Api Version"
+ },
+ "azure_openai_key": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Azure Openai Key"
+ },
+ "input_url": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Input Url"
+ },
+ "http_proxy": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Http Proxy"
+ },
+ "auto_mode": {
"type": "boolean",
- "title": "Continuous Mode",
+ "title": "Auto Mode",
"default": false
},
- "s3_input_path": {
- "type": "string",
- "title": "S3 Input Path",
- "default": ""
- },
- "s3_output_path_prefix": {
- "type": "string",
- "title": "S3 Output Path Prefix",
- "default": ""
- },
- "azure_openai_deployment_name": {
+ "auto_mode_trigger_on_regexp_in_page": {
"anyOf": [
{
"type": "string"
@@ -15992,9 +19122,9 @@
"type": "null"
}
],
- "title": "Azure Openai Deployment Name"
+ "title": "Auto Mode Trigger On Regexp In Page"
},
- "azure_openai_endpoint": {
+ "auto_mode_trigger_on_text_in_page": {
"anyOf": [
{
"type": "string"
@@ -16003,9 +19133,24 @@
"type": "null"
}
],
- "title": "Azure Openai Endpoint"
+ "title": "Auto Mode Trigger On Text In Page"
},
- "azure_openai_api_version": {
+ "auto_mode_trigger_on_table_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Table In Page",
+ "default": false
+ },
+ "auto_mode_trigger_on_image_in_page": {
+ "type": "boolean",
+ "title": "Auto Mode Trigger On Image In Page",
+ "default": false
+ },
+ "structured_output": {
+ "type": "boolean",
+ "title": "Structured Output",
+ "default": false
+ },
+ "structured_output_json_schema": {
"anyOf": [
{
"type": "string"
@@ -16014,9 +19159,9 @@
"type": "null"
}
],
- "title": "Azure Openai Api Version"
+ "title": "Structured Output Json Schema"
},
- "azure_openai_key": {
+ "structured_output_json_schema_name": {
"anyOf": [
{
"type": "string"
@@ -16025,7 +19170,23 @@
"type": "null"
}
],
- "title": "Azure Openai Key"
+ "title": "Structured Output Json Schema Name"
+ },
+ "max_pages": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Max Pages"
+ },
+ "extract_charts": {
+ "type": "boolean",
+ "title": "Extract Charts",
+ "default": false
}
},
"type": "object",
@@ -16372,6 +19533,19 @@
],
"title": "Error",
"description": "List of errors that occurred during ingestion."
+ },
+ "effective_at": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Effective At",
+ "description": "When the status is effective"
}
},
"type": "object",
@@ -16489,12 +19663,12 @@
"class_name": {
"type": "string",
"title": "Class Name",
- "default": "MarkdownNodeParser"
+ "default": "base_component"
}
},
"type": "object",
"title": "MarkdownNodeParser",
- "description": "Markdown node parser.\n\nSplits a document into Nodes using custom Markdown splitting logic.\n\nArgs:\n include_metadata (bool): whether to include metadata in nodes\n include_prev_next_rel (bool): whether to include prev/next relationships"
+ "description": "Markdown node parser.\n\nSplits a document into Nodes using Markdown header-based splitting logic.\nEach node contains its text content and the path of headers leading to it.\n\nArgs:\n include_metadata (bool): whether to include metadata in nodes\n include_prev_next_rel (bool): whether to include prev/next relationships"
},
"MessageAnnotation": {
"properties": {
@@ -16919,6 +20093,29 @@
"minLength": 1,
"title": "Name",
"description": "A name for the organization."
+ },
+ "stripe_customer_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stripe Customer Id",
+ "description": "The Stripe customer ID for the organization."
+ },
+ "parse_plan_level": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/ParsePlanLevel"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Whether the organization is a Parse Premium customer."
}
},
"type": "object",
@@ -17078,6 +20275,42 @@
"title": "PageSplitterNodeParser",
"description": "Split text into pages."
},
+ "PaginatedListPipelineFilesResponse": {
+ "properties": {
+ "files": {
+ "items": {
+ "$ref": "#/components/schemas/PipelineFile"
+ },
+ "type": "array",
+ "title": "Files",
+ "description": "The files to list"
+ },
+ "limit": {
+ "type": "integer",
+ "title": "Limit",
+ "description": "The limit of the files"
+ },
+ "offset": {
+ "type": "integer",
+ "title": "Offset",
+ "description": "The offset of the files"
+ },
+ "total_count": {
+ "type": "integer",
+ "title": "Total Count",
+ "description": "The total number of files"
+ }
+ },
+ "type": "object",
+ "required": ["files", "limit", "offset", "total_count"],
+ "title": "PaginatedListPipelineFilesResponse"
+ },
+ "ParsePlanLevel": {
+ "type": "string",
+ "enum": ["DEFAULT", "PREMIUM"],
+ "title": "ParsePlanLevel",
+ "description": "Enum for the Parse plan level."
+ },
"ParserLanguages": {
"type": "string",
"enum": [
@@ -17310,6 +20543,21 @@
"required": ["markdown", "job_metadata"],
"title": "ParsingJobMarkdownResult"
},
+ "ParsingJobStructuredResult": {
+ "properties": {
+ "structured": {
+ "title": "Structured",
+ "description": "The json result of the structured parsing job"
+ },
+ "job_metadata": {
+ "title": "Job Metadata",
+ "description": "Parsing job metadata , including usage"
+ }
+ },
+ "type": "object",
+ "required": ["structured", "job_metadata"],
+ "title": "ParsingJobStructuredResult"
+ },
"ParsingJobTextResult": {
"properties": {
"text": {
@@ -17469,6 +20717,19 @@
"format": "uuid",
"title": "Project Id"
},
+ "embedding_model_config_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Embedding Model Config Id",
+ "description": "The ID of the EmbeddingModelConfig this pipeline is using."
+ },
"pipeline_type": {
"$ref": "#/components/schemas/PipelineType",
"description": "Type of pipeline. Either PLAYGROUND or MANAGED.",
@@ -17730,6 +20991,19 @@
"title": "Data Sink Id",
"description": "Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID."
},
+ "embedding_model_config_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Embedding Model Config Id",
+ "description": "Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID."
+ },
"data_sink": {
"anyOf": [
{
@@ -17898,7 +21172,8 @@
"$ref": "#/components/schemas/CloudBoxDataSource"
}
],
- "title": "Component"
+ "title": "DataSourceCreateComponent",
+ "description": "Component that implements the data source"
},
"project_id": {
"type": "string",
@@ -18123,6 +21398,18 @@
],
"title": "Name"
},
+ "external_file_id": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "External File Id",
+ "description": "The ID of the file in the external system"
+ },
"file_size": {
"anyOf": [
{
@@ -18207,6 +21494,44 @@
"title": "Resource Info",
"description": "Resource information for the file"
},
+ "permission_info": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "anyOf": [
+ {
+ "type": "object"
+ },
+ {
+ "items": {},
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Permission Info",
+ "description": "Permission information for the file"
+ },
"data_source_id": {
"anyOf": [
{
@@ -18314,6 +21639,18 @@
],
"title": "Config Hash",
"description": "Hashes for the configuration of the pipeline."
+ },
+ "indexed_page_count": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Indexed Page Count",
+ "description": "The number of pages that have been indexed for this file"
}
},
"type": "object",
@@ -18515,6 +21852,19 @@
"title": "Data Sink Id",
"description": "Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID."
},
+ "embedding_model_config_id": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Embedding Model Config Id",
+ "description": "Embedding model config ID. When provided instead of embedding_config, the embedding model config will be looked up by ID."
+ },
"data_sink": {
"anyOf": [
{
@@ -18588,6 +21938,55 @@
"title": "PipelineUpdate",
"description": "Schema for updating a pipeline."
},
+ "Plan": {
+ "properties": {
+ "total_users": {
+ "type": "integer",
+ "title": "Total Users",
+ "default": 1
+ },
+ "total_indexes": {
+ "type": "integer",
+ "title": "Total Indexes",
+ "default": 5
+ },
+ "total_indexed_pages": {
+ "type": "integer",
+ "title": "Total Indexed Pages",
+ "default": 10000
+ },
+ "credits": {
+ "type": "integer",
+ "title": "Credits",
+ "default": 30000
+ },
+ "has_payment_method": {
+ "type": "boolean",
+ "title": "Has Payment Method",
+ "default": false
+ },
+ "free": {
+ "type": "boolean",
+ "title": "Free",
+ "description": "If is a free plan",
+ "default": true
+ },
+ "allowed_index": {
+ "type": "boolean",
+ "title": "Allowed Index",
+ "description": "If is allowed to use indexes",
+ "default": true
+ },
+ "allowed_external_index": {
+ "type": "boolean",
+ "title": "Allowed External Index",
+ "description": "If is allowed to use external data sources or sinks in indexes",
+ "default": false
+ }
+ },
+ "type": "object",
+ "title": "Plan"
+ },
"PlaygroundSession": {
"properties": {
"id": {
@@ -18692,6 +22091,21 @@
"description": "Number of nodes for dense retrieval.",
"default": 30
},
+ "dense_similarity_cutoff": {
+ "anyOf": [
+ {
+ "type": "number",
+ "maximum": 1,
+ "minimum": 0
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dense Similarity Cutoff",
+ "description": "Minimum similarity score wrt query for retrieval",
+ "default": 0
+ },
"sparse_similarity_top_k": {
"anyOf": [
{
@@ -18732,7 +22146,7 @@
],
"title": "Rerank Top N",
"description": "Number of reranked nodes for returning.",
- "default": 3
+ "default": 6
},
"alpha": {
"anyOf": [
@@ -18777,7 +22191,7 @@
"retrieval_mode": {
"$ref": "#/components/schemas/RetrievalMode",
"description": "The retrieval mode for the query.",
- "default": "auto_routed"
+ "default": "chunks"
},
"retrieve_image_nodes": {
"type": "boolean",
@@ -19099,6 +22513,21 @@
"description": "Number of nodes for dense retrieval.",
"default": 30
},
+ "dense_similarity_cutoff": {
+ "anyOf": [
+ {
+ "type": "number",
+ "maximum": 1,
+ "minimum": 0
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dense Similarity Cutoff",
+ "description": "Minimum similarity score wrt query for retrieval",
+ "default": 0
+ },
"sparse_similarity_top_k": {
"anyOf": [
{
@@ -19139,7 +22568,7 @@
],
"title": "Rerank Top N",
"description": "Number of reranked nodes for returning.",
- "default": 3
+ "default": 6
},
"alpha": {
"anyOf": [
@@ -19184,7 +22613,7 @@
"retrieval_mode": {
"$ref": "#/components/schemas/RetrievalMode",
"description": "The retrieval mode for the query.",
- "default": "auto_routed"
+ "default": "chunks"
},
"retrieve_image_nodes": {
"type": "boolean",
@@ -19255,7 +22684,7 @@
}
},
"type": "object",
- "required": ["pipeline_id", "retrieval_nodes", "retrieval_latency"],
+ "required": ["pipeline_id", "retrieval_nodes"],
"title": "RetrieveResults",
"description": "Schema for the result of an retrieval execution."
},
@@ -19754,6 +23183,48 @@
"enum": ["NODE_PARSER", "EMBEDDING"],
"title": "TransformationCategoryNames"
},
+ "Usage": {
+ "properties": {
+ "total_users": {
+ "type": "integer",
+ "title": "Total Users",
+ "default": 0
+ },
+ "total_indexes": {
+ "type": "integer",
+ "title": "Total Indexes",
+ "default": 0
+ },
+ "total_indexed_pages": {
+ "type": "integer",
+ "title": "Total Indexed Pages",
+ "default": 0
+ },
+ "extract_pages": {
+ "type": "integer",
+ "title": "Extract Pages",
+ "default": 0
+ },
+ "parse_pages": {
+ "type": "integer",
+ "title": "Parse Pages",
+ "default": 0
+ },
+ "index_pages": {
+ "type": "integer",
+ "title": "Index Pages",
+ "default": 0
+ },
+ "credits": {
+ "type": "integer",
+ "title": "Credits",
+ "default": 0
+ }
+ },
+ "type": "object",
+ "title": "Usage",
+ "description": "Response model; use UsageSubmission for tracking"
+ },
"UserOrganization": {
"properties": {
"id": {
diff --git a/packages/cloud/src/reader.ts b/packages/cloud/src/reader.ts
index 7ae3885baf09cd1dcb741b88c5b03e0e294d3719..f6bd34a0b270ad5bc4558af776f53fac673b0f4a 100644
--- a/packages/cloud/src/reader.ts
+++ b/packages/cloud/src/reader.ts
@@ -96,6 +96,28 @@ export class LlamaParseReader extends FileReader {
azureOpenaiEndpoint?: string | undefined;
azureOpenaiApiVersion?: string | undefined;
azureOpenaiKey?: string | undefined;
+ auto_mode?: boolean | undefined;
+ auto_mode_trigger_on_image_in_page?: boolean | undefined;
+ auto_mode_trigger_on_table_in_page?: boolean | undefined;
+ auto_mode_trigger_on_text_in_page?: string | undefined;
+ auto_mode_trigger_on_regexp_in_page?: string | undefined;
+ bbox_bottom?: number | undefined;
+ bbox_left?: number | undefined;
+ bbox_right?: number | undefined;
+ bbox_top?: number | undefined;
+ disable_image_extraction?: boolean | undefined;
+ extract_charts?: boolean | undefined;
+ guess_xlsx_sheet_name?: boolean | undefined;
+ html_make_all_elements_visible?: boolean | undefined;
+ html_remove_fixed_elements?: boolean | undefined;
+ html_remove_navigation_elements?: boolean | undefined;
+ http_proxy?: string | undefined;
+ input_url?: string | undefined;
+ max_pages?: number | undefined;
+ output_pdf_of_document?: boolean | undefined;
+ structured_output?: boolean | undefined;
+ structured_output_json_schema?: string | undefined;
+ structured_output_json_schema_name?: string | undefined;
// numWorkers is implemented in SimpleDirectoryReader
stdout?: WriteStream | undefined;
@@ -200,6 +222,32 @@ export class LlamaParseReader extends FileReader {
azure_openai_endpoint: this.azureOpenaiEndpoint,
azure_openai_api_version: this.azureOpenaiApiVersion,
azure_openai_key: this.azureOpenaiKey,
+ auto_mode: this.auto_mode,
+ auto_mode_trigger_on_image_in_page:
+ this.auto_mode_trigger_on_image_in_page,
+ auto_mode_trigger_on_table_in_page:
+ this.auto_mode_trigger_on_table_in_page,
+ auto_mode_trigger_on_text_in_page: this.auto_mode_trigger_on_text_in_page,
+ auto_mode_trigger_on_regexp_in_page:
+ this.auto_mode_trigger_on_regexp_in_page,
+ bbox_bottom: this.bbox_bottom,
+ bbox_left: this.bbox_left,
+ bbox_right: this.bbox_right,
+ bbox_top: this.bbox_top,
+ disable_image_extraction: this.disable_image_extraction,
+ extract_charts: this.extract_charts,
+ guess_xlsx_sheet_name: this.guess_xlsx_sheet_name,
+ html_make_all_elements_visible: this.html_make_all_elements_visible,
+ html_remove_fixed_elements: this.html_remove_fixed_elements,
+ html_remove_navigation_elements: this.html_remove_navigation_elements,
+ http_proxy: this.http_proxy,
+ input_url: this.input_url,
+ max_pages: this.max_pages,
+ output_pdf_of_document: this.output_pdf_of_document,
+ structured_output: this.structured_output,
+ structured_output_json_schema: this.structured_output_json_schema,
+ structured_output_json_schema_name:
+ this.structured_output_json_schema_name,
} satisfies {
[Key in keyof Body_upload_file_api_v1_parsing_upload_post]-?:
| Body_upload_file_api_v1_parsing_upload_post[Key]