dify_user_client

Core Documentation

  • Clients
    • Basic Usage
    • Base Client
      • DifyBaseClient
        • DifyBaseClient.__init__()
        • DifyBaseClient._login()
        • DifyBaseClient._send_user_request()
    • User Client
      • DifyUserClient
        • DifyUserClient.update_timezone()
        • DifyUserClient.update_system_model()
        • DifyUserClient.apps
        • DifyUserClient.get_app()
        • DifyUserClient.tool_providers
        • DifyUserClient.get_tool_provider()
        • DifyUserClient.tools
        • DifyUserClient.get_tool()
        • DifyUserClient.model_providers
        • DifyUserClient.get_model_provider()
        • DifyUserClient.create_app()
        • DifyUserClient.create_app_from_yaml()
        • DifyUserClient.delete_app()
    • Combined Client
      • DifyClient
        • DifyClient.__init__()
    • Data Models
      • Credentials
  • Applications
    • App Types
    • Base App Class
      • App.create()
    • Chat Management
      • Chat
        • Chat.id
        • Chat.app
        • Chat.client
        • Chat.info
        • Chat.messages
    • Workflow Applications
      • WorkflowApp.get_logs()
      • WorkflowApp.iter_logs()
      • WorkflowApp.get_node_executions()
    • Agent Applications
      • AgentApp.get_logs()
      • AgentApp.iter_logs()
      • AgentApp.get_messages()
    • Chat Applications
      • ChatApp.get_logs()
      • ChatApp.iter_logs()
    • Completion Applications
    • Advanced Chat Applications
    • Type Safety
  • Knowledge
    • Dataset Management
      • KnowledgeDataset
        • KnowledgeDataset.__init__()
        • KnowledgeDataset.documents
        • KnowledgeDataset.get_document()
        • KnowledgeDataset.create_document_by_text()
        • KnowledgeDataset.create_document_by_file()
        • KnowledgeDataset.update_document_from_file()
        • KnowledgeDataset.delete_document()
        • KnowledgeDataset.delete()
    • Document
      • KnowledgeDocument
        • KnowledgeDocument.__init__()
        • KnowledgeDocument.segments
        • KnowledgeDocument.create_segments()
        • KnowledgeDocument.get_segment()
        • KnowledgeDocument.delete_segment()
        • KnowledgeDocument.indexing_status
        • KnowledgeDocument.wait_for_indexing()
        • KnowledgeDocument.data
        • KnowledgeDocument.delete()
    • Segment
      • KnowledgeSegment
        • KnowledgeSegment.__init__()
        • KnowledgeSegment.update()
        • KnowledgeSegment.delete()
    • Data Models
      • DatasetPermissionEnum
        • DatasetPermissionEnum.ONLY_ME
        • DatasetPermissionEnum.ALL_TEAM
        • DatasetPermissionEnum.PARTIAL_TEAM
      • DocumentIndexingStatuses
        • DocumentIndexingStatuses.WAITING
        • DocumentIndexingStatuses.PARSING
        • DocumentIndexingStatuses.CLEANING
        • DocumentIndexingStatuses.SPLITTING
        • DocumentIndexingStatuses.COMPLETED
        • DocumentIndexingStatuses.INDEXING
        • DocumentIndexingStatuses.ERROR
        • DocumentIndexingStatuses.PAUSED
      • KnowledgeToken
      • KnowledgeSegmentSettings
      • KnowledgeDocumentSegmentSettings
      • KnowledgeDocumentData
    • Hit
    • Dataset Settings
      • Basic Usage
      • Settings Configuration
        • Retrieval Methods
        • Permissions
      • Settings Properties
  • Tools
    • Tool Providers
      • ToolProvider
        • ToolProvider.create()
        • ToolProvider.tool_info
      • WorkflowToolProvider
        • WorkflowToolProvider.info
        • WorkflowToolProvider.tools
      • BuiltinToolProvider
        • BuiltinToolProvider.tools
        • BuiltinToolProvider.tools_info
        • BuiltinToolProvider.update_credentials()
    • Tools
      • Tool
        • Tool.create()
        • Tool.info
      • WorkflowTool
        • WorkflowTool.workflow_app_id
        • WorkflowTool.info
      • BuiltinTool
        • BuiltinTool.info
    • Data Models
      • ToolInfo
      • ToolParameter
      • WorkflowToolProviderInfo
  • Logging and Chat History
    • Quick Examples
    • Chat Session
      • Chat
        • Chat.__init__()
        • Chat.messages
    • Workflow Logging
      • WorkflowLogEntry
        • WorkflowLogEntry.id
        • WorkflowLogEntry.workflow_run
        • WorkflowLogEntry.created_from
        • WorkflowLogEntry.created_by_role
        • WorkflowLogEntry.created_by_account
        • WorkflowLogEntry.created_by_end_user
        • WorkflowLogEntry.created_at
      • WorkflowRun
        • WorkflowRun.id
        • WorkflowRun.version
        • WorkflowRun.status
        • WorkflowRun.error
        • WorkflowRun.elapsed_time
        • WorkflowRun.total_tokens
        • WorkflowRun.total_steps
        • WorkflowRun.created_at
        • WorkflowRun.finished_at
        • WorkflowRun.exceptions_count
    • Workflow Node Executions
      • WorkflowNodeExecution
        • WorkflowNodeExecution.id
        • WorkflowNodeExecution.node_type
        • WorkflowNodeExecution.title
        • WorkflowNodeExecution.status
        • WorkflowNodeExecution.error
        • WorkflowNodeExecution.elapsed_time
        • WorkflowNodeExecution.inputs
        • WorkflowNodeExecution.outputs
        • WorkflowNodeExecution.process_data
        • WorkflowNodeExecution.index
        • WorkflowNodeExecution.predecessor_node_id
        • WorkflowNodeExecution.node_id
        • WorkflowNodeExecution.execution_metadata
        • WorkflowNodeExecution.extras
        • WorkflowNodeExecution.created_at
        • WorkflowNodeExecution.created_by_role
        • WorkflowNodeExecution.created_by_account
        • WorkflowNodeExecution.created_by_end_user
        • WorkflowNodeExecution.finished_at
      • WorkflowNodeExecutionMetadata
        • WorkflowNodeExecutionMetadata.parallel_id
        • WorkflowNodeExecutionMetadata.parallel_start_node_id
        • WorkflowNodeExecutionMetadata.tool_info
        • WorkflowNodeExecutionMetadata.total_tokens
        • WorkflowNodeExecutionMetadata.total_price
        • WorkflowNodeExecutionMetadata.currency
      • WorkflowNodeExecutions
        • WorkflowNodeExecutions.data
    • Agent and Chat Logging
      • AgentConversation
        • AgentConversation.id
        • AgentConversation.status
        • AgentConversation.from_source
        • AgentConversation.from_end_user_id
        • AgentConversation.from_end_user_session_id
        • AgentConversation.from_account_id
        • AgentConversation.from_account_name
        • AgentConversation.name
        • AgentConversation.summary
        • AgentConversation.read_at
        • AgentConversation.created_at
        • AgentConversation.updated_at
        • AgentConversation.annotated
        • AgentConversation.agent_model_config
        • AgentConversation.message_count
        • AgentConversation.user_feedback_stats
        • AgentConversation.admin_feedback_stats
        • AgentConversation.status_count
    • Chat Messages
      • ChatMessage
        • ChatMessage.id
        • ChatMessage.conversation_id
        • ChatMessage.inputs
        • ChatMessage.query
        • ChatMessage.answer
        • ChatMessage.message
        • ChatMessage.feedback
        • ChatMessage.created_at
        • ChatMessage.created_by_role
        • ChatMessage.created_by_account
        • ChatMessage.created_by_end_user
        • ChatMessage.from_source
        • ChatMessage.from_end_user_id
        • ChatMessage.from_end_user_session_id
        • ChatMessage.from_account_id
        • ChatMessage.from_account_name
      • PaginatedChatMessages
        • PaginatedChatMessages.data
        • PaginatedChatMessages.page
        • PaginatedChatMessages.limit
        • PaginatedChatMessages.total
        • PaginatedChatMessages.has_more
      • PaginatedAgentLogs
        • PaginatedAgentLogs.data
        • PaginatedAgentLogs.page
        • PaginatedAgentLogs.limit
        • PaginatedAgentLogs.total
        • PaginatedAgentLogs.has_more

Advanced Features

  • Data Models
    • App Token
      • AppToken
    • Workflow Models
      • WorkflowDraft
    • Graph Models
      • Graph
      • GraphNode
      • GraphEdge
      • GraphEdgeData
      • GraphNodeData
      • Viewport
    • Base Models
      • BaseModel
        • BaseModel.id
        • BaseModel.created_at
        • BaseModel.updated_at
        • BaseModel.to_dict()
    • Pagination Models
      • PaginatedResponse
        • PaginatedResponse.page
        • PaginatedResponse.limit
        • PaginatedResponse.total
        • PaginatedResponse.has_more
        • PaginatedResponse.data
        • PaginatedResponse.__iter__()
        • PaginatedResponse.__len__()
    • Logging Models
      • AgentConversation
        • AgentConversation.id
        • AgentConversation.status
        • AgentConversation.from_source
        • AgentConversation.from_end_user_id
        • AgentConversation.from_end_user_session_id
        • AgentConversation.from_account_id
        • AgentConversation.from_account_name
        • AgentConversation.name
        • AgentConversation.summary
        • AgentConversation.read_at
        • AgentConversation.created_at
        • AgentConversation.updated_at
        • AgentConversation.annotated
        • AgentConversation.agent_model_config
        • AgentConversation.message_count
        • AgentConversation.user_feedback_stats
        • AgentConversation.admin_feedback_stats
        • AgentConversation.status_count
      • ChatMessage
        • ChatMessage.id
        • ChatMessage.conversation_id
        • ChatMessage.inputs
        • ChatMessage.query
        • ChatMessage.answer
        • ChatMessage.message
        • ChatMessage.feedback
        • ChatMessage.created_at
        • ChatMessage.created_by_role
        • ChatMessage.created_by_account
        • ChatMessage.created_by_end_user
        • ChatMessage.from_source
        • ChatMessage.from_end_user_id
        • ChatMessage.from_end_user_session_id
        • ChatMessage.from_account_id
        • ChatMessage.from_account_name
      • PaginatedChatMessages
        • PaginatedChatMessages.data
        • PaginatedChatMessages.page
        • PaginatedChatMessages.limit
        • PaginatedChatMessages.total
        • PaginatedChatMessages.has_more
      • PaginatedAgentLogs
        • PaginatedAgentLogs.data
        • PaginatedAgentLogs.page
        • PaginatedAgentLogs.limit
        • PaginatedAgentLogs.total
        • PaginatedAgentLogs.has_more
      • PaginatedWorkflowLogs
        • PaginatedWorkflowLogs.data
        • PaginatedWorkflowLogs.page
        • PaginatedWorkflowLogs.limit
        • PaginatedWorkflowLogs.total
        • PaginatedWorkflowLogs.has_more
    • Workflow Execution Models
      • WorkflowNodeExecutionMetadata
        • WorkflowNodeExecutionMetadata.parallel_id
        • WorkflowNodeExecutionMetadata.parallel_start_node_id
        • WorkflowNodeExecutionMetadata.tool_info
        • WorkflowNodeExecutionMetadata.total_tokens
        • WorkflowNodeExecutionMetadata.total_price
        • WorkflowNodeExecutionMetadata.currency
      • WorkflowNodeExecutions
        • WorkflowNodeExecutions.data
  • Language Models
    • Model Provider Management
      • ModelProvider
        • ModelProvider.__init__()
        • ModelProvider.info
        • ModelProvider.update_credentials()
        • ModelProvider.validate_credentials()
        • ModelProvider.delete()
    • Data Models
      • SupportedModelType
        • SupportedModelType.text_embedding
        • SupportedModelType.speech2text
        • SupportedModelType.moderation
        • SupportedModelType.tts
        • SupportedModelType.llm
        • SupportedModelType.rerank
      • ModelProviderInfo
      • ModelProviderHelp

Development

  • Contributing
    • Development Setup
    • Code Style
    • Testing
    • Documentation
  • Changelog
    • [0.0.5] - 2025-04-17
      • Added
      • Changed
      • Deprecated
      • Removed
      • Fixed
      • Security
dify_user_client
  • Search

© Copyright 2025, Ivan Pikulin.

Built with Sphinx using a theme provided by Read the Docs.