Implementation:Elevenlabs Elevenlabs python GetKnowledgeBaseSummaryUrlResponseModel

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

Overview

Description

GetKnowledgeBaseSummaryUrlResponseModel is a Pydantic-based data model representing a summary view of a URL-type knowledge base document. It extends the common knowledge base summary structure with a url field containing the source URL of the document. This model is used for listing URL-based knowledge base entries without including the full extracted content.

Usage

This model is returned by API endpoints that list or summarize URL-type knowledge base documents. The url field provides the original source URL from which the knowledge base content was derived. 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_url_response_model.py

Class Signature

class GetKnowledgeBaseSummaryUrlResponseModel(UncheckedBaseModel):
    ...

Import Statement

from elevenlabs.types.get_knowledge_base_summary_url_response_model import GetKnowledgeBaseSummaryUrlResponseModel

I/O Contract

Field Name	Type	Required	Default	Description
id	str	Yes	N/A	Unique identifier of the URL document
name	str	Yes	N/A	Name of the URL 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[GetKnowledgeBaseSummaryUrlResponseModelDependentAgentsItem]	Yes	N/A	Deprecated. List of agents that depend on this URL document. Use the separate endpoint to get dependent agents instead
url	str	Yes	N/A	The source URL from which the knowledge base content was derived

Usage Examples

Listing URL Documents

from elevenlabs.types.get_knowledge_base_summary_url_response_model import (
    GetKnowledgeBaseSummaryUrlResponseModel,
)

# Assuming `url_docs` is a list of GetKnowledgeBaseSummaryUrlResponseModel
for doc in url_docs:
    print(f"URL Document: {doc.name}")
    print(f"  Source URL: {doc.url}")
    print(f"  ID: {doc.id}")

Filtering by URL Domain

from urllib.parse import urlparse

# Filter documents from a specific domain
target_domain = "docs.example.com"
domain_docs = [
    doc for doc in url_docs
    if urlparse(doc.url).netloc == target_domain
]
print(f"Found {len(domain_docs)} documents from {target_domain}")

Related Pages

• Implementation:Elevenlabs_Elevenlabs_python_GetKnowledgeBaseUrlResponseModel
• Implementation:Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryFileResponseModel
• Implementation:Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryFolderResponseModel
• Implementation:Elevenlabs_Elevenlabs_python_GetKnowledgeBaseSummaryTextResponseModel
• Implementation:Elevenlabs_Elevenlabs_python_KnowledgeBaseLocator