Skip to content

Add get_encoding_name_for_model to tiktoken #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dqbd merged 2 commits into from
Aug 9, 2025
Merged

Add get_encoding_name_for_model to tiktoken #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09e2414
Add get_encoding_name_for_model to tiktoken
noseworthy Feb 16, 2025
f5dac19
Add changeset
dqbd Aug 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/cyan-donuts-behave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"tiktoken": patch
"@dqbd/tiktoken": patch
---

Add get_encoding_name_for_model method
241 changes: 129 additions & 112 deletions wasm/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ export type TiktokenModel =
| "gpt-5-chat-latest";

/**
* @param {TiktokenModel} encoding
* @param {TiktokenModel} model
* @param {Record<string, number>} [extend_special_tokens]
* @returns {Tiktoken}
*/
Expand All @@ -485,117 +485,8 @@ pub fn encoding_for_model(
model: &str,
extend_special_tokens: JsValue,
) -> Result<Tiktoken, JsError> {
let encoding = match model {
"text-davinci-003" => Ok("p50k_base"),
"text-davinci-002" => Ok("p50k_base"),
"text-davinci-001" => Ok("r50k_base"),
"text-curie-001" => Ok("r50k_base"),
"text-babbage-001" => Ok("r50k_base"),
"text-ada-001" => Ok("r50k_base"),
"davinci" => Ok("r50k_base"),
"davinci-002" => Ok("cl100k_base"),
"curie" => Ok("r50k_base"),
"babbage" => Ok("r50k_base"),
"babbage-002" => Ok("cl100k_base"),
"ada" => Ok("r50k_base"),
"code-davinci-002" => Ok("p50k_base"),
"code-davinci-001" => Ok("p50k_base"),
"code-cushman-002" => Ok("p50k_base"),
"code-cushman-001" => Ok("p50k_base"),
"davinci-codex" => Ok("p50k_base"),
"cushman-codex" => Ok("p50k_base"),
"text-davinci-edit-001" => Ok("p50k_edit"),
"code-davinci-edit-001" => Ok("p50k_edit"),
"text-embedding-ada-002" => Ok("cl100k_base"),
"text-embedding-3-small" => Ok("cl100k_base"),
"text-embedding-3-large" => Ok("cl100k_base"),
"text-similarity-davinci-001" => Ok("r50k_base"),
"text-similarity-curie-001" => Ok("r50k_base"),
"text-similarity-babbage-001" => Ok("r50k_base"),
"text-similarity-ada-001" => Ok("r50k_base"),
"text-search-davinci-doc-001" => Ok("r50k_base"),
"text-search-curie-doc-001" => Ok("r50k_base"),
"text-search-babbage-doc-001" => Ok("r50k_base"),
"text-search-ada-doc-001" => Ok("r50k_base"),
"code-search-babbage-code-001" => Ok("r50k_base"),
"code-search-ada-code-001" => Ok("r50k_base"),
"gpt2" => Ok("gpt2"),
"gpt-3.5-turbo" => Ok("cl100k_base"),
"gpt-3.5-turbo-0301" => Ok("cl100k_base"),
"gpt-3.5-turbo-0613" => Ok("cl100k_base"),
"gpt-3.5-turbo-16k" => Ok("cl100k_base"),
"gpt-3.5-turbo-16k-0613" => Ok("cl100k_base"),
"gpt-3.5-turbo-instruct" => Ok("cl100k_base"),
"gpt-3.5-turbo-instruct-0914" => Ok("cl100k_base"),
"gpt-4" => Ok("cl100k_base"),
"gpt-4-0314" => Ok("cl100k_base"),
"gpt-4-0613" => Ok("cl100k_base"),
"gpt-4-32k" => Ok("cl100k_base"),
"gpt-4-32k-0314" => Ok("cl100k_base"),
"gpt-4-32k-0613" => Ok("cl100k_base"),
"gpt-3.5-turbo-1106" => Ok("cl100k_base"),
"gpt-35-turbo" => Ok("cl100k_base"),
"gpt-4-1106-preview" => Ok("cl100k_base"),
"gpt-4-vision-preview" => Ok("cl100k_base"),
"gpt-3.5-turbo-0125" => Ok("cl100k_base"),
"gpt-4-turbo" => Ok("cl100k_base"),
"gpt-4-turbo-2024-04-09" => Ok("cl100k_base"),
"gpt-4-turbo-preview" => Ok("cl100k_base"),
"gpt-4-0125-preview" => Ok("cl100k_base"),
"gpt-4o" => Ok("o200k_base"),
"gpt-4o-2024-05-13" => Ok("o200k_base"),
"gpt-4o-2024-08-06" => Ok("o200k_base"),
"gpt-4o-2024-11-20" => Ok("o200k_base"),
"gpt-4o-mini-2024-07-18" => Ok("o200k_base"),
"gpt-4o-mini" => Ok("o200k_base"),
"gpt-4o-search-preview" => Ok("o200k_base"),
"gpt-4o-search-preview-2025-03-11" => Ok("o200k_base"),
"gpt-4o-mini-search-preview" => Ok("o200k_base"),
"gpt-4o-mini-search-preview-2025-03-11" => Ok("o200k_base"),
"gpt-4o-audio-preview" => Ok("o200k_base"),
"gpt-4o-audio-preview-2024-12-17" => Ok("o200k_base"),
"gpt-4o-audio-preview-2024-10-01" => Ok("o200k_base"),
"gpt-4o-mini-audio-preview" => Ok("o200k_base"),
"gpt-4o-mini-audio-preview-2024-12-17" => Ok("o200k_base"),
"o1" => Ok("o200k_base"),
"o1-2024-12-17" => Ok("o200k_base"),
"o1-mini" => Ok("o200k_base"),
"o1-mini-2024-09-12" => Ok("o200k_base"),
"o1-preview" => Ok("o200k_base"),
"o1-preview-2024-09-12" => Ok("o200k_base"),
"o1-pro" => Ok("o200k_base"),
"o1-pro-2025-03-19" => Ok("o200k_base"),
"o3" => Ok("o200k_base"),
"o3-2025-04-16" => Ok("o200k_base"),
"o3-mini" => Ok("o200k_base"),
"o3-mini-2025-01-31" => Ok("o200k_base"),
"o4-mini" => Ok("o200k_base"),
"o4-mini-2025-04-16" => Ok("o200k_base"),
"chatgpt-4o-latest" => Ok("o200k_base"),
"gpt-4o-realtime" => Ok("o200k_base"),
"gpt-4o-realtime-preview-2024-10-01" => Ok("o200k_base"),
"gpt-4o-realtime-preview-2024-12-17" => Ok("o200k_base"),
"gpt-4o-mini-realtime-preview" => Ok("o200k_base"),
"gpt-4o-mini-realtime-preview-2024-12-17" => Ok("o200k_base"),
"gpt-4.1" => Ok("o200k_base"),
"gpt-4.1-2025-04-14" => Ok("o200k_base"),
"gpt-4.1-mini" => Ok("o200k_base"),
"gpt-4.1-mini-2025-04-14" => Ok("o200k_base"),
"gpt-4.1-nano" => Ok("o200k_base"),
"gpt-4.1-nano-2025-04-14" => Ok("o200k_base"),
"gpt-4.5-preview" => Ok("o200k_base"),
"gpt-4.5-preview-2025-02-27" => Ok("o200k_base"),
"gpt-5" => Ok("o200k_base"),
"gpt-5-2025-08-07" => Ok("o200k_base"),
"gpt-5-nano" => Ok("o200k_base"),
"gpt-5-nano-2025-08-07" => Ok("o200k_base"),
"gpt-5-mini" => Ok("o200k_base"),
"gpt-5-mini-2025-08-07" => Ok("o200k_base"),
"gpt-5-chat-latest" => Ok("o200k_base"),
model => Err(JsError::new(
format!("Invalid model: {}", model.to_string()).as_str(),
)),
}?;
let binding = get_encoding_name_for_model(model)?;
let encoding = binding.as_str();

Tiktoken::with_encoding(
encoding,
Expand All @@ -604,3 +495,129 @@ pub fn encoding_for_model(
.ok(),
)
}

#[cfg(feature = "inline")]
#[wasm_bindgen(typescript_custom_section)]
const _: &'static str = r#"
/**
* @param {TiktokenModel} model
* @returns {TiktokenEncoding}
*/
export function get_encoding_name_for_model(model: TiktokenModel): TiktokenEncoding;
"#;

#[cfg(feature="inline")]
#[wasm_bindgen(skip_typescript)]
pub fn get_encoding_name_for_model(model: &str) -> Result<String, JsError> {
match model {
"text-davinci-003" => Ok("p50k_base".into()),
"text-davinci-002" => Ok("p50k_base".into()),
"text-davinci-001" => Ok("r50k_base".into()),
"text-curie-001" => Ok("r50k_base".into()),
"text-babbage-001" => Ok("r50k_base".into()),
"text-ada-001" => Ok("r50k_base".into()),
"davinci" => Ok("r50k_base".into()),
"davinci-002" => Ok("cl100k_base".into()),
"curie" => Ok("r50k_base".into()),
"babbage" => Ok("r50k_base".into()),
"babbage-002" => Ok("cl100k_base".into()),
"ada" => Ok("r50k_base".into()),
"code-davinci-002" => Ok("p50k_base".into()),
"code-davinci-001" => Ok("p50k_base".into()),
"code-cushman-002" => Ok("p50k_base".into()),
"code-cushman-001" => Ok("p50k_base".into()),
"davinci-codex" => Ok("p50k_base".into()),
"cushman-codex" => Ok("p50k_base".into()),
"text-davinci-edit-001" => Ok("p50k_edit".into()),
"code-davinci-edit-001" => Ok("p50k_edit".into()),
"text-embedding-ada-002" => Ok("cl100k_base".into()),
"text-embedding-3-small" => Ok("cl100k_base".into()),
"text-embedding-3-large" => Ok("cl100k_base".into()),
"text-similarity-davinci-001" => Ok("r50k_base".into()),
"text-similarity-curie-001" => Ok("r50k_base".into()),
"text-similarity-babbage-001" => Ok("r50k_base".into()),
"text-similarity-ada-001" => Ok("r50k_base".into()),
"text-search-davinci-doc-001" => Ok("r50k_base".into()),
"text-search-curie-doc-001" => Ok("r50k_base".into()),
"text-search-babbage-doc-001" => Ok("r50k_base".into()),
"text-search-ada-doc-001" => Ok("r50k_base".into()),
"code-search-babbage-code-001" => Ok("r50k_base".into()),
"code-search-ada-code-001" => Ok("r50k_base".into()),
"gpt2" => Ok("gpt2".into()),
"gpt-3.5-turbo" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-0301" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-0613" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-16k" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-16k-0613" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-instruct" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-instruct-0914" => Ok("cl100k_base".into()),
"gpt-4" => Ok("cl100k_base".into()),
"gpt-4-0314" => Ok("cl100k_base".into()),
"gpt-4-0613" => Ok("cl100k_base".into()),
"gpt-4-32k" => Ok("cl100k_base".into()),
"gpt-4-32k-0314" => Ok("cl100k_base".into()),
"gpt-4-32k-0613" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-1106" => Ok("cl100k_base".into()),
"gpt-35-turbo" => Ok("cl100k_base".into()),
"gpt-4-1106-preview" => Ok("cl100k_base".into()),
"gpt-4-vision-preview" => Ok("cl100k_base".into()),
"gpt-3.5-turbo-0125" => Ok("cl100k_base".into()),
"gpt-4-turbo" => Ok("cl100k_base".into()),
"gpt-4-turbo-2024-04-09" => Ok("cl100k_base".into()),
"gpt-4-turbo-preview" => Ok("cl100k_base".into()),
"gpt-4-0125-preview" => Ok("cl100k_base".into()),
"gpt-4o" => Ok("o200k_base".into()),
"gpt-4o-2024-05-13" => Ok("o200k_base".into()),
"gpt-4o-2024-08-06" => Ok("o200k_base".into()),
"gpt-4o-2024-11-20" => Ok("o200k_base".into()),
"gpt-4o-mini-2024-07-18" => Ok("o200k_base".into()),
"gpt-4o-mini" => Ok("o200k_base".into()),
"gpt-4o-search-preview" => Ok("o200k_base".into()),
"gpt-4o-search-preview-2025-03-11" => Ok("o200k_base".into()),
"gpt-4o-mini-search-preview" => Ok("o200k_base".into()),
"gpt-4o-mini-search-preview-2025-03-11" => Ok("o200k_base".into()),
"gpt-4o-audio-preview" => Ok("o200k_base".into()),
"gpt-4o-audio-preview-2024-12-17" => Ok("o200k_base".into()),
"gpt-4o-audio-preview-2024-10-01" => Ok("o200k_base".into()),
"gpt-4o-mini-audio-preview" => Ok("o200k_base".into()),
"gpt-4o-mini-audio-preview-2024-12-17" => Ok("o200k_base".into()),
"o1" => Ok("o200k_base".into()),
"o1-2024-12-17" => Ok("o200k_base".into()),
"o1-mini" => Ok("o200k_base".into()),
"o1-mini-2024-09-12" => Ok("o200k_base".into()),
"o1-preview" => Ok("o200k_base".into()),
"o1-preview-2024-09-12" => Ok("o200k_base".into()),
"o1-pro" => Ok("o200k_base".into()),
"o1-pro-2025-03-19" => Ok("o200k_base".into()),
"o3" => Ok("o200k_base".into()),
"o3-2025-04-16" => Ok("o200k_base".into()),
"o3-mini" => Ok("o200k_base".into()),
"o3-mini-2025-01-31" => Ok("o200k_base".into()),
"o4-mini" => Ok("o200k_base".into()),
"o4-mini-2025-04-16" => Ok("o200k_base".into()),
"chatgpt-4o-latest" => Ok("o200k_base".into()),
"gpt-4o-realtime" => Ok("o200k_base".into()),
"gpt-4o-realtime-preview-2024-10-01" => Ok("o200k_base".into()),
"gpt-4o-realtime-preview-2024-12-17" => Ok("o200k_base".into()),
"gpt-4o-mini-realtime-preview" => Ok("o200k_base".into()),
"gpt-4o-mini-realtime-preview-2024-12-17" => Ok("o200k_base".into()),
"gpt-4.1" => Ok("o200k_base".into()),
"gpt-4.1-2025-04-14" => Ok("o200k_base".into()),
"gpt-4.1-mini" => Ok("o200k_base".into()),
"gpt-4.1-mini-2025-04-14" => Ok("o200k_base".into()),
"gpt-4.1-nano" => Ok("o200k_base".into()),
"gpt-4.1-nano-2025-04-14" => Ok("o200k_base".into()),
"gpt-4.5-preview" => Ok("o200k_base".into()),
"gpt-4.5-preview-2025-02-27" => Ok("o200k_base".into()),
"gpt-5" => Ok("o200k_base".into()),
"gpt-5-2025-08-07" => Ok("o200k_base".into()),
"gpt-5-nano" => Ok("o200k_base".into()),
"gpt-5-nano-2025-08-07" => Ok("o200k_base".into()),
"gpt-5-mini" => Ok("o200k_base".into()),
"gpt-5-mini-2025-08-07" => Ok("o200k_base".into()),
"gpt-5-chat-latest" => Ok("o200k_base".into()),
model => Err(JsError::new(
format!("Invalid model: {}", model.to_string()).as_str(),
)),
}
}
13 changes: 12 additions & 1 deletion wasm/test/test_simple_public.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { it, expect, describe } from "vitest";
import { encoding_for_model, get_encoding } from "../dist";
import { encoding_for_model, get_encoding, get_encoding_name_for_model } from "../dist";

it("encoding_for_model initialization", () => {
expect(() => encoding_for_model("gpt2")).not.toThrowError();
Expand Down Expand Up @@ -106,6 +106,17 @@ it("test_encoding_for_model", () => {
expect(encoding_for_model("gpt-3.5-turbo").name).toEqual("cl100k_base");
});

it("test_get_encoding_name_for_model", () => {
expect(get_encoding_name_for_model("gpt2")).toEqual("gpt2");
expect(get_encoding_name_for_model("text-davinci-003")).toEqual("p50k_base");
expect(get_encoding_name_for_model("gpt-3.5-turbo")).toEqual("cl100k_base");

// @ts-expect-error - explicitly testing for invalid model
expect(() => get_encoding_name_for_model("gpt2-unknown")).toThrowError(
"Invalid model: gpt2-unknown"
);
})

it("test_custom_tokens", () => {
const enc = encoding_for_model("gpt2", {
"<|im_start|>": 100264,
Expand Down
Loading