Response for chunk neighbor traversal. Returns items in the same SectionOrChunkItem discriminated union format used by the document version contents endpoint.
| Name | Type | Description | Notes |
|---|---|---|---|
| items | List[SectionContentItemOrChunkContentItem] | Ordered siblings: preceding → anchor → succeeding | |
| anchor_index | int | Index of the anchor chunk in items | |
| anchor_offset | int | 0-based position of the anchor in the traversal scope under the active content_type filter. With within_section=true the scope is the parent's filtered sibling chain; with within_section=false it is the entire document version in DFS order. | |
| total | int | Total items in the traversal scope under the active filter. Within-section: filtered direct children of the anchor's parent. Cross-section: filtered DFS items in the document version. | |
| document_version_id | UUID | ID of the enclosing document version. Populated only when within_section=false (where it is required to scope the DFS traversal); null when within_section=true. | [optional] |
from ksapi.models.chunk_neighbors_response import ChunkNeighborsResponse
# TODO update the JSON string below
json = "{}"
# create an instance of ChunkNeighborsResponse from a JSON string
chunk_neighbors_response_instance = ChunkNeighborsResponse.from_json(json)
# print the JSON string representation of the object
print(ChunkNeighborsResponse.to_json())
# convert the object into a dict
chunk_neighbors_response_dict = chunk_neighbors_response_instance.to_dict()
# create an instance of ChunkNeighborsResponse from a dict
chunk_neighbors_response_from_dict = ChunkNeighborsResponse.from_dict(chunk_neighbors_response_dict)