タイトルだけで探す場合と、本文まで探す場合

比較:A タイトルのみ と B 本文あり

全体像

入力の違いが検索範囲を変える
全体像の読み方:左から右へ、入力・処理・結果を追います。図の枠は対応する説明へのリンクです。対応する本文へ。探索できる原図

searchDocumentsの検索対象は、呼び出し元が渡したtitleとcontentです。Aはcontentを空文字にするため、本文中の語を見つけられません。Bは同じ関数へ実本文を渡すため、本文だけにある「再作成」も見つけられます。

先に押さえる前提

この比較はcontextリポジトリの plugins/site-search/search-core.js にある1関数を対象にします。呼び出し元は検証用の同じ4文書・同じ検索語・既定上限8を使い、Aのcontentだけを空文字に変えました。実サイト全体や検索製品の性能は比較していません。

「タイトルのみ」はtitleだけのオブジェクトを意味しません。関数は normalize(document.content) を呼ぶため、呼び出し元はAでも content: "" を渡します。contentを省略すると、normalizeがundefinedを扱えず失敗します。実コード9行目。

A タイトルのみ

見出しの語だけが候補を決める

B 本文あり

説明文にだけある語も候補を決める

関数はファイルやWebページを読み込みません。呼び出し元が本文を取得してcontentへ入れると、検索関数は本文も判定できます。入力を作る処理と検索する処理の責任を分けて確認してください。

同じ例の動き

全体を表示しています。

再生は説明の順序を示します。処理時間や性能差を表しません。

検索語「再作成」を同じ順で処理する
同じ例の動きの読み方:左から右へ、入力・処理・結果を追います。図の枠は対応する説明へのリンクです。対応する本文へ。探索できる原図

「再作成」が本文にだけある例

authoring文書のtitleは「Skill authoring」です。Bのcontentには「再作成」が入っています。検索関数はAでは語を見つけられず、Bでは本文の一致として文書を返しました。

Aの実返却値

[]

Bの実返却値(主要値)

{
  "id": "authoring",
  "title": "Skill authoring",
  "score": 1,
  "excerpt": "…成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。"
}

①呼び出し元が入力を作ります。②検索関数がtitleかcontentの部分一致を判定します。③タイトルに語がないBの文書は本文の一致なので、検索関数はscoreを1にします。AにもBにも同じ関数が使われ、本文用の別エンジンはありません。実コード10〜13行目。

別の入力と、適用範囲を確かめる

同じ6検索語の実行結果

Aは空本文、Bは実本文。全4文書は同じです。
検索語AB
再作成0件1件
Skill1件1件
検索 本文0件1件
API api2件2件
(空)0件0件
不存在0件0件

関数は「API api」をNFKC正規化して小文字化し、重複語を除きます。関数は1つのapiに一致する2文書をA/Bとも返しました。空の検索語では関数が空配列を返します。

全入力を読む
{
  "note": "検証用に新規作成した架空の4文書。実サイトの索引全体の複製ではない。",
  "documents": [
    {
      "id": "authoring",
      "title": "Skill authoring",
      "url": "docs/skills/skill-authoring.html",
      "content": "共通Skillを更新した担当者は公開成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。"
    },
    {
      "id": "search",
      "title": "サイト検索",
      "url": "docs/search.html",
      "content": "検索関数はタイトルと本文の両方を正規化し、全検索語に一致する文書を返します。"
    },
    {
      "id": "limit",
      "title": "API 入門",
      "url": "docs/api.html",
      "content": "API の呼び出し例です。上限は既定で8件です。"
    },
    {
      "id": "api",
      "title": "API ガイド",
      "url": "docs/api-guide.html",
      "content": "利用者は検索とAPIの接続点を確認できます。"
    }
  ],
  "queries": [
    "再作成",
    "Skill",
    "検索 本文",
    "API api",
    "",
    "不存在"
  ],
  "cases": [
    {
      "name": "A",
      "content": "空文字"
    },
    {
      "name": "B",
      "content": "元の本文"
    }
  ]
}
全返却値を読む
{
  "results": [
    {
      "query": "再作成",
      "A": [],
      "B": [
        {
          "id": "authoring",
          "title": "Skill authoring",
          "url": "docs/skills/skill-authoring.html",
          "content": "共通Skillを更新した担当者は公開成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。",
          "score": 1,
          "excerpt": "…成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。"
        }
      ]
    },
    {
      "query": "Skill",
      "A": [
        {
          "id": "authoring",
          "title": "Skill authoring",
          "url": "docs/skills/skill-authoring.html",
          "content": "",
          "score": 10,
          "excerpt": ""
        }
      ],
      "B": [
        {
          "id": "authoring",
          "title": "Skill authoring",
          "url": "docs/skills/skill-authoring.html",
          "content": "共通Skillを更新した担当者は公開成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。",
          "score": 10,
          "excerpt": "共通Skillを更新した担当者は公開成果物を全削除し、更新後のSkillをサブエージェントで実行して再作成します。"
        }
      ]
    },
    {
      "query": "検索 本文",
      "A": [],
      "B": [
        {
          "id": "search",
          "title": "サイト検索",
          "url": "docs/search.html",
          "content": "検索関数はタイトルと本文の両方を正規化し、全検索語に一致する文書を返します。",
          "score": 11,
          "excerpt": "検索関数はタイトルと本文の両方を正規化し、全検索語に一致する文書を返します。"
        }
      ]
    },
    {
      "query": "API api",
      "A": [
        {
          "id": "api",
          "title": "API ガイド",
          "url": "docs/api-guide.html",
          "content": "",
          "score": 10,
          "excerpt": ""
        },
        {
          "id": "limit",
          "title": "API 入門",
          "url": "docs/api.html",
          "content": "",
          "score": 10,
          "excerpt": ""
        }
      ],
      "B": [
        {
          "id": "api",
          "title": "API ガイド",
          "url": "docs/api-guide.html",
          "content": "利用者は検索とAPIの接続点を確認できます。",
          "score": 10,
          "excerpt": "利用者は検索とAPIの接続点を確認できます。"
        },
        {
          "id": "limit",
          "title": "API 入門",
          "url": "docs/api.html",
          "content": "API の呼び出し例です。上限は既定で8件です。",
          "score": 10,
          "excerpt": "API の呼び出し例です。上限は既定で8件です。"
        }
      ]
    },
    {
      "query": "",
      "A": [],
      "B": []
    },
    {
      "query": "不存在",
      "A": [],
      "B": []
    }
  ],
  "extra": {
    "limit1": [
      {
        "id": "api",
        "title": "API ガイド",
        "url": "docs/api-guide.html",
        "content": "利用者は検索とAPIの接続点を確認できます。",
        "score": 10,
        "excerpt": "利用者は検索とAPIの接続点を確認できます。"
      }
    ],
    "limitDefault": [
      {
        "id": "api",
        "title": "API ガイド",
        "url": "docs/api-guide.html",
        "content": "利用者は検索とAPIの接続点を確認できます。",
        "score": 10,
        "excerpt": "利用者は検索とAPIの接続点を確認できます。"
      },
      {
        "id": "limit",
        "title": "API 入門",
        "url": "docs/api.html",
        "content": "API の呼び出し例です。上限は既定で8件です。",
        "score": 10,
        "excerpt": "API の呼び出し例です。上限は既定で8件です。"
      }
    ],
    "negativeLimit": [
      {
        "id": "api",
        "title": "API ガイド",
        "url": "docs/api-guide.html",
        "content": "利用者は検索とAPIの接続点を確認できます。",
        "score": 10,
        "excerpt": "利用者は検索とAPIの接続点を確認できます。"
      }
    ]
  }
}

コードと設定

検索関数が行う3つの処理
コードと設定の読み方:左から右へ、入力・処理・結果を追います。図の枠は対応する説明へのリンクです。対応する本文へ。探索できる原図

図の①〜③は同じ関数の中で実行されます。次の左右の例は、同じディレクトリに保存した実コードと実入力を読み込むJavaScriptです。呼び出し元がAのcontentを空文字にする1箇所だけが異なります。共通関数の全行へ。

A タイトルのみ

JavaScript / 実行用の最小呼び出し例
const {searchDocuments} = require('./search-core.js');
const {documents} = require('./search-input.json');
const input = documents.map(d => ({...d, content:''}));
console.log(searchDocuments(input, '再作成'));
// 実結果: []

B 本文あり

JavaScript / 実行用の最小呼び出し例
const {searchDocuments} = require('./search-core.js');
const {documents} = require('./search-input.json');
const input = documents;
console.log(searchDocuments(input, '再作成'));
// 実結果: authoring文書、score 1

Aの呼び出し元は各文書のcontentを空文字にします。検索関数はtitleと空文字を判定するため、タイトルにない「再作成」を候補にできません。

Bの呼び出し元は実本文を保ちます。検索関数は本文の一致も候補に含め、本文の一致に1点を加えます。

ファイルの配置と設定を見る

共通の実コード

配置:<repository>/plugins/site-search/search-core.js。以下は実ファイルの全行です。保存した原本。

 1 function normalize(value) {
 2   return value.normalize('NFKC').toLocaleLowerCase('ja');
 3 }
 4 
 5 function searchDocuments(documents, query, limit = 8) {
 6   const terms = [...new Set(normalize(query).trim().split(/\s+/).filter(Boolean))];
 7   if (!terms.length) return [];
 8   return documents
 9     .map((document) => {
10       const title = normalize(document.title);
11       const content = normalize(document.content);
12       if (!terms.every((term) => title.includes(term) || content.includes(term))) return null;
13       const score = terms.reduce((sum, term) => sum + (title.includes(term) ? 10 : 1), 0);
14       const position = Math.max(0, content.indexOf(terms[0]));
15       const start = Math.max(0, position - 32);
16       const excerpt = `${start ? '…' : ''}${document.content.slice(start, start + 150)}${document.content.length > start + 150 ? '…' : ''}`;
17       return {...document, score, excerpt};
18     })
19     .filter(Boolean)
20     .sort((a, b) => b.score - a.score || a.title.localeCompare(b.title, 'ja'))
21     .slice(0, limit);
22 }
23 
24 module.exports = {searchDocuments};

正規化・得点・抜粋・上限

①関数はqueryとtitle/contentをNFKCで正規化し、日本語ロケールで小文字化します。queryの前後空白を除き、空白で語を分け、重複語を除きます。②関数はすべての語がtitleかcontentのどこかに含まれる文書だけを残します。語はtitleとcontentへ分かれていても構いません。③関数は各語につきタイトル一致を10点、それ以外の本文一致を1点にします。同じ語が両方にあれば10点です。関数は得点降順、同点なら日本語ロケールでtitleを比較して並べ、slice(0,limit)を返します。既定limitは8です。

関数は最初の検索語が本文に現れる位置から32文字手前を抜粋の開始点とし、原文contentから150文字分をsliceします。関数は必要なら前後へ…を付けます。最初の語がタイトルだけにあれば、関数は本文先頭から抜粋します。空本文のAのexcerptは空文字です。

関数はcontentを取得せず、語形変化や意味の類似、typoを扱いません。NFKC後の位置を原文のsliceに使うため、正規化で文字数が変わる文字の前後では抜粋位置がずれる可能性があります。JavaScriptのsliceはUTF-16の位置を使い、字形の境界を保証しません。関数はlimitの範囲を検査していません。実行したlimit=-1では末尾1件が除かれました。呼び出し元が正の整数を与える必要があります。

保存したファイル

output.html
search-core.js
search-input.json
search-results.json
replay.cjs
diagrams/各関心/model.json・viewer.html・diagram.svg・delivery.json・export.json

再現コマンド:同じフォルダで node replay.cjs。Node.jsを使います。追加パッケージは不要です。

使い分け

探したい情報を入力へ含める
使い分けの読み方:左から右へ、入力・処理・結果を追います。図の枠は対応する説明へのリンクです。対応する本文へ。探索できる原図

見出しの名前から探す画面を作る開発者はAを選べます。Aは本文の語による候補を出さず、入力本文を検索関数へ渡す必要がありません。

説明文の内容からも探す画面を作る開発者はBを選びます。Bの呼び出し元は本文の収集と入力サイズの管理を担当します。Bでも検索関数はタイトル一致を強く評価するため、本文一致が常に先頭になるわけではありません。

この試行は性能・メモリ・検索品質の利用者評価を測っていません。開発者は「本文を渡すと高速」「Aが常に適切」といった結論をこの試行から出せません。

公式資料

実入力・実コード・全返却値を照合する
根拠と再現の読み方:左から右へ、入力・処理・結果を追います。図の枠は対応する説明へのリンクです。対応する本文へ。探索できる原図

この題材の一次資料はローカルの実コードです。外部製品の仕様はこの比較へ混ぜていません。関数内の各処理と、保存した入力・返却値を対応付けました。

同梱Archify 2.16.0のeditorialモデルを5つ新規作成し、無改変のCLIで配布しました。制作者は実Chromeで標準SVGボタンを押して取得した画像を埋め込みました。各モデル、配布レシート、SVG、エクスポート記録はdiagramsへ保存しています。