Class NeuroClient

Hierarchy (View Summary)

Constructors

constructor

Properties

apiToken? fetch fetchOpts headers host hostSchemaRe hostTH paths schema schemaTH sessionIdCookie? sessions userAgent

Methods

createSession getOpts getSession getSharingContent getSharingUrl getTHSummarizeSec request requestJSON requestTH summarizeArticle summarizeImpl summarizeText summarizeVideo

Constructors

constructor

Properties

OptionalapiToken

apiToken?: string

Optional field.

Allow use official "API" (only allow get summarized link to 300.ya.ru)

fetch

fetch: FetchFunction

fetchOpts

fetchOpts: Record<string, unknown>

headers

headers: Record<string, string>

host

host: string

hostSchemaRe

hostSchemaRe: RegExp

hostTH

hostTH: string

paths

paths: {
    sharing: string;
    sharingUrl: string;
    summarizeVideo: string;
    summarizeWithCookie: string;
    summarizeWithSec: string;
} = ...

/api/neuro/generation - requires sec headers /api/generation - requires session cookie /api/sharing-url - requires API Token

schema

schema: URLSchema

schemaTH

schemaTH: string

OptionalsessionIdCookie

sessionIdCookie?: string

Optional field. Allow use all summarizeXX methods except summarizeVideo with outdated YaHMAC key. To enable it login to any ya website and set your Session_id cookie value

Lifetime: ~6 months

sessions

sessions: Partial

userAgent

userAgent: string

Methods

createSession

  • createSession(
        module: SessionModule,
    ): Promise<{ expires: number; secretKey: string; uuid: string }>

    Parameters

    Returns Promise<{ expires: number; secretKey: string; uuid: string }>

getOpts

  • getOpts(
        body: unknown,
        headers?: Record<string, string>,
        method?: string,
    ): { body: unknown; headers: { [x: string]: string }; method: string }

    Parameters

    • body: unknown
    • Optionalheaders: Record<string, string>
    • Optionalmethod: string

    Returns { body: unknown; headers: { [x: string]: string }; method: string }

getSession

getSharingContent

getSharingUrl

getTHSummarizeSec

  • getTHSummarizeSec(): { headers: Record<string, string>; path: string }

    Returns { headers: Record<string, string>; path: string }

request

  • request<T = ArrayBuffer>(
        path: string,
        body: Uint8Array,
        headers?: Record<string, string>,
        method?: string,
    ): Promise<ClientResponse<T>>

    Type Parameters

    • T = ArrayBuffer

    Parameters

    • path: string
    • body: Uint8Array
    • Optionalheaders: Record<string, string>
    • Optionalmethod: string

    Returns Promise<ClientResponse<T>>

requestJSON

  • requestJSON<T = unknown>(
        path: string,
        body?: unknown,
        headers?: Record<string, string>,
        method?: string,
    ): Promise<ClientResponse<T>>

    Type Parameters

    • T = unknown

    Parameters

    • path: string
    • Optionalbody: unknown
    • Optionalheaders: Record<string, string>
    • Optionalmethod: string

    Returns Promise<ClientResponse<T>>

requestTH

  • requestTH<T = unknown>(
        path: string,
        body: any,
        headers?: Record<string, string>,
    ): Promise<ClientResponse<T>>

    The standard method for requesting the TH Backend API

    Type Parameters

    • T = unknown

    Parameters

    • path: string
    • body: any
    • headers: Record<string, string> = {}

    Returns Promise<ClientResponse<T>>

summarizeArticle

ProtectedsummarizeImpl

summarizeText

summarizeVideo

Settings

Member Visibility

On This Page

Constructors
Properties
Methods