Class YandexGPTProvider

allowUnsafeEval

OptionalapiExtra

OptionalapiKey

apiUrl

apiUrlPlaceholder

baseLang

fetch

fetchOpts

headers

MAX_UID

NANO_DIFF

origin

originPlaceholder

Optionalsession

sessionUrl

createSession

• createSession(): TranslationTypes.YandexTranslateProviderType.Session

  Returns TranslationTypes.YandexTranslateProviderType.Session

detect

• detect(text: string): Promise<DetectResponse>

  The total limit of characters per request is 1k chars

  Parameters

  • text: string

  Returns Promise<DetectResponse>

generateSid

• generateSid(): string

  Returns string

genYandexMetrikaUID

• genYandexMetrikaUID(): string

  Returns string

genYandexUID

• genYandexUID(): string

  Returns string

getId

• getId(): string

  Returns string

getLangs

• getLangs(): Promise<GetLangsResponse>

  Returns Promise<GetLangsResponse>

getOpts

• getOpts(
      body: URLSearchParams | null,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): {
      body: URLSearchParams | null;
      headers: {
          "Content-Type": string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

  Parameters

  • body: URLSearchParams | null
  • headers: Record<string, string> = {}
  • method: RequestMethod = "POST"

  Returns {
      body: URLSearchParams | null;
      headers: {
          "Content-Type": string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

getParams

• getParams(srv: Srv, params?: Record<string, string>): string

  Parameters

  • srv: Srv
  • params: Record<string, string> = {}

  Returns string

getSecure

• getSecure(srv: Srv): { srv: Srv; yu: string; yum: string }

  Parameters

  • srv: Srv

  Returns { srv: Srv; yu: string; yum: string }

getSession

• getSession(): TranslationTypes.YandexTranslateProviderType.Session

  Returns TranslationTypes.YandexTranslateProviderType.Session

incrRequestsCount

• incrRequestsCount(): void

  Returns void

isErrorRes

• isErrorRes<T extends object>(
      res: Response,
      data: TranslationTypes.YandexTranslateProviderType.FailedResponse | T,
  ): data is TranslationTypes.YandexTranslateProviderType.FailedResponse

  Type Parameters

  • T extends object

  Parameters

  • res: Response
  • data: TranslationTypes.YandexTranslateProviderType.FailedResponse | T

  Returns data is TranslationTypes.YandexTranslateProviderType.FailedResponse

isSuccessProviderRes

• isSuccessProviderRes<T>(
      res: ProviderResponse<T>,
  ): res is ProviderSuccessResponse<T>

  Type Parameters

  • T

  Parameters

  • res: ProviderResponse<T>

  Returns res is ProviderSuccessResponse<T>

isValidUrl

• isValidUrl(url: string | undefined): url is string

  Parameters

  • url: string | undefined

  Returns url is string

parseLang

• parseLang(lang: string): { fromLang: string; toLang: string }

  Parameters

  • lang: string

  Returns { fromLang: string; toLang: string }

rawDetect

• rawDetect(
      text: string,
      options?: DetectOptions,
  ): Promise<{ lang: string; probs: Record<string, number>; score: number }>

  You can use this method if you need a probabilities

  Parameters

  • text: string
  • options: DetectOptions = DetectOptions.withCurrentProb

  Returns Promise<{ lang: string; probs: Record<string, number>; score: number }>

request

• request<T extends object>(
      path: string,
      body?: URLSearchParams | null,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): Promise<ProviderResponse<T>>

  The standard method for requesting the API, if necessary, you can override how it is done in the example

  Type Parameters

  • T extends object

  Parameters

  • path: string
  • body: URLSearchParams | null = null
  • headers: Record<string, string> = {}
  • method: RequestMethod = "POST"

  Returns Promise<ProviderResponse<T>>

translate

• translate(text: string | string[], lang?: string): Promise<TranslationResponse>

  The total limit of characters per request is 10k chars

  Parameters

  • text: string | string[]
  • lang: string = "en-ru"

  Returns Promise<TranslationResponse>

updateData

• updateData(__namedParameters?: Partial<BaseProviderOpts>): void

  Parameters

  • __namedParameters: Partial<BaseProviderOpts> = {}

  Returns void