Models

Bases: BaseEntity

Agent model.

avatar: str | None

canvas_category: str | None

canvas_type: str | None

create_date: str | None

create_time: int | None

description: str | None

dsl: dict[str, Any] | None

id: str | None

title: str | None

update_date: str | None

update_time: int | None

user_id: str | None

Bases: BaseEntity

Result returned by agent completion API.

answer: str | None = None

create_time: int | None = None

classmethod from_raw(raw: dict) → Self[source]

Create an instance from raw dictionary, populating export fields.

Parameters:: raw – Original dictionary data from API.
Returns:: Instance of cls with fields set and _raw saved.

id: str | None = None

steps: list[AgentStep] | None = None

usage: dict[str, Any] | None = None

class ragflow_async_sdk.models.ChatAssistant(id: 'str', name: 'str', avatar: 'Optional[str]' = None, datasets: 'Optional[list[str]]' = None, llm: 'Optional[LLMConfig]' = None, prompt: 'Optional[PromptConfig]' = None, create_date: 'Optional[str]' = None, create_time: 'Optional[int]' = None, update_date: 'Optional[str]' = None, update_time: 'Optional[int]' = None, status: 'Optional[str]' = None, top_k: 'Optional[int]' = 1024, language: 'Optional[str]' = 'English')[source]

Bases: BaseEntity

avatar: str | None

create_date: str | None

create_time: int | None

datasets: list[str] | None

classmethod from_raw(raw: dict) → Self[source]

Create an instance from raw dictionary, populating export fields.

Parameters:: raw – Original dictionary data from API.
Returns:: Instance of cls with fields set and _raw saved.

id: str

language: str | None

llm: LLMConfig | None

name: str

prompt: PromptConfig | None

status: str | None

top_k: int | None

update_date: str | None

update_time: int | None

class ragflow_async_sdk.models.ChatCompletionResult(answer: str | None = None, session_id: str | None = None, messages: list[ChatCompletionMessage] | None = None, reference: list[ChatCompletionReference] | None = None)[source]

Bases: BaseEntity

Result of a non-streaming chat completion.

answer: str | None = None

classmethod from_raw(raw: dict[str, Any]) → Self[source]

Create an instance from raw dictionary, populating export fields.

Parameters:: raw – Original dictionary data from API.
Returns:: Instance of cls with fields set and _raw saved.

messages: list[ChatCompletionMessage] | None = None

reference: list[ChatCompletionReference] | None = None

session_id: str | None = None

class ragflow_async_sdk.models.Chunk(id: 'str', dataset_id: 'str', document_id: 'str', content: 'str', available: 'Optional[bool]' = True, docnm_kwd: 'Optional[str]' = None, image_id: 'Optional[str]' = None, create_time: 'Optional[str]' = None, create_timestamp: 'Optional[float]' = None, important_keywords: 'Optional[list[str]]' = None, questions: 'Optional[list[str]]' = None, positions: 'Optional[list[str]]' = None)[source]

Bases: BaseEntity

available: bool | None

content: str

create_time: str | None

create_timestamp: float | None

dataset_id: str

docnm_kwd: str | None

document_id: str

id: str

image_id: str | None

important_keywords: list[str] | None

positions: list[str] | None

questions: list[str] | None

Bases: BaseEntity

Dataset model for RAGFlow.

avatar: str | None

chunk_count: int | None

chunk_method: str | None

create_date: str | None

create_time: int | None

description: str | None

document_count: int | None

embedding_model: str | None

id: str

language: str | None

name: str

permission: str

status: str

token_num: int | None

update_date: str | None

update_time: int | None

class ragflow_async_sdk.models.Document(id: 'str', dataset_id: 'str', name: 'str', type: 'str', location: 'str', status: 'Optional[str]' = None, run: 'Optional[str]' = None, suffix: 'Optional[str]' = None, size: 'Optional[int]' = None, created_by: 'Optional[str]' = None, create_date: 'Optional[str]' = None, create_time: 'Optional[int]' = None, update_date: 'Optional[str]' = None, update_time: 'Optional[int]' = None, chunk_method: 'Optional[ChunkMethod | str]' = None, chunk_count: 'Optional[int]' = None, token_count: 'Optional[int]' = None, parser_config: 'Optional[dict[str, Any]]' = None, meta_fields: 'Optional[dict[str, Any]]' = None, pipeline_id: 'Optional[str]' = None, thumbnail: 'Optional[str]' = None, progress: 'Optional[float]' = None, progress_msg: 'Optional[str]' = None, process_begin_at: 'Optional[str]' = None, process_duration: 'Optional[float]' = None, enabled: 'Optional[int]' = None)[source]

Bases: BaseEntity

chunk_count: int | None

chunk_method: ChunkMethod | str | None

create_date: str | None

create_time: int | None

created_by: str | None

dataset_id: str

enabled: int | None

id: str

location: str

meta_fields: dict[str, Any] | None

name: str

parser_config: dict[str, Any] | None

pipeline_id: str | None

process_begin_at: str | None

process_duration: float | None

progress: float | None

progress_msg: str | None

run: str | None

size: int | None

status: str | None

suffix: str | None

thumbnail: str | None

token_count: int | None

type: str

update_date: str | None

update_time: int | None

class ragflow_async_sdk.models.File(id: str, name: str, type: str, size: int | None = None, parent_id: str | None = None, location: str | None = None, create_time: int | None = None)[source]

Bases: BaseEntity

create_time: int | None

id: str

location: str | None

name: str

parent_id: str | None

size: int | None

type: str

class ragflow_async_sdk.models.Folder(id: str, name: str, type: str, parent_id: str | None = None)[source]

Bases: BaseEntity

id: str

name: str

parent_id: str | None

type: str

Bases: BaseEntity

System health status.

db: str | None = None

doc_engine: str | None = None

redis: str | None = None

status: str | None = None

storage: str | None = None

class ragflow_async_sdk.models.TaskStatus(id: 'Optional[str]' = None, task_type: 'Optional[str]' = None, progress: 'Optional[float]' = None, progress_msg: 'Optional[str]' = None, begin_at: 'Optional[str]' = None, create_date: 'Optional[str]' = None, create_time: 'Optional[int]' = None, update_date: 'Optional[str]' = None, update_time: 'Optional[int]' = None, process_duration: 'Optional[float]' = None, retry_count: 'Optional[int]' = None, from_page: 'Optional[int]' = None, to_page: 'Optional[int]' = None, chunk_ids: 'Optional[str]' = None, digest: 'Optional[str]' = None, doc_id: 'Optional[str]' = None)[source]

Bases: BaseEntity

begin_at: str | None

chunk_ids: str | None

create_date: str | None

create_time: int | None

digest: str | None

doc_id: str | None

from_page: int | None

id: str | None

process_duration: float | None

progress: float | None

progress_msg: str | None

retry_count: int | None

task_type: str | None

to_page: int | None

update_date: str | None

update_time: int | None