Class NeuroClient

Hierarchy (View Summary)

MinimalClient
- NeuroClient
  - NeuroWorkerClient

Constructors

constructor

new NeuroClient(__namedParameters?: NeuroClientOpts): NeuroClient
Parameters
- __namedParameters: NeuroClientOpts = {}
Returns NeuroClient
Overrides MinimalClient.constructor
- Defined in src/client.ts:56

Properties

`Optional`apiToken

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

`Optional`sessionIdCookie

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
- module: SessionModule
Returns Promise<{ expires: number; secretKey: string; uuid: string }>
Inherited from MinimalClient.createSession
- Defined in node_modules/@vot.js/core/dist/client.d.ts:31

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 }
Inherited from MinimalClient.getOpts
- Defined in node_modules/@vot.js/core/dist/client.d.ts:23

getSession

getSession(module: SessionModule): Promise<ClientSession>
Parameters
- module: SessionModule
Returns Promise<ClientSession>
Inherited from MinimalClient.getSession
- Defined in node_modules/@vot.js/core/dist/client.d.ts:30

getSharingContent

getSharingContent<
    T extends
        MinimalSummarizeResponse<any> =
        | ArticleSummarizeResponse
        | TextSummarizeResponse
        | SharingVideoSummarizeResponse,
>(
    __namedParameters: GetSharingContentOpts,
): Promise<T>
Type Parameters
- T extends MinimalSummarizeResponse<any> = ArticleSummarizeResponse | TextSummarizeResponse | SharingVideoSummarizeResponse
Parameters
- __namedParameters: GetSharingContentOpts
Returns Promise<T>
- Defined in src/client.ts:170

getSharingUrl

getSharingUrl(
__namedParameters: GetSharingUrlOpts,
): Promise<GetSharingUrlSuccess>
Parameters
- __namedParameters: GetSharingUrlOpts
Returns Promise<GetSharingUrlSuccess>
- Defined in src/client.ts:144

getTHSummarizeSec

getTHSummarizeSec(): { headers: Record<string, string>; path: string }
Returns { headers: Record<string, string>; path: string }
- Defined in src/client.ts:216

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>>
Inherited from MinimalClient.request
- Defined in node_modules/@vot.js/core/dist/client.d.ts:21

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>>
Inherited from MinimalClient.requestJSON
- Defined in node_modules/@vot.js/core/dist/client.d.ts:22

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>>
- Defined in src/client.ts:82

summarizeArticle

summarizeArticle(
__namedParameters: ArticleSummarizeOpts,
): Promise<ArticleSummarizeResponse>
Parameters
- __namedParameters: ArticleSummarizeOpts
Returns Promise<ArticleSummarizeResponse>
- Defined in src/client.ts:275

`Protected`summarizeImpl

summarizeImpl<T extends SummarizeResponse<"article" | "text" | "file">>(
    type: "article" | "text" | "file",
    body: Record<string, unknown>,
    headers: RequestHeaders,
): Promise<T>
Type Parameters
- T extends SummarizeResponse<"article" | "text" | "file">
Parameters
- type: "article" | "text" | "file"
- body: Record<string, unknown>
- headers: RequestHeaders
Returns Promise<T>
- Defined in src/client.ts:243

summarizeText

summarizeText(
__namedParameters: TextSummarizeOpts,
): Promise<TextSummarizeResponse>
Parameters
- __namedParameters: TextSummarizeOpts
Returns Promise<TextSummarizeResponse>
- Defined in src/client.ts:291

summarizeVideo

summarizeVideo(
__namedParameters: VideoSummarizeOpts,
): Promise<VideoSummarizeResponse>
Parameters
- __namedParameters: VideoSummarizeOpts
Returns Promise<VideoSummarizeResponse>
- Defined in src/client.ts:111

Class NeuroClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NeuroClient

Properties

OptionalapiToken

fetch

fetchOpts

headers

host

hostSchemaRe

hostTH

paths

schema

schemaTH

OptionalsessionIdCookie

sessions

userAgent

Methods

createSession

Parameters

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

getOpts

Parameters

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

getSession

Parameters

Returns Promise<ClientSession>

getSharingContent

Type Parameters

Parameters

Returns Promise<T>

getSharingUrl

Parameters

Returns Promise<GetSharingUrlSuccess>

getTHSummarizeSec

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

request

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

requestJSON

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

requestTH

Type Parameters

Parameters

Returns Promise<ClientResponse<T>>

summarizeArticle

Parameters

Returns Promise<ArticleSummarizeResponse>

ProtectedsummarizeImpl

Type Parameters

Parameters

Returns Promise<T>

summarizeText

Parameters

Returns Promise<TextSummarizeResponse>

summarizeVideo

Parameters

Returns Promise<VideoSummarizeResponse>

Settings

On This Page

`Optional`apiToken

`Optional`sessionIdCookie

`Protected`summarizeImpl