Skip to content

Single paper recommendation

This tool is used to return recommendations for a single paper.

SinglePaperRecInput

Bases: BaseModel

Input schema for single paper recommendation tool.

Source code in aiagents4pharma/talk2scholars/tools/s2/single_paper_rec.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class SinglePaperRecInput(BaseModel):
    """Input schema for single paper recommendation tool."""

    paper_id: str = Field(
        description="Semantic Scholar Paper ID to get recommendations for (40-character string)"
    )
    limit: int = Field(
        default=5,
        description="Maximum number of recommendations to return",
        ge=1,
        le=500,
    )
    year: Optional[str] = Field(
        default=None,
        description="Year range in format: YYYY for specific year, "
        "YYYY- for papers after year, -YYYY for papers before year, or YYYY:YYYY for range",
    )
    tool_call_id: Annotated[str, InjectedToolCallId]
    model_config = {"arbitrary_types_allowed": True}

get_single_paper_recommendations(paper_id, tool_call_id, limit=10, year=None)

Get recommendations for a single paper using its Semantic Scholar ID. No other ID types are supported.

Parameters:

Name Type Description Default
paper_id str

The Semantic Scholar Paper ID to get recommendations for.

 required
tool_call_id Annotated[str, InjectedToolCallId]

The tool call ID.

 required
limit int

The maximum number of recommendations to return. Defaults to 5.

 10
year str

Year range for papers.

 None
Supports formats like "2024-", "-2024", "2024

2025". Defaults to None.

 required

Returns:

Type Description
Command[Any]

Dict[str, Any]: The recommendations and related information.
Source code in aiagents4pharma/talk2scholars/tools/s2/single_paper_rec.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@tool(args_schema=SinglePaperRecInput, parse_docstring=True)
def get_single_paper_recommendations(
    paper_id: str,
    tool_call_id: Annotated[str, InjectedToolCallId],
    limit: int = 10,
    year: Optional[str] = None,
) -> Command[Any]:
    """
    Get recommendations for a single paper using its Semantic Scholar ID.
    No other ID types are supported.

    Args:
        paper_id (str): The Semantic Scholar Paper ID to get recommendations for.
        tool_call_id (Annotated[str, InjectedToolCallId]): The tool call ID.
        limit (int, optional): The maximum number of recommendations to return. Defaults to 5.
        year (str, optional): Year range for papers.
        Supports formats like "2024-", "-2024", "2024:2025". Defaults to None.

    Returns:
        Dict[str, Any]: The recommendations and related information.
    """
    # Create recommendation data object to organize variables
    rec_data = SinglePaperRecData(paper_id, limit, year, tool_call_id)

    # Process the recommendations
    results = rec_data.process_recommendations()

    return Command(
        update={
            "papers": results["papers"],
            "last_displayed_papers": "papers",
            "messages": [
                ToolMessage(
                    content=results["content"],
                    tool_call_id=tool_call_id,
                    artifact=results["papers"],
                )
            ],
        }
    )