Skip to content

Conversation

@qryxip
Copy link
Member

@qryxip qryxip commented Mar 16, 2025

内容

現在各言語によっては非同期APIなどが無かったりします。どの言語にどの機能が無いのかを表にしておいて案内するのもいいのではないかと思いました。

関連 Issue

その他

@qryxip qryxip force-pushed the pr/docs-add-languages-md branch from c314363 to aadd98a Compare March 29, 2025 04:23
@qryxip qryxip changed the title docs: 「各言語バインディングの機能」を追加 docs: 各言語の表とデータのシリアライズについて追加 Mar 29, 2025
@qryxip qryxip marked this pull request as ready for review March 29, 2025 04:24
@qryxip
Copy link
Member Author

qryxip commented Mar 29, 2025

#975 のために「データのシリアライズ」(serialization.md)というのも加えてみました。

Copy link
Member

@sevenc-nanashi sevenc-nanashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

特に問題なさそう。

@Hiroshiba
Copy link
Member

Hiroshiba commented Mar 29, 2025

まだ完璧にコメントできるほど見きれていないのですが、一旦0.16前にコメントまで・・・!!

今のPRの形だと、AudioQueryとUserDictに関して、「serdeでエンジンに互換性のあるjson化ができる」という案内だと認識しています!
たしかに0.16時点ではそうなっているかもですが、将来的に変える・変わらない予定なのかが未合意だという認識です・・・!

たぶんだけど、こういう合意状態・・・?(かなり怪しい)

  • 今のシリアライゼーション結果を未来ほぼずっと保存・読み込み対応するか
    • できそう、くらいの感じ・・・でしたっけ。。
  • AudioQueryのserdeやjavaでのjson変換
    • 0.16段階でエンジンと同じjsonが出ている状態なのはOK
      • たしか「今から変えるのは無理」となったため
    • 今後もserdeでエンジンと同じjsonを出す、というのは未合意
      • たしか専用の関数を作るのはどうか、みたいな提案をどこかに書いた記憶
    • 今後も過去のjsonを読み込めるようにするかは未合意
      • マイグレーションが必要になり、serdeやGSON?でできるのかの調査とかが必要

(漏れや把握違いがありそう、気軽に指摘いただけると。。。 🙇 )

C APIではスキーマに従ったJSONの入出力が未定なのと同様に、未定ですという案内なら0.16に間に合うかも。
「シリアライゼーションはVOICEVOX ENGINEと同じjsonになっています。今後変更される可能性があります。」みたいなのとか?

↑みたいな曖昧性を書きつつ、表のチェックマークを曖昧感ある絵文字(⚠️とか?)にすればいけるかも!!
ちょっと一旦返信まで・・・!

@qryxip qryxip force-pushed the pr/docs-add-languages-md branch from 39d76f4 to c0f34d4 Compare March 29, 2025 08:54
@qryxip
Copy link
Member Author

qryxip commented Mar 29, 2025

  • 022785b (#1049): APIドキュメント側に"ただし今後の破壊的変更にて変わる可能性がある。"という一文を入れるようにしました。
  • 3f7caee (#1049): serialization.mdの文面を変えました。
  • c0f34d4 (#1049): languages.mdでの ✔️ を 💣 に変えました。

@qryxip
Copy link
Member Author

qryxip commented Mar 29, 2025

もし0.16に入れて頂ける場合ですが、GitHubのMarkdownよりもAPIドキュメントの文面の方が重要度は高そうかなと思っています。というのも前者は後で変更できるので。

@qryxip
Copy link
Member Author

qryxip commented Mar 29, 2025

なんとなくで 💣 にしてみたけど、普通に ⚠️ とかの方がよかったか…?

@Hiroshiba
Copy link
Member

なんか探してみても良いかもですね!
個人的には・・・まあ意外とどちらでも良いかもです!
表の下に意味を書いておくと良いかも?

Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

@Hiroshiba
Copy link
Member

マージできそう! これお待ちしてコアのビルド始めます 🙏

@qryxip qryxip merged commit ebee829 into VOICEVOX:main Mar 29, 2025
30 checks passed
@qryxip qryxip deleted the pr/docs-add-languages-md branch March 29, 2025 09:32
@qryxip
Copy link
Member Author

qryxip commented Mar 29, 2025

マージしました。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants