# 表示領域の HTML と class 名

AI SEARCH は、`insertSelector` の要素の中に表示領域の HTML を追加します。表示領域の要素には、`gn-ais` で始まる class 名が付与されます。

| 項目 | 内容 |
| --- | --- |
| 対象者 | タグを設置する方（エンジニア、制作会社） |
| ページの概要 | 表示領域の HTML の構造と class 名を確認し、サイトの CSS 調整や表示の確認に使用できます |
| 前提条件 | [タグの設置](<https://docs.geniee-search.net/aisearch/install/tag/index.md>)の手順で、AI の回答が表示されていること |

## 表示領域の HTML

default のテーマで、回答の表示が完了した時点の HTML です。`<div id="ai-search">` は、`insertSelector` に記述したセレクタに該当するサイトの要素です。

```
<div id="ai-search">
  <div class="gn-ais gn-ais-v1 gn-ais-default gn-ais-completed">
    <div class="gn-ais-header">[headerText の固定メッセージ]</div>
    <div class="gn-ais-body">
      <div>
        [回答の HTML]
        <div class="gn-ais-references">
          <ul>
            <li><a href="https://example.com/price.html" target="_blank">1,3: [ページのタイトル]</a></li>
          </ul>
        </div>
      </div>
    </div>
    <div class="gn-ais-footer">[footerText の固定メッセージ]</div>
  </div>
</div>
```

表示領域の各部分と class 名の対応は、次の図のとおりです。左が表示、右が HTML で、同じ色の枠が対応します。

![左に default のテーマの表示領域、右にその HTML を並べた図。見出しが gn-ais-header、回答と参照リンクを含む本文が gn-ais-body、参照リンクの一覧が gn-ais-references、注意書きが gn-ais-footer の要素に対応し、全体が gn-ais の要素に入る](<https://docs.geniee-search.net/aisearch/images/html-classes.svg>)

図はイメージです。実際の表示は、デザインやサイトのレイアウトによって異なる場合があります。

- `gn-ais-header` と `gn-ais-footer` の要素は、`headerText` と `footerText` を記述しなかった場合も、中が空の状態で挿入されます
- `gn-ais-body` の内容は、表示の状態によって変わります。状態ごとの内容は「[表示の状態と class 名](<#states>)」を参照してください
- テーマによって、見出しと本文の中の HTML が変わります。違いは「[テーマごとの HTML の違い](<#themes>)」を参照してください

## 表示の状態と class 名

表示領域の全体の要素（`gn-ais`）には、表示の状態を表す class 名が 1 つ付与されます。状態が変わると、class 名も変更されます。

| class 名 | 表示の状態 | `gn-ais-body` 内に表示される内容 |
| --- | --- | --- |
| `gn-ais-no-input` | URL に検索キーワードがない状態で、検索結果ページを開いた場合 | `noInputBodyText` の固定メッセージ |
| `gn-ais-loading` | 回答を生成している場合 | `loadingBodyText` の固定メッセージ |
| `gn-ais-rendering` | 回答を表示している途中の場合 | 表示し終えた部分までの回答 |
| `gn-ais-completed` | 回答の表示が完了した場合 | 回答と参照リンク |
| `gn-ais-exception` | 回答を取得できなかった場合 | `exceptionBodyText` の固定メッセージ |
| `gn-ais-service-unavailable` | ページを開いたときに、サービスを利用できない場合。`showServiceUnavailable: true` を記述した場合のみ表示します | `serviceUnavailableBodyText` の固定メッセージ |

theme1 の表示領域を状態別に並べると、次のとおりです。各画面の上の `gn-ais-no-input` などは、その状態で表示領域の全体の要素に付与されている class 名です。

![theme1 の表示領域を、状態ごとに上から並べた画面。gn-ais-no-input では本文に noInputBodyText の固定メッセージ、gn-ais-loading では loadingBodyText の固定メッセージが出る。gn-ais-rendering では回答が途中まで表示され、gn-ais-completed では回答の全体が表示される。gn-ais-exception では exceptionBodyText の固定メッセージが出る。注意書きは gn-ais-rendering と gn-ais-completed のときだけ表示される](<https://docs.geniee-search.net/aisearch/images/html-states.webp>)

- 画面の回答は、回答できる情報が見つからなかった場合の例です
- theme1 と theme2 では、注意書き（`footerText`）は `gn-ais-rendering` と `gn-ais-completed` のときのみ表示されます
- `useStream` を記述しない場合、`gn-ais-rendering` は直ちに `gn-ais-completed` に変わります。`useStream: true` を記述した場合は、回答を少しずつ表示している間、`gn-ais-rendering` が付きます
- ページを開いたときにサービスを利用できない場合、`showServiceUnavailable` を書かなければ（初期値の `false`）、表示領域は追加されません。`showServiceUnavailable: true` を書くと、表示領域を追加して `gn-ais-service-unavailable` を付けます
- 検索した時点で利用が制限された場合は、`showServiceUnavailable: true` を書いていても `gn-ais-service-unavailable` は付与されず、`serviceUnavailableBodyText` の固定メッセージも表示されません
- 検索したときに、解約やリクエスト数の上限を超えたことなどで利用が制限されている場合は、表示領域の要素が削除されます。この場合、class 名も付与されません

表示の状態を class 名で確認する方法は「[表示の確認 › class 名による表示状態の確認](<https://docs.geniee-search.net/aisearch/install/verify/#state-class>)」を参照してください。

## class 名の一覧

| class 名 | 付いている要素 | 付くテーマ |
| --- | --- | --- |
| `gn-ais` | 表示領域の全体 | すべて |
| `gn-ais-v1` | 表示領域の全体 | すべて |
| `gn-ais-[テーマ名]`（`gn-ais-default`、`gn-ais-theme1`、`gn-ais-theme2`） | 表示領域の全体。`theme` に書いたテーマで変わります | すべて |
| `gn-ais-[状態]`（例: `gn-ais-loading`、`gn-ais-completed`） | 表示領域の全体。表示の状態で変わります。一覧は「[表示の状態と class 名](<#states>)」を参照してください | すべて |
| `gn-ais-header` | 見出し（`headerText`） | すべて |
| `gn-ais-header-title` | 見出しのラベル。`gn-ais-header` の中にあります | theme1、theme2 |
| `gn-ais-body` | 本文（回答、参照リンク、状態ごとの固定メッセージ） | すべて |
| `gn-ais-dots` | 回答の生成中に、固定メッセージの後ろで増えていく点 | theme1、theme2 |
| `gn-ais-references` | 参照リンクの一覧 | すべて |
| `gn-ais-footer` | 注意書き（`footerText`） | すべて |
| `gn-ais-content-wrapper` | 回答と参照リンク、展開ボタンを囲む要素 | theme2 |
| `has-fade` | `gn-ais-content-wrapper` の要素。回答を折りたたんでいる間のみ付与されます | theme2 |
| `gn-ais-content-text` | 回答と参照リンク。折りたたむ高さは、`gn-ais-content-text` 要素の `style` 属性で指定されます | theme2 |
| `gn-ais-show-more-btn` | 長い回答を展開・折りたたみするボタン | theme2 |
| `gn-ais-btn-text` | ボタンの固定メッセージ（`showMoreButtonText`、`showLessButtonText`） | theme2 |
| `gn-ais-btn-arrow` | ボタンの矢印（`▼`） | theme2 |
| `expanded` | `gn-ais-content-text` の要素と `gn-ais-show-more-btn` の要素。回答を展開している間のみ付与されます | theme2 |

class 名を使用して見た目を変更する方法は「[サイトの CSS による調整](<https://docs.geniee-search.net/aisearch/install/appearance/css/index.md>)」を参照してください。

## テーマごとの HTML の違い

### default

見出しの固定メッセージは、`gn-ais-header` 要素に直接挿入されます。`gn-ais-header-title` と `gn-ais-dots` の要素は挿入されません。回答の表示完了後の HTML は[表示領域の HTML](<#structure>)のとおりです。

```
<div class="gn-ais gn-ais-v1 gn-ais-default gn-ais-loading">
  <div class="gn-ais-header">[headerText の固定メッセージ]</div>
  <div class="gn-ais-body">
    <div>[loadingBodyText の固定メッセージ]</div>
  </div>
  <div class="gn-ais-footer">[footerText の固定メッセージ]</div>
</div>
```

default のテーマで回答の生成中の表示は、次のとおりです。画面の上の `gn-ais-default` は、表示領域の全体の要素に付く class 名です。default には背景と枠線がないため、画面では表示領域の範囲を点線で囲んでいます。

![default のテーマの表示領域。点線の枠の中に、中央の見出し、左に寄った本文「サイト内の情報をまとめています」、注意書きの 2 行が、背景のないまま並んでいる](<https://docs.geniee-search.net/aisearch/images/html-default-loading.webp>)

### theme1

見出しの固定メッセージが `gn-ais-header-title` の要素に入ります。回答の生成中は、固定メッセージの後ろに `gn-ais-dots` の要素が入ります。

```
<div class="gn-ais gn-ais-v1 gn-ais-theme1 gn-ais-loading">
  <div class="gn-ais-header">
    <div class="gn-ais-header-title">[headerText の固定メッセージ]</div>
  </div>
  <div class="gn-ais-body">
    <div>
      <p>[loadingBodyText の固定メッセージ]<span class="gn-ais-dots"></span></p>
    </div>
  </div>
  <div class="gn-ais-footer">[footerText の固定メッセージ]</div>
</div>
```

theme1 で回答の生成中の表示は、次のとおりです。画面の上の `gn-ais-theme1` は、表示領域の全体の要素に付く class 名です。固定メッセージの後ろの点が `gn-ais-dots` 要素です。注意書きは HTML に含まれていますが、回答が表示されるまで表示されません。

![theme1 の表示領域。灰色の背景の上に見出しのラベル、その下に「サイト内の情報をまとめています」と、後ろに続く点が表示されている。注意書きは表示されていない](<https://docs.geniee-search.net/aisearch/images/html-theme1-loading.webp>)

### theme2

見出しと、回答の生成中の HTML は theme1 と同じです。回答を表示している間と表示が終わった後は、回答と参照リンクが `gn-ais-content-text` の要素に格納され、高さが `contentMaxHeight` を超えると展開ボタンが追加されます。

```
<div class="gn-ais gn-ais-v1 gn-ais-theme2 gn-ais-completed">
  <div class="gn-ais-header">
    <div class="gn-ais-header-title">[headerText の固定メッセージ]</div>
  </div>
  <div class="gn-ais-body">
    <div class="gn-ais-content-wrapper has-fade">
      <div class="gn-ais-content-text" style="max-height: 120px; overflow: hidden;">
        [回答の HTML]
        <div class="gn-ais-references">...</div>
      </div>
      <button class="gn-ais-show-more-btn" type="button">
        <span class="gn-ais-btn-text">もっと見る</span>
        <span class="gn-ais-btn-arrow">▼</span>
      </button>
    </div>
  </div>
  <div class="gn-ais-footer">[footerText の固定メッセージ]</div>
</div>
```

- ボタンで展開すると、`gn-ais-content-wrapper` の要素から `has-fade` が削除され、`gn-ais-content-text` とボタンの要素に `expanded` が付与されます。`style` 属性は `max-height: none; overflow: visible;` になります
- 回答が `contentMaxHeight` の高さに収まる場合は、`has-fade` とボタンの要素は挿入されません
- 検索キーワードがない場合、回答を取得できなかった場合、サービスを利用できない場合は、`gn-ais-body` 内は `<div>[固定メッセージ]</div>` のみになります

theme2 で、回答を折りたたんでいる間と、ボタンで展開した後の表示は、次のとおりです。各画面の上の `has-fade` と `expanded` は、その時点で付与されている class 名です。`has-fade` は `gn-ais-content-wrapper` の要素に、`expanded` は `gn-ais-content-text` の要素とボタンの要素に付きます。

![theme2 の表示領域を上下に並べた画面。上は has-fade が付いている間で、回答が途中から薄くなって切れ、その下に「もっと見る ▼」のボタンがある。下は expanded が付いた後で、回答の全体と「閉じる ▲」のボタンが表示される](<https://docs.geniee-search.net/aisearch/images/html-theme2-collapse.webp>)

回答の展開中は、ボタンの矢印が上向きで表示されます。`gn-ais-btn-arrow` の要素の文字は `▼` のままです。

## 回答と参照リンクの HTML

| 部分 | HTML |
| --- | --- |
| 回答 | 見出し（`h1`〜`h6`）、段落（`p`）、箇条書き（`ul`、`ol`）、強調（`strong`）、リンク（`a`）などの要素で構成されます。回答内のリンクには `target="_blank"` が付与されます |
| 参照の番号 | 回答の文章内に `[1]` のような番号がテキストで挿入されます。番号は参照リンクの番号に対応します |
| 参照リンク | `gn-ais-references` 要素内に、`ul` と `li` で構成されます。リンクの文字は「番号: ページのタイトル」で、`target="_blank"` が付きます |

- 参照リンクには、回答内で番号が示されたページのみが含まれます
- 同じ URL のページを 2 回以上参照した場合は、1 つのリンクに集約し、番号をカンマで区切って表示します（例: `1,3: [ページのタイトル]`）
- 回答の中の `script`、`style`、`iframe` の要素は削除されます

## 関連ページ

- [サイトの CSS による調整](<https://docs.geniee-search.net/aisearch/install/appearance/css/index.md>)
- [デザインの選択](<https://docs.geniee-search.net/aisearch/install/appearance/theme/index.md>)
- [表示の確認](<https://docs.geniee-search.net/aisearch/install/verify/index.md>)
- [パラメータ一覧](<https://docs.geniee-search.net/aisearch/reference/parameters/index.md>)
