diff --git a/.changeset/eleven-jeans-admire.md b/.changeset/eleven-jeans-admire.md new file mode 100644 index 0000000000..01a6b468ae --- /dev/null +++ b/.changeset/eleven-jeans-admire.md @@ -0,0 +1,5 @@ +--- +"@llamaindex/cloud": patch +--- + +feat: bump cloud sdk version diff --git a/packages/cloud/openapi.json b/packages/cloud/openapi.json index e7baf161b4..e27a423d80 100644 --- a/packages/cloud/openapi.json +++ b/packages/cloud/openapi.json @@ -6,33 +6,54 @@ }, "paths": { "/api/v1/api-keys": { - "get": { + "post": { "tags": ["API Keys"], - "summary": "List Keys", - "description": "List API Keys for a user.", - "operationId": "list_keys_api_v1_api_keys_get", + "summary": "Generate Key", + "description": "Generate a new API Key.", + "operationId": "generate_key_api_v1_api_keys_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIKeyCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/APIKey" - }, - "type": "array", - "title": "Response List Keys Api V1 Api Keys Get" + "$ref": "#/components/schemas/APIKey" } } } @@ -47,7 +68,13 @@ } } } - }, + } + }, + "get": { + "tags": ["API Keys"], + "summary": "List Keys", + "description": "List API Keys for a user.", + "operationId": "list_keys_api_v1_api_keys_get", "security": [ { "HTTPBearer": [] @@ -55,41 +82,36 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["API Keys"], - "summary": "Generate Key", - "description": "Generate a new API Key.", - "operationId": "generate_key_api_v1_api_keys_post", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIKeyCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/APIKey" + "type": "array", + "items": { + "$ref": "#/components/schemas/APIKey" + }, + "title": "Response List Keys Api V1 Api Keys Get" } } } @@ -104,7 +126,15 @@ } } } - }, + } + } + }, + "/api/v1/api-keys/{api_key_id}": { + "delete": { + "tags": ["API Keys"], + "summary": "Delete Api Key", + "description": "Delete an API Key by ID.", + "operationId": "delete_api_key_api_v1_api_keys__api_key_id__delete", "security": [ { "HTTPBearer": [] @@ -112,56 +142,38 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/api-keys/{api_key_id}": { - "put": { - "tags": ["API Keys"], - "summary": "Update Existing Api Key", - "description": "Update name of an existing API Key.", - "operationId": "update_existing_api_key_api_v1_api_keys__api_key_id__put", + ], "parameters": [ { + "name": "api_key_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Api Key Id" - }, - "name": "api_key_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIKeyUpdate" - } - } - }, - "required": true - }, "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/APIKey" - } - } - } + "204": { + "description": "Successful Response" }, "422": { "description": "Validation Error", @@ -173,7 +185,13 @@ } } } - }, + } + }, + "put": { + "tags": ["API Keys"], + "summary": "Update Existing Api Key", + "description": "Update name of an existing API Key.", + "operationId": "update_existing_api_key_api_v1_api_keys__api_key_id__put", "security": [ { "HTTPBearer": [] @@ -181,37 +199,55 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["API Keys"], - "summary": "Delete Api Key", - "description": "Delete an API Key by ID.", - "operationId": "delete_api_key_api_v1_api_keys__api_key_id__delete", + ], "parameters": [ { + "name": "api_key_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Api Key Id" - }, - "name": "api_key_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIKeyUpdate" + } + } + } + }, "responses": { - "204": { - "description": "Successful Response" + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/APIKey" + } + } + } }, "422": { "description": "Validation Error", @@ -223,15 +259,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/validate-integrations/validate-embedding-connection": { @@ -239,22 +267,38 @@ "summary": "Validate Embedding Connection", "description": "Validate an embedding connection.", "operationId": "validate_embedding_connection_api_v1_validate_integrations_validate_embedding_connection_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "anyOf": [ + "oneOf": [ { "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig" }, @@ -277,11 +321,22 @@ "$ref": "#/components/schemas/BedrockEmbeddingConfig" } ], + "discriminator": { + "propertyName": "type", + "mapping": { + "AZURE_EMBEDDING": "#/components/schemas/AzureOpenAIEmbeddingConfig", + "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", + "BEDROCK_EMBEDDING": "#/components/schemas/BedrockEmbeddingConfig" + } + }, "title": "Embedding Config" } } - }, - "required": true + } }, "responses": { "200": { @@ -304,15 +359,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/validate-integrations/validate-data-source-connection": { @@ -320,26 +367,41 @@ "summary": "Validate Data Source Connection", "description": "Validate a data source connection.", "operationId": "validate_data_source_connection_api_v1_validate_integrations_validate_data_source_connection_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -362,15 +424,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/validate-integrations/validate-data-sink-connection": { @@ -378,26 +432,41 @@ "summary": "Validate Data Sink Connection", "description": "Validate a data sink connection.", "operationId": "validate_data_sink_connection_api_v1_validate_integrations_validate_data_sink_connection_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSinkCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -420,15 +489,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/data-sinks": { @@ -437,25 +498,47 @@ "summary": "List Data Sinks", "description": "List data sinks for a given project.\nIf project_id is not provided, uses the default project.", "operationId": "list_data_sinks_api_v1_data_sinks_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -464,10 +547,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/DataSink" }, - "type": "array", "title": "Response List Data Sinks Api V1 Data Sinks Get" } } @@ -483,7 +566,13 @@ } } } - }, + } + }, + "post": { + "tags": ["Data Sinks"], + "summary": "Create Data Sink", + "description": "Create a new data sink.", + "operationId": "create_data_sink_api_v1_data_sinks_post", "security": [ { "HTTPBearer": [] @@ -491,53 +580,68 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Data Sinks"], - "summary": "Upsert Data Sink", - "description": "Upserts a data sink.\nUpdates if a data sink with the same name and project_id already exists. Otherwise, creates a new data sink.", - "operationId": "upsert_data_sink_api_v1_data_sinks_put", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSinkCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -560,7 +664,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Data Sinks"], + "summary": "Upsert Data Sink", + "description": "Upserts a data sink.\nUpdates if a data sink with the same name and project_id already exists. Otherwise, creates a new data sink.", + "operationId": "upsert_data_sink_api_v1_data_sinks_put", "security": [ { "HTTPBearer": [] @@ -568,53 +678,68 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Data Sinks"], - "summary": "Create Data Sink", - "description": "Create a new data sink.", - "operationId": "create_data_sink_api_v1_data_sinks_post", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSinkCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -637,15 +762,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/data-sinks/{data_sink_id}": { @@ -654,25 +771,40 @@ "summary": "Get Data Sink", "description": "Get a data sink by ID.", "operationId": "get_data_sink_api_v1_data_sinks__data_sink_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "data_sink_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Sink Id" - }, - "name": "data_sink_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -696,7 +828,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Data Sinks"], + "summary": "Update Data Sink", + "description": "Update a data sink by ID.", + "operationId": "update_data_sink_api_v1_data_sinks__data_sink_id__put", "security": [ { "HTTPBearer": [] @@ -704,43 +842,44 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Data Sinks"], - "summary": "Update Data Sink", - "description": "Update a data sink by ID.", - "operationId": "update_data_sink_api_v1_data_sinks__data_sink_id__put", + ], "parameters": [ { + "name": "data_sink_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Sink Id" - }, - "name": "data_sink_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSinkUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -763,7 +902,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Data Sinks"], + "summary": "Delete Data Sink", + "description": "Delete a data sink by ID.", + "operationId": "delete_data_sink_api_v1_data_sinks__data_sink_id__delete", "security": [ { "HTTPBearer": [] @@ -771,32 +916,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Data Sinks"], - "summary": "Delete Data Sink", - "description": "Delete a data sink by ID.", - "operationId": "delete_data_sink_api_v1_data_sinks__data_sink_id__delete", + ], "parameters": [ { + "name": "data_sink_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Sink Id" - }, - "name": "data_sink_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -813,15 +959,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/data-sources": { @@ -830,35 +968,64 @@ "summary": "List Data Sources", "description": "List data sources for a given project.\nIf project_id is not provided, uses the default project.", "operationId": "list_data_sources_api_v1_data_sources_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -867,10 +1034,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/DataSource" }, - "type": "array", "title": "Response List Data Sources Api V1 Data Sources Get" } } @@ -886,7 +1053,13 @@ } } } - }, + } + }, + "post": { + "tags": ["Data Sources"], + "summary": "Create Data Source", + "description": "Create a new data source.", + "operationId": "create_data_source_api_v1_data_sources_post", "security": [ { "HTTPBearer": [] @@ -894,53 +1067,68 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Data Sources"], - "summary": "Upsert Data Source", - "description": "Upserts a data source.\nUpdates if a data source with the same name and project_id already exists. Otherwise, creates a new data source.", - "operationId": "upsert_data_source_api_v1_data_sources_put", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -963,7 +1151,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Data Sources"], + "summary": "Upsert Data Source", + "description": "Upserts a data source.\nUpdates if a data source with the same name and project_id already exists. Otherwise, creates a new data source.", + "operationId": "upsert_data_source_api_v1_data_sources_put", "security": [ { "HTTPBearer": [] @@ -971,53 +1165,68 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Data Sources"], - "summary": "Create Data Source", - "description": "Create a new data source.", - "operationId": "create_data_source_api_v1_data_sources_post", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -1040,15 +1249,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/data-sources/{data_source_id}": { @@ -1057,25 +1258,40 @@ "summary": "Get Data Source", "description": "Get a data source by ID.", "operationId": "get_data_source_api_v1_data_sources__data_source_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1099,7 +1315,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Data Sources"], + "summary": "Update Data Source", + "description": "Update a data source by ID.", + "operationId": "update_data_source_api_v1_data_sources__data_source_id__put", "security": [ { "HTTPBearer": [] @@ -1107,43 +1329,44 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Data Sources"], - "summary": "Update Data Source", - "description": "Update a data source by ID.", - "operationId": "update_data_source_api_v1_data_sources__data_source_id__put", + ], "parameters": [ { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -1166,7 +1389,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Data Sources"], + "summary": "Delete Data Source", + "description": "Delete a data source by ID.", + "operationId": "delete_data_source_api_v1_data_sources__data_source_id__delete", "security": [ { "HTTPBearer": [] @@ -1174,32 +1403,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Data Sources"], - "summary": "Delete Data Source", - "description": "Delete a data source by ID.", - "operationId": "delete_data_source_api_v1_data_sources__data_source_id__delete", + ], "parameters": [ { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1216,7 +1446,15 @@ } } } - }, + } + } + }, + "/api/v1/organizations": { + "post": { + "tags": ["Organizations"], + "summary": "Create Organization", + "description": "Create a new organization.", + "operationId": "create_organization_api_v1_organizations_post", "security": [ { "HTTPBearer": [] @@ -1224,37 +1462,42 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/organizations": { - "get": { - "tags": ["Organizations"], - "summary": "List Organizations", - "description": "List organizations for a user.", - "operationId": "list_organizations_api_v1_organizations_get", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/Organization" - }, - "type": "array", - "title": "Response List Organizations Api V1 Organizations Get" + "$ref": "#/components/schemas/Organization" } } } @@ -1269,7 +1512,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Organizations"], + "summary": "Upsert Organization", + "description": "Upsert a new organization.", + "operationId": "upsert_organization_api_v1_organizations_put", "security": [ { "HTTPBearer": [] @@ -1277,33 +1526,34 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Organizations"], - "summary": "Upsert Organization", - "description": "Upsert a new organization.", - "operationId": "upsert_organization_api_v1_organizations_put", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -1326,7 +1576,13 @@ } } } - }, + } + }, + "get": { + "tags": ["Organizations"], + "summary": "List Organizations", + "description": "List organizations for a user.", + "operationId": "list_organizations_api_v1_organizations_get", "security": [ { "HTTPBearer": [] @@ -1334,41 +1590,36 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Organizations"], - "summary": "Create Organization", - "description": "Create a new organization.", - "operationId": "create_organization_api_v1_organizations_post", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Organization" + "type": "array", + "items": { + "$ref": "#/components/schemas/Organization" + }, + "title": "Response List Organizations Api V1 Organizations Get" } } } @@ -1383,7 +1634,15 @@ } } } - }, + } + } + }, + "/api/v1/organizations/default": { + "put": { + "tags": ["Organizations"], + "summary": "Set Default Organization", + "description": "Set the default organization for the user.", + "operationId": "set_default_organization_api_v1_organizations_default_put", "security": [ { "HTTPBearer": [] @@ -1391,26 +1650,35 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/organizations/default": { - "get": { - "tags": ["Organizations"], - "summary": "Get Default Organization", - "description": "Get the default organization for the user.", - "operationId": "get_default_organization_api_v1_organizations_default_get", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DefaultOrganizationUpdate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", @@ -1432,7 +1700,13 @@ } } } - }, + } + }, + "get": { + "tags": ["Organizations"], + "summary": "Get Default Organization", + "description": "Get the default organization for the user.", + "operationId": "get_default_organization_api_v1_organizations_default_get", "security": [ { "HTTPBearer": [] @@ -1440,34 +1714,25 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Organizations"], - "summary": "Set Default Organization", - "description": "Set the default organization for the user.", - "operationId": "set_default_organization_api_v1_organizations_default_put", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DefaultOrganizationUpdate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", @@ -1489,15 +1754,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/organizations/{organization_id}": { @@ -1506,25 +1763,40 @@ "summary": "Get Organization", "description": "Get an organization by ID.", "operationId": "get_organization_api_v1_organizations__organization_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1548,7 +1820,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Organizations"], + "summary": "Update Organization", + "description": "Update an existing organization.", + "operationId": "update_organization_api_v1_organizations__organization_id__put", "security": [ { "HTTPBearer": [] @@ -1556,43 +1834,44 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Organizations"], - "summary": "Update Organization", - "description": "Update an existing organization.", - "operationId": "update_organization_api_v1_organizations__organization_id__put", + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", - "title": "Session" - }, - "name": "session", - "in": "cookie" + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Session" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -1615,7 +1894,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Organizations"], + "summary": "Delete Organization", + "description": "Delete an organization by ID.", + "operationId": "delete_organization_api_v1_organizations__organization_id__delete", "security": [ { "HTTPBearer": [] @@ -1623,32 +1908,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Organizations"], - "summary": "Delete Organization", - "description": "Delete an organization by ID.", - "operationId": "delete_organization_api_v1_organizations__organization_id__delete", + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1665,15 +1951,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/organizations/{organization_id}/users": { @@ -1682,25 +1960,40 @@ "summary": "List Organization Users", "description": "Get all users in an organization.", "operationId": "list_organization_users_api_v1_organizations__organization_id__users_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1709,10 +2002,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/UserOrganization" }, - "type": "array", "title": "Response List Organization Users Api V1 Organizations Organization Id Users Get" } } @@ -1728,7 +2021,13 @@ } } } - }, + } + }, + "put": { + "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", "security": [ { "HTTPBearer": [] @@ -1736,47 +2035,48 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "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", + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/UserOrganizationCreate" }, - "type": "array", "title": "Payload" } } - }, - "required": true + } }, "responses": { "200": { @@ -1784,10 +2084,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/UserOrganization" }, - "type": "array", "title": "Response Add Users To Organization Api V1 Organizations Organization Id Users Put" } } @@ -1803,15 +2103,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/organizations/{organization_id}/users/{member_user_id}": { @@ -1820,34 +2112,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "member_user_id", + "in": "path", "required": true, "schema": { "type": "string", "title": "Member User Id" - }, - "name": "member_user_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1864,15 +2171,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/organizations/{organization_id}/users/remove": { @@ -1881,40 +2180,55 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "organization_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Organization Id" - }, - "name": "organization_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/UserOrganizationDelete" }, - "type": "array", "title": "Payload" } } - }, - "required": true + } }, "responses": { "204": { @@ -1930,15 +2244,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects": { @@ -1947,34 +2253,63 @@ "summary": "List Projects", "description": "List projects or get one by name", "operationId": "list_projects_api_v1_projects_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "project_name", + "in": "query", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Project Name" - }, - "name": "project_name", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -1983,10 +2318,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/Project" }, - "type": "array", "title": "Response List Projects Api V1 Projects Get" } } @@ -2002,7 +2337,13 @@ } } } - }, + } + }, + "post": { + "tags": ["Projects"], + "summary": "Create Project", + "description": "Create a new project.", + "operationId": "create_project_api_v1_projects_post", "security": [ { "HTTPBearer": [] @@ -2010,43 +2351,51 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -2069,7 +2418,13 @@ } } } - }, + } + }, + "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", "security": [ { "HTTPBearer": [] @@ -2077,43 +2432,51 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Projects"], - "summary": "Create Project", - "description": "Create a new project.", - "operationId": "create_project_api_v1_projects_post", + ], "parameters": [ { + "name": "organization_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Organization Id" - }, - "name": "organization_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -2136,7 +2499,15 @@ } } } - }, + } + } + }, + "/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", "security": [ { "HTTPBearer": [] @@ -2144,46 +2515,38 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/projects/{project_id}": { - "get": { - "tags": ["Projects"], - "summary": "Get Project", - "description": "Get a project by ID.", - "operationId": "get_project_api_v1_projects__project_id__get", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Project" - } - } - } + "204": { + "description": "Successful Response" }, "422": { "description": "Validation Error", @@ -2195,7 +2558,13 @@ } } } - }, + } + }, + "get": { + "tags": ["Projects"], + "summary": "Get Project", + "description": "Get a project by ID.", + "operationId": "get_project_api_v1_projects__project_id__get", "security": [ { "HTTPBearer": [] @@ -2203,44 +2572,35 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Projects"], - "summary": "Update Existing Project", - "description": "Update an existing project.", - "operationId": "update_existing_project_api_v1_projects__project_id__put", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProjectUpdate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", @@ -2262,7 +2622,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Projects"], + "summary": "Update Existing Project", + "description": "Update an existing project.", + "operationId": "update_existing_project_api_v1_projects__project_id__put", "security": [ { "HTTPBearer": [] @@ -2270,37 +2636,55 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Projects"], - "summary": "Delete Project", - "description": "Delete a project by ID.", - "operationId": "delete_project_api_v1_projects__project_id__delete", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProjectUpdate" + } + } + } + }, "responses": { - "204": { - "description": "Successful Response" + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + } + } }, "422": { "description": "Validation Error", @@ -2312,7 +2696,15 @@ } } } - }, + } + } + }, + "/api/v1/projects/{project_id}/eval/dataset": { + "post": { + "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", "security": [ { "HTTPBearer": [] @@ -2320,47 +2712,52 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/projects/{project_id}/eval/dataset": { - "get": { - "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", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvalDatasetCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/EvalDataset" - }, - "type": "array", - "title": "Response List Datasets For Project Api V1 Projects Project Id Eval Dataset Get" + "$ref": "#/components/schemas/EvalDataset" } } } @@ -2375,7 +2772,13 @@ } } } - }, + } + }, + "get": { + "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", "security": [ { "HTTPBearer": [] @@ -2383,51 +2786,46 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "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", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvalDatasetCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EvalDataset" + "type": "array", + "items": { + "$ref": "#/components/schemas/EvalDataset" + }, + "title": "Response List Datasets For Project Api V1 Projects Project Id Eval Dataset Get" } } } @@ -2442,15 +2840,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects/{project_id}/localevalset": { @@ -2459,36 +2849,51 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocalEvalSetCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -2496,10 +2901,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/LocalEvalResults" }, - "type": "array", "title": "Response Create Local Eval Set For Project Api V1 Projects Project Id Localevalset Post" } } @@ -2515,15 +2920,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects/{project_id}/localeval": { @@ -2532,25 +2929,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -2559,10 +2971,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/LocalEvalResults" }, - "type": "array", "title": "Response List Local Evals For Project Api V1 Projects Project Id Localeval Get" } } @@ -2578,15 +2990,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects/{project_id}/localevalsets": { @@ -2595,25 +2999,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -2622,10 +3041,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/LocalEvalSets" }, - "type": "array", "title": "Response List Local Eval Sets For Project Api V1 Projects Project Id Localevalsets Get" } } @@ -2641,15 +3060,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects/{project_id}/localevalset/{local_eval_set_id}": { @@ -2658,35 +3069,50 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "local_eval_set_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Local Eval Set Id" - }, - "name": "local_eval_set_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -2708,7 +3134,15 @@ } } } - }, + } + } + }, + "/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": [] @@ -2716,47 +3150,52 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/projects/{project_id}/prompts": { - "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", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromptMixinPrompts" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/PromptMixinPrompts" - }, - "type": "array", - "title": "Response List Promptmixin Prompts Api V1 Projects Project Id Prompts Get" + "$ref": "#/components/schemas/PromptMixinPrompts" } } } @@ -2771,7 +3210,13 @@ } } } - }, + } + }, + "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": [] @@ -2779,51 +3224,46 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromptMixinPrompts" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromptMixinPrompts" + "type": "array", + "items": { + "$ref": "#/components/schemas/PromptMixinPrompts" + }, + "title": "Response List Promptmixin Prompts Api V1 Projects Project Id Prompts Get" } } } @@ -2838,15 +3278,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/projects/{project_id}/prompts/{prompt_set_id}": { @@ -2855,46 +3287,61 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "prompt_set_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Set Id" - }, - "name": "prompt_set_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromptMixinPrompts" } } - }, - "required": true + } }, "responses": { "200": { @@ -2917,7 +3364,13 @@ } } } - }, + } + }, + "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": [] @@ -2925,42 +3378,43 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "project_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Project Id" - }, - "name": "project_id", - "in": "path" + } }, { + "name": "prompt_set_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Prompt Set Id" - }, - "name": "prompt_set_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -2982,15 +3436,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files/{id}": { @@ -2999,35 +3445,57 @@ "summary": "Get File", "description": "Read File metadata objects.", "operationId": "get_file_api_v1_files__id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" - }, - "name": "id", - "in": "path" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3051,7 +3519,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Files"], + "summary": "Delete File", + "description": "Delete the file from S3.", + "operationId": "delete_file_api_v1_files__id__delete", "security": [ { "HTTPBearer": [] @@ -3059,42 +3533,50 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Files"], - "summary": "Delete File", - "description": "Delete the file from S3.", - "operationId": "delete_file_api_v1_files__id__delete", + ], "parameters": [ { + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" - }, - "name": "id", - "in": "path" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3111,15 +3593,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files": { @@ -3128,25 +3602,47 @@ "summary": "List Files", "description": "Read File metadata objects.", "operationId": "list_files_api_v1_files_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3155,10 +3651,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/File" }, - "type": "array", "title": "Response List Files Api V1 Files Get" } } @@ -3174,7 +3670,13 @@ } } } - }, + } + }, + "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": [] @@ -3182,43 +3684,51 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Files"], - "summary": "Generate Presigned Url", - "description": "Create a presigned url for uploading a file.", - "operationId": "generate_presigned_url_api_v1_files_put", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -3241,7 +3751,13 @@ } } } - }, + } + }, + "post": { + "tags": ["Files"], + "summary": "Upload File", + "description": "Upload a file to S3.", + "operationId": "upload_file_api_v1_files_post", "security": [ { "HTTPBearer": [] @@ -3249,43 +3765,51 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Files"], - "summary": "Upload File", - "description": "Upload a file to S3.", - "operationId": "upload_file_api_v1_files_post", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_file_api_v1_files_post" } } - }, - "required": true + } }, "responses": { "200": { @@ -3308,15 +3832,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files/sync": { @@ -3325,25 +3841,47 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3352,10 +3890,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/File" }, - "type": "array", "title": "Response Sync Files Api V1 Files Sync Put" } } @@ -3371,15 +3909,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files/{id}/content": { @@ -3388,35 +3918,57 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" - }, - "name": "id", - "in": "path" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3440,15 +3992,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files/{id}/page_screenshots": { @@ -3457,35 +4001,57 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" - }, - "name": "id", - "in": "path" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3494,10 +4060,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PageScreenshotMetadata" }, - "type": "array", "title": "Response List File Page Screenshots Api V1 Files Id Page Screenshots Get" } } @@ -3513,15 +4079,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/files/{id}/page_screenshots/{page_index}": { @@ -3530,44 +4088,66 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" - }, - "name": "id", - "in": "path" + } }, { + "name": "page_index", + "in": "path", "required": true, "schema": { "type": "integer", "title": "Page Index" - }, - "name": "page_index", - "in": "path" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3589,15 +4169,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines": { @@ -3606,51 +4178,95 @@ "summary": "Search Pipelines", "description": "Search for pipelines by various parameters.", "operationId": "search_pipelines_api_v1_pipelines_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "project_name", + "in": "query", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Project Name" - }, - "name": "project_name", - "in": "query" + } }, { + "name": "pipeline_name", + "in": "query", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Pipeline Name" - }, - "name": "pipeline_name", - "in": "query" + } }, { + "name": "pipeline_type", + "in": "query", "required": false, "schema": { - "$ref": "#/components/schemas/PipelineType" - }, - "name": "pipeline_type", - "in": "query" + "anyOf": [ + { + "$ref": "#/components/schemas/PipelineType" + }, + { + "type": "null" + } + ], + "title": "Pipeline Type" + } }, { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3659,10 +4275,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" }, - "type": "array", "title": "Response Search Pipelines Api V1 Pipelines Get" } } @@ -3678,7 +4294,13 @@ } } } - }, + } + }, + "post": { + "tags": ["Pipelines"], + "summary": "Create Pipeline", + "description": "Create a new pipeline for a project.", + "operationId": "create_pipeline_api_v1_pipelines_post", "security": [ { "HTTPBearer": [] @@ -3686,43 +4308,51 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -3745,7 +4375,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Pipelines"], + "summary": "Upsert Pipeline", + "description": "Upsert a pipeline for a project.\nUpdates if a pipeline with the same name and project_id already exists. Otherwise, creates a new pipeline.", + "operationId": "upsert_pipeline_api_v1_pipelines_put", "security": [ { "HTTPBearer": [] @@ -3753,43 +4389,51 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Pipelines"], - "summary": "Create Pipeline", - "description": "Create a new pipeline for a project.", - "operationId": "create_pipeline_api_v1_pipelines_post", + ], "parameters": [ { + "name": "project_id", + "in": "query", "required": false, "schema": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id" - }, - "name": "project_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -3812,15 +4456,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}": { @@ -3829,25 +4465,40 @@ "summary": "Get Pipeline", "description": "Get a pipeline by ID for a given project.", "operationId": "get_pipeline_api_v1_pipelines__pipeline_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3871,7 +4522,13 @@ } } } - }, + } + }, + "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", "security": [ { "HTTPBearer": [] @@ -3879,43 +4536,44 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -3938,7 +4596,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Pipelines"], + "summary": "Delete Pipeline", + "description": "Delete a pipeline by ID.", + "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete", "security": [ { "HTTPBearer": [] @@ -3946,32 +4610,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Pipelines"], - "summary": "Delete Pipeline", - "description": "Delete a pipeline by ID.", - "operationId": "delete_pipeline_api_v1_pipelines__pipeline_id__delete", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -3988,15 +4653,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/status": { @@ -4005,25 +4662,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4047,15 +4719,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/sync": { @@ -4064,25 +4728,40 @@ "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, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4106,15 +4785,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/copy": { @@ -4123,25 +4794,40 @@ "summary": "Copy Pipeline", "description": "Copy a pipeline by ID.", "operationId": "copy_pipeline_api_v1_pipelines__pipeline_id__copy_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4165,7 +4851,15 @@ } } } - }, + } + } + }, + "/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", "security": [ { "HTTPBearer": [] @@ -4173,57 +4867,62 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "eval_dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Eval Dataset Id" - }, - "name": "eval_dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvalExecutionCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/EvalDatasetJobRecord" - }, - "type": "array", - "title": "Response Get Eval Dataset Executions Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Get" + "$ref": "#/components/schemas/EvalDatasetJobRecord" } } } @@ -4238,7 +4937,13 @@ } } } - }, + } + }, + "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", "security": [ { "HTTPBearer": [] @@ -4246,61 +4951,56 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "eval_dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Eval Dataset Id" - }, - "name": "eval_dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvalExecutionCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EvalDatasetJobRecord" + "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" } } } @@ -4315,15 +5015,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/result": { @@ -4332,35 +5024,50 @@ "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, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "eval_dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Eval Dataset Id" - }, - "name": "eval_dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4369,10 +5076,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/EvalQuestionResult" }, - "type": "array", "title": "Response Get Eval Dataset Execution Result Api V1 Pipelines Pipeline Id Eval Datasets Eval Dataset Id Execute Result Get" } } @@ -4388,15 +5095,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/eval-datasets/{eval_dataset_id}/execute/{eval_dataset_execution_id}": { @@ -4405,45 +5104,60 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "eval_dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Eval Dataset Id" - }, - "name": "eval_dataset_id", - "in": "path" + } }, { + "name": "eval_dataset_execution_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Eval Dataset Execution Id" - }, - "name": "eval_dataset_execution_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4467,15 +5181,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/files": { @@ -4484,45 +5190,67 @@ "summary": "List Pipeline Files", "description": "Get files for a pipeline.", "operationId": "list_pipeline_files_api_v1_pipelines__pipeline_id__files_get", - "parameters": [ + "security": [ { - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + "HTTPBearer": [] }, { - "required": false, + "HTTPBearer": [] + } + ], + "parameters": [ + { + "name": "pipeline_id", + "in": "path", + "required": true, "schema": { "type": "string", "format": "uuid", - "title": "Data Source Id" - }, + "title": "Pipeline Id" + } + }, + { "name": "data_source_id", - "in": "query" + "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", - "title": "Only Manually Uploaded", - "default": false - }, - "name": "only_manually_uploaded", - "in": "query" + "default": false, + "title": "Only Manually Uploaded" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4531,10 +5259,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineFile" }, - "type": "array", "title": "Response List Pipeline Files Api V1 Pipelines Pipeline Id Files Get" } } @@ -4550,7 +5278,13 @@ } } } - }, + } + }, + "put": { + "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", "security": [ { "HTTPBearer": [] @@ -4558,47 +5292,48 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineFileCreate" }, - "type": "array", "title": "Pipeline File Creates" } } - }, - "required": true + } }, "responses": { "200": { @@ -4606,10 +5341,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineFile" }, - "type": "array", "title": "Response Add Files To Pipeline Api V1 Pipelines Pipeline Id Files Put" } } @@ -4625,15 +5360,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/files/{file_id}/status": { @@ -4642,35 +5369,50 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "file_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" - }, - "name": "file_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4694,15 +5436,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/files/{file_id}": { @@ -4711,46 +5445,61 @@ "summary": "Update Pipeline File", "description": "Update a file for a pipeline.", "operationId": "update_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__put", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "file_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" - }, - "name": "file_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineFileUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -4773,7 +5522,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Pipelines"], + "summary": "Delete Pipeline File", + "description": "Delete a file from a pipeline.", + "operationId": "delete_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__delete", "security": [ { "HTTPBearer": [] @@ -4781,42 +5536,43 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Pipelines"], - "summary": "Delete Pipeline File", - "description": "Delete a file from a pipeline.", - "operationId": "delete_pipeline_file_api_v1_pipelines__pipeline_id__files__file_id__delete", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "file_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "File Id" - }, - "name": "file_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4833,15 +5589,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/metadata": { @@ -4850,36 +5598,51 @@ "summary": "Import Pipeline Metadata", "description": "Import metadata for a pipeline.", "operationId": "import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_import_pipeline_metadata_api_v1_pipelines__pipeline_id__metadata_put" } } - }, - "required": true + } }, "responses": { "200": { @@ -4887,10 +5650,10 @@ "content": { "application/json": { "schema": { + "type": "object", "additionalProperties": { "type": "string" }, - "type": "object", "title": "Response Import Pipeline Metadata Api V1 Pipelines Pipeline Id Metadata Put" } } @@ -4906,7 +5669,13 @@ } } } - }, + } + }, + "delete": { + "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", "security": [ { "HTTPBearer": [] @@ -4914,32 +5683,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -4956,15 +5726,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/data-sources": { @@ -4973,25 +5735,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5000,10 +5777,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineDataSource" }, - "type": "array", "title": "Response List Pipeline Data Sources Api V1 Pipelines Pipeline Id Data Sources Get" } } @@ -5019,7 +5796,13 @@ } } } - }, + } + }, + "put": { + "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", "security": [ { "HTTPBearer": [] @@ -5027,47 +5810,48 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineDataSourceCreate" }, - "type": "array", "title": "Pipeline Data Source Creates" } } - }, - "required": true + } }, "responses": { "200": { @@ -5075,10 +5859,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineDataSource" }, - "type": "array", "title": "Response Add Data Sources To Pipeline Api V1 Pipelines Pipeline Id Data Sources Put" } } @@ -5094,15 +5878,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}": { @@ -5111,46 +5887,61 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineDataSourceUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -5173,7 +5964,13 @@ } } } - }, + } + }, + "delete": { + "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", "security": [ { "HTTPBearer": [] @@ -5181,42 +5978,43 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5233,15 +6031,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/sync": { @@ -5250,35 +6040,50 @@ "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", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5302,15 +6107,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/data-sources/{data_source_id}/status": { @@ -5319,35 +6116,50 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "data_source_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Source Id" - }, - "name": "data_source_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5371,15 +6183,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/retrieve": { @@ -5388,36 +6192,51 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalParams" } } - }, - "required": true + } }, "responses": { "200": { @@ -5440,15 +6259,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/jobs": { @@ -5457,25 +6268,40 @@ "summary": "List Pipeline Jobs", "description": "Get jobs for a pipeline.", "operationId": "list_pipeline_jobs_api_v1_pipelines__pipeline_id__jobs_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5484,10 +6310,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/PipelineDeployment" }, - "type": "array", "title": "Response List Pipeline Jobs Api V1 Pipelines Pipeline Id Jobs Get" } } @@ -5503,15 +6329,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/jobs/{job_id}": { @@ -5520,35 +6338,50 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5572,15 +6405,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/playground-session": { @@ -5589,25 +6414,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -5631,15 +6471,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/chat": { @@ -5648,36 +6480,51 @@ "summary": "Chat", "description": "Make a retrieval query + chat completion for a managed pipeline.", "operationId": "chat_api_v1_pipelines__pipeline_id__chat_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatInputParams" } } - }, - "required": true + } }, "responses": { "200": { @@ -5698,7 +6545,15 @@ } } } - }, + } + } + }, + "/api/v1/pipelines/{pipeline_id}/documents": { + "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": [] @@ -5706,89 +6561,60 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/pipelines/{pipeline_id}/documents": { - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" - }, - { - "required": false, - "schema": { - "type": "integer", - "minimum": 0.0, - "title": "Skip", - "default": 0 - }, - "name": "skip", - "in": "query" - }, - { - "required": false, - "schema": { - "type": "integer", - "minimum": 0.0, - "title": "Limit", - "default": 10 - }, - "name": "limit", - "in": "query" - }, - { - "required": false, - "schema": { - "type": "string", - "format": "uuid", - "title": "File Id" - }, - "name": "file_id", - "in": "query" - }, - { - "required": false, - "schema": { - "type": "boolean", - "title": "Only Direct Upload", - "default": false - }, - "name": "only_direct_upload", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CloudDocumentCreate" + }, + "title": "Documents" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/CloudDocument" }, - "type": "array", - "title": "Response List Pipeline Documents Api V1 Pipelines Pipeline Id Documents Get" + "title": "Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post" } } } @@ -5803,7 +6629,13 @@ } } } - }, + } + }, + "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": [] @@ -5811,59 +6643,102 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "skip", + "in": "query", "required": false, "schema": { - "type": "string", - "title": "Session" - }, - "name": "session", - "in": "cookie" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/CloudDocumentCreate" - }, - "type": "array", - "title": "Documents" - } + "type": "integer", + "minimum": 0, + "default": 0, + "title": "Skip" } }, - "required": true - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/CloudDocument" - }, + { + "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", + "format": "uuid" + }, + { + "type": "null" + } + ], + "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" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": { "type": "array", - "title": "Response Upsert Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Put" + "items": { + "$ref": "#/components/schemas/CloudDocument" + }, + "title": "Response List Pipeline Documents Api V1 Pipelines Pipeline Id Documents Get" } } } @@ -5878,7 +6753,13 @@ } } } - }, + } + }, + "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": [] @@ -5886,47 +6767,48 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/CloudDocumentCreate" }, - "type": "array", "title": "Documents" } } - }, - "required": true + } }, "responses": { "200": { @@ -5934,11 +6816,11 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/CloudDocument" }, - "type": "array", - "title": "Response Create Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Post" + "title": "Response Upsert Batch Pipeline Documents Api V1 Pipelines Pipeline Id Documents Put" } } } @@ -5953,15 +6835,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/documents/{document_id}": { @@ -5970,34 +6844,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "document_id", + "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" - }, - "name": "document_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6021,7 +6910,13 @@ } } } - }, + } + }, + "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": [] @@ -6029,41 +6924,42 @@ { "HTTPBearer": [] } - ] - }, - "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", + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "document_id", + "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" - }, - "name": "document_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6080,15 +6976,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/status": { @@ -6097,34 +6985,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "document_id", + "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" - }, - "name": "document_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6148,15 +7051,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/pipelines/{pipeline_id}/documents/{document_id}/chunks": { @@ -6165,34 +7060,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "pipeline_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Pipeline Id" - }, - "name": "pipeline_id", - "in": "path" + } }, { + "name": "document_id", + "in": "path", "required": true, "schema": { "type": "string", "title": "Document Id" - }, - "name": "document_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6201,10 +7111,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/TextNode" }, - "type": "array", "title": "Response List Pipeline Document Chunks Api V1 Pipelines Pipeline Id Documents Document Id Chunks Get" } } @@ -6220,15 +7130,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/evals/datasets/{dataset_id}": { @@ -6237,25 +7139,40 @@ "summary": "Get Dataset", "description": "Get a dataset by ID.", "operationId": "get_dataset_api_v1_evals_datasets__dataset_id__get", - "parameters": [ + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], + "parameters": [ { - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Dataset Id" - }, "name": "dataset_id", - "in": "path" + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Dataset Id" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6279,7 +7196,13 @@ } } } - }, + } + }, + "put": { + "tags": ["Evals"], + "summary": "Update Dataset", + "description": "Update a dataset.", + "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put", "security": [ { "HTTPBearer": [] @@ -6287,43 +7210,44 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Evals"], - "summary": "Update Dataset", - "description": "Update a dataset.", - "operationId": "update_dataset_api_v1_evals_datasets__dataset_id__put", + ], "parameters": [ { + "name": "dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Dataset Id" - }, - "name": "dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvalDatasetUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -6346,7 +7270,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Evals"], + "summary": "Delete Dataset", + "description": "Delete a dataset.", + "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete", "security": [ { "HTTPBearer": [] @@ -6354,32 +7284,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Evals"], - "summary": "Delete Dataset", - "description": "Delete a dataset.", - "operationId": "delete_dataset_api_v1_evals_datasets__dataset_id__delete", + ], "parameters": [ { + "name": "dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Dataset Id" - }, - "name": "dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6396,7 +7327,15 @@ } } } - }, + } + } + }, + "/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": [] @@ -6404,47 +7343,52 @@ { "HTTPBearer": [] } - ] - } - }, - "/api/v1/evals/datasets/{dataset_id}/question": { - "get": { - "tags": ["Evals"], - "summary": "List Questions", - "description": "List questions for a dataset.", - "operationId": "list_questions_api_v1_evals_datasets__dataset_id__question_get", + ], "parameters": [ { + "name": "dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Dataset Id" - }, - "name": "dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EvalQuestionCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/EvalQuestion" - }, - "type": "array", - "title": "Response List Questions Api V1 Evals Datasets Dataset Id Question Get" + "$ref": "#/components/schemas/EvalQuestion" } } } @@ -6459,7 +7403,13 @@ } } } - }, + } + }, + "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": [] @@ -6467,51 +7417,46 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Evals"], - "summary": "Create Question", - "description": "Create a new question.", - "operationId": "create_question_api_v1_evals_datasets__dataset_id__question_post", + ], "parameters": [ { + "name": "dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Dataset Id" - }, - "name": "dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EvalQuestionCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EvalQuestion" + "type": "array", + "items": { + "$ref": "#/components/schemas/EvalQuestion" + }, + "title": "Response List Questions Api V1 Evals Datasets Dataset Id Question Get" } } } @@ -6526,15 +7471,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/evals/datasets/{dataset_id}/questions": { @@ -6543,40 +7480,55 @@ "summary": "Create Questions", "description": "Create a new question.", "operationId": "create_questions_api_v1_evals_datasets__dataset_id__questions_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "dataset_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Dataset Id" - }, - "name": "dataset_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/EvalQuestionCreate" }, - "type": "array", "title": "Payload" } } - }, - "required": true + } }, "responses": { "200": { @@ -6584,10 +7536,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/EvalQuestion" }, - "type": "array", "title": "Response Create Questions Api V1 Evals Datasets Dataset Id Questions Post" } } @@ -6603,15 +7555,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/evals/questions/{question_id}": { @@ -6620,25 +7564,40 @@ "summary": "Get Question", "description": "Get a question by ID.", "operationId": "get_question_api_v1_evals_questions__question_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "question_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Question Id" - }, - "name": "question_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6662,51 +7621,58 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } }, "put": { "tags": ["Evals"], "summary": "Replace Question", "description": "Replace a question.", "operationId": "replace_question_api_v1_evals_questions__question_id__put", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "question_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Question Id" - }, - "name": "question_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvalQuestionCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -6729,7 +7695,13 @@ } } } - }, + } + }, + "delete": { + "tags": ["Evals"], + "summary": "Delete Question", + "description": "Delete a question.", + "operationId": "delete_question_api_v1_evals_questions__question_id__delete", "security": [ { "HTTPBearer": [] @@ -6737,32 +7709,33 @@ { "HTTPBearer": [] } - ] - }, - "delete": { - "tags": ["Evals"], - "summary": "Delete Question", - "description": "Delete a question.", - "operationId": "delete_question_api_v1_evals_questions__question_id__delete", + ], "parameters": [ { + "name": "question_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Question Id" - }, - "name": "question_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6779,15 +7752,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/evals/models": { @@ -6796,15 +7761,30 @@ "summary": "List Supported Models", "description": "List supported models.", "operationId": "list_supported_models_api_v1_evals_models_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6813,10 +7793,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/SupportedLLMModel" }, - "type": "array", "title": "Response List Supported Models Api V1 Evals Models Get" } } @@ -6832,15 +7812,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/image/{name}": { @@ -6849,34 +7821,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "name", + "in": "path", "required": true, "schema": { "type": "string", "title": "Name" - }, - "name": "name", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -6896,15 +7883,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/supported_file_extensions": { @@ -6922,7 +7901,8 @@ "items": { "$ref": "#/components/schemas/LlamaParseSupportedFileExtensions" }, - "type": "array" + "type": "array", + "title": "Response Get Supported File Extensions Api V1 Parsing Supported File Extensions Get" } } } @@ -6936,15 +7916,30 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { @@ -6977,15 +7972,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/usage": { @@ -6994,15 +7981,30 @@ "summary": "Usage", "description": "Get parsing usage for user", "operationId": "usage_api_v1_parsing_usage_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7026,15 +8028,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}": { @@ -7043,25 +8037,40 @@ "summary": "Get Job", "description": "Get a job by id", "operationId": "get_job_api_v1_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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7085,15 +8094,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/details": { @@ -7102,25 +8103,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7144,15 +8160,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/text": { @@ -7161,25 +8169,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7203,15 +8226,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/raw/text": { @@ -7220,25 +8235,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7260,15 +8290,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/markdown": { @@ -7277,25 +8299,40 @@ "summary": "Get Job Result", "description": "Get a job by id", "operationId": "get_job_result_api_v1_parsing_job__job_id__result_markdown_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7319,15 +8356,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/raw/markdown": { @@ -7336,25 +8365,40 @@ "summary": "Get Job Raw Md Result", "description": "Get a job by id", "operationId": "get_job_raw_md_result_api_v1_parsing_job__job_id__result_raw_markdown_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7376,15 +8420,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/json": { @@ -7393,25 +8429,40 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7435,15 +8486,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/result/raw/json": { @@ -7452,25 +8495,40 @@ "summary": "Get Job Json Raw Result", "description": "Get a job by id", "operationId": "get_job_json_raw_result_api_v1_parsing_job__job_id__result_raw_json_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7492,15 +8550,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/history": { @@ -7509,15 +8559,30 @@ "summary": "Get Parsing History Result", "description": "Get parsing history for user", "operationId": "get_parsing_history_result_api_v1_parsing_history_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7526,10 +8591,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/ParsingHistoryItem" }, - "type": "array", "title": "Response Get Parsing History Result Api V1 Parsing History Get" } } @@ -7545,15 +8610,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/parsing/job/{job_id}/read/{filename}": { @@ -7562,34 +8619,49 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "job_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Job Id" - }, - "name": "job_id", - "in": "path" + } }, { + "name": "filename", + "in": "path", "required": true, "schema": { "type": "string", "title": "Filename" - }, - "name": "filename", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -7613,15 +8685,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/component-definition/configurable-transformations": { @@ -7702,26 +8766,41 @@ "summary": "Create Checkout Session", "description": "Create a new checkout session.", "operationId": "create_checkout_session_api_v1_billing_checkout_session_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutSessionCreatePayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -7745,15 +8824,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/billing/customer-portal-session": { @@ -7762,26 +8833,41 @@ "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": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPortalSessionCreatePayload" } } - }, - "required": true + } }, "responses": { "200": { @@ -7805,15 +8891,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/billing/webhook": { @@ -7824,13 +8902,13 @@ "operationId": "stripe_webhook_api_v1_billing_webhook_post", "parameters": [ { + "name": "stripe-signature", + "in": "header", "required": false, "schema": { "type": "string", "title": "Stripe-Signature" - }, - "name": "stripe-signature", - "in": "header" + } } ], "responses": { @@ -7856,42 +8934,53 @@ } }, "/api/v1/extraction/schemas": { - "get": { + "post": { "tags": ["Extraction"], - "summary": "List Schemas", - "operationId": "list_schemas_api_v1_extraction_schemas_get", - "parameters": [ + "summary": "Create Schema", + "operationId": "create_schema_api_v1_extraction_schemas_post", + "security": [ { - "required": false, - "schema": { - "type": "string", - "format": "uuid", - "title": "Project Id" - }, - "name": "project_id", - "in": "query" + "HTTPBearer": [] }, { + "HTTPBearer": [] + } + ], + "parameters": [ + { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExtractionSchemaCreate" + } + } + } + }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ExtractionSchema" - }, - "type": "array", - "title": "Response List Schemas Api V1 Extraction Schemas Get" + "$ref": "#/components/schemas/ExtractionSchema" } } } @@ -7906,7 +8995,12 @@ } } } - }, + } + }, + "get": { + "tags": ["Extraction"], + "summary": "List Schemas", + "operationId": "list_schemas_api_v1_extraction_schemas_get", "security": [ { "HTTPBearer": [] @@ -7914,40 +9008,53 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Extraction"], - "summary": "Create Schema", - "operationId": "create_schema_api_v1_extraction_schemas_post", + ], "parameters": [ { + "name": "project_id", + "in": "query", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Project Id" + } + }, + { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtractionSchemaCreate" - } - } - }, - "required": true - }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExtractionSchema" + "type": "array", + "items": { + "$ref": "#/components/schemas/ExtractionSchema" + }, + "title": "Response List Schemas Api V1 Extraction Schemas Get" } } } @@ -7962,15 +9069,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/schemas/infer": { @@ -7978,26 +9077,41 @@ "tags": ["Extraction"], "summary": "Infer Schema", "operationId": "infer_schema_api_v1_extraction_schemas_infer_post", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionSchemaInfer" } } - }, - "required": true + } }, "responses": { "200": { @@ -8020,15 +9134,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/schemas/{schema_id}": { @@ -8036,25 +9142,40 @@ "tags": ["Extraction"], "summary": "Get Schema", "operationId": "get_schema_api_v1_extraction_schemas__schema_id__get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "schema_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Schema Id" - }, - "name": "schema_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8078,7 +9199,12 @@ } } } - }, + } + }, + "put": { + "tags": ["Extraction"], + "summary": "Update Schema", + "operationId": "update_schema_api_v1_extraction_schemas__schema_id__put", "security": [ { "HTTPBearer": [] @@ -8086,42 +9212,44 @@ { "HTTPBearer": [] } - ] - }, - "put": { - "tags": ["Extraction"], - "summary": "Update Schema", - "operationId": "update_schema_api_v1_extraction_schemas__schema_id__put", + ], "parameters": [ { + "name": "schema_id", + "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Schema Id" - }, - "name": "schema_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionSchemaUpdate" } } - }, - "required": true + } }, "responses": { "200": { @@ -8144,15 +9272,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/jobs": { @@ -8160,25 +9280,40 @@ "tags": ["Extraction"], "summary": "List Jobs", "operationId": "list_jobs_api_v1_extraction_jobs_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "schema_id", + "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Schema Id" - }, - "name": "schema_id", - "in": "query" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8187,10 +9322,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/ExtractionJob" }, - "type": "array", "title": "Response List Jobs Api V1 Extraction Jobs Get" } } @@ -8206,7 +9341,12 @@ } } } - }, + } + }, + "post": { + "tags": ["Extraction"], + "summary": "Run Job", + "operationId": "run_job_api_v1_extraction_jobs_post", "security": [ { "HTTPBearer": [] @@ -8214,32 +9354,34 @@ { "HTTPBearer": [] } - ] - }, - "post": { - "tags": ["Extraction"], - "summary": "Run Job", - "operationId": "run_job_api_v1_extraction_jobs_post", + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionJobCreate" } } - }, - "required": true + } }, "responses": { "200": { @@ -8262,15 +9404,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/jobs/{job_id}": { @@ -8278,25 +9412,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8320,15 +9469,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/jobs/batch": { @@ -8336,26 +9477,41 @@ "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": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionJobCreateBatch" } } - }, - "required": true + } }, "responses": { "200": { @@ -8363,10 +9519,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/ExtractionJob" }, - "type": "array", "title": "Response Run Jobs In Batch Api V1 Extraction Jobs Batch Post" } } @@ -8382,15 +9538,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/v1/extraction/jobs/{job_id}/result": { @@ -8398,25 +9546,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8440,15 +9603,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/image/{name}": { @@ -8457,34 +9612,49 @@ "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": "job_id", - "in": "path" + } }, { + "name": "name", + "in": "path", "required": true, "schema": { "type": "string", "title": "Name" - }, - "name": "name", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8504,15 +9674,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/supported_file_extensions": { @@ -8530,7 +9692,8 @@ "items": { "$ref": "#/components/schemas/LlamaParseSupportedFileExtensions" }, - "type": "array" + "type": "array", + "title": "Response Get Supported File Extensions Api Parsing Supported File Extensions Get" } } } @@ -8544,15 +9707,30 @@ "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": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "requestBody": { @@ -8585,15 +9763,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/usage": { @@ -8602,15 +9772,30 @@ "summary": "Usage", "description": "Get parsing usage for user", "operationId": "usage_api_parsing_usage_get", + "security": [ + { + "HTTPBearer": [] + }, + { + "HTTPBearer": [] + } + ], "parameters": [ { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8634,15 +9819,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}": { @@ -8651,25 +9828,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8693,15 +9885,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/details": { @@ -8710,25 +9894,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8752,15 +9951,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/text": { @@ -8769,25 +9960,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8811,15 +10017,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/raw/text": { @@ -8828,25 +10026,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8868,15 +10081,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/markdown": { @@ -8885,25 +10090,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8927,15 +10147,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/raw/markdown": { @@ -8944,25 +10156,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -8984,15 +10211,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/json": { @@ -9001,25 +10220,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -9043,15 +10277,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/result/raw/json": { @@ -9060,25 +10286,40 @@ "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": "job_id", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -9100,15 +10341,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/history": { @@ -9117,15 +10350,30 @@ "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": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -9134,10 +10382,10 @@ "content": { "application/json": { "schema": { + "type": "array", "items": { "$ref": "#/components/schemas/ParsingHistoryItem" }, - "type": "array", "title": "Response Get Parsing History Result Api Parsing History Get" } } @@ -9153,15 +10401,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } }, "/api/parsing/job/{job_id}/read/{filename}": { @@ -9170,34 +10410,49 @@ "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": "job_id", - "in": "path" + } }, { + "name": "filename", + "in": "path", "required": true, "schema": { "type": "string", "title": "Filename" - }, - "name": "filename", - "in": "path" + } }, { + "name": "session", + "in": "cookie", "required": false, "schema": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Session" - }, - "name": "session", - "in": "cookie" + } } ], "responses": { @@ -9221,15 +10476,7 @@ } } } - }, - "security": [ - { - "HTTPBearer": [] - }, - { - "HTTPBearer": [] - } - ] + } } } }, @@ -9244,21 +10491,42 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, "name": { - "type": "string", - "maxLength": 3000, - "minLength": 0, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 0 + }, + { + "type": "null" + } + ], "title": "Name" }, "user_id": { @@ -9278,9 +10546,16 @@ "APIKeyCreate": { "properties": { "name": { - "type": "string", - "maxLength": 3000, - "minLength": 0, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 0 + }, + { + "type": "null" + } + ], "title": "Name" } }, @@ -9291,9 +10566,16 @@ "APIKeyUpdate": { "properties": { "name": { - "type": "string", - "maxLength": 3000, - "minLength": 0, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 0 + }, + { + "type": "null" + } + ], "title": "Name" } }, @@ -9306,6 +10588,7 @@ "mode": { "type": "string", "enum": ["advanced"], + "const": "advanced", "title": "Mode", "default": "advanced" }, @@ -9354,6 +10637,7 @@ "mode": { "type": "string", "enum": ["auto"], + "const": "auto", "title": "Mode", "default": "auto" }, @@ -9385,19 +10669,24 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, @@ -9438,10 +10727,17 @@ "gte": 0 }, "default_headers": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Default Headers", "description": "The default headers for API requests." }, @@ -9452,20 +10748,53 @@ "default": true }, "dimensions": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Dimensions", "description": "The number of dimensions on the output embedding vectors. Works only with v3 embedding models." }, "azure_endpoint": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Azure Endpoint", "description": "The Azure endpoint to use." }, "azure_deployment": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Azure Deployment", "description": "The Azure deployment to use." }, + "azure_ad_token_provider": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Azure Ad Token Provider", + "description": "Callback function to provide Azure AD token." + }, "use_azure_ad": { "type": "boolean", "title": "Use Azure Ad", @@ -9479,25 +10808,20 @@ }, "type": "object", "required": ["api_key", "use_azure_ad"], - "title": "AzureOpenAIEmbedding", - "description": "OpenAI class for embeddings.\n\nArgs:\n mode (str): Mode for embedding.\n Defaults to OpenAIEmbeddingMode.TEXT_SEARCH_MODE.\n Options are:\n\n - OpenAIEmbeddingMode.SIMILARITY_MODE\n - OpenAIEmbeddingMode.TEXT_SEARCH_MODE\n\n model (str): Model for embedding.\n Defaults to OpenAIEmbeddingModelType.TEXT_EMBED_ADA_002.\n Options are:\n\n - OpenAIEmbeddingModelType.DAVINCI\n - OpenAIEmbeddingModelType.CURIE\n - OpenAIEmbeddingModelType.BABBAGE\n - OpenAIEmbeddingModelType.ADA\n - OpenAIEmbeddingModelType.TEXT_EMBED_ADA_002" + "title": "AzureOpenAIEmbedding" }, "AzureOpenAIEmbeddingConfig": { "properties": { "type": { "type": "string", "enum": ["AZURE_EMBEDDING"], + "const": "AZURE_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "AZURE_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/AzureOpenAIEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/AzureOpenAIEmbedding", "description": "Configuration for the Azure OpenAI embedding model." } }, @@ -9546,20 +10870,45 @@ "title": "Kwargs" }, "output_parser": { - "type": "object", - "title": "Output Parser", - "default": {} + "anyOf": [ + {}, + { + "type": "null" + } + ], + "title": "Output Parser" }, "template_var_mappings": { - "type": "object", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Template Var Mappings", "description": "Template variable mappings (Optional)." + }, + "function_mappings": { + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Function Mappings", + "description": "Function mappings (Optional). This is a mapping from template variable names to functions that take in the current kwargs and return a string." } }, "type": "object", - "required": ["metadata", "template_vars", "kwargs"], - "title": "BasePromptTemplate", - "description": "Chainable mixin.\n\nA module that can produce a `QueryComponent` from a set of inputs through\n`as_query_component`.\n\nIf plugged in directly into a `QueryPipeline`, the `ChainableMixin` will be\nconverted into a `QueryComponent` with default parameters." + "required": ["metadata", "template_vars", "kwargs", "output_parser"], + "title": "BasePromptTemplate" }, "BedrockEmbedding": { "properties": { @@ -9570,55 +10919,107 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, "profile_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Profile Name", "description": "The name of aws profile to use. If not given, then the default profile is used." }, "aws_access_key_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Aws Access Key Id", "description": "AWS Access Key ID to use" }, "aws_secret_access_key": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Aws Secret Access Key", "description": "AWS Secret Access Key to use" }, "aws_session_token": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Aws Session Token", "description": "AWS Session Token to use" }, "region_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Region Name", "description": "AWS region name to use. Uses region configured in AWS CLI if not passed" }, "botocore_session": { + "anyOf": [ + {}, + { + "type": "null" + } + ], "title": "Botocore Session", "description": "Use this Botocore session instead of creating a new default one." }, "botocore_config": { - "title": "Botocore Config", - "description": "Custom configuration object to use instead of the default generated one." - }, + "anyOf": [ + {}, + { + "type": "null" + } + ], + "title": "Botocore Config", + "description": "Custom configuration object to use instead of the default generated one." + }, "max_retries": { "type": "integer", "exclusiveMinimum": 0.0, @@ -9645,25 +11046,20 @@ }, "type": "object", "required": ["model_name"], - "title": "BedrockEmbedding", - "description": "Base class for embeddings." + "title": "BedrockEmbedding" }, "BedrockEmbeddingConfig": { "properties": { "type": { "type": "string", "enum": ["BEDROCK_EMBEDDING"], + "const": "BEDROCK_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "BEDROCK_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/BedrockEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/BedrockEmbedding", "description": "Configuration for the Bedrock embedding model." } }, @@ -9689,6 +11085,7 @@ "$ref": "#/components/schemas/ParserLanguages" }, "type": "array", + "title": "Language", "default": ["en"] }, "parsing_instruction": { @@ -9721,6 +11118,11 @@ "title": "Fast Mode", "default": false }, + "premium_mode": { + "type": "boolean", + "title": "Premium Mode", + "default": false + }, "gpt4o_api_key": { "type": "string", "title": "Gpt4O Api Key", @@ -9800,8 +11202,15 @@ "default": "" }, "file": { - "type": "string", - "format": "binary", + "anyOf": [ + { + "type": "string", + "format": "binary" + }, + { + "type": "null" + } + ], "title": "File" } }, @@ -9827,6 +11236,7 @@ "$ref": "#/components/schemas/ParserLanguages" }, "type": "array", + "title": "Language", "default": ["en"] }, "parsing_instruction": { @@ -9859,6 +11269,11 @@ "title": "Fast Mode", "default": false }, + "premium_mode": { + "type": "boolean", + "title": "Premium Mode", + "default": false + }, "gpt4o_api_key": { "type": "string", "title": "Gpt4O Api Key", @@ -9938,8 +11353,15 @@ "default": "" }, "file": { - "type": "string", - "format": "binary", + "anyOf": [ + { + "type": "string", + "format": "binary" + }, + { + "type": "null" + } + ], "title": "File" } }, @@ -9949,8 +11371,7 @@ "BoxAuthMechanism": { "type": "string", "enum": ["developer_token", "ccg"], - "title": "BoxAuthMechanism", - "description": "An enumeration." + "title": "BoxAuthMechanism" }, "CharacterChunkingConfig": { "properties": { @@ -9969,6 +11390,7 @@ "mode": { "type": "string", "enum": ["character"], + "const": "character", "title": "Mode", "default": "character" } @@ -9991,9 +11413,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "chunk_size": { "type": "integer", @@ -10004,10 +11436,10 @@ }, "chunk_overlap": { "type": "integer", + "minimum": 0.0, "title": "Chunk Overlap", "description": "The token overlap of each chunk when splitting.", - "default": 200, - "gte": 0 + "default": 200 }, "separator": { "type": "string", @@ -10022,7 +11454,14 @@ "default": "\n\n\n" }, "secondary_chunking_regex": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Secondary Chunking Regex", "description": "Backup regex for splitting into sentences.", "default": "[^,.;。？！]+[,.;。？！]?" @@ -10043,7 +11482,14 @@ "$ref": "#/components/schemas/PresetRetrievalParams" }, "llm_parameters": { - "$ref": "#/components/schemas/LLMParameters" + "anyOf": [ + { + "$ref": "#/components/schemas/LLMParameters" + }, + { + "type": "null" + } + ] }, "class_name": { "type": "string", @@ -10052,8 +11498,7 @@ } }, "type": "object", - "title": "ChatData", - "description": "Base schema model for BaseComponent classes used in the platform.\nComes with special serialization logic for types used commonly in platform codebase." + "title": "ChatData" }, "ChatInputParams": { "properties": { @@ -10074,8 +11519,7 @@ } }, "type": "object", - "title": "ChatInputParams", - "description": "Base schema model for BaseComponent classes used in the platform.\nComes with special serialization logic for types used commonly in platform codebase." + "title": "ChatInputParams" }, "ChatMessage": { "properties": { @@ -10101,7 +11545,14 @@ "$ref": "#/components/schemas/MessageRole" }, "content": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Content", "description": "Text content of the generation" }, @@ -10121,21 +11572,18 @@ }, "type": "object", "required": ["id", "index", "role"], - "title": "ChatMessage", - "description": "Base schema model for BaseComponent classes used in the platform.\nComes with special serialization logic for types used commonly in platform codebase." + "title": "ChatMessage" }, "CheckoutSessionCreatePayload": { "properties": { "success_url": { "type": "string", - "maxLength": 65536, "minLength": 1, "format": "uri", "title": "Success Url" }, "cancel_url": { "type": "string", - "maxLength": 65536, "minLength": 1, "format": "uri", "title": "Cancel Url" @@ -10158,37 +11606,86 @@ "description": "The Azure Storage Blob account URL to use for authentication." }, "blob": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Blob", "description": "The blob name to read from." }, "prefix": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Prefix", "description": "The prefix of the Azure Storage Blob objects to read from." }, "account_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Account Name", "description": "The Azure Storage Blob account name to use for authentication." }, "account_key": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Account Key", "description": "The Azure Storage Blob account key to use for authentication." }, "tenant_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Tenant Id", "description": "The Azure AD tenant ID to use for authentication." }, "client_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Id", "description": "The Azure AD client ID to use for authentication." }, "client_secret": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Secret", "description": "The Azure AD client secret to use for authentication." }, @@ -10200,13 +11697,13 @@ }, "type": "object", "required": ["container_name", "account_url"], - "title": "CloudAzStorageBlobDataSource", - "description": "Base component object to capture class names." + "title": "CloudAzStorageBlobDataSource" }, "CloudAzureAISearchVectorStore": { "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [true], "const": true, "title": "Supports Nested Metadata Filters", "default": true @@ -10220,31 +11717,80 @@ "title": "Search Service Endpoint" }, "search_service_api_version": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Search Service Api Version" }, "index_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Index Name" }, "filterable_metadata_field_keys": { - "type": "object", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Filterable Metadata Field Keys" }, "embedding_dimension": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Embedding Dimension" }, "client_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Id" }, "client_secret": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Secret" }, "tenant_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Tenant Id" }, "class_name": { @@ -10261,40 +11807,78 @@ "CloudBoxDataSource": { "properties": { "folder_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Folder Id", "description": "The ID of the Box folder to read from." }, "authentication_mechanism": { - "allOf": [ - { - "$ref": "#/components/schemas/BoxAuthMechanism" - } - ], + "$ref": "#/components/schemas/BoxAuthMechanism", "description": "The type of authentication to use (Developer Token or CCG)" }, "developer_token": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Developer Token", "description": "Developer token for authentication if authentication_mechanism is 'developer_token'." }, "client_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Id", "description": "Box API key used for identifying the application the user is authenticating with" }, "client_secret": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Secret", "description": "Box API secret used for making auth requests." }, "user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Id", "description": "Box User ID, if provided authenticates as user." }, "enterprise_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Enterprise Id", "description": "Box Enterprise ID, if provided authenticates as service." }, @@ -10306,42 +11890,77 @@ }, "type": "object", "required": ["authentication_mechanism"], - "title": "CloudBoxDataSource", - "description": "Base component object to capture class names." + "title": "CloudBoxDataSource" }, "CloudChromaVectorStore": { "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [false], "const": false, "title": "Supports Nested Metadata Filters", "default": false }, "collection_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Collection Name" }, "host": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Host" }, "port": { - "type": "string", - "title": "Port" - }, - "ssl": { - "type": "boolean", - "title": "Ssl" - }, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Port" + }, + "ssl": { + "type": "boolean", + "title": "Ssl" + }, "headers": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Headers" }, "persist_dir": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Persist Dir" }, "collection_kwargs": { @@ -10356,8 +11975,7 @@ }, "type": "object", "required": ["ssl"], - "title": "CloudChromaVectorStore", - "description": "Base class for cloud vector stores." + "title": "CloudChromaVectorStore" }, "CloudConfluenceDataSource": { "properties": { @@ -10372,32 +11990,74 @@ "description": "Type of Authentication for connecting to Confluence APIs." }, "user_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Name", "description": "The username to use for authentication." }, "api_token": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Api Token", "description": "The API token to use for authentication." }, "space_key": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Space Key", "description": "The space key to read from." }, "page_ids": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Page Ids", "description": "The page IDs of the Confluence to read from." }, "cql": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cql", "description": "The CQL query to use for fetching pages." }, "label": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Label", "description": "The label to use for fetching pages." }, @@ -10409,8 +12069,7 @@ }, "type": "object", "required": ["server_url", "authentication_mechanism"], - "title": "CloudConfluenceDataSource", - "description": "Base component object to capture class names." + "title": "CloudConfluenceDataSource" }, "CloudDocument": { "properties": { @@ -10439,10 +12098,17 @@ "default": [] }, "page_positions": { - "items": { - "type": "integer" - }, - "type": "array", + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Page Positions", "description": "indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1]." }, @@ -10483,15 +12149,29 @@ "default": [] }, "page_positions": { - "items": { - "type": "integer" - }, - "type": "array", + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Page Positions", "description": "indices in the CloudDocument.text where a new page begins. e.g. Second page starts at index specified by page_positions[1]." }, "id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Id" } }, @@ -10520,28 +12200,55 @@ }, "type": "object", "required": ["folder_id", "service_account_key"], - "title": "CloudGoogleDriveDataSource", - "description": "Base component object to capture class names." + "title": "CloudGoogleDriveDataSource" }, "CloudJiraDataSource": { "properties": { "email": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Email", "description": "The email address to use for authentication." }, "api_token": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Api Token", "description": "The API/ Access Token used for Basic, PAT and OAuth2 authentication." }, "server_url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Server Url", "description": "The server url for Jira Cloud." }, "cloud_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cloud Id", "description": "The cloud ID, used in case of OAuth2." }, @@ -10570,6 +12277,7 @@ "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [false], "const": false, "title": "Supports Nested Metadata Filters", "default": false @@ -10579,15 +12287,36 @@ "title": "Uri" }, "collection_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Collection Name" }, "token": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Token" }, "embedding_dimension": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Embedding Dimension" }, "class_name": { @@ -10605,6 +12334,7 @@ "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [false], "const": false, "title": "Supports Nested Metadata Filters", "default": false @@ -10622,11 +12352,25 @@ "title": "Collection Name" }, "vector_index_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Vector Index Name" }, "fulltext_index_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Fulltext Index Name" }, "class_name": { @@ -10648,12 +12392,26 @@ "description": "The integration token to use for authentication." }, "database_ids": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Database Ids", "description": "The Notion Database Id to read content from." }, "page_ids": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Page Ids", "description": "The Page ID's of the Notion to read from." }, @@ -10665,8 +12423,7 @@ }, "type": "object", "required": ["integration_token"], - "title": "CloudNotionPageDataSource", - "description": "Base component object to capture class names." + "title": "CloudNotionPageDataSource" }, "CloudOneDriveDataSource": { "properties": { @@ -10676,12 +12433,26 @@ "description": "The user principal name to use for authentication." }, "folder_path": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Folder Path", "description": "The path of the OneDrive folder to read from." }, "folder_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Folder Id", "description": "The ID of the OneDrive folder to read from." }, @@ -10713,13 +12484,13 @@ "client_secret", "tenant_id" ], - "title": "CloudOneDriveDataSource", - "description": "Base component object to capture class names." + "title": "CloudOneDriveDataSource" }, "CloudPineconeVectorStore": { "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [true], "const": true, "title": "Supports Nested Metadata Filters", "default": true @@ -10733,11 +12504,25 @@ "title": "Index Name" }, "namespace": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Namespace" }, "insert_kwargs": { - "type": "object", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Insert Kwargs" }, "class_name": { @@ -10755,6 +12540,7 @@ "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [false], "const": false, "title": "Supports Nested Metadata Filters", "default": false @@ -10792,7 +12578,14 @@ "title": "Embed Dim" }, "hybrid_search": { - "type": "boolean", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Hybrid Search", "default": true }, @@ -10813,13 +12606,13 @@ "schema_name", "embed_dim" ], - "title": "CloudPostgresVectorStore", - "description": "Base class for cloud vector stores." + "title": "CloudPostgresVectorStore" }, "CloudQdrantVectorStore": { "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [true], "const": true, "title": "Supports Nested Metadata Filters", "default": true @@ -10864,22 +12657,50 @@ "description": "The name of the S3 bucket to read from." }, "prefix": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Prefix", "description": "The prefix of the S3 objects to read from." }, "aws_access_id": { - "type": "string", - "title": "Aws Access Id", - "description": "The AWS access ID to use for authentication." - }, + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Aws Access Id", + "description": "The AWS access ID to use for authentication." + }, "aws_access_secret": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Aws Access Secret", "description": "The AWS access secret to use for authentication." }, "s3_endpoint_url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "S3 Endpoint Url", "description": "The S3 endpoint URL to use for authentication." }, @@ -10891,33 +12712,67 @@ }, "type": "object", "required": ["bucket"], - "title": "CloudS3DataSource", - "description": "Base component object to capture class names." + "title": "CloudS3DataSource" }, "CloudSharepointDataSource": { "properties": { "site_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Site Name", "description": "The name of the SharePoint site to download from." }, "site_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Site Id", "description": "The ID of the SharePoint site to download from." }, "folder_path": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Folder Path", "description": "The path of the Sharepoint folder to read from." }, "folder_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Folder Id", "description": "The ID of the Sharepoint folder to read from." }, "drive_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Drive Name", "description": "The name of the Sharepoint drive to read from." }, @@ -10944,8 +12799,7 @@ }, "type": "object", "required": ["client_id", "client_secret", "tenant_id"], - "title": "CloudSharepointDataSource", - "description": "Base component object to capture class names." + "title": "CloudSharepointDataSource" }, "CloudSlackDataSource": { "properties": { @@ -10955,32 +12809,74 @@ "description": "Slack Bot Token." }, "channel_ids": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Channel Ids", "description": "Slack Channel." }, "latest_date": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Latest Date", "description": "Latest date." }, "earliest_date": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Earliest Date", "description": "Earliest date." }, "earliest_date_timestamp": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Earliest Date Timestamp", "description": "Earliest date timestamp." }, "latest_date_timestamp": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Latest Date Timestamp", "description": "Latest date timestamp." }, "channel_patterns": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Channel Patterns", "description": "Slack Channel name pattern." }, @@ -10992,13 +12888,13 @@ }, "type": "object", "required": ["slack_token"], - "title": "CloudSlackDataSource", - "description": "Base component object to capture class names." + "title": "CloudSlackDataSource" }, "CloudWeaviateVectorStore": { "properties": { "supports_nested_metadata_filters": { "type": "boolean", + "enum": [false], "const": false, "title": "Supports Nested Metadata Filters", "default": false @@ -11008,7 +12904,14 @@ "title": "Index Name" }, "url": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Url" }, "text_key": { @@ -11031,8 +12934,7 @@ }, "type": "object", "required": ["index_name", "text_key"], - "title": "CloudWeaviateVectorStore", - "description": "Base class for cloud vector stores." + "title": "CloudWeaviateVectorStore" }, "CodeSplitter": { "properties": { @@ -11049,9 +12951,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "language": { "type": "string", @@ -11100,19 +13012,24 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, @@ -11127,7 +13044,14 @@ "description": "Truncation type - START/ END/ NONE" }, "input_type": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Input Type", "description": "Model Input type. If not provided, search_document and search_query are used when needed." }, @@ -11152,17 +13076,13 @@ "type": { "type": "string", "enum": ["COHERE_EMBEDDING"], + "const": "COHERE_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "COHERE_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/CohereEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/CohereEmbedding", "description": "Configuration for the Cohere embedding model." } }, @@ -11181,8 +13101,7 @@ "MONGODB_ATLAS", "MILVUS" ], - "title": "ConfigurableDataSinkNames", - "description": "An enumeration." + "title": "ConfigurableDataSinkNames" }, "ConfigurableDataSourceNames": { "type": "string", @@ -11198,8 +13117,7 @@ "JIRA", "BOX" ], - "title": "ConfigurableDataSourceNames", - "description": "An enumeration." + "title": "ConfigurableDataSourceNames" }, "ConfigurableTransformationDefinition": { "properties": { @@ -11214,19 +13132,11 @@ "description": "The json_schema field can be used by clients to determine how to construct the component" }, "configurable_transformation_type": { - "allOf": [ - { - "$ref": "#/components/schemas/ConfigurableTransformationNames" - } - ], + "$ref": "#/components/schemas/ConfigurableTransformationNames", "description": "The name field will act as the unique identifier of TransformationDefinition objects" }, "transformation_category": { - "allOf": [ - { - "$ref": "#/components/schemas/TransformationCategoryNames" - } - ], + "$ref": "#/components/schemas/TransformationCategoryNames", "description": "The transformation_category field will be used to group transformations in the UI" } }, @@ -11258,8 +13168,7 @@ "GEMINI_EMBEDDING", "VERTEXAI_EMBEDDING" ], - "title": "ConfigurableTransformationNames", - "description": "An enumeration." + "title": "ConfigurableTransformationNames" }, "ConfiguredTransformationItem": { "properties": { @@ -11269,11 +13178,7 @@ "title": "Id" }, "configurable_transformation_type": { - "allOf": [ - { - "$ref": "#/components/schemas/ConfigurableTransformationNames" - } - ], + "$ref": "#/components/schemas/ConfigurableTransformationNames", "description": "Name for the type of transformation this is (e.g. SIMPLE_NODE_PARSER). Can also be an enum instance of llama_index.ingestion.transformations.ConfigurableTransformations. This will be converted to ConfigurableTransformationNames." }, "component": { @@ -11282,50 +13187,46 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CharacterSplitter" - }, - { - "$ref": "#/components/schemas/PageSplitterNodeParser" - }, - { - "$ref": "#/components/schemas/CodeSplitter" - }, - { - "$ref": "#/components/schemas/SentenceSplitter" - }, - { - "$ref": "#/components/schemas/TokenTextSplitter" - }, - { - "$ref": "#/components/schemas/MarkdownNodeParser" - }, - { - "$ref": "#/components/schemas/MarkdownElementNodeParser" - }, - { - "$ref": "#/components/schemas/OpenAIEmbedding" - }, - { - "$ref": "#/components/schemas/AzureOpenAIEmbedding" - }, - { - "$ref": "#/components/schemas/CohereEmbedding" - }, - { - "$ref": "#/components/schemas/BedrockEmbedding" - }, - { - "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbedding" - }, - { - "$ref": "#/components/schemas/GeminiEmbedding" - }, - { - "$ref": "#/components/schemas/ExtendVertexTextEmbedding" - } - ] + "$ref": "#/components/schemas/CharacterSplitter" + }, + { + "$ref": "#/components/schemas/PageSplitterNodeParser" + }, + { + "$ref": "#/components/schemas/CodeSplitter" + }, + { + "$ref": "#/components/schemas/SentenceSplitter" + }, + { + "$ref": "#/components/schemas/TokenTextSplitter" + }, + { + "$ref": "#/components/schemas/MarkdownNodeParser" + }, + { + "$ref": "#/components/schemas/MarkdownElementNodeParser" + }, + { + "$ref": "#/components/schemas/OpenAIEmbedding" + }, + { + "$ref": "#/components/schemas/AzureOpenAIEmbedding" + }, + { + "$ref": "#/components/schemas/CohereEmbedding" + }, + { + "$ref": "#/components/schemas/BedrockEmbedding" + }, + { + "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbedding" + }, + { + "$ref": "#/components/schemas/GeminiEmbedding" + }, + { + "$ref": "#/components/schemas/ExtendVertexTextEmbedding" } ], "title": "Component", @@ -11341,7 +13242,6 @@ "properties": { "return_url": { "type": "string", - "maxLength": 65536, "minLength": 1, "format": "uri", "title": "Return Url" @@ -11360,14 +13260,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -11385,32 +13299,28 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudChromaVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPineconeVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPostgresVectorStore" - }, - { - "$ref": "#/components/schemas/CloudQdrantVectorStore" - }, - { - "$ref": "#/components/schemas/CloudWeaviateVectorStore" - }, - { - "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" - }, - { - "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" - }, - { - "$ref": "#/components/schemas/CloudMilvusVectorStore" - } - ] + "$ref": "#/components/schemas/CloudChromaVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPineconeVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPostgresVectorStore" + }, + { + "$ref": "#/components/schemas/CloudQdrantVectorStore" + }, + { + "$ref": "#/components/schemas/CloudWeaviateVectorStore" + }, + { + "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" + }, + { + "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" + }, + { + "$ref": "#/components/schemas/CloudMilvusVectorStore" } ], "title": "Component" @@ -11442,32 +13352,28 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudChromaVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPineconeVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPostgresVectorStore" - }, - { - "$ref": "#/components/schemas/CloudQdrantVectorStore" - }, - { - "$ref": "#/components/schemas/CloudWeaviateVectorStore" - }, - { - "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" - }, - { - "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" - }, - { - "$ref": "#/components/schemas/CloudMilvusVectorStore" - } - ] + "$ref": "#/components/schemas/CloudChromaVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPineconeVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPostgresVectorStore" + }, + { + "$ref": "#/components/schemas/CloudQdrantVectorStore" + }, + { + "$ref": "#/components/schemas/CloudWeaviateVectorStore" + }, + { + "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" + }, + { + "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" + }, + { + "$ref": "#/components/schemas/CloudMilvusVectorStore" } ], "title": "Component" @@ -11491,11 +13397,7 @@ "description": "The json_schema field can be used by clients to determine how to construct the component" }, "sink_type": { - "allOf": [ - { - "$ref": "#/components/schemas/ConfigurableDataSinkNames" - } - ], + "$ref": "#/components/schemas/ConfigurableDataSinkNames", "description": "The name field will act as the unique identifier of DataSinkDefinition objects" } }, @@ -11507,7 +13409,14 @@ "DataSinkUpdate": { "properties": { "name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "The name of the data sink." }, @@ -11520,32 +13429,31 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudChromaVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPineconeVectorStore" - }, - { - "$ref": "#/components/schemas/CloudPostgresVectorStore" - }, - { - "$ref": "#/components/schemas/CloudQdrantVectorStore" - }, - { - "$ref": "#/components/schemas/CloudWeaviateVectorStore" - }, - { - "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" - }, - { - "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" - }, - { - "$ref": "#/components/schemas/CloudMilvusVectorStore" - } - ] + "$ref": "#/components/schemas/CloudChromaVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPineconeVectorStore" + }, + { + "$ref": "#/components/schemas/CloudPostgresVectorStore" + }, + { + "$ref": "#/components/schemas/CloudQdrantVectorStore" + }, + { + "$ref": "#/components/schemas/CloudWeaviateVectorStore" + }, + { + "$ref": "#/components/schemas/CloudAzureAISearchVectorStore" + }, + { + "$ref": "#/components/schemas/CloudMongoDBAtlasVectorSearch" + }, + { + "$ref": "#/components/schemas/CloudMilvusVectorStore" + }, + { + "type": "null" } ], "title": "Component" @@ -11565,14 +13473,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -11585,30 +13507,40 @@ "$ref": "#/components/schemas/ConfigurableDataSourceNames" }, "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata that will be present on all data loaded from the data source" }, @@ -11618,38 +13550,34 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudS3DataSource" - }, - { - "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" - }, - { - "$ref": "#/components/schemas/CloudGoogleDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudOneDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudSharepointDataSource" - }, - { - "$ref": "#/components/schemas/CloudSlackDataSource" - }, - { - "$ref": "#/components/schemas/CloudNotionPageDataSource" - }, - { - "$ref": "#/components/schemas/CloudConfluenceDataSource" - }, - { - "$ref": "#/components/schemas/CloudJiraDataSource" - }, - { - "$ref": "#/components/schemas/CloudBoxDataSource" - } - ] + "$ref": "#/components/schemas/CloudS3DataSource" + }, + { + "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" + }, + { + "$ref": "#/components/schemas/CloudGoogleDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudOneDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudSharepointDataSource" + }, + { + "$ref": "#/components/schemas/CloudSlackDataSource" + }, + { + "$ref": "#/components/schemas/CloudNotionPageDataSource" + }, + { + "$ref": "#/components/schemas/CloudConfluenceDataSource" + }, + { + "$ref": "#/components/schemas/CloudJiraDataSource" + }, + { + "$ref": "#/components/schemas/CloudBoxDataSource" } ], "title": "Component" @@ -11676,30 +13604,40 @@ "$ref": "#/components/schemas/ConfigurableDataSourceNames" }, "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata that will be present on all data loaded from the data source" }, @@ -11709,38 +13647,34 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudS3DataSource" - }, - { - "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" - }, - { - "$ref": "#/components/schemas/CloudGoogleDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudOneDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudSharepointDataSource" - }, - { - "$ref": "#/components/schemas/CloudSlackDataSource" - }, - { - "$ref": "#/components/schemas/CloudNotionPageDataSource" - }, - { - "$ref": "#/components/schemas/CloudConfluenceDataSource" - }, - { - "$ref": "#/components/schemas/CloudJiraDataSource" - }, - { - "$ref": "#/components/schemas/CloudBoxDataSource" - } - ] + "$ref": "#/components/schemas/CloudS3DataSource" + }, + { + "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" + }, + { + "$ref": "#/components/schemas/CloudGoogleDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudOneDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudSharepointDataSource" + }, + { + "$ref": "#/components/schemas/CloudSlackDataSource" + }, + { + "$ref": "#/components/schemas/CloudNotionPageDataSource" + }, + { + "$ref": "#/components/schemas/CloudConfluenceDataSource" + }, + { + "$ref": "#/components/schemas/CloudJiraDataSource" + }, + { + "$ref": "#/components/schemas/CloudBoxDataSource" } ], "title": "Component" @@ -11764,11 +13698,7 @@ "description": "The json_schema field can be used by clients to determine how to construct the component" }, "source_type": { - "allOf": [ - { - "$ref": "#/components/schemas/ConfigurableDataSourceNames" - } - ], + "$ref": "#/components/schemas/ConfigurableDataSourceNames", "description": "The name field will act as the unique identifier of DataSourceDefinition objects" } }, @@ -11780,7 +13710,14 @@ "DataSourceUpdate": { "properties": { "name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "The name of the data source." }, @@ -11788,30 +13725,40 @@ "$ref": "#/components/schemas/ConfigurableDataSourceNames" }, "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata that will be present on all data loaded from the data source" }, @@ -11821,38 +13768,37 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudS3DataSource" - }, - { - "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" - }, - { - "$ref": "#/components/schemas/CloudGoogleDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudOneDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudSharepointDataSource" - }, - { - "$ref": "#/components/schemas/CloudSlackDataSource" - }, - { - "$ref": "#/components/schemas/CloudNotionPageDataSource" - }, - { - "$ref": "#/components/schemas/CloudConfluenceDataSource" - }, - { - "$ref": "#/components/schemas/CloudJiraDataSource" - }, - { - "$ref": "#/components/schemas/CloudBoxDataSource" - } - ] + "$ref": "#/components/schemas/CloudS3DataSource" + }, + { + "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" + }, + { + "$ref": "#/components/schemas/CloudGoogleDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudOneDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudSharepointDataSource" + }, + { + "$ref": "#/components/schemas/CloudSlackDataSource" + }, + { + "$ref": "#/components/schemas/CloudNotionPageDataSource" + }, + { + "$ref": "#/components/schemas/CloudConfluenceDataSource" + }, + { + "$ref": "#/components/schemas/CloudJiraDataSource" + }, + { + "$ref": "#/components/schemas/CloudBoxDataSource" + }, + { + "type": "null" } ], "title": "Component" @@ -11882,6 +13828,7 @@ "mode": { "type": "string", "enum": ["element"], + "const": "element", "title": "Mode", "default": "element" } @@ -11898,14 +13845,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -11950,12 +13911,7 @@ "description": "The IDs for the EvalQuestions this execution ran against." }, "eval_execution_params": { - "allOf": [ - { - "$ref": "#/components/schemas/EvalExecutionParams" - } - ], - "title": "Eval Execution Params", + "$ref": "#/components/schemas/EvalExecutionParams", "description": "The parameters for the eval execution." } }, @@ -11969,6 +13925,7 @@ "job_name": { "type": "string", "enum": ["eval_dataset_job"], + "const": "eval_dataset_job", "title": "Job Name" }, "partitions": { @@ -11988,34 +13945,64 @@ "description": "The partitions for this execution. Used for determining where to save job output." }, "parameters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/EvalDatasetJobParams" + }, + { + "type": "null" } ], - "title": "Parameters", "description": "Additional input parameters for the eval execution." }, "session_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Session Id", "description": "The upstream request ID that created this job. Used for tracking the job across services." }, "correlation_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Correlation Id", "description": "The correlation ID for this job. Used for tracking the job across services." }, "parent_job_execution_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Parent Job Execution Id", "description": "The ID of the parent job execution." }, "user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Id", "description": "The ID of the user that created this job" }, @@ -12035,27 +14022,62 @@ "$ref": "#/components/schemas/StatusEnum" }, "error_code": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error Code" }, "error_message": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error Message" }, "attempts": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Attempts", "description": "The number of times this job has been attempted", "default": 0 }, "started_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Started At" }, "ended_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Ended At" }, "updated_at": { @@ -12065,12 +14087,14 @@ "description": "Update datetime" }, "data": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/Base" + }, + { + "type": "null" } ], - "title": "Data", "description": "Additional metadata for the job execution." } }, @@ -12103,12 +14127,7 @@ "title": "Eval Question Ids" }, "params": { - "allOf": [ - { - "$ref": "#/components/schemas/EvalExecutionParamsOverride" - } - ], - "title": "Params", + "$ref": "#/components/schemas/EvalExecutionParamsOverride", "description": "The parameters for the eval execution that will override the ones set in the pipeline." } }, @@ -12120,11 +14139,7 @@ "EvalExecutionParams": { "properties": { "llm_model": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportedLLMModelNames" - } - ], + "$ref": "#/components/schemas/SupportedLLMModelNames", "description": "The LLM model to use within eval execution.", "default": "GPT_4O" }, @@ -12142,15 +14157,25 @@ "EvalExecutionParamsOverride": { "properties": { "llm_model": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/SupportedLLMModelNames" + }, + { + "type": "null" } ], "description": "The LLM model to use within eval execution." }, "qa_prompt_tmpl": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Qa Prompt Tmpl", "description": "The template to use for the question answering prompt." } @@ -12159,6 +14184,11 @@ "title": "EvalExecutionParamsOverride", "description": "Schema for the params override for an eval execution." }, + "EvalMetric": { + "type": "string", + "enum": ["RELEVANCY", "FAITHFULNESS"], + "title": "EvalMetric" + }, "EvalQuestion": { "properties": { "id": { @@ -12168,14 +14198,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -12200,8 +14244,7 @@ }, "type": "object", "required": ["id", "content", "eval_dataset_id", "eval_dataset_index"], - "title": "EvalQuestion", - "description": "Base schema model containing common database fields." + "title": "EvalQuestion" }, "EvalQuestionCreate": { "properties": { @@ -12259,12 +14302,7 @@ "description": "The ID of the EvalDatasetJobRecord that this result was generated from." }, "eval_dataset_execution_params": { - "allOf": [ - { - "$ref": "#/components/schemas/EvalExecutionParams" - } - ], - "title": "Eval Dataset Execution Params", + "$ref": "#/components/schemas/EvalExecutionParams", "description": "The EvalExecutionParams that were used when this result was generated." }, "eval_finished_at": { @@ -12303,28 +14341,29 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, "embed_mode": { - "allOf": [ - { - "$ref": "#/components/schemas/VertexEmbeddingMode" - } - ], + "$ref": "#/components/schemas/VertexEmbeddingMode", "description": "The embedding mode to use." }, "additional_kwargs": { @@ -12333,22 +14372,50 @@ "description": "Additional kwargs for the Vertex." }, "client_email": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Client Email", "description": "The client email to use when making Vertex API calls." }, "token_uri": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Token Uri", "description": "The token uri to use when making Vertex API calls." }, "private_key_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Private Key Id", "description": "The private key id to use when making Vertex API calls." }, "private_key": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Private Key", "description": "The private key to use when making Vertex API calls." }, @@ -12369,9 +14436,16 @@ } }, "type": "object", - "required": ["embed_mode", "project", "location"], - "title": "ExtendVertexTextEmbedding", - "description": "Base class for embeddings." + "required": [ + "embed_mode", + "client_email", + "token_uri", + "private_key_id", + "private_key", + "project", + "location" + ], + "title": "ExtendVertexTextEmbedding" }, "ExtractionJob": { "properties": { @@ -12382,20 +14456,11 @@ "description": "The id of the extraction job" }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusEnum" - } - ], + "$ref": "#/components/schemas/StatusEnum", "description": "The status of the extraction job" }, "file": { - "allOf": [ - { - "$ref": "#/components/schemas/File" - } - ], - "title": "File", + "$ref": "#/components/schemas/File", "description": "The file that the extract was extracted from" } }, @@ -12456,14 +14521,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -12494,6 +14573,9 @@ }, { "type": "boolean" + }, + { + "type": "null" } ] }, @@ -12502,12 +14584,7 @@ "description": "The data extracted from the file" }, "file": { - "allOf": [ - { - "$ref": "#/components/schemas/File" - } - ], - "title": "File", + "$ref": "#/components/schemas/File", "description": "The file that the extract was extracted from" } }, @@ -12525,14 +14602,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -12548,30 +14639,40 @@ "description": "The ID of the project that the extraction schema belongs to" }, "data_schema": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Data Schema", "description": "The schema of the data" } @@ -12591,8 +14692,15 @@ "description": "The name of the extraction schema" }, "project_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id", "description": "The ID of the project that the extraction schema belongs to" }, @@ -12617,6 +14725,9 @@ }, { "type": "boolean" + }, + { + "type": "null" } ] }, @@ -12633,8 +14744,15 @@ "ExtractionSchemaInfer": { "properties": { "schema_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Schema Id", "description": "The ID of a schema to update with the new schema" }, @@ -12646,8 +14764,15 @@ "description": "The name of the extraction schema" }, "project_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Project Id", "description": "The ID of the project that the extraction schema belongs to" }, @@ -12676,30 +14801,40 @@ "ExtractionSchemaUpdate": { "properties": { "data_schema": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Data Schema", "description": "The schema of the data" } @@ -12717,14 +14852,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -12735,15 +14884,29 @@ "title": "Name" }, "file_size": { - "type": "integer", - "minimum": 0.0, + "anyOf": [ + { + "type": "integer", + "minimum": 0.0 + }, + { + "type": "null" + } + ], "title": "File Size", "description": "Size of the file in bytes" }, "file_type": { - "type": "string", - "maxLength": 3000, - "minLength": 1, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 1 + }, + { + "type": "null" + } + ], "title": "File Type", "description": "File type (e.g. pdf, docx, etc.)" }, @@ -12754,42 +14917,66 @@ "description": "The ID of the project that the file belongs to" }, "last_modified_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Last Modified At", "description": "The last modified time of the file" }, "resource_info": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Resource Info", "description": "Resource information for the file" }, "data_source_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Data Source Id", "description": "The ID of the data source that the file belongs to" } @@ -12808,52 +14995,83 @@ "title": "Name" }, "file_size": { - "type": "integer", - "minimum": 0.0, + "anyOf": [ + { + "type": "integer", + "minimum": 0.0 + }, + { + "type": "null" + } + ], "title": "File Size", "description": "Size of the file in bytes" }, "last_modified_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Last Modified At", "description": "The last modified time of the file" }, "resource_info": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Resource Info", "description": "Resource information for the file" }, "data_source_id": { - "type": "string", - "format": "uuid", - "title": "Data Source Id", - "description": "The ID of the data source that the file belongs to" - } - }, + "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" @@ -12894,36 +15112,62 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, "title": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Title", "description": "Title is only applicable for retrieval_document tasks, and is used to represent a document title. For other tasks, title is invalid.", "default": "" }, "task_type": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Task Type", "description": "The task for embedding model.", "default": "retrieval_document" }, "api_key": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Api Key", "description": "API key to access the model. Defaults to None." }, @@ -12942,17 +15186,13 @@ "type": { "type": "string", "enum": ["GEMINI_EMBEDDING"], + "const": "GEMINI_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "GEMINI_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/GeminiEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/GeminiEmbedding", "description": "Configuration for the Gemini embedding model." } }, @@ -12975,44 +15215,73 @@ "HuggingFaceInferenceAPIEmbedding": { "properties": { "model_name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Model Name", "description": "Hugging Face model name. If None, the task will be used." }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, "pooling": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/Pooling" + }, + { + "type": "null" } ], "description": "Pooling strategy. If None, the model's default pooling is used.", "default": "cls" }, "query_instruction": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Query Instruction", "description": "Instruction to prepend during query embedding." }, "text_instruction": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Text Instruction", "description": "Instruction to prepend during text embedding." }, @@ -13023,34 +15292,65 @@ }, { "type": "boolean" + }, + { + "type": "null" } ], "title": "Token", "description": "Hugging Face token. Will default to the locally saved token. Pass token=False if you don’t want to send your token to the server." }, "timeout": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Timeout", "description": "The maximum number of seconds to wait for a response from the server. Loading a new model in Inference API can take up to several minutes. Defaults to None, meaning it will loop until the server is available." }, "headers": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Headers", "description": "Additional headers to send to the server. By default only the authorization and user-agent headers are sent. Values in this dictionary will override the default values." }, "cookies": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Cookies", "description": "Additional cookies to send to the server." }, "task": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Task", "description": "Optional task to pick Hugging Face's recommended model, used when model_name is left as default of None." }, @@ -13069,17 +15369,13 @@ "type": { "type": "string", "enum": ["HUGGINGFACE_API_EMBEDDING"], + "const": "HUGGINGFACE_API_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "HUGGINGFACE_API_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbedding", "description": "Configuration for the HuggingFace Inference API embedding model." } }, @@ -13100,11 +15396,7 @@ "description": "List of errors that occurred during ingestion." }, "step": { - "allOf": [ - { - "$ref": "#/components/schemas/JobNameMapping" - } - ], + "$ref": "#/components/schemas/JobNameMapping", "description": "Name of the job that failed." } }, @@ -13117,7 +15409,7 @@ "id": { "type": "string", "title": "Id", - "description": "ID of the message, if any. Not necessarily a UUID." + "description": "ID of the message, if any. a UUID." }, "role": { "$ref": "#/components/schemas/MessageRole" @@ -13127,7 +15419,14 @@ "title": "Content" }, "data": { - "type": "object", + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Data", "description": "Additional data to be stored with the message." }, @@ -13138,7 +15437,7 @@ } }, "type": "object", - "required": ["role", "content"], + "required": ["id", "role", "content"], "title": "InputMessage", "description": "This is distinct from a ChatMessage because this schema is enforced by the AI Chat library used in the frontend" }, @@ -13159,42 +15458,54 @@ "LLM": { "properties": { "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "system_prompt": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "System Prompt", "description": "System prompt for LLM calls." }, - "output_parser": { - "type": "object", - "title": "Output Parser", - "description": "Output parser to parse, validate, and correct errors programmatically.", - "default": {} + "messages_to_prompt": { + "type": "string", + "title": "Messages To Prompt", + "description": "Function to convert a list of messages to an LLM prompt." }, - "pydantic_program_mode": { - "allOf": [ + "completion_to_prompt": { + "type": "string", + "title": "Completion To Prompt", + "description": "Function to convert a completion to an LLM prompt." + }, + "output_parser": { + "anyOf": [ + {}, { - "$ref": "#/components/schemas/PydanticProgramMode" + "type": "null" } ], + "title": "Output Parser", + "description": "Output parser to parse, validate, and correct errors programmatically." + }, + "pydantic_program_mode": { + "$ref": "#/components/schemas/PydanticProgramMode", "default": "default" }, "query_wrapper_prompt": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/BasePromptTemplate" + }, + { + "type": "null" } ], - "title": "Query Wrapper Prompt", "description": "Query wrapper prompt for LLM calls." - }, - "class_name": { - "type": "string", - "title": "Class Name", - "default": "base_component" } }, "type": "object", @@ -13227,21 +15538,31 @@ "LLMParameters": { "properties": { "model_name": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportedLLMModelNames" - } - ], + "$ref": "#/components/schemas/SupportedLLMModelNames", "description": "The name of the model to use for LLM completions.", "default": "GPT_3_5_TURBO" }, "system_prompt": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "System Prompt", "description": "The system prompt to use for the completion." }, "temperature": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Temperature", "description": "The temperature value for the model.", "default": 0.1 @@ -13253,8 +15574,7 @@ } }, "type": "object", - "title": "LLMParameters", - "description": "Base schema model for BaseComponent classes used in the platform.\nComes with special serialization logic for types used commonly in platform codebase." + "title": "LLMParameters" }, "LlamaParseParameters": { "properties": { @@ -13263,7 +15583,8 @@ "$ref": "#/components/schemas/ParserLanguages" }, "type": "array", - "minItems": 1 + "minItems": 1, + "title": "Languages" }, "parsing_instruction": { "type": "string", @@ -13316,7 +15637,14 @@ "default": false }, "page_separator": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Page Separator" }, "bounding_box": { @@ -13364,6 +15692,11 @@ "title": "Take Screenshot", "default": false }, + "premium_mode": { + "type": "boolean", + "title": "Premium Mode", + "default": false + }, "s3_input_path": { "type": "string", "title": "S3 Input Path", @@ -13458,46 +15791,94 @@ ".eth", ".tsv" ], - "title": "LlamaParseSupportedFileExtensions", - "description": "An enumeration." + "title": "LlamaParseSupportedFileExtensions" }, "LocalEval": { "properties": { "query": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Query", "description": "Query string" }, "contexts": { - "items": { - "type": "string" - }, - "type": "array", + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Contexts", "description": "Context strings" }, "response": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Response", "description": "Response string" }, "passing": { - "type": "boolean", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Passing", "description": "Binary evaluation result (passing or not)" }, "feedback": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Feedback", "description": "Feedback or reasoning for the response" }, "score": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Score", "description": "Score for the response" }, "pairwise_source": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Pairwise Source", "description": "Used only for pairwise and specifies whether it is from original order of presented answers or flipped order" }, @@ -13508,7 +15889,14 @@ "default": false }, "invalid_reason": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Invalid Reason", "description": "Reason for invalid evaluation." } @@ -13526,8 +15914,15 @@ "description": "The ID of the project." }, "eval_set_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Eval Set Id", "description": "The ID of the local eval result set." }, @@ -13542,12 +15937,7 @@ "description": "The name of the eval." }, "result": { - "allOf": [ - { - "$ref": "#/components/schemas/LocalEval" - } - ], - "title": "Result", + "$ref": "#/components/schemas/LocalEval", "description": "The eval results." } }, @@ -13619,30 +16009,47 @@ "ManagedIngestionStatusResponse": { "properties": { "job_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Job Id", "description": "ID of the latest job." }, "deployment_date": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Deployment Date", "description": "Date of the deployment." }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ManagedIngestionStatus" - } - ], + "$ref": "#/components/schemas/ManagedIngestionStatus", "description": "Status of the ingestion." }, "error": { - "items": { - "$ref": "#/components/schemas/IngestionErrorResponse" - }, - "type": "array", + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IngestionErrorResponse" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Error", "description": "List of errors that occurred during ingestion." } @@ -13666,17 +16073,29 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "llm": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/LLM" + }, + { + "type": "null" } ], - "title": "Llm", "description": "LLM model to use for summarization." }, "summary_query_str": { @@ -13698,12 +16117,14 @@ "default": true }, "nested_node_parser": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/NodeParser" + }, + { + "type": "null" } ], - "title": "Nested Node Parser", "description": "Other types of node parsers to handle some types of nodes." }, "class_name": { @@ -13731,9 +16152,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "class_name": { "type": "string", @@ -13753,7 +16184,8 @@ }, "data": { "type": "string", - "format": "json-string", + "contentMediaType": "application/json", + "contentSchema": {}, "title": "Data" }, "class_name": { @@ -13763,9 +16195,8 @@ } }, "type": "object", - "required": ["type"], - "title": "MessageAnnotation", - "description": "Base schema model for BaseComponent classes used in the platform.\nComes with special serialization logic for types used commonly in platform codebase." + "required": ["type", "data"], + "title": "MessageAnnotation" }, "MessageRole": { "type": "string", @@ -13815,21 +16246,20 @@ "type": "integer" }, "type": "array" + }, + { + "type": "null" } ], "title": "Value" }, "operator": { - "allOf": [ - { - "$ref": "#/components/schemas/FilterOperator" - } - ], + "$ref": "#/components/schemas/FilterOperator", "default": "==" } }, "type": "object", - "required": ["key"], + "required": ["key", "value"], "title": "MetadataFilter", "description": "Comprehensive metadata filter for vector stores to support more operators.\n\nValue uses Strict* types, as int, float and str are compatible types and were all\nconverted to string before.\n\nSee: https://docs.pydantic.dev/latest/usage/types/#strict-types" }, @@ -13850,9 +16280,12 @@ "title": "Filters" }, "condition": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/FilterCondition" + }, + { + "type": "null" } ], "default": "and" @@ -13866,17 +16299,38 @@ "MetricResult": { "properties": { "passing": { - "type": "boolean", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Passing", "description": "Whether the metric passed or not." }, "score": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Score", "description": "The score for the metric." }, "feedback": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Feedback", "description": "The reasoning for the metric." } @@ -13899,9 +16353,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "class_name": { "type": "string", @@ -13913,11 +16377,18 @@ "title": "NodeParser", "description": "Base interface for node parser." }, + "NodeRelationship": { + "type": "string", + "enum": ["1", "2", "3", "4", "5"], + "title": "NodeRelationship", + "description": "Node relationships used in `BaseNode` class.\n\nAttributes:\n SOURCE: The node is the source document.\n PREVIOUS: The node is the previous node in the document.\n NEXT: The node is the next node in the document.\n PARENT: The node is the parent node in the document.\n CHILD: The node is a child node in the document." + }, "NoneChunkingConfig": { "properties": { "mode": { "type": "string", "enum": ["none"], + "const": "none", "title": "Mode", "default": "none" } @@ -13930,6 +16401,7 @@ "mode": { "type": "string", "enum": ["none"], + "const": "none", "title": "Mode", "default": "none" } @@ -13940,8 +16412,7 @@ "ObjectType": { "type": "string", "enum": ["1", "2", "3", "4"], - "title": "ObjectType", - "description": "An enumeration." + "title": "ObjectType" }, "OpenAIEmbedding": { "properties": { @@ -13953,19 +16424,24 @@ }, "embed_batch_size": { "type": "integer", + "maximum": 2048.0, "exclusiveMinimum": 0.0, "title": "Embed Batch Size", "description": "The batch size for embedding calls.", - "default": 10, - "lte": 2048 + "default": 10 }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" }, "num_workers": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Num Workers", "description": "The number of workers to use for async embedding calls." }, @@ -13980,13 +16456,27 @@ "description": "The OpenAI API key." }, "api_base": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Api Base", "description": "The base URL for OpenAI API.", "default": "https://api.openai.com/v1" }, "api_version": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Api Version", "description": "The version for OpenAI API.", "default": "" @@ -14006,10 +16496,17 @@ "gte": 0 }, "default_headers": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Default Headers", "description": "The default headers for API requests." }, @@ -14020,7 +16517,14 @@ "default": true }, "dimensions": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Dimensions", "description": "The number of dimensions on the output embedding vectors. Works only with v3 embedding models." }, @@ -14040,17 +16544,13 @@ "type": { "type": "string", "enum": ["OPENAI_EMBEDDING"], + "const": "OPENAI_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "OPENAI_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/OpenAIEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/OpenAIEmbedding", "description": "Configuration for the OpenAI embedding model." } }, @@ -14066,14 +16566,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -14108,9 +16622,16 @@ "OrganizationUpdate": { "properties": { "name": { - "type": "string", - "maxLength": 3000, - "minLength": 1, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 1 + }, + { + "type": "null" + } + ], "title": "Name", "description": "A name for the organization." } @@ -14170,6 +16691,7 @@ "mode": { "type": "string", "enum": ["page"], + "const": "page", "title": "Mode", "default": "page" }, @@ -14197,12 +16719,29 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "page_separator": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Page Separator", "description": "Separator to split text into pages.", "default": "\n---\n" @@ -14338,15 +16877,36 @@ "default": false }, "pages": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Pages" }, "images": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Images" }, "time": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Time" } }, @@ -14371,11 +16931,25 @@ "$ref": "#/components/schemas/StatusEnum" }, "error_code": { - "type": "string", - "title": "Error Code" - }, - "error_message": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error Code" + }, + "error_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error Message" } }, @@ -14395,6 +16969,7 @@ } }, "type": "object", + "required": ["pages", "job_metadata"], "title": "ParsingJobJsonResult" }, "ParsingJobMarkdownResult": { @@ -14410,7 +16985,7 @@ } }, "type": "object", - "required": ["markdown"], + "required": ["markdown", "job_metadata"], "title": "ParsingJobMarkdownResult" }, "ParsingJobTextResult": { @@ -14426,7 +17001,7 @@ } }, "type": "object", - "required": ["text"], + "required": ["text", "job_metadata"], "title": "ParsingJobTextResult" }, "ParsingUsage": { @@ -14436,7 +17011,14 @@ "title": "Usage Pdf Pages" }, "max_pdf_pages": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Max Pdf Pages" } }, @@ -14444,6 +17026,20 @@ "required": ["usage_pdf_pages"], "title": "ParsingUsage" }, + "PartitionNames": { + "type": "string", + "enum": [ + "data_source_id_partition", + "pipeline_id_partition", + "eval_dataset_id_partition", + "file_id_partition", + "pipeline_file_id_partition", + "file_parsing_id_partition", + "extraction_schema_id_partition" + ], + "title": "PartitionNames", + "description": "Enum for dataset partition names." + }, "Pipeline": { "properties": { "id": { @@ -14453,14 +17049,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -14474,17 +17084,20 @@ "title": "Project Id" }, "pipeline_type": { - "allOf": [ - { - "$ref": "#/components/schemas/PipelineType" - } - ], + "$ref": "#/components/schemas/PipelineType", "description": "Type of pipeline. Either PLAYGROUND or MANAGED.", "default": "MANAGED" }, "managed_pipeline_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Managed Pipeline Id", "description": "The ID of the ManagedPipeline this playground pipeline is linked to." }, @@ -14517,12 +17130,12 @@ "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", - "BEDROCK_EMBEDDING": "#/components/schemas/BedrockEmbeddingConfig" + "VERTEXAI_EMBEDDING": "#/components/schemas/VertexAIEmbeddingConfig" } } }, @@ -14536,12 +17149,14 @@ "default": [] }, "config_hash": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/PipelineConfigurationHashes" + }, + { + "type": "null" } ], - "title": "Config Hash", "description": "Hashes for the configuration of the pipeline." }, "transform_config": { @@ -14557,39 +17172,33 @@ "description": "Configuration for the transformation." }, "preset_retrieval_parameters": { - "allOf": [ - { - "$ref": "#/components/schemas/PresetRetrievalParams" - } - ], - "title": "Preset Retrieval Parameters", + "$ref": "#/components/schemas/PresetRetrievalParams", "description": "Preset retrieval parameters for the pipeline." }, "eval_parameters": { - "allOf": [ - { - "$ref": "#/components/schemas/EvalExecutionParams" - } - ], - "title": "Eval Parameters", + "$ref": "#/components/schemas/EvalExecutionParams", "description": "Eval parameters for the pipeline." }, "llama_parse_parameters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/LlamaParseParameters" + }, + { + "type": "null" } ], - "title": "Llama Parse Parameters", "description": "Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline." }, "data_sink": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/DataSink" + }, + { + "type": "null" } ], - "title": "Data Sink", "description": "The data sink for the pipeline. If None, the pipeline will use the fully managed data sink." } }, @@ -14601,19 +17210,40 @@ "PipelineConfigurationHashes": { "properties": { "embedding_config_hash": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Embedding Config Hash", "description": "Hash of the embedding config.", "default": "" }, "parsing_config_hash": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Parsing Config Hash", "description": "Hash of the llama parse parameters.", "default": "" }, "transform_config_hash": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Transform Config Hash", "description": "Hash of the transform config.", "default": "" @@ -14628,25 +17258,44 @@ "embedding_config": { "anyOf": [ { - "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/CohereEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/GeminiEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/OpenAIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/VertexAIEmbeddingConfig" + "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" + } + } }, { - "$ref": "#/components/schemas/BedrockEmbeddingConfig" + "type": "null" } ], "title": "Embedding Config" @@ -14658,61 +17307,64 @@ }, { "$ref": "#/components/schemas/AdvancedModeTransformConfig" + }, + { + "type": "null" } ], "title": "Transform Config", "description": "Configuration for the transformation." }, "configured_transformations": { - "items": { - "$ref": "#/components/schemas/ConfiguredTransformationItem" - }, - "type": "array", + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ConfiguredTransformationItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Configured Transformations", "description": "Deprecated, use embedding_config or transform_config instead. configured transformations for the pipeline.", "default": [] }, "data_sink_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Data Sink Id", "description": "Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID." }, "data_sink": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/DataSinkCreate" + }, + { + "type": "null" } ], - "title": "Data Sink", "description": "Data sink. When provided instead of data_sink_id, the data sink will be created." }, "preset_retrieval_parameters": { - "allOf": [ - { - "$ref": "#/components/schemas/PresetRetrievalParams" - } - ], - "title": "Preset Retrieval Parameters", + "$ref": "#/components/schemas/PresetRetrievalParams", "description": "Preset retrieval parameters for the pipeline." }, "eval_parameters": { - "allOf": [ - { - "$ref": "#/components/schemas/EvalExecutionParams" - } - ], - "title": "Eval Parameters", + "$ref": "#/components/schemas/EvalExecutionParams", "description": "Eval parameters for the pipeline." }, "llama_parse_parameters": { - "allOf": [ - { - "$ref": "#/components/schemas/LlamaParseParameters" - } - ], - "title": "Llama Parse Parameters", - "description": "Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline." + "$ref": "#/components/schemas/LlamaParseParameters" }, "name": { "type": "string", @@ -14721,17 +17373,20 @@ "title": "Name" }, "pipeline_type": { - "allOf": [ - { - "$ref": "#/components/schemas/PipelineType" - } - ], + "$ref": "#/components/schemas/PipelineType", "description": "Type of pipeline. Either PLAYGROUND or MANAGED.", "default": "MANAGED" }, "managed_pipeline_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Managed Pipeline Id", "description": "The ID of the ManagedPipeline this playground pipeline is linked to." } @@ -14750,14 +17405,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -14770,30 +17439,40 @@ "$ref": "#/components/schemas/ConfigurableDataSourceNames" }, "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata that will be present on all data loaded from the data source" }, @@ -14803,38 +17482,34 @@ "type": "object" }, { - "anyOf": [ - { - "$ref": "#/components/schemas/CloudS3DataSource" - }, - { - "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" - }, - { - "$ref": "#/components/schemas/CloudGoogleDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudOneDriveDataSource" - }, - { - "$ref": "#/components/schemas/CloudSharepointDataSource" - }, - { - "$ref": "#/components/schemas/CloudSlackDataSource" - }, - { - "$ref": "#/components/schemas/CloudNotionPageDataSource" - }, - { - "$ref": "#/components/schemas/CloudConfluenceDataSource" - }, - { - "$ref": "#/components/schemas/CloudJiraDataSource" - }, - { - "$ref": "#/components/schemas/CloudBoxDataSource" - } - ] + "$ref": "#/components/schemas/CloudS3DataSource" + }, + { + "$ref": "#/components/schemas/CloudAzStorageBlobDataSource" + }, + { + "$ref": "#/components/schemas/CloudGoogleDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudOneDriveDataSource" + }, + { + "$ref": "#/components/schemas/CloudSharepointDataSource" + }, + { + "$ref": "#/components/schemas/CloudSlackDataSource" + }, + { + "$ref": "#/components/schemas/CloudNotionPageDataSource" + }, + { + "$ref": "#/components/schemas/CloudConfluenceDataSource" + }, + { + "$ref": "#/components/schemas/CloudJiraDataSource" + }, + { + "$ref": "#/components/schemas/CloudBoxDataSource" } ], "title": "Component" @@ -14863,13 +17538,26 @@ "description": "The last time the data source was automatically synced." }, "sync_interval": { - "type": "number", - "format": "time-delta", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Sync Interval", "description": "The interval at which the data source should be synced." }, "sync_schedule_set_by": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Sync Schedule Set By", "description": "The id of the user who set the sync schedule." } @@ -14897,8 +17585,14 @@ "description": "The ID of the data source." }, "sync_interval": { - "type": "number", - "format": "time-delta", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Sync Interval", "description": "The interval at which the data source should be synced." } @@ -14911,8 +17605,14 @@ "PipelineDataSourceUpdate": { "properties": { "sync_interval": { - "type": "number", - "format": "time-delta", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Sync Interval", "description": "The interval at which the data source should be synced." } @@ -14930,42 +17630,65 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, "status": { - "allOf": [ - { - "$ref": "#/components/schemas/ManagedIngestionStatus" - } - ], + "$ref": "#/components/schemas/ManagedIngestionStatus", "description": "Status of the pipeline deployment." }, "started_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Started At", "description": "Time the pipeline deployment started." }, "ended_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Ended At", "description": "Time the pipeline deployment finished." } }, "type": "object", "required": ["id", "status"], - "title": "PipelineDeployment", - "description": "Base schema model containing common database fields." + "title": "PipelineDeployment" }, "PipelineFile": { "properties": { @@ -14976,33 +17699,68 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, "name": { - "type": "string", - "maxLength": 3000, - "minLength": 1, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 1 + }, + { + "type": "null" + } + ], "title": "Name" }, "file_size": { - "type": "integer", - "minimum": 0.0, + "anyOf": [ + { + "type": "integer", + "minimum": 0.0 + }, + { + "type": "null" + } + ], "title": "File Size", "description": "Size of the file in bytes" }, "file_type": { - "type": "string", - "maxLength": 3000, - "minLength": 1, + "anyOf": [ + { + "type": "string", + "maxLength": 3000, + "minLength": 1 + }, + { + "type": "null" + } + ], "title": "File Type", "description": "File type (e.g. pdf, docx, etc.)" }, @@ -15013,48 +17771,79 @@ "description": "The ID of the project that the file belongs to" }, "last_modified_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Last Modified At", "description": "The last modified time of the file" }, "resource_info": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Resource Info", "description": "Resource information for the file" }, "data_source_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Data Source Id", "description": "The ID of the data source that the file belongs to" }, "file_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "File Id", "description": "The ID of the file" }, @@ -15065,58 +17854,78 @@ "description": "The ID of the pipeline that the file is associated with" }, "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata for the file" }, "config_hash": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Config Hash", "description": "Hashes for the configuration of the pipeline." } @@ -15124,41 +17933,51 @@ "type": "object", "required": ["id", "project_id", "pipeline_id"], "title": "PipelineFile", - "description": "Schema for a file that is associated with a pipeline." - }, - "PipelineFileCreate": { - "properties": { - "file_id": { - "type": "string", - "format": "uuid", - "title": "File Id", - "description": "The ID of the file" - }, - "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "description": "Schema for a file that is associated with a pipeline." + }, + "PipelineFileCreate": { + "properties": { + "file_id": { + "type": "string", + "format": "uuid", + "title": "File Id", + "description": "The ID of the file" + }, + "custom_metadata": { + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata for the file" } @@ -15171,30 +17990,40 @@ "PipelineFileUpdate": { "properties": { "custom_metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "object" - }, - { - "items": {}, - "type": "array" - }, - { - "type": "string" - }, - { - "type": "integer" - }, - { - "type": "number" + "anyOf": [ + { + "additionalProperties": { + "anyOf": [ + { + "type": "object" + }, + { + "items": {}, + "type": "array" + }, + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] }, - { - "type": "boolean" - } - ] - }, - "type": "object", + "type": "object" + }, + { + "type": "null" + } + ], "title": "Custom Metadata", "description": "Custom metadata for the file" } @@ -15214,25 +18043,44 @@ "embedding_config": { "anyOf": [ { - "$ref": "#/components/schemas/AzureOpenAIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/CohereEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/GeminiEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/HuggingFaceInferenceAPIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/OpenAIEmbeddingConfig" - }, - { - "$ref": "#/components/schemas/VertexAIEmbeddingConfig" + "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" + } + } }, { - "$ref": "#/components/schemas/BedrockEmbeddingConfig" + "type": "null" } ], "title": "Embedding Config" @@ -15244,69 +18092,108 @@ }, { "$ref": "#/components/schemas/AdvancedModeTransformConfig" + }, + { + "type": "null" } ], "title": "Transform Config", "description": "Configuration for the transformation." }, "configured_transformations": { - "items": { - "$ref": "#/components/schemas/ConfiguredTransformationItem" - }, - "type": "array", + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ConfiguredTransformationItem" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Configured Transformations", "description": "Deprecated, use embedding_config or transform_config instead. configured transformations for the pipeline.", "default": [] }, "data_sink_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Data Sink Id", "description": "Data sink ID. When provided instead of data_sink, the data sink will be looked up by ID." }, "data_sink": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/DataSinkCreate" + }, + { + "type": "null" } ], - "title": "Data Sink", "description": "Data sink. When provided instead of data_sink_id, the data sink will be created." }, "preset_retrieval_parameters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/PresetRetrievalParams" + }, + { + "type": "null" } ], - "title": "Preset Retrieval Parameters", "description": "Preset retrieval parameters for the pipeline." }, "eval_parameters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/EvalExecutionParams" + }, + { + "type": "null" } ], - "title": "Eval Parameters", "description": "Eval parameters for the pipeline." }, "llama_parse_parameters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/LlamaParseParameters" + }, + { + "type": "null" } ], - "title": "Llama Parse Parameters", "description": "Settings that can be configured for how to use LlamaParse to parse files within a LlamaCloud pipeline." }, "name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name" }, "managed_pipeline_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Managed Pipeline Id", "description": "The ID of the ManagedPipeline this playground pipeline is linked to." } @@ -15324,14 +18211,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -15350,12 +18251,7 @@ "title": "Llm Params Id" }, "llm_params": { - "allOf": [ - { - "$ref": "#/components/schemas/LLMParameters" - } - ], - "title": "Llm Params", + "$ref": "#/components/schemas/LLMParameters", "description": "LLM parameters last used in this session." }, "retrieval_params_id": { @@ -15364,12 +18260,7 @@ "title": "Retrieval Params Id" }, "retrieval_params": { - "allOf": [ - { - "$ref": "#/components/schemas/PresetRetrievalParams" - } - ], - "title": "Retrieval Params", + "$ref": "#/components/schemas/PresetRetrievalParams", "description": "Preset retrieval parameters last used in this session." }, "chat_messages": { @@ -15401,64 +18292,104 @@ "PresetRetrievalParams": { "properties": { "dense_similarity_top_k": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Dense Similarity Top K", "description": "Number of nodes for dense retrieval.", "default": 30 }, "sparse_similarity_top_k": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Sparse Similarity Top K", "description": "Number of nodes for sparse retrieval.", "default": 30 }, "enable_reranking": { - "type": "boolean", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Enable Reranking", "description": "Enable reranking for retrieval" }, "rerank_top_n": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Rerank Top N", "description": "Number of reranked nodes for returning.", "default": 3 }, "alpha": { - "type": "number", - "maximum": 1.0, - "minimum": 0.0, + "anyOf": [ + { + "type": "number", + "maximum": 1.0, + "minimum": 0.0 + }, + { + "type": "null" + } + ], "title": "Alpha", "description": "Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval." }, "search_filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/MetadataFilters" + }, + { + "type": "null" } ], - "title": "Search Filters", "description": "Search filters for retrieval." }, "files_top_k": { - "type": "integer", - "maximum": 5.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 5.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Files Top K", "description": "Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).", "default": 1 }, "retrieval_mode": { - "allOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], + "$ref": "#/components/schemas/RetrievalMode", "description": "The retrieval mode for the query.", "default": "chunks" }, @@ -15467,6 +18398,11 @@ "title": "Retrieve Image Nodes", "description": "Whether to retrieve image nodes.", "default": false + }, + "class_name": { + "type": "string", + "title": "Class Name", + "default": "base_component" } }, "type": "object", @@ -15477,7 +18413,6 @@ "properties": { "url": { "type": "string", - "maxLength": 65536, "minLength": 1, "format": "uri", "title": "Url", @@ -15490,10 +18425,17 @@ "description": "The time at which the presigned URL expires" }, "form_fields": { - "additionalProperties": { - "type": "string" - }, - "type": "object", + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Form Fields", "description": "Form fields for a presigned POST request" } @@ -15518,20 +18460,41 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, "ad_hoc_eval_dataset_id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Ad Hoc Eval Dataset Id" }, "organization_id": { @@ -15589,8 +18552,15 @@ "description": "The ID of the project." }, "id": { - "type": "string", - "format": "uuid", + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], "title": "Id", "description": "The ID of the prompt set." }, @@ -15631,15 +18601,29 @@ "description": "The type of prompt." }, "template": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Template", "description": "The template of the prompt." }, "message_templates": { - "items": { - "$ref": "#/components/schemas/ChatMessage" - }, - "type": "array", + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/ChatMessage" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Message Templates", "description": "The chat message templates of the prompt." } @@ -15668,14 +18652,28 @@ "title": "Node Id" }, "node_type": { - "$ref": "#/components/schemas/ObjectType" + "anyOf": [ + { + "$ref": "#/components/schemas/ObjectType" + }, + { + "type": "null" + } + ] }, "metadata": { "type": "object", "title": "Metadata" }, "hash": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Hash" }, "class_name": { @@ -15686,76 +18684,114 @@ }, "type": "object", "required": ["node_id"], - "title": "RelatedNodeInfo", - "description": "Base component object to capture class names." + "title": "RelatedNodeInfo" }, "RetrievalMode": { "type": "string", "enum": ["chunks", "files_via_metadata", "files_via_content"], - "title": "RetrievalMode", - "description": "An enumeration." + "title": "RetrievalMode" }, "RetrievalParams": { "properties": { "dense_similarity_top_k": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Dense Similarity Top K", "description": "Number of nodes for dense retrieval.", "default": 30 }, "sparse_similarity_top_k": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Sparse Similarity Top K", "description": "Number of nodes for sparse retrieval.", "default": 30 }, "enable_reranking": { - "type": "boolean", + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Enable Reranking", "description": "Enable reranking for retrieval" }, "rerank_top_n": { - "type": "integer", - "maximum": 100.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 100.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Rerank Top N", "description": "Number of reranked nodes for returning.", "default": 3 }, "alpha": { - "type": "number", - "maximum": 1.0, - "minimum": 0.0, + "anyOf": [ + { + "type": "number", + "maximum": 1.0, + "minimum": 0.0 + }, + { + "type": "null" + } + ], "title": "Alpha", "description": "Alpha value for hybrid retrieval to determine the weights between dense and sparse retrieval. 0 is sparse retrieval and 1 is dense retrieval." }, "search_filters": { - "allOf": [ + "anyOf": [ { "$ref": "#/components/schemas/MetadataFilters" + }, + { + "type": "null" } ], - "title": "Search Filters", "description": "Search filters for retrieval." }, "files_top_k": { - "type": "integer", - "maximum": 5.0, - "minimum": 1.0, + "anyOf": [ + { + "type": "integer", + "maximum": 5.0, + "minimum": 1.0 + }, + { + "type": "null" + } + ], "title": "Files Top K", "description": "Number of files to retrieve (only for retrieval mode files_via_metadata and files_via_content).", "default": 1 }, "retrieval_mode": { - "allOf": [ - { - "$ref": "#/components/schemas/RetrievalMode" - } - ], + "$ref": "#/components/schemas/RetrievalMode", "description": "The retrieval mode for the query.", "default": "chunks" }, @@ -15769,6 +18805,11 @@ "type": "string", "title": "Query", "description": "The query to retrieve against." + }, + "class_name": { + "type": "string", + "title": "Class Name", + "default": "base_component" } }, "type": "object", @@ -15824,6 +18865,7 @@ "mode": { "type": "string", "enum": ["semantic"], + "const": "semantic", "title": "Mode", "default": "semantic" }, @@ -15858,6 +18900,7 @@ "mode": { "type": "string", "enum": ["sentence"], + "const": "sentence", "title": "Mode", "default": "sentence" }, @@ -15890,9 +18933,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "chunk_size": { "type": "integer", @@ -15903,10 +18956,10 @@ }, "chunk_overlap": { "type": "integer", + "minimum": 0.0, "title": "Chunk Overlap", "description": "The token overlap of each chunk when splitting.", - "default": 200, - "gte": 0 + "default": 200 }, "separator": { "type": "string", @@ -15921,7 +18974,14 @@ "default": "\n\n\n" }, "secondary_chunking_regex": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Secondary Chunking Regex", "description": "Backup regex for splitting into sentences.", "default": "[^,.;。？！]+[,.;。？！]?" @@ -15945,11 +19005,7 @@ "SupportedLLMModel": { "properties": { "name": { - "allOf": [ - { - "$ref": "#/components/schemas/SupportedLLMModelNames" - } - ], + "$ref": "#/components/schemas/SupportedLLMModelNames", "description": "The name of the supported LLM model." }, "enabled": { @@ -15959,12 +19015,7 @@ "default": true }, "details": { - "allOf": [ - { - "$ref": "#/components/schemas/LLMModelData" - } - ], - "title": "Details", + "$ref": "#/components/schemas/LLMModelData", "description": "The details of the supported LLM model." } }, @@ -15983,8 +19034,7 @@ "GPT_4O_MINI", "AZURE_OPENAI" ], - "title": "SupportedLLMModelNames", - "description": "An enumeration." + "title": "SupportedLLMModelNames" }, "TextNode": { "properties": { @@ -15994,10 +19044,17 @@ "description": "Unique ID of the node." }, "embedding": { - "items": { - "type": "number" - }, - "type": "array", + "anyOf": [ + { + "items": { + "type": "number" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Embedding", "description": "Embedding of the node." }, @@ -16053,12 +19110,26 @@ "default": "text/plain" }, "start_char_idx": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Start Char Idx", "description": "Start char index of the node." }, "end_char_idx": { - "type": "integer", + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "End Char Idx", "description": "End char index of the node." }, @@ -16087,8 +19158,7 @@ } }, "type": "object", - "title": "TextNode", - "description": "Base node Object.\n\nGeneric abstract interface for retrievable nodes" + "title": "TextNode" }, "TextNodeWithScore": { "properties": { @@ -16096,7 +19166,14 @@ "$ref": "#/components/schemas/TextNode" }, "score": { - "type": "number", + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Score" }, "class_name": { @@ -16127,6 +19204,7 @@ "mode": { "type": "string", "enum": ["token"], + "const": "token", "title": "Mode", "default": "token" }, @@ -16154,9 +19232,19 @@ "default": true }, "callback_manager": { - "type": "object", - "title": "Callback Manager", - "default": {} + "title": "Callback Manager" + }, + "id_func": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id Func", + "description": "Function to generate node IDs." }, "chunk_size": { "type": "integer", @@ -16167,10 +19255,10 @@ }, "chunk_overlap": { "type": "integer", + "minimum": 0.0, "title": "Chunk Overlap", "description": "The token overlap of each chunk when splitting.", - "default": 20, - "gte": 0 + "default": 20 }, "separator": { "type": "string", @@ -16197,8 +19285,7 @@ "TransformationCategoryNames": { "type": "string", "enum": ["NODE_PARSER", "EMBEDDING"], - "title": "TransformationCategoryNames", - "description": "An enumeration." + "title": "TransformationCategoryNames" }, "UserOrganization": { "properties": { @@ -16209,14 +19296,28 @@ "description": "Unique identifier" }, "created_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Creation datetime" }, "updated_at": { - "type": "string", - "format": "date-time", + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Update datetime" }, @@ -16227,7 +19328,14 @@ "description": "The user's email address." }, "user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Id", "description": "The user's ID." }, @@ -16244,13 +19352,27 @@ "default": true }, "invited_by_user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Invited By User Id", "description": "The user ID of the user who added the user to the organization." }, "invited_by_user_email": { - "type": "string", - "format": "email", + "anyOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], "title": "Invited By User Email", "description": "The email address of the user who added the user to the organization." } @@ -16263,13 +19385,27 @@ "UserOrganizationCreate": { "properties": { "user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Id", "description": "The user's ID." }, "email": { - "type": "string", - "format": "email", + "anyOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], "title": "Email", "description": "The user's email address." } @@ -16281,13 +19417,27 @@ "UserOrganizationDelete": { "properties": { "user_id": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "User Id", "description": "The user's ID." }, "email": { - "type": "string", - "format": "email", + "anyOf": [ + { + "type": "string", + "format": "email" + }, + { + "type": "null" + } + ], "title": "Email", "description": "The user's email address." } @@ -16330,17 +19480,13 @@ "type": { "type": "string", "enum": ["VERTEXAI_EMBEDDING"], + "const": "VERTEXAI_EMBEDDING", "title": "Type", "description": "Type of the embedding model.", "default": "VERTEXAI_EMBEDDING" }, "component": { - "allOf": [ - { - "$ref": "#/components/schemas/ExtendVertexTextEmbedding" - } - ], - "title": "Component", + "$ref": "#/components/schemas/ExtendVertexTextEmbedding", "description": "Configuration for the VertexAI embedding model." } }, diff --git a/packages/cloud/src/reader.ts b/packages/cloud/src/reader.ts index e597647bef..7731cd5f4d 100644 --- a/packages/cloud/src/reader.ts +++ b/packages/cloud/src/reader.ts @@ -170,6 +170,15 @@ export class LlamaParseReader extends FileReader { vendorMultimodalModelName?: string | undefined; // The API key for the multimodal API. Can also be set as an env variable: LLAMA_CLOUD_VENDOR_MULTIMODAL_API_KEY vendorMultimodalApiKey?: string | undefined; + + webhookUrl?: string | undefined; + premiumMode?: boolean | undefined; + takeScreenshot?: boolean | undefined; + disableOcr?: boolean | undefined; + disableReconstruction?: boolean | undefined; + inputS3Path?: string | undefined; + outputS3PathPrefix?: string | undefined; + // numWorkers is implemented in SimpleDirectoryReader stdout?: WriteStream | undefined; @@ -258,13 +267,13 @@ export class LlamaParseReader extends FileReader { use_vendor_multimodal_model: this.useVendorMultimodalModel, vendor_multimodal_model_name: this.vendorMultimodalModelName, vendor_multimodal_api_key: this.vendorMultimodalApiKey, - // fixme: does these fields need to be set? - webhook_url: undefined, - take_screenshot: undefined, - disable_ocr: undefined, - disable_reconstruction: undefined, - input_s3_path: undefined, - output_s3_path_prefix: undefined, + premium_mode: this.premiumMode, + webhook_url: this.webhookUrl, + take_screenshot: this.takeScreenshot, + disable_ocr: this.disableOcr, + disable_reconstruction: this.disableReconstruction, + input_s3_path: this.inputS3Path, + output_s3_path_prefix: this.outputS3PathPrefix, } satisfies { [Key in keyof Body_upload_file_api_v1_parsing_upload_post]-?: | Body_upload_file_api_v1_parsing_upload_post[Key] diff --git a/packages/llamaindex/src/cloud/LlamaCloudRetriever.ts b/packages/llamaindex/src/cloud/LlamaCloudRetriever.ts index ebdf0b0bb8..54f18fb863 100644 --- a/packages/llamaindex/src/cloud/LlamaCloudRetriever.ts +++ b/packages/llamaindex/src/cloud/LlamaCloudRetriever.ts @@ -37,7 +37,7 @@ export class LlamaCloudRetriever extends BaseRetriever { return { // Currently LlamaCloud only supports text nodes node: textNode, - score: node.score, + score: node.score ?? undefined, }; }); }