このセクションの記事

サイト内検索多言語化の 2 つの方式について

概要

WOVN 導入サイトでは、翻訳言語でサイト内検索もできます。
実装方式は、「Internal Site Search API」方式と「WOVN . api (Translation Sets API v2 ) with 検索ベンダー」方式の 2 つのパターンがあります。
API の実行方法については、あわせて「Translation Sets API v1」も参照してください。

インフォメーション
サイト内検索を実装する場合、当社にて API 機能を有効にします。ご希望の方は、WOVN 管理画面右上の「お問い合わせ」ボタンからお問い合わせください。

目次

Internal Site Search API方式

WOVN のサーバーに保管された翻訳データを検索して、独自のレイアウトに合わせて表示する実装パターンです。
導入手順や機能の詳細は サイト内検索: Internal Site Search API 方式を参照してください。

仕様

  • WOVN に保存された翻訳データを検索し、「タイトル」「URL」「一致部分の文章」の結果を JSON 形式で受け取ります
  • GET メソッドで実行します

特徴

  • 検索の主体は、WOVN のシステムです
  • Web サイト側では、JSON を読み取る処理をします
  • WOVN から返却された JSON データを、検索結果として HTML に表示させる必要があります

メリット

  • 異なる言語での検索精度は、WOVN で実施した翻訳品質に左右されます
  • 翻訳品質を向上させると、検索精度も向上します
  • 幅広い構成に対応可能です

デメリット

  • リッチな検索機能を求める場合には不向きです
  • サジェスト検索やあいまい検索にも非対応です
  • 既存の検索処理とは別の処理ロジックになります
    • 元言語 → 本来の検索
    • 翻訳言語 → WOVN上の DB を検索

Internal Site Search API パターンの仕組み

元言語が日本語のサイトで、英語に切り替えた状態での検索を想定します。

  1. エンドユーザーが英語でサイト内検索します

    __________2023-04-05_0.24.45.png

  2. 検索ワードを対訳に持つページを、WOVN 管理画面内で検索します。一致したページの「タイトル」「URL」「一致部分の文章」を JSON 形式で返却します。

    __________2023-04-05_0.29.07.png

  3. 返却された JSON データを用いて、「フロントエンド」または「バックエンド」で検索結果を表示させます。

検索結果の取得方法

詳細は、Internal Site Search API 方式：技術仕様を参照してください。

WOVN . api (Translation Sets API v2 ) with 検索ベンダー

検索ベンターと WOVN の API を連携して、検索 DB 内のデータを多言語対応させる実装パターンです。

あわせて、「Translation Sets API v2」も参照してください。

仕様

WOVN 管理画面に、POST メソッドで翻訳する文章を登録して翻訳します。
管理画面 > 設定画面の「自動 AI 翻訳機能」が ON の場合、自動で AI 翻訳を実行します。
しかし「自動 AI 翻訳機能」が OFF の場合は手動で翻訳を実施してください。

制約事項

  • POST メソッドで登録した文章のみ、GET メソッドで取得可能です。
  • WOVN.io によりサーバーサイドスクレイピングされた 「WOVN.api with 検索ベンダー」 パターンでは取得できません。
  • リクエスト上限は 17 アクセス / 秒です。

特徴

  • 検索の主体は、検索 DB ベンダー側のシステムです
  • 検索ベンダーのデータベース上に、WOVN で翻訳したデータをあらかじめ格納します
  • 検索データの多言語化を行うことで、多言語によるサイト内検索ができます

メリット

  • 異なる言語での検索精度は、WOVN で実施した翻訳品質に左右されます
  • 翻訳品質を向上させると、検索精度も向上します
  • 検索 DB ベンダーのシステムを利用している場合、システム改修の必要がほぼありません
  • 検索結果の見た目を変更したい場合など、サイト側の機能を変更する場合は改修が必要です

デメリット

  • 「WOVN.api with 検索ベンダー」方式で作成した翻訳情報と、WOVN.io のサーバーサイドスクレイピングして作成した翻訳情報は共有できません。
  • 両者の間で翻訳結果の揺れが生じる可能性があります
  • 前者は純粋な文字情報が送られるのに対し、後者は HTML のタグを含んだ情報が送られるためです

WOVN.api with 検索ベンダー の仕組み

  1. 検索 DB に元言語のデータを登録します

  2. 登録を検知次第、WOVN に API を実行して翻訳リクエストを行います

  3. WOVN での翻訳完了後、検索 DB に対訳を登録するリクエストを API から実行します

  4. エンドユーザーがサイト内検索をすると、検索 DB から表示中の言語に応じた検索結果を返却します。お客様システム側では日本語と同様に結果を出力します
    4.png

翻訳テキストの登録方法

WOVN.io で翻訳したテキストを、検索 DB に登録する方法です。

パラメーター 必須 概要 タイプ 例
Authorization ◯ 認証用 API Key。WOVN管理画面から取得可能 文字列 Token＝token”XXXX”
Content-type - リソースのメディア指定の種別 文字列 Content-type:application/json
project_token ◯ WOVN.io のプロジェクトトークン 文字列 ”t0k3n1"
translation_sets.term_id ◯ リクエストしたテキストを格納するページ ID です。
WOVN 管理画面のページ名と紐付きます		 文字列 "Page001”
translation_sets.terms.id ◯ 翻訳テキストの任意 ID。最大 30 文字まで設定可能で、 WOVN 管理画面でユニークである必要があります 文字列 "taxt001”
translation_sets.terms.src ◯ 翻訳テキストです。最大 10,000 文字まで登録可 文字列 "こんにちは”
callback_url - 翻訳完了後、指定 URL に翻訳を返却します 文字列 "https://example.com/callback”

翻訳テキストの取得方法

あらかじめ POST / translation_sets で格納したテキストの翻訳を取得します。API によって返却されるデータは JSON 形式の文字列です。

パラメーター 概要
Authorization 認証用 API Key。WOVN 管理画面から取得可能
Content-type リソースのメディア指定の種別
project_token WOVN.io のプロジェクトトークン
translation_sets.id リクエストしたテキストが格納されているページ ID です。
WOVN 管理画面のページ名と紐付きます
translation_sets.terms リクエストしたテキストID
translation_sets.terms[].src リクエストしたテキスト
translation_sets.terms[].status 翻訳処理の状況 in_progress：翻訳中 translated:翻訳ずみ error：エラー
translation_sets.terms[].translations リクエストしたテキストの対訳情報
translation_sets.terms[].translations[] lang code で記載された対訳