Class SearchApi

API for searching papers.

Constructors

constructor

Methods

getPaperDetails getPaperSummary getSavedPapers getSearchResults getSuggestions

Constructors

constructor

Methods

StaticgetPaperDetails

  • getPaperDetails(user_id: string, paper_id: string, token: string): Promise<any>

  • Get paper details based on the paper ID.

    Parameters

    • user_id: string

      The ID of the user requesting the paper details.

    • paper_id: string

      The ID of the paper.

    • token: string

      The authorization token.

    Returns Promise<any>

    The details of the paper.

StaticgetPaperSummary

  • getPaperSummary(
        params: { paperIds: string[]; searchQuery: string },
    ): Promise<null | Response>

  • Get the summary of the paper.

    Parameters

    • params: { paperIds: string[]; searchQuery: string }

      An object containing the paper IDs and the search query string.

      • paperIds: string[]

        The IDs of the papers.

      • searchQuery: string

        The search query string.

    Returns Promise<null | Response>

    The summary of the paper.

StaticgetSavedPapers

  • getSavedPapers(user_id: string, token: string): Promise<never[] | { data: any }>

  • Parameters

    • user_id: string
    • token: string

    Returns Promise<never[] | { data: any }>

StaticgetSearchResults

  • getSearchResults(
        searchQuery: SearchQueryDto,
        token: string,
        page?: number,
        pageSize?: number,
    ): Promise<{ data: any }>

  • Get search results based on the search query.

    Parameters

    • searchQuery: SearchQueryDto

      The search query parameters.

    • token: string

      The authorization token.

    • page: number = 1

      The page number for pagination (default is 1).

    • pageSize: number = 10

      The number of results per page (default is 10).

    Returns Promise<{ data: any }>

    An object containing the search results and the loading time.

StaticgetSuggestions

  • getSuggestions(query: string): Promise<string[]>

  • Get suggestions based on the search query.

    Parameters

    • query: string

      The search query string.

    Returns Promise<string[]>

    An array of suggestions.

Settings

Member Visibility

On This Page

Constructors
Methods