Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 2.51 KB

File metadata and controls

49 lines (40 loc) · 2.51 KB

DocumentResponse

Document response model.

Properties

Name Type Description Notes
part_type str Path part type
id UUID Document ID
path_part_id UUID PathPart ID
name str Document name
parent_path_part_id UUID Parent PathPart ID
document_type DocumentType
document_origin DocumentOrigin
active_version_id UUID Active version ID
active_version DocumentVersionResponse
materialized_path str Full materialized path from root
system_managed bool Whether this document is system-managed
approval_state PathPartApprovalState
exclude_from_qdrant bool Direct exclusion flag on this document's path part only. The effective exclusion also applies when any ancestor folder has the flag set — fetch the ancestry to determine effective state.
tenant_id UUID Tenant ID
owner UserInfo
created_at datetime Creation timestamp
updated_at datetime Last update timestamp
tags List[TagResponse] Tags attached to this document [optional]
can_write bool Whether the current caller has write access to this document. Only populated by endpoints that compute it (e.g. folder contents). [optional]
checkout DocumentCheckoutResponse Active write-lock state. Null when no checkout is held. Populated on detail endpoints (GET /v1/documents/{id}). Any tenant member with read access may observe this state. [optional]

Example

from ksapi.models.document_response import DocumentResponse

# TODO update the JSON string below
json = "{}"
# create an instance of DocumentResponse from a JSON string
document_response_instance = DocumentResponse.from_json(json)
# print the JSON string representation of the object
print(DocumentResponse.to_json())

# convert the object into a dict
document_response_dict = document_response_instance.to_dict()
# create an instance of DocumentResponse from a dict
document_response_from_dict = DocumentResponse.from_dict(document_response_dict)

[Back to Model list] [Back to API list] [Back to README]