Implementation:Elevenlabs Elevenlabs python GetKnowledgeBaseSummaryFileResponseModel

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

Overview

Description

GetKnowledgeBaseSummaryFileResponseModel is a Pydantic-based data model representing a summary view of a file-type knowledge base document. Unlike the full file response model, this summary version omits the extracted content and filename, instead providing information about dependent agents. It is designed for list views and overview screens where full file content is not needed.

Usage

This model is returned by API endpoints that list or summarize knowledge base file documents. It provides identification, metadata, access control, folder hierarchy, and dependent agent information. The dependent_agents field is deprecated and a separate endpoint should be used to retrieve dependent agents in the future.

Code Reference

Source Location

src/elevenlabs/types/get_knowledge_base_summary_file_response_model.py

Class Signature

class GetKnowledgeBaseSummaryFileResponseModel(UncheckedBaseModel):
    ...

Import Statement

from elevenlabs.types.get_knowledge_base_summary_file_response_model import GetKnowledgeBaseSummaryFileResponseModel

I/O Contract

Field Name	Type	Required	Default	Description
id	str	Yes	N/A	Unique identifier of the knowledge base file
name	str	Yes	N/A	Name of the knowledge base file
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[GetKnowledgeBaseSummaryFileResponseModelDependentAgentsItem]	Yes	N/A	Deprecated. List of agents that depend on this file. Use the separate endpoint to get dependent agents instead

Usage Examples

Iterating Over Summary File Results

from elevenlabs.types.get_knowledge_base_summary_file_response_model import (
    GetKnowledgeBaseSummaryFileResponseModel,
)

# Assuming `files` is a list of GetKnowledgeBaseSummaryFileResponseModel
for file_summary in files:
    print(f"File: {file_summary.name} (ID: {file_summary.id})")
    print(f"  Supported usages: {file_summary.supported_usages}")
    if file_summary.folder_parent_id:
        print(f"  Parent folder: {file_summary.folder_parent_id}")

Checking Folder Path

if file_summary.folder_path:
    path_str = " / ".join(segment.name for segment in file_summary.folder_path)
    print(f"  Located at: {path_str}")
else:
    print("  Located at root level")

Related Pages

• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseFileResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryFolderResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryTextResponseModel
• Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryUrlResponseModel
• Elevenlabs_Elevenlabs_python_KnowledgeBaseLocator