Implementation:Elevenlabs Elevenlabs python GetKnowledgeBaseSummaryTextResponseModel

Attribute	Value
Page Type	Implementation
Package	elevenlabs
Module	elevenlabs.types.get_knowledge_base_summary_text_response_model
Class	GetKnowledgeBaseSummaryTextResponseModel
Base Class	UncheckedBaseModel
Source File	src/elevenlabs/types/get_knowledge_base_summary_text_response_model.py
Auto-Generated	Yes (Fern API Definition)

Overview

Description

GetKnowledgeBaseSummaryTextResponseModel is a Pydantic-based data model representing a summary view of a text-type knowledge base document. This model shares the common knowledge base summary structure (identification, metadata, access control, folder hierarchy) and includes information about dependent agents. It is designed for listing text-type documents without including the full text content.

Usage

This model is returned by API endpoints that list or summarize text-type knowledge base documents. It provides enough metadata to display text entries in a summary list without fetching the full document content. The dependent_agents field is deprecated and a separate endpoint should be used in the future.

Code Reference

Source Location

src/elevenlabs/types/get_knowledge_base_summary_text_response_model.py

Class Signature

class GetKnowledgeBaseSummaryTextResponseModel(UncheckedBaseModel):
    ...

Import Statement

from elevenlabs.types.get_knowledge_base_summary_text_response_model import GetKnowledgeBaseSummaryTextResponseModel

I/O Contract

Field Name	Type	Required	Default	Description
id	str	Yes	N/A	Unique identifier of the text document
name	str	Yes	N/A	Name of the text document
metadata	KnowledgeBaseDocumentMetadataResponseModel	Yes	N/A	Document metadata including status and processing details
supported_usages	List[DocumentUsageModeEnum]	Yes	N/A	List of supported usage modes for this document
access_info	ResourceAccessInfo	Yes	N/A	Access control information for the resource
folder_parent_id	Optional[str]	No	None	The ID of the parent folder, or null if the document is at the root level
folder_path	Optional[List[KnowledgeBaseFolderPathSegmentSummaryResponseModel]]	No	None	The folder path segments leading to this entity, from root to parent folder
dependent_agents	List[GetKnowledgeBaseSummaryTextResponseModelDependentAgentsItem]	Yes	N/A	Deprecated. List of agents that depend on this text document. Use the separate endpoint to get dependent agents instead

Usage Examples

Listing Text Documents

from elevenlabs.types.get_knowledge_base_summary_text_response_model import (
    GetKnowledgeBaseSummaryTextResponseModel,
)

# Assuming `text_docs` is a list of GetKnowledgeBaseSummaryTextResponseModel
for doc in text_docs:
    print(f"Text Document: {doc.name} (ID: {doc.id})")
    print(f"  Supported usages: {doc.supported_usages}")

Filtering by Folder Location

# Find all text documents at root level
root_docs = [doc for doc in text_docs if doc.folder_parent_id is None]

# Find text documents in a specific folder
target_folder_id = "folder_xyz"
folder_docs = [doc for doc in text_docs if doc.folder_parent_id == target_folder_id]

Related Pages

• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryFileResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryFolderResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryUrlResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseFileResponseModel
• Elevenlabs_Elevenlabs_python_KnowledgeBaseLocator