From a6c6fea035e8f2c5a6632928965333082047036d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 28 Mar 2026 15:34:56 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- ... => Mixedbread.JsonSerializerContext.g.cs} | 0 src/libs/Mixedbread/openapi.yaml | 9490 +++-------------- 2 files changed, 1597 insertions(+), 7893 deletions(-) rename src/libs/Mixedbread/Generated/{Mixedbread..JsonSerializerContext.g.cs => Mixedbread.JsonSerializerContext.g.cs} (100%) diff --git a/src/libs/Mixedbread/Generated/Mixedbread..JsonSerializerContext.g.cs b/src/libs/Mixedbread/Generated/Mixedbread.JsonSerializerContext.g.cs similarity index 100% rename from src/libs/Mixedbread/Generated/Mixedbread..JsonSerializerContext.g.cs rename to src/libs/Mixedbread/Generated/Mixedbread.JsonSerializerContext.g.cs diff --git a/src/libs/Mixedbread/openapi.yaml b/src/libs/Mixedbread/openapi.yaml index f415456..43b713f 100644 --- a/src/libs/Mixedbread/openapi.yaml +++ b/src/libs/Mixedbread/openapi.yaml @@ -1,26 +1,11 @@ { "openapi": "3.1.0", - "info": { - "title": "mxbai-omni", - "version": "0.1.0" - }, + "info": { "title": "mxbai-omni", "version": "0.1.0" }, "servers": [ - { - "url": "https://api.mixedbread.com", - "description": "mixedbread ai production server" - }, - { - "url": "https://api.dev.mixedbread.com", - "description": "mixedbread ai development server" - }, - { - "url": "http://127.0.0.1:8000", - "description": "mixedbread local server" - }, - { - "url": "http://localhost:8000", - "description": "mixedbread local server" - } + { "url": "https://api.mixedbread.com", "description": "mixedbread ai production server" }, + { "url": "https://api.dev.mixedbread.com", "description": "mixedbread ai development server" }, + { "url": "http://127.0.0.1:8000", "description": "mixedbread local server" }, + { "url": "http://localhost:8000", "description": "mixedbread local server" } ], "paths": { "/": { @@ -31,90 +16,48 @@ "responses": { "200": { "description": "Info response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoResponse" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoResponse" } } } }, "500": { "description": "Info failed", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/files": { "post": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Upload file", "description": "Upload a new file.\n\nArgs:\n file: The file to upload.\n\nReturns:\n FileResponse: The response containing the details of the uploaded file.", "operationId": "create_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/Body_create_file" - } - } + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_file" } } } }, "responses": { "201": { "description": "The uploaded file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileObject" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileObject" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "List files", "description": "List all files for the authenticated user.\n\nArgs:\n pagination: The pagination options\n\nReturns:\n A list of files belonging to the user.", "operationId": "list_files", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -125,11 +68,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -140,18 +79,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -161,18 +91,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -184,10 +105,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -198,16 +116,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" }], "description": "Search query for fuzzy matching over name and description fields", "title": "Q" }, @@ -218,21 +127,13 @@ "200": { "description": "A list of files for the user", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/FileListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -240,9 +141,7 @@ }, "/v1/files/uploads": { "get": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "List in-progress multipart uploads", "description": "List all in-progress multipart uploads for the authenticated organization.", "operationId": "list_multipart_uploads", @@ -250,34 +149,20 @@ "200": { "description": "All in-progress multipart uploads for the organization", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MultipartUploadListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/MultipartUploadListResponse" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] }, "post": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Create multipart upload", "description": "Initiate a multipart upload and receive presigned URLs for uploading parts directly to storage.", "operationId": "create_multipart_upload", "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateMultipartUploadRequest" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultipartUploadRequest" } } }, "required": true }, @@ -286,43 +171,27 @@ "description": "The multipart upload details with presigned URLs", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateMultipartUploadResponse" - } + "schema": { "$ref": "#/components/schemas/CreateMultipartUploadResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/files/uploads/{upload_id}/complete": { "post": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Complete multipart upload", "description": "Complete a multipart upload after all parts have been uploaded.\nCreates the file object and returns it.", "operationId": "complete_multipart_upload", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "upload_id", @@ -341,31 +210,19 @@ "required": true, "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/CompleteMultipartUploadRequest" - } + "schema": { "$ref": "#/components/schemas/CompleteMultipartUploadRequest" } } } }, "responses": { "200": { "description": "The completed file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileObject" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileObject" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -373,17 +230,11 @@ }, "/v1/files/uploads/{upload_id}/abort": { "post": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Abort multipart upload", "description": "Abort a multipart upload and clean up any uploaded parts.", "operationId": "abort_multipart_upload", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "upload_id", @@ -401,22 +252,12 @@ "responses": { "200": { "description": "The details of the aborted upload", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileDeleted" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -424,17 +265,11 @@ }, "/v1/files/uploads/{upload_id}": { "get": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Get multipart upload details", "description": "Get a multipart upload's details with fresh presigned URLs for any parts not yet uploaded.", "operationId": "get_multipart_upload", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "upload_id", @@ -454,20 +289,14 @@ "description": "Upload details with presigned URLs for incomplete parts", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/MultipartUploadDetailResponse" - } + "schema": { "$ref": "#/components/schemas/MultipartUploadDetailResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -475,17 +304,11 @@ }, "/v1/files/{file_id}": { "get": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Get file details", "description": "Retrieve details of a specific file by its ID.\n\nArgs:\n file_id: The ID of the file to retrieve.\n\nReturns:\n FileResponse: The response containing the file details.", "operationId": "retrieve_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "file_id", @@ -503,38 +326,22 @@ "responses": { "200": { "description": "The details of the requested file", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileObject" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileObject" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Update file", "description": "Update the details of a specific file.\n\nArgs:\n file_id: The ID of the file to update.\n file: The new details for the file.\n\nReturns:\n FileObject: The updated file details.", "operationId": "update_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "file_id", @@ -552,48 +359,28 @@ "requestBody": { "required": true, "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/Body_update_file" - } - } + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_update_file" } } } }, "responses": { "200": { "description": "The updated file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileObject" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileObject" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Delete file", "description": "Delete a specific file by its ID.\n\nArgs:\n file_id: The ID of the file to delete.\n\nReturns:\n FileDeleted: The response containing the details of the deleted file.", "operationId": "delete_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "file_id", @@ -611,22 +398,12 @@ "responses": { "200": { "description": "The details of the deleted file", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/FileDeleted" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -634,17 +411,11 @@ }, "/v1/files/{file_id}/content": { "get": { - "tags": [ - "files" - ], + "tags": ["files"], "summary": "Download file", "description": "Download a specific file by its ID.\n\nArgs:\n file_id: The ID of the file to download.\n\nReturns:\n FileStreamResponse: The response containing the file to be downloaded.", "operationId": "download_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "file_id", @@ -662,22 +433,12 @@ "responses": { "200": { "description": "The file to be downloaded", - "content": { - "application/octet-stream": { - "schema": { - "type": "string" - } - } - } + "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -685,87 +446,51 @@ }, "/v1/chat/completions": { "post": { - "tags": [ - "completions" - ], + "tags": ["completions"], "summary": "Create a chat completion", "description": "Create a chat completion using the provided parameters.\n\nGenerates a completion response based on the chat messages and model parameters provided.\nThe response can be either a full completion or streamed chunks depending on the request parameters.\n\nArgs:\n params: Parameters for creating the chat completion including messages, model selection,\n and generation settings\n user: The authenticated user making the request\n\nReturns:\n Either a ChatCompletion containing the full response, or ChatCompletionChunk for streaming\n\nRaises:\n HTTPException: If there is an error creating the completion (500)", "operationId": "create_chat_completion", "responses": { "200": { "description": "The generated chat completion response", - "content": { - "application/json": { - "schema": {} - } - } + "content": { "application/json": { "schema": {} } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/api-keys": { "post": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Create API key", "description": "Create a new API key.\n\nArgs:\n params: The parameters for creating the API key.\n\nReturns:\n ApiKeyCreated: The response containing the details of the created API key.", "operationId": "create_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyCreateParams" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateParams" } } } }, "responses": { "201": { "description": "The created API key details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyCreated" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreated" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "List API keys", "description": "List all API keys for the authenticated user.\n\nArgs:\n pagination: The pagination options\n\nReturns:\n A list of API keys belonging to the user.", "operationId": "list_api_keys", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -797,21 +522,13 @@ "200": { "description": "A list of API keys for the user", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -819,17 +536,11 @@ }, "/v1/api-keys/{api_key_id}": { "get": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Get API key details", "description": "Retrieve details of a specific API key by its ID.\n\nArgs:\n api_key_id: The ID of the API key to retrieve.\n\nReturns:\n ApiKey: The response containing the API key details.", "operationId": "retrieve_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "api_key_id", @@ -847,38 +558,22 @@ "responses": { "200": { "description": "The details of the requested API key", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKey" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Update API key", "description": "Update a specific API key by its ID.\n\nArgs:\n api_key_id: The ID of the API key to update.\n params: The parameters to update.\n\nReturns:\n ApiKey: The updated API key details.", "operationId": "update_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "api_key_id", @@ -896,48 +591,28 @@ "requestBody": { "required": true, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUpdateParams" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyUpdateParams" } } } }, "responses": { "200": { "description": "The updated API key details", + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } + }, + "422": { + "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKey" - } - } - } - }, - "422": { - "description": "Validation Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Delete API key", "description": "Delete a specific API key by its ID.\n\nArgs:\n api_key_id: The ID of the API key to delete.\n\nReturns:\n ApiKeyDeleted: The response containing the details of the deleted API key.", "operationId": "delete_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "api_key_id", @@ -955,22 +630,12 @@ "responses": { "200": { "description": "The details of the deleted API key", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyDeleted" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -978,17 +643,11 @@ }, "/v1/api-keys/{api_key_id}/revoke": { "post": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Revoke API key", "description": "Revoke a specific API key by its ID.\n\nArgs:\n api_key_id: The ID of the API key to revoke.\n\nReturns:\n ApiKey: The response containing the details of the revoked API key.", "operationId": "revoke_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "api_key_id", @@ -1006,22 +665,12 @@ "responses": { "200": { "description": "The revoked API key details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKey" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1029,17 +678,11 @@ }, "/v1/api-keys/{api_key_id}/reroll": { "post": { - "tags": [ - "api_keys" - ], + "tags": ["api_keys"], "summary": "Reroll API key", "description": "Reroll the secret for a specific API key by its ID.\n\nThis generates a new secret key, invalidating the old one.\n\nArgs:\n api_key_id: The ID of the API key to reroll.\n\nReturns:\n ApiKeyCreated: The response containing the API key details with the new secret key.", "operationId": "reroll_api_key", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "api_key_id", @@ -1057,22 +700,12 @@ "responses": { "200": { "description": "The API key details with the new secret key", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyCreated" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreated" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1080,93 +713,57 @@ }, "/v1/schemas/mxjson": { "get": { - "tags": [ - "schemas" - ], + "tags": ["schemas"], "summary": "Get mxbai json schema", "description": "Get the mxbai json schema.\n\nReturns:\n The mxbai json schema.", "operationId": "get_mxbai_json_schema", "responses": { "200": { "description": "The mxbai json schema", - "content": { - "application/json": { - "schema": {} - } - } + "content": { "application/json": { "schema": {} } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/billing/summary": { "get": { - "tags": [ - "billing" - ], + "tags": ["billing"], "summary": "Get billing summary", "operationId": "get_billing_summary", "responses": { "200": { "description": "Billing summary for the current period", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/BillingPeriodSummary" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/BillingPeriodSummary" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/billing/stores": { "get": { - "tags": [ - "billing" - ], + "tags": ["billing"], "summary": "List store cost information", "operationId": "list_store_cost_info", "responses": { "200": { "description": "The list of store cost information", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreCostListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreCostListResponse" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/billing/stores/{store_id}/costs/histogram": { "get": { - "tags": [ - "billing" - ], + "tags": ["billing"], "summary": "Get store cost histogram", "operationId": "get_store_cost_histogram", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_id", @@ -1185,21 +782,13 @@ "200": { "description": "Histogram of store costs over time", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CostHistogramResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CostHistogramResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1207,62 +796,39 @@ }, "/v1/billing/parsing/costs/histogram": { "get": { - "tags": [ - "billing" - ], + "tags": ["billing"], "summary": "Get parsing cost histogram", "operationId": "get_parsing_cost_histogram", "responses": { "200": { "description": "Histogram of parsing costs over time", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CostHistogramResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CostHistogramResponse" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/admin/stores/{organization_id}/{store_identifier}/reingest": { "post": { - "tags": [ - "admin" - ], + "tags": ["admin"], "summary": "Reingest all stores", "description": "Reingest all stores across all organizations (admin only).\n\nThis endpoint creates StoreFileReingestionJob for each store.\n\nReturns:\n dict: Confirmation message with count of jobs created.", "operationId": "reingest_all_stores", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "organization_id", "in": "path", "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Organization Id" - } + "schema": { "type": "string", "format": "uuid", "title": "Organization Id" } }, { "name": "store_identifier", "in": "path", "required": true, - "schema": { - "type": "string", - "title": "Store Identifier" - } + "schema": { "type": "string", "title": "Store Identifier" } }, { "name": "statuses", @@ -1270,15 +836,8 @@ "required": false, "schema": { "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/VectorStoreFileStatus" - } - }, - { - "type": "null" - } + { "type": "array", "items": { "$ref": "#/components/schemas/VectorStoreFileStatus" } }, + { "type": "null" } ], "description": "Statuses of files to reingest", "title": "Statuses" @@ -1301,20 +860,12 @@ "responses": { "200": { "description": "Confirmation that reingestion jobs have been created", - "content": { - "application/json": { - "schema": {} - } - } + "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1322,32 +873,18 @@ }, "/v1/stores/{store_identifier}/events": { "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "List events for a store", "description": "List events for a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n options: The pagination options.\n\nReturns:\n StoreEventListResponse: The list of events for the store.", "operationId": "list_store_events", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1362,11 +899,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -1377,18 +910,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -1398,18 +922,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -1421,10 +936,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -1435,15 +947,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "description": "Time to filter events before", "title": "Filter Before" }, @@ -1454,15 +958,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "description": "Time to filter events after", "title": "Filter After" }, @@ -1473,16 +969,10 @@ "in": "query", "required": true, "schema": { - "enum": [ - "ingestion", - "search" - ], + "enum": ["ingestion", "search"], "type": "string", "description": "The type of event to list", - "examples": [ - "ingestion", - "search" - ], + "examples": ["ingestion", "search"], "title": "Event Type" }, "description": "The type of event to list" @@ -1492,21 +982,13 @@ "200": { "description": "The list of events for the store", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreEventListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreEventListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1514,32 +996,18 @@ }, "/v1/stores/{store_identifier}/events/histogram": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Get store event histogram", "description": "Get histogram of store events over time.\n\nArgs:\n store_identifier: The ID or name of the store.\n histogram_params: Parameters for histogram generation.\n\nReturns:\n StoreEventHistogramResponse: The event histogram.", "operationId": "get_store_event_histogram", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1549,32 +1017,20 @@ "requestBody": { "required": true, "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreEventHistogramParams" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreEventHistogramParams" } } } }, "responses": { "200": { "description": "Histogram of store events over time", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreEventHistogramResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreEventHistogramResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1582,32 +1038,18 @@ }, "/v1/stores/{store_identifier}/files": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Upload file to store", "description": "Upload a file to a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n file_add_params: The file to add to the store.\n\nReturns:\n VectorStoreFile: The uploaded file details.", "operationId": "create_store_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1628,54 +1070,30 @@ "responses": { "201": { "description": "The uploaded store file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFile" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "[DEPRECATED] List store files", "description": "DEPRECATED: Use POST /stores/{store_identifier}/files/list instead", "operationId": "list_store_files", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1690,11 +1108,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -1705,18 +1119,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -1726,18 +1131,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -1749,10 +1145,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -1764,15 +1157,8 @@ "required": false, "schema": { "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/StoreFileStatus" - } - }, - { - "type": "null" - } + { "type": "array", "items": { "$ref": "#/components/schemas/StoreFileStatus" } }, + { "type": "null" } ], "description": "Status to filter by", "title": "Statuses" @@ -1784,21 +1170,13 @@ "200": { "description": "The list of store files", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFileListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreFileListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1806,32 +1184,18 @@ }, "/v1/stores/{store_identifier}/files/upload": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Upload file via form to store", "description": "Upload a file via form to a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n config: The config for the file.\n metadata: The metadata for the file.\n file: The file to upload.\n\nReturns:\n VectorStoreFile: The uploaded file details.", "operationId": "upload_store_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1841,32 +1205,18 @@ "requestBody": { "required": true, "content": { - "multipart/form-data": { - "schema": { - "$ref": "#/components/schemas/Body_upload_store_file" - } - } + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_store_file" } } } }, "responses": { "201": { "description": "The uploaded store file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFile" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1874,32 +1224,18 @@ }, "/v1/stores/{store_identifier}/files/list": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "List store files with metadata filter", "description": "List files indexed in a vector store with pagination and metadata filter.\n\nArgs:\n vector_store_identifier: The ID or name of the vector store\n pagination: Pagination parameters and metadata filter\n\nReturns:\n VectorStoreFileListResponse: Paginated list of vector store files", "operationId": "list_store_files_with_metadata_filter", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1921,21 +1257,13 @@ "200": { "description": "List of files in the store", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFileListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreFileListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -1943,32 +1271,18 @@ }, "/v1/stores/{store_identifier}/files/{file_identifier}": { "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Get store file", "description": "Get a file from a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n file_id: The ID or name of the file.\n options: Get file options.\n\nReturns:\n VectorStoreFile: The file details.", "operationId": "retrieve_store_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -1979,15 +1293,7 @@ "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the file", "title": "File Identifier" }, @@ -1998,17 +1304,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "array", - "items": { - "type": "integer" - } - } - ], + "anyOf": [{ "type": "boolean" }, { "type": "array", "items": { "type": "integer" } }], "description": "Whether to return the chunks for the file. If a list of integers is provided, only the chunks at the specified indices will be returned.", "default": false, "title": "Return Chunks" @@ -2019,53 +1315,29 @@ "responses": { "200": { "description": "The store file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFile" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Update store file metadata", "description": "Update metadata on a file within a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n file_identifier: The ID or name of the file to update.\n update_params: Metadata update payload.\n\nReturns:\n StoreFile: The updated file details.", "operationId": "update_store_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2076,15 +1348,7 @@ "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the file to update", "title": "File Identifier" }, @@ -2105,53 +1369,29 @@ "responses": { "200": { "description": "The updated store file details", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFile" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Delete store file", "description": "Delete a file from a store.\n\nArgs:\n store_identifier: The ID or name of the store.\n file_id: The ID or name of the file to delete.\n\nReturns:\n VectorStoreFileDeleted: The deleted file details.", "operationId": "delete_store_file", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2162,15 +1402,7 @@ "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the file to delete", "title": "File Identifier" }, @@ -2181,21 +1413,13 @@ "200": { "description": "The deleted store file details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFileDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreFileDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2203,9 +1427,7 @@ }, "/v1/stores/files/search": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Search store files", "description": "Search for files within a store based on semantic similarity.\n\nArgs:\n store_identifier: The ID or name of the store to search within\n search_params: Search configuration including query text, pagination, and filters\n\nReturns:\n StoreFileSearchResponse: List of matching files with relevance scores", "operationId": "search_store_files", @@ -2224,59 +1446,33 @@ "200": { "description": "List of files matching search criteria with relevance scores", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreFileSearchResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreFileSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/stores/{store_identifier}/rules": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Create search rule", "description": "Create a new search rule for a store.\n\nArgs:\n store_identifier: The ID or name of the store\n rule_create: Search rule creation parameters\n\nReturns:\n SearchRuleResponse: The created search rule details", "operationId": "create_search_rule", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2308,11 +1504,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2320,32 +1512,18 @@ }, "/v1/stores/{store_identifier}/rules/{rule_id}": { "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Get a search rule", "description": "Get a search rule by ID.\n\nArgs:\n store_identifier: The ID or name of the store\n rule_id: The ID of the search rule to retrieve\n\nReturns:\n SearchRuleResponse: The search rule details", "operationId": "retrieve_search_rule", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2378,42 +1556,24 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Update a search rule", "description": "Update a search rule by ID.\n\nArgs:\n store_identifier: The ID or name of the store\n rule_id: The ID of the search rule to update\n rule_update: SearchRuleUpdateParams object containing the fields to update\n\nReturns:\n SearchRuleResponse: The updated search rule details", "operationId": "update_search_rule", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2457,42 +1617,24 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Delete a search rule", "description": "Delete a search rule by ID.\n\nArgs:\n store_identifier: The ID or name of the store\n rule_id: The ID of the search rule to delete\n\nReturns:\n SearchRuleDeleted: The deleted search rule details", "operationId": "delete_search_rule", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2525,11 +1667,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2537,32 +1675,18 @@ }, "/v1/stores/{store_identifier}/rules/{rule_id}/specific": { "delete": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Delete a specific rule from rules array", "description": "Delete a specific rule from within a search rule's rules array.\n\nArgs:\n store_identifier: The ID or name of the store\n rule_id: The ID of the search rule containing the rule to delete\n rule_delete: The specific rule to delete from the rules array\n\nReturns:\n SearchRuleSpecificDeleted: Details about the deletion operation", "operationId": "delete_specific_search_rule", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2606,11 +1730,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2618,17 +1738,11 @@ }, "/v1/stores": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Create a store", "description": "Create a new vector store.\n\nArgs:\n vector_store_create: VectorStoreCreate object containing the name, description, and metadata.\n\nReturns:\n VectorStore: The response containing the created vector store details.", "operationId": "create_store", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { @@ -2643,38 +1757,22 @@ "responses": { "201": { "description": "The details of the created store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Store" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "List stores", "description": "List all stores with optional search.\n\nArgs:\n pagination: The pagination options.\n q: Optional search query to filter vector stores.\n\nReturns:\n StoreListResponse: The list of stores.", "operationId": "list_stores", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -2685,11 +1783,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -2700,18 +1794,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -2721,18 +1806,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -2744,10 +1820,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -2758,16 +1831,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" }], "description": "Search query for fuzzy matching over name and description fields", "title": "Q" }, @@ -2778,21 +1842,13 @@ "200": { "description": "The list of stores", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2800,32 +1856,18 @@ }, "/v1/stores/{store_identifier}": { "get": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Get a store", "description": "Get a store by ID or name.\n\nArgs:\n store_identifier: The ID or name of the store to retrieve.\n\nReturns:\n Store: The response containing the store details.", "operationId": "retrieve_store", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2835,53 +1877,29 @@ "responses": { "200": { "description": "The details of the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Store" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Update a store", "description": "Update a store by ID or name.\n\nArgs:\n store_identifier: The ID or name of the store to update.\n store_update: StoreCreate object containing the name, description, and metadata.\n\nReturns:\n Store: The response containing the updated store details.", "operationId": "update_store", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store", "title": "Store Identifier" }, @@ -2902,53 +1920,29 @@ "responses": { "200": { "description": "The details of the updated store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Store" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Store" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Delete a store", "description": "Delete a store by ID or name.\n\nArgs:\n store_identifier: The ID or name of the store to delete.\n\nReturns:\n Store: The response containing the deleted store details.", "operationId": "delete_store", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the store to delete", "title": "Store Identifier" }, @@ -2958,22 +1952,12 @@ "responses": { "200": { "description": "The details of the deleted store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreDeleted" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -2981,9 +1965,7 @@ }, "/v1/stores/search": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Perform semantic search across store chunks", "description": "Perform semantic search across store chunks.\n\nThis endpoint searches through store chunks using semantic similarity matching.\nIt supports complex search queries with filters and returns relevance-scored results.\n\nFor the special 'mixedbread/web' store, this endpoint performs web search using\na mixture of different providers instead of semantic search. Web search results are always\nreranked for consistent scoring.\n\nArgs:\n search_params: Search configuration including:\n - query text or embeddings\n - store_identifiers: List of store identifiers to search\n - file_ids: Optional list of file IDs to filter chunks by (or tuple of list and condition operator)\n - metadata filters\n - pagination parameters\n - sorting preferences\n _state: API state dependency\n _ctx: Service context dependency\n\nReturns:\n StoreSearchResponse containing:\n - List of matched chunks with relevance scores\n - Pagination details including total result count\n\nRaises:\n HTTPException (400): If search parameters are invalid\n HTTPException (404): If no vector stores are found to search", "operationId": "search_store_chunks", @@ -3002,36 +1984,22 @@ "200": { "description": "List of semantically similar chunks with relevance scores and pagination details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreSearchResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/StoreSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/stores/question-answering": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Question answering", "operationId": "create_question_answering", "requestBody": { @@ -3048,37 +2016,21 @@ "responses": { "200": { "description": "The answer to the question", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StoreQAResults" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreQAResults" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/stores/metadata-facets": { "post": { - "tags": [ - "stores" - ], + "tags": ["stores"], "summary": "Get metadata facets", "operationId": "get_metadata_facets", "requestBody": { @@ -3095,61 +2047,33 @@ "responses": { "200": { "description": "The metadata facets", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/MetadataFacets" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataFacets" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/vector_stores/{vector_store_identifier}/files": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Upload file to vector store", "description": "DEPRECATED: Use POST /stores/{store_identifier}/files instead", "operationId": "create_vector_store_file", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3171,53 +2095,31 @@ "201": { "description": "The uploaded vector store file details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFile" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] List vector store files", "description": "DEPRECATED: Use POST /stores/{store_identifier}/files/list instead", "operationId": "list_vector_store_files", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3232,11 +2134,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -3247,18 +2145,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -3268,18 +2157,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -3291,10 +2171,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -3306,15 +2183,8 @@ "required": false, "schema": { "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/StoreFileStatus" - } - }, - { - "type": "null" - } + { "type": "array", "items": { "$ref": "#/components/schemas/StoreFileStatus" } }, + { "type": "null" } ], "description": "Status to filter by", "title": "Statuses" @@ -3326,21 +2196,13 @@ "200": { "description": "The list of vector store files", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFileListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreFileListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -3348,33 +2210,19 @@ }, "/v1/vector_stores/{vector_store_identifier}/files/list": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] List vector store files with metadata filter", "description": "DEPRECATED: Use POST /stores/{store_identifier}/files/list instead", "operationId": "list_vector_store_files_with_metadata_filter", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3396,21 +2244,13 @@ "200": { "description": "List of files in the vector store", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFileListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreFileListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -3418,33 +2258,19 @@ }, "/v1/vector_stores/{vector_store_identifier}/files/{file_id}": { "get": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Get vector store file", "description": "DEPRECATED: Use GET /stores/{store_identifier}/files/{file_id} instead", "operationId": "retrieve_vector_store_file", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3455,15 +2281,7 @@ "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the file", "title": "File Id" }, @@ -3486,53 +2304,31 @@ "200": { "description": "The vector store file details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFile" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreFile" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Delete vector store file", "description": "DEPRECATED: Use DELETE /stores/{store_identifier}/files/{file_id} instead", "operationId": "delete_vector_store_file", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3543,15 +2339,7 @@ "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the file to delete", "title": "File Id" }, @@ -3562,21 +2350,13 @@ "200": { "description": "The deleted vector store file details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFileDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreFileDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -3584,9 +2364,7 @@ }, "/v1/vector_stores/files/search": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Search vector store files", "description": "DEPRECATED: Use POST /stores/{store_identifier}/files/search instead", "operationId": "search_vector_store_files", @@ -3606,60 +2384,36 @@ "description": "List of files matching search criteria with relevance scores", "content": { "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreFileSearchResponse" - } + "schema": { "$ref": "#/components/schemas/VectorStoreFileSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/vector_stores/{vector_store_identifier}/rules": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Create search rule", "description": "DEPRECATED: Use POST /stores/{store_identifier}/rules instead", "operationId": "deprecated_create_search_rule", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3691,11 +2445,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -3703,33 +2453,19 @@ }, "/v1/vector_stores/{vector_store_identifier}/rules/{rule_id}": { "get": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Get a search rule", "description": "DEPRECATED: Use GET /stores/{store_identifier}/rules/{rule_id} instead", "operationId": "deprecated_retrieve_search_rule", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3762,43 +2498,25 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Update a search rule", "description": "DEPRECATED: Use PUT /stores/{store_identifier}/rules/{rule_id} instead", "operationId": "deprecated_update_search_rule", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], - "parameters": [ + "security": [{ "ApiKeyAuth": [] }], + "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3842,43 +2560,25 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Delete a search rule", "description": "DEPRECATED: Use DELETE /stores/{store_identifier}/rules/{rule_id} instead", "operationId": "deprecated_delete_search_rule", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3911,11 +2611,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -3923,33 +2619,19 @@ }, "/v1/vector_stores/{vector_store_identifier}/rules/{rule_id}/specific": { "delete": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Delete a specific rule from rules array", "description": "DEPRECATED: Use DELETE /stores/{store_identifier}/rules/{rule_id}/specific instead", "operationId": "deprecated_delete_specific_search_rule", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -3993,11 +2675,7 @@ "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4005,18 +2683,12 @@ }, "/v1/vector_stores": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Create a vector store", "description": "DEPRECATED: Use POST /stores instead", "operationId": "create_vector_store", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { @@ -4031,39 +2703,23 @@ "responses": { "201": { "description": "The details of the created vector store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStore" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorStore" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] List vector stores", "description": "DEPRECATED: Use GET /stores instead", "operationId": "list_vector_stores", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -4074,11 +2730,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -4089,18 +2741,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -4110,18 +2753,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -4133,10 +2767,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -4147,16 +2778,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" }], "description": "Search query for fuzzy matching over name and description fields", "title": "Q" }, @@ -4167,21 +2789,13 @@ "200": { "description": "The list of vector stores", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4189,33 +2803,19 @@ }, "/v1/vector_stores/{vector_store_identifier}": { "get": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Get a vector store", "description": "DEPRECATED: Use GET /stores/{store_identifier} instead", "operationId": "retrieve_vector_store", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -4225,54 +2825,30 @@ "responses": { "200": { "description": "The details of the vector store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStore" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorStore" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Update a vector store", "description": "DEPRECATED: Use PUT /stores/{store_identifier} instead", "operationId": "update_vector_store", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store", "title": "Vector Store Identifier" }, @@ -4293,54 +2869,30 @@ "responses": { "200": { "description": "The details of the updated vector store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStore" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VectorStore" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Delete a vector store", "description": "DEPRECATED: Use DELETE /stores/{store_identifier} instead", "operationId": "delete_vector_store", "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "vector_store_identifier", "in": "path", "required": true, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "description": "The ID or name of the vector store to delete", "title": "Vector Store Identifier" }, @@ -4351,21 +2903,13 @@ "200": { "description": "The details of the deleted vector store", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4373,9 +2917,7 @@ }, "/v1/vector_stores/search": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Perform semantic search across vector store chunks", "description": "DEPRECATED: Use POST /stores/search instead", "operationId": "search_vector_store_chunks", @@ -4394,37 +2936,23 @@ "200": { "description": "List of semantically similar chunks with relevance scores and pagination details", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreSearchResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/vector_stores/question-answering": { "post": { - "tags": [ - "deprecated_vector_stores" - ], + "tags": ["deprecated_vector_stores"], "summary": "[DEPRECATED] Question answering", "description": "DEPRECATED: Use POST /stores/question-answering instead", "operationId": "deprecated_create_question_answering", @@ -4443,45 +2971,27 @@ "200": { "description": "The answer to the question", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VectorStoreQAResults" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/VectorStoreQAResults" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "deprecated": true, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/parsing/jobs": { "post": { - "tags": [ - "parsing" - ], + "tags": ["parsing"], "summary": "Start a parse job", "description": "Start a parse job for the provided file.\n\nArgs:\n params: The parameters for creating a parse job.\n\nReturns:\n The created parsing job.", "operationId": "create_parsing_job", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { @@ -4496,38 +3006,22 @@ "responses": { "201": { "description": "The created parse job", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParsingJob" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParsingJob" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "parsing" - ], + "tags": ["parsing"], "summary": "List parsing jobs", "description": "List parsing jobs with pagination.\n\nArgs:\n limit: The number of items to return.\n offset: The number of items to skip.\n\nReturns:\n List of parsing jobs with pagination.", "operationId": "list_parsing_jobs", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -4538,11 +3032,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -4553,18 +3043,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -4574,18 +3055,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -4597,10 +3069,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -4612,15 +3081,8 @@ "required": false, "schema": { "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ParsingJobStatus" - } - }, - { - "type": "null" - } + { "type": "array", "items": { "$ref": "#/components/schemas/ParsingJobStatus" } }, + { "type": "null" } ], "description": "Status to filter by", "title": "Statuses" @@ -4632,16 +3094,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string", - "minLength": 1, - "maxLength": 100 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" }], "description": "Search query to filter by", "title": "Q" }, @@ -4652,21 +3105,13 @@ "200": { "description": "List of parsing jobs with pagination", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParsingJobListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ParsingJobListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4674,17 +3119,11 @@ }, "/v1/parsing/jobs/{job_id}": { "get": { - "tags": [ - "parsing" - ], + "tags": ["parsing"], "summary": "Get parsing job result", "description": "Get detailed information about a specific parse job.\n\nArgs:\n job_id: The ID of the parse job.\n\nReturns:\n Detailed information about the parse job.", "operationId": "retrieve_parsing_job", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "job_id", @@ -4702,38 +3141,22 @@ "responses": { "200": { "description": "Detailed information about a parsing job", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParsingJob" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParsingJob" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { - "tags": [ - "parsing" - ], + "tags": ["parsing"], "summary": "Cancel a parsing job", "description": "Cancel a specific parse job.\n\nArgs:\n job_id: The ID of the parse job to cancel.\n\nReturns:\n The cancelled parsing job.", "operationId": "cancel_parsing_job", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "job_id", @@ -4751,39 +3174,23 @@ "responses": { "200": { "description": "The cancelled parse job", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParsingJob" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParsingJob" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "parsing" - ], + "tags": ["parsing"], "summary": "Delete a parsing job", "description": "Delete a specific parse job.\n\nArgs:\n job_id: The ID of the parse job to delete.\n\nReturns:\n The deleted parsing job.", "operationId": "delete_parsing_job", - "security": [ - { - "ApiKeyAuth": [] - } - ], - "parameters": [ + "security": [{ "ApiKeyAuth": [] }], + "parameters": [ { "name": "job_id", "in": "path", @@ -4801,21 +3208,13 @@ "200": { "description": "The deleted parse job", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ParsingJobDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ParsingJobDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4823,9 +3222,7 @@ }, "/v1/extractions/jobs": { "post": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Start an extraction job", "description": "Start an extraction job for the provided file and schema.\n\nArgs:\n params: The parameters for creating an extraction job.\n\nReturns:\n The created extraction job.", "operationId": "create_extraction_job", @@ -4843,45 +3240,25 @@ "responses": { "200": { "description": "The created extraction job", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtractionJob" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionJob" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/extractions/jobs/{job_id}": { "get": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Get extraction job result", "description": "Get detailed information about a specific extraction job.\n\nArgs:\n job_id: The ID of the extraction job.\n\nReturns:\n Detailed information about the extraction job.", "operationId": "retrieve_extraction_job", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "job_id", @@ -4898,22 +3275,12 @@ "responses": { "200": { "description": "Detailed information about an extraction job", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtractionJob" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionJob" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -4921,9 +3288,7 @@ }, "/v1/extractions/schema": { "post": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Create a schema", "description": "Create a schema with the provided parameters.\n\nArgs:\n params: The parameters for creating a schema.\n\nReturns:\n The created schema.", "operationId": "create_schema", @@ -4942,36 +3307,22 @@ "200": { "description": "The created schema", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreatedJsonSchema" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/CreatedJsonSchema" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/extractions/schema/enhance": { "post": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Enhance a schema", "description": "Enhance a schema by enriching the descriptions to aid extraction.\n\nArgs:\n params: The parameters for enhancing a schema.\n\nReturns:\n The enhanced schema.", "operationId": "enhance_schema", @@ -4990,36 +3341,22 @@ "200": { "description": "The enhanced schema", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EnhancedJsonSchema" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/EnhancedJsonSchema" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/extractions/schema/validate": { "post": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Validate a schema", "description": "Validate a schema.\n\nArgs:\n params: The parameters for validating a schema.\n\nReturns:\n The validation result.", "operationId": "validate_schema", @@ -5038,36 +3375,22 @@ "200": { "description": "The validation result", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidatedJsonSchema" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ValidatedJsonSchema" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/extractions/content": { "post": { - "tags": [ - "extractions" - ], + "tags": ["extractions"], "summary": "Extract content from a string", "description": "Extract content from a string using the provided schema.\n\nArgs:\n params: The parameters for extracting content from a string.\n\nReturns:\n The extracted content.", "operationId": "extract_content", @@ -5086,29 +3409,17 @@ "200": { "description": "The extracted content", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExtractionResult" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ExtractionResult" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/embeddings": { @@ -5131,29 +3442,17 @@ "200": { "description": "The embeddings for the input text or image", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EmbeddingCreateResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/reranking": { @@ -5175,46 +3474,25 @@ "responses": { "200": { "description": "The reranked documents for the input query", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RerankResponse" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RerankResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, - "security": [ - { - "ApiKeyAuth": [] - } - ] + "security": [{ "ApiKeyAuth": [] }] } }, "/v1/data_sources/{data_source_id}/connectors": { "post": { - "tags": [ - "data_sources", - "data_sources" - ], + "tags": ["data_sources", "data_sources"], "summary": "Create a new connector", "description": "Create a new connector.\n\nArgs:\n data_source_id: The ID of the data source to create a connector for.\n params: The connector to create.\n\nReturns:\n The created connector.", "operationId": "create_connector", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5244,38 +3522,23 @@ "201": { "description": "The created connector", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceConnector" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceConnector" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "data_sources", - "data_sources" - ], + "tags": ["data_sources", "data_sources"], "summary": "Get all connectors for a data source", "description": "Get all connectors for a data source.\n\nArgs:\n data_source_id: The ID of the data source to get connectors for.\n pagination: The pagination options.\n\nReturns:\n The list of connectors.", "operationId": "list_connectors", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5298,11 +3561,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -5313,18 +3572,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -5334,18 +3584,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -5357,10 +3598,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -5371,21 +3609,13 @@ "200": { "description": "The list of connectors", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConnectorListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -5393,18 +3623,11 @@ }, "/v1/data_sources/{data_source_id}/connectors/{connector_id}": { "get": { - "tags": [ - "data_sources", - "data_sources" - ], + "tags": ["data_sources", "data_sources"], "summary": "Get a connector by ID", "description": "Get a connector by ID.\n\nArgs:\n data_source_id: The ID of the data source to get a connector for.\n connector_id: The ID of the connector to get.\n\nReturns:\n The connector.", "operationId": "get_connector", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5435,38 +3658,23 @@ "200": { "description": "The connector", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceConnector" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceConnector" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "data_sources", - "data_sources" - ], + "tags": ["data_sources", "data_sources"], "summary": "Update a connector", "description": "Update a connector.\n\nArgs:\n data_source_id: The ID of the data source to update a connector for.\n connector_id: The ID of the connector to update.\n params: The connector to update.\n\nReturns:\n The updated connector.", "operationId": "update_connector", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5508,38 +3716,23 @@ "200": { "description": "The updated connector", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceConnector" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceConnector" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "data_sources", - "data_sources" - ], + "tags": ["data_sources", "data_sources"], "summary": "Delete a connector", "description": "Delete a connector.\n\nArgs:\n data_source_id: The ID of the data source to delete a connector for.\n connector_id: The ID of the connector to delete.\n\nReturns:\n The deleted connector.", "operationId": "delete_connector", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5570,21 +3763,13 @@ "200": { "description": "The deleted connector", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceConnectorDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceConnectorDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -5592,29 +3777,19 @@ }, "/v1/data_sources/": { "post": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Create a new data source", "description": "Create a new data source.\n\nArgs:\n params: The data source to create.\n\nReturns:\n The created data source.", "operationId": "create_data_source", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ - { - "$ref": "#/components/schemas/NotionDataSourceCreateOrUpdateParams" - }, - { - "$ref": "#/components/schemas/LinearDataSourceCreateOrUpdateParams" - } + { "$ref": "#/components/schemas/NotionDataSourceCreateOrUpdateParams" }, + { "$ref": "#/components/schemas/LinearDataSourceCreateOrUpdateParams" } ], "description": "The data source to create", "title": "Params" @@ -5625,38 +3800,22 @@ "responses": { "201": { "description": "The created data source", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSource" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSource" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Get all data sources", "description": "Get all data sources.\n\nReturns:\n The list of data sources.", "operationId": "list_data_sources", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "limit", @@ -5667,11 +3826,7 @@ "maximum": 100, "minimum": 1, "description": "Maximum number of items to return per page (1-100)", - "examples": [ - 10, - 20, - 50 - ], + "examples": [10, 20, 50], "default": 20, "title": "Limit" }, @@ -5682,18 +3837,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "After" }, "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response." @@ -5703,18 +3849,9 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ], + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="], "title": "Before" }, "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response." @@ -5726,10 +3863,7 @@ "schema": { "type": "boolean", "description": "Whether to include total count in response (expensive operation)", - "examples": [ - false, - true - ], + "examples": [false, true], "default": false, "title": "Include Total" }, @@ -5740,21 +3874,13 @@ "200": { "description": "The list of data sources", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceListResponse" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceListResponse" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -5762,17 +3888,11 @@ }, "/v1/data_sources/{data_source_id}": { "get": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Get a data source by ID", "description": "Get a data source by ID.\n\nArgs:\n data_source_id: The ID of the data source to fetch.\n\nReturns:\n The data source.", "operationId": "get_data_source", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5790,38 +3910,22 @@ "responses": { "200": { "description": "The data source", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSource" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSource" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Update a data source", "description": "Update a data source.\n\nArgs:\n data_source_id: The ID of the data source to update.\n params: The data source to update.\n\nReturns:\n The updated data source.", "operationId": "update_data_source", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5842,12 +3946,8 @@ "application/json": { "schema": { "anyOf": [ - { - "$ref": "#/components/schemas/NotionDataSourceCreateOrUpdateParams" - }, - { - "$ref": "#/components/schemas/LinearDataSourceCreateOrUpdateParams" - } + { "$ref": "#/components/schemas/NotionDataSourceCreateOrUpdateParams" }, + { "$ref": "#/components/schemas/LinearDataSourceCreateOrUpdateParams" } ], "description": "The data source to update", "title": "Params" @@ -5858,38 +3958,22 @@ "responses": { "200": { "description": "The updated data source", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSource" - } - } - } + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSource" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Delete a data source", "description": "Delete a data source.\n\nArgs:\n data_source_id: The ID of the data source to delete.", "operationId": "delete_data_source", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5908,21 +3992,13 @@ "200": { "description": "The ID of the deleted data source and if it was deleted successfully", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DataSourceDeleted" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceDeleted" } } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -5930,17 +4006,11 @@ }, "/v1/data_sources/{data_source_id}/oauth2/authorize": { "get": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "Authorize a data source", "description": "Start OAuth2 authorization flow for a data source.\n\nInitiates the OAuth2 authorization process by redirecting the user\nto the external service's authorization page. After authorization,\nthe user will be redirected back to the oauth2_callback endpoint.\n\nArgs:\n data_source_id: The ID of the data source to authorize\n\nReturns:\n Redirect to the OAuth2 provider's authorization page\n\nRaises:\n DataSourceNotFoundError: When data source doesn't exist\n DataSourceAuthTypeNotSupportedError: When OAuth2 is not supported for this data source type", "operationId": "authorize_data_source", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "data_source_id", @@ -5958,20 +4028,12 @@ "responses": { "200": { "description": "The authorization URL", - "content": { - "application/json": { - "schema": {} - } - } + "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -5979,17 +4041,11 @@ }, "/v1/data_sources/oauth2/callback": { "get": { - "tags": [ - "data_sources" - ], + "tags": ["data_sources"], "summary": "OAuth2 callback for data source authorization", "description": "OAuth2 callback endpoint for completing data source authorization.\n\nThis endpoint is called by OAuth2 providers after user authorization.\nIt exchanges the authorization code for access tokens and stores them\nsecurely for the data source.\n\nArgs:\n state: OAuth2 state parameter used for CSRF protection\n code: Authorization code from the OAuth2 provider\n error: OAuth2 error code if authorization was denied or failed\n error_description: Human-readable description of the error\n\nReturns:\n Redirect to the data source details page on success\n\nRaises:\n OAuth2TokenExchangeError: When OAuth2 provider returns an error\n InvalidStateError: When state parameter is invalid or expired", "operationId": "oauth2_callback", - "security": [ - { - "ApiKeyAuth": [] - } - ], + "security": [{ "ApiKeyAuth": [] }], "parameters": [ { "name": "state", @@ -6018,14 +4074,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "OAuth2 error code if authorization failed", "title": "Error" }, @@ -6036,14 +4085,7 @@ "in": "query", "required": false, "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Human-readable error description", "title": "Error Description" }, @@ -6053,26 +4095,14 @@ "responses": { "307": { "description": "Successful authorization, redirect to data source", - "content": { - "application/json": { - "schema": {} - } - } - }, - "400": { - "description": "OAuth2 error or invalid parameters" - }, - "404": { - "description": "Invalid or expired state parameter" + "content": { "application/json": { "schema": {} } } }, + "400": { "description": "OAuth2 error or invalid parameters" }, + "404": { "description": "Invalid or expired state parameter" }, "422": { "description": "Validation Error", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/HTTPValidationError" - } - } + "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } @@ -6100,16 +4130,7 @@ "default": 3 }, "instructions": { - "anyOf": [ - { - "type": "string", - "maxLength": 2000, - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" }], "title": "Instructions", "description": "Additional custom instructions (followed only when not in conflict with existing rules)" } @@ -6120,31 +4141,15 @@ }, "ApiKey": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the API key" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the API key" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the API key" }, + "name": { "type": "string", "title": "Name", "description": "The name of the API key" }, "redacted_value": { "type": "string", "title": "Redacted Value", "description": "The redacted value of the API key" }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "The expiration datetime of the API key" }, @@ -6161,15 +4166,7 @@ "description": "The last update datetime of the API key" }, "last_active_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Last Active At", "description": "The last active datetime of the API key" }, @@ -6182,49 +4179,25 @@ }, "scope": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Scope" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/Scope" }, "type": "array" }, + { "type": "null" } ], "title": "Scope", "description": "The scope of the API key" } }, "type": "object", - "required": [ - "id", - "name", - "redacted_value", - "created_at", - "updated_at" - ], + "required": ["id", "name", "redacted_value", "created_at", "updated_at"], "title": "ApiKey", "description": "Response model for an API key." }, "ApiKeyCreateOrUpdateParams": { "properties": { - "type": { - "type": "string", - "const": "api_key", - "title": "Type", - "default": "api_key" - }, - "api_key": { - "type": "string", - "title": "Api Key", - "description": "The API key" - } + "type": { "type": "string", "const": "api_key", "title": "Type", "default": "api_key" }, + "api_key": { "type": "string", "title": "Api Key", "description": "The API key" } }, "type": "object", - "required": [ - "api_key" - ], + "required": ["api_key"], "title": "ApiKeyCreateOrUpdateParams", "description": "Base class for API key create or update parameters." }, @@ -6238,29 +4211,14 @@ }, "scope": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Scope" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/Scope" }, "type": "array" }, + { "type": "null" } ], "title": "Scope", "description": "The scope of the API key" }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "Optional expiration datetime" } @@ -6271,31 +4229,15 @@ }, "ApiKeyCreated": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the API key" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the API key" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the API key" }, + "name": { "type": "string", "title": "Name", "description": "The name of the API key" }, "redacted_value": { "type": "string", "title": "Redacted Value", "description": "The redacted value of the API key" }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "The expiration datetime of the API key" }, @@ -6312,15 +4254,7 @@ "description": "The last update datetime of the API key" }, "last_active_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Last Active At", "description": "The last active datetime of the API key" }, @@ -6333,44 +4267,22 @@ }, "scope": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Scope" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/Scope" }, "type": "array" }, + { "type": "null" } ], "title": "Scope", "description": "The scope of the API key" }, - "value": { - "type": "string", - "title": "Value", - "description": "The value of the API key" - } + "value": { "type": "string", "title": "Value", "description": "The value of the API key" } }, "type": "object", - "required": [ - "id", - "name", - "redacted_value", - "created_at", - "updated_at", - "value" - ], + "required": ["id", "name", "redacted_value", "created_at", "updated_at", "value"], "title": "ApiKeyCreated", "description": "Response model for creating an API key." }, "ApiKeyDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the deleted API key" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the deleted API key" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -6385,18 +4297,13 @@ } }, "type": "object", - "required": [ - "id", - "deleted" - ], + "required": ["id", "deleted"], "title": "ApiKeyDeleted", "description": "Response model for deleting an API key." }, "ApiKeyListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/PaginationWithTotal" - }, + "pagination": { "$ref": "#/components/schemas/PaginationWithTotal" }, "object": { "type": "string", "const": "list", @@ -6405,45 +4312,25 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/ApiKey" - }, + "items": { "$ref": "#/components/schemas/ApiKey" }, "type": "array", "title": "Data", "description": "The list of API keys" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "ApiKeyListResponse" }, "ApiKeyUpdateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "A name/description for the API key" }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "Optional expiration datetime" } @@ -6454,94 +4341,18 @@ }, "AudioChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "audio", - "title": "Type", - "default": "audio" - }, - "file_type": { - "type": "string", - "title": "File Type", - "default": "audio/mpeg" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, + "type": { "type": "string", "const": "audio", "title": "Type", "default": "audio" }, + "file_type": { "type": "string", "title": "File Type", "default": "audio/mpeg" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, "total_duration_seconds": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Total Duration Seconds" }, - "sample_rate": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Sample Rate" - }, - "channels": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Channels" - }, - "audio_format": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Audio Format" - }, - "bpm": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Bpm" - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "sample_rate": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Sample Rate" }, + "channels": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Channels" }, + "audio_format": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Audio Format" }, + "bpm": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Bpm" }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", @@ -6556,9 +4367,7 @@ } }, "type": "object", - "required": [ - "url" - ], + "required": ["url"], "title": "AudioUrl", "description": "Model for audio URL validation." }, @@ -6568,48 +4377,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "audio/mpeg", - "examples": [ - "audio/mpeg" - ] + "examples": ["audio/mpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -6624,9 +4411,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -6641,20 +4426,10 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "type": { "type": "string", @@ -6664,44 +4439,19 @@ "default": "audio_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the audio", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the audio", - "examples": [ - "A financial report audio for 2025" - ] + "examples": ["A financial report audio for 2025"] }, "audio_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/AudioUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/AudioUrl" }, { "type": "null" }], "description": "Audio URL" }, "sampling_rate": { @@ -6711,10 +4461,7 @@ } }, "type": "object", - "required": [ - "chunk_index", - "sampling_rate" - ], + "required": ["chunk_index", "sampling_rate"], "title": "AudioUrlInputChunk" }, "BalanceInfo": { @@ -6730,15 +4477,7 @@ "description": "The next effective balance" }, "next_effective_date": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Next Effective Date", "description": "The next effective date" } @@ -6749,22 +4488,11 @@ }, "BillingPeriodSummary": { "properties": { - "period": { - "$ref": "#/components/schemas/Period", - "description": "The billing period" - }, - "cost": { - "$ref": "#/components/schemas/CostInfo", - "description": "The cost information" - }, - "balance": { - "$ref": "#/components/schemas/BalanceInfo", - "description": "The balance information" - }, + "period": { "$ref": "#/components/schemas/Period", "description": "The billing period" }, + "cost": { "$ref": "#/components/schemas/CostInfo", "description": "The cost information" }, + "balance": { "$ref": "#/components/schemas/BalanceInfo", "description": "The balance information" }, "usages": { - "additionalProperties": { - "$ref": "#/components/schemas/UsageInfo" - }, + "additionalProperties": { "$ref": "#/components/schemas/UsageInfo" }, "type": "object", "title": "Usages", "description": "The monthly usages information per metric" @@ -6777,13 +4505,7 @@ } }, "type": "object", - "required": [ - "period", - "cost", - "balance", - "usages", - "generated_at" - ], + "required": ["period", "cost", "balance", "usages", "generated_at"], "title": "BillingPeriodSummary", "description": "High level billing summary for the currently active period." }, @@ -6797,9 +4519,7 @@ } }, "type": "object", - "required": [ - "file" - ], + "required": ["file"], "title": "Body_create_file" }, "Body_update_file": { @@ -6812,9 +4532,7 @@ } }, "type": "object", - "required": [ - "file" - ], + "required": ["file"], "title": "Body_update_file" }, "Body_upload_store_file": { @@ -6825,35 +4543,16 @@ "title": "File", "description": "The file to upload and index" }, - "params": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Params" - } + "params": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Params" } }, "type": "object", - "required": [ - "file" - ], + "required": ["file"], "title": "Body_upload_store_file" }, "Chunk": { "properties": { "content": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Content", "description": "The full content of the chunk" }, @@ -6863,19 +4562,14 @@ "description": "The content of the chunk to embed" }, "elements": { - "items": { - "$ref": "#/components/schemas/ChunkElement" - }, + "items": { "$ref": "#/components/schemas/ChunkElement" }, "type": "array", "title": "Elements", "description": "List of elements contained in this chunk" } }, "type": "object", - "required": [ - "content_to_embed", - "elements" - ], + "required": ["content_to_embed", "elements"], "title": "Chunk", "description": "A chunk of text extracted from a document page." }, @@ -6894,18 +4588,10 @@ }, "bbox": { "prefixItems": [ - { - "type": "number" - }, - { - "type": "number" - }, - { - "type": "number" - }, - { - "type": "number" - } + { "type": "number" }, + { "type": "number" }, + { "type": "number" }, + { "type": "number" } ], "type": "array", "maxItems": 4, @@ -6925,48 +4611,24 @@ "description": "The extracted text content of the element" }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "A brief summary of the element's content" }, "image": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Image", "description": "The base64-encoded image data for figure elements" } }, "type": "object", - "required": [ - "type", - "confidence", - "bbox", - "page", - "content" - ], + "required": ["type", "confidence", "bbox", "page", "content"], "title": "ChunkElement", "description": "Represents an extracted element from a document with its content and metadata." }, "ChunkSearchResultRule": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query to trigger the rule" - }, + "query": { "type": "string", "title": "Query", "description": "The query to trigger the rule" }, "store_id": { "type": "string", "title": "Store Id", @@ -6997,105 +4659,36 @@ } }, "type": "object", - "required": [ - "query", - "store_id", - "type", - "file_id", - "chunk_index", - "result_index" - ], + "required": ["query", "store_id", "type", "file_id", "chunk_index", "result_index"], "title": "ChunkSearchResultRule", "description": "Represents a chunk search result rule for a vector store search." }, "ChunkingStrategy": { "type": "string", - "enum": [ - "page" - ], + "enum": ["page"], "title": "ChunkingStrategy", "description": "Strategy used for chunking document content." }, "CodeChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "code", - "title": "Type", - "default": "code" - }, - "file_type": { - "type": "string", - "title": "File Type" - }, - "language": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Language" - }, - "word_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Word Count" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, - "start_line": { - "type": "integer", - "title": "Start Line", - "default": 0 - }, - "num_lines": { - "type": "integer", - "title": "Num Lines", - "default": 0 - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "type": { "type": "string", "const": "code", "title": "Type", "default": "code" }, + "file_type": { "type": "string", "title": "File Type" }, + "language": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Language" }, + "word_count": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Word Count" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, + "start_line": { "type": "integer", "title": "Start Line", "default": 0 }, + "num_lines": { "type": "integer", "title": "Num Lines", "default": 0 }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", - "required": [ - "file_type" - ], + "required": ["file_type"], "title": "CodeChunkGeneratedMetadata" }, "CompleteMultipartUploadRequest": { "properties": { "parts": { - "items": { - "$ref": "#/components/schemas/MultipartUploadPart" - }, + "items": { "$ref": "#/components/schemas/MultipartUploadPart" }, "type": "array", "minItems": 1, "title": "Parts", @@ -7103,9 +4696,7 @@ } }, "type": "object", - "required": [ - "parts" - ], + "required": ["parts"], "title": "CompleteMultipartUploadRequest" }, "ConditionOperator": { @@ -7129,13 +4720,9 @@ }, "ConnectorListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "data": { - "items": { - "$ref": "#/components/schemas/DataSourceConnector" - }, + "items": { "$ref": "#/components/schemas/DataSourceConnector" }, "type": "array", "title": "Data", "description": "The list of connectors" @@ -7149,40 +4736,18 @@ } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "ConnectorListResponse", "description": "A list of connectors with pagination." }, "ContextualizationConfig": { "properties": { "with_metadata": { - "anyOf": [ - { - "type": "boolean" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], + "anyOf": [{ "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }], "title": "With Metadata", "description": "Include all metadata or specific fields in the contextualization. Supports dot notation for nested fields (e.g., 'author.name'). When True, all metadata is included (flattened). When a list, only specified fields are included.", "default": false, - "examples": [ - true, - false, - [ - "title", - "author.name", - "author.email", - "tags" - ] - ] + "examples": [true, false, ["title", "author.name", "author.email", "tags"]] } }, "type": "object", @@ -7191,9 +4756,7 @@ "CostHistogramResponse": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/DailyCostBucket" - }, + "items": { "$ref": "#/components/schemas/DailyCostBucket" }, "type": "array", "title": "Data", "description": "The histogram of cost information" @@ -7207,9 +4770,7 @@ } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "CostHistogramResponse" }, "CostInfo": { @@ -7236,18 +4797,14 @@ "default": "0" }, "phases": { - "items": { - "$ref": "#/components/schemas/PhaseCostInfo" - }, + "items": { "$ref": "#/components/schemas/PhaseCostInfo" }, "type": "array", "title": "Phases", "description": "The cost for each phase in descending order of end date", "default": [] }, "products": { - "items": { - "$ref": "#/components/schemas/ProductCostInfo" - }, + "items": { "$ref": "#/components/schemas/ProductCostInfo" }, "type": "array", "title": "Products", "description": "The cost for each product. Store, Parsing, Reranking, Embeddings", @@ -7265,27 +4822,21 @@ "minLength": 1, "title": "Filename", "description": "Name of the file including extension", - "examples": [ - "document.pdf" - ] + "examples": ["document.pdf"] }, "file_size": { "type": "integer", "exclusiveMinimum": 0, "title": "File Size", "description": "Total size of the file in bytes", - "examples": [ - 10485760 - ] + "examples": [10485760] }, "mime_type": { "type": "string", "pattern": "^[\\w\\.\\-\\+]+/[\\w\\.\\-\\+]+(\\.\\w+)*$", "title": "Mime Type", "description": "MIME type of the file", - "examples": [ - "application/pdf" - ] + "examples": ["application/pdf"] }, "part_count": { "type": "integer", @@ -7294,17 +4845,11 @@ "title": "Part Count", "description": "Number of parts to split the upload into", "default": 1, - "examples": [ - 3 - ] + "examples": [3] } }, "type": "object", - "required": [ - "filename", - "file_size", - "mime_type" - ], + "required": ["filename", "file_size", "mime_type"], "title": "CreateMultipartUploadRequest" }, "CreateMultipartUploadResponse": { @@ -7315,19 +4860,14 @@ "description": "The multipart upload ID (use this to complete or abort)" }, "part_urls": { - "items": { - "$ref": "#/components/schemas/MultipartUploadPartUrl" - }, + "items": { "$ref": "#/components/schemas/MultipartUploadPartUrl" }, "type": "array", "title": "Part Urls", "description": "Presigned URLs for uploading parts" } }, "type": "object", - "required": [ - "id", - "part_urls" - ], + "required": ["id", "part_urls"], "title": "CreateMultipartUploadResponse" }, "CreatedJsonSchema": { @@ -7340,9 +4880,7 @@ } }, "type": "object", - "required": [ - "json_schema" - ], + "required": ["json_schema"], "title": "CreatedJsonSchema", "description": "Result of creating a JSON schema." }, @@ -7352,67 +4890,29 @@ "type": "boolean", "title": "Has More", "description": "Contextual direction-aware flag: True if more items exist in the requested pagination direction. For 'after': more items after this page. For 'before': more items before this page.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "first_cursor": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "First Cursor", "description": "Cursor of the first item in this page. Use for backward pagination. None if page is empty.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==", - null - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==", null] }, "last_cursor": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Last Cursor", "description": "Cursor of the last item in this page. Use for forward pagination. None if page is empty.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==", - null - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMFQyMzo1OTo1OS4wMDBaIiwiaWQiOiJ4eXo3ODkifQ==", null] }, "total": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Total", "description": "Total number of items available across all pages. Only included when include_total=true was requested. Expensive operation - use sparingly.", - "examples": [ - 42, - 0, - null - ] + "examples": [42, 0, null] } }, "type": "object", - "required": [ - "has_more", - "first_cursor", - "last_cursor" - ], + "required": ["has_more", "first_cursor", "last_cursor"], "title": "CursorPaginationResponse", "description": "Response model for cursor-based pagination." }, @@ -7431,31 +4931,20 @@ "description": "The cost of the cost bucket" }, "cost_per_metric": { - "additionalProperties": { - "type": "string", - "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" - }, + "additionalProperties": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, "type": "object", "title": "Cost Per Metric", "description": "The cost per metric" } }, "type": "object", - "required": [ - "day", - "cost", - "cost_per_metric" - ], + "required": ["day", "cost", "cost_per_metric"], "title": "DailyCostBucket", "description": "Daily cost bucket." }, "DataSource": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the data source" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the data source" }, "created_at": { "type": "string", "format": "date-time", @@ -7468,22 +4957,10 @@ "title": "Updated At", "description": "The last update time of the data source" }, - "type": { - "$ref": "#/components/schemas/DataSourceType", - "description": "The type of data source" - }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the data source" - }, + "type": { "$ref": "#/components/schemas/DataSourceType", "description": "The type of data source" }, + "name": { "type": "string", "title": "Name", "description": "The name of the data source" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "The metadata of the data source" }, @@ -7491,12 +4968,8 @@ "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/DataSourceOAuth2Params" - }, - { - "$ref": "#/components/schemas/DataSourceApiKeyParams" - } + { "$ref": "#/components/schemas/DataSourceOAuth2Params" }, + { "$ref": "#/components/schemas/DataSourceApiKeyParams" } ], "discriminator": { "propertyName": "type", @@ -7506,9 +4979,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Auth Params", "description": "Authentication parameters" @@ -7522,46 +4993,23 @@ } }, "type": "object", - "required": [ - "id", - "created_at", - "updated_at", - "type", - "name", - "metadata", - "auth_params" - ], + "required": ["id", "created_at", "updated_at", "type", "name", "metadata", "auth_params"], "title": "DataSource", "description": "Service-level representation of a data source." }, "DataSourceApiKeyParams": { "properties": { - "type": { - "type": "string", - "const": "api_key", - "title": "Type", - "default": "api_key" - }, - "api_key": { - "type": "string", - "title": "Api Key", - "description": "The API key" - } + "type": { "type": "string", "const": "api_key", "title": "Type", "default": "api_key" }, + "api_key": { "type": "string", "title": "Api Key", "description": "The API key" } }, "type": "object", - "required": [ - "api_key" - ], + "required": ["api_key"], "title": "DataSourceApiKeyParams", "description": "Authentication parameters for a API key data source." }, "DataSourceConnector": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the connector" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the connector" }, "created_at": { "type": "string", "format": "date-time", @@ -7574,11 +5022,7 @@ "title": "Updated At", "description": "The last update time of the connector" }, - "store_id": { - "type": "string", - "title": "Store Id", - "description": "The ID of the store" - }, + "store_id": { "type": "string", "title": "Store Id", "description": "The ID of the store" }, "data_source_id": { "type": "string", "title": "Data Source Id", @@ -7591,12 +5035,7 @@ "default": "New Connector" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "The metadata of the connector" }, @@ -7607,41 +5046,17 @@ "description": "The polling interval of the connector" }, "started_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Started At", "description": "The start time of the connector" }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished At", "description": "The finish time of the connector" }, "last_synced_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Last Synced At", "description": "The last sync time of the connector" }, @@ -7650,15 +5065,7 @@ "description": "The sync status of the connector" }, "error": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Error", "description": "The sync error of the connector" }, @@ -7690,11 +5097,7 @@ }, "DataSourceConnectorCreateParams": { "properties": { - "store_id": { - "type": "string", - "title": "Store Id", - "description": "The ID of the store" - }, + "store_id": { "type": "string", "title": "Store Id", "description": "The ID of the store" }, "name": { "type": "string", "title": "Name", @@ -7708,51 +5111,25 @@ "default": true }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "The metadata of the connector" }, "polling_interval": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "string" }, { "type": "null" }], "title": "Polling Interval", "description": "Polling interval for the connector. Defaults to 30 minutes if not specified. Can be provided as:\n- int: Number of seconds (e.g., 1800 for 30 minutes)\n- str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g., 'PT30M', 'P1D')\nValid range: 15 seconds to 30 days", - "examples": [ - 1800, - "30m", - "1h", - "PT30M" - ] + "examples": [1800, "30m", "1h", "PT30M"] } }, "type": "object", - "required": [ - "store_id" - ], + "required": ["store_id"], "title": "DataSourceConnectorCreateParams", "description": "Parameters for creating a connector." }, "DataSourceConnectorDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the connector" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the connector" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -7768,71 +5145,32 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "DataSourceConnectorDeleted", "description": "Deleted connector." }, "DataSourceConnectorUpdateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "The name of the connector" }, "metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Metadata", "description": "The metadata of the connector" }, "trigger_sync": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Trigger Sync", "description": "Whether the connector should be synced after update" }, "polling_interval": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "string" }, { "type": "null" }], "title": "Polling Interval", "description": "Polling interval for the connector. Defaults to 30 minutes if not specified. Can be provided as:\n- int: Number of seconds (e.g., 1800 for 30 minutes)\n- str: Duration string (e.g., '30m', '1h', '2d') or ISO 8601 format (e.g., 'PT30M', 'P1D')\nValid range: 15 seconds to 30 days", - "examples": [ - 1800, - "30m", - "1h", - "PT30M" - ] + "examples": [1800, "30m", "1h", "PT30M"] } }, "type": "object", @@ -7841,11 +5179,7 @@ }, "DataSourceDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the data source" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the data source" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -7861,21 +5195,15 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "DataSourceDeleted", "description": "Deleted data source." }, "DataSourceListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "data": { - "items": { - "$ref": "#/components/schemas/DataSource" - }, + "items": { "$ref": "#/components/schemas/DataSource" }, "type": "array", "title": "Data", "description": "The list of data sources" @@ -7889,21 +5217,13 @@ } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "DataSourceListResponse", "description": "A list of data sources with pagination." }, "DataSourceOAuth2Params": { "properties": { - "type": { - "type": "string", - "const": "oauth2", - "title": "Type", - "default": "oauth2" - }, + "type": { "type": "string", "const": "oauth2", "title": "Type", "default": "oauth2" }, "created_at": { "type": "string", "format": "date-time", @@ -7911,77 +5231,33 @@ "description": "The timestamp when the OAuth2 credentials were created" }, "scope": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Scope", "description": "The OAuth2 scope", "default": "read" }, "access_token": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Access Token", "description": "The OAuth2 access token" }, "refresh_token": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Refresh Token", "description": "The OAuth2 refresh token" }, "token_type": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Token Type", "description": "The OAuth2 token type" }, "expires_on": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires On", "description": "The OAuth2 token expiration timestamp" }, "additional_params": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Additional Params", "description": "Additional parameters for the OAuth2 flow" } @@ -7990,23 +5266,11 @@ "title": "DataSourceOAuth2Params", "description": "Authentication parameters for a OAuth data source." }, - "DataSourceType": { - "type": "string", - "enum": [ - "notion", - "linear" - ], - "title": "DataSourceType" - }, + "DataSourceType": { "type": "string", "enum": ["notion", "linear"], "title": "DataSourceType" }, "DeprecatedStoreFileUpsertParams": { "properties": { "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional metadata for the file" }, @@ -8015,14 +5279,7 @@ "description": "Configuration for adding the file" }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "External identifier for this file in the store" }, @@ -8031,10 +5288,7 @@ "title": "Overwrite", "description": "If true, overwrite an existing file with the same external_id", "default": true, - "examples": [ - false, - true - ] + "examples": [false, true] }, "file_id": { "type": "string", @@ -8043,22 +5297,13 @@ "description": "ID of the file to add" }, "experimental": { - "anyOf": [ - { - "$ref": "#/components/schemas/StoreFileConfig" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/StoreFileConfig" }, { "type": "null" }], "description": "Strategy for adding the file. This field is deprecated. Please use the top-level 'config' field instead. If this is provided, it will override the top-level 'config' field.", "deprecated": true } }, "type": "object", - "required": [ - "file_id" - ], + "required": ["file_id"], "title": "DeprecatedStoreFileUpsertParams" }, "DocumentParserResult": { @@ -8072,31 +5317,20 @@ "description": "The format of the returned content" }, "element_types": { - "items": { - "$ref": "#/components/schemas/ElementType" - }, + "items": { "$ref": "#/components/schemas/ElementType" }, "type": "array", "title": "Element Types", "description": "The types of elements extracted" }, "chunks": { - "items": { - "$ref": "#/components/schemas/Chunk" - }, + "items": { "$ref": "#/components/schemas/Chunk" }, "type": "array", "title": "Chunks", "description": "List of extracted chunks from the document" }, "page_sizes": { "items": { - "prefixItems": [ - { - "type": "integer" - }, - { - "type": "integer" - } - ], + "prefixItems": [{ "type": "integer" }, { "type": "integer" }], "type": "array", "maxItems": 2, "minItems": 2 @@ -8107,12 +5341,7 @@ } }, "type": "object", - "required": [ - "chunking_strategy", - "return_format", - "element_types", - "chunks" - ], + "required": ["chunking_strategy", "return_format", "element_types", "chunks"], "title": "DocumentParserResult", "description": "Result of document parsing operation." }, @@ -8144,9 +5373,7 @@ "type": "integer", "title": "Index", "description": "The index of the embedding.", - "examples": [ - 0 - ] + "examples": [0] }, "object": { "type": "string", @@ -8154,16 +5381,11 @@ "title": "Object", "description": "The object type of the embedding.", "default": "embedding", - "examples": [ - "embedding" - ] + "examples": ["embedding"] } }, "type": "object", - "required": [ - "embedding", - "index" - ], + "required": ["embedding", "index"], "title": "Embedding" }, "EmbeddingCreateParams": { @@ -8174,100 +5396,48 @@ "minLength": 1, "title": "Model", "description": "The model to use for creating embeddings.", - "examples": [ - "mixedbread-ai/mxbai-embed-large-v1" - ] + "examples": ["mixedbread-ai/mxbai-embed-large-v1"] }, "input": { "anyOf": [ - { - "type": "string", - "maxLength": 64000, - "minLength": 1 - }, - { - "items": { - "type": "string" - }, - "type": "array", - "maxItems": 256, - "minItems": 1 - } + { "type": "string", "maxLength": 64000, "minLength": 1 }, + { "items": { "type": "string" }, "type": "array", "maxItems": 256, "minItems": 1 } ], "title": "Input", "description": "The input to create embeddings for." }, "dimensions": { - "anyOf": [ - { - "type": "integer", - "exclusiveMinimum": 0 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" }], "title": "Dimensions", "description": "The number of dimensions to use for the embeddings.", - "examples": [ - 768 - ] + "examples": [768] }, "prompt": { - "anyOf": [ - { - "type": "string", - "maxLength": 32000, - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "maxLength": 32000, "minLength": 1 }, { "type": "null" }], "title": "Prompt", "description": "The prompt to use for the embedding creation.", - "examples": [ - "Provide a detailed summary of the following text." - ] + "examples": ["Provide a detailed summary of the following text."] }, "normalized": { "type": "boolean", "title": "Normalized", "description": "Whether to normalize the embeddings.", "default": true, - "examples": [ - true - ] + "examples": [true] }, "encoding_format": { "anyOf": [ - { - "$ref": "#/components/schemas/EncodingFormat" - }, - { - "items": { - "$ref": "#/components/schemas/EncodingFormat" - }, - "type": "array" - } + { "$ref": "#/components/schemas/EncodingFormat" }, + { "items": { "$ref": "#/components/schemas/EncodingFormat" }, "type": "array" } ], "title": "Encoding Format", "description": "The encoding format(s) of the embeddings. Can be a single format or a list of formats.", "default": "float", - "examples": [ - "float", - [ - "int8", - "float" - ] - ] + "examples": ["float", ["int8", "float"]] } }, "type": "object", - "required": [ - "model", - "input" - ], + "required": ["model", "input"], "title": "EmbeddingCreateParams", "description": "Parameters for creating embeddings." }, @@ -8276,33 +5446,13 @@ "usage": { "$ref": "#/components/schemas/Usage", "description": "The usage of the model", - "examples": [ - { - "completion_tokens": 10, - "prompt_tokens": 10, - "total_tokens": 20 - } - ] - }, - "model": { - "type": "string", - "title": "Model", - "description": "The model used" + "examples": [{ "completion_tokens": 10, "prompt_tokens": 10, "total_tokens": 20 }] }, + "model": { "type": "string", "title": "Model", "description": "The model used" }, "data": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/Embedding" - }, - "type": "array" - }, - { - "items": { - "$ref": "#/components/schemas/MultiEncodingEmbedding" - }, - "type": "array" - } + { "items": { "$ref": "#/components/schemas/Embedding" }, "type": "array" }, + { "items": { "$ref": "#/components/schemas/MultiEncodingEmbedding" }, "type": "array" } ], "title": "Data", "description": "The created embeddings." @@ -8318,92 +5468,41 @@ "type": "boolean", "title": "Normalized", "description": "Whether the embeddings are normalized.", - "examples": [ - true - ] + "examples": [true] }, "encoding_format": { "anyOf": [ - { - "$ref": "#/components/schemas/EncodingFormat" - }, - { - "items": { - "$ref": "#/components/schemas/EncodingFormat" - }, - "type": "array" - } + { "$ref": "#/components/schemas/EncodingFormat" }, + { "items": { "$ref": "#/components/schemas/EncodingFormat" }, "type": "array" } ], "title": "Encoding Format", "description": "The encoding formats of the embeddings.", - "examples": [ - "float" - ] + "examples": ["float"] }, "dimensions": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Dimensions", "description": "The number of dimensions used for the embeddings.", - "examples": [ - 768 - ] + "examples": [768] } }, "type": "object", - "required": [ - "usage", - "model", - "data", - "normalized", - "encoding_format", - "dimensions" - ], + "required": ["usage", "model", "data", "normalized", "encoding_format", "dimensions"], "title": "EmbeddingCreateResponse" }, "EmbeddingItem": { "anyOf": [ - { - "items": { - "type": "number" - }, - "type": "array" - }, - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "string" - } + { "items": { "type": "number" }, "type": "array" }, + { "items": { "type": "integer" }, "type": "array" }, + { "type": "string" } ], "title": "EmbeddingItem", "description": "The encoded embedding data by encoding format.", - "examples": [ - 0.1, - 0.2, - 0.3 - ] + "examples": [0.1, 0.2, 0.3] }, "EncodingFormat": { "type": "string", - "enum": [ - "float", - "float16", - "base64", - "binary", - "ubinary", - "int8", - "uint8" - ], + "enum": ["float", "float16", "base64", "binary", "ubinary", "int8", "uint8"], "title": "EncodingFormat", "description": "Enumeration of encoding formats." }, @@ -8417,22 +5516,14 @@ } }, "type": "object", - "required": [ - "json_schema" - ], + "required": ["json_schema"], "title": "EnhancedJsonSchema", "description": "Result of enhancing a JSON schema." }, "ErrorResponse": { - "properties": { - "error": { - "$ref": "#/components/schemas/InnerErrorResponse" - } - }, + "properties": { "error": { "$ref": "#/components/schemas/InnerErrorResponse" } }, "type": "object", - "required": [ - "error" - ], + "required": ["error"], "title": "ErrorResponse", "description": "Error Pydantic Response Service Message" }, @@ -8460,24 +5551,13 @@ "properties": { "content": { "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - }, + { "type": "string" }, + { "items": { "type": "string" }, "type": "array" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/TextInput" - }, - { - "$ref": "#/components/schemas/ImageUrlInput" - } + { "$ref": "#/components/schemas/TextInput" }, + { "$ref": "#/components/schemas/ImageUrlInput" } ] }, "type": "array" @@ -8494,23 +5574,13 @@ "description": "The JSON schema to use for extraction" }, "instructions": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Instructions", "description": "Additional instructions for the extraction" } }, "type": "object", - "required": [ - "content", - "json_schema" - ], + "required": ["content", "json_schema"], "title": "ExtractContentCreateParams", "description": "Parameters for extracting content using a schema." }, @@ -8529,10 +5599,7 @@ } }, "type": "object", - "required": [ - "file_id", - "json_schema" - ], + "required": ["file_id", "json_schema"], "title": "ExtractJobCreateParams", "description": "Parameters for creating an extraction job." }, @@ -8569,28 +5636,12 @@ "description": "When the job was last updated" }, "started_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Started At", "description": "When the job started processing" }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished At", "description": "When the job finished processing" }, @@ -8599,26 +5650,11 @@ "description": "Current status of the job" }, "result": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExtractionResult" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExtractionResult" }, { "type": "null" }], "description": "The extraction results if completed" }, "error": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Error", "description": "Error information if failed" }, @@ -8648,24 +5684,11 @@ }, "ExtractionResult": { "properties": { - "data": { - "additionalProperties": true, - "type": "object", - "title": "Data" - }, - "warnings": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Warnings" - } + "data": { "additionalProperties": true, "type": "object", "title": "Data" }, + "warnings": { "items": { "type": "string" }, "type": "array", "title": "Warnings" } }, "type": "object", - "required": [ - "data", - "warnings" - ], + "required": ["data", "warnings"], "title": "ExtractionResult", "description": "The result of an extraction job." }, @@ -8676,54 +5699,42 @@ "title": "Pending", "description": "Number of files waiting to be processed", "default": 0, - "examples": [ - 5 - ] + "examples": [5] }, "in_progress": { "type": "integer", "title": "In Progress", "description": "Number of files currently being processed", "default": 0, - "examples": [ - 5 - ] + "examples": [5] }, "cancelled": { "type": "integer", "title": "Cancelled", "description": "Number of files whose processing was cancelled", "default": 0, - "examples": [ - 2 - ] + "examples": [2] }, "completed": { "type": "integer", "title": "Completed", "description": "Number of successfully processed files", "default": 0, - "examples": [ - 42 - ] + "examples": [42] }, "failed": { "type": "integer", "title": "Failed", "description": "Number of files that failed processing", "default": 0, - "examples": [ - 1 - ] + "examples": [1] }, "total": { "type": "integer", "title": "Total", "description": "Total number of files", "default": 0, - "examples": [ - 50 - ] + "examples": [50] } }, "type": "object", @@ -8732,11 +5743,7 @@ }, "FileDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the deleted file" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the deleted file" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -8752,16 +5759,12 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "FileDeleted" }, "FileListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -8770,19 +5773,14 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/FileObject" - }, + "items": { "$ref": "#/components/schemas/FileObject" }, "type": "array", "title": "Data", "description": "The list of files" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "FileListResponse" }, "FileObject": { @@ -8791,30 +5789,21 @@ "type": "string", "title": "Id", "description": "Unique identifier for the file", - "examples": [ - "file_abc123", - "file_xyz789" - ] + "examples": ["file_abc123", "file_xyz789"] }, "filename": { "type": "string", "minLength": 1, "title": "Filename", "description": "Name of the file including extension", - "examples": [ - "document.pdf", - "image.jpg" - ] + "examples": ["document.pdf", "image.jpg"] }, "bytes": { "type": "integer", "exclusiveMinimum": 0, "title": "Bytes", "description": "Size of the file in bytes", - "examples": [ - 1024, - 2048 - ] + "examples": [1024, 2048] }, "mime_type": { "type": "string", @@ -8833,10 +5822,7 @@ "minimum": 1, "title": "Version", "description": "Version of the file", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "created_at": { "type": "string", @@ -8852,25 +5838,13 @@ } }, "type": "object", - "required": [ - "id", - "filename", - "bytes", - "mime_type", - "version", - "created_at", - "updated_at" - ], + "required": ["id", "filename", "bytes", "mime_type", "version", "created_at", "updated_at"], "title": "FileObject", "description": "A model representing a file object in the system.\n\nThis model contains metadata about files stored in the system, including\nidentifiers, size information, and timestamps." }, "FileSearchResultRule": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query to trigger the rule" - }, + "query": { "type": "string", "title": "Query", "description": "The query to trigger the rule" }, "store_id": { "type": "string", "title": "Store Id", @@ -8902,22 +5876,14 @@ } }, "type": "object", - "required": [ - "query", - "store_id", - "type", - "file_id", - "result_index" - ], + "required": ["query", "store_id", "type", "file_id", "result_index"], "title": "FileSearchResultRule", "description": "Represents a file search result rule for a vector store search." }, "HTTPValidationError": { "properties": { "detail": { - "items": { - "$ref": "#/components/schemas/ValidationError" - }, + "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } @@ -8927,61 +5893,12 @@ }, "ImageChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "image", - "title": "Type", - "default": "image" - }, - "file_type": { - "type": "string", - "title": "File Type", - "default": "image/jpeg" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, - "width": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Width" - }, - "height": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Height" - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "type": { "type": "string", "const": "image", "title": "Type", "default": "image" }, + "file_type": { "type": "string", "title": "File Type", "default": "image/jpeg" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, + "width": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Width" }, + "height": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Height" }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", @@ -8991,12 +5908,7 @@ "properties": { "url": { "anyOf": [ - { - "type": "string", - "maxLength": 2083, - "minLength": 1, - "format": "uri" - }, + { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri" }, { "type": "string", "pattern": "data:(?P[\\w]+\\/[\\w\\-\\+\\.]+)?(?:\\;name\\=(?P[\\w\\.\\-%!*'~\\(\\)]+))?(?:\\;charset\\=(?P[\\w\\-\\+\\.]+))?(?P\\;base64)?,(?P.*)", @@ -9016,9 +5928,7 @@ } }, "type": "object", - "required": [ - "url" - ], + "required": ["url"], "title": "ImageUrl", "description": "Model for image URL validation." }, @@ -9037,9 +5947,7 @@ } }, "type": "object", - "required": [ - "url" - ], + "required": ["url"], "title": "ImageUrl", "description": "Model for image URL validation." }, @@ -9058,9 +5966,7 @@ } }, "type": "object", - "required": [ - "image_url" - ], + "required": ["image_url"], "title": "ImageUrlInput", "description": "Model for image input validation." }, @@ -9070,48 +5976,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "image/jpeg", - "examples": [ - "image/jpeg" - ] + "examples": ["image/jpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -9126,9 +6010,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -9143,20 +6025,10 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "type": { "type": "string", @@ -9166,96 +6038,44 @@ "default": "image_url" }, "ocr_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ocr Text", "description": "ocr text of the image", - "examples": [ - "2025 Financial Report" - ] + "examples": ["2025 Financial Report"] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the image", - "examples": [ - "A financial report for 2025" - ] + "examples": ["A financial report for 2025"] }, "image_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/ImageUrl-Output" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ImageUrl-Output" }, { "type": "null" }], "description": "Image URL" } }, "type": "object", - "required": [ - "chunk_index" - ], + "required": ["chunk_index"], "title": "ImageUrlInputChunk" }, "InfoResponse": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "version": { - "type": "string", - "title": "Version" - } + "name": { "type": "string", "title": "Name" }, + "version": { "type": "string", "title": "Version" } }, "type": "object", - "required": [ - "name", - "version" - ], + "required": ["name", "version"], "title": "InfoResponse", "description": "Info Pydantic Response Service Message" }, "InnerErrorResponse": { "properties": { - "message": { - "type": "string", - "title": "Message", - "description": "The error message" - }, - "code": { - "type": "integer", - "title": "Code", - "description": "The error code" - }, - "type": { - "type": "string", - "title": "Type", - "description": "The error type" - } + "message": { "type": "string", "title": "Message", "description": "The error message" }, + "code": { "type": "integer", "title": "Code", "description": "The error code" }, + "type": { "type": "string", "title": "Type", "description": "The error type" } }, "type": "object", - "required": [ - "message", - "code", - "type" - ], + "required": ["message", "code", "type"], "title": "InnerErrorResponse", "description": "Inner Error Pydantic Response Service Message" }, @@ -9268,9 +6088,7 @@ } }, "type": "object", - "required": [ - "description" - ], + "required": ["description"], "title": "JsonSchemaCreateParams", "description": "Parameters for creating a JSON schema." }, @@ -9284,9 +6102,7 @@ } }, "type": "object", - "required": [ - "json_schema" - ], + "required": ["json_schema"], "title": "JsonSchemaEnhanceParams", "description": "Parameters for enhancing a JSON schema." }, @@ -9300,9 +6116,7 @@ } }, "type": "object", - "required": [ - "json_schema" - ], + "required": ["json_schema"], "title": "JsonSchemaValidateParams", "description": "Parameters for validating a JSON schema." }, @@ -9315,138 +6129,61 @@ "description": "The type of data source to create", "default": "linear" }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the data source" - }, + "name": { "type": "string", "title": "Name", "description": "The name of the data source" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "The metadata of the data source" }, "auth_params": { "anyOf": [ { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuth2CreateOrUpdateParams" - } - ], + "oneOf": [{ "$ref": "#/components/schemas/OAuth2CreateOrUpdateParams" }], "discriminator": { "propertyName": "type", - "mapping": { - "oauth2": "#/components/schemas/OAuth2CreateOrUpdateParams" - } + "mapping": { "oauth2": "#/components/schemas/OAuth2CreateOrUpdateParams" } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Auth Params", "description": "The authentication parameters of the data source. Linear only supports OAuth2." } }, "type": "object", - "required": [ - "name" - ], + "required": ["name"], "title": "LinearDataSourceCreateOrUpdateParams", "description": "Parameters for creating or updating a Linear data source." }, "MarkdownChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "markdown", - "title": "Type", - "default": "markdown" - }, + "type": { "type": "string", "const": "markdown", "title": "Type", "default": "markdown" }, "file_type": { "type": "string", "const": "text/markdown", "title": "File Type", "default": "text/markdown" }, - "language": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Language" - }, - "word_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Word Count" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, + "language": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Language" }, + "word_count": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Word Count" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, "chunk_headings": { - "items": { - "$ref": "#/components/schemas/MarkdownHeading" - }, + "items": { "$ref": "#/components/schemas/MarkdownHeading" }, "type": "array", "title": "Chunk Headings" }, "heading_context": { - "items": { - "$ref": "#/components/schemas/MarkdownHeading" - }, + "items": { "$ref": "#/components/schemas/MarkdownHeading" }, "type": "array", "title": "Heading Context" }, - "start_line": { - "type": "integer", - "title": "Start Line", - "default": 0 - }, - "num_lines": { - "type": "integer", - "title": "Num Lines", - "default": 0 - }, + "start_line": { "type": "integer", "title": "Start Line", "default": 0 }, + "num_lines": { "type": "integer", "title": "Num Lines", "default": 0 }, "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" }, - "frontmatter": { - "additionalProperties": true, - "type": "object", - "title": "Frontmatter" - } + "frontmatter": { "additionalProperties": true, "type": "object", "title": "Frontmatter" } }, "additionalProperties": true, "type": "object", @@ -9454,20 +6191,11 @@ }, "MarkdownHeading": { "properties": { - "level": { - "type": "integer", - "title": "Level" - }, - "text": { - "type": "string", - "title": "Text" - } + "level": { "type": "integer", "title": "Level" }, + "text": { "type": "string", "title": "Text" } }, "type": "object", - "required": [ - "level", - "text" - ], + "required": ["level", "text"], "title": "MarkdownHeading" }, "MetadataCursorPagination": { @@ -9479,91 +6207,49 @@ "title": "Limit", "description": "Maximum number of items to return per page (1-100)", "default": 20, - "examples": [ - 10, - 20, - 50 - ] + "examples": [10, 20, 50] }, "after": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "After", "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="] }, "before": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Before", "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="] }, "include_total": { "type": "boolean", "title": "Include Total", "description": "Whether to include total count in response (expensive operation)", "default": false, - "examples": [ - false, - true - ] + "examples": [false, true] }, "statuses": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/StoreFileStatus" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/StoreFileStatus" }, "type": "array" }, + { "type": "null" } ], "title": "Statuses", "description": "Status to filter by" }, "metadata_filter": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Metadata Filter", "description": "Metadata filter to apply to the query" @@ -9576,64 +6262,30 @@ "MetadataFacets": { "properties": { "facets": { - "additionalProperties": { - "additionalProperties": true, - "type": "object" - }, + "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object", "title": "Facets", "description": "Metadata facets", "examples": [ - { - "author": { - "count": 1, - "value": "John Doe" - }, - "year": { - "count": 2, - "value": "2024" - } - } + { "author": { "count": 1, "value": "John Doe" }, "year": { "count": 2, "value": "2024" } } ] } }, "type": "object", - "required": [ - "facets" - ], + "required": ["facets"], "title": "MetadataFacets", "description": "Represents metadata facets for a store." }, "MetadataFacetsParams": { "properties": { "query": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }], "title": "Query", "description": "Search query text", - "examples": [ - "how to configure SSL" - ] + "examples": ["how to configure SSL"] }, "store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -9649,28 +6301,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -9679,51 +6321,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -9731,39 +6344,20 @@ "description": "Search configuration options" }, "facets": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], + "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], "title": "Facets", "description": "Optional list of facets to return. Use dot for nested fields.", - "examples": [ - "author", - "year", - "author.name" - ] + "examples": ["author", "year", "author.name"] } }, "type": "object", - "required": [ - "store_identifiers" - ], + "required": ["store_identifiers"], "title": "MetadataFacetsParams", "description": "Parameters for getting metadata facets." }, "Mode": { "type": "string", - "enum": [ - "fast", - "high_quality" - ], + "enum": ["fast", "high_quality"], "title": "Mode", "description": "The mode of the document parser." }, @@ -9772,28 +6366,13 @@ "embedding": { "$ref": "#/components/schemas/MultipleEncodingsEmbeddingItem", "description": "The encoded embedding data by encoding format.Returned, if more than one encoding format is used.", - "examples": [ - { - "float": [ - 0.1, - 0.2, - 0.3 - ], - "int8": [ - 1, - 2, - 3 - ] - } - ] + "examples": [{ "float": [0.1, 0.2, 0.3], "int8": [1, 2, 3] }] }, "index": { "type": "integer", "title": "Index", "description": "The index of the embedding.", - "examples": [ - 0 - ] + "examples": [0] }, "object": { "type": "string", @@ -9801,16 +6380,11 @@ "title": "Object", "description": "The object type of the embedding.", "default": "embedding_dict", - "examples": [ - "embedding_dict" - ] + "examples": ["embedding_dict"] } }, "type": "object", - "required": [ - "embedding", - "index" - ], + "required": ["embedding", "index"], "title": "MultiEncodingEmbedding" }, "MultiModalQuery": { @@ -9819,18 +6393,12 @@ "type": "string", "minLength": 1, "description": "The text input document to create embeddings for.", - "examples": [ - "This is a sample text input." - ] + "examples": ["This is a sample text input."] }, { "oneOf": [ - { - "$ref": "#/components/schemas/ImageUrlInput" - }, - { - "$ref": "#/components/schemas/TextInput" - } + { "$ref": "#/components/schemas/ImageUrlInput" }, + { "$ref": "#/components/schemas/TextInput" } ], "description": "The input to create embeddings for.", "discriminator": { @@ -9845,26 +6413,10 @@ }, "MultipartUploadDetailResponse": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The multipart upload record ID" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Original filename" - }, - "file_size": { - "type": "integer", - "title": "File Size", - "description": "Total file size in bytes" - }, - "mime_type": { - "type": "string", - "title": "Mime Type", - "description": "MIME type of the file" - }, + "id": { "type": "string", "title": "Id", "description": "The multipart upload record ID" }, + "filename": { "type": "string", "title": "Filename", "description": "Original filename" }, + "file_size": { "type": "integer", "title": "File Size", "description": "Total file size in bytes" }, + "mime_type": { "type": "string", "title": "Mime Type", "description": "MIME type of the file" }, "part_count": { "type": "integer", "title": "Part Count", @@ -9876,17 +6428,13 @@ "description": "When the upload was initiated" }, "completed_parts": { - "items": { - "$ref": "#/components/schemas/MultipartUploadPart" - }, + "items": { "$ref": "#/components/schemas/MultipartUploadPart" }, "type": "array", "title": "Completed Parts", "description": "Parts that have already been uploaded" }, "part_urls": { - "items": { - "$ref": "#/components/schemas/MultipartUploadPartUrl" - }, + "items": { "$ref": "#/components/schemas/MultipartUploadPartUrl" }, "type": "array", "title": "Part Urls", "description": "Presigned URLs for the parts that still need to be uploaded" @@ -9908,42 +6456,22 @@ "MultipartUploadListResponse": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/MultipartUploadObject" - }, + "items": { "$ref": "#/components/schemas/MultipartUploadObject" }, "type": "array", "title": "Data", "description": "List of in-progress multipart uploads" } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "MultipartUploadListResponse" }, "MultipartUploadObject": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The multipart upload record ID" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Original filename" - }, - "file_size": { - "type": "integer", - "title": "File Size", - "description": "Total file size in bytes" - }, - "mime_type": { - "type": "string", - "title": "Mime Type", - "description": "MIME type of the file" - }, + "id": { "type": "string", "title": "Id", "description": "The multipart upload record ID" }, + "filename": { "type": "string", "title": "Filename", "description": "Original filename" }, + "file_size": { "type": "integer", "title": "File Size", "description": "Total file size in bytes" }, + "mime_type": { "type": "string", "title": "Mime Type", "description": "MIME type of the file" }, "part_count": { "type": "integer", "title": "Part Count", @@ -9956,14 +6484,7 @@ } }, "type": "object", - "required": [ - "id", - "filename", - "file_size", - "mime_type", - "part_count", - "created_at" - ], + "required": ["id", "filename", "file_size", "mime_type", "part_count", "created_at"], "title": "MultipartUploadObject" }, "MultipartUploadPart": { @@ -9981,10 +6502,7 @@ } }, "type": "object", - "required": [ - "part_number", - "etag" - ], + "required": ["part_number", "etag"], "title": "MultipartUploadPart" }, "MultipartUploadPartUrl": { @@ -9995,60 +6513,20 @@ "title": "Part Number", "description": "1-based part number" }, - "url": { - "type": "string", - "title": "Url", - "description": "Presigned URL for uploading this part" - } + "url": { "type": "string", "title": "Url", "description": "Presigned URL for uploading this part" } }, "type": "object", - "required": [ - "part_number", - "url" - ], + "required": ["part_number", "url"], "title": "MultipartUploadPartUrl" }, "MultipleEncodingsEmbeddingItem": { "properties": { - "float": { - "items": { - "type": "number" - }, - "type": "array", - "title": "Float" - }, - "int8": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Int8" - }, - "uint8": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Uint8" - }, - "binary": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Binary" - }, - "ubinary": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Ubinary" - }, - "base64": { - "type": "string", - "title": "Base64" - } + "float": { "items": { "type": "number" }, "type": "array", "title": "Float" }, + "int8": { "items": { "type": "integer" }, "type": "array", "title": "Int8" }, + "uint8": { "items": { "type": "integer" }, "type": "array", "title": "Uint8" }, + "binary": { "items": { "type": "integer" }, "type": "array", "title": "Binary" }, + "ubinary": { "items": { "type": "integer" }, "type": "array", "title": "Ubinary" }, + "base64": { "type": "string", "title": "Base64" } }, "type": "object", "title": "MultipleEncodingsEmbeddingItem" @@ -10062,18 +6540,9 @@ "description": "The type of data source to create", "default": "notion" }, - "name": { - "type": "string", - "title": "Name", - "description": "The name of the data source" - }, + "name": { "type": "string", "title": "Name", "description": "The name of the data source" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "The metadata of the data source" }, @@ -10081,12 +6550,8 @@ "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/OAuth2CreateOrUpdateParams" - }, - { - "$ref": "#/components/schemas/ApiKeyCreateOrUpdateParams" - } + { "$ref": "#/components/schemas/OAuth2CreateOrUpdateParams" }, + { "$ref": "#/components/schemas/ApiKeyCreateOrUpdateParams" } ], "discriminator": { "propertyName": "type", @@ -10096,29 +6561,20 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Auth Params", "description": "The authentication parameters of the data source. Notion supports OAuth2 and API key." } }, "type": "object", - "required": [ - "name" - ], + "required": ["name"], "title": "NotionDataSourceCreateOrUpdateParams", "description": "Parameters for creating or updating a Notion data source." }, "OAuth2CreateOrUpdateParams": { "properties": { - "type": { - "type": "string", - "const": "oauth2", - "title": "Type", - "default": "oauth2" - } + "type": { "type": "string", "const": "oauth2", "title": "Type", "default": "oauth2" } }, "type": "object", "title": "OAuth2CreateOrUpdateParams", @@ -10126,51 +6582,16 @@ }, "PDFChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "pdf", - "title": "Type", - "default": "pdf" - }, + "type": { "type": "string", "const": "pdf", "title": "Type", "default": "pdf" }, "file_type": { "type": "string", "const": "application/pdf", "title": "File Type", "default": "application/pdf" }, - "total_pages": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Pages" - }, - "total_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Total Size" - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "total_pages": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Total Pages" }, + "total_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Total Size" }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", @@ -10204,25 +6625,10 @@ }, "ParsingJob": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the job" - }, - "file_id": { - "type": "string", - "title": "File Id", - "description": "The ID of the file to parse" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the job" }, + "file_id": { "type": "string", "title": "File Id", "description": "The ID of the file to parse" }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Filename", "description": "The name of the file" }, @@ -10231,52 +6637,21 @@ "description": "The status of the job" }, "error": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Error", "description": "The error of the job" }, "result": { - "anyOf": [ - { - "$ref": "#/components/schemas/DocumentParserResult" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/DocumentParserResult" }, { "type": "null" }], "description": "The result of the job" }, "started_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Started At", "description": "The started time of the job" }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished At", "description": "The finished time of the job" }, @@ -10287,15 +6662,7 @@ "description": "The creation time of the job" }, "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Updated At", "description": "The updated time of the job" }, @@ -10308,32 +6675,17 @@ } }, "type": "object", - "required": [ - "id", - "file_id", - "status" - ], + "required": ["id", "file_id", "status"], "title": "ParsingJob", "description": "A job for parsing documents with its current state and result." }, "ParsingJobCreateParams": { "properties": { - "file_id": { - "type": "string", - "title": "File Id", - "description": "The ID of the file to parse" - }, + "file_id": { "type": "string", "title": "File Id", "description": "The ID of the file to parse" }, "element_types": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/ElementType" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/ElementType" }, "type": "array" }, + { "type": "null" } ], "title": "Element Types", "description": "The elements to extract from the document" @@ -10355,19 +6707,13 @@ } }, "type": "object", - "required": [ - "file_id" - ], + "required": ["file_id"], "title": "ParsingJobCreateParams", "description": "Parameters for creating a parsing job." }, "ParsingJobDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the deleted job" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the deleted job" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -10383,33 +6729,16 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "ParsingJobDeleted", "description": "A deleted parsing job." }, "ParsingJobListItem": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The ID of the job" - }, - "file_id": { - "type": "string", - "title": "File Id", - "description": "The ID of the file to parse" - }, + "id": { "type": "string", "title": "Id", "description": "The ID of the job" }, + "file_id": { "type": "string", "title": "File Id", "description": "The ID of the file to parse" }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Filename", "description": "The name of the file" }, @@ -10418,41 +6747,17 @@ "description": "The status of the job" }, "error": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Error", "description": "The error of the job" - }, - "started_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + }, + "started_at": { + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Started At", "description": "The started time of the job" }, "finished_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Finished At", "description": "The finished time of the job" }, @@ -10463,15 +6768,7 @@ "description": "The creation time of the job" }, "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Updated At", "description": "The updated time of the job" }, @@ -10484,23 +6781,15 @@ } }, "type": "object", - "required": [ - "id", - "file_id", - "status" - ], + "required": ["id", "file_id", "status"], "title": "ParsingJobListItem", "description": "A parsing job item for list responses." }, "ParsingJobListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "data": { - "items": { - "$ref": "#/components/schemas/ParsingJobListItem" - }, + "items": { "$ref": "#/components/schemas/ParsingJobListItem" }, "type": "array", "title": "Data", "description": "The list of parsing jobs" @@ -10514,22 +6803,13 @@ } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "ParsingJobListResponse", "description": "A list of parsing jobs with pagination." }, "ParsingJobStatus": { "type": "string", - "enum": [ - "pending", - "in_progress", - "cancelled", - "completed", - "failed" - ], + "enum": ["pending", "in_progress", "cancelled", "completed", "failed"], "title": "ParsingJobStatus" }, "Period": { @@ -10548,19 +6828,13 @@ } }, "type": "object", - "required": [ - "start", - "end" - ], + "required": ["start", "end"], "title": "Period", "description": "Inclusive/exclusive window describing a billing period." }, "PhaseCostInfo": { "properties": { - "period": { - "$ref": "#/components/schemas/Period", - "description": "The period" - }, + "period": { "$ref": "#/components/schemas/Period", "description": "The period" }, "net_usage_cost": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", @@ -10581,12 +6855,7 @@ } }, "type": "object", - "required": [ - "period", - "net_usage_cost", - "gross_usage_cost", - "balance_applied" - ], + "required": ["period", "net_usage_cost", "gross_usage_cost", "balance_applied"], "title": "PhaseCostInfo", "description": "Cost information for a billing phase." }, @@ -10617,22 +6886,13 @@ } }, "type": "object", - "required": [ - "product_name", - "gross_usage_cost", - "net_usage_cost", - "balance_applied" - ], + "required": ["product_name", "gross_usage_cost", "net_usage_cost", "balance_applied"], "title": "ProductCostInfo", "description": "Cost information for a product." }, "QueryRegexSubstitutionRule": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query to trigger the rule" - }, + "query": { "type": "string", "title": "Query", "description": "The query to trigger the rule" }, "store_id": { "type": "string", "title": "Store Id", @@ -10648,14 +6908,10 @@ "type": "string", "title": "Pattern", "description": "The regex pattern to match", - "examples": [ - "\\b(\\w+)\\s+world\\b" - ] + "examples": ["\\b(\\w+)\\s+world\\b"] }, "flags": { - "items": { - "$ref": "#/components/schemas/RegexFlag" - }, + "items": { "$ref": "#/components/schemas/RegexFlag" }, "type": "array", "title": "Flags", "description": "The regex flags to use", @@ -10665,29 +6921,17 @@ "type": "string", "title": "Replacement", "description": "The replacement string (can use regex groups)", - "examples": [ - "\\1\\sglobe" - ] + "examples": ["\\1\\sglobe"] } }, "type": "object", - "required": [ - "query", - "store_id", - "type", - "pattern", - "replacement" - ], + "required": ["query", "store_id", "type", "pattern", "replacement"], "title": "QueryRegexSubstitutionRule", "description": "Represents a regex query substitution rule for a vector store search." }, "QueryStringSubstitutionRule": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query to trigger the rule" - }, + "query": { "type": "string", "title": "Query", "description": "The query to trigger the rule" }, "store_id": { "type": "string", "title": "Store Id", @@ -10703,19 +6947,11 @@ "type": "string", "title": "Substitution", "description": "The substitution to apply", - "examples": [ - "query1", - "query2" - ] + "examples": ["query1", "query2"] } }, "type": "object", - "required": [ - "query", - "store_id", - "type", - "substitution" - ], + "required": ["query", "store_id", "type", "substitution"], "title": "QueryStringSubstitutionRule", "description": "Represents a string query substitution rule for a vector store search." }, @@ -10744,34 +6980,19 @@ "type": "integer", "title": "Index", "description": "The index of the document.", - "examples": [ - 0 - ] + "examples": [0] }, "score": { "type": "number", "title": "Score", "description": "The score of the document.", - "examples": [ - 0.95 - ] + "examples": [0.95] }, "input": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Input", "description": "The input document.", - "examples": [ - { - "field1": "value1", - "field2": "value2" - }, - "Hello, world!" - ] + "examples": [{ "field1": "value1", "field2": "value2" }, "Hello, world!"] }, "object": { "type": "string", @@ -10779,28 +7000,16 @@ "title": "Object", "description": "The object type.", "default": "rank_result", - "examples": [ - "rank_result" - ] + "examples": ["rank_result"] } }, "type": "object", - "required": [ - "index", - "score" - ], + "required": ["index", "score"], "title": "RankedDocument" }, "RegexFlag": { "type": "string", - "enum": [ - "IGNORECASE", - "MULTILINE", - "DOTALL", - "VERBOSE", - "ASCII", - "UNICODE" - ], + "enum": ["IGNORECASE", "MULTILINE", "DOTALL", "VERBOSE", "ASCII", "UNICODE"], "title": "RegexFlag", "description": "Supported regex flags." }, @@ -10813,51 +7022,20 @@ "title": "Model", "description": "The name of the reranking model", "default": "mixedbread-ai/mxbai-rerank-large-v2", - "examples": [ - "rerank_model" - ] + "examples": ["rerank_model"] }, "with_metadata": { - "anyOf": [ - { - "type": "boolean" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ], + "anyOf": [{ "type": "boolean" }, { "items": { "type": "string" }, "type": "array" }], "title": "With Metadata", "description": "Whether to include metadata in the reranked results", "default": false, - "examples": [ - true, - false, - [ - "metadata1", - "metadata2" - ] - ] + "examples": [true, false, ["metadata1", "metadata2"]] }, "top_k": { - "anyOf": [ - { - "type": "integer", - "exclusiveMinimum": 0 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" }], "title": "Top K", "description": "Maximum number of results to return after reranking. If None, returns all reranked results.", - "examples": [ - 10, - 50, - 100 - ] + "examples": [10, 50, 100] } }, "type": "object", @@ -10873,9 +7051,7 @@ "title": "Model", "description": "The model to use for reranking documents.", "default": "mixedbread-ai/mxbai-rerank-large-v2", - "examples": [ - "mixedbread-ai/mxbai-rerank-large-v2" - ] + "examples": ["mixedbread-ai/mxbai-rerank-large-v2"] }, "query": { "type": "string", @@ -10883,69 +7059,30 @@ "minLength": 1, "title": "Query", "description": "The query to rerank the documents.", - "examples": [ - "What are the key features of the Mixedbread embedding model?" - ] + "examples": ["What are the key features of the Mixedbread embedding model?"] }, "input": { - "items": { - "anyOf": [ - { - "type": "string" - }, - {}, - { - "items": {}, - "type": "array" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, {}, { "items": {}, "type": "array" }] }, "type": "array", "maxItems": 1000, "minItems": 1, "title": "Input", "description": "The input documents to rerank.", "examples": [ + ["Document 1", "Document 2"], [ - "Document 1", - "Document 2" - ], - [ - { - "field1": "value1", - "field2": "value2" - }, - { - "field1": "value3", - "field2": "value4" - } + { "field1": "value1", "field2": "value2" }, + { "field1": "value3", "field2": "value4" } ] ] }, "rank_fields": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array", - "minItems": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "items": { "type": "string" }, "type": "array", "minItems": 1 }, { "type": "null" }], "title": "Rank Fields", "description": "The fields of the documents to rank.", "examples": [ - [ - "content", - "title" - ], - [ - "document.text", - "metadata.summary" - ] + ["content", "title"], + ["document.text", "metadata.summary"] ] }, "top_k": { @@ -10954,34 +7091,25 @@ "title": "Top K", "description": "The number of documents to return.", "default": -1, - "examples": [ - 10 - ] + "examples": [10] }, "return_input": { "type": "boolean", "title": "Return Input", "description": "Whether to return the documents.", "default": false, - "examples": [ - false - ] + "examples": [false] }, "rewrite_query": { "type": "boolean", "title": "Rewrite Query", "description": "Wether or not to rewrite the query before passing it to the reranking model", "default": false, - "examples": [ - false - ] + "examples": [false] } }, "type": "object", - "required": [ - "query", - "input" - ], + "required": ["query", "input"], "title": "RerankParams", "description": "Parameters for reranking documents." }, @@ -10990,23 +7118,11 @@ "usage": { "$ref": "#/components/schemas/Usage", "description": "The usage of the model", - "examples": [ - { - "completion_tokens": 10, - "prompt_tokens": 10, - "total_tokens": 20 - } - ] - }, - "model": { - "type": "string", - "title": "Model", - "description": "The model used" + "examples": [{ "completion_tokens": 10, "prompt_tokens": 10, "total_tokens": 20 }] }, + "model": { "type": "string", "title": "Model", "description": "The model used" }, "data": { - "items": { - "$ref": "#/components/schemas/RankedDocument" - }, + "items": { "$ref": "#/components/schemas/RankedDocument" }, "type": "array", "title": "Data", "description": "The ranked documents.", @@ -11014,19 +7130,11 @@ [ { "index": 0, - "input": { - "field1": "value1", - "field2": "value2" - }, + "input": { "field1": "value1", "field2": "value2" }, "object": "rank_result", "score": 0.95 }, - { - "index": 1, - "input": "Hello, world!", - "object": "rank_result", - "score": 0.94 - } + { "index": 1, "input": "Hello, world!", "object": "rank_result", "score": 0.94 } ] ] }, @@ -11041,36 +7149,22 @@ "type": "integer", "title": "Top K", "description": "The number of documents to return.", - "examples": [ - 10 - ] + "examples": [10] }, "return_input": { "type": "boolean", "title": "Return Input", "description": "Whether to return the documents.", - "examples": [ - false - ] + "examples": [false] } }, "type": "object", - "required": [ - "usage", - "model", - "data", - "top_k", - "return_input" - ], + "required": ["usage", "model", "data", "top_k", "return_input"], "title": "RerankResponse" }, "ReturnFormat": { "type": "string", - "enum": [ - "html", - "markdown", - "plain" - ], + "enum": ["html", "markdown", "plain"], "title": "ReturnFormat", "description": "Format options for the returned document content." }, @@ -11078,81 +7172,33 @@ "properties": { "method": { "type": "string", - "enum": [ - "read", - "write", - "delete", - "list", - "create", - "search" - ], + "enum": ["read", "write", "delete", "list", "create", "search"], "title": "Method" }, "resource_type": { - "anyOf": [ - { - "type": "string", - "const": "store" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "const": "store" }, { "type": "null" }], "title": "Resource Type" }, "resource_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" }], "title": "Resource Id" } }, "type": "object", - "required": [ - "method" - ], + "required": ["method"], "title": "Scope" }, "ScoredStoreFile": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "Unique identifier for the file" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Name of the file" - }, + "id": { "type": "string", "title": "Id", "description": "Unique identifier for the file" }, + "filename": { "type": "string", "title": "Filename", "description": "Name of the file" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional file metadata" }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "External identifier for this file in the store" }, @@ -11162,20 +7208,11 @@ "default": "pending" }, "last_error": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Last Error", "description": "Last error message if processing failed" }, - "store_id": { - "type": "string", - "title": "Store Id", - "description": "ID of the containing store" - }, + "store_id": { "type": "string", "title": "Store Id", "description": "ID of the containing store" }, "created_at": { "type": "string", "format": "date-time", @@ -11183,59 +7220,25 @@ "description": "Timestamp of store file creation" }, "version": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Version", "description": "Version number of the file", - "examples": [ - 1 - ] + "examples": [1] }, "usage_bytes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Bytes", "description": "Storage usage in bytes", - "examples": [ - 51200 - ] + "examples": [51200] }, "usage_tokens": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Tokens", "description": "Storage usage in tokens", - "examples": [ - 51200 - ] + "examples": [51200] }, "config": { - "anyOf": [ - { - "$ref": "#/components/schemas/StoreFileConfig" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/StoreFileConfig" }, { "type": "null" }], "description": "Configuration for the file" }, "object": { @@ -11275,9 +7278,7 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Chunks", "description": "Array of scored file chunks" @@ -11286,41 +7287,20 @@ "type": "number", "title": "Score", "description": "score of the file", - "examples": [ - 0.5 - ] + "examples": [0.5] } }, "type": "object", - "required": [ - "id", - "store_id", - "created_at", - "chunks", - "score" - ], + "required": ["id", "store_id", "created_at", "chunks", "score"], "title": "ScoredStoreFile", "description": "Represents a scored store file." }, "ScoredVectorStoreFile": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "Unique identifier for the file" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Name of the file" - }, - "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "id": { "type": "string", "title": "Id", "description": "Unique identifier for the file" }, + "filename": { "type": "string", "title": "Filename", "description": "Name of the file" }, + "metadata": { + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional file metadata" }, @@ -11330,12 +7310,7 @@ "default": "pending" }, "last_error": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Last Error", "description": "Last error message if processing failed" }, @@ -11351,34 +7326,16 @@ "description": "Timestamp of store file creation" }, "version": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Version", "description": "Version number of the file", - "examples": [ - 1 - ] + "examples": [1] }, "usage_bytes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Bytes", "description": "Storage usage in bytes", - "examples": [ - 51200 - ] + "examples": [51200] }, "object": { "type": "string", @@ -11417,9 +7374,7 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Chunks", "description": "Array of scored file chunks" @@ -11428,19 +7383,11 @@ "type": "number", "title": "Score", "description": "score of the file", - "examples": [ - 0.5 - ] + "examples": [0.5] } }, "type": "object", - "required": [ - "id", - "vector_store_id", - "created_at", - "chunks", - "score" - ], + "required": ["id", "vector_store_id", "created_at", "chunks", "score"], "title": "ScoredVectorStoreFile", "description": "Represents a scored store file." }, @@ -11453,106 +7400,55 @@ "title": "Limit", "description": "Maximum number of items to return per page (1-100)", "default": 20, - "examples": [ - 10, - 20, - 50 - ] + "examples": [10, 20, 50] }, "after": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "After", "description": "Cursor for forward pagination - get items after this position. Use last_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="] }, "before": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Before", "description": "Cursor for backward pagination - get items before this position. Use first_cursor from previous response.", - "examples": [ - "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ==" - ] + "examples": ["eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMVQyMzo1OTo1OS4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="] }, "include_total": { "type": "boolean", "title": "Include Total", "description": "Whether to include total count in response (expensive operation)", "default": false, - "examples": [ - false, - true - ] + "examples": [false, true] }, "statuses": { "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/StoreFileStatus" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "$ref": "#/components/schemas/StoreFileStatus" }, "type": "array" }, + { "type": "null" } ], "title": "Statuses", "description": "Status to filter by" }, "metadata_filter": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Metadata Filter", "description": "Metadata filter to apply to the query" }, "q": { - "anyOf": [ - { - "type": "string", - "maxLength": 100, - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "maxLength": 100, "minLength": 1 }, { "type": "null" }], "title": "Q", "description": "Search query for fuzzy matching over name and external_id fields" } @@ -11568,34 +7464,20 @@ { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "All", "description": "List of conditions or filters to be ANDed together", "examples": [ [ - { - "key": "price", - "operator": "gt", - "value": "100" - }, - { - "key": "color", - "operator": "eq", - "value": "red" - } + { "key": "price", "operator": "gt", "value": "100" }, + { "key": "color", "operator": "eq", "value": "red" } ], null ] @@ -11605,34 +7487,20 @@ { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Any", "description": "List of conditions or filters to be ORed together", "examples": [ [ - { - "key": "price", - "operator": "gt", - "value": "100" - }, - { - "key": "color", - "operator": "eq", - "value": "red" - } + { "key": "price", "operator": "gt", "value": "100" }, + { "key": "color", "operator": "eq", "value": "red" } ], null ] @@ -11642,42 +7510,24 @@ { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "None", "description": "List of conditions or filters to be NOTed", "examples": [ [ - { - "key": "price", - "operator": "gt", - "value": "100" - }, - { - "key": "color", - "operator": "eq", - "value": "red" - } + { "key": "price", "operator": "gt", "value": "100" }, + { "key": "color", "operator": "eq", "value": "red" } ], null ], - "x-stainless-naming": { - "python": { - "type_name": "none_type" - } - } + "x-stainless-naming": { "python": { "type_name": "none_type" } } } }, "type": "object", @@ -11690,34 +7540,21 @@ "type": "string", "title": "Key", "description": "The field to apply the condition on", - "examples": [ - "price", - "color" - ] + "examples": ["price", "color"] }, "value": { "title": "Value", "description": "The value to compare against", - "examples": [ - "100", - "red" - ] + "examples": ["100", "red"] }, "operator": { "$ref": "#/components/schemas/ConditionOperator", "description": "The operator for the condition", - "examples": [ - "eq", - "gt" - ] + "examples": ["eq", "gt"] } }, "type": "object", - "required": [ - "key", - "value", - "operator" - ], + "required": ["key", "value", "operator"], "title": "SearchFilterCondition", "description": "Represents a condition with a field, operator, and value." }, @@ -11727,9 +7564,7 @@ "type": "string", "title": "Id", "description": "Unique identifier for the store", - "examples": [ - "1b8b486e-16d0-400b-8868-04cd75217a7e" - ] + "examples": ["1b8b486e-16d0-400b-8868-04cd75217a7e"] }, "name": { "type": "string", @@ -11737,60 +7572,29 @@ "minLength": 1, "title": "Name", "description": "Name of the store", - "examples": [ - "Customer Support KB", - "Product Documentation" - ] + "examples": ["Customer Support KB", "Product Documentation"] }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Detailed description of the store's purpose and contents", - "examples": [ - "Contains customer support articles and FAQs" - ] + "examples": ["Contains customer support articles and FAQs"] }, "is_public": { "type": "boolean", "title": "Is Public", "description": "Whether the store can be accessed by anyone with valid login credentials", "default": false, - "examples": [ - false - ] + "examples": [false] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Additional metadata associated with the store", - "examples": [ - { - "category": "support", - "language": "en" - } - ] + "examples": [{ "category": "support", "language": "en" }] }, "config": { - "anyOf": [ - { - "$ref": "#/components/schemas/StoreConfig" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/StoreConfig" }, { "type": "null" }], "description": "Store-level configuration defaults" }, "file_counts": { @@ -11798,14 +7602,7 @@ "description": "Counts of files in different states" }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "status": { @@ -11818,29 +7615,17 @@ "format": "date-time", "title": "Created At", "description": "Timestamp when the store was created", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Timestamp when the store was last updated", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "last_active_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Last Active At", "description": "Timestamp when the store was last used" }, @@ -11849,34 +7634,20 @@ "title": "Usage Bytes", "description": "Total storage usage in bytes", "default": 0, - "examples": [ - 1024000 - ] + "examples": [1024000] }, "usage_tokens": { "type": "integer", "title": "Usage Tokens", "description": "Total storage usage in tokens", "default": 0, - "examples": [ - 1024000 - ] + "examples": [1024000] }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "Optional expiration timestamp for the store", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "object": { "type": "string", @@ -11887,12 +7658,7 @@ } }, "type": "object", - "required": [ - "id", - "name", - "created_at", - "updated_at" - ], + "required": ["id", "name", "created_at", "updated_at"], "title": "Store", "description": "Model representing a store with its metadata and timestamps." }, @@ -11914,30 +7680,18 @@ }, "rerank": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/RerankConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/RerankConfig" }, + { "type": "null" } ], "title": "Rerank", "description": "Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)." }, "agentic": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/AgenticSearchConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/AgenticSearchConfig" }, + { "type": "null" } ], "title": "Agentic", "description": "Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored." @@ -11964,22 +7718,10 @@ "query": { "$ref": "#/components/schemas/MultiModalQuery", "description": "Search query text", - "examples": [ - "how to configure SSL" - ] + "examples": ["how to configure SSL"] }, "store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -11995,28 +7737,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -12025,51 +7757,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -12078,24 +7781,14 @@ } }, "type": "object", - "required": [ - "query", - "store_identifiers" - ], + "required": ["query", "store_identifiers"], "title": "StoreChunkSearchParams", "description": "Query parameters for searching store chunks." }, "StoreConfig": { "properties": { "contextualization": { - "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/ContextualizationConfig" - } - ], + "anyOf": [{ "type": "boolean" }, { "$ref": "#/components/schemas/ContextualizationConfig" }], "title": "Contextualization", "description": "Contextualize files with metadata", "default": false @@ -12113,11 +7806,7 @@ }, "StoreCostInfo": { "properties": { - "store_id": { - "type": "string", - "title": "Store Id", - "description": "The ID of the store" - }, + "store_id": { "type": "string", "title": "Store Id", "description": "The ID of the store" }, "cost": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$", @@ -12125,30 +7814,21 @@ "description": "The cost" }, "cost_per_metric": { - "additionalProperties": { - "type": "string", - "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" - }, + "additionalProperties": { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, "type": "object", "title": "Cost Per Metric", "description": "The cost per metric" } }, "type": "object", - "required": [ - "store_id", - "cost", - "cost_per_metric" - ], + "required": ["store_id", "cost", "cost_per_metric"], "title": "StoreCostInfo", "description": "Cost information for a store." }, "StoreCostListResponse": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/StoreCostInfo" - }, + "items": { "$ref": "#/components/schemas/StoreCostInfo" }, "type": "array", "title": "Data", "description": "The list of store cost information" @@ -12162,97 +7842,47 @@ } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "StoreCostListResponse" }, "StoreCreateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }], "title": "Name", - "description": "Name for the new store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).", - "examples": [ - "technical-documentation" - ] + "description": "Name for the new store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-).", + "examples": ["technical-documentation"] }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the store", - "examples": [ - "Contains technical specifications and guides" - ] + "examples": ["Contains technical specifications and guides"] }, "is_public": { "type": "boolean", "title": "Is Public", "description": "Whether the store can be accessed by anyone with valid login credentials", "default": false, - "examples": [ - false - ] + "examples": [false] }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional metadata key-value pairs" }, "config": { - "anyOf": [ - { - "$ref": "#/components/schemas/StoreConfig" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/StoreConfig" }, { "type": "null" }], "description": "Store-level configuration defaults" }, "file_ids": { "anyOf": [ - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs" @@ -12265,15 +7895,7 @@ "StoreDeleted": { "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "title": "Id", "description": "ID of the deleted store" }, @@ -12291,10 +7913,7 @@ } }, "type": "object", - "required": [ - "id", - "deleted" - ], + "required": ["id", "deleted"], "title": "StoreDeleted", "description": "Response model for store deletion." }, @@ -12369,12 +7988,7 @@ } }, "type": "object", - "required": [ - "bucket_start", - "bucket_end", - "type", - "event_count" - ], + "required": ["bucket_start", "bucket_end", "type", "event_count"], "title": "StoreEventHistogramBucket", "description": "Represents a histogram of events in a store." }, @@ -12413,25 +8027,19 @@ "default": "store.histogram" }, "data": { - "items": { - "$ref": "#/components/schemas/StoreEventHistogramBucket" - }, + "items": { "$ref": "#/components/schemas/StoreEventHistogramBucket" }, "type": "array", "title": "Data", "description": "The histogram of store events" } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "StoreEventHistogramResponse" }, "StoreEventListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -12442,12 +8050,8 @@ "data": { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/StoreIngestionEvent" - }, - { - "$ref": "#/components/schemas/StoreSearchEvent" - } + { "$ref": "#/components/schemas/StoreIngestionEvent" }, + { "$ref": "#/components/schemas/StoreSearchEvent" } ], "discriminator": { "propertyName": "type", @@ -12463,43 +8067,20 @@ } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "StoreEventListResponse" }, "StoreFile": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "Unique identifier for the file" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Name of the file" - }, + "id": { "type": "string", "title": "Id", "description": "Unique identifier for the file" }, + "filename": { "type": "string", "title": "Filename", "description": "Name of the file" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional file metadata" }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "External identifier for this file in the store" }, @@ -12509,20 +8090,11 @@ "default": "pending" }, "last_error": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Last Error", "description": "Last error message if processing failed" }, - "store_id": { - "type": "string", - "title": "Store Id", - "description": "ID of the containing store" - }, + "store_id": { "type": "string", "title": "Store Id", "description": "ID of the containing store" }, "created_at": { "type": "string", "format": "date-time", @@ -12530,59 +8102,25 @@ "description": "Timestamp of store file creation" }, "version": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Version", "description": "Version number of the file", - "examples": [ - 1 - ] + "examples": [1] }, "usage_bytes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Bytes", "description": "Storage usage in bytes", - "examples": [ - 51200 - ] + "examples": [51200] }, "usage_tokens": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Tokens", "description": "Storage usage in tokens", - "examples": [ - 51200 - ] + "examples": [51200] }, "config": { - "anyOf": [ - { - "$ref": "#/components/schemas/StoreFileConfig" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/StoreFileConfig" }, { "type": "null" }], "description": "Configuration for the file" }, "object": { @@ -12597,18 +8135,10 @@ { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/TextInputChunk" - }, - { - "$ref": "#/components/schemas/ImageUrlInputChunk" - }, - { - "$ref": "#/components/schemas/AudioUrlInputChunk" - }, - { - "$ref": "#/components/schemas/VideoUrlInputChunk" - } + { "$ref": "#/components/schemas/TextInputChunk" }, + { "$ref": "#/components/schemas/ImageUrlInputChunk" }, + { "$ref": "#/components/schemas/AudioUrlInputChunk" }, + { "$ref": "#/components/schemas/VideoUrlInputChunk" } ], "discriminator": { "propertyName": "type", @@ -12622,20 +8152,14 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Chunks", "description": "chunks" } }, "type": "object", - "required": [ - "id", - "store_id", - "created_at" - ], + "required": ["id", "store_id", "created_at"], "title": "StoreFile", "description": "Represents a file stored in a store." }, @@ -12653,11 +8177,7 @@ }, "StoreFileDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "ID of the deleted file" - }, + "id": { "type": "string", "title": "Id", "description": "ID of the deleted file" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -12673,17 +8193,13 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "StoreFileDeleted", "description": "Response model for file deletion." }, "StoreFileListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -12692,33 +8208,20 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/StoreFile" - }, + "items": { "$ref": "#/components/schemas/StoreFile" }, "type": "array", "title": "Data", "description": "The list of store files" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "StoreFileListResponse" }, "StoreFileMetadataUpdateParams": { "properties": { "metadata": { - "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "type": "null" - } - ], + "anyOf": [{ "additionalProperties": true, "type": "object" }, { "type": "null" }], "title": "Metadata", "description": "Updated metadata for the file" } @@ -12729,10 +8232,7 @@ }, "StoreFileParsingStrategy": { "type": "string", - "enum": [ - "fast", - "high_quality" - ], + "enum": ["fast", "high_quality"], "title": "StoreFileParsingStrategy", "description": "Strategy for adding a file to a store." }, @@ -12754,30 +8254,18 @@ }, "rerank": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/RerankConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/RerankConfig" }, + { "type": "null" } ], "title": "Rerank", "description": "Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)." }, "agentic": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/AgenticSearchConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/AgenticSearchConfig" }, + { "type": "null" } ], "title": "Agentic", "description": "Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored." @@ -12816,22 +8304,10 @@ "query": { "$ref": "#/components/schemas/MultiModalQuery", "description": "Search query text", - "examples": [ - "how to configure SSL" - ] + "examples": ["how to configure SSL"] }, "store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -12847,28 +8323,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -12877,51 +8343,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -12930,10 +8367,7 @@ } }, "type": "object", - "required": [ - "query", - "store_identifiers" - ], + "required": ["query", "store_identifiers"], "title": "StoreFileSearchParams", "description": "Query parameters for searching store files." }, @@ -12947,29 +8381,19 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/ScoredStoreFile" - }, + "items": { "$ref": "#/components/schemas/ScoredStoreFile" }, "type": "array", "title": "Data", "description": "The list of scored store files" } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "StoreFileSearchResponse" }, "StoreFileStatus": { "type": "string", - "enum": [ - "pending", - "in_progress", - "cancelled", - "completed", - "failed" - ], + "enum": ["pending", "in_progress", "cancelled", "completed", "failed"], "title": "StoreFileStatus" }, "StoreIngestionEvent": { @@ -12986,12 +8410,7 @@ "title": "Created At", "description": "Timestamp when the event was created" }, - "type": { - "type": "string", - "const": "ingestion", - "title": "Type", - "default": "ingestion" - }, + "type": { "type": "string", "const": "ingestion", "title": "Type", "default": "ingestion" }, "store_id": { "type": "string", "format": "uuid", @@ -13036,14 +8455,7 @@ "description": "Strategy used to ingest the file" }, "filename": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Filename", "description": "Name of the file if the event is tied to a file" } @@ -13066,9 +8478,7 @@ }, "StoreListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -13077,19 +8487,14 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/Store" - }, + "items": { "$ref": "#/components/schemas/Store" }, "type": "array", "title": "Data", "description": "The list of stores" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "StoreListResponse" }, "StoreQAParams": { @@ -13101,17 +8506,7 @@ "description": "Question to answer. If not provided, the question will be extracted from the passed messages." }, "store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -13127,28 +8522,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -13157,51 +8542,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", - "description": "Optional list of file IDs to filter chunks by (inclusion filter)", - "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + "description": "Optional list of file IDs to filter chunks by (inclusion filter)", + "examples": [ + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -13215,16 +8571,7 @@ "default": false }, "instructions": { - "anyOf": [ - { - "type": "string", - "maxLength": 2000, - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "maxLength": 2000, "minLength": 1 }, { "type": "null" }], "title": "Instructions", "description": "Additional custom instructions (followed only when not in conflict with existing rules)" }, @@ -13234,19 +8581,13 @@ } }, "type": "object", - "required": [ - "store_identifiers" - ], + "required": ["store_identifiers"], "title": "StoreQAParams", "description": "Query parameters for question answering." }, "StoreQAResults": { "properties": { - "answer": { - "type": "string", - "title": "Answer", - "description": "The answer generated by the LLM" - }, + "answer": { "type": "string", "title": "Answer", "description": "The answer generated by the LLM" }, "sources": { "items": { "oneOf": [ @@ -13279,9 +8620,7 @@ } }, "type": "object", - "required": [ - "answer" - ], + "required": ["answer"], "title": "StoreQAResults", "description": "Results from a question answering operation." }, @@ -13299,17 +8638,9 @@ "title": "Created At", "description": "Timestamp when the event was created" }, - "type": { - "type": "string", - "const": "search", - "title": "Type", - "default": "search" - }, + "type": { "type": "string", "const": "search", "title": "Type", "default": "search" }, "store_ids": { - "items": { - "type": "string", - "format": "uuid" - }, + "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Store Ids", "description": "IDs of the vector stores searched" @@ -13327,14 +8658,7 @@ "description": "Query used to search the vector store" }, "rewritten_query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Rewritten Query", "description": "Rewritten query if query rewriting was enabled" }, @@ -13346,12 +8670,7 @@ } }, "type": "object", - "required": [ - "id", - "created_at", - "store_ids", - "query" - ], + "required": ["id", "created_at", "store_ids", "query"], "title": "StoreSearchEvent", "description": "Represents a search event in a vector store." }, @@ -13396,78 +8715,38 @@ } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "StoreSearchResponse" }, "StoreStatus": { "type": "string", - "enum": [ - "expired", - "in_progress", - "completed" - ], + "enum": ["expired", "in_progress", "completed"], "title": "StoreStatus", "description": "Status of a store." }, "StoreUpdateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }], "title": "Name", "description": "New name for the store. Can only contain lowercase letters, numbers, periods (.), and hyphens (-)." }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "New description" }, "is_public": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Is Public", "description": "Whether the store can be accessed by anyone with valid login credentials" }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional metadata key-value pairs" } @@ -13478,84 +8757,24 @@ }, "SyncStatus": { "type": "string", - "enum": [ - "idle", - "pending", - "in_progress", - "cancelled", - "completed", - "failed" - ], + "enum": ["idle", "pending", "in_progress", "cancelled", "completed", "failed"], "title": "SyncStatus" }, "TextChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "text", - "title": "Type", - "default": "text" - }, + "type": { "type": "string", "const": "text", "title": "Type", "default": "text" }, "file_type": { "type": "string", "const": "text/plain", "title": "File Type", "default": "text/plain" }, - "language": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Language" - }, - "word_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Word Count" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, - "start_line": { - "type": "integer", - "title": "Start Line", - "default": 0 - }, - "num_lines": { - "type": "integer", - "title": "Num Lines", - "default": 0 - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "language": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Language" }, + "word_count": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Word Count" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, + "start_line": { "type": "integer", "title": "Start Line", "default": 0 }, + "num_lines": { "type": "integer", "title": "Num Lines", "default": 0 }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", @@ -13579,9 +8798,7 @@ } }, "type": "object", - "required": [ - "text" - ], + "required": ["text"], "title": "TextInput", "description": "Model for text input validation.\n\nAttributes:\n type: Input type identifier, always \"text\"\n text: The actual text content, with length and whitespace constraints" }, @@ -13591,48 +8808,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "text/plain", - "examples": [ - "text/plain" - ] + "examples": ["text/plain"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -13647,9 +8842,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -13664,20 +8857,10 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "type": { "type": "string", @@ -13691,29 +8874,16 @@ "title": "Offset", "description": "The offset of the text in the file relative to the start of the file.", "default": 0, - "examples": [ - 0, - 13, - 42 - ] + "examples": [0, 13, 42] }, "text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Text", "description": "Text content" } }, "type": "object", - "required": [ - "chunk_index" - ], + "required": ["chunk_index"], "title": "TextInputChunk" }, "Usage": { @@ -13729,23 +8899,13 @@ "description": "The total number of tokens used" }, "completion_tokens": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Completion Tokens", "description": "The number of tokens used for the completion" } }, "type": "object", - "required": [ - "prompt_tokens", - "total_tokens" - ], + "required": ["prompt_tokens", "total_tokens"], "title": "Usage" }, "UsageInfo": { @@ -13759,13 +8919,8 @@ }, "limit": { "anyOf": [ - { - "type": "string", - "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" - }, - { - "type": "null" - } + { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, + { "type": "null" } ], "title": "Limit", "description": "The limit of the resource" @@ -13789,9 +8944,7 @@ "description": "Whether the schema is valid" }, "errors": { - "items": { - "type": "string" - }, + "items": { "type": "string" }, "type": "array", "title": "Errors", "description": "List of validation errors" @@ -13804,52 +8957,24 @@ } }, "type": "object", - "required": [ - "is_valid", - "errors", - "json_schema" - ], + "required": ["is_valid", "errors", "json_schema"], "title": "ValidatedJsonSchema", "description": "Result of validating a JSON schema." }, "ValidationError": { "properties": { "loc": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, "type": "array", "title": "Location" }, - "msg": { - "type": "string", - "title": "Message" - }, - "type": { - "type": "string", - "title": "Error Type" - }, - "input": { - "title": "Input" - }, - "ctx": { - "type": "object", - "title": "Context" - } + "msg": { "type": "string", "title": "Message" }, + "type": { "type": "string", "title": "Error Type" }, + "input": { "title": "Input" }, + "ctx": { "type": "object", "title": "Context" } }, "type": "object", - "required": [ - "loc", - "msg", - "type" - ], + "required": ["loc", "msg", "type"], "title": "ValidationError" }, "VectorStore": { @@ -13858,9 +8983,7 @@ "type": "string", "title": "Id", "description": "Unique identifier for the vector store", - "examples": [ - "1b8b486e-16d0-400b-8868-04cd75217a7e" - ] + "examples": ["1b8b486e-16d0-400b-8868-04cd75217a7e"] }, "name": { "type": "string", @@ -13868,64 +8991,33 @@ "minLength": 1, "title": "Name", "description": "Name of the vector store", - "examples": [ - "Customer Support KB", - "Product Documentation" - ] + "examples": ["Customer Support KB", "Product Documentation"] }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Detailed description of the vector store's purpose and contents", - "examples": [ - "Contains customer support articles and FAQs" - ] + "examples": ["Contains customer support articles and FAQs"] }, "is_public": { "type": "boolean", "title": "Is Public", "description": "Whether the vector store can be accessed by anyone with valid login credentials", "default": false, - "examples": [ - false - ] + "examples": [false] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Additional metadata associated with the vector store", - "examples": [ - { - "category": "support", - "language": "en" - } - ] + "examples": [{ "category": "support", "language": "en" }] }, "file_counts": { "$ref": "#/components/schemas/FileCounts", "description": "Counts of files in different states" }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "status": { @@ -13938,29 +9030,17 @@ "format": "date-time", "title": "Created At", "description": "Timestamp when the vector store was created", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Timestamp when the vector store was last updated", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "last_active_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Last Active At", "description": "Timestamp when the vector store was last used" }, @@ -13969,25 +9049,13 @@ "title": "Usage Bytes", "description": "Total storage usage in bytes", "default": 0, - "examples": [ - 1024000 - ] + "examples": [1024000] }, "expires_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "format": "date-time" }, { "type": "null" }], "title": "Expires At", "description": "Optional expiration timestamp for the vector store", - "examples": [ - "2024-01-01T00:00:00Z" - ] + "examples": ["2024-01-01T00:00:00Z"] }, "object": { "type": "string", @@ -13998,12 +9066,7 @@ } }, "type": "object", - "required": [ - "id", - "name", - "created_at", - "updated_at" - ], + "required": ["id", "name", "created_at", "updated_at"], "title": "VectorStore", "description": "Model representing a vector store with its metadata and timestamps." }, @@ -14025,30 +9088,18 @@ }, "rerank": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/RerankConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/RerankConfig" }, + { "type": "null" } ], "title": "Rerank", "description": "Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)." }, "agentic": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/AgenticSearchConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/AgenticSearchConfig" }, + { "type": "null" } ], "title": "Agentic", "description": "Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored." @@ -14073,26 +9124,14 @@ "VectorStoreChunkSearchParams": { "properties": { "query": { - "type": "string", - "minLength": 1, - "title": "Query", - "description": "Search query text", - "examples": [ - "how to configure SSL" - ] - }, - "vector_store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "type": "string", + "minLength": 1, + "title": "Query", + "description": "Search query text", + "examples": ["how to configure SSL"] + }, + "vector_store_identifiers": { + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -14108,28 +9147,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -14138,51 +9167,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -14191,88 +9191,44 @@ } }, "type": "object", - "required": [ - "query", - "vector_store_identifiers" - ], + "required": ["query", "vector_store_identifiers"], "title": "VectorStoreChunkSearchParams", "description": "Query parameters for searching vector store chunks." }, "VectorStoreCreateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }], "title": "Name", "description": "Name for the new vector store", - "examples": [ - "Technical Documentation" - ] + "examples": ["Technical Documentation"] }, "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "Description of the vector store", - "examples": [ - "Contains technical specifications and guides" - ] + "examples": ["Contains technical specifications and guides"] }, "is_public": { "type": "boolean", "title": "Is Public", "description": "Whether the vector store can be accessed by anyone with valid login credentials", "default": false, - "examples": [ - false - ] + "examples": [false] }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional metadata key-value pairs" }, "file_ids": { "anyOf": [ - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs" @@ -14285,15 +9241,7 @@ "VectorStoreDeleted": { "properties": { "id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ], + "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }], "title": "Id", "description": "ID of the deleted vector store" }, @@ -14311,32 +9259,16 @@ } }, "type": "object", - "required": [ - "id", - "deleted" - ], + "required": ["id", "deleted"], "title": "VectorStoreDeleted", "description": "Response model for vector store deletion." }, "VectorStoreFile": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "Unique identifier for the file" - }, - "filename": { - "type": "string", - "title": "Filename", - "description": "Name of the file" - }, + "id": { "type": "string", "title": "Id", "description": "Unique identifier for the file" }, + "filename": { "type": "string", "title": "Filename", "description": "Name of the file" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional file metadata" }, @@ -14346,12 +9278,7 @@ "default": "pending" }, "last_error": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Last Error", "description": "Last error message if processing failed" }, @@ -14367,34 +9294,16 @@ "description": "Timestamp of store file creation" }, "version": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Version", "description": "Version number of the file", - "examples": [ - 1 - ] + "examples": [1] }, "usage_bytes": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Usage Bytes", "description": "Storage usage in bytes", - "examples": [ - 51200 - ] + "examples": [51200] }, "object": { "type": "string", @@ -14408,18 +9317,10 @@ { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/TextInputChunk" - }, - { - "$ref": "#/components/schemas/ImageUrlInputChunk" - }, - { - "$ref": "#/components/schemas/AudioUrlInputChunk" - }, - { - "$ref": "#/components/schemas/VideoUrlInputChunk" - } + { "$ref": "#/components/schemas/TextInputChunk" }, + { "$ref": "#/components/schemas/ImageUrlInputChunk" }, + { "$ref": "#/components/schemas/AudioUrlInputChunk" }, + { "$ref": "#/components/schemas/VideoUrlInputChunk" } ], "discriminator": { "propertyName": "type", @@ -14433,30 +9334,20 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Chunks", "description": "chunks" } }, "type": "object", - "required": [ - "id", - "vector_store_id", - "created_at" - ], + "required": ["id", "vector_store_id", "created_at"], "title": "VectorStoreFile", "description": "Represents a file stored in a store." }, "VectorStoreFileDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "ID of the deleted file" - }, + "id": { "type": "string", "title": "Id", "description": "ID of the deleted file" }, "deleted": { "type": "boolean", "title": "Deleted", @@ -14472,17 +9363,13 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "VectorStoreFileDeleted", "description": "Response model for file deletion." }, "VectorStoreFileListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -14491,19 +9378,14 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/VectorStoreFile" - }, + "items": { "$ref": "#/components/schemas/VectorStoreFile" }, "type": "array", "title": "Data", "description": "The list of vector store files" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "VectorStoreFileListResponse", "description": "List response wrapper for vector store files." }, @@ -14525,30 +9407,18 @@ }, "rerank": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/RerankConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/RerankConfig" }, + { "type": "null" } ], "title": "Rerank", "description": "Whether to rerank results and optional reranking configuration. Ignored when agentic is enabled (the agent handles ranking)." }, "agentic": { "anyOf": [ - { - "type": "boolean" - }, - { - "$ref": "#/components/schemas/AgenticSearchConfig" - }, - { - "type": "null" - } + { "type": "boolean" }, + { "$ref": "#/components/schemas/AgenticSearchConfig" }, + { "type": "null" } ], "title": "Agentic", "description": "Whether to use agentic multi-query search with automatic query decomposition and ranking. When enabled, rewrite_query and rerank options are ignored." @@ -14589,22 +9459,10 @@ "minLength": 1, "title": "Query", "description": "Search query text", - "examples": [ - "how to configure SSL" - ] + "examples": ["how to configure SSL"] }, "vector_store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -14620,28 +9478,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -14650,51 +9498,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -14703,10 +9522,7 @@ } }, "type": "object", - "required": [ - "query", - "vector_store_identifiers" - ], + "required": ["query", "vector_store_identifiers"], "title": "VectorStoreFileSearchParams", "description": "Query parameters for searching store files." }, @@ -14720,37 +9536,25 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/ScoredVectorStoreFile" - }, + "items": { "$ref": "#/components/schemas/ScoredVectorStoreFile" }, "type": "array", "title": "Data", "description": "The list of scored vector store files" } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "VectorStoreFileSearchResponse", "description": "Search response wrapper for vector store files." }, "VectorStoreFileStatus": { "type": "string", - "enum": [ - "pending", - "in_progress", - "cancelled", - "completed", - "failed" - ], + "enum": ["pending", "in_progress", "cancelled", "completed", "failed"], "title": "VectorStoreFileStatus" }, "VectorStoreListResponse": { "properties": { - "pagination": { - "$ref": "#/components/schemas/CursorPaginationResponse" - }, + "pagination": { "$ref": "#/components/schemas/CursorPaginationResponse" }, "object": { "type": "string", "const": "list", @@ -14759,19 +9563,14 @@ "default": "list" }, "data": { - "items": { - "$ref": "#/components/schemas/VectorStore" - }, + "items": { "$ref": "#/components/schemas/VectorStore" }, "type": "array", "title": "Data", "description": "The list of vector stores" } }, "type": "object", - "required": [ - "pagination", - "data" - ], + "required": ["pagination", "data"], "title": "VectorStoreListResponse" }, "VectorStoreQAParams": { @@ -14783,17 +9582,7 @@ "description": "Question to answer. If not provided, the question will be extracted from the passed messages." }, "vector_store_identifiers": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "string", - "format": "uuid" - } - ] - }, + "items": { "anyOf": [{ "type": "string" }, { "type": "string", "format": "uuid" }] }, "type": "array", "maxItems": 100, "minItems": 1, @@ -14809,28 +9598,18 @@ }, "filters": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - }, + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" }, { "items": { "anyOf": [ - { - "$ref": "#/components/schemas/SearchFilter" - }, - { - "$ref": "#/components/schemas/SearchFilterCondition" - } + { "$ref": "#/components/schemas/SearchFilter" }, + { "$ref": "#/components/schemas/SearchFilterCondition" } ] }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Filters", "description": "Optional filter conditions" @@ -14839,51 +9618,22 @@ "anyOf": [ { "prefixItems": [ - { - "$ref": "#/components/schemas/ConditionOperator" - }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - } + { "$ref": "#/components/schemas/ConditionOperator" }, + { "items": { "type": "string", "format": "uuid" }, "type": "array" } ], "type": "array", "maxItems": 2, "minItems": 2 }, - { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array" - }, - { - "type": "null" - } + { "items": { "type": "string", "format": "uuid" }, "type": "array" }, + { "type": "null" } ], "title": "File Ids", "description": "Optional list of file IDs to filter chunks by (inclusion filter)", "examples": [ - [ - "123e4567-e89b-12d3-a456-426614174000", - "123e4567-e89b-12d3-a456-426614174001" - ], - [ - "in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ], - [ - "not_in", - [ - "123e4567-e89b-12d3-a456-426614174000" - ] - ] + ["123e4567-e89b-12d3-a456-426614174000", "123e4567-e89b-12d3-a456-426614174001"], + ["in", ["123e4567-e89b-12d3-a456-426614174000"]], + ["not_in", ["123e4567-e89b-12d3-a456-426614174000"]] ] }, "search_options": { @@ -14902,19 +9652,13 @@ } }, "type": "object", - "required": [ - "vector_store_identifiers" - ], + "required": ["vector_store_identifiers"], "title": "VectorStoreQAParams", "description": "Query parameters for question answering." }, "VectorStoreQAResults": { "properties": { - "answer": { - "type": "string", - "title": "Answer", - "description": "The answer generated by the LLM" - }, + "answer": { "type": "string", "title": "Answer", "description": "The answer generated by the LLM" }, "sources": { "items": { "oneOf": [ @@ -14947,9 +9691,7 @@ } }, "type": "object", - "required": [ - "answer" - ], + "required": ["answer"], "title": "VectorStoreQAResults", "description": "Results from a question answering operation." }, @@ -14994,68 +9736,32 @@ } }, "type": "object", - "required": [ - "data" - ], + "required": ["data"], "title": "VectorStoreSearchResponse" }, "VectorStoreUpdateParams": { "properties": { "name": { - "anyOf": [ - { - "type": "string", - "minLength": 1 - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string", "minLength": 1 }, { "type": "null" }], "title": "Name", "description": "New name for the store" }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "description": { + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Description", "description": "New description" }, "is_public": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Is Public", "description": "Whether the vector store can be accessed by anyone with valid login credentials" }, "expires_after": { - "anyOf": [ - { - "$ref": "#/components/schemas/ExpiresAfter" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ExpiresAfter" }, { "type": "null" }], "description": "Optional expiration policy" }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "Optional metadata key-value pairs" } @@ -15066,110 +9772,20 @@ }, "VideoChunkGeneratedMetadata": { "properties": { - "type": { - "type": "string", - "const": "video", - "title": "Type", - "default": "video" - }, - "file_type": { - "type": "string", - "title": "File Type", - "default": "video/mp4" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" - }, + "type": { "type": "string", "const": "video", "title": "Type", "default": "video" }, + "file_type": { "type": "string", "title": "File Type", "default": "video/mp4" }, + "file_size": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "File Size" }, "total_duration_seconds": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Total Duration Seconds" }, - "fps": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Fps" - }, - "width": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Width" - }, - "height": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Height" - }, - "frame_count": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Frame Count" - }, - "has_audio_stream": { - "type": "boolean", - "title": "Has Audio Stream", - "default": false - }, - "bpm": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Bpm" - }, - "file_extension": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "File Extension" - } + "fps": { "anyOf": [{ "type": "number" }, { "type": "null" }], "title": "Fps" }, + "width": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Width" }, + "height": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Height" }, + "frame_count": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Frame Count" }, + "has_audio_stream": { "type": "boolean", "title": "Has Audio Stream", "default": false }, + "bpm": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Bpm" }, + "file_extension": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "File Extension" } }, "additionalProperties": true, "type": "object", @@ -15184,9 +9800,7 @@ } }, "type": "object", - "required": [ - "url" - ], + "required": ["url"], "title": "VideoUrl", "description": "Model for video URL validation." }, @@ -15196,48 +9810,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "video/mp4", - "examples": [ - "video/mp4" - ] + "examples": ["video/mp4"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -15252,9 +9844,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -15269,20 +9859,10 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "type": { "type": "string", @@ -15292,51 +9872,24 @@ "default": "video_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the video", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the video", - "examples": [ - "A financial report video for 2025" - ] + "examples": ["A financial report video for 2025"] }, "video_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/VideoUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/VideoUrl" }, { "type": "null" }], "description": "Video URL" } }, "type": "object", - "required": [ - "chunk_index" - ], + "required": ["chunk_index"], "title": "VideoUrlInputChunk" }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__ScoredAudioUrlInputChunk": { @@ -15345,48 +9898,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "audio/mpeg", - "examples": [ - "audio/mpeg" - ] + "examples": ["audio/mpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -15401,9 +9932,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -15418,67 +9947,40 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "vector_store_id": { "type": "string", "title": "Vector Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -15488,44 +9990,19 @@ "default": "audio_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the audio", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the audio", - "examples": [ - "A financial report audio for 2025" - ] + "examples": ["A financial report audio for 2025"] }, "audio_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/AudioUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/AudioUrl" }, { "type": "null" }], "description": "Audio URL" }, "sampling_rate": { @@ -15535,14 +10012,7 @@ } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "vector_store_id", - "sampling_rate" - ], + "required": ["chunk_index", "score", "file_id", "filename", "vector_store_id", "sampling_rate"], "title": "ScoredAudioUrlInputChunk", "description": "Scored audio chunk for deprecated API." }, @@ -15552,48 +10022,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "image/jpeg", - "examples": [ - "image/jpeg" - ] + "examples": ["image/jpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -15608,9 +10056,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -15625,67 +10071,40 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "vector_store_id": { "type": "string", "title": "Vector Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -15695,55 +10114,24 @@ "default": "image_url" }, "ocr_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ocr Text", "description": "ocr text of the image", - "examples": [ - "2025 Financial Report" - ] + "examples": ["2025 Financial Report"] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the image", - "examples": [ - "A financial report for 2025" - ] + "examples": ["A financial report for 2025"] }, "image_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/ImageUrl-Output" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ImageUrl-Output" }, { "type": "null" }], "description": "Image URL" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "vector_store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "vector_store_id"], "title": "ScoredImageUrlInputChunk", "description": "Scored image chunk for deprecated API." }, @@ -15753,48 +10141,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "text/plain", - "examples": [ - "text/plain" - ] + "examples": ["text/plain"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -15809,9 +10175,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -15824,69 +10188,42 @@ "word_count": 100 } ] - }, - "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + }, + "model": { + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "vector_store_id": { "type": "string", "title": "Vector Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -15900,33 +10237,16 @@ "title": "Offset", "description": "The offset of the text in the file relative to the start of the file.", "default": 0, - "examples": [ - 0, - 13, - 42 - ] + "examples": [0, 13, 42] }, "text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Text", "description": "Text content" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "vector_store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "vector_store_id"], "title": "ScoredTextInputChunk", "description": "Scored text chunk for deprecated API." }, @@ -15936,48 +10256,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "video/mp4", - "examples": [ - "video/mp4" - ] + "examples": ["video/mp4"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -15992,9 +10290,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -16009,67 +10305,40 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "vector_store_id": { "type": "string", "title": "Vector Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -16079,80 +10348,37 @@ "default": "video_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the video", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the video", - "examples": [ - "A financial report video for 2025" - ] + "examples": ["A financial report video for 2025"] }, "video_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/VideoUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/VideoUrl" }, { "type": "null" }], "description": "Video URL" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "vector_store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "vector_store_id"], "title": "ScoredVideoUrlInputChunk", "description": "Scored video chunk for deprecated API." }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleCreateParams": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query pattern to match" - }, + "query": { "type": "string", "title": "Query", "description": "The query pattern to match" }, "rules": { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16171,20 +10397,13 @@ } }, "type": "object", - "required": [ - "query", - "rules" - ], + "required": ["query", "rules"], "title": "SearchRuleCreateParams", "description": "Parameters for creating a new search rule." }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The deleted search rule ID" - }, + "id": { "type": "string", "title": "Id", "description": "The deleted search rule ID" }, "object": { "type": "string", "const": "search_rule", @@ -16200,19 +10419,13 @@ } }, "type": "object", - "required": [ - "id" - ], + "required": ["id"], "title": "SearchRuleDeleted", "description": "Response model for deleted search rule." }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleResponse": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The search rule ID" - }, + "id": { "type": "string", "title": "Id", "description": "The search rule ID" }, "object": { "type": "string", "const": "search_rule", @@ -16220,11 +10433,7 @@ "description": "The object type", "default": "search_rule" }, - "query": { - "type": "string", - "title": "Query", - "description": "The query pattern" - }, + "query": { "type": "string", "title": "Query", "description": "The query pattern" }, "vector_store_id": { "type": "string", "title": "Vector Store Id", @@ -16233,18 +10442,10 @@ "rules": { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16275,14 +10476,7 @@ } }, "type": "object", - "required": [ - "id", - "query", - "vector_store_id", - "rules", - "created_at", - "updated_at" - ], + "required": ["id", "query", "vector_store_id", "rules", "created_at", "updated_at"], "title": "SearchRuleResponse", "description": "Response model for a search rule." }, @@ -16290,18 +10484,10 @@ "properties": { "rule": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "title": "Rule", "description": "The specific rule to delete from the rules array", @@ -16317,19 +10503,13 @@ } }, "type": "object", - "required": [ - "rule" - ], + "required": ["rule"], "title": "SearchRuleSpecificDeleteParams", "description": "Parameters for deleting a specific rule from array." }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleSpecificDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The search rule ID" - }, + "id": { "type": "string", "title": "Id", "description": "The search rule ID" }, "object": { "type": "string", "const": "search_rule", @@ -16339,18 +10519,10 @@ }, "deleted_rule": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "title": "Deleted Rule", "description": "The specific rule that was deleted", @@ -16371,25 +10543,14 @@ } }, "type": "object", - "required": [ - "id", - "deleted_rule", - "remaining_rules" - ], + "required": ["id", "deleted_rule", "remaining_rules"], "title": "SearchRuleSpecificDeleted", "description": "Response model for specific deleted rule." }, "mxbai_omni__api__routes__v1__deprecated_vector_stores__models__SearchRuleUpdateParams": { "properties": { "query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Query", "description": "The query pattern to match" }, @@ -16398,18 +10559,10 @@ { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16424,9 +10577,7 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Rules", "description": "The rules to apply on query matches" @@ -16438,26 +10589,14 @@ }, "mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleCreateParams": { "properties": { - "query": { - "type": "string", - "title": "Query", - "description": "The query pattern to match" - }, + "query": { "type": "string", "title": "Query", "description": "The query pattern to match" }, "rules": { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16476,10 +10615,7 @@ } }, "type": "object", - "required": [ - "query", - "rules" - ], + "required": ["query", "rules"], "title": "SearchRuleCreateParams", "description": "Parameters for creating a new search rule for a store." }, @@ -16499,19 +10635,13 @@ } }, "type": "object", - "required": [ - "deleted" - ], + "required": ["deleted"], "title": "SearchRuleDeleted", "description": "Response model for deleted store search rule." }, "mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleResponse": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The search rule ID" - }, + "id": { "type": "string", "title": "Id", "description": "The search rule ID" }, "object": { "type": "string", "const": "search_rule", @@ -16519,31 +10649,15 @@ "description": "The object type", "default": "search_rule" }, - "query": { - "type": "string", - "title": "Query", - "description": "The query pattern" - }, - "store_id": { - "type": "string", - "title": "Store Id", - "description": "The store ID" - }, + "query": { "type": "string", "title": "Query", "description": "The query pattern" }, + "store_id": { "type": "string", "title": "Store Id", "description": "The store ID" }, "rules": { "items": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16574,14 +10688,7 @@ } }, "type": "object", - "required": [ - "id", - "query", - "store_id", - "rules", - "created_at", - "updated_at" - ], + "required": ["id", "query", "store_id", "rules", "created_at", "updated_at"], "title": "SearchRuleResponse", "description": "Response model for a store search rule." }, @@ -16589,18 +10696,10 @@ "properties": { "rule": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "title": "Rule", "description": "The specific rule to delete from the rules array", @@ -16616,19 +10715,13 @@ } }, "type": "object", - "required": [ - "rule" - ], + "required": ["rule"], "title": "SearchRuleSpecificDeleteParams", "description": "Parameters for deleting a specific rule from a search rule array." }, "mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleSpecificDeleted": { "properties": { - "id": { - "type": "string", - "title": "Id", - "description": "The search rule ID" - }, + "id": { "type": "string", "title": "Id", "description": "The search rule ID" }, "object": { "type": "string", "const": "search_rule", @@ -16638,18 +10731,10 @@ }, "deleted_rule": { "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "title": "Deleted Rule", "description": "The specific rule that was deleted", @@ -16670,45 +10755,26 @@ } }, "type": "object", - "required": [ - "id", - "deleted_rule", - "remaining_rules" - ], + "required": ["id", "deleted_rule", "remaining_rules"], "title": "SearchRuleSpecificDeleted", "description": "Response model for a specific deleted rule from a search rule array." }, "mxbai_omni__api__routes__v1__stores__rules__models__SearchRuleUpdateParams": { "properties": { "query": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Query", "description": "The query pattern to match" }, "rules": { - "anyOf": [ - { - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/QueryStringSubstitutionRule" - }, - { - "$ref": "#/components/schemas/QueryRegexSubstitutionRule" - }, - { - "$ref": "#/components/schemas/ChunkSearchResultRule" - }, - { - "$ref": "#/components/schemas/FileSearchResultRule" - } + "anyOf": [ + { + "items": { + "oneOf": [ + { "$ref": "#/components/schemas/QueryStringSubstitutionRule" }, + { "$ref": "#/components/schemas/QueryRegexSubstitutionRule" }, + { "$ref": "#/components/schemas/ChunkSearchResultRule" }, + { "$ref": "#/components/schemas/FileSearchResultRule" } ], "description": "The possible rules for a vector store search", "discriminator": { @@ -16723,9 +10789,7 @@ }, "type": "array" }, - { - "type": "null" - } + { "type": "null" } ], "title": "Rules", "description": "The rules to apply on query matches" @@ -16741,48 +10805,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "audio/mpeg", - "examples": [ - "audio/mpeg" - ] + "examples": ["audio/mpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -16797,9 +10839,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -16814,82 +10854,46 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "store_id": { "type": "string", "title": "Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "external identifier for this file", - "examples": [ - "ext-123" - ] + "examples": ["ext-123"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -16899,44 +10903,19 @@ "default": "audio_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the audio", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the audio", - "examples": [ - "A financial report audio for 2025" - ] + "examples": ["A financial report audio for 2025"] }, "audio_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/AudioUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/AudioUrl" }, { "type": "null" }], "description": "Audio URL" }, "sampling_rate": { @@ -16946,14 +10925,7 @@ } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "store_id", - "sampling_rate" - ], + "required": ["chunk_index", "score", "file_id", "filename", "store_id", "sampling_rate"], "title": "ScoredAudioUrlInputChunk" }, "mxbai_omni__core__store__models__chunk_types__ScoredImageUrlInputChunk": { @@ -16962,48 +10934,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "image/jpeg", - "examples": [ - "image/jpeg" - ] + "examples": ["image/jpeg"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -17018,9 +10968,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -17035,82 +10983,46 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "store_id": { "type": "string", "title": "Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "external identifier for this file", - "examples": [ - "ext-123" - ] + "examples": ["ext-123"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -17120,55 +11032,24 @@ "default": "image_url" }, "ocr_text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Ocr Text", "description": "ocr text of the image", - "examples": [ - "2025 Financial Report" - ] + "examples": ["2025 Financial Report"] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the image", - "examples": [ - "A financial report for 2025" - ] + "examples": ["A financial report for 2025"] }, "image_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/ImageUrl-Output" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/ImageUrl-Output" }, { "type": "null" }], "description": "Image URL" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "store_id"], "title": "ScoredImageUrlInputChunk" }, "mxbai_omni__core__store__models__chunk_types__ScoredTextInputChunk": { @@ -17177,48 +11058,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "text/plain", - "examples": [ - "text/plain" - ] + "examples": ["text/plain"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -17233,9 +11092,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -17250,82 +11107,46 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "store_id": { "type": "string", "title": "Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "external identifier for this file", - "examples": [ - "ext-123" - ] + "examples": ["ext-123"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -17339,33 +11160,16 @@ "title": "Offset", "description": "The offset of the text in the file relative to the start of the file.", "default": 0, - "examples": [ - 0, - 13, - 42 - ] + "examples": [0, 13, 42] }, "text": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Text", "description": "Text content" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "store_id"], "title": "ScoredTextInputChunk" }, "mxbai_omni__core__store__models__chunk_types__ScoredVideoUrlInputChunk": { @@ -17374,48 +11178,26 @@ "type": "integer", "title": "Chunk Index", "description": "position of the chunk in a file", - "examples": [ - 0, - 1, - 2, - 3, - 4 - ] + "examples": [0, 1, 2, 3, 4] }, "mime_type": { "type": "string", "title": "Mime Type", "description": "mime type of the chunk", "default": "video/mp4", - "examples": [ - "video/mp4" - ] + "examples": ["video/mp4"] }, "generated_metadata": { "anyOf": [ { "oneOf": [ - { - "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/TextChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" - }, - { - "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" - } + { "$ref": "#/components/schemas/MarkdownChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/TextChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/PDFChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/CodeChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/AudioChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/VideoChunkGeneratedMetadata" }, + { "$ref": "#/components/schemas/ImageChunkGeneratedMetadata" } ], "discriminator": { "propertyName": "type", @@ -17430,9 +11212,7 @@ } } }, - { - "type": "null" - } + { "type": "null" } ], "title": "Generated Metadata", "description": "metadata of the chunk", @@ -17447,82 +11227,46 @@ ] }, "model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Model", "description": "model used for this chunk", - "examples": [ - "text-embedding-ada-002", - "clip-vit-large-patch14" - ] + "examples": ["text-embedding-ada-002", "clip-vit-large-patch14"] }, "score": { "type": "number", "title": "Score", "description": "score of the chunk", - "examples": [ - 0.5 - ] + "examples": [0.5] }, "file_id": { "type": "string", "title": "File Id", "description": "file id", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "filename": { "type": "string", "title": "Filename", "description": "filename", - "examples": [ - "file1" - ] + "examples": ["file1"] }, "store_id": { "type": "string", "title": "Store Id", "description": "store id", - "examples": [ - "store1" - ] + "examples": ["store1"] }, "external_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "External Id", "description": "external identifier for this file", - "examples": [ - "ext-123" - ] + "examples": ["ext-123"] }, "metadata": { - "anyOf": [ - {}, - { - "type": "null" - } - ], + "anyOf": [{}, { "type": "null" }], "title": "Metadata", "description": "file metadata", - "examples": [ - { - "key": "value" - } - ] + "examples": [{ "key": "value" }] }, "type": { "type": "string", @@ -17532,69 +11276,29 @@ "default": "video_url" }, "transcription": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Transcription", "description": "speech recognition (sr) text of the video", - "examples": [ - "The year 2025 reports for .." - ] + "examples": ["The year 2025 reports for .."] }, "summary": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], + "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Summary", "description": "summary of the video", - "examples": [ - "A financial report video for 2025" - ] + "examples": ["A financial report video for 2025"] }, "video_url": { - "anyOf": [ - { - "$ref": "#/components/schemas/VideoUrl" - }, - { - "type": "null" - } - ], + "anyOf": [{ "$ref": "#/components/schemas/VideoUrl" }, { "type": "null" }], "description": "Video URL" } }, "type": "object", - "required": [ - "chunk_index", - "score", - "file_id", - "filename", - "store_id" - ], + "required": ["chunk_index", "score", "file_id", "filename", "store_id"], "title": "ScoredVideoUrlInputChunk" } }, "securitySchemes": { - "ApiKeyAuth": { - "type": "http", - "description": "Api key to access Mixedbreads API", - "scheme": "bearer" - } - } - }, - "security": [ - { - "ApiKeyAuth": [] + "ApiKeyAuth": { "type": "http", "description": "Api key to access Mixedbreads API", "scheme": "bearer" } } - ] -} \ No newline at end of file + } +}