Hamelp

説明

このプラグインは新しいカスタム投稿タイプ「よくある質問」を追加します。いくつかの機能を使ってユーザーのためのヘルプページを作ることができます。ヘルプセンターとはなんでしょうか？　いくつかの例を GitHub Wiki に挙げていますので、ご覧ください。

ポータルを作成する

このプラグインが提供する機能は……

• シングルページとアーカイブページを持つカスタムタクソノミー。
• カスタム投稿タイプに紐づくカスタムタクソノミー。
• インクリメンタル検索ボックス。
• AI オーバービュー（2.0.0から）

AI オーバービュー

AI オーバービューは大規模言語モデルを用いて、あなたの FAQ コンテンツに基づいた回答をユーザーに返します。
composer で wp-ai-client （実験的）を同梱しており、WordPress が利用する AI サービスを必要とします。wp-api-client はまだ実験的なので、API は将来のリリースで変更されるかもしれません。

AI の挙動とレート制限を管理画面の 設定 > Hamelp から設定できます。

ブロックを使う

AI FAQ オーバービュー ブロックをエディターに追加してください。ブロックには次のオプションがあります。

• プレースホルダー — 入力欄のプレースホルダー。
• ボタンテキスト — 送信ボタンのラベル

• 引用元を表示 — 回答の下に関連する FAQ のリンクを表示します。

  テンプレート関数を使う

テーマテンプレートで hamelp_render_ai_overview() 関数を使うこともできます。

<?php echo hamelp_render_ai_overview(); ?>

関数はオプションの引数を配列で受け取ります。

<php
echo hamelp_render_ai_overview( [
    'placeholder'  => 'Ask a question...',
    'button_text'  => 'Ask AI',
    'show_sources' => true,
] );
?>

この関数は必要な JavaScript と CSS アセットを自動で読み込みます。

検索ボックス

ページ本文で hamelp-search ショートコードを利用することができます。

[hamelp-search label='Enter your question here.'][/hamelp-search]

もしくはテーマから呼び出すこともできます。

<?php echo do_shortcode( '[hamelp-search][/hamelp-search]' ) ?>