プラグイン系APIについて¶

内容について

この内容はサービス改良の中で予告なく改定されることがあります

翻訳・発話サーバ¶

ゆかりねっとコネクターNEOを通して読み上げ設定のコントロールをサポートします。
ゆかりねっとコネクターNEOを通して翻訳と読み上げをサポートします。

使用条件

翻訳/発話連携サーバプラグインをONにしていること
翻訳１の翻訳エンジンを選定していること（これが使われます）
送信先ポートはレジストリから取得します

使用条件

プラグイン v2.3以上

HTTP経由¶

発話の停止¶

送付方式：HTTP(GET)

停止指示

    http://localhost:15520/api/command?target=Plugin_PlayVoice&command=stop

発話パラメータの設定¶

送付方式：HTTP(GET)

停止パラメータ

パラメータ	値	例
engine	エンジン名	さとうささら/CeVIO_64
pitch	高さ	1.0
accent	抑揚	1.0
speed	速度	1.0
volume	音量	1.0
quality	声質	1.0

engineに指定する文字の区切り文字 / は、%2F に置き換えてください

指示

    http://localhost:15520/api/command?target=Plugin_PlayVoice&command=set&engine=さとうささら%2FCeVIO_64

デバイスの取得¶

送付方式：HTTP(GET)

RequestResult

    http://localhost:15520/api/command?target=Plugin_PlayVoice&command=device

[
'ずんだもん-ノーマル/VOICEVOX',
'ずんだもん-あまあま/VOICEVOX'
]

読み上げ指示¶

送付方式：HTTP(GET)

パラメータ

パラメータ	値	例
Engine	エンジン名	さとうささら/CeVIO_64
Pitch	高さ	1.0
Accent	抑揚	1.0
Speed	速度	1.0
Volume	音量	1.0
Quality	声質	1.0
Kuten	句点待ち時間	1.0
Toten	読点待ち時間	1.0
prePhoneme	前空白	1.0
postPhoneme	後空白	1.0
Text	読む文章	"おはよう"
ID	識別用のID	"00000-0000-0000-000000"

engineに指定する文字の区切り文字 / は、%2F に置き換えてください
パラメータ名は大文字・小文字を区別します
IDを指定した場合は、何度要求しても1度しか読み上げません。

Request

    http://localhost:15520/api/command?target=Plugin_PlayVoice&command=speech&Engine=さとうささら%2FCeVIO_64&Text=Hello

共通項目¶

通信ポートの特定¶

通信ポートはレジストリから取得できます

使用条件

ポートを開放したときに更新されます

レジストリ位置：HKCU\Software\YukarinetteConnectorNeo\TransServer

名前	型	意味
WebSocket	DWord32	WebSocketポート番号
HTTP	DWord32	HTTPポート番号

プラグイン通信¶

翻訳（１言語）¶

翻訳/発話連携サーバプラグインが開いているHTTPサーバもしくはWebSocketサーバに下記のリクエストを送付してください。
送付方式：HTTPの場合はPOST、WSの場合はテキスト

RequestResponse(OK)Response(NG)

{
    operation: 'translate',
    params: [
        {
            id: '0000-0000-0000-0000',
            lang: 'en_US',
            text: 'こんにちは'
        }
    ]
}

{
    operation: 'translate',
    status: 'success'
    id: '0000-0000-0000-0000',
    lang: 'ja_JP',
    text: 'Hello.' 
}

{
    operation: 'translate',
    status: 'failure'
    id: '0000-0000-0000-0000',
    lang: 'ja_JP',
    text: 'こんにちは.' 
}

要求時は、翻訳してほしい言語を指定します。
返答時には、推定した言語と翻訳した文が来ます。
statusがfailureの場合は、処理に失敗しています。

翻訳（複数言語）¶

対応プラグインバージョン: v1.4以上

翻訳/発話連携サーバプラグインが開いているHTTPサーバもしくはWebSocketサーバに下記のリクエストを送付してください。
送付方式：HTTPの場合はPOST、WSの場合はテキスト

RequestResponse(OK) Case1Response(OK) Case2Response(NG)

{
    operation: 'translates',
    params: [
        {
            id: '0000-0000-0000-0000',
            lang: [
                'ja_JP',
                'en_US',
                'fr_FR'
            ],
            text: 'こんにちは'
        }
    ]
}

{
    operation: 'translates',
    status: 'success'
    id: '0000-0000-0000-0000',
    detect_language : 'ja_JP',
    result : [
        {
            lang: 'ja_JP',
            text: 'こんにちは' 
        },
        {
            lang: 'en_US',
            text: 'Hello.' 
        },
        {
            lang: 'fr_FR',
            text: 'bonjour.' 
        }
    ]
}

{
    operation: 'translates',
    status: 'success'
    id: '0000-0000-0000-0000',
    detect_language : 'unknown',
    result : [
        {
            lang: 'ja_JP',
            text: 'こんにちは' 
        },
        {
            lang: 'en_US',
            text: 'Hello.' 
        },
        {
            lang: 'fr_FR',
            text: 'bonjour.' 
        }
    ]
}

{
    operation: 'translates',
    status: 'failure'
    id: '0000-0000-0000-0000',
    message: '翻訳サーバに接続できません'
}

要求時は、翻訳してほしい言語を指定します。
返答時には、推定した言語と翻訳した文が来ます。
statusがfailureの場合は、処理に失敗しています。

読み上げ¶

翻訳/発話連携サーバプラグインが開いているHTTPサーバもしくはWebSocketサーバに下記のリクエストを送付してください。
送付方式：HTTPの場合はPOST、WSの場合はテキスト

パラメータ拡張

v2.0.73よりパラメータが追加されました。(volume)
volumeは発話音量の設定です。（float型、単位は倍。有効指定範囲 0.2～2　）

Request(Standard)Request(Extend)Response(OK)Response(NG)

{
    operation: 'speech',
    params: [
        {
            id: '0000-0000-0000-0000',
            text: 'こんにちは',
            talker: 'ずんだもん-ノーマル/VOICEVOX'
        }
    ]
}

{
    operation: 'speech',
    params: [
        {
            id: '0000-0000-0000-0000',
            text: 'こんにちは',
            talker: 'ずんだもん-ノーマル/VOICEVOX',
            volume: 1.0
        }
    ]
}

{
    operation: 'speech',
    status: 'sended'
    id: '0000-0000-0000-0000',
    text: 'こんにちは.' 
}

{
    operation: 'speech',
    status: 'failure'
    id: '0000-0000-0000-0000',
    text: 'こんにちは.' 
}

要求時は、発話してほしいボイスキャラクターを指定するとその音源で話そうとします。
statusがfailureの場合は、プラグインが無効な場合など要求が出せなかった場合にでます。
statusがsendedの場合、要求自体はだせたという意味で、発話が完了したわけではありません。

音声話者リスト¶

送付方式：HTTPの場合はPOST、WSの場合はテキスト

RequestResponse(OK)Response(NG)

{
    operation: 'speech.getvoicelist',
    params: [
        {
            id: '0000-0000-0000-0000',
        }
    ]
}

{
    operation: 'speech.getvoicelist',
    status: 'sended'
    id: '0000-0000-0000-0000',
    voice: [
            'ずんだもん/VOICEVOX',
            '弦巻マキ(日)/CeVIO AI'
        ]
    }
}

{
    operation: 'speech.getvoicelist',
    status: 'failure'
    id: '0000-0000-0000-0000'
}

発話の強制停止¶

送付方式：HTTPの場合はPOST、WSの場合はテキスト
キューをクリアするため、現在発話動作に入っているものは読み上げします。

RequestResponse(OK)Response(NG)

{
    operation: 'speech.stop',
    params: [
        {
            id: '0000-0000-0000-0000',
        }
    ]
}

{
    operation: 'speech.stop',
    status: 'sended'
    id: '0000-0000-0000-0000',
}

{
    operation: 'speech.stop',
    status: 'failure'
    id: '0000-0000-0000-0000'
}

バージョンの取得¶

対応プラグインバージョン: v1.4a以上

送付方式：HTTPの場合はPOST、WSの場合はテキスト

RequestResponse(OK)Response(NG)

{
    operation: 'version',
    params: [
        {
            id: '0000-0000-0000-0000',
        }
    ]
}

{
    operation: 'version',
    status: 'success',
    version: [
        {
            System: '1.959',
            Plugin: '1.4a'
        }
    ]
    id: '0000-0000-0000-0000',
}

{
    operation: 'version',
    status: 'failure',
    id: '0000-0000-0000-0000'
}

名前	型	意味
System	String	NEO本体のバージョン
Plugin	String	翻訳/発話連携サーバプラグイン

OSCの送信¶

翻訳/発話連携サーバプラグインが開いているHTTPサーバもしくはWebSocketサーバに下記のリクエストを送付してください。
送付方式：HTTPの場合はPOST、WSの場合はテキスト
対応バージョン：v2.0.73～

RequestResponse(OK)Response(NG)

{
    operation: 'osc',
    params: [
        {
            address: '/comment/text',
            id: '0000-0000-0000-0000',
            text: 'こんにちは',
            target : [
                'vrchat',
                'virtualcast',
                'unity',
                'neosvr'
            ]
        }
    ]
}

{
    operation: 'osc',
    status: 'sended'
    id: '0000-0000-0000-0000',
    text: 'こんにちは.' 
}

{
    operation: 'osc',
    status: 'failure'
    id: '0000-0000-0000-0000',
    text: 'こんにちは.' 
}

連携に必要なプラグイン名

送信先	有効化すべきプラグイン
vrchat	VRChatプラグイン
virtualcast	VirtualCastプラグイン
unity	VMCプラグイン
neosvr	NeosVRプラグイン

指定したOSC通信をプラットフォームに送信します。
statusがfailureの場合は、プラグインが無効な場合など要求が出せなかった場合にでます。
statusがsendedの場合、要求自体はだせたという意味です。

GPTをつかった言葉の処理¶

翻訳/発話連携サーバプラグインが開いているHTTPサーバもしくはWebSocketサーバに下記のリクエストを送付してください。
送付方式：HTTPの場合はPOST、WSの場合はテキスト
対応バージョン：v2.0.94～

RequestResponse(OK)Response(NG)

{
    "operation": "gpt",
    "params": [
        {
            "id": "0000-0000-0000-0000",
            "command": "question",
            "premise": "あなたはおじいさん役。",
            "prompt": "役割に合わせ発言せよ。「おはよう」",
            "maxtokens": 1000,
            "temperature":0.5
        }
    ]
}

{
    operation: 'gpt',
    status: 'success'
    id: '0000-0000-0000-0000',
    text: '「皆の者、おはよう」' 
}

{
    operation: 'gpt',
    status: 'failure'
    id: '0000-0000-0000-0000',
    text: '' 
}

GPT3プラグイン自体が有効で、APIキーなどが設定済みであるときに使用可能です。
statusがfailureの場合は、プラグインが無効な場合など要求が出せなかった場合にでます。

入力支援¶

ゆかりねっとコネクターNEOの文字入力を支援します

使用条件

入力支援プラグインをONにしていること
送信先ポートはレジストリから取得します

遠隔操作¶

送付方式：HTTP(GET)

１行前に移動１行後に移動カーソル行を送信カーソル行を送り次の行に移動

    http://localhost:15520/api/command?target=Plugin_InputAssist&command=prev

    http://localhost:15520/api/command?target=Plugin_InputAssist&command=next

    http://localhost:15520/api/command?target=Plugin_InputAssist&command=send

    http://localhost:15520/api/command?target=Plugin_InputAssist&command=sendnext

歌詞プラグイン¶

ゆかりねっとコネクターNEOの文字入力を支援します

使用条件

入力支援プラグインをONにしていること
送信先ポートはレジストリから取得します

遠隔操作¶

送付方式：HTTP(GET)

再生一時停止停止ファイルロード

    http://localhost:15520/api/command?target=Plugin_LyricAssist&command=play

    http://localhost:15520/api/command?target=Plugin_LyricAssist&command=pause

    http://localhost:15520/api/command?target=Plugin_LyricAssist&command=stop

sukiyuki.stl を読み込む場合

    http://localhost:15520/api/command?target=Plugin_LyricAssist&command=load&file=d:/sukiyuki.stl

OBS WSプラグイン¶

指定した字幕ソースに文字を表示します。

使用条件

OBS-WSプラグインをONにしていること
OBS-WSプラグイン v2.1以上で有効

ソースに指定した字幕を表示する¶

送付方式：HTTP(GET)

実行

ソース名 字幕枠 に あいうえお と表示したい場合

    http://127.0.0.1:15520/api/command?target=Plugin_OBS&command=set&text=あいうえお&source=字幕枠

OBS WS5プラグイン¶

指定した字幕ソースに文字を表示します。

使用条件

OBS-WS5プラグインをONにしていること
OBS-WS5プラグイン v2.3以上で有効

ソースに指定した字幕を表示する¶

送付方式：HTTP(GET)

実行

ソース名 字幕枠 に あいうえお と表示したい場合

    http://127.0.0.1:15520/api/command?target=Plugin_OBS5&command=set&text=あいうえお&source=字幕枠

OSCプラグイン¶

指定したOSCメッセージを送付します。

使用条件

OSCプラグインをONにしていること
送信先ポートはレジストリから取得します
OSCプラグイン v1.5以上で有効

OSCメッセージの遠隔発火¶

送付方式：HTTP(GET)

実行

送信タグ名 EyeClose を送りたい場合

    http://localhost:15520/api/command?target=Plugin_VRChat_OSC&command=exec&tag=EyeClose

HTTPコールプラグイン¶

指定したHTTP呼び出し(GET)を送付します。

使用条件

HTTPプラグインをONにしていること
送信先ポートはレジストリから取得します
ゆかりねっとコネクターNEO v2.0～で有効

HTTPメッセージの遠隔発火¶

送付方式：HTTP(GET)

実行

送信タグ名 CALL を送りたい場合

    http://localhost:15520/api/command?target=Plugin_HTTPCall&command=exec&tag=CALL

clusterウェブトリガープラグイン¶

指定したHTTP呼び出し(GET)を送付します。

使用条件

clusterウェブトリガープラグインをONにしていること
送信先ポートはレジストリから取得します
ゆかりねっとコネクターNEO v2.0～で有効

ウェブトリガーの遠隔発火¶

送付方式：HTTP(GET)

実行

送信タグ名 Trig1 を発火したい場合

    http://localhost:15520/api/command?target=Plugin_ClusterTrigger&command=exec&tag=Trig1

NeosVRプラグイン¶

NeosVRと通信してトリガーをかけることができます。

使用条件

NeosVRプラグインをONにしていること
ゆかりねっとコネクターNEO v2.0～で有効

NeosVRメッセージの遠隔発火¶

送付方式：HTTP(GET)

実行

送信タグ名 CALL を送りたい場合

    http://localhost:15520/api/command?target=Plugin_NeosVR&command=exec&tag=CALL

```

VTuberStudio プラグイン¶

VTuberStudioと通信してトリガーをかけることができます。

使用条件

VTuberStudioプラグインをONにしていること
ゆかりねっとコネクターNEO v2.0.17～で有効

VTuberStudioキーバインドアクションの遠隔発火¶

送付方式：HTTP(GET)

実行

送信タグ名 CALL を送りたい場合

    http://localhost:15520/api/command?target=Plugin_VtuberStudio&command=exec&tag=CALL

GPT3 プラグイン¶

GPT3処理をおこなうことができます

使用条件

GPT3プラグインをONにしていること
ゆかりねっとコネクターNEO v2.0.94～で有効

GPTをつかった言葉の処理¶

送付方式：HTTP(GET)

実行RequestResponse(OK)Response(NG)

送信タグ名 CALL を送りたい場合

    http://localhost:15520/api/command?target=Plugin_VtuberStudio&command=exec&tag=CALL

{
    "operation": "gpt",
    "params": [
        {
            "id": "0000-0000-0000-0000",
            "command": "question",
            "premise": "あなたはおじいさん役。",
            "prompt": "役割に合わせ発言せよ。「おはよう」",
            "maxtokens": 1000,
            "temperature":0.5
        }
    ]
}

{
    operation: 'gpt',
    status: 'success'
    id: '0000-0000-0000-0000',
    text: '「皆の者、おはよう」' 
}

{
    operation: 'gpt',
    status: 'failure'
    id: '0000-0000-0000-0000',
    text: '' 
}

GPT3プラグイン自体が有効で、APIキーなどが設定済みであるときに使用可能です。
statusがfailureの場合は、プラグインが無効な場合など要求が出せなかった場合にでます。

最終更新日: 2023年5月30日