Skip to main content
Vrin client methods return plain dicts by default. These dataclasses provide optional typed wrappers with convenience properties. All have a from_dict() classmethod.

Document

Represents a document to be processed and indexed.

Fields

QueryResult

Represents a single search result from the knowledge base.

Fields

Properties

  • title — Document title (from metadata)
  • tags — Document tags (from metadata)
  • source — Source identifier (from metadata)

JobStatus

Represents the status of an async processing job (insertion or upload).

Fields

Properties

  • is_completed — True when status is "completed"
  • is_failed — True when status is "failed"
  • is_processing — True when status is any active state
  • completion_time — datetime from completed_at
  • creation_time — datetime from timestamp

InsertResult

Structured response from an insert operation.

Fields

UploadResult

Structured response from a file upload.

Fields

UserLimits

User plan information and usage limits.

Fields

Conversation

Summary of a conversation session.

Fields