From 6a3c69d6b6fc57aa405d6a86d35db89a3584fd6c Mon Sep 17 00:00:00 2001 From: Wenxi Onyx Date: Tue, 6 Jan 2026 10:58:55 -0800 Subject: [PATCH] revert openapi spec version --- developers/api_reference/openapi.json | 8898 ++++++++++++------------- 1 file changed, 4449 insertions(+), 4449 deletions(-) diff --git a/developers/api_reference/openapi.json b/developers/api_reference/openapi.json index 82f1bad3..0ef5cb1b 100644 --- a/developers/api_reference/openapi.json +++ b/developers/api_reference/openapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.1.0", + "openapi": "3.0.3", "info": { "title": "Onyx API", "description": "Onyx API for AI-powered enterprise search and chat", @@ -5115,85 +5115,117 @@ }, "components": { "schemas": { - "FileUploadResponse": { + "MethodSpec": { "properties": { - "file_paths": { - "items": { - "type": "string" - }, - "type": "array", - "title": "File Paths" + "name": { + "type": "string", + "title": "Name" }, - "file_names": { - "items": { - "type": "string" - }, - "type": "array", - "title": "File Names" + "summary": { + "type": "string", + "title": "Summary" }, - "zip_metadata": { + "path": { + "type": "string", + "title": "Path" + }, + "method": { + "type": "string", + "title": "Method" + }, + "spec": { "additionalProperties": true, "type": "object", - "title": "Zip Metadata" - } - }, - "type": "object", - "required": [ - "file_paths", - "file_names", - "zip_metadata" - ], - "title": "FileUploadResponse" - }, - "IndexedSourcesResponse": { - "properties": { - "sources": { - "items": { - "$ref": "#/components/schemas/DocumentSource" - }, - "type": "array", - "title": "Sources" + "title": "Spec" } }, "type": "object", "required": [ - "sources" - ], - "title": "IndexedSourcesResponse" - }, - "RerankerProvider": { - "type": "string", - "enum": [ - "cohere", - "litellm", - "bedrock" + "name", + "summary", + "path", + "method", + "spec" ], - "title": "RerankerProvider" + "title": "MethodSpec" }, - "OpenUrlStart": { + "DeepResearchPlanStart": { "properties": { "type": { "type": "string", - "const": "open_url_start", + "const": "deep_research_plan_start", "title": "Type", - "default": "open_url_start" + "default": "deep_research_plan_start" } }, "type": "object", - "title": "OpenUrlStart", - "description": "Signal that OpenURL tool has started." + "title": "DeepResearchPlanStart" }, - "Body_upload_user_files_user_projects_file_upload_post": { + "SendMessageRequest": { "properties": { - "files": { + "message": { + "type": "string", + "title": "Message" + }, + "llm_override": { + "anyOf": [ + { + "$ref": "#/components/schemas/LLMOverride" + }, + { + "type": "null" + } + ] + }, + "allowed_tool_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Allowed Tool Ids" + }, + "forced_tool_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Forced Tool Id" + }, + "file_descriptors": { "items": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/FileDescriptor" }, "type": "array", - "title": "Files" + "title": "File Descriptors", + "default": [] }, - "project_id": { + "internal_search_filters": { + "anyOf": [ + { + "$ref": "#/components/schemas/BaseFilters" + }, + { + "type": "null" + } + ] + }, + "deep_research": { + "type": "boolean", + "title": "Deep Research", + "default": false + }, + "parent_message_id": { "anyOf": [ { "type": "integer" @@ -5202,255 +5234,250 @@ "type": "null" } ], - "title": "Project Id" + "title": "Parent Message Id", + "default": -1 }, - "temp_id_map": { + "chat_session_id": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "uuid" }, { "type": "null" } ], - "title": "Temp Id Map" + "title": "Chat Session Id" + }, + "chat_session_info": { + "anyOf": [ + { + "$ref": "#/components/schemas/ChatSessionCreationRequest" + }, + { + "type": "null" + } + ] + }, + "stream": { + "type": "boolean", + "title": "Stream", + "default": true } }, "type": "object", "required": [ - "files" + "message" ], - "title": "Body_upload_user_files_user_projects_file_upload_post" + "title": "SendMessageRequest" }, - "GeneratedImage": { + "CustomToolDelta": { "properties": { - "file_id": { + "type": { "type": "string", - "title": "File Id" + "const": "custom_tool_delta", + "title": "Type", + "default": "custom_tool_delta" }, - "url": { + "tool_name": { "type": "string", - "title": "Url" + "title": "Tool Name" }, - "revised_prompt": { + "response_type": { "type": "string", - "title": "Revised Prompt" + "title": "Response Type" }, - "shape": { + "data": { "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "items": {}, + "type": "array" + }, { "type": "string" }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, { "type": "null" } ], - "title": "Shape" - } - }, - "type": "object", - "required": [ - "file_id", - "url", - "revised_prompt" - ], - "title": "GeneratedImage", - "description": "Represents an image generated by an image generation tool." - }, - "LlmWebSearchResult": { - "properties": { - "document_citation_number": { - "type": "integer", - "title": "Document Citation Number" + "title": "Data" }, - "unique_identifier_to_strip_away": { + "file_ids": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Unique Identifier To Strip Away" - }, - "type": { - "type": "string", - "const": "web_search", - "title": "Type", - "default": "web_search" - }, - "url": { - "type": "string", - "title": "Url" - }, - "title": { - "type": "string", - "title": "Title" - }, - "snippet": { - "type": "string", - "title": "Snippet" + "title": "File Ids" } }, "type": "object", "required": [ - "document_citation_number", - "url", - "title", - "snippet" - ], - "title": "LlmWebSearchResult", - "description": "Result from a web search query" + "tool_name", + "response_type" + ], + "title": "CustomToolDelta" }, - "Body_bulk_invite_users_manage_admin_users_put": { - "properties": { - "emails": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Emails" - } - }, - "type": "object", - "required": [ - "emails" + "PermissionSyncStatus": { + "type": "string", + "enum": [ + "not_started", + "in_progress", + "success", + "canceled", + "failed", + "completed_with_errors" ], - "title": "Body_bulk_invite_users_manage_admin_users_put" + "title": "PermissionSyncStatus", + "description": "Status enum for permission sync attempts" }, - "FullUserSnapshot": { + "ConnectorSnapshot": { "properties": { - "id": { - "type": "string", - "format": "uuid", - "title": "Id" - }, - "email": { + "name": { "type": "string", - "title": "Email" + "title": "Name" }, - "role": { - "$ref": "#/components/schemas/UserRole" + "source": { + "$ref": "#/components/schemas/DocumentSource" }, - "is_active": { - "type": "boolean", - "title": "Is Active" + "input_type": { + "$ref": "#/components/schemas/InputType" }, - "password_configured": { - "type": "boolean", - "title": "Password Configured" - } - }, - "type": "object", - "required": [ - "id", - "email", - "role", - "is_active", - "password_configured" - ], - "title": "FullUserSnapshot" - }, - "ValidateToolRequest": { - "properties": { - "definition": { + "connector_specific_config": { "additionalProperties": true, "type": "object", - "title": "Definition" - } - }, - "type": "object", - "required": [ - "definition" - ], - "title": "ValidateToolRequest" - }, - "ObjectCreationIdResponse": { - "properties": { - "id": { - "type": "integer", - "title": "Id" + "title": "Connector Specific Config" }, - "credential": { + "refresh_freq": { "anyOf": [ { - "$ref": "#/components/schemas/CredentialSnapshot" + "type": "integer" }, { "type": "null" } - ] - } - }, - "type": "object", - "required": [ - "id" - ], - "title": "ObjectCreationIdResponse" - }, - "HTTPValidationError": { - "properties": { - "detail": { + ], + "title": "Refresh Freq" + }, + "prune_freq": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Prune Freq" + }, + "indexing_start": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Indexing Start" + }, + "id": { + "type": "integer", + "title": "Id" + }, + "credential_ids": { "items": { - "$ref": "#/components/schemas/ValidationError" + "type": "integer" }, "type": "array", - "title": "Detail" - } - }, - "type": "object", - "title": "HTTPValidationError" - }, - "SearchToolDocumentsDelta": { - "properties": { - "type": { + "title": "Credential Ids" + }, + "time_created": { "type": "string", - "const": "search_tool_documents_delta", - "title": "Type", - "default": "search_tool_documents_delta" + "format": "date-time", + "title": "Time Created" }, - "documents": { - "items": { - "$ref": "#/components/schemas/SearchDoc" - }, - "type": "array", - "title": "Documents" + "time_updated": { + "type": "string", + "format": "date-time", + "title": "Time Updated" } }, "type": "object", "required": [ - "documents" + "name", + "source", + "input_type", + "connector_specific_config", + "id", + "credential_ids", + "time_created", + "time_updated" ], - "title": "SearchToolDocumentsDelta" + "title": "ConnectorSnapshot" }, - "ContainerVersions": { + "TaskStatus": { + "type": "string", + "enum": [ + "PENDING", + "STARTED", + "SUCCESS", + "FAILURE" + ], + "title": "TaskStatus" + }, + "ThemePreference": { + "type": "string", + "enum": [ + "light", + "dark", + "system" + ], + "title": "ThemePreference" + }, + "CitationInfo": { "properties": { - "onyx": { - "type": "string", - "title": "Onyx" - }, - "relational_db": { + "type": { "type": "string", - "title": "Relational Db" + "const": "citation_info", + "title": "Type", + "default": "citation_info" }, - "index": { - "type": "string", - "title": "Index" + "citation_number": { + "type": "integer", + "title": "Citation Number" }, - "nginx": { + "document_id": { "type": "string", - "title": "Nginx" + "title": "Document Id" } }, "type": "object", "required": [ - "onyx", - "relational_db", - "index", - "nginx" + "citation_number", + "document_id" ], - "title": "ContainerVersions" + "title": "CitationInfo" }, "UserRoleResponse": { "properties": { @@ -5465,95 +5492,72 @@ ], "title": "UserRoleResponse" }, - "ChatSessionSharedStatus": { - "type": "string", - "enum": [ - "public", - "private" - ], - "title": "ChatSessionSharedStatus" - }, - "UserRole": { - "type": "string", - "enum": [ - "limited", - "basic", - "admin", - "curator", - "global_curator", - "slack_user", - "ext_perm_user" - ], - "title": "UserRole", - "description": "User roles\n- Basic can't perform any admin actions\n- Admin can perform all admin actions\n- Curator can perform admin actions for\n groups they are curators of\n- Global Curator can perform admin actions\n for all groups they are a member of\n- Limited can access a limited set of basic api endpoints\n- Slack are users that have used onyx via slack but dont have a web login\n- External permissioned users that have been picked up during the external permissions sync process but don't have a web login" - }, - "OpenUrlsToolRequest": { + "PaginatedReturn_MinimalPersonaSnapshot_": { "properties": { - "urls": { + "items": { "items": { - "type": "string" + "$ref": "#/components/schemas/MinimalPersonaSnapshot" }, "type": "array", - "minItems": 1, - "title": "Urls", - "description": "URLs to fetch using the configured content provider." - } - }, - "type": "object", - "required": [ - "urls" + "title": "Items" + }, + "total_items": { + "type": "integer", + "title": "Total Items" + } + }, + "type": "object", + "required": [ + "items", + "total_items" ], - "title": "OpenUrlsToolRequest" + "title": "PaginatedReturn[MinimalPersonaSnapshot]" }, - "CustomToolDelta": { + "Tag": { "properties": { - "type": { + "tag_key": { "type": "string", - "const": "custom_tool_delta", - "title": "Type", - "default": "custom_tool_delta" + "title": "Tag Key" }, - "tool_name": { + "tag_value": { "type": "string", - "title": "Tool Name" - }, - "response_type": { + "title": "Tag Value" + } + }, + "type": "object", + "required": [ + "tag_key", + "tag_value" + ], + "title": "Tag" + }, + "CustomToolCreate": { + "properties": { + "name": { "type": "string", - "title": "Response Type" + "title": "Name" }, - "data": { + "description": { "anyOf": [ - { - "additionalProperties": true, - "type": "object" - }, - { - "items": {}, - "type": "array" - }, { "type": "string" }, - { - "type": "integer" - }, - { - "type": "number" - }, - { - "type": "boolean" - }, { "type": "null" } ], - "title": "Data" + "title": "Description" }, - "file_ids": { + "definition": { + "additionalProperties": true, + "type": "object", + "title": "Definition" + }, + "custom_headers": { "anyOf": [ { "items": { - "type": "string" + "$ref": "#/components/schemas/Header" }, "type": "array" }, @@ -5561,17 +5565,55 @@ "type": "null" } ], - "title": "File Ids" + "title": "Custom Headers" + }, + "passthrough_auth": { + "type": "boolean", + "title": "Passthrough Auth" + }, + "oauth_config_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Oauth Config Id" } }, "type": "object", "required": [ - "tool_name", - "response_type" + "name", + "definition", + "passthrough_auth" ], - "title": "CustomToolDelta" + "title": "CustomToolCreate" }, - "ToolSnapshot": { + "CredentialSwapRequest": { + "properties": { + "new_credential_id": { + "type": "integer", + "title": "New Credential Id" + }, + "connector_id": { + "type": "integer", + "title": "Connector Id" + }, + "access_type": { + "$ref": "#/components/schemas/AccessType" + } + }, + "type": "object", + "required": [ + "new_credential_id", + "connector_id", + "access_type" + ], + "title": "CredentialSwapRequest" + }, + "UserProjectSnapshot": { "properties": { "id": { "type": "integer", @@ -5582,26 +5624,34 @@ "title": "Name" }, "description": { - "type": "string", - "title": "Description" - }, - "definition": { "anyOf": [ { - "additionalProperties": true, - "type": "object" + "type": "string" }, { "type": "null" } ], - "title": "Definition" + "title": "Description" }, - "display_name": { + "created_at": { "type": "string", - "title": "Display Name" + "format": "date-time", + "title": "Created At" }, - "in_code_tool_id": { + "user_id": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "User Id" + }, + "instructions": { "anyOf": [ { "type": "string" @@ -5610,36 +5660,108 @@ "type": "null" } ], - "title": "In Code Tool Id" + "title": "Instructions" }, - "custom_headers": { + "chat_sessions": { + "items": { + "$ref": "#/components/schemas/ChatSessionDetails" + }, + "type": "array", + "title": "Chat Sessions" + } + }, + "type": "object", + "required": [ + "id", + "name", + "description", + "created_at", + "user_id", + "chat_sessions" + ], + "title": "UserProjectSnapshot" + }, + "MinimalUserSnapshot": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Id" + }, + "email": { + "type": "string", + "title": "Email" + } + }, + "type": "object", + "required": [ + "id", + "email" + ], + "title": "MinimalUserSnapshot" + }, + "MinimalPersonaSnapshot": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "tools": { + "items": { + "$ref": "#/components/schemas/ToolSnapshot" + }, + "type": "array", + "title": "Tools" + }, + "starter_messages": { "anyOf": [ { - "items": {}, + "items": { + "$ref": "#/components/schemas/StarterMessage" + }, "type": "array" }, { "type": "null" } ], - "title": "Custom Headers" + "title": "Starter Messages" }, - "passthrough_auth": { + "llm_relevance_filter": { "type": "boolean", - "title": "Passthrough Auth" + "title": "Llm Relevance Filter" }, - "mcp_server_id": { + "llm_filter_extraction": { + "type": "boolean", + "title": "Llm Filter Extraction" + }, + "document_sets": { + "items": { + "$ref": "#/components/schemas/DocumentSetSummary" + }, + "type": "array", + "title": "Document Sets" + }, + "llm_model_version_override": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Mcp Server Id" + "title": "Llm Model Version Override" }, - "user_id": { + "llm_model_provider_override": { "anyOf": [ { "type": "string" @@ -5648,20 +5770,20 @@ "type": "null" } ], - "title": "User Id" + "title": "Llm Model Provider Override" }, - "oauth_config_id": { + "uploaded_image_id": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Oauth Config Id" + "title": "Uploaded Image Id" }, - "oauth_config_name": { + "icon_name": { "anyOf": [ { "type": "string" @@ -5670,212 +5792,163 @@ "type": "null" } ], - "title": "Oauth Config Name" + "title": "Icon Name" }, - "enabled": { + "is_public": { "type": "boolean", - "title": "Enabled", - "default": true - }, - "chat_selectable": { - "type": "boolean", - "title": "Chat Selectable", - "default": true - }, - "agent_creation_selectable": { - "type": "boolean", - "title": "Agent Creation Selectable", - "default": true - }, - "default_enabled": { - "type": "boolean", - "title": "Default Enabled", - "default": false - } - }, - "type": "object", - "required": [ - "id", - "name", - "description", - "definition", - "display_name", - "in_code_tool_id", - "custom_headers", - "passthrough_auth" - ], - "title": "ToolSnapshot" - }, - "AuthTypeResponse": { - "properties": { - "auth_type": { - "$ref": "#/components/schemas/AuthType" + "title": "Is Public" }, - "requires_verification": { + "is_visible": { "type": "boolean", - "title": "Requires Verification" + "title": "Is Visible" }, - "anonymous_user_enabled": { + "display_priority": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Anonymous User Enabled" + "title": "Display Priority" }, - "password_min_length": { - "type": "integer", - "title": "Password Min Length" - } - }, - "type": "object", - "required": [ - "auth_type", - "requires_verification", - "password_min_length" - ], - "title": "AuthTypeResponse" - }, - "FederatedConnectorStatus": { - "properties": { - "id": { - "type": "integer", - "title": "Id" + "is_default_persona": { + "type": "boolean", + "title": "Is Default Persona" }, - "source": { - "$ref": "#/components/schemas/FederatedConnectorSource" + "builtin_persona": { + "type": "boolean", + "title": "Builtin Persona" }, - "name": { - "type": "string", - "title": "Name" - } - }, - "type": "object", - "required": [ - "id", - "source", - "name" - ], - "title": "FederatedConnectorStatus" - }, - "PaginatedReturn_IndexAttemptErrorPydantic_": { - "properties": { - "items": { + "labels": { "items": { - "$ref": "#/components/schemas/IndexAttemptErrorPydantic" + "$ref": "#/components/schemas/PersonaLabelSnapshot" }, "type": "array", - "title": "Items" + "title": "Labels" }, - "total_items": { - "type": "integer", - "title": "Total Items" + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/MinimalUserSnapshot" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "items", - "total_items" + "id", + "name", + "description", + "tools", + "starter_messages", + "llm_relevance_filter", + "llm_filter_extraction", + "document_sets", + "llm_model_version_override", + "llm_model_provider_override", + "uploaded_image_id", + "icon_name", + "is_public", + "is_visible", + "display_priority", + "is_default_persona", + "builtin_persona", + "labels", + "owner" ], - "title": "PaginatedReturn[IndexAttemptErrorPydantic]" + "title": "MinimalPersonaSnapshot", + "description": "Minimal persona model optimized for ChatPage.tsx - only includes fields actually used" }, - "CreateChatSessionID": { + "TenantInfo": { "properties": { - "chat_session_id": { - "type": "string", - "format": "uuid", - "title": "Chat Session Id" + "invitation": { + "anyOf": [ + { + "$ref": "#/components/schemas/TenantSnapshot" + }, + { + "type": "null" + } + ] + }, + "new_tenant": { + "anyOf": [ + { + "$ref": "#/components/schemas/TenantSnapshot" + }, + { + "type": "null" + } + ] } }, "type": "object", - "required": [ - "chat_session_id" - ], - "title": "CreateChatSessionID" + "title": "TenantInfo" }, - "CategorizedFilesSnapshot": { + "CredentialSnapshot": { "properties": { - "user_files": { - "items": { - "$ref": "#/components/schemas/UserFileSnapshot" - }, - "type": "array", - "title": "User Files" + "credential_json": { + "additionalProperties": true, + "type": "object", + "title": "Credential Json" }, - "non_accepted_files": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Non Accepted Files" + "admin_public": { + "type": "boolean", + "title": "Admin Public" + }, + "source": { + "$ref": "#/components/schemas/DocumentSource" }, - "unsupported_files": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Unsupported Files" - } - }, - "type": "object", - "required": [ - "user_files", - "non_accepted_files", - "unsupported_files" - ], - "title": "CategorizedFilesSnapshot" - }, - "PersonaUpsertRequest": { - "properties": { "name": { - "type": "string", + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name" }, - "description": { - "type": "string", - "title": "Description" + "curator_public": { + "type": "boolean", + "title": "Curator Public", + "default": false }, - "document_set_ids": { + "groups": { "items": { "type": "integer" }, "type": "array", - "title": "Document Set Ids" - }, - "num_chunks": { - "type": "number", - "title": "Num Chunks" - }, - "is_public": { - "type": "boolean", - "title": "Is Public" - }, - "recency_bias": { - "$ref": "#/components/schemas/RecencyBiasSetting" + "title": "Groups" }, - "llm_filter_extraction": { + "is_user_file": { "type": "boolean", - "title": "Llm Filter Extraction" + "title": "Is User File", + "default": false }, - "llm_relevance_filter": { - "type": "boolean", - "title": "Llm Relevance Filter" + "id": { + "type": "integer", + "title": "Id" }, - "llm_model_provider_override": { + "user_id": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "uuid" }, { "type": "null" } ], - "title": "Llm Model Provider Override" + "title": "User Id" }, - "llm_model_version_override": { + "user_email": { "anyOf": [ { "type": "string" @@ -5884,67 +5957,38 @@ "type": "null" } ], - "title": "Llm Model Version Override" + "title": "User Email" }, - "starter_messages": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/StarterMessage" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Starter Messages" - }, - "users": { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array", - "title": "Users" - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" - }, - "tool_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Tool Ids" - }, - "remove_image": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Remove Image" + "time_created": { + "type": "string", + "format": "date-time", + "title": "Time Created" }, - "uploaded_image_id": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Uploaded Image Id" + "time_updated": { + "type": "string", + "format": "date-time", + "title": "Time Updated" + } + }, + "type": "object", + "required": [ + "credential_json", + "admin_public", + "source", + "id", + "user_id", + "time_created", + "time_updated" + ], + "title": "CredentialSnapshot" + }, + "StatusResponse_int_": { + "properties": { + "success": { + "type": "boolean", + "title": "Success" }, - "icon_name": { + "message": { "anyOf": [ { "type": "string" @@ -5953,102 +5997,80 @@ "type": "null" } ], - "title": "Icon Name" - }, - "search_start_date": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Search Start Date" + "title": "Message" }, - "label_ids": { + "data": { "anyOf": [ { - "items": { - "type": "integer" - }, - "type": "array" + "type": "integer" }, { "type": "null" } ], - "title": "Label Ids" + "title": "Data" + } + }, + "type": "object", + "required": [ + "success" + ], + "title": "StatusResponse[int]" + }, + "CredentialBase": { + "properties": { + "credential_json": { + "additionalProperties": true, + "type": "object", + "title": "Credential Json" }, - "is_default_persona": { + "admin_public": { "type": "boolean", - "title": "Is Default Persona", - "default": false + "title": "Admin Public" }, - "display_priority": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Display Priority" + "source": { + "$ref": "#/components/schemas/DocumentSource" }, - "user_file_ids": { + "name": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "User File Ids" - }, - "system_prompt": { - "type": "string", - "title": "System Prompt" + "title": "Name" }, - "replace_base_system_prompt": { + "curator_public": { "type": "boolean", - "title": "Replace Base System Prompt", + "title": "Curator Public", "default": false }, - "task_prompt": { - "type": "string", - "title": "Task Prompt" + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups" }, - "datetime_aware": { + "is_user_file": { "type": "boolean", - "title": "Datetime Aware" + "title": "Is User File", + "default": false } }, "type": "object", "required": [ - "name", - "description", - "document_set_ids", - "num_chunks", - "is_public", - "recency_bias", - "llm_filter_extraction", - "llm_relevance_filter", - "tool_ids", - "system_prompt", - "task_prompt", - "datetime_aware" + "credential_json", + "admin_public", + "source" ], - "title": "PersonaUpsertRequest" + "title": "CredentialBase" }, - "ProjectInstructionsResponse": { + "PromptOverride": { "properties": { - "instructions": { + "system_prompt": { "anyOf": [ { "type": "string" @@ -6057,185 +6079,287 @@ "type": "null" } ], - "title": "Instructions" - } - }, - "type": "object", - "required": [ - "instructions" - ], - "title": "ProjectInstructionsResponse" - }, - "RecencyBiasSetting": { - "type": "string", - "enum": [ - "favor_recent", - "base_decay", - "no_decay", - "auto" - ], - "title": "RecencyBiasSetting" - }, - "WebSearchProviderType": { - "type": "string", - "enum": [ - "google_pse", - "serper", - "exa", - "searxng" - ], - "title": "WebSearchProviderType" - }, - "Placement": { - "properties": { - "turn_index": { - "type": "integer", - "title": "Turn Index" - }, - "tab_index": { - "type": "integer", - "title": "Tab Index", - "default": 0 + "title": "System Prompt" }, - "sub_turn_index": { + "task_prompt": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Sub Turn Index" + "title": "Task Prompt" } }, "type": "object", - "required": [ - "turn_index" - ], - "title": "Placement" + "title": "PromptOverride" }, - "StatusResponse_int_": { + "IntermediateReportCitedDocs": { "properties": { - "success": { - "type": "boolean", - "title": "Success" + "type": { + "type": "string", + "const": "intermediate_report_cited_docs", + "title": "Type", + "default": "intermediate_report_cited_docs" }, - "message": { + "cited_docs": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/SearchDoc" + }, + "type": "array" }, { "type": "null" } ], - "title": "Message" + "title": "Cited Docs" + } + }, + "type": "object", + "title": "IntermediateReportCitedDocs" + }, + "IndexingStatus": { + "type": "string", + "enum": [ + "not_started", + "in_progress", + "success", + "canceled", + "failed", + "completed_with_errors" + ], + "title": "IndexingStatus" + }, + "Body_bulk_invite_users_manage_admin_users_put": { + "properties": { + "emails": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Emails" + } + }, + "type": "object", + "required": [ + "emails" + ], + "title": "Body_bulk_invite_users_manage_admin_users_put" + }, + "ChatSessionGroup": { + "properties": { + "title": { + "type": "string", + "title": "Title" }, - "data": { + "chats": { + "items": { + "$ref": "#/components/schemas/ChatSessionSummary" + }, + "type": "array", + "title": "Chats" + } + }, + "type": "object", + "required": [ + "title", + "chats" + ], + "title": "ChatSessionGroup" + }, + "WebContentProviderType": { + "type": "string", + "enum": [ + "onyx_web_crawler", + "firecrawl" + ], + "title": "WebContentProviderType" + }, + "Body_create_credential_with_private_key_manage_credential_private_key_post": { + "properties": { + "credential_json": { + "type": "string", + "title": "Credential Json" + }, + "admin_public": { + "type": "boolean", + "title": "Admin Public", + "default": false + }, + "curator_public": { + "type": "boolean", + "title": "Curator Public", + "default": false + }, + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups", + "default": [] + }, + "name": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Data" + "title": "Name" + }, + "source": { + "type": "string", + "title": "Source" + }, + "uploaded_file": { + "type": "string", + "format": "binary", + "title": "Uploaded File" + }, + "field_key": { + "type": "string", + "title": "Field Key" + }, + "type_definition_key": { + "type": "string", + "title": "Type Definition Key" } }, "type": "object", "required": [ - "success" + "credential_json", + "source", + "uploaded_file", + "field_key", + "type_definition_key" ], - "title": "StatusResponse[int]" + "title": "Body_create_credential_with_private_key_manage_credential_private_key_post" }, - "CCPairFullInfo": { + "DocsCountOperator": { + "type": "string", + "enum": [ + ">", + "<", + "=" + ], + "title": "DocsCountOperator" + }, + "HTTPValidationError": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "status": { - "$ref": "#/components/schemas/ConnectorCredentialPairStatus" - }, - "in_repeated_error_state": { + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" + } + }, + "type": "object", + "title": "HTTPValidationError" + }, + "UserFileDeleteResult": { + "properties": { + "has_associations": { "type": "boolean", - "title": "In Repeated Error State" - }, - "num_docs_indexed": { - "type": "integer", - "title": "Num Docs Indexed" + "title": "Has Associations" }, - "connector": { - "$ref": "#/components/schemas/ConnectorSnapshot" + "project_names": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Project Names", + "default": [] }, - "credential": { - "$ref": "#/components/schemas/CredentialSnapshot" + "assistant_names": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Assistant Names", + "default": [] + } + }, + "type": "object", + "required": [ + "has_associations" + ], + "title": "UserFileDeleteResult" + }, + "ConnectorFileInfo": { + "properties": { + "file_id": { + "type": "string", + "title": "File Id" }, - "number_of_index_attempts": { - "type": "integer", - "title": "Number Of Index Attempts" + "file_name": { + "type": "string", + "title": "File Name" }, - "last_index_attempt_status": { + "file_size": { "anyOf": [ { - "$ref": "#/components/schemas/IndexingStatus" + "type": "integer" }, { "type": "null" } - ] + ], + "title": "File Size" }, - "latest_deletion_attempt": { + "upload_date": { "anyOf": [ { - "$ref": "#/components/schemas/DeletionAttemptSnapshot" + "type": "string" }, { "type": "null" } - ] - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" - }, - "is_editable_for_current_user": { - "type": "boolean", - "title": "Is Editable For Current User" + ], + "title": "Upload Date" + } + }, + "type": "object", + "required": [ + "file_id", + "file_name" + ], + "title": "ConnectorFileInfo" + }, + "ChatSeedRequest": { + "properties": { + "persona_id": { + "type": "integer", + "title": "Persona Id" }, - "deletion_failure_message": { + "llm_override": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/LLMOverride" }, { "type": "null" } - ], - "title": "Deletion Failure Message" - }, - "indexing": { - "type": "boolean", - "title": "Indexing" + ] }, - "creator": { + "prompt_override": { "anyOf": [ { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/PromptOverride" }, { "type": "null" } - ], - "title": "Creator" + ] }, - "creator_email": { + "description": { "anyOf": [ { "type": "string" @@ -6244,56 +6368,153 @@ "type": "null" } ], - "title": "Creator Email" + "title": "Description" }, - "last_indexed": { + "message": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Indexed" + "title": "Message" + } + }, + "type": "object", + "required": [ + "persona_id" + ], + "title": "ChatSeedRequest" + }, + "PaginatedReturn_PersonaSnapshot_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/PersonaSnapshot" + }, + "type": "array", + "title": "Items" }, - "last_pruned": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Pruned" + "total_items": { + "type": "integer", + "title": "Total Items" + } + }, + "type": "object", + "required": [ + "items", + "total_items" + ], + "title": "PaginatedReturn[PersonaSnapshot]" + }, + "CCPairSummary": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "last_full_permission_sync": { + "name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Last Full Permission Sync" + "title": "Name" }, - "overall_indexing_speed": { + "source": { + "$ref": "#/components/schemas/DocumentSource" + }, + "access_type": { + "$ref": "#/components/schemas/AccessType" + } + }, + "type": "object", + "required": [ + "id", + "name", + "source", + "access_type" + ], + "title": "CCPairSummary", + "description": "Simplified connector-credential pair information with just essential data" + }, + "AuthType": { + "type": "string", + "enum": [ + "disabled", + "basic", + "google_oauth", + "oidc", + "saml", + "cloud" + ], + "title": "AuthType" + }, + "ValidateToolResponse": { + "properties": { + "methods": { + "items": { + "$ref": "#/components/schemas/MethodSpec" + }, + "type": "array", + "title": "Methods" + } + }, + "type": "object", + "required": [ + "methods" + ], + "title": "ValidateToolResponse" + }, + "PythonToolDelta": { + "properties": { + "type": { + "type": "string", + "const": "python_tool_delta", + "title": "Type", + "default": "python_tool_delta" + }, + "stdout": { + "type": "string", + "title": "Stdout", + "default": "" + }, + "stderr": { + "type": "string", + "title": "Stderr", + "default": "" + }, + "file_ids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "File Ids", + "default": [] + } + }, + "type": "object", + "title": "PythonToolDelta" + }, + "RerankingDetails": { + "properties": { + "rerank_model_name": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Overall Indexing Speed" + "title": "Rerank Model Name" }, - "latest_checkpoint_description": { + "rerank_api_url": { "anyOf": [ { "type": "string" @@ -6302,35 +6523,19 @@ "type": "null" } ], - "title": "Latest Checkpoint Description" + "title": "Rerank Api Url" }, - "last_permission_sync_attempt_status": { + "rerank_provider_type": { "anyOf": [ { - "$ref": "#/components/schemas/PermissionSyncStatus" + "$ref": "#/components/schemas/RerankerProvider" }, { "type": "null" } ] }, - "permission_syncing": { - "type": "boolean", - "title": "Permission Syncing" - }, - "last_permission_sync_attempt_finished": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Permission Sync Attempt Finished" - }, - "last_permission_sync_attempt_error_message": { + "rerank_api_key": { "anyOf": [ { "type": "string" @@ -6339,69 +6544,54 @@ "type": "null" } ], - "title": "Last Permission Sync Attempt Error Message" + "title": "Rerank Api Key" + }, + "num_rerank": { + "type": "integer", + "title": "Num Rerank" + }, + "disable_rerank_for_streaming": { + "type": "boolean", + "title": "Disable Rerank For Streaming", + "default": false } }, "type": "object", "required": [ - "id", - "name", - "status", - "in_repeated_error_state", - "num_docs_indexed", - "connector", - "credential", - "number_of_index_attempts", - "last_index_attempt_status", - "latest_deletion_attempt", - "access_type", - "is_editable_for_current_user", - "deletion_failure_message", - "indexing", - "creator", - "creator_email", - "last_indexed", - "last_pruned", - "last_full_permission_sync", - "overall_indexing_speed", - "latest_checkpoint_description", - "last_permission_sync_attempt_status", - "permission_syncing", - "last_permission_sync_attempt_finished", - "last_permission_sync_attempt_error_message" - ], - "title": "CCPairFullInfo" - }, - "TaskStatus": { - "type": "string", - "enum": [ - "PENDING", - "STARTED", - "SUCCESS", - "FAILURE" + "rerank_model_name", + "rerank_api_url", + "rerank_provider_type", + "num_rerank" ], - "title": "TaskStatus" + "title": "RerankingDetails" }, - "PaginatedReturn_MinimalPersonaSnapshot_": { + "TokenRateLimitDisplay": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/MinimalPersonaSnapshot" - }, - "type": "array", - "title": "Items" + "token_id": { + "type": "integer", + "title": "Token Id" }, - "total_items": { + "enabled": { + "type": "boolean", + "title": "Enabled" + }, + "token_budget": { "type": "integer", - "title": "Total Items" + "title": "Token Budget" + }, + "period_hours": { + "type": "integer", + "title": "Period Hours" } }, "type": "object", "required": [ - "items", - "total_items" + "token_id", + "enabled", + "token_budget", + "period_hours" ], - "title": "PaginatedReturn[MinimalPersonaSnapshot]" + "title": "TokenRateLimitDisplay" }, "SavedSearchDoc": { "properties": { @@ -6566,86 +6756,124 @@ ], "title": "SavedSearchDoc" }, - "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put": { + "RetrievalDetails": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "credential_json": { - "type": "string", - "title": "Credential Json" + "chunks_above": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Chunks Above" }, - "uploaded_file": { - "type": "string", - "format": "binary", - "title": "Uploaded File" + "chunks_below": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Chunks Below" }, - "field_key": { - "type": "string", - "title": "Field Key" + "full_doc": { + "type": "boolean", + "title": "Full Doc", + "default": false }, - "type_definition_key": { - "type": "string", - "title": "Type Definition Key" + "run_search": { + "$ref": "#/components/schemas/OptionalSearchSetting", + "default": "auto" + }, + "real_time": { + "type": "boolean", + "title": "Real Time", + "default": true + }, + "filters": { + "anyOf": [ + { + "$ref": "#/components/schemas/BaseFilters" + }, + { + "type": "null" + } + ] + }, + "enable_auto_detect_filters": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Enable Auto Detect Filters" + }, + "offset": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Offset" + }, + "limit": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Limit" + }, + "dedupe_docs": { + "type": "boolean", + "title": "Dedupe Docs", + "default": false } }, "type": "object", - "required": [ - "name", - "credential_json", - "uploaded_file", - "field_key", - "type_definition_key" - ], - "title": "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put" - }, - "UserFileStatus": { - "type": "string", - "enum": [ - "PROCESSING", - "COMPLETED", - "FAILED", - "CANCELED", - "DELETING" - ], - "title": "UserFileStatus" - }, - "WebContentProviderType": { - "type": "string", - "enum": [ - "onyx_web_crawler", - "firecrawl" - ], - "title": "WebContentProviderType" + "title": "RetrievalDetails" }, - "ConnectorFilesResponse": { + "Placement": { "properties": { - "files": { - "items": { - "$ref": "#/components/schemas/ConnectorFileInfo" - }, - "type": "array", - "title": "Files" + "turn_index": { + "type": "integer", + "title": "Turn Index" + }, + "tab_index": { + "type": "integer", + "title": "Tab Index", + "default": 0 + }, + "sub_turn_index": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Sub Turn Index" } }, "type": "object", "required": [ - "files" - ], - "title": "ConnectorFilesResponse" - }, - "ConnectorCredentialPairStatus": { - "type": "string", - "enum": [ - "SCHEDULED", - "INITIAL_INDEXING", - "ACTIVE", - "PAUSED", - "DELETING", - "INVALID" + "turn_index" ], - "title": "ConnectorCredentialPairStatus" + "title": "Placement" }, "BaseFilters": { "properties": { @@ -6707,193 +6935,112 @@ "type": "object", "title": "BaseFilters" }, - "InputType": { - "type": "string", - "enum": [ - "load_state", - "poll", - "event", - "slim_retrieval" - ], - "title": "InputType" - }, - "FederatedConnectorSummary": { + "ChatSearchResponse": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" + "groups": { + "items": { + "$ref": "#/components/schemas/ChatSessionGroup" + }, + "type": "array", + "title": "Groups" }, - "source": { - "$ref": "#/components/schemas/FederatedConnectorSource" + "has_more": { + "type": "boolean", + "title": "Has More" }, - "entities": { - "additionalProperties": true, - "type": "object", - "title": "Entities" + "next_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Next Page" } }, "type": "object", "required": [ - "id", - "name", - "source", - "entities" + "groups", + "has_more" ], - "title": "FederatedConnectorSummary", - "description": "Simplified federated connector information with just essential data" + "title": "ChatSearchResponse" }, - "ConnectorUpdateRequest": { + "StatusResponse_list_int__": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "source": { - "$ref": "#/components/schemas/DocumentSource" - }, - "input_type": { - "$ref": "#/components/schemas/InputType" - }, - "connector_specific_config": { - "additionalProperties": true, - "type": "object", - "title": "Connector Specific Config" + "success": { + "type": "boolean", + "title": "Success" }, - "refresh_freq": { + "message": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Refresh Freq" + "title": "Message" }, - "prune_freq": { + "data": { "anyOf": [ { - "type": "integer" + "items": { + "type": "integer" + }, + "type": "array" }, { "type": "null" } ], - "title": "Prune Freq" - }, - "indexing_start": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Indexing Start" - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" + "title": "Data" } }, "type": "object", "required": [ - "name", - "source", - "input_type", - "connector_specific_config", - "access_type" + "success" ], - "title": "ConnectorUpdateRequest" + "title": "StatusResponse[list[int]]" }, - "ImageGenerationFinal": { + "FullUserSnapshot": { "properties": { - "type": { + "id": { "type": "string", - "const": "image_generation_final", - "title": "Type", - "default": "image_generation_final" - }, - "images": { - "items": { - "$ref": "#/components/schemas/GeneratedImage" - }, - "type": "array", - "title": "Images" - } - }, - "type": "object", - "required": [ - "images" - ], - "title": "ImageGenerationFinal" - }, - "DocumentSearchPagination": { - "properties": { - "offset": { - "type": "integer", - "title": "Offset" + "format": "uuid", + "title": "Id" }, - "limit": { - "type": "integer", - "title": "Limit" + "email": { + "type": "string", + "title": "Email" }, - "returned_count": { - "type": "integer", - "title": "Returned Count" + "role": { + "$ref": "#/components/schemas/UserRole" }, - "has_more": { + "is_active": { "type": "boolean", - "title": "Has More" + "title": "Is Active" }, - "next_offset": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Next Offset" + "password_configured": { + "type": "boolean", + "title": "Password Configured" } }, "type": "object", "required": [ - "offset", - "limit", - "returned_count", - "has_more" + "id", + "email", + "role", + "is_active", + "password_configured" ], - "title": "DocumentSearchPagination" + "title": "FullUserSnapshot" }, - "SearchDoc": { + "LLMOverride": { "properties": { - "document_id": { - "type": "string", - "title": "Document Id" - }, - "chunk_ind": { - "type": "integer", - "title": "Chunk Ind" - }, - "semantic_identifier": { - "type": "string", - "title": "Semantic Identifier" - }, - "link": { + "model_provider": { "anyOf": [ { "type": "string" @@ -6902,291 +7049,268 @@ "type": "null" } ], - "title": "Link" - }, - "blurb": { - "type": "string", - "title": "Blurb" - }, - "source_type": { - "$ref": "#/components/schemas/DocumentSource" - }, - "boost": { - "type": "integer", - "title": "Boost" - }, - "hidden": { - "type": "boolean", - "title": "Hidden" - }, - "metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ] - }, - "type": "object", - "title": "Metadata" + "title": "Model Provider" }, - "score": { + "model_version": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Score" + "title": "Model Version" }, - "is_relevant": { + "temperature": { "anyOf": [ { - "type": "boolean" + "type": "number" }, { "type": "null" } ], - "title": "Is Relevant" + "title": "Temperature" + } + }, + "type": "object", + "title": "LLMOverride" + }, + "AllUsersResponse": { + "properties": { + "accepted": { + "items": { + "$ref": "#/components/schemas/FullUserSnapshot" + }, + "type": "array", + "title": "Accepted" }, - "relevance_explanation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Relevance Explanation" + "invited": { + "items": { + "$ref": "#/components/schemas/InvitedUserSnapshot" + }, + "type": "array", + "title": "Invited" }, - "match_highlights": { + "slack_users": { "items": { - "type": "string" + "$ref": "#/components/schemas/FullUserSnapshot" }, "type": "array", - "title": "Match Highlights" + "title": "Slack Users" }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" + "accepted_pages": { + "type": "integer", + "title": "Accepted Pages" }, - "primary_owners": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Primary Owners" + "invited_pages": { + "type": "integer", + "title": "Invited Pages" }, - "secondary_owners": { + "slack_users_pages": { + "type": "integer", + "title": "Slack Users Pages" + } + }, + "type": "object", + "required": [ + "accepted", + "invited", + "slack_users", + "accepted_pages", + "invited_pages", + "slack_users_pages" + ], + "title": "AllUsersResponse" + }, + "LlmOpenUrlResult": { + "properties": { + "document_citation_number": { + "type": "integer", + "title": "Document Citation Number" + }, + "unique_identifier_to_strip_away": { "anyOf": [ { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Secondary Owners" + "title": "Unique Identifier To Strip Away" }, - "is_internet": { - "type": "boolean", - "title": "Is Internet", - "default": false - } + "type": { + "type": "string", + "const": "open_url", + "title": "Type", + "default": "open_url" + }, + "content": { + "type": "string", + "title": "Content" + } }, "type": "object", "required": [ - "document_id", - "chunk_ind", - "semantic_identifier", - "blurb", - "source_type", - "boost", - "hidden", - "metadata", - "match_highlights" + "document_citation_number", + "content" ], - "title": "SearchDoc" + "title": "LlmOpenUrlResult", + "description": "Result from opening/fetching a URL" }, - "ChatSessionDetails": { + "OpenUrlUrls": { "properties": { - "id": { - "type": "string", - "format": "uuid", - "title": "Id" - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "persona_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Persona Id" - }, - "time_created": { - "type": "string", - "title": "Time Created" - }, - "time_updated": { + "type": { "type": "string", - "title": "Time Updated" - }, - "shared_status": { - "$ref": "#/components/schemas/ChatSessionSharedStatus" - }, - "current_alternate_model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Alternate Model" + "const": "open_url_urls", + "title": "Type", + "default": "open_url_urls" }, - "current_temperature_override": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Current Temperature Override" + "urls": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Urls" } }, "type": "object", "required": [ - "id", - "name", - "time_created", - "time_updated", - "shared_status" + "urls" ], - "title": "ChatSessionDetails" + "title": "OpenUrlUrls", + "description": "URLs to be fetched (sent before crawling begins)." }, - "PromptOverride": { + "ReasoningStart": { "properties": { - "system_prompt": { + "type": { + "type": "string", + "const": "reasoning_start", + "title": "Type", + "default": "reasoning_start" + } + }, + "type": "object", + "title": "ReasoningStart" + }, + "ProjectPayload": { + "properties": { + "project": { + "$ref": "#/components/schemas/UserProjectSnapshot" + }, + "files": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/UserFileSnapshot" + }, + "type": "array" }, { "type": "null" } ], - "title": "System Prompt" + "title": "Files" }, - "task_prompt": { + "persona_id_to_is_default": { "anyOf": [ { - "type": "string" + "additionalProperties": { + "type": "boolean" + }, + "type": "object" }, { "type": "null" } ], - "title": "Task Prompt" - } - }, - "type": "object", - "title": "PromptOverride" - }, - "CredentialSwapRequest": { - "properties": { - "new_credential_id": { - "type": "integer", - "title": "New Credential Id" - }, - "connector_id": { - "type": "integer", - "title": "Connector Id" - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" + "title": "Persona Id To Is Default" } }, "type": "object", "required": [ - "new_credential_id", - "connector_id", - "access_type" + "project" ], - "title": "CredentialSwapRequest" + "title": "ProjectPayload" }, - "TopLevelBranching": { + "UserByEmail": { "properties": { - "type": { + "user_email": { "type": "string", - "const": "top_level_branching", - "title": "Type", - "default": "top_level_branching" - }, - "num_parallel_branches": { - "type": "integer", - "title": "Num Parallel Branches" + "title": "User Email" } }, "type": "object", "required": [ - "num_parallel_branches" + "user_email" ], - "title": "TopLevelBranching" + "title": "UserByEmail" }, - "FileDescriptor": { + "DocumentSource": { + "type": "string", + "enum": [ + "ingestion_api", + "slack", + "web", + "google_drive", + "gmail", + "requesttracker", + "github", + "gitbook", + "gitlab", + "guru", + "bookstack", + "outline", + "confluence", + "jira", + "slab", + "productboard", + "file", + "coda", + "notion", + "zulip", + "linear", + "hubspot", + "document360", + "gong", + "google_sites", + "zendesk", + "loopio", + "dropbox", + "sharepoint", + "teams", + "salesforce", + "discourse", + "axero", + "clickup", + "mediawiki", + "wikipedia", + "asana", + "s3", + "r2", + "google_cloud_storage", + "oci_storage", + "xenforo", + "not_applicable", + "discord", + "freshdesk", + "fireflies", + "egnyte", + "airtable", + "highspot", + "drupal_wiki", + "imap", + "bitbucket", + "testrail", + "mock_connector", + "user_file" + ], + "title": "DocumentSource" + }, + "UpdateProjectRequest": { "properties": { - "id": { - "type": "string", - "title": "Id" - }, - "type": { - "$ref": "#/components/schemas/ChatFileType" - }, "name": { "anyOf": [ { @@ -7198,7 +7322,7 @@ ], "title": "Name" }, - "user_file_id": { + "description": { "anyOf": [ { "type": "string" @@ -7207,269 +7331,112 @@ "type": "null" } ], - "title": "User File Id" + "title": "Description" } }, "type": "object", - "required": [ - "id", - "type" - ], - "title": "FileDescriptor", - "description": "NOTE: is a `TypedDict` so it can be used as a type hint for a JSONB column\nin Postgres" - }, - "ChatSessionsResponse": { - "properties": { - "sessions": { - "items": { - "$ref": "#/components/schemas/ChatSessionDetails" - }, - "type": "array", - "title": "Sessions" - } - }, - "type": "object", - "required": [ - "sessions" - ], - "title": "ChatSessionsResponse" - }, - "PythonToolDelta": { - "properties": { - "type": { - "type": "string", - "const": "python_tool_delta", - "title": "Type", - "default": "python_tool_delta" - }, - "stdout": { - "type": "string", - "title": "Stdout", - "default": "" - }, - "stderr": { - "type": "string", - "title": "Stderr", - "default": "" - }, - "file_ids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "File Ids", - "default": [] - } - }, - "type": "object", - "title": "PythonToolDelta" - }, - "ValidateToolResponse": { - "properties": { - "methods": { - "items": { - "$ref": "#/components/schemas/MethodSpec" - }, - "type": "array", - "title": "Methods" - } - }, - "type": "object", - "required": [ - "methods" - ], - "title": "ValidateToolResponse" + "title": "UpdateProjectRequest" }, - "SendMessageRequest": { + "IndexAttemptErrorPydantic": { "properties": { - "message": { - "type": "string", - "title": "Message" + "id": { + "type": "integer", + "title": "Id" }, - "llm_override": { - "anyOf": [ - { - "$ref": "#/components/schemas/LLMOverride" - }, - { - "type": "null" - } - ] + "connector_credential_pair_id": { + "type": "integer", + "title": "Connector Credential Pair Id" }, - "allowed_tool_ids": { + "document_id": { "anyOf": [ { - "items": { - "type": "integer" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Allowed Tool Ids" + "title": "Document Id" }, - "forced_tool_id": { + "document_link": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Forced Tool Id" - }, - "file_descriptors": { - "items": { - "$ref": "#/components/schemas/FileDescriptor" - }, - "type": "array", - "title": "File Descriptors", - "default": [] - }, - "internal_search_filters": { - "anyOf": [ - { - "$ref": "#/components/schemas/BaseFilters" - }, - { - "type": "null" - } - ] - }, - "deep_research": { - "type": "boolean", - "title": "Deep Research", - "default": false + "title": "Document Link" }, - "parent_message_id": { + "entity_id": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Parent Message Id", - "default": -1 + "title": "Entity Id" }, - "chat_session_id": { + "failed_time_range_start": { "anyOf": [ { "type": "string", - "format": "uuid" + "format": "date-time" }, { "type": "null" } ], - "title": "Chat Session Id" + "title": "Failed Time Range Start" }, - "chat_session_info": { + "failed_time_range_end": { "anyOf": [ { - "$ref": "#/components/schemas/ChatSessionCreationRequest" + "type": "string", + "format": "date-time" }, { "type": "null" } - ] + ], + "title": "Failed Time Range End" }, - "stream": { - "type": "boolean", - "title": "Stream", - "default": true - } - }, - "type": "object", - "required": [ - "message" - ], - "title": "SendMessageRequest" - }, - "ChatSessionSummary": { - "properties": { - "id": { + "failure_message": { "type": "string", - "format": "uuid", - "title": "Id" - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" + "title": "Failure Message" }, - "persona_id": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Persona Id" + "is_resolved": { + "type": "boolean", + "title": "Is Resolved", + "default": false }, "time_created": { "type": "string", "format": "date-time", "title": "Time Created" }, - "shared_status": { - "$ref": "#/components/schemas/ChatSessionSharedStatus" - }, - "current_alternate_model": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Alternate Model" - }, - "current_temperature_override": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Current Temperature Override" + "index_attempt_id": { + "type": "integer", + "title": "Index Attempt Id" } }, "type": "object", "required": [ "id", + "connector_credential_pair_id", + "document_id", + "document_link", + "entity_id", + "failed_time_range_start", + "failed_time_range_end", + "failure_message", "time_created", - "shared_status" - ], - "title": "ChatSessionSummary" - }, - "TenantSnapshot": { - "properties": { - "number_of_users": { - "type": "integer", - "title": "Number Of Users" - } - }, - "type": "object", - "required": [ - "number_of_users" + "index_attempt_id" ], - "title": "TenantSnapshot" + "title": "IndexAttemptErrorPydantic" }, "UserInfo": { "properties": { @@ -7598,49 +7565,14 @@ ], "title": "UserInfo" }, - "UserSpecificAssistantPreference": { - "properties": { - "disabled_tool_ids": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Disabled Tool Ids" - } - }, - "type": "object", - "required": [ - "disabled_tool_ids" - ], - "title": "UserSpecificAssistantPreference" - }, - "AllVersions": { + "ChatSessionDetailResponse": { "properties": { - "stable": { - "$ref": "#/components/schemas/ContainerVersions" - }, - "dev": { - "$ref": "#/components/schemas/ContainerVersions" - }, - "migration": { - "$ref": "#/components/schemas/ContainerVersions" - } - }, - "type": "object", - "required": [ - "stable", - "dev", - "migration" - ], - "title": "AllVersions" - }, - "ConnectorStatus": { - "properties": { - "cc_pair_id": { - "type": "integer", - "title": "Cc Pair Id" + "chat_session_id": { + "type": "string", + "format": "uuid", + "title": "Chat Session Id" }, - "name": { + "description": { "anyOf": [ { "type": "string" @@ -7649,107 +7581,57 @@ "type": "null" } ], - "title": "Name" - }, - "connector": { - "$ref": "#/components/schemas/ConnectorSnapshot" - }, - "credential": { - "$ref": "#/components/schemas/CredentialSnapshot" - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" - } - }, - "type": "object", - "required": [ - "cc_pair_id", - "name", - "connector", - "credential", - "access_type", - "groups" - ], - "title": "ConnectorStatus", - "description": "Represents the status of a connector,\nincluding indexing status elated information" - }, - "UserFileSnapshot": { - "properties": { - "id": { - "type": "string", - "format": "uuid", - "title": "Id" + "title": "Description" }, - "temp_id": { + "persona_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Temp Id" - }, - "name": { - "type": "string", - "title": "Name" + "title": "Persona Id" }, - "project_id": { + "persona_name": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Project Id" + "title": "Persona Name" }, - "user_id": { + "personal_icon_name": { "anyOf": [ { - "type": "string", - "format": "uuid" + "type": "string" }, { "type": "null" } ], - "title": "User Id" + "title": "Personal Icon Name" }, - "file_id": { - "type": "string", - "title": "File Id" + "messages": { + "items": { + "$ref": "#/components/schemas/ChatMessageDetail" + }, + "type": "array", + "title": "Messages" }, - "created_at": { + "time_created": { "type": "string", "format": "date-time", - "title": "Created At" - }, - "status": { - "$ref": "#/components/schemas/UserFileStatus" + "title": "Time Created" }, - "last_accessed_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Last Accessed At" + "shared_status": { + "$ref": "#/components/schemas/ChatSessionSharedStatus" }, - "file_type": { + "current_alternate_model": { "anyOf": [ { "type": "string" @@ -7758,179 +7640,157 @@ "type": "null" } ], - "title": "File Type" - }, - "chat_file_type": { - "$ref": "#/components/schemas/ChatFileType" + "title": "Current Alternate Model" }, - "token_count": { + "current_temperature_override": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Token Count" + "title": "Current Temperature Override" }, - "chunk_count": { - "anyOf": [ - { - "type": "integer" + "deleted": { + "type": "boolean", + "title": "Deleted", + "default": false + }, + "packets": { + "items": { + "items": { + "$ref": "#/components/schemas/Packet" }, - { - "type": "null" - } - ], - "title": "Chunk Count" + "type": "array" + }, + "type": "array", + "title": "Packets" } }, "type": "object", "required": [ - "id", - "name", - "user_id", - "file_id", - "created_at", - "status", - "last_accessed_at", - "file_type", - "chat_file_type", - "token_count", - "chunk_count" + "chat_session_id", + "description", + "persona_name", + "personal_icon_name", + "messages", + "time_created", + "shared_status", + "current_alternate_model", + "current_temperature_override", + "packets" ], - "title": "UserFileSnapshot" + "title": "ChatSessionDetailResponse" }, - "IntermediateReportCitedDocs": { + "PaginatedReturn_IndexAttemptErrorPydantic_": { "properties": { - "type": { - "type": "string", - "const": "intermediate_report_cited_docs", - "title": "Type", - "default": "intermediate_report_cited_docs" + "items": { + "items": { + "$ref": "#/components/schemas/IndexAttemptErrorPydantic" + }, + "type": "array", + "title": "Items" }, - "cited_docs": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SearchDoc" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Cited Docs" + "total_items": { + "type": "integer", + "title": "Total Items" } }, "type": "object", - "title": "IntermediateReportCitedDocs" + "required": [ + "items", + "total_items" + ], + "title": "PaginatedReturn[IndexAttemptErrorPydantic]" }, - "MinimalPersonaSnapshot": { + "MessageType": { + "type": "string", + "enum": [ + "system", + "user", + "assistant", + "tool_call", + "tool_call_response" + ], + "title": "MessageType" + }, + "ConnectorIndexingStatusLite": { "properties": { - "id": { + "cc_pair_id": { "type": "integer", - "title": "Id" + "title": "Cc Pair Id" }, "name": { - "type": "string", - "title": "Name" - }, - "description": { - "type": "string", - "title": "Description" - }, - "tools": { - "items": { - "$ref": "#/components/schemas/ToolSnapshot" - }, - "type": "array", - "title": "Tools" - }, - "starter_messages": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/StarterMessage" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Starter Messages" + "title": "Name" }, - "llm_relevance_filter": { - "type": "boolean", - "title": "Llm Relevance Filter" + "source": { + "$ref": "#/components/schemas/DocumentSource" }, - "llm_filter_extraction": { - "type": "boolean", - "title": "Llm Filter Extraction" + "access_type": { + "$ref": "#/components/schemas/AccessType" }, - "document_sets": { - "items": { - "$ref": "#/components/schemas/DocumentSetSummary" - }, - "type": "array", - "title": "Document Sets" + "cc_pair_status": { + "$ref": "#/components/schemas/ConnectorCredentialPairStatus" }, - "llm_model_version_override": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Llm Model Version Override" + "in_progress": { + "type": "boolean", + "title": "In Progress" }, - "llm_model_provider_override": { + "in_repeated_error_state": { + "type": "boolean", + "title": "In Repeated Error State" + }, + "last_finished_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } - ], - "title": "Llm Model Provider Override" + ] }, - "uploaded_image_id": { + "last_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } - ], - "title": "Uploaded Image Id" + ] }, - "icon_name": { + "last_success": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Icon Name" + "title": "Last Success" }, - "is_public": { + "is_editable": { "type": "boolean", - "title": "Is Public" + "title": "Is Editable" }, - "is_visible": { - "type": "boolean", - "title": "Is Visible" + "docs_indexed": { + "type": "integer", + "title": "Docs Indexed" }, - "display_priority": { + "latest_index_attempt_docs_indexed": { "anyOf": [ { "type": "integer" @@ -7939,149 +7799,301 @@ "type": "null" } ], - "title": "Display Priority" - }, - "is_default_persona": { - "type": "boolean", - "title": "Is Default Persona" - }, - "builtin_persona": { - "type": "boolean", - "title": "Builtin Persona" - }, - "labels": { - "items": { - "$ref": "#/components/schemas/PersonaLabelSnapshot" - }, - "type": "array", - "title": "Labels" - }, - "owner": { - "anyOf": [ - { - "$ref": "#/components/schemas/MinimalUserSnapshot" - }, - { - "type": "null" - } - ] + "title": "Latest Index Attempt Docs Indexed" } }, "type": "object", "required": [ - "id", + "cc_pair_id", "name", - "description", - "tools", - "starter_messages", - "llm_relevance_filter", - "llm_filter_extraction", - "document_sets", - "llm_model_version_override", - "llm_model_provider_override", - "uploaded_image_id", - "icon_name", - "is_public", - "is_visible", - "display_priority", - "is_default_persona", - "builtin_persona", - "labels", - "owner" + "source", + "access_type", + "cc_pair_status", + "in_progress", + "in_repeated_error_state", + "last_finished_status", + "last_status", + "last_success", + "is_editable", + "docs_indexed", + "latest_index_attempt_docs_indexed" ], - "title": "MinimalPersonaSnapshot", - "description": "Minimal persona model optimized for ChatPage.tsx - only includes fields actually used" + "title": "ConnectorIndexingStatusLite" }, - "Header": { + "SearchToolQueriesDelta": { "properties": { - "key": { + "type": { "type": "string", - "title": "Key" + "const": "search_tool_queries_delta", + "title": "Type", + "default": "search_tool_queries_delta" }, - "value": { - "type": "string", - "title": "Value" + "queries": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Queries" } }, "type": "object", "required": [ - "key", - "value" + "queries" ], - "title": "Header" + "title": "SearchToolQueriesDelta" }, - "PaginatedReturn_FullUserSnapshot_": { + "DocumentSearchPagination": { "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/FullUserSnapshot" - }, - "type": "array", - "title": "Items" + "offset": { + "type": "integer", + "title": "Offset" }, - "total_items": { + "limit": { "type": "integer", - "title": "Total Items" + "title": "Limit" + }, + "returned_count": { + "type": "integer", + "title": "Returned Count" + }, + "has_more": { + "type": "boolean", + "title": "Has More" + }, + "next_offset": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Next Offset" } }, "type": "object", "required": [ - "items", - "total_items" + "offset", + "limit", + "returned_count", + "has_more" ], - "title": "PaginatedReturn[FullUserSnapshot]" + "title": "DocumentSearchPagination" }, - "StarterMessage": { + "ConnectorIndexingStatusLiteResponse": { "properties": { - "name": { - "type": "string", - "title": "Name" + "source": { + "$ref": "#/components/schemas/DocumentSource" }, - "message": { - "type": "string", - "title": "Message" + "summary": { + "$ref": "#/components/schemas/SourceSummary" + }, + "current_page": { + "type": "integer", + "title": "Current Page" + }, + "total_pages": { + "type": "integer", + "title": "Total Pages" + }, + "indexing_statuses": { + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/ConnectorIndexingStatusLite" + }, + { + "$ref": "#/components/schemas/FederatedConnectorStatus" + } + ] + }, + "type": "array", + "title": "Indexing Statuses" } }, "type": "object", "required": [ - "name", - "message" + "source", + "summary", + "current_page", + "total_pages", + "indexing_statuses" ], - "title": "StarterMessage", - "description": "Starter message for a persona." + "title": "ConnectorIndexingStatusLiteResponse" }, - "LLMEvaluationType": { + "InputType": { "type": "string", "enum": [ - "agentic", - "basic", - "skip", - "unspecified" + "load_state", + "poll", + "event", + "slim_retrieval" ], - "title": "LLMEvaluationType" + "title": "InputType" }, - "OverallStop": { + "ConnectorUpdateRequest": { "properties": { - "type": { + "name": { "type": "string", - "const": "stop", - "title": "Type", - "default": "stop" + "title": "Name" }, - "stop_reason": { - "anyOf": [ - { - "type": "string" - }, - { + "source": { + "$ref": "#/components/schemas/DocumentSource" + }, + "input_type": { + "$ref": "#/components/schemas/InputType" + }, + "connector_specific_config": { + "additionalProperties": true, + "type": "object", + "title": "Connector Specific Config" + }, + "refresh_freq": { + "anyOf": [ + { + "type": "integer" + }, + { "type": "null" } ], - "title": "Stop Reason" + "title": "Refresh Freq" + }, + "prune_freq": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Prune Freq" + }, + "indexing_start": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Indexing Start" + }, + "access_type": { + "$ref": "#/components/schemas/AccessType" + }, + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups" } }, "type": "object", - "title": "OverallStop" + "required": [ + "name", + "source", + "input_type", + "connector_specific_config", + "access_type" + ], + "title": "ConnectorUpdateRequest" + }, + "ChatFileType": { + "type": "string", + "enum": [ + "image", + "document", + "plain_text", + "csv" + ], + "title": "ChatFileType" + }, + "ConnectorFilesResponse": { + "properties": { + "files": { + "items": { + "$ref": "#/components/schemas/ConnectorFileInfo" + }, + "type": "array", + "title": "Files" + } + }, + "type": "object", + "required": [ + "files" + ], + "title": "ConnectorFilesResponse" + }, + "AllVersions": { + "properties": { + "stable": { + "$ref": "#/components/schemas/ContainerVersions" + }, + "dev": { + "$ref": "#/components/schemas/ContainerVersions" + }, + "migration": { + "$ref": "#/components/schemas/ContainerVersions" + } + }, + "type": "object", + "required": [ + "stable", + "dev", + "migration" + ], + "title": "AllVersions" + }, + "AuthTypeResponse": { + "properties": { + "auth_type": { + "$ref": "#/components/schemas/AuthType" + }, + "requires_verification": { + "type": "boolean", + "title": "Requires Verification" + }, + "anonymous_user_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Anonymous User Enabled" + }, + "password_min_length": { + "type": "integer", + "title": "Password Min Length" + } + }, + "type": "object", + "required": [ + "auth_type", + "requires_verification", + "password_min_length" + ], + "title": "AuthTypeResponse" + }, + "SectionEnd": { + "properties": { + "type": { + "type": "string", + "const": "section_end", + "title": "Type", + "default": "section_end" + } + }, + "type": "object", + "title": "SectionEnd" }, "AgentResponseDelta": { "properties": { @@ -8102,67 +8114,73 @@ ], "title": "AgentResponseDelta" }, - "SearchToolQueriesDelta": { + "PythonToolStart": { "properties": { "type": { "type": "string", - "const": "search_tool_queries_delta", + "const": "python_tool_start", "title": "Type", - "default": "search_tool_queries_delta" + "default": "python_tool_start" }, - "queries": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Queries" + "code": { + "type": "string", + "title": "Code" } }, "type": "object", "required": [ - "queries" - ], - "title": "SearchToolQueriesDelta" - }, - "SearchType": { - "type": "string", - "enum": [ - "keyword", - "semantic", - "internet" + "code" ], - "title": "SearchType" + "title": "PythonToolStart" }, - "TokenRateLimitArgs": { + "StatusResponse": { "properties": { - "enabled": { + "success": { "type": "boolean", - "title": "Enabled" + "title": "Success" }, - "token_budget": { - "type": "integer", - "title": "Token Budget" + "message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Message" }, - "period_hours": { - "type": "integer", - "title": "Period Hours" + "data": { + "anyOf": [ + {}, + { + "type": "null" + } + ], + "title": "Data" } }, "type": "object", "required": [ - "enabled", - "token_budget", - "period_hours" + "success" ], - "title": "TokenRateLimitArgs" + "title": "StatusResponse" }, - "CCPairSummary": { + "CCStatusUpdateRequest": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { + "status": { + "$ref": "#/components/schemas/ConnectorCredentialPairStatus" + } + }, + "type": "object", + "required": [ + "status" + ], + "title": "CCStatusUpdateRequest" + }, + "ProjectInstructionsResponse": { + "properties": { + "instructions": { "anyOf": [ { "type": "string" @@ -8171,240 +8189,121 @@ "type": "null" } ], - "title": "Name" - }, - "source": { - "$ref": "#/components/schemas/DocumentSource" - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" + "title": "Instructions" } }, "type": "object", "required": [ - "id", - "name", - "source", - "access_type" + "instructions" ], - "title": "CCPairSummary", - "description": "Simplified connector-credential pair information with just essential data" + "title": "ProjectInstructionsResponse" }, - "IndexingStatusRequest": { + "PersonaUpsertRequest": { "properties": { - "secondary_index": { - "type": "boolean", - "title": "Secondary Index", - "default": false + "name": { + "type": "string", + "title": "Name" }, - "source": { - "anyOf": [ - { - "$ref": "#/components/schemas/DocumentSource" - }, - { - "type": "null" - } - ] + "description": { + "type": "string", + "title": "Description" }, - "access_type_filters": { + "document_set_ids": { "items": { - "$ref": "#/components/schemas/AccessType" + "type": "integer" }, "type": "array", - "title": "Access Type Filters" + "title": "Document Set Ids" }, - "last_status_filters": { - "items": { - "$ref": "#/components/schemas/IndexingStatus" - }, - "type": "array", - "title": "Last Status Filters" + "num_chunks": { + "type": "number", + "title": "Num Chunks" }, - "docs_count_operator": { + "is_public": { + "type": "boolean", + "title": "Is Public" + }, + "recency_bias": { + "$ref": "#/components/schemas/RecencyBiasSetting" + }, + "llm_filter_extraction": { + "type": "boolean", + "title": "Llm Filter Extraction" + }, + "llm_relevance_filter": { + "type": "boolean", + "title": "Llm Relevance Filter" + }, + "llm_model_provider_override": { "anyOf": [ { - "$ref": "#/components/schemas/DocsCountOperator" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Llm Model Provider Override" }, - "docs_count_value": { + "llm_model_version_override": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Docs Count Value" + "title": "Llm Model Version Override" }, - "name_filter": { + "starter_messages": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/StarterMessage" + }, + "type": "array" }, { "type": "null" } ], - "title": "Name Filter" - }, - "source_to_page": { - "additionalProperties": { - "type": "integer" - }, - "propertyNames": { - "$ref": "#/components/schemas/DocumentSource" - }, - "type": "object", - "title": "Source To Page" - }, - "get_all_connectors": { - "type": "boolean", - "title": "Get All Connectors", - "default": false - } - }, - "type": "object", - "title": "IndexingStatusRequest" - }, - "TokenRateLimitDisplay": { - "properties": { - "token_id": { - "type": "integer", - "title": "Token Id" - }, - "enabled": { - "type": "boolean", - "title": "Enabled" - }, - "token_budget": { - "type": "integer", - "title": "Token Budget" - }, - "period_hours": { - "type": "integer", - "title": "Period Hours" - } - }, - "type": "object", - "required": [ - "token_id", - "enabled", - "token_budget", - "period_hours" - ], - "title": "TokenRateLimitDisplay" - }, - "ReasoningDelta": { - "properties": { - "type": { - "type": "string", - "const": "reasoning_delta", - "title": "Type", - "default": "reasoning_delta" - }, - "reasoning": { - "type": "string", - "title": "Reasoning" - } - }, - "type": "object", - "required": [ - "reasoning" - ], - "title": "ReasoningDelta" - }, - "PaginatedReturn_IndexAttemptSnapshot_": { - "properties": { - "items": { - "items": { - "$ref": "#/components/schemas/IndexAttemptSnapshot" - }, - "type": "array", - "title": "Items" + "title": "Starter Messages" }, - "total_items": { - "type": "integer", - "title": "Total Items" - } - }, - "type": "object", - "required": [ - "items", - "total_items" - ], - "title": "PaginatedReturn[IndexAttemptSnapshot]" - }, - "Body_upload_files_api_manage_admin_connector_file_upload_post": { - "properties": { - "files": { + "users": { "items": { "type": "string", - "format": "binary" + "format": "uuid" }, "type": "array", - "title": "Files" - } - }, - "type": "object", - "required": [ - "files" - ], - "title": "Body_upload_files_api_manage_admin_connector_file_upload_post" - }, - "DocumentSearchResponse": { - "properties": { - "top_documents": { + "title": "Users" + }, + "groups": { "items": { - "$ref": "#/components/schemas/SavedSearchDocWithContent" + "type": "integer" }, "type": "array", - "title": "Top Documents" + "title": "Groups" }, - "llm_indices": { + "tool_ids": { "items": { "type": "integer" }, "type": "array", - "title": "Llm Indices" + "title": "Tool Ids" }, - "pagination": { - "$ref": "#/components/schemas/DocumentSearchPagination" - } - }, - "type": "object", - "required": [ - "top_documents", - "llm_indices", - "pagination" - ], - "title": "DocumentSearchResponse" - }, - "BasicCCPairInfo": { - "properties": { - "has_successful_run": { - "type": "boolean", - "title": "Has Successful Run" + "remove_image": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Remove Image" }, - "source": { - "$ref": "#/components/schemas/DocumentSource" - } - }, - "type": "object", - "required": [ - "has_successful_run", - "source" - ], - "title": "BasicCCPairInfo" - }, - "ConnectorCredentialPairMetadata": { - "properties": { - "name": { + "uploaded_image_id": { "anyOf": [ { "type": "string" @@ -8413,51 +8312,51 @@ "type": "null" } ], - "title": "Name" + "title": "Uploaded Image Id" }, - "access_type": { - "$ref": "#/components/schemas/AccessType" + "icon_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Icon Name" }, - "auto_sync_options": { + "search_start_date": { "anyOf": [ { - "additionalProperties": true, - "type": "object" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Auto Sync Options" + "title": "Search Start Date" }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" - } - }, - "type": "object", - "required": [ - "access_type" - ], - "title": "ConnectorCredentialPairMetadata" - }, - "ChatSearchResponse": { - "properties": { - "groups": { - "items": { - "$ref": "#/components/schemas/ChatSessionGroup" - }, - "type": "array", - "title": "Groups" + "label_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Label Ids" }, - "has_more": { + "is_default_persona": { "type": "boolean", - "title": "Has More" + "title": "Is Default Persona", + "default": false }, - "next_page": { + "display_priority": { "anyOf": [ { "type": "integer" @@ -8466,23 +8365,90 @@ "type": "null" } ], - "title": "Next Page" + "title": "Display Priority" + }, + "user_file_ids": { + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "User File Ids" + }, + "system_prompt": { + "type": "string", + "title": "System Prompt" + }, + "replace_base_system_prompt": { + "type": "boolean", + "title": "Replace Base System Prompt", + "default": false + }, + "task_prompt": { + "type": "string", + "title": "Task Prompt" + }, + "datetime_aware": { + "type": "boolean", + "title": "Datetime Aware" } }, "type": "object", "required": [ - "groups", - "has_more" + "name", + "description", + "document_set_ids", + "num_chunks", + "is_public", + "recency_bias", + "llm_filter_extraction", + "llm_relevance_filter", + "tool_ids", + "system_prompt", + "task_prompt", + "datetime_aware" ], - "title": "ChatSearchResponse" + "title": "PersonaUpsertRequest" }, - "CustomToolCreate": { + "UserPreferences": { "properties": { - "name": { - "type": "string", - "title": "Name" + "chosen_assistants": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Chosen Assistants" }, - "description": { + "hidden_assistants": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Hidden Assistants", + "default": [] + }, + "visible_assistants": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Visible Assistants", + "default": [] + }, + "default_model": { "anyOf": [ { "type": "string" @@ -8491,18 +8457,13 @@ "type": "null" } ], - "title": "Description" - }, - "definition": { - "additionalProperties": true, - "type": "object", - "title": "Definition" + "title": "Default Model" }, - "custom_headers": { + "pinned_assistants": { "anyOf": [ { "items": { - "$ref": "#/components/schemas/Header" + "type": "integer" }, "type": "array" }, @@ -8510,112 +8471,281 @@ "type": "null" } ], - "title": "Custom Headers" + "title": "Pinned Assistants" }, - "passthrough_auth": { - "type": "boolean", - "title": "Passthrough Auth" + "shortcut_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Shortcut Enabled" }, - "oauth_config_id": { + "auto_scroll": { "anyOf": [ { - "type": "integer" + "type": "boolean" }, { "type": "null" } ], - "title": "Oauth Config Id" - } - }, - "type": "object", - "required": [ - "name", - "definition", - "passthrough_auth" - ], - "title": "CustomToolCreate" - }, - "ChatSessionCreationRequest": { - "properties": { - "persona_id": { - "type": "integer", - "title": "Persona Id", - "default": 0 + "title": "Auto Scroll" }, - "description": { + "temperature_override_enabled": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Description" + "title": "Temperature Override Enabled" }, - "project_id": { + "theme_preference": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/ThemePreference" + }, + { + "type": "null" + } + ] + }, + "assistant_specific_configs": { + "anyOf": [ + { + "additionalProperties": { + "$ref": "#/components/schemas/UserSpecificAssistantPreference" + }, + "type": "object" }, { "type": "null" } ], - "title": "Project Id" + "title": "Assistant Specific Configs" } }, "type": "object", - "title": "ChatSessionCreationRequest" + "title": "UserPreferences" }, - "UserFileDeleteResult": { + "PaginatedReturn_FullUserSnapshot_": { "properties": { - "has_associations": { - "type": "boolean", - "title": "Has Associations" + "items": { + "items": { + "$ref": "#/components/schemas/FullUserSnapshot" + }, + "type": "array", + "title": "Items" }, - "project_names": { + "total_items": { + "type": "integer", + "title": "Total Items" + } + }, + "type": "object", + "required": [ + "items", + "total_items" + ], + "title": "PaginatedReturn[FullUserSnapshot]" + }, + "WebSearchWithContentResponse": { + "properties": { + "search_provider_type": { + "$ref": "#/components/schemas/WebSearchProviderType" + }, + "content_provider_type": { + "anyOf": [ + { + "$ref": "#/components/schemas/WebContentProviderType" + }, + { + "type": "null" + } + ] + }, + "search_results": { "items": { - "type": "string" + "$ref": "#/components/schemas/LlmWebSearchResult" }, "type": "array", - "title": "Project Names", - "default": [] + "title": "Search Results" }, - "assistant_names": { + "full_content_results": { "items": { - "type": "string" + "$ref": "#/components/schemas/LlmOpenUrlResult" }, "type": "array", - "title": "Assistant Names", - "default": [] + "title": "Full Content Results" } }, "type": "object", "required": [ - "has_associations" + "search_provider_type", + "search_results", + "full_content_results" ], - "title": "UserFileDeleteResult" + "title": "WebSearchWithContentResponse" }, - "IntermediateReportDelta": { + "ToolSnapshot": { "properties": { - "type": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { "type": "string", - "const": "intermediate_report_delta", - "title": "Type", - "default": "intermediate_report_delta" + "title": "Name" }, - "content": { + "description": { "type": "string", - "title": "Content" + "title": "Description" + }, + "definition": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Definition" + }, + "display_name": { + "type": "string", + "title": "Display Name" + }, + "in_code_tool_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "In Code Tool Id" + }, + "custom_headers": { + "anyOf": [ + { + "items": {}, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Custom Headers" + }, + "passthrough_auth": { + "type": "boolean", + "title": "Passthrough Auth" + }, + "mcp_server_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Mcp Server Id" + }, + "user_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "User Id" + }, + "oauth_config_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Oauth Config Id" + }, + "oauth_config_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Oauth Config Name" + }, + "enabled": { + "type": "boolean", + "title": "Enabled", + "default": true + }, + "chat_selectable": { + "type": "boolean", + "title": "Chat Selectable", + "default": true + }, + "agent_creation_selectable": { + "type": "boolean", + "title": "Agent Creation Selectable", + "default": true + }, + "default_enabled": { + "type": "boolean", + "title": "Default Enabled", + "default": false } }, "type": "object", "required": [ - "content" + "id", + "name", + "description", + "definition", + "display_name", + "in_code_tool_id", + "custom_headers", + "passthrough_auth" ], - "title": "IntermediateReportDelta" + "title": "ToolSnapshot" + }, + "StarterMessage": { + "properties": { + "name": { + "type": "string", + "title": "Name" + }, + "message": { + "type": "string", + "title": "Message" + } + }, + "type": "object", + "required": [ + "name", + "message" + ], + "title": "StarterMessage", + "description": "Starter message for a persona." }, "CustomToolStart": { "properties": { @@ -8636,189 +8766,128 @@ ], "title": "CustomToolStart" }, - "AccessType": { - "type": "string", - "enum": [ - "public", - "private", - "sync" - ], - "title": "AccessType" - }, - "AuthType": { - "type": "string", - "enum": [ - "disabled", - "basic", - "google_oauth", - "oidc", - "saml", - "cloud" - ], - "title": "AuthType" - }, - "ChatFileType": { - "type": "string", - "enum": [ - "image", - "document", - "plain_text", - "csv" - ], - "title": "ChatFileType" - }, - "FederatedConnectorSource": { - "type": "string", - "enum": [ - "federated_slack" - ], - "title": "FederatedConnectorSource" - }, - "DocumentSetSummary": { + "DeletionAttemptSnapshot": { "properties": { - "id": { + "connector_id": { "type": "integer", - "title": "Id" + "title": "Connector Id" }, - "name": { - "type": "string", - "title": "Name" + "credential_id": { + "type": "integer", + "title": "Credential Id" }, - "description": { + "status": { + "$ref": "#/components/schemas/TaskStatus" + } + }, + "type": "object", + "required": [ + "connector_id", + "credential_id", + "status" + ], + "title": "DeletionAttemptSnapshot" + }, + "DocumentSearchRequest": { + "properties": { + "chunks_above": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Description" + "title": "Chunks Above" }, - "cc_pair_summaries": { - "items": { - "$ref": "#/components/schemas/CCPairSummary" - }, - "type": "array", - "title": "Cc Pair Summaries" + "chunks_below": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Chunks Below" }, - "is_up_to_date": { + "full_doc": { "type": "boolean", - "title": "Is Up To Date" + "title": "Full Doc", + "default": false }, - "is_public": { - "type": "boolean", - "title": "Is Public" + "message": { + "type": "string", + "title": "Message" }, - "users": { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array", - "title": "Users" + "search_type": { + "$ref": "#/components/schemas/SearchType" }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" - }, - "federated_connector_summaries": { - "items": { - "$ref": "#/components/schemas/FederatedConnectorSummary" - }, - "type": "array", - "title": "Federated Connector Summaries" - } - }, - "type": "object", - "required": [ - "id", - "name", - "description", - "cc_pair_summaries", - "is_up_to_date", - "is_public", - "users", - "groups" - ], - "title": "DocumentSetSummary", - "description": "Simplified document set model with minimal data for list views" - }, - "AllUsersResponse": { - "properties": { - "accepted": { - "items": { - "$ref": "#/components/schemas/FullUserSnapshot" - }, - "type": "array", - "title": "Accepted" - }, - "invited": { - "items": { - "$ref": "#/components/schemas/InvitedUserSnapshot" - }, - "type": "array", - "title": "Invited" - }, - "slack_users": { - "items": { - "$ref": "#/components/schemas/FullUserSnapshot" - }, - "type": "array", - "title": "Slack Users" + "retrieval_options": { + "$ref": "#/components/schemas/RetrievalDetails" }, - "accepted_pages": { - "type": "integer", - "title": "Accepted Pages" + "recency_bias_multiplier": { + "type": "number", + "title": "Recency Bias Multiplier", + "default": 1.0 }, - "invited_pages": { - "type": "integer", - "title": "Invited Pages" + "evaluation_type": { + "$ref": "#/components/schemas/LLMEvaluationType" }, - "slack_users_pages": { - "type": "integer", - "title": "Slack Users Pages" + "rerank_settings": { + "anyOf": [ + { + "$ref": "#/components/schemas/RerankingDetails" + }, + { + "type": "null" + } + ] } }, "type": "object", "required": [ - "accepted", - "invited", - "slack_users", - "accepted_pages", - "invited_pages", - "slack_users_pages" + "message", + "search_type", + "retrieval_options", + "evaluation_type" ], - "title": "AllUsersResponse" + "title": "DocumentSearchRequest" }, - "ConnectorCredentialPairIdentifier": { + "OverallStop": { "properties": { - "connector_id": { - "type": "integer", - "title": "Connector Id" + "type": { + "type": "string", + "const": "stop", + "title": "Type", + "default": "stop" }, - "credential_id": { - "type": "integer", - "title": "Credential Id" + "stop_reason": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Stop Reason" } }, "type": "object", - "required": [ - "connector_id", - "credential_id" - ], - "title": "ConnectorCredentialPairIdentifier" + "title": "OverallStop" }, - "StatusResponse_list_int__": { + "FileDescriptor": { "properties": { - "success": { - "type": "boolean", - "title": "Success" + "id": { + "type": "string", + "title": "Id" }, - "message": { + "type": { + "$ref": "#/components/schemas/ChatFileType" + }, + "name": { "anyOf": [ { "type": "string" @@ -8827,145 +8896,74 @@ "type": "null" } ], - "title": "Message" + "title": "Name" }, - "data": { + "user_file_id": { "anyOf": [ { - "items": { - "type": "integer" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Data" - } - }, - "type": "object", - "required": [ - "success" - ], - "title": "StatusResponse[list[int]]" - }, - "IntermediateReportStart": { - "properties": { - "type": { - "type": "string", - "const": "intermediate_report_start", - "title": "Type", - "default": "intermediate_report_start" - } - }, - "type": "object", - "title": "IntermediateReportStart" - }, - "UpsertProjectInstructionsRequest": { - "properties": { - "instructions": { - "type": "string", - "title": "Instructions" - } - }, - "type": "object", - "required": [ - "instructions" - ], - "title": "UpsertProjectInstructionsRequest" - }, - "InvitedUserSnapshot": { - "properties": { - "email": { - "type": "string", - "title": "Email" + "title": "User File Id" } }, "type": "object", "required": [ - "email" + "id", + "type" ], - "title": "InvitedUserSnapshot" + "title": "FileDescriptor", + "description": "NOTE: is a `TypedDict` so it can be used as a type hint for a JSONB column\nin Postgres" }, - "WebSearchWithContentResponse": { + "ChatMessageDetail": { "properties": { - "search_provider_type": { - "$ref": "#/components/schemas/WebSearchProviderType" - }, - "content_provider_type": { + "chat_session_id": { "anyOf": [ { - "$ref": "#/components/schemas/WebContentProviderType" + "type": "string", + "format": "uuid" }, { "type": "null" } - ] - }, - "search_results": { - "items": { - "$ref": "#/components/schemas/LlmWebSearchResult" - }, - "type": "array", - "title": "Search Results" + ], + "title": "Chat Session Id" }, - "full_content_results": { - "items": { - "$ref": "#/components/schemas/LlmOpenUrlResult" - }, - "type": "array", - "title": "Full Content Results" - } - }, - "type": "object", - "required": [ - "search_provider_type", - "search_results", - "full_content_results" - ], - "title": "WebSearchWithContentResponse" - }, - "ReasoningDone": { - "properties": { - "type": { - "type": "string", - "const": "reasoning_done", - "title": "Type", - "default": "reasoning_done" - } - }, - "type": "object", - "title": "ReasoningDone" - }, - "ChatSeedRequest": { - "properties": { - "persona_id": { + "message_id": { "type": "integer", - "title": "Persona Id" + "title": "Message Id" }, - "llm_override": { + "parent_message": { "anyOf": [ { - "$ref": "#/components/schemas/LLMOverride" + "type": "integer" }, { "type": "null" } - ] + ], + "title": "Parent Message" }, - "prompt_override": { + "latest_child_message": { "anyOf": [ { - "$ref": "#/components/schemas/PromptOverride" + "type": "integer" }, { "type": "null" } - ] + ], + "title": "Latest Child Message" }, - "description": { - "anyOf": [ + "message": { + "type": "string", + "title": "Message" + }, + "reasoning_tokens": { + "anyOf": [ { "type": "string" }, @@ -8973,130 +8971,166 @@ "type": "null" } ], - "title": "Description" + "title": "Reasoning Tokens" }, - "message": { + "message_type": { + "$ref": "#/components/schemas/MessageType" + }, + "context_docs": { "anyOf": [ { - "type": "string" + "items": { + "$ref": "#/components/schemas/SavedSearchDoc" + }, + "type": "array" }, { "type": "null" } ], - "title": "Message" - } - }, - "type": "object", - "required": [ - "persona_id" - ], - "title": "ChatSeedRequest" - }, - "DocumentSearchRequest": { - "properties": { - "chunks_above": { + "title": "Context Docs" + }, + "citations": { "anyOf": [ { - "type": "integer" + "additionalProperties": { + "type": "string" + }, + "type": "object" }, { "type": "null" } ], - "title": "Chunks Above" + "title": "Citations" }, - "chunks_below": { + "time_sent": { + "type": "string", + "format": "date-time", + "title": "Time Sent" + }, + "files": { + "items": { + "$ref": "#/components/schemas/FileDescriptor" + }, + "type": "array", + "title": "Files" + }, + "error": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Chunks Below" - }, - "full_doc": { - "type": "boolean", - "title": "Full Doc", - "default": false - }, - "message": { - "type": "string", - "title": "Message" - }, - "search_type": { - "$ref": "#/components/schemas/SearchType" - }, - "retrieval_options": { - "$ref": "#/components/schemas/RetrievalDetails" - }, - "recency_bias_multiplier": { - "type": "number", - "title": "Recency Bias Multiplier", - "default": 1.0 - }, - "evaluation_type": { - "$ref": "#/components/schemas/LLMEvaluationType" + "title": "Error" }, - "rerank_settings": { + "current_feedback": { "anyOf": [ { - "$ref": "#/components/schemas/RerankingDetails" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Current Feedback" } }, "type": "object", "required": [ + "message_id", "message", - "search_type", - "retrieval_options", - "evaluation_type" + "message_type", + "time_sent", + "files" ], - "title": "DocumentSearchRequest" + "title": "ChatMessageDetail" }, - "TenantInfo": { + "RerankerProvider": { + "type": "string", + "enum": [ + "cohere", + "litellm", + "bedrock" + ], + "title": "RerankerProvider" + }, + "Header": { "properties": { - "invitation": { + "key": { + "type": "string", + "title": "Key" + }, + "value": { + "type": "string", + "title": "Value" + } + }, + "type": "object", + "required": [ + "key", + "value" + ], + "title": "Header" + }, + "FederatedConnectorSource": { + "type": "string", + "enum": [ + "federated_slack" + ], + "title": "FederatedConnectorSource" + }, + "IndexAttemptSnapshot": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "status": { "anyOf": [ { - "$ref": "#/components/schemas/TenantSnapshot" + "$ref": "#/components/schemas/IndexingStatus" }, { "type": "null" } ] }, - "new_tenant": { + "from_beginning": { + "type": "boolean", + "title": "From Beginning" + }, + "new_docs_indexed": { + "type": "integer", + "title": "New Docs Indexed" + }, + "total_docs_indexed": { + "type": "integer", + "title": "Total Docs Indexed" + }, + "docs_removed_from_index": { + "type": "integer", + "title": "Docs Removed From Index" + }, + "error_msg": { "anyOf": [ { - "$ref": "#/components/schemas/TenantSnapshot" + "type": "string" }, { "type": "null" } - ] - } - }, - "type": "object", - "title": "TenantInfo" - }, - "IndexAttemptErrorPydantic": { - "properties": { - "id": { - "type": "integer", - "title": "Id" + ], + "title": "Error Msg" }, - "connector_credential_pair_id": { + "error_count": { "type": "integer", - "title": "Connector Credential Pair Id" + "title": "Error Count" }, - "document_id": { + "full_exception_trace": { "anyOf": [ { "type": "string" @@ -9105,9 +9139,9 @@ "type": "null" } ], - "title": "Document Id" + "title": "Full Exception Trace" }, - "document_link": { + "time_started": { "anyOf": [ { "type": "string" @@ -9116,20 +9150,25 @@ "type": "null" } ], - "title": "Document Link" + "title": "Time Started" }, - "entity_id": { + "time_updated": { + "type": "string", + "title": "Time Updated" + }, + "poll_range_start": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Entity Id" + "title": "Poll Range Start" }, - "failed_time_range_start": { + "poll_range_end": { "anyOf": [ { "type": "string", @@ -9139,130 +9178,66 @@ "type": "null" } ], - "title": "Failed Time Range Start" + "title": "Poll Range End" + } + }, + "type": "object", + "required": [ + "id", + "status", + "from_beginning", + "new_docs_indexed", + "total_docs_indexed", + "docs_removed_from_index", + "error_msg", + "error_count", + "full_exception_trace", + "time_started", + "time_updated" + ], + "title": "IndexAttemptSnapshot" + }, + "ChatSessionDetails": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Id" }, - "failed_time_range_end": { + "name": { "anyOf": [ { - "type": "string", - "format": "date-time" + "type": "string" }, { "type": "null" } ], - "title": "Failed Time Range End" - }, - "failure_message": { - "type": "string", - "title": "Failure Message" + "title": "Name" }, - "is_resolved": { - "type": "boolean", - "title": "Is Resolved", - "default": false + "persona_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Persona Id" }, "time_created": { "type": "string", - "format": "date-time", "title": "Time Created" }, - "index_attempt_id": { - "type": "integer", - "title": "Index Attempt Id" - } - }, - "type": "object", - "required": [ - "id", - "connector_credential_pair_id", - "document_id", - "document_link", - "entity_id", - "failed_time_range_start", - "failed_time_range_end", - "failure_message", - "time_created", - "index_attempt_id" - ], - "title": "IndexAttemptErrorPydantic" - }, - "DocumentSource": { - "type": "string", - "enum": [ - "ingestion_api", - "slack", - "web", - "google_drive", - "gmail", - "requesttracker", - "github", - "gitbook", - "gitlab", - "guru", - "bookstack", - "outline", - "confluence", - "jira", - "slab", - "productboard", - "file", - "coda", - "notion", - "zulip", - "linear", - "hubspot", - "document360", - "gong", - "google_sites", - "zendesk", - "loopio", - "dropbox", - "sharepoint", - "teams", - "salesforce", - "discourse", - "axero", - "clickup", - "mediawiki", - "wikipedia", - "asana", - "s3", - "r2", - "google_cloud_storage", - "oci_storage", - "xenforo", - "not_applicable", - "discord", - "freshdesk", - "fireflies", - "egnyte", - "airtable", - "highspot", - "drupal_wiki", - "imap", - "bitbucket", - "testrail", - "mock_connector", - "user_file" - ], - "title": "DocumentSource" - }, - "CredentialBase": { - "properties": { - "credential_json": { - "additionalProperties": true, - "type": "object", - "title": "Credential Json" - }, - "admin_public": { - "type": "boolean", - "title": "Admin Public" + "time_updated": { + "type": "string", + "title": "Time Updated" }, - "source": { - "$ref": "#/components/schemas/DocumentSource" + "shared_status": { + "$ref": "#/components/schemas/ChatSessionSharedStatus" }, - "name": { + "current_alternate_model": { "anyOf": [ { "type": "string" @@ -9271,48 +9246,42 @@ "type": "null" } ], - "title": "Name" - }, - "curator_public": { - "type": "boolean", - "title": "Curator Public", - "default": false - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" + "title": "Current Alternate Model" }, - "is_user_file": { - "type": "boolean", - "title": "Is User File", - "default": false - } - }, - "type": "object", - "required": [ - "credential_json", - "admin_public", - "source" - ], - "title": "CredentialBase" - }, - "RetrievalDetails": { - "properties": { - "chunks_above": { + "current_temperature_override": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Chunks Above" + "title": "Current Temperature Override" + } + }, + "type": "object", + "required": [ + "id", + "name", + "time_created", + "time_updated", + "shared_status" + ], + "title": "ChatSessionDetails" + }, + "WebSearchToolRequest": { + "properties": { + "queries": { + "items": { + "type": "string" + }, + "type": "array", + "minItems": 1, + "title": "Queries", + "description": "List of search queries to send to the configured provider." }, - "chunks_below": { + "max_results": { "anyOf": [ { "type": "integer" @@ -9321,97 +9290,130 @@ "type": "null" } ], - "title": "Chunks Below" - }, - "full_doc": { - "type": "boolean", - "title": "Full Doc", - "default": false - }, - "run_search": { - "$ref": "#/components/schemas/OptionalSearchSetting", - "default": "auto" - }, - "real_time": { - "type": "boolean", - "title": "Real Time", - "default": true + "title": "Max Results", + "description": "Optional cap on number of results to return per query. Defaults to 10.", + "default": 10 + } + }, + "type": "object", + "required": [ + "queries" + ], + "title": "WebSearchToolRequest" + }, + "UpsertProjectInstructionsRequest": { + "properties": { + "instructions": { + "type": "string", + "title": "Instructions" + } + }, + "type": "object", + "required": [ + "instructions" + ], + "title": "UpsertProjectInstructionsRequest" + }, + "ChatSessionSummary": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "title": "Id" }, - "filters": { + "name": { "anyOf": [ { - "$ref": "#/components/schemas/BaseFilters" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Name" }, - "enable_auto_detect_filters": { + "persona_id": { "anyOf": [ { - "type": "boolean" + "type": "integer" }, { "type": "null" } ], - "title": "Enable Auto Detect Filters" + "title": "Persona Id" }, - "offset": { + "time_created": { + "type": "string", + "format": "date-time", + "title": "Time Created" + }, + "shared_status": { + "$ref": "#/components/schemas/ChatSessionSharedStatus" + }, + "current_alternate_model": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Offset" + "title": "Current Alternate Model" }, - "limit": { + "current_temperature_override": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Limit" + "title": "Current Temperature Override" + } + }, + "type": "object", + "required": [ + "id", + "time_created", + "shared_status" + ], + "title": "ChatSessionSummary" + }, + "SearchToolStart": { + "properties": { + "type": { + "type": "string", + "const": "search_tool_start", + "title": "Type", + "default": "search_tool_start" }, - "dedupe_docs": { + "is_internet_search": { "type": "boolean", - "title": "Dedupe Docs", + "title": "Is Internet Search", "default": false } }, "type": "object", - "title": "RetrievalDetails" + "title": "SearchToolStart" }, - "PersonaSnapshot": { + "SearchDoc": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" - }, - "description": { + "document_id": { "type": "string", - "title": "Description" + "title": "Document Id" }, - "is_public": { - "type": "boolean", - "title": "Is Public" + "chunk_ind": { + "type": "integer", + "title": "Chunk Ind" }, - "is_visible": { - "type": "boolean", - "title": "Is Visible" + "semantic_identifier": { + "type": "string", + "title": "Semantic Identifier" }, - "uploaded_image_id": { + "link": { "anyOf": [ { "type": "string" @@ -9420,113 +9422,63 @@ "type": "null" } ], - "title": "Uploaded Image Id" + "title": "Link" }, - "icon_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Icon Name" + "blurb": { + "type": "string", + "title": "Blurb" }, - "user_file_ids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "User File Ids" + "source_type": { + "$ref": "#/components/schemas/DocumentSource" }, - "display_priority": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Display Priority" + "boost": { + "type": "integer", + "title": "Boost" }, - "is_default_persona": { + "hidden": { "type": "boolean", - "title": "Is Default Persona" + "title": "Hidden" }, - "builtin_persona": { - "type": "boolean", - "title": "Builtin Persona" + "metadata": { + "additionalProperties": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ] + }, + "type": "object", + "title": "Metadata" }, - "starter_messages": { + "score": { "anyOf": [ { - "items": { - "$ref": "#/components/schemas/StarterMessage" - }, - "type": "array" + "type": "number" }, { "type": "null" } ], - "title": "Starter Messages" - }, - "llm_relevance_filter": { - "type": "boolean", - "title": "Llm Relevance Filter" - }, - "llm_filter_extraction": { - "type": "boolean", - "title": "Llm Filter Extraction" - }, - "tools": { - "items": { - "$ref": "#/components/schemas/ToolSnapshot" - }, - "type": "array", - "title": "Tools" - }, - "labels": { - "items": { - "$ref": "#/components/schemas/PersonaLabelSnapshot" - }, - "type": "array", - "title": "Labels" + "title": "Score" }, - "owner": { + "is_relevant": { "anyOf": [ { - "$ref": "#/components/schemas/MinimalUserSnapshot" + "type": "boolean" }, { "type": "null" } - ] - }, - "users": { - "items": { - "$ref": "#/components/schemas/MinimalUserSnapshot" - }, - "type": "array", - "title": "Users" - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" - }, - "document_sets": { - "items": { - "$ref": "#/components/schemas/DocumentSetSummary" - }, - "type": "array", - "title": "Document Sets" + ], + "title": "Is Relevant" }, - "llm_model_provider_override": { + "relevance_explanation": { "anyOf": [ { "type": "string" @@ -9535,248 +9487,248 @@ "type": "null" } ], - "title": "Llm Model Provider Override" + "title": "Relevance Explanation" }, - "llm_model_version_override": { + "match_highlights": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Match Highlights" + }, + "updated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Llm Model Version Override" + "title": "Updated At" }, - "num_chunks": { + "primary_owners": { "anyOf": [ { - "type": "number" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Num Chunks" + "title": "Primary Owners" }, - "system_prompt": { + "secondary_owners": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "System Prompt" + "title": "Secondary Owners" }, - "replace_base_system_prompt": { + "is_internet": { "type": "boolean", - "title": "Replace Base System Prompt", + "title": "Is Internet", "default": false + } + }, + "type": "object", + "required": [ + "document_id", + "chunk_ind", + "semantic_identifier", + "blurb", + "source_type", + "boost", + "hidden", + "metadata", + "match_highlights" + ], + "title": "SearchDoc" + }, + "FederatedConnectorStatus": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "task_prompt": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Task Prompt" + "source": { + "$ref": "#/components/schemas/FederatedConnectorSource" }, - "datetime_aware": { - "type": "boolean", - "title": "Datetime Aware", - "default": true + "name": { + "type": "string", + "title": "Name" } }, "type": "object", "required": [ "id", - "name", - "description", - "is_public", - "is_visible", - "uploaded_image_id", - "icon_name", - "user_file_ids", - "display_priority", - "is_default_persona", - "builtin_persona", - "starter_messages", - "llm_relevance_filter", - "llm_filter_extraction", - "tools", - "labels", - "owner", - "users", - "groups", - "document_sets", - "llm_model_provider_override", - "llm_model_version_override", - "num_chunks" + "source", + "name" ], - "title": "PersonaSnapshot" + "title": "FederatedConnectorStatus" }, - "IndexingStatus": { + "UserFileStatus": { "type": "string", "enum": [ - "not_started", - "in_progress", - "success", - "canceled", - "failed", - "completed_with_errors" + "PROCESSING", + "COMPLETED", + "FAILED", + "CANCELED", + "DELETING" ], - "title": "IndexingStatus" + "title": "UserFileStatus" }, - "ReasoningStart": { + "UserPersonalization": { + "properties": { + "name": { + "type": "string", + "title": "Name", + "default": "" + }, + "role": { + "type": "string", + "title": "Role", + "default": "" + }, + "use_memories": { + "type": "boolean", + "title": "Use Memories", + "default": true + }, + "memories": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Memories" + } + }, + "type": "object", + "title": "UserPersonalization" + }, + "ImageGenerationToolStart": { "properties": { "type": { "type": "string", - "const": "reasoning_start", + "const": "image_generation_start", "title": "Type", - "default": "reasoning_start" + "default": "image_generation_start" } }, "type": "object", - "title": "ReasoningStart" + "title": "ImageGenerationToolStart" }, - "ConnectorSnapshot": { + "ConnectorStatus": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "source": { - "$ref": "#/components/schemas/DocumentSource" - }, - "input_type": { - "$ref": "#/components/schemas/InputType" - }, - "connector_specific_config": { - "additionalProperties": true, - "type": "object", - "title": "Connector Specific Config" + "cc_pair_id": { + "type": "integer", + "title": "Cc Pair Id" }, - "refresh_freq": { + "name": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Refresh Freq" + "title": "Name" }, - "prune_freq": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "Prune Freq" + "connector": { + "$ref": "#/components/schemas/ConnectorSnapshot" }, - "indexing_start": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Indexing Start" + "credential": { + "$ref": "#/components/schemas/CredentialSnapshot" }, - "id": { - "type": "integer", - "title": "Id" + "access_type": { + "$ref": "#/components/schemas/AccessType" }, - "credential_ids": { + "groups": { "items": { "type": "integer" }, "type": "array", - "title": "Credential Ids" - }, - "time_created": { - "type": "string", - "format": "date-time", - "title": "Time Created" - }, - "time_updated": { - "type": "string", - "format": "date-time", - "title": "Time Updated" + "title": "Groups" } }, "type": "object", "required": [ + "cc_pair_id", "name", - "source", - "input_type", - "connector_specific_config", - "id", - "credential_ids", - "time_created", - "time_updated" + "connector", + "credential", + "access_type", + "groups" ], - "title": "ConnectorSnapshot" + "title": "ConnectorStatus", + "description": "Represents the status of a connector,\nincluding indexing status elated information" }, - "DeletionAttemptSnapshot": { + "RunConnectorRequest": { "properties": { "connector_id": { "type": "integer", "title": "Connector Id" }, - "credential_id": { - "type": "integer", - "title": "Credential Id" + "credential_ids": { + "anyOf": [ + { + "items": { + "type": "integer" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Credential Ids" }, - "status": { - "$ref": "#/components/schemas/TaskStatus" + "from_beginning": { + "type": "boolean", + "title": "From Beginning", + "default": false } }, "type": "object", "required": [ - "connector_id", - "credential_id", - "status" + "connector_id" ], - "title": "DeletionAttemptSnapshot" + "title": "RunConnectorRequest" }, - "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post": { + "ObjectCreationIdResponse": { "properties": { - "files": { + "id": { + "type": "integer", + "title": "Id" + }, + "credential": { "anyOf": [ { - "items": { - "type": "string", - "format": "binary" - }, - "type": "array" + "$ref": "#/components/schemas/CredentialSnapshot" }, { "type": "null" } - ], - "title": "Files" - }, - "file_ids_to_remove": { - "type": "string", - "title": "File Ids To Remove", - "default": "[]" + ] } }, "type": "object", - "title": "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post" + "required": [ + "id" + ], + "title": "ObjectCreationIdResponse" }, "CredentialDataUpdateRequest": { "properties": { @@ -9797,215 +9749,126 @@ ], "title": "CredentialDataUpdateRequest" }, - "StatusResponse": { + "OpenUrlsToolResponse": { "properties": { - "success": { - "type": "boolean", - "title": "Success" + "results": { + "items": { + "$ref": "#/components/schemas/LlmOpenUrlResult" + }, + "type": "array", + "title": "Results" }, - "message": { + "provider_type": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/WebContentProviderType" }, { "type": "null" } - ], - "title": "Message" - }, - "data": { - "anyOf": [ - {}, - { - "type": "null" - } - ], - "title": "Data" + ] } }, "type": "object", "required": [ - "success" + "results" ], - "title": "StatusResponse" + "title": "OpenUrlsToolResponse" }, - "UserPersonalization": { + "ValidationError": { "properties": { - "name": { - "type": "string", - "title": "Name", - "default": "" - }, - "role": { - "type": "string", - "title": "Role", - "default": "" - }, - "use_memories": { - "type": "boolean", - "title": "Use Memories", - "default": true - }, - "memories": { + "loc": { "items": { - "type": "string" + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] }, "type": "array", - "title": "Memories" - } - }, - "type": "object", - "title": "UserPersonalization" - }, - "DeepResearchPlanStart": { - "properties": { - "type": { - "type": "string", - "const": "deep_research_plan_start", - "title": "Type", - "default": "deep_research_plan_start" - } - }, - "type": "object", - "title": "DeepResearchPlanStart" - }, - "ThemePreference": { - "type": "string", - "enum": [ - "light", - "dark", - "system" - ], - "title": "ThemePreference" - }, - "LLMOverride": { - "properties": { - "model_provider": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Provider" - }, - "model_version": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Model Version" + "title": "Location" }, - "temperature": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Temperature" - } - }, - "type": "object", - "title": "LLMOverride" - }, - "DeepResearchPlanDelta": { - "properties": { - "type": { + "msg": { "type": "string", - "const": "deep_research_plan_delta", - "title": "Type", - "default": "deep_research_plan_delta" + "title": "Message" }, - "content": { + "type": { "type": "string", - "title": "Content" + "title": "Error Type" } }, "type": "object", "required": [ - "content" + "loc", + "msg", + "type" ], - "title": "DeepResearchPlanDelta" + "title": "ValidationError" }, - "Tag": { + "ResearchAgentStart": { "properties": { - "tag_key": { + "type": { "type": "string", - "title": "Tag Key" + "const": "research_agent_start", + "title": "Type", + "default": "research_agent_start" }, - "tag_value": { + "research_task": { "type": "string", - "title": "Tag Value" + "title": "Research Task" } }, "type": "object", "required": [ - "tag_key", - "tag_value" + "research_task" ], - "title": "Tag" + "title": "ResearchAgentStart" }, - "DocsCountOperator": { + "RecencyBiasSetting": { "type": "string", "enum": [ - ">", - "<", - "=" - ], - "title": "DocsCountOperator" - }, - "OpenUrlUrls": { - "properties": { - "type": { - "type": "string", - "const": "open_url_urls", - "title": "Type", - "default": "open_url_urls" - }, - "urls": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Urls" - } - }, - "type": "object", - "required": [ - "urls" + "favor_recent", + "base_decay", + "no_decay", + "auto" ], - "title": "OpenUrlUrls", - "description": "URLs to be fetched (sent before crawling begins)." - }, - "ImageGenerationToolHeartbeat": { - "properties": { - "type": { - "type": "string", - "const": "image_generation_heartbeat", - "title": "Type", - "default": "image_generation_heartbeat" - } - }, - "type": "object", - "title": "ImageGenerationToolHeartbeat" + "title": "RecencyBiasSetting" }, - "IndexAttemptSnapshot": { + "CCPairFullInfo": { "properties": { "id": { "type": "integer", "title": "Id" }, + "name": { + "type": "string", + "title": "Name" + }, "status": { + "$ref": "#/components/schemas/ConnectorCredentialPairStatus" + }, + "in_repeated_error_state": { + "type": "boolean", + "title": "In Repeated Error State" + }, + "num_docs_indexed": { + "type": "integer", + "title": "Num Docs Indexed" + }, + "connector": { + "$ref": "#/components/schemas/ConnectorSnapshot" + }, + "credential": { + "$ref": "#/components/schemas/CredentialSnapshot" + }, + "number_of_index_attempts": { + "type": "integer", + "title": "Number Of Index Attempts" + }, + "last_index_attempt_status": { "anyOf": [ { "$ref": "#/components/schemas/IndexingStatus" @@ -10015,23 +9878,24 @@ } ] }, - "from_beginning": { - "type": "boolean", - "title": "From Beginning" - }, - "new_docs_indexed": { - "type": "integer", - "title": "New Docs Indexed" + "latest_deletion_attempt": { + "anyOf": [ + { + "$ref": "#/components/schemas/DeletionAttemptSnapshot" + }, + { + "type": "null" + } + ] }, - "total_docs_indexed": { - "type": "integer", - "title": "Total Docs Indexed" + "access_type": { + "$ref": "#/components/schemas/AccessType" }, - "docs_removed_from_index": { - "type": "integer", - "title": "Docs Removed From Index" + "is_editable_for_current_user": { + "type": "boolean", + "title": "Is Editable For Current User" }, - "error_msg": { + "deletion_failure_message": { "anyOf": [ { "type": "string" @@ -10040,24 +9904,25 @@ "type": "null" } ], - "title": "Error Msg" + "title": "Deletion Failure Message" }, - "error_count": { - "type": "integer", - "title": "Error Count" + "indexing": { + "type": "boolean", + "title": "Indexing" }, - "full_exception_trace": { + "creator": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "uuid" }, { "type": "null" } ], - "title": "Full Exception Trace" + "title": "Creator" }, - "time_started": { + "creator_email": { "anyOf": [ { "type": "string" @@ -10066,13 +9931,21 @@ "type": "null" } ], - "title": "Time Started" + "title": "Creator Email" }, - "time_updated": { - "type": "string", - "title": "Time Updated" + "last_indexed": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ], + "title": "Last Indexed" }, - "poll_range_start": { + "last_pruned": { "anyOf": [ { "type": "string", @@ -10082,9 +9955,9 @@ "type": "null" } ], - "title": "Poll Range Start" + "title": "Last Pruned" }, - "poll_range_end": { + "last_full_permission_sync": { "anyOf": [ { "type": "string", @@ -10094,72 +9967,20 @@ "type": "null" } ], - "title": "Poll Range End" - } - }, - "type": "object", - "required": [ - "id", - "status", - "from_beginning", - "new_docs_indexed", - "total_docs_indexed", - "docs_removed_from_index", - "error_msg", - "error_count", - "full_exception_trace", - "time_started", - "time_updated" - ], - "title": "IndexAttemptSnapshot" - }, - "UserFileIdsRequest": { - "properties": { - "file_ids": { - "items": { - "type": "string", - "format": "uuid" - }, - "type": "array", - "title": "File Ids" - } - }, - "type": "object", - "required": [ - "file_ids" - ], - "title": "UserFileIdsRequest" - }, - "ChatSessionDetailResponse": { - "properties": { - "chat_session_id": { - "type": "string", - "format": "uuid", - "title": "Chat Session Id" - }, - "description": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Description" + "title": "Last Full Permission Sync" }, - "persona_id": { + "overall_indexing_speed": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Persona Id" + "title": "Overall Indexing Speed" }, - "persona_name": { + "latest_checkpoint_description": { "anyOf": [ { "type": "string" @@ -10168,185 +9989,145 @@ "type": "null" } ], - "title": "Persona Name" + "title": "Latest Checkpoint Description" }, - "personal_icon_name": { + "last_permission_sync_attempt_status": { "anyOf": [ { - "type": "string" + "$ref": "#/components/schemas/PermissionSyncStatus" }, { "type": "null" } - ], - "title": "Personal Icon Name" - }, - "messages": { - "items": { - "$ref": "#/components/schemas/ChatMessageDetail" - }, - "type": "array", - "title": "Messages" - }, - "time_created": { - "type": "string", - "format": "date-time", - "title": "Time Created" + ] }, - "shared_status": { - "$ref": "#/components/schemas/ChatSessionSharedStatus" + "permission_syncing": { + "type": "boolean", + "title": "Permission Syncing" }, - "current_alternate_model": { + "last_permission_sync_attempt_finished": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Current Alternate Model" + "title": "Last Permission Sync Attempt Finished" }, - "current_temperature_override": { + "last_permission_sync_attempt_error_message": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Current Temperature Override" - }, - "deleted": { - "type": "boolean", - "title": "Deleted", - "default": false - }, - "packets": { - "items": { - "items": { - "$ref": "#/components/schemas/Packet" - }, - "type": "array" - }, - "type": "array", - "title": "Packets" - } - }, - "type": "object", - "required": [ - "chat_session_id", - "description", - "persona_name", - "personal_icon_name", - "messages", - "time_created", - "shared_status", - "current_alternate_model", - "current_temperature_override", - "packets" - ], - "title": "ChatSessionDetailResponse" - }, - "VersionResponse": { - "properties": { - "backend_version": { - "type": "string", - "title": "Backend Version" + "title": "Last Permission Sync Attempt Error Message" } }, "type": "object", "required": [ - "backend_version" + "id", + "name", + "status", + "in_repeated_error_state", + "num_docs_indexed", + "connector", + "credential", + "number_of_index_attempts", + "last_index_attempt_status", + "latest_deletion_attempt", + "access_type", + "is_editable_for_current_user", + "deletion_failure_message", + "indexing", + "creator", + "creator_email", + "last_indexed", + "last_pruned", + "last_full_permission_sync", + "overall_indexing_speed", + "latest_checkpoint_description", + "last_permission_sync_attempt_status", + "permission_syncing", + "last_permission_sync_attempt_finished", + "last_permission_sync_attempt_error_message" ], - "title": "VersionResponse" + "title": "CCPairFullInfo" }, - "MessageType": { + "SearchType": { "type": "string", "enum": [ - "system", - "user", - "assistant", - "tool_call", - "tool_call_response" + "keyword", + "semantic", + "internet" ], - "title": "MessageType" + "title": "SearchType" }, - "ValidationError": { + "BasicCCPairInfo": { "properties": { - "loc": { - "items": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "integer" - } - ] - }, - "type": "array", - "title": "Location" - }, - "msg": { - "type": "string", - "title": "Message" + "has_successful_run": { + "type": "boolean", + "title": "Has Successful Run" }, - "type": { - "type": "string", - "title": "Error Type" + "source": { + "$ref": "#/components/schemas/DocumentSource" } }, "type": "object", "required": [ - "loc", - "msg", - "type" + "has_successful_run", + "source" ], - "title": "ValidationError" + "title": "BasicCCPairInfo" }, - "ResearchAgentStart": { + "CategorizedFilesSnapshot": { "properties": { - "type": { - "type": "string", - "const": "research_agent_start", - "title": "Type", - "default": "research_agent_start" + "user_files": { + "items": { + "$ref": "#/components/schemas/UserFileSnapshot" + }, + "type": "array", + "title": "User Files" }, - "research_task": { - "type": "string", - "title": "Research Task" + "non_accepted_files": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Non Accepted Files" + }, + "unsupported_files": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Unsupported Files" } }, "type": "object", "required": [ - "research_task" + "user_files", + "non_accepted_files", + "unsupported_files" ], - "title": "ResearchAgentStart" + "title": "CategorizedFilesSnapshot" }, - "ConnectorFileInfo": { + "DocumentSetSummary": { "properties": { - "file_id": { - "type": "string", - "title": "File Id" + "id": { + "type": "integer", + "title": "Id" }, - "file_name": { + "name": { "type": "string", - "title": "File Name" - }, - "file_size": { - "anyOf": [ - { - "type": "integer" - }, - { - "type": "null" - } - ], - "title": "File Size" + "title": "Name" }, - "upload_date": { + "description": { "anyOf": [ { "type": "string" @@ -10355,30 +10136,68 @@ "type": "null" } ], - "title": "Upload Date" - } - }, - "type": "object", - "required": [ - "file_id", - "file_name" + "title": "Description" + }, + "cc_pair_summaries": { + "items": { + "$ref": "#/components/schemas/CCPairSummary" + }, + "type": "array", + "title": "Cc Pair Summaries" + }, + "is_up_to_date": { + "type": "boolean", + "title": "Is Up To Date" + }, + "is_public": { + "type": "boolean", + "title": "Is Public" + }, + "users": { + "items": { + "type": "string", + "format": "uuid" + }, + "type": "array", + "title": "Users" + }, + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups" + }, + "federated_connector_summaries": { + "items": { + "$ref": "#/components/schemas/FederatedConnectorSummary" + }, + "type": "array", + "title": "Federated Connector Summaries" + } + }, + "type": "object", + "required": [ + "id", + "name", + "description", + "cc_pair_summaries", + "is_up_to_date", + "is_public", + "users", + "groups" ], - "title": "ConnectorFileInfo" + "title": "DocumentSetSummary", + "description": "Simplified document set model with minimal data for list views" }, - "RerankingDetails": { + "ChatSessionCreationRequest": { "properties": { - "rerank_model_name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Rerank Model Name" + "persona_id": { + "type": "integer", + "title": "Persona Id", + "default": 0 }, - "rerank_api_url": { + "description": { "anyOf": [ { "type": "string" @@ -10387,55 +10206,63 @@ "type": "null" } ], - "title": "Rerank Api Url" - }, - "rerank_provider_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/RerankerProvider" - }, - { - "type": "null" - } - ] + "title": "Description" }, - "rerank_api_key": { + "project_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Rerank Api Key" + "title": "Project Id" + } + }, + "type": "object", + "title": "ChatSessionCreationRequest" + }, + "WebSearchProviderType": { + "type": "string", + "enum": [ + "google_pse", + "serper", + "exa", + "searxng" + ], + "title": "WebSearchProviderType" + }, + "UserRoleUpdateRequest": { + "properties": { + "user_email": { + "type": "string", + "title": "User Email" }, - "num_rerank": { - "type": "integer", - "title": "Num Rerank" + "new_role": { + "$ref": "#/components/schemas/UserRole" }, - "disable_rerank_for_streaming": { + "explicit_override": { "type": "boolean", - "title": "Disable Rerank For Streaming", + "title": "Explicit Override", "default": false } }, "type": "object", "required": [ - "rerank_model_name", - "rerank_api_url", - "rerank_provider_type", - "num_rerank" + "user_email", + "new_role" ], - "title": "RerankingDetails" + "title": "UserRoleUpdateRequest" }, - "ConnectorIndexingStatusLite": { + "UserFileSnapshot": { "properties": { - "cc_pair_id": { - "type": "integer", - "title": "Cc Pair Id" + "id": { + "type": "string", + "format": "uuid", + "title": "Id" }, - "name": { + "temp_id": { "anyOf": [ { "type": "string" @@ -10444,46 +10271,48 @@ "type": "null" } ], - "title": "Name" - }, - "source": { - "$ref": "#/components/schemas/DocumentSource" - }, - "access_type": { - "$ref": "#/components/schemas/AccessType" - }, - "cc_pair_status": { - "$ref": "#/components/schemas/ConnectorCredentialPairStatus" - }, - "in_progress": { - "type": "boolean", - "title": "In Progress" + "title": "Temp Id" }, - "in_repeated_error_state": { - "type": "boolean", - "title": "In Repeated Error State" + "name": { + "type": "string", + "title": "Name" }, - "last_finished_status": { + "project_id": { "anyOf": [ { - "$ref": "#/components/schemas/IndexingStatus" + "type": "integer" }, { "type": "null" } - ] + ], + "title": "Project Id" }, - "last_status": { + "user_id": { "anyOf": [ { - "$ref": "#/components/schemas/IndexingStatus" + "type": "string", + "format": "uuid" }, { "type": "null" } - ] + ], + "title": "User Id" }, - "last_success": { + "file_id": { + "type": "string", + "title": "File Id" + }, + "created_at": { + "type": "string", + "format": "date-time", + "title": "Created At" + }, + "status": { + "$ref": "#/components/schemas/UserFileStatus" + }, + "last_accessed_at": { "anyOf": [ { "type": "string", @@ -10493,89 +10322,153 @@ "type": "null" } ], - "title": "Last Success" - }, - "is_editable": { - "type": "boolean", - "title": "Is Editable" - }, - "docs_indexed": { - "type": "integer", - "title": "Docs Indexed" + "title": "Last Accessed At" }, - "latest_index_attempt_docs_indexed": { + "file_type": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Latest Index Attempt Docs Indexed" - } - }, - "type": "object", - "required": [ - "cc_pair_id", - "name", - "source", - "access_type", - "cc_pair_status", - "in_progress", - "in_repeated_error_state", - "last_finished_status", - "last_status", - "last_success", - "is_editable", - "docs_indexed", - "latest_index_attempt_docs_indexed" - ], - "title": "ConnectorIndexingStatusLite" - }, - "UpdateProjectRequest": { - "properties": { - "name": { + "title": "File Type" + }, + "chat_file_type": { + "$ref": "#/components/schemas/ChatFileType" + }, + "token_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Name" + "title": "Token Count" }, - "description": { + "chunk_count": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Description" + "title": "Chunk Count" } }, "type": "object", - "title": "UpdateProjectRequest" + "required": [ + "id", + "name", + "user_id", + "file_id", + "created_at", + "status", + "last_accessed_at", + "file_type", + "chat_file_type", + "token_count", + "chunk_count" + ], + "title": "UserFileSnapshot" }, - "CredentialSnapshot": { + "ReasoningDone": { "properties": { - "credential_json": { - "additionalProperties": true, - "type": "object", - "title": "Credential Json" + "type": { + "type": "string", + "const": "reasoning_done", + "title": "Type", + "default": "reasoning_done" + } + }, + "type": "object", + "title": "ReasoningDone" + }, + "DocumentSearchResponse": { + "properties": { + "top_documents": { + "items": { + "$ref": "#/components/schemas/SavedSearchDocWithContent" + }, + "type": "array", + "title": "Top Documents" }, - "admin_public": { - "type": "boolean", - "title": "Admin Public" + "llm_indices": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Llm Indices" }, - "source": { - "$ref": "#/components/schemas/DocumentSource" + "pagination": { + "$ref": "#/components/schemas/DocumentSearchPagination" + } + }, + "type": "object", + "required": [ + "top_documents", + "llm_indices", + "pagination" + ], + "title": "DocumentSearchResponse" + }, + "LLMEvaluationType": { + "type": "string", + "enum": [ + "agentic", + "basic", + "skip", + "unspecified" + ], + "title": "LLMEvaluationType" + }, + "ReasoningDelta": { + "properties": { + "type": { + "type": "string", + "const": "reasoning_delta", + "title": "Type", + "default": "reasoning_delta" + }, + "reasoning": { + "type": "string", + "title": "Reasoning" + } + }, + "type": "object", + "required": [ + "reasoning" + ], + "title": "ReasoningDelta" + }, + "PersonaSnapshot": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "is_public": { + "type": "boolean", + "title": "Is Public" + }, + "is_visible": { + "type": "boolean", + "title": "Is Visible" + }, + "uploaded_image_id": { "anyOf": [ { "type": "string" @@ -10584,12 +10477,97 @@ "type": "null" } ], - "title": "Name" + "title": "Uploaded Image Id" }, - "curator_public": { + "icon_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Icon Name" + }, + "user_file_ids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "User File Ids" + }, + "display_priority": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Display Priority" + }, + "is_default_persona": { "type": "boolean", - "title": "Curator Public", - "default": false + "title": "Is Default Persona" + }, + "builtin_persona": { + "type": "boolean", + "title": "Builtin Persona" + }, + "starter_messages": { + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/StarterMessage" + }, + "type": "array" + }, + { + "type": "null" + } + ], + "title": "Starter Messages" + }, + "llm_relevance_filter": { + "type": "boolean", + "title": "Llm Relevance Filter" + }, + "llm_filter_extraction": { + "type": "boolean", + "title": "Llm Filter Extraction" + }, + "tools": { + "items": { + "$ref": "#/components/schemas/ToolSnapshot" + }, + "type": "array", + "title": "Tools" + }, + "labels": { + "items": { + "$ref": "#/components/schemas/PersonaLabelSnapshot" + }, + "type": "array", + "title": "Labels" + }, + "owner": { + "anyOf": [ + { + "$ref": "#/components/schemas/MinimalUserSnapshot" + }, + { + "type": "null" + } + ] + }, + "users": { + "items": { + "$ref": "#/components/schemas/MinimalUserSnapshot" + }, + "type": "array", + "title": "Users" }, "groups": { "items": { @@ -10598,28 +10576,25 @@ "type": "array", "title": "Groups" }, - "is_user_file": { - "type": "boolean", - "title": "Is User File", - "default": false - }, - "id": { - "type": "integer", - "title": "Id" + "document_sets": { + "items": { + "$ref": "#/components/schemas/DocumentSetSummary" + }, + "type": "array", + "title": "Document Sets" }, - "user_id": { + "llm_model_provider_override": { "anyOf": [ { - "type": "string", - "format": "uuid" + "type": "string" }, { "type": "null" } ], - "title": "User Id" + "title": "Llm Model Provider Override" }, - "user_email": { + "llm_model_version_override": { "anyOf": [ { "type": "string" @@ -10628,49 +10603,20 @@ "type": "null" } ], - "title": "User Email" - }, - "time_created": { - "type": "string", - "format": "date-time", - "title": "Time Created" - }, - "time_updated": { - "type": "string", - "format": "date-time", - "title": "Time Updated" - } - }, - "type": "object", - "required": [ - "credential_json", - "admin_public", - "source", - "id", - "user_id", - "time_created", - "time_updated" - ], - "title": "CredentialSnapshot" - }, - "FailedConnectorIndexingStatus": { - "properties": { - "cc_pair_id": { - "type": "integer", - "title": "Cc Pair Id" + "title": "Llm Model Version Override" }, - "name": { + "num_chunks": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Name" + "title": "Num Chunks" }, - "error_msg": { + "system_prompt": { "anyOf": [ { "type": "string" @@ -10679,262 +10625,271 @@ "type": "null" } ], - "title": "Error Msg" + "title": "System Prompt" }, - "is_deletable": { + "replace_base_system_prompt": { "type": "boolean", - "title": "Is Deletable" + "title": "Replace Base System Prompt", + "default": false }, - "connector_id": { - "type": "integer", - "title": "Connector Id" + "task_prompt": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Task Prompt" }, - "credential_id": { - "type": "integer", - "title": "Credential Id" + "datetime_aware": { + "type": "boolean", + "title": "Datetime Aware", + "default": true } }, "type": "object", "required": [ - "cc_pair_id", + "id", "name", - "error_msg", - "is_deletable", - "connector_id", - "credential_id" + "description", + "is_public", + "is_visible", + "uploaded_image_id", + "icon_name", + "user_file_ids", + "display_priority", + "is_default_persona", + "builtin_persona", + "starter_messages", + "llm_relevance_filter", + "llm_filter_extraction", + "tools", + "labels", + "owner", + "users", + "groups", + "document_sets", + "llm_model_provider_override", + "llm_model_version_override", + "num_chunks" ], - "title": "FailedConnectorIndexingStatus", - "description": "Simplified version of ConnectorIndexingStatus for failed indexing attempts" + "title": "PersonaSnapshot" }, - "SectionEnd": { + "ChatSeedResponse": { "properties": { - "type": { + "redirect_url": { "type": "string", - "const": "section_end", - "title": "Type", - "default": "section_end" + "title": "Redirect Url" } }, "type": "object", - "title": "SectionEnd" + "required": [ + "redirect_url" + ], + "title": "ChatSeedResponse" }, - "MethodSpec": { + "InvitedUserSnapshot": { "properties": { - "name": { - "type": "string", - "title": "Name" - }, - "summary": { - "type": "string", - "title": "Summary" - }, - "path": { - "type": "string", - "title": "Path" - }, - "method": { + "email": { "type": "string", - "title": "Method" - }, - "spec": { - "additionalProperties": true, - "type": "object", - "title": "Spec" + "title": "Email" } }, "type": "object", "required": [ - "name", - "summary", - "path", - "method", - "spec" + "email" ], - "title": "MethodSpec" + "title": "InvitedUserSnapshot" }, - "ImageGenerationToolStart": { + "UserFileIdsRequest": { "properties": { - "type": { - "type": "string", - "const": "image_generation_start", - "title": "Type", - "default": "image_generation_start" + "file_ids": { + "items": { + "type": "string", + "format": "uuid" + }, + "type": "array", + "title": "File Ids" } }, "type": "object", - "title": "ImageGenerationToolStart" + "required": [ + "file_ids" + ], + "title": "UserFileIdsRequest" }, - "OpenUrlDocuments": { + "Body_upload_files_api_manage_admin_connector_file_upload_post": { "properties": { - "type": { - "type": "string", - "const": "open_url_documents", - "title": "Type", - "default": "open_url_documents" - }, - "documents": { + "files": { "items": { - "$ref": "#/components/schemas/SearchDoc" + "type": "string", + "format": "binary" }, "type": "array", - "title": "Documents" + "title": "Files" } }, "type": "object", "required": [ - "documents" + "files" ], - "title": "OpenUrlDocuments", - "description": "Final documents after crawling completes." + "title": "Body_upload_files_api_manage_admin_connector_file_upload_post" }, - "ConnectorIndexingStatusLiteResponse": { + "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put": { "properties": { - "source": { - "$ref": "#/components/schemas/DocumentSource" + "name": { + "type": "string", + "title": "Name" }, - "summary": { - "$ref": "#/components/schemas/SourceSummary" + "credential_json": { + "type": "string", + "title": "Credential Json" }, - "current_page": { - "type": "integer", - "title": "Current Page" + "uploaded_file": { + "type": "string", + "format": "binary", + "title": "Uploaded File" }, - "total_pages": { - "type": "integer", - "title": "Total Pages" + "field_key": { + "type": "string", + "title": "Field Key" }, - "indexing_statuses": { - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/ConnectorIndexingStatusLite" - }, - { - "$ref": "#/components/schemas/FederatedConnectorStatus" - } - ] - }, - "type": "array", - "title": "Indexing Statuses" + "type_definition_key": { + "type": "string", + "title": "Type Definition Key" } }, "type": "object", "required": [ - "source", - "summary", - "current_page", - "total_pages", - "indexing_statuses" + "name", + "credential_json", + "uploaded_file", + "field_key", + "type_definition_key" ], - "title": "ConnectorIndexingStatusLiteResponse" + "title": "Body_update_credential_private_key_manage_admin_credential_private_key__credential_id__put" }, - "SearchToolStart": { + "ImageGenerationFinal": { "properties": { "type": { "type": "string", - "const": "search_tool_start", + "const": "image_generation_final", "title": "Type", - "default": "search_tool_start" + "default": "image_generation_final" }, - "is_internet_search": { - "type": "boolean", - "title": "Is Internet Search", - "default": false + "images": { + "items": { + "$ref": "#/components/schemas/GeneratedImage" + }, + "type": "array", + "title": "Images" } }, "type": "object", - "title": "SearchToolStart" + "required": [ + "images" + ], + "title": "ImageGenerationFinal" }, - "ChatSeedResponse": { + "IntermediateReportDelta": { "properties": { - "redirect_url": { + "type": { "type": "string", - "title": "Redirect Url" + "const": "intermediate_report_delta", + "title": "Type", + "default": "intermediate_report_delta" + }, + "content": { + "type": "string", + "title": "Content" } }, "type": "object", "required": [ - "redirect_url" + "content" ], - "title": "ChatSeedResponse" + "title": "IntermediateReportDelta" }, - "PaginatedReturn_PersonaSnapshot_": { + "UserSpecificAssistantPreference": { "properties": { - "items": { + "disabled_tool_ids": { "items": { - "$ref": "#/components/schemas/PersonaSnapshot" + "type": "integer" }, "type": "array", - "title": "Items" - }, - "total_items": { - "type": "integer", - "title": "Total Items" + "title": "Disabled Tool Ids" } }, "type": "object", "required": [ - "items", - "total_items" + "disabled_tool_ids" ], - "title": "PaginatedReturn[PersonaSnapshot]" + "title": "UserSpecificAssistantPreference" }, - "OpenUrlsToolResponse": { + "WebSearchToolResponse": { "properties": { "results": { "items": { - "$ref": "#/components/schemas/LlmOpenUrlResult" + "$ref": "#/components/schemas/LlmWebSearchResult" }, "type": "array", "title": "Results" }, "provider_type": { - "anyOf": [ - { - "$ref": "#/components/schemas/WebContentProviderType" - }, - { - "type": "null" - } - ] + "$ref": "#/components/schemas/WebSearchProviderType" } }, "type": "object", "required": [ - "results" + "results", + "provider_type" ], - "title": "OpenUrlsToolResponse" + "title": "WebSearchToolResponse" }, - "ChatMessageDetail": { + "IndexingStatusRequest": { "properties": { - "chat_session_id": { + "secondary_index": { + "type": "boolean", + "title": "Secondary Index", + "default": false + }, + "source": { "anyOf": [ { - "type": "string", - "format": "uuid" + "$ref": "#/components/schemas/DocumentSource" }, { "type": "null" } - ], - "title": "Chat Session Id" + ] }, - "message_id": { - "type": "integer", - "title": "Message Id" + "access_type_filters": { + "items": { + "$ref": "#/components/schemas/AccessType" + }, + "type": "array", + "title": "Access Type Filters" }, - "parent_message": { + "last_status_filters": { + "items": { + "$ref": "#/components/schemas/IndexingStatus" + }, + "type": "array", + "title": "Last Status Filters" + }, + "docs_count_operator": { "anyOf": [ { - "type": "integer" + "$ref": "#/components/schemas/DocsCountOperator" }, { "type": "null" } - ], - "title": "Parent Message" + ] }, - "latest_child_message": { + "docs_count_value": { "anyOf": [ { "type": "integer" @@ -10943,13 +10898,9 @@ "type": "null" } ], - "title": "Latest Child Message" - }, - "message": { - "type": "string", - "title": "Message" + "title": "Docs Count Value" }, - "reasoning_tokens": { + "name_filter": { "anyOf": [ { "type": "string" @@ -10958,16 +10909,43 @@ "type": "null" } ], - "title": "Reasoning Tokens" + "title": "Name Filter" }, - "message_type": { - "$ref": "#/components/schemas/MessageType" + "source_to_page": { + "additionalProperties": { + "type": "integer" + }, + "propertyNames": { + "$ref": "#/components/schemas/DocumentSource" + }, + "type": "object", + "title": "Source To Page" }, - "context_docs": { + "get_all_connectors": { + "type": "boolean", + "title": "Get All Connectors", + "default": false + } + }, + "type": "object", + "title": "IndexingStatusRequest" + }, + "ChatSessionSharedStatus": { + "type": "string", + "enum": [ + "public", + "private" + ], + "title": "ChatSessionSharedStatus" + }, + "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post": { + "properties": { + "files": { "anyOf": [ { "items": { - "$ref": "#/components/schemas/SavedSearchDoc" + "type": "string", + "format": "binary" }, "type": "array" }, @@ -10975,86 +10953,84 @@ "type": "null" } ], - "title": "Context Docs" - }, - "citations": { - "anyOf": [ - { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Citations" + "title": "Files" }, - "time_sent": { + "file_ids_to_remove": { "type": "string", - "format": "date-time", - "title": "Time Sent" + "title": "File Ids To Remove", + "default": "[]" + } + }, + "type": "object", + "title": "Body_update_connector_files_manage_admin_connector__connector_id__files_update_post" + }, + "FederatedConnectorSummary": { + "properties": { + "id": { + "type": "integer", + "title": "Id" }, - "files": { - "items": { - "$ref": "#/components/schemas/FileDescriptor" - }, - "type": "array", - "title": "Files" + "name": { + "type": "string", + "title": "Name" }, - "error": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Error" + "source": { + "$ref": "#/components/schemas/FederatedConnectorSource" }, - "current_feedback": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Current Feedback" + "entities": { + "additionalProperties": true, + "type": "object", + "title": "Entities" } }, "type": "object", "required": [ - "message_id", - "message", - "message_type", - "time_sent", - "files" + "id", + "name", + "source", + "entities" ], - "title": "ChatMessageDetail" + "title": "FederatedConnectorSummary", + "description": "Simplified federated connector information with just essential data" }, - "CCStatusUpdateRequest": { + "ImageGenerationToolHeartbeat": { "properties": { - "status": { - "$ref": "#/components/schemas/ConnectorCredentialPairStatus" + "type": { + "type": "string", + "const": "image_generation_heartbeat", + "title": "Type", + "default": "image_generation_heartbeat" + } + }, + "type": "object", + "title": "ImageGenerationToolHeartbeat" + }, + "AccessType": { + "type": "string", + "enum": [ + "public", + "private", + "sync" + ], + "title": "AccessType" + }, + "CreateChatSessionID": { + "properties": { + "chat_session_id": { + "type": "string", + "format": "uuid", + "title": "Chat Session Id" } }, "type": "object", "required": [ - "status" + "chat_session_id" ], - "title": "CCStatusUpdateRequest" + "title": "CreateChatSessionID" }, - "LlmOpenUrlResult": { + "ConnectorCredentialPairMetadata": { "properties": { - "document_citation_number": { - "type": "integer", - "title": "Document Citation Number" - }, - "unique_identifier_to_strip_away": { + "name": { "anyOf": [ { "type": "string" @@ -11063,661 +11039,429 @@ "type": "null" } ], - "title": "Unique Identifier To Strip Away" + "title": "Name" }, - "type": { - "type": "string", - "const": "open_url", - "title": "Type", - "default": "open_url" + "access_type": { + "$ref": "#/components/schemas/AccessType" }, - "content": { - "type": "string", - "title": "Content" + "auto_sync_options": { + "anyOf": [ + { + "additionalProperties": true, + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Auto Sync Options" + }, + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups" } }, "type": "object", "required": [ - "document_citation_number", - "content" + "access_type" ], - "title": "LlmOpenUrlResult", - "description": "Result from opening/fetching a URL" + "title": "ConnectorCredentialPairMetadata" }, "OptionalSearchSetting": { "type": "string", "enum": [ - "always", - "never", - "auto" - ], - "title": "OptionalSearchSetting" - }, - "WebSearchToolResponse": { - "properties": { - "results": { - "items": { - "$ref": "#/components/schemas/LlmWebSearchResult" - }, - "type": "array", - "title": "Results" - }, - "provider_type": { - "$ref": "#/components/schemas/WebSearchProviderType" - } - }, - "type": "object", - "required": [ - "results", - "provider_type" - ], - "title": "WebSearchToolResponse" - }, - "ChatSessionGroup": { - "properties": { - "title": { - "type": "string", - "title": "Title" - }, - "chats": { - "items": { - "$ref": "#/components/schemas/ChatSessionSummary" - }, - "type": "array", - "title": "Chats" - } - }, - "type": "object", - "required": [ - "title", - "chats" - ], - "title": "ChatSessionGroup" - }, - "SavedSearchDocWithContent": { - "properties": { - "document_id": { - "type": "string", - "title": "Document Id" - }, - "chunk_ind": { - "type": "integer", - "title": "Chunk Ind" - }, - "semantic_identifier": { - "type": "string", - "title": "Semantic Identifier" - }, - "link": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Link" - }, - "blurb": { - "type": "string", - "title": "Blurb" - }, - "source_type": { - "$ref": "#/components/schemas/DocumentSource" - }, - "boost": { - "type": "integer", - "title": "Boost" - }, - "hidden": { - "type": "boolean", - "title": "Hidden" - }, - "metadata": { - "additionalProperties": { - "anyOf": [ - { - "type": "string" - }, - { - "items": { - "type": "string" - }, - "type": "array" - } - ] - }, - "type": "object", - "title": "Metadata" - }, - "score": { - "anyOf": [ - { - "type": "number" - }, - { - "type": "null" - } - ], - "title": "Score", - "default": 0.0 - }, - "is_relevant": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Is Relevant" - }, - "relevance_explanation": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Relevance Explanation" - }, - "match_highlights": { - "items": { - "type": "string" - }, - "type": "array", - "title": "Match Highlights" - }, - "updated_at": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ], - "title": "Updated At" - }, - "primary_owners": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Primary Owners" - }, - "secondary_owners": { - "anyOf": [ - { - "items": { - "type": "string" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Secondary Owners" - }, - "is_internet": { - "type": "boolean", - "title": "Is Internet", - "default": false - }, - "db_doc_id": { - "type": "integer", - "title": "Db Doc Id" - }, - "content": { - "type": "string", - "title": "Content" - } - }, - "type": "object", - "required": [ - "document_id", - "chunk_ind", - "semantic_identifier", - "blurb", - "source_type", - "boost", - "hidden", - "metadata", - "match_highlights", - "db_doc_id", - "content" - ], - "title": "SavedSearchDocWithContent", - "description": "Used for endpoints that need to return the actual contents of the retrieved\nsection in addition to the match_highlights." - }, - "ProjectPayload": { - "properties": { - "project": { - "$ref": "#/components/schemas/UserProjectSnapshot" - }, - "files": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/UserFileSnapshot" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Files" - }, - "persona_id_to_is_default": { - "anyOf": [ - { - "additionalProperties": { - "type": "boolean" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Persona Id To Is Default" - } - }, - "type": "object", - "required": [ - "project" - ], - "title": "ProjectPayload" - }, - "Body_create_credential_with_private_key_manage_credential_private_key_post": { - "properties": { - "credential_json": { - "type": "string", - "title": "Credential Json" - }, - "admin_public": { - "type": "boolean", - "title": "Admin Public", - "default": false - }, - "curator_public": { - "type": "boolean", - "title": "Curator Public", - "default": false - }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups", - "default": [] - }, - "name": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "title": "Name" - }, - "source": { - "type": "string", - "title": "Source" - }, - "uploaded_file": { - "type": "string", - "format": "binary", - "title": "Uploaded File" - }, - "field_key": { - "type": "string", - "title": "Field Key" - }, - "type_definition_key": { - "type": "string", - "title": "Type Definition Key" - } - }, - "type": "object", - "required": [ - "credential_json", - "source", - "uploaded_file", - "field_key", - "type_definition_key" - ], - "title": "Body_create_credential_with_private_key_manage_credential_private_key_post" - }, - "UserByEmail": { - "properties": { - "user_email": { - "type": "string", - "title": "User Email" - } - }, - "type": "object", - "required": [ - "user_email" - ], - "title": "UserByEmail" - }, - "Packet": { - "properties": { - "placement": { - "$ref": "#/components/schemas/Placement" - }, - "obj": { - "oneOf": [ - { - "$ref": "#/components/schemas/OverallStop" - }, - { - "$ref": "#/components/schemas/SectionEnd" - }, - { - "$ref": "#/components/schemas/TopLevelBranching" - }, - { - "$ref": "#/components/schemas/AgentResponseStart" - }, - { - "$ref": "#/components/schemas/AgentResponseDelta" - }, - { - "$ref": "#/components/schemas/SearchToolStart" - }, - { - "$ref": "#/components/schemas/SearchToolQueriesDelta" - }, - { - "$ref": "#/components/schemas/SearchToolDocumentsDelta" - }, - { - "$ref": "#/components/schemas/ImageGenerationToolStart" - }, - { - "$ref": "#/components/schemas/ImageGenerationToolHeartbeat" - }, - { - "$ref": "#/components/schemas/ImageGenerationFinal" - }, - { - "$ref": "#/components/schemas/OpenUrlStart" - }, - { - "$ref": "#/components/schemas/OpenUrlUrls" - }, - { - "$ref": "#/components/schemas/OpenUrlDocuments" - }, - { - "$ref": "#/components/schemas/PythonToolStart" - }, - { - "$ref": "#/components/schemas/PythonToolDelta" - }, - { - "$ref": "#/components/schemas/CustomToolStart" - }, - { - "$ref": "#/components/schemas/CustomToolDelta" - }, - { - "$ref": "#/components/schemas/ReasoningStart" - }, - { - "$ref": "#/components/schemas/ReasoningDelta" - }, - { - "$ref": "#/components/schemas/ReasoningDone" - }, - { - "$ref": "#/components/schemas/CitationInfo" - }, - { - "$ref": "#/components/schemas/DeepResearchPlanStart" - }, - { - "$ref": "#/components/schemas/DeepResearchPlanDelta" - }, - { - "$ref": "#/components/schemas/ResearchAgentStart" - }, - { - "$ref": "#/components/schemas/IntermediateReportStart" - }, - { - "$ref": "#/components/schemas/IntermediateReportDelta" - }, - { - "$ref": "#/components/schemas/IntermediateReportCitedDocs" - } - ], - "title": "Obj", - "discriminator": { - "propertyName": "type", - "mapping": { - "citation_info": "#/components/schemas/CitationInfo", - "custom_tool_delta": "#/components/schemas/CustomToolDelta", - "custom_tool_start": "#/components/schemas/CustomToolStart", - "deep_research_plan_delta": "#/components/schemas/DeepResearchPlanDelta", - "deep_research_plan_start": "#/components/schemas/DeepResearchPlanStart", - "image_generation_final": "#/components/schemas/ImageGenerationFinal", - "image_generation_heartbeat": "#/components/schemas/ImageGenerationToolHeartbeat", - "image_generation_start": "#/components/schemas/ImageGenerationToolStart", - "intermediate_report_cited_docs": "#/components/schemas/IntermediateReportCitedDocs", - "intermediate_report_delta": "#/components/schemas/IntermediateReportDelta", - "intermediate_report_start": "#/components/schemas/IntermediateReportStart", - "message_delta": "#/components/schemas/AgentResponseDelta", - "message_start": "#/components/schemas/AgentResponseStart", - "open_url_documents": "#/components/schemas/OpenUrlDocuments", - "open_url_start": "#/components/schemas/OpenUrlStart", - "open_url_urls": "#/components/schemas/OpenUrlUrls", - "python_tool_delta": "#/components/schemas/PythonToolDelta", - "python_tool_start": "#/components/schemas/PythonToolStart", - "reasoning_delta": "#/components/schemas/ReasoningDelta", - "reasoning_done": "#/components/schemas/ReasoningDone", - "reasoning_start": "#/components/schemas/ReasoningStart", - "research_agent_start": "#/components/schemas/ResearchAgentStart", - "search_tool_documents_delta": "#/components/schemas/SearchToolDocumentsDelta", - "search_tool_queries_delta": "#/components/schemas/SearchToolQueriesDelta", - "search_tool_start": "#/components/schemas/SearchToolStart", - "section_end": "#/components/schemas/SectionEnd", - "stop": "#/components/schemas/OverallStop", - "top_level_branching": "#/components/schemas/TopLevelBranching" - } - } + "always", + "never", + "auto" + ], + "title": "OptionalSearchSetting" + }, + "IntermediateReportStart": { + "properties": { + "type": { + "type": "string", + "const": "intermediate_report_start", + "title": "Type", + "default": "intermediate_report_start" + } + }, + "type": "object", + "title": "IntermediateReportStart" + }, + "OpenUrlsToolRequest": { + "properties": { + "urls": { + "items": { + "type": "string" + }, + "type": "array", + "minItems": 1, + "title": "Urls", + "description": "URLs to fetch using the configured content provider." } }, "type": "object", "required": [ - "placement", - "obj" + "urls" ], - "title": "Packet" + "title": "OpenUrlsToolRequest" }, - "UserPreferences": { + "SearchToolDocumentsDelta": { "properties": { - "chosen_assistants": { - "anyOf": [ - { - "items": { - "type": "integer" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Chosen Assistants" + "type": { + "type": "string", + "const": "search_tool_documents_delta", + "title": "Type", + "default": "search_tool_documents_delta" }, - "hidden_assistants": { + "documents": { "items": { - "type": "integer" + "$ref": "#/components/schemas/SearchDoc" }, "type": "array", - "title": "Hidden Assistants", - "default": [] + "title": "Documents" + } + }, + "type": "object", + "required": [ + "documents" + ], + "title": "SearchToolDocumentsDelta" + }, + "ContainerVersions": { + "properties": { + "onyx": { + "type": "string", + "title": "Onyx" }, - "visible_assistants": { + "relational_db": { + "type": "string", + "title": "Relational Db" + }, + "index": { + "type": "string", + "title": "Index" + }, + "nginx": { + "type": "string", + "title": "Nginx" + } + }, + "type": "object", + "required": [ + "onyx", + "relational_db", + "index", + "nginx" + ], + "title": "ContainerVersions" + }, + "UserRole": { + "type": "string", + "enum": [ + "limited", + "basic", + "admin", + "curator", + "global_curator", + "slack_user", + "ext_perm_user" + ], + "title": "UserRole", + "description": "User roles\n- Basic can't perform any admin actions\n- Admin can perform all admin actions\n- Curator can perform admin actions for\n groups they are curators of\n- Global Curator can perform admin actions\n for all groups they are a member of\n- Limited can access a limited set of basic api endpoints\n- Slack are users that have used onyx via slack but dont have a web login\n- External permissioned users that have been picked up during the external permissions sync process but don't have a web login" + }, + "Body_upload_user_files_user_projects_file_upload_post": { + "properties": { + "files": { "items": { - "type": "integer" + "type": "string", + "format": "binary" }, "type": "array", - "title": "Visible Assistants", - "default": [] + "title": "Files" }, - "default_model": { + "project_id": { "anyOf": [ { - "type": "string" + "type": "integer" }, { "type": "null" } ], - "title": "Default Model" + "title": "Project Id" }, - "pinned_assistants": { + "temp_id_map": { "anyOf": [ { - "items": { - "type": "integer" - }, - "type": "array" + "type": "string" }, { "type": "null" } ], - "title": "Pinned Assistants" + "title": "Temp Id Map" + } + }, + "type": "object", + "required": [ + "files" + ], + "title": "Body_upload_user_files_user_projects_file_upload_post" + }, + "ChatSessionsResponse": { + "properties": { + "sessions": { + "items": { + "$ref": "#/components/schemas/ChatSessionDetails" + }, + "type": "array", + "title": "Sessions" + } + }, + "type": "object", + "required": [ + "sessions" + ], + "title": "ChatSessionsResponse" + }, + "FailedConnectorIndexingStatus": { + "properties": { + "cc_pair_id": { + "type": "integer", + "title": "Cc Pair Id" }, - "shortcut_enabled": { + "name": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Shortcut Enabled" + "title": "Name" }, - "auto_scroll": { + "error_msg": { "anyOf": [ { - "type": "boolean" + "type": "string" }, { "type": "null" } ], - "title": "Auto Scroll" + "title": "Error Msg" }, - "temperature_override_enabled": { - "anyOf": [ - { - "type": "boolean" - }, - { - "type": "null" - } - ], - "title": "Temperature Override Enabled" + "is_deletable": { + "type": "boolean", + "title": "Is Deletable" }, - "theme_preference": { + "connector_id": { + "type": "integer", + "title": "Connector Id" + }, + "credential_id": { + "type": "integer", + "title": "Credential Id" + } + }, + "type": "object", + "required": [ + "cc_pair_id", + "name", + "error_msg", + "is_deletable", + "connector_id", + "credential_id" + ], + "title": "FailedConnectorIndexingStatus", + "description": "Simplified version of ConnectorIndexingStatus for failed indexing attempts" + }, + "ValidateToolRequest": { + "properties": { + "definition": { + "additionalProperties": true, + "type": "object", + "title": "Definition" + } + }, + "type": "object", + "required": [ + "definition" + ], + "title": "ValidateToolRequest" + }, + "GeneratedImage": { + "properties": { + "file_id": { + "type": "string", + "title": "File Id" + }, + "url": { + "type": "string", + "title": "Url" + }, + "revised_prompt": { + "type": "string", + "title": "Revised Prompt" + }, + "shape": { "anyOf": [ { - "$ref": "#/components/schemas/ThemePreference" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Shape" + } + }, + "type": "object", + "required": [ + "file_id", + "url", + "revised_prompt" + ], + "title": "GeneratedImage", + "description": "Represents an image generated by an image generation tool." + }, + "PaginatedReturn_IndexAttemptSnapshot_": { + "properties": { + "items": { + "items": { + "$ref": "#/components/schemas/IndexAttemptSnapshot" + }, + "type": "array", + "title": "Items" }, - "assistant_specific_configs": { - "anyOf": [ - { - "additionalProperties": { - "$ref": "#/components/schemas/UserSpecificAssistantPreference" - }, - "type": "object" - }, - { - "type": "null" - } - ], - "title": "Assistant Specific Configs" + "total_items": { + "type": "integer", + "title": "Total Items" } }, "type": "object", - "title": "UserPreferences" + "required": [ + "items", + "total_items" + ], + "title": "PaginatedReturn[IndexAttemptSnapshot]" }, - "MinimalUserSnapshot": { + "ConnectorCredentialPairStatus": { + "type": "string", + "enum": [ + "SCHEDULED", + "INITIAL_INDEXING", + "ACTIVE", + "PAUSED", + "DELETING", + "INVALID" + ], + "title": "ConnectorCredentialPairStatus" + }, + "FileUploadResponse": { "properties": { - "id": { - "type": "string", - "format": "uuid", - "title": "Id" + "file_paths": { + "items": { + "type": "string" + }, + "type": "array", + "title": "File Paths" }, - "email": { - "type": "string", - "title": "Email" + "file_names": { + "items": { + "type": "string" + }, + "type": "array", + "title": "File Names" + }, + "zip_metadata": { + "additionalProperties": true, + "type": "object", + "title": "Zip Metadata" } }, "type": "object", "required": [ - "id", - "email" + "file_paths", + "file_names", + "zip_metadata" ], - "title": "MinimalUserSnapshot" + "title": "FileUploadResponse" }, - "CitationInfo": { + "LlmWebSearchResult": { "properties": { + "document_citation_number": { + "type": "integer", + "title": "Document Citation Number" + }, + "unique_identifier_to_strip_away": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Unique Identifier To Strip Away" + }, "type": { "type": "string", - "const": "citation_info", + "const": "web_search", "title": "Type", - "default": "citation_info" + "default": "web_search" }, - "citation_number": { - "type": "integer", - "title": "Citation Number" + "url": { + "type": "string", + "title": "Url" }, - "document_id": { + "title": { "type": "string", - "title": "Document Id" + "title": "Title" + }, + "snippet": { + "type": "string", + "title": "Snippet" } }, "type": "object", "required": [ - "citation_number", - "document_id" + "document_citation_number", + "url", + "title", + "snippet" ], - "title": "CitationInfo" + "title": "LlmWebSearchResult", + "description": "Result from a web search query" }, - "CustomToolUpdate": { + "FullPersonaSnapshot": { "properties": { + "id": { + "type": "integer", + "title": "Id" + }, "name": { + "type": "string", + "title": "Name" + }, + "description": { + "type": "string", + "title": "Description" + }, + "is_public": { + "type": "boolean", + "title": "Is Public" + }, + "is_visible": { + "type": "boolean", + "title": "Is Visible" + }, + "uploaded_image_id": { "anyOf": [ { "type": "string" @@ -11726,9 +11470,9 @@ "type": "null" } ], - "title": "Name" + "title": "Uploaded Image Id" }, - "description": { + "icon_name": { "anyOf": [ { "type": "string" @@ -11737,25 +11481,39 @@ "type": "null" } ], - "title": "Description" + "title": "Icon Name" }, - "definition": { + "user_file_ids": { + "items": { + "type": "string" + }, + "type": "array", + "title": "User File Ids" + }, + "display_priority": { "anyOf": [ { - "additionalProperties": true, - "type": "object" + "type": "integer" }, { "type": "null" } ], - "title": "Definition" + "title": "Display Priority" }, - "custom_headers": { + "is_default_persona": { + "type": "boolean", + "title": "Is Default Persona" + }, + "builtin_persona": { + "type": "boolean", + "title": "Builtin Persona" + }, + "starter_messages": { "anyOf": [ { "items": { - "$ref": "#/components/schemas/Header" + "$ref": "#/components/schemas/StarterMessage" }, "type": "array" }, @@ -11763,76 +11521,97 @@ "type": "null" } ], - "title": "Custom Headers" + "title": "Starter Messages" }, - "passthrough_auth": { + "llm_relevance_filter": { + "type": "boolean", + "title": "Llm Relevance Filter", + "default": false + }, + "llm_filter_extraction": { + "type": "boolean", + "title": "Llm Filter Extraction", + "default": false + }, + "tools": { + "items": { + "$ref": "#/components/schemas/ToolSnapshot" + }, + "type": "array", + "title": "Tools" + }, + "labels": { + "items": { + "$ref": "#/components/schemas/PersonaLabelSnapshot" + }, + "type": "array", + "title": "Labels" + }, + "owner": { "anyOf": [ { - "type": "boolean" + "$ref": "#/components/schemas/MinimalUserSnapshot" }, { "type": "null" } - ], - "title": "Passthrough Auth" + ] }, - "oauth_config_id": { + "users": { + "items": { + "$ref": "#/components/schemas/MinimalUserSnapshot" + }, + "type": "array", + "title": "Users" + }, + "groups": { + "items": { + "type": "integer" + }, + "type": "array", + "title": "Groups" + }, + "document_sets": { + "items": { + "$ref": "#/components/schemas/DocumentSetSummary" + }, + "type": "array", + "title": "Document Sets" + }, + "llm_model_provider_override": { "anyOf": [ { - "type": "integer" + "type": "string" }, { "type": "null" } ], - "title": "Oauth Config Id" - } - }, - "type": "object", - "title": "CustomToolUpdate" - }, - "WebSearchToolRequest": { - "properties": { - "queries": { - "items": { - "type": "string" - }, - "type": "array", - "minItems": 1, - "title": "Queries", - "description": "List of search queries to send to the configured provider." + "title": "Llm Model Provider Override" + }, + "llm_model_version_override": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Llm Model Version Override" }, - "max_results": { + "num_chunks": { "anyOf": [ { - "type": "integer" + "type": "number" }, { "type": "null" } ], - "title": "Max Results", - "description": "Optional cap on number of results to return per query. Defaults to 10.", - "default": 10 - } - }, - "type": "object", - "required": [ - "queries" - ], - "title": "WebSearchToolRequest" - }, - "UserProjectSnapshot": { - "properties": { - "id": { - "type": "integer", - "title": "Id" - }, - "name": { - "type": "string", - "title": "Name" + "title": "Num Chunks" }, - "description": { + "system_prompt": { "anyOf": [ { "type": "string" @@ -11841,116 +11620,183 @@ "type": "null" } ], - "title": "Description" + "title": "System Prompt" }, - "created_at": { - "type": "string", - "format": "date-time", - "title": "Created At" + "replace_base_system_prompt": { + "type": "boolean", + "title": "Replace Base System Prompt", + "default": false }, - "user_id": { + "task_prompt": { "anyOf": [ { - "type": "string", - "format": "uuid" + "type": "string" }, { "type": "null" } ], - "title": "User Id" + "title": "Task Prompt" }, - "instructions": { + "datetime_aware": { + "type": "boolean", + "title": "Datetime Aware", + "default": true + }, + "search_start_date": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "Instructions" + "title": "Search Start Date" + } + }, + "type": "object", + "required": [ + "id", + "name", + "description", + "is_public", + "is_visible", + "uploaded_image_id", + "icon_name", + "user_file_ids", + "display_priority", + "is_default_persona", + "builtin_persona", + "starter_messages", + "tools", + "labels", + "owner", + "users", + "groups", + "document_sets", + "llm_model_provider_override", + "llm_model_version_override", + "num_chunks" + ], + "title": "FullPersonaSnapshot" + }, + "TokenRateLimitArgs": { + "properties": { + "enabled": { + "type": "boolean", + "title": "Enabled" }, - "chat_sessions": { + "token_budget": { + "type": "integer", + "title": "Token Budget" + }, + "period_hours": { + "type": "integer", + "title": "Period Hours" + } + }, + "type": "object", + "required": [ + "enabled", + "token_budget", + "period_hours" + ], + "title": "TokenRateLimitArgs" + }, + "IndexedSourcesResponse": { + "properties": { + "sources": { "items": { - "$ref": "#/components/schemas/ChatSessionDetails" + "$ref": "#/components/schemas/DocumentSource" }, "type": "array", - "title": "Chat Sessions" + "title": "Sources" } }, "type": "object", "required": [ - "id", - "name", - "description", - "created_at", - "user_id", - "chat_sessions" + "sources" ], - "title": "UserProjectSnapshot" + "title": "IndexedSourcesResponse" }, - "PersonaLabelSnapshot": { + "ConnectorCredentialPairIdentifier": { "properties": { - "id": { + "connector_id": { "type": "integer", - "title": "Id" + "title": "Connector Id" }, - "name": { - "type": "string", - "title": "Name" + "credential_id": { + "type": "integer", + "title": "Credential Id" } }, "type": "object", "required": [ - "id", - "name" + "connector_id", + "credential_id" ], - "title": "PersonaLabelSnapshot" + "title": "ConnectorCredentialPairIdentifier" }, - "PythonToolStart": { + "DeepResearchPlanDelta": { "properties": { "type": { "type": "string", - "const": "python_tool_start", + "const": "deep_research_plan_delta", "title": "Type", - "default": "python_tool_start" + "default": "deep_research_plan_delta" }, - "code": { + "content": { "type": "string", - "title": "Code" + "title": "Content" } }, "type": "object", "required": [ - "code" + "content" ], - "title": "PythonToolStart" + "title": "DeepResearchPlanDelta" }, - "PermissionSyncStatus": { - "type": "string", - "enum": [ - "not_started", - "in_progress", - "success", - "canceled", - "failed", - "completed_with_errors" + "OpenUrlStart": { + "properties": { + "type": { + "type": "string", + "const": "open_url_start", + "title": "Type", + "default": "open_url_start" + } + }, + "type": "object", + "title": "OpenUrlStart", + "description": "Signal that OpenURL tool has started." + }, + "VersionResponse": { + "properties": { + "backend_version": { + "type": "string", + "title": "Backend Version" + } + }, + "type": "object", + "required": [ + "backend_version" ], - "title": "PermissionSyncStatus", - "description": "Status enum for permission sync attempts" + "title": "VersionResponse" }, - "RunConnectorRequest": { + "AgentResponseStart": { "properties": { - "connector_id": { - "type": "integer", - "title": "Connector Id" + "type": { + "type": "string", + "const": "message_start", + "title": "Type", + "default": "message_start" }, - "credential_ids": { + "final_documents": { "anyOf": [ { "items": { - "type": "integer" + "$ref": "#/components/schemas/SearchDoc" }, "type": "array" }, @@ -11958,93 +11804,38 @@ "type": "null" } ], - "title": "Credential Ids" - }, - "from_beginning": { - "type": "boolean", - "title": "From Beginning", - "default": false - } - }, - "type": "object", - "required": [ - "connector_id" - ], - "title": "RunConnectorRequest" - }, - "SourceSummary": { - "properties": { - "total_connectors": { - "type": "integer", - "title": "Total Connectors" - }, - "active_connectors": { - "type": "integer", - "title": "Active Connectors" - }, - "public_connectors": { - "type": "integer", - "title": "Public Connectors" - }, - "total_docs_indexed": { - "type": "integer", - "title": "Total Docs Indexed" + "title": "Final Documents" } }, "type": "object", - "required": [ - "total_connectors", - "active_connectors", - "public_connectors", - "total_docs_indexed" - ], - "title": "SourceSummary" + "title": "AgentResponseStart" }, - "UserRoleUpdateRequest": { + "OpenUrlDocuments": { "properties": { - "user_email": { + "type": { "type": "string", - "title": "User Email" - }, - "new_role": { - "$ref": "#/components/schemas/UserRole" + "const": "open_url_documents", + "title": "Type", + "default": "open_url_documents" }, - "explicit_override": { - "type": "boolean", - "title": "Explicit Override", - "default": false + "documents": { + "items": { + "$ref": "#/components/schemas/SearchDoc" + }, + "type": "array", + "title": "Documents" } }, "type": "object", "required": [ - "user_email", - "new_role" + "documents" ], - "title": "UserRoleUpdateRequest" + "title": "OpenUrlDocuments", + "description": "Final documents after crawling completes." }, - "FullPersonaSnapshot": { + "CustomToolUpdate": { "properties": { - "id": { - "type": "integer", - "title": "Id" - }, "name": { - "type": "string", - "title": "Name" - }, - "description": { - "type": "string", - "title": "Description" - }, - "is_public": { - "type": "boolean", - "title": "Is Public" - }, - "is_visible": { - "type": "boolean", - "title": "Is Visible" - }, - "uploaded_image_id": { "anyOf": [ { "type": "string" @@ -12053,9 +11844,9 @@ "type": "null" } ], - "title": "Uploaded Image Id" + "title": "Name" }, - "icon_name": { + "description": { "anyOf": [ { "type": "string" @@ -12064,39 +11855,25 @@ "type": "null" } ], - "title": "Icon Name" - }, - "user_file_ids": { - "items": { - "type": "string" - }, - "type": "array", - "title": "User File Ids" + "title": "Description" }, - "display_priority": { + "definition": { "anyOf": [ { - "type": "integer" + "additionalProperties": true, + "type": "object" }, { "type": "null" } ], - "title": "Display Priority" - }, - "is_default_persona": { - "type": "boolean", - "title": "Is Default Persona" - }, - "builtin_persona": { - "type": "boolean", - "title": "Builtin Persona" + "title": "Definition" }, - "starter_messages": { + "custom_headers": { "anyOf": [ { "items": { - "$ref": "#/components/schemas/StarterMessage" + "$ref": "#/components/schemas/Header" }, "type": "array" }, @@ -12104,192 +11881,415 @@ "type": "null" } ], - "title": "Starter Messages" + "title": "Custom Headers" }, - "llm_relevance_filter": { - "type": "boolean", - "title": "Llm Relevance Filter", - "default": false + "passthrough_auth": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Passthrough Auth" }, - "llm_filter_extraction": { - "type": "boolean", - "title": "Llm Filter Extraction", - "default": false + "oauth_config_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Oauth Config Id" + } + }, + "type": "object", + "title": "CustomToolUpdate" + }, + "TenantSnapshot": { + "properties": { + "number_of_users": { + "type": "integer", + "title": "Number Of Users" + } + }, + "type": "object", + "required": [ + "number_of_users" + ], + "title": "TenantSnapshot" + }, + "Packet": { + "properties": { + "placement": { + "$ref": "#/components/schemas/Placement" + }, + "obj": { + "oneOf": [ + { + "$ref": "#/components/schemas/OverallStop" + }, + { + "$ref": "#/components/schemas/SectionEnd" + }, + { + "$ref": "#/components/schemas/TopLevelBranching" + }, + { + "$ref": "#/components/schemas/AgentResponseStart" + }, + { + "$ref": "#/components/schemas/AgentResponseDelta" + }, + { + "$ref": "#/components/schemas/SearchToolStart" + }, + { + "$ref": "#/components/schemas/SearchToolQueriesDelta" + }, + { + "$ref": "#/components/schemas/SearchToolDocumentsDelta" + }, + { + "$ref": "#/components/schemas/ImageGenerationToolStart" + }, + { + "$ref": "#/components/schemas/ImageGenerationToolHeartbeat" + }, + { + "$ref": "#/components/schemas/ImageGenerationFinal" + }, + { + "$ref": "#/components/schemas/OpenUrlStart" + }, + { + "$ref": "#/components/schemas/OpenUrlUrls" + }, + { + "$ref": "#/components/schemas/OpenUrlDocuments" + }, + { + "$ref": "#/components/schemas/PythonToolStart" + }, + { + "$ref": "#/components/schemas/PythonToolDelta" + }, + { + "$ref": "#/components/schemas/CustomToolStart" + }, + { + "$ref": "#/components/schemas/CustomToolDelta" + }, + { + "$ref": "#/components/schemas/ReasoningStart" + }, + { + "$ref": "#/components/schemas/ReasoningDelta" + }, + { + "$ref": "#/components/schemas/ReasoningDone" + }, + { + "$ref": "#/components/schemas/CitationInfo" + }, + { + "$ref": "#/components/schemas/DeepResearchPlanStart" + }, + { + "$ref": "#/components/schemas/DeepResearchPlanDelta" + }, + { + "$ref": "#/components/schemas/ResearchAgentStart" + }, + { + "$ref": "#/components/schemas/IntermediateReportStart" + }, + { + "$ref": "#/components/schemas/IntermediateReportDelta" + }, + { + "$ref": "#/components/schemas/IntermediateReportCitedDocs" + } + ], + "title": "Obj", + "discriminator": { + "propertyName": "type", + "mapping": { + "citation_info": "#/components/schemas/CitationInfo", + "custom_tool_delta": "#/components/schemas/CustomToolDelta", + "custom_tool_start": "#/components/schemas/CustomToolStart", + "deep_research_plan_delta": "#/components/schemas/DeepResearchPlanDelta", + "deep_research_plan_start": "#/components/schemas/DeepResearchPlanStart", + "image_generation_final": "#/components/schemas/ImageGenerationFinal", + "image_generation_heartbeat": "#/components/schemas/ImageGenerationToolHeartbeat", + "image_generation_start": "#/components/schemas/ImageGenerationToolStart", + "intermediate_report_cited_docs": "#/components/schemas/IntermediateReportCitedDocs", + "intermediate_report_delta": "#/components/schemas/IntermediateReportDelta", + "intermediate_report_start": "#/components/schemas/IntermediateReportStart", + "message_delta": "#/components/schemas/AgentResponseDelta", + "message_start": "#/components/schemas/AgentResponseStart", + "open_url_documents": "#/components/schemas/OpenUrlDocuments", + "open_url_start": "#/components/schemas/OpenUrlStart", + "open_url_urls": "#/components/schemas/OpenUrlUrls", + "python_tool_delta": "#/components/schemas/PythonToolDelta", + "python_tool_start": "#/components/schemas/PythonToolStart", + "reasoning_delta": "#/components/schemas/ReasoningDelta", + "reasoning_done": "#/components/schemas/ReasoningDone", + "reasoning_start": "#/components/schemas/ReasoningStart", + "research_agent_start": "#/components/schemas/ResearchAgentStart", + "search_tool_documents_delta": "#/components/schemas/SearchToolDocumentsDelta", + "search_tool_queries_delta": "#/components/schemas/SearchToolQueriesDelta", + "search_tool_start": "#/components/schemas/SearchToolStart", + "section_end": "#/components/schemas/SectionEnd", + "stop": "#/components/schemas/OverallStop", + "top_level_branching": "#/components/schemas/TopLevelBranching" + } + } + } + }, + "type": "object", + "required": [ + "placement", + "obj" + ], + "title": "Packet" + }, + "SavedSearchDocWithContent": { + "properties": { + "document_id": { + "type": "string", + "title": "Document Id" }, - "tools": { - "items": { - "$ref": "#/components/schemas/ToolSnapshot" - }, - "type": "array", - "title": "Tools" + "chunk_ind": { + "type": "integer", + "title": "Chunk Ind" }, - "labels": { - "items": { - "$ref": "#/components/schemas/PersonaLabelSnapshot" - }, - "type": "array", - "title": "Labels" + "semantic_identifier": { + "type": "string", + "title": "Semantic Identifier" }, - "owner": { + "link": { "anyOf": [ { - "$ref": "#/components/schemas/MinimalUserSnapshot" + "type": "string" }, { "type": "null" } - ] + ], + "title": "Link" }, - "users": { - "items": { - "$ref": "#/components/schemas/MinimalUserSnapshot" - }, - "type": "array", - "title": "Users" + "blurb": { + "type": "string", + "title": "Blurb" }, - "groups": { - "items": { - "type": "integer" - }, - "type": "array", - "title": "Groups" + "source_type": { + "$ref": "#/components/schemas/DocumentSource" }, - "document_sets": { - "items": { - "$ref": "#/components/schemas/DocumentSetSummary" + "boost": { + "type": "integer", + "title": "Boost" + }, + "hidden": { + "type": "boolean", + "title": "Hidden" + }, + "metadata": { + "additionalProperties": { + "anyOf": [ + { + "type": "string" + }, + { + "items": { + "type": "string" + }, + "type": "array" + } + ] }, - "type": "array", - "title": "Document Sets" + "type": "object", + "title": "Metadata" }, - "llm_model_provider_override": { + "score": { "anyOf": [ { - "type": "string" + "type": "number" }, { "type": "null" } ], - "title": "Llm Model Provider Override" + "title": "Score", + "default": 0.0 }, - "llm_model_version_override": { + "is_relevant": { "anyOf": [ { - "type": "string" + "type": "boolean" }, { "type": "null" } ], - "title": "Llm Model Version Override" + "title": "Is Relevant" }, - "num_chunks": { + "relevance_explanation": { "anyOf": [ { - "type": "number" + "type": "string" }, { "type": "null" } ], - "title": "Num Chunks" + "title": "Relevance Explanation" }, - "system_prompt": { + "match_highlights": { + "items": { + "type": "string" + }, + "type": "array", + "title": "Match Highlights" + }, + "updated_at": { "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } ], - "title": "System Prompt" - }, - "replace_base_system_prompt": { - "type": "boolean", - "title": "Replace Base System Prompt", - "default": false + "title": "Updated At" }, - "task_prompt": { + "primary_owners": { "anyOf": [ { - "type": "string" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Task Prompt" - }, - "datetime_aware": { - "type": "boolean", - "title": "Datetime Aware", - "default": true + "title": "Primary Owners" }, - "search_start_date": { + "secondary_owners": { "anyOf": [ { - "type": "string", - "format": "date-time" + "items": { + "type": "string" + }, + "type": "array" }, { "type": "null" } ], - "title": "Search Start Date" + "title": "Secondary Owners" + }, + "is_internet": { + "type": "boolean", + "title": "Is Internet", + "default": false + }, + "db_doc_id": { + "type": "integer", + "title": "Db Doc Id" + }, + "content": { + "type": "string", + "title": "Content" } }, "type": "object", "required": [ - "id", - "name", - "description", - "is_public", - "is_visible", - "uploaded_image_id", - "icon_name", - "user_file_ids", - "display_priority", - "is_default_persona", - "builtin_persona", - "starter_messages", - "tools", - "labels", - "owner", - "users", - "groups", - "document_sets", - "llm_model_provider_override", - "llm_model_version_override", - "num_chunks" + "document_id", + "chunk_ind", + "semantic_identifier", + "blurb", + "source_type", + "boost", + "hidden", + "metadata", + "match_highlights", + "db_doc_id", + "content" ], - "title": "FullPersonaSnapshot" + "title": "SavedSearchDocWithContent", + "description": "Used for endpoints that need to return the actual contents of the retrieved\nsection in addition to the match_highlights." }, - "AgentResponseStart": { + "TopLevelBranching": { "properties": { "type": { "type": "string", - "const": "message_start", + "const": "top_level_branching", "title": "Type", - "default": "message_start" + "default": "top_level_branching" }, - "final_documents": { - "anyOf": [ - { - "items": { - "$ref": "#/components/schemas/SearchDoc" - }, - "type": "array" - }, - { - "type": "null" - } - ], - "title": "Final Documents" + "num_parallel_branches": { + "type": "integer", + "title": "Num Parallel Branches" } }, "type": "object", - "title": "AgentResponseStart" + "required": [ + "num_parallel_branches" + ], + "title": "TopLevelBranching" + }, + "PersonaLabelSnapshot": { + "properties": { + "id": { + "type": "integer", + "title": "Id" + }, + "name": { + "type": "string", + "title": "Name" + } + }, + "type": "object", + "required": [ + "id", + "name" + ], + "title": "PersonaLabelSnapshot" + }, + "SourceSummary": { + "properties": { + "total_connectors": { + "type": "integer", + "title": "Total Connectors" + }, + "active_connectors": { + "type": "integer", + "title": "Active Connectors" + }, + "public_connectors": { + "type": "integer", + "title": "Public Connectors" + }, + "total_docs_indexed": { + "type": "integer", + "title": "Total Docs Indexed" + } + }, + "type": "object", + "required": [ + "total_connectors", + "active_connectors", + "public_connectors", + "total_docs_indexed" + ], + "title": "SourceSummary" } }, "securitySchemes": {