API

OpenAI互換API

Chat Completions (テキストおよび画像)、Completions、Embeddings エンドポイントへのリクエストを送信。

---

OpenAIライクなAPIエンドポイント

LM Studio は、いくつかの OpenAI エンドポイントでリクエストを受け付け、OpenAI ライクなレスポンスオブジェクトを返します。

サポートされているエンドポイント

GET  /v1/models
POST /v1/chat/completions
POST /v1/embeddings
POST /v1/completions

各エンドポイントの詳細については、以下をご覧ください。

---

既存の OpenAI クライアントの再利用

LM Studio を指すように base url を変更

注意: 以下の例では、サーバーポートが 1234 であると仮定しています。

Python

from openai import OpenAI

client = OpenAI(
+    base_url="https://:1234/v1"
)

# ... the rest of your code ...

Typescript

import OpenAI from 'openai';

const client = new OpenAI({
+  baseUrl: "https://:1234/v1"
});

// ... the rest of your code ...

cURL

- curl https://api.openai.com/v1/chat/completions \
+ curl https://:1234/v1/chat/completions \
  -H "Content-Type: application/json" \
  -d '{
-     "model": "gpt-4o-mini",
+     "model": "use the model identifier from LM Studio here",
     "messages": [{"role": "user", "content": "Say this is a test!"}],
     "temperature": 0.7
   }'

---

エンドポイントの概要

/v1/models

• GET リクエスト
• 現在 ロードされているモデルのリストを表示します。

cURL の例

curl https://:1234/v1/models

/v1/chat/completions

• POST リクエスト
• チャット履歴を送信し、アシスタントの応答を受け取ります。
• プロンプトテンプレートが自動的に適用されます。
• ペイロードで温度などの推論パラメータを指定できます。サポートされているパラメータについては、サポートされているパラメータを参照してください。
• 詳細については、OpenAI のドキュメントを参照してください。
• モデルがどのような入力Receiveしているかを確認するために、常に lms log stream を開いたターミナルウィンドウを置いておいてください。

Python の例

# Example: reuse your existing OpenAI setup
from openai import OpenAI

# Point to the local server
client = OpenAI(base_url="https://:1234/v1", api_key="lm-studio")

completion = client.chat.completions.create(
  model="model-identifier",
  messages=[
    {"role": "system", "content": "Always answer in rhymes."},
    {"role": "user", "content": "Introduce yourself."}
  ],
  temperature=0.7,
)

print(completion.choices[0].message)

/v1/embeddings

• POST リクエスト
• 文字列または文字列の配列を送信し、テキスト埋め込み (整数トークン ID) の配列を取得します。
• 詳細については、OpenAI のドキュメントを参照してください。

Python の例

# Make sure to `pip install openai` first
from openai import OpenAI
client = OpenAI(base_url="https://:1234/v1", api_key="lm-studio")

def get_embedding(text, model="model-identifier"):
   text = text.replace("\n", " ")
   return client.embeddings.create(input = [text], model=model).data[0].embedding

print(get_embedding("Once upon a time, there was a cat."))

/v1/completions

• POST リクエスト
• 文字列を送信し、その文字列のモデルによる継続を受け取ります。
• サポートされているペイロードパラメータについては、サポートされているペイロードパラメータを参照してください。
• プロンプトテンプレートは、モデルにプロンプトテンプレートがある場合でも適用されません。
• 詳細については、OpenAI のドキュメントを参照してください。
• モデルがどのような入力Receiveしているかを確認するために、常に lms log stream を開いたターミナルウィンドウを置いておいてください。

---

サポートされているペイロードパラメータ

各パラメータの説明については、https://platform.openai.com/docs/api-reference/chat/create を参照してください。

model
top_p
top_k
messages
temperature
max_tokens
stream
stop
presence_penalty
frequency_penalty
logit_bias
repeat_penalty
seed

---

コミュニティ

LM Studio Discord サーバーで、他の LM Studio 開発者とチャットしたり、LLM、ハードウェアなどについて話し合ったりしましょう。LM Studio Discord サーバー。