Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.67 KB

File metadata and controls

35 lines (26 loc) · 1.67 KB

CitedChunk

One cited chunk with the source document context for FE rendering. chunk_id is the load-bearing field — every reader can use it via /v1/chunks/bulk. The document fields are populated by save_document when it resolves each chunk through the KS API at save time; they stay None only when the chunk could not be resolved (e.g. the agent cited an id that no longer exists, or the resolve call failed). The doc-info snapshot is captured at save time; later renames or replacements of the source document do not update it.

Properties

Name Type Description Notes
chunk_id UUID
document_id UUID [optional]
document_name str Source document name as of save time. May be stale if the document was later renamed or replaced. [optional]
document_type DocumentType [optional]
document_version_id UUID [optional]
version_number int [optional]

Example

from ksapi.models.cited_chunk import CitedChunk

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

# convert the object into a dict
cited_chunk_dict = cited_chunk_instance.to_dict()
# create an instance of CitedChunk from a dict
cited_chunk_from_dict = CitedChunk.from_dict(cited_chunk_dict)

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