Skip to main content

概述

文档模块用于获取单个文档的详细内容和总结。

get()

获取文档详情。
doc = client.docs.get("doc_abc123")
print(doc["title"])
print(doc["content"])
doc_id
string
required
文档 ID
返回值
dict
文档详情,包含完整内容

summary()

获取文档总结。
summary = client.docs.summary("doc_abc123")
print(summary["summary"])
print(summary["key_points"])
doc_id
string
required
文档 ID
返回值
dict
文档总结,包含摘要和关键要点

list_by_symbol()

获取指定股票的相关文档列表。
docs = client.docs.list_by_symbol(
    symbol="US:AAPL",
    categories=["news", "filings"],
    num=20
)
symbol
string
required
股票代码,格式:市场:代码
categories
list[str]
文档类别筛选
num
int
default:"10"
返回数量
start_date
str
开始日期
end_date
str
结束日期

list_by_label()

获取指定标签的文档列表。
docs = client.docs.list_by_label(
    label="财报",
    num=20
)
label
string
required
文档标签
num
int
default:"10"
返回数量
start_date
str
开始日期
end_date
str
结束日期

返回数据结构

文档详情

{
    "doc_id": "abc123",
    "title": "Tesla Q4 2024 Earnings Call Transcript",
    "content": "完整文档内容...",
    "category": "transcripts",
    "published_at": 1704067200000,
    "channel_name": "Tesla Inc.",
    "companies": [
        {
            "name": "Tesla",
            "stocks": [{"symbol": "US:TSLA"}]
        }
    ],
    "url": "https://...",
    "word_count": 15000
}

文档总结

{
    "doc_id": "abc123",
    "summary": "Tesla 在 Q4 财报电话会议中报告了...",
    "key_points": [
        "交付量创历史新高",
        "毛利率环比提升",
        "Cybertruck 产能爬坡顺利"
    ],
    "sentiment": "positive"
}

使用场景

# 搜索文档后获取详情
results = client.search.all("Tesla earnings", num=5)
for result in results:
    doc_id = result["doc_id"]
    
    # 获取完整内容
    detail = client.docs.get(doc_id)
    print(f"标题: {detail['title']}")
    print(f"字数: {detail.get('word_count', 'N/A')}")
    
    # 获取 AI 总结
    summary = client.docs.summary(doc_id)
    print(f"摘要: {summary['summary'][:200]}...")
    print()