# 固定メッセージの変更

設定タグに固定メッセージの項目を書くと、表示領域の見出し、注意書き、状態ごとの固定メッセージを変えられます。記述しなかった固定メッセージは表示されません。

| 項目 | 内容 |
| --- | --- |
| 対象者 | タグを設置する方（エンジニア、制作会社） |
| ページの概要 | 見出し、注意書き、状態ごとの固定メッセージを変えられます。回答を少しずつ表示する設定もできます |
| 前提条件 | [タグの設置](<https://docs.geniee-search.net/aisearch/install/tag/index.md>)の手順で、AI の回答が表示されていること |

## 変更できる固定メッセージ

| 項目 | 表示される場所 | 表示されるとき |
| --- | --- | --- |
| `headerText` | 表示領域上部の見出し | 表示領域が表示されている間 |
| `footerText` | 表示領域下部の注意書き | default では、表示領域が表示されている間。theme1 と theme2 では、回答を表示している間だけ |
| `noInputBodyText` | 表示領域の本文 | URL に検索キーワードがない状態で、検索結果ページを開いたとき |
| `loadingBodyText` | 表示領域の本文 | 回答の生成中。theme1 と theme2 では、固定メッセージの後ろに表示される点が順に増えます |
| `exceptionBodyText` | 表示領域の本文 | 回答を取得できなかったとき |
| `serviceUnavailableBodyText` | 表示領域の本文 | ページを開いた時点でサービスを利用できない状態で、`showServiceUnavailable: true` を記述した場合。詳しくは「[サービス利用不可時の固定メッセージ表示](<#service-unavailable>)」を参照してください |

- どの項目も初期値はありません。書かなかった固定メッセージは表示されません
- 値は空でない文字列で指定します。空の文字列（`""`）を記述すると、ブラウザのコンソールに `Invalid value for [項目名]` が表示され、表示領域は表示されません
- theme1 と theme2 では、`headerText` を記述しないと、見出しのラベルが文字のないまま表示されます。theme1 と theme2 では `headerText` を記述してください
- theme2 の折りたたみのボタンの固定メッセージは、[デザインの選択 › 長い回答の折りたたみ（theme2）](<https://docs.geniee-search.net/aisearch/install/appearance/theme/#collapse>)の `extraThemeConf` で変えます

## 固定メッセージの記述方法

[タグの設置](<https://docs.geniee-search.net/aisearch/install/tag/index.md>)で書いた設定タグに、表示したい固定メッセージの項目を足します。次の例の固定メッセージは、サイトに合わせて書き換えてください。

```
<script>
  window.aisConf = window.aisConf || [];
  window.aisConf.push({
    uid: "[サービスの ID]",
    promptId: "[プロンプトの ID]",
    insertSelector: "[表示領域を置く要素の CSS セレクタ]",
    inputSelector: "[検索ボックスの CSS セレクタ]",
    headerText: "生成AIによる補足回答エリア",
    footerText: "このエリアの文章はサイトの情報からAIにより生成しています。<br>正確な情報は確認するようにしてください。",
    noInputBodyText: "検索されたキーワードから、AIがサイト情報をまとめてここに回答します。",
    loadingBodyText: "サイト内の情報をまとめています",
    exceptionBodyText: "エラーが発生しました。もう一度お試しください。",
  });
</script>
```

`[ ]` の部分は[タグの設置 › 設定タグの必須 4 項目](<https://docs.geniee-search.net/aisearch/install/tag/#required-parameters>)で説明している値です。

## 固定メッセージに記述できる HTML

固定メッセージには HTML タグを記述できます。改行する場合は `<br>` を記述します。

AI SEARCH は、固定メッセージを表示する前に次の要素を削除します。

| 取り除くもの | 値 |
| --- | --- |
| 要素 | `script`、`style`、`iframe` |
| 属性 | `href`、`class`、`style`、`id`、`onclick` など |

`href` が削除されるため、固定メッセージ内の `a` 要素はリンクとして機能しません。`class` と `style` も取り除かれるため、固定メッセージの見た目は、「[サイトの CSS による調整](<https://docs.geniee-search.net/aisearch/install/appearance/css/index.md>)」の方法で変更します。

## サービス利用不可時の固定メッセージ表示

設定タグに `showServiceUnavailable: true` を記述すると、ページを開いたときにサービスを利用できない状態の場合に、表示領域を表示して `serviceUnavailableBodyText` の固定メッセージを表示します。サービスを利用できなくなるのは、契約が終了しているとき（解約など）と、今月のリクエスト数が上限に達しているときです。詳しくは「[AI SEARCH の機能 › 表示される場所と内容](<https://docs.geniee-search.net/aisearch/getting-started/overview/#display>)」を参照してください。

| 項目 | 内容 | 初期値 |
| --- | --- | --- |
| `showServiceUnavailable` | ページを開いたときにサービスを利用できない状態の場合に、表示領域を表示するかどうか。`true` か `false` で書きます | `false` |
| `serviceUnavailableBodyText` | `showServiceUnavailable` が `true` のときに、表示領域の本文に表示する固定メッセージ | なし |

```
<script>
  window.aisConf = window.aisConf || [];
  window.aisConf.push({
    uid: "[サービスの ID]",
    promptId: "[プロンプトの ID]",
    insertSelector: "[表示領域を置く要素の CSS セレクタ]",
    inputSelector: "[検索ボックスの CSS セレクタ]",
    showServiceUnavailable: true,
    serviceUnavailableBodyText: "サービスは現在利用できません。",
  });
</script>
```

- `showServiceUnavailable: true` と `serviceUnavailableBodyText` は併せて記述します。`serviceUnavailableBodyText` を書かないと、本文が空のまま表示領域が表示されます
- `showServiceUnavailable` を書かない場合は、ページを開いたときにサービスを利用できない状態だと、表示領域を表示しません。ブラウザのコンソールにもメッセージは表示されません
- ページを開いたときは利用できる状態でも、その後に回答を取得するまでの間に利用できない状態になった場合（他の閲覧者の検索で今月のリクエスト数が上限に達したときなど）は、`showServiceUnavailable` を書いていても `serviceUnavailableBodyText` の固定メッセージは表示されません。次にページを開いたときに固定メッセージが表示されます

## 回答の段階的な表示

設定タグに `useStream: true` を書くと、回答の完成を待たずに、生成された部分から順に表示します。書かない場合は、回答の完成後に一括で表示します。

| 項目 | 内容 | 初期値 | 設定できる値 |
| --- | --- | --- | --- |
| `useStream` | 回答を少しずつ表示するかどうか | `false` | `true` か `false`。`"true"` のように引用符で囲むと、`Invalid value for useStream` が表示されます |
| `streamRate` | 回答の一部を受信するたびに、表示前に待機する時間（ミリ秒）。値が大きいほど、表示速度が遅くなります。`useStream` が `true` のときだけ使います | `30` | 0 より大きい数値 |

```
<script>
  window.aisConf = window.aisConf || [];
  window.aisConf.push({
    uid: "[サービスの ID]",
    promptId: "[プロンプトの ID]",
    insertSelector: "[表示領域を置く要素の CSS セレクタ]",
    inputSelector: "[検索ボックスの CSS セレクタ]",
    useStream: true,
    streamRate: 30,
  });
</script>
```

- `loadingBodyText` の固定メッセージは、回答の最初の部分が表示されるまで表示されます
- 参照リンクは回答を最後まで表示した後に表示されます

## 確認方法

1. 検索結果ページを、検索キーワードを付けずに開きます。見出しと `noInputBodyText` の固定メッセージが表示されることを確かめます
2. 検索結果ページを、検索キーワードを付けて開きます（例: `https://example.com/search?q=[サイトの内容に関わるキーワード]`）。回答が出るまで `loadingBodyText` の固定メッセージが表示されることを確かめます
3. 回答が表示された後に、見出しと注意書きが表示されることを確認します。`useStream: true` を書いた場合は、回答が少しずつ表示されることも確かめます
4. ブラウザの開発者ツールでコンソールを開き、`Invalid value for` などのメッセージが出ていないことを確かめます

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

## 設定上の制限と回避方法

| 制限事項 | 回避方法 |
| --- | --- |
| 固定メッセージ内にリンクを配置すること | 表示領域の外（`insertSelector` の要素の前や後ろ）に、サイトの HTML でリンクを配置します |
| 固定メッセージに `class` や `style` を付けて見た目を変える | 表示領域の class 名を使い、[サイトの CSS による調整](<https://docs.geniee-search.net/aisearch/install/appearance/css/index.md>)の方法で変えます |
| 空の文字列（`""`）を記述して固定メッセージを非表示にすること | 非表示にしたい固定メッセージの項目を、設定タグから削除します |
| AI の回答の内容や口調を、設定タグで変更すること | 回答の内容は、管理画面のプロンプトで変えます。[回答の内容の変更](<https://docs.geniee-search.net/aisearch/operate/prompt/index.md>)にあります |

## 関連ページ

- [デザインの選択](<https://docs.geniee-search.net/aisearch/install/appearance/theme/index.md>)
- [サイトの CSS による調整](<https://docs.geniee-search.net/aisearch/install/appearance/css/index.md>)
- [タグの設置](<https://docs.geniee-search.net/aisearch/install/tag/index.md>)
- [表示の確認](<https://docs.geniee-search.net/aisearch/install/verify/index.md>)
- [パラメータ一覧](<https://docs.geniee-search.net/aisearch/reference/parameters/index.md>)
- [表示されない場合・表示に異常がある場合](<https://docs.geniee-search.net/aisearch/troubleshooting/display/index.md>)
