0.3.0 • Published 5 months ago

arpk v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

ARPK npm

LLM as your translator, with DeepLX-compatible API.

Usage

Prepare

ARPK supports most OpenAI-compatible APIs, Ollama is used here as an example (and is also the default):

ollama serve
ollama pull llama3.2

Install

First install Node.js, then install ARPK via your favorite package manager (or npm).

npm i -g arpk

You can also use ARPK via npx without installing it:

npx -y arpk

Translate

arpk translate --from "EN-US" --to "ZH" --input "Hello, World!"
# 你好,世界!

echo "Hello, World!" | arpk translate --from "EN-US" --to "JA"
# こんにちは、世界!

Serve

ARPK_LLM_MODEL="llama3.2" arpk serve

npx

ARPK_LLM_MODEL="llama3.2" npx -y arpk serve

docker

docker run -d \
  --name arpk \
  --network host \
  --restart unless-stopped \
  -e ARPK_LLM_MODEL=llama3.2 \
  ghcr.io/moeru-ai/arpk:latest

docker-compose

services:
  arpk:
    image: ghcr.io/moeru-ai/arpk:latest
    container_name: arpk
    network_mode: host
    restart: unless-stopped
    environment:
      - ARPK_LLM_MODEL=llama3.2

API

/translate, /api/v1/translate and /api/v2/translate are connected to the same translate endpoint.

await fetch('http://127.0.0.1:1188/translate', {
  body: JSON.stringify({
    source_lang: 'JA',
    target_lang: 'ZH',
    text: '雨の季節が過ぎ 澄み渡る空を 眺めて独り想フ'
  }),
  method: 'POST'
}).then(res => res.json())
// {
//   alternates: [],
//   code: 200,
//   data: '雨季过后,晴朗的天空下我独自遐思。',
//   id: 1519129853500,
//   method: 'ARPK v0.0.0 (llama3.2)',
//   source_lang: 'JA',
//   target_lang: 'ZH'
// }

Environments

Currently only Bearer Auth is supported when using ARPK_TOKEN, not URL Params.

EnvironmentDefaultDescription
ARPK_PORT1188The port the server will listen on
ARPK_TOKENnullAccess token to protect your API
ARPK_LLM_API_KEYnullOpenAI-compatible API key
ARPK_LLM_BASE_URLhttp://127.0.0.1:11434/v1/OpenAI-compatible API base url
ARPK_LLM_MODELllama3.2Model to be used by the ARPK
ARPK_SYSTEM_PROMPThttps://github.com/moeru-ai/arpk/blob/main/src/lib/prompts.tsSystem prompt
ARPK_SOURCE_LANGnullTranslate source language (cli only, --from)
ARPK_TARGET_LANGnullTranslate target language (cli only, --to)

License

MIT

0.3.0

5 months ago

0.3.0-beta.6

5 months ago

0.3.0-beta.4

7 months ago

0.3.0-beta.3

8 months ago

0.3.0-beta.2

8 months ago

0.3.0-beta.1

8 months ago

0.2.1

9 months ago

0.2.3

9 months ago

0.2.2

9 months ago

0.2.4

9 months ago

0.1.4

9 months ago

0.1.3

9 months ago

0.1.5

9 months ago

0.1.2

10 months ago

0.1.0

11 months ago

0.0.3

11 months ago

0.1.1

11 months ago

0.0.4

11 months ago

0.0.2

11 months ago

0.0.1

11 months ago

1.0.0

8 years ago