Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update DocumentInfo and DocumentIndexClient #1162

Merged
merged 2 commits into from
Nov 28, 2024
Merged

docs: Update DocumentInfo and DocumentIndexClient #1162

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
093c930
docs: Update DocumentInfo and DocumentIndexClient
Michael-JB Nov 28, 2024
26d11b1
Merge branch 'main' into di-146-improve-documents-api-docs
Michael-JB Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions src/intelligence_layer/connectors/document_index/document_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,13 +190,12 @@ def from_slash_separated_str(cls, path: str) -> "DocumentPath":


class DocumentInfo(BaseModel):
"""Presents an overview of a document.
"""Information about a document.

Args:
document_path: Path to a document.
created: When this version of the document was created.
Equivalent to when it was last updated.
version: How many times the document was updated.
document_path: Path to the document. The path uniquely identifies the document among all managed documents.
created: When this version of the document was created. Equivalent to when it was last updated.
version: The version of the document, i.e., how many times the document was updated.
"""

document_path: DocumentPath
Expand Down Expand Up @@ -832,17 +831,17 @@ def documents(
collection_path: CollectionPath,
filter_query_params: Optional[DocumentFilterQueryParams] = None,
) -> Sequence[DocumentInfo]:
"""List all documents within a collection.
"""Lists the information of documents in a collection. This includes the document name, creation timestamp and version number.

Note:
Does not return each document's content.
This does not return document contents.

Args:
collection_path: Path to the collection of interest.
filter_query_params: Query parameters to filter the results.

Returns:
Overview of all documents within the collection.
Information of documents in the collection.
"""
if filter_query_params is None:
filter_query_params = DocumentFilterQueryParams(
Expand Down