# FAQs
Highlight related APIs
## 回答を選択
> 特定のFAQをユーザーが選択したものとして処理することができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq/select_answer":{"post":{"tags":["FAQs"],"operationId":"selectFaq","summary":"回答を選択","description":"特定のFAQをユーザーが選択したものとして処理することができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"選択したいQ&AのID"},"hashId":{"type":"string","description":"Q&A検索結果のID"}}}}}},"responses":{"200":{"description":"選択されたQ&A","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","description":"成功した場合は、「成功」を返します。"}}}}}},"404":{"description":"無効なQ&Aです"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aから検索
> このAPIを使用すると、Q\&Aナレッジベースから最も関連性の高い質問と回答のペアを見つけることができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq":{"post":{"tags":["FAQs"],"operationId":"searchFaq","summary":"Q&Aから検索","description":"このAPIを使用すると、Q&Aナレッジベースから最も関連性の高い質問と回答のペアを見つけることができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoRegisterCandidates":{"type":"boolean","description":"デフォルト値はtrueです。このオプションをfalseに設定すると、指定されたクエリに対して答えがない場合、自動的にQ&A登録候補にクエリが登録されません。"},"hashtagsOperator":{"type":"string","enum":["AND","OR"],"description":"ANDまたはORのいずれかを選択します。\nすべてのハッシュタグを含む結果を返したい場合はANDを選択します。\n少なくとも1つのハッシュタグを含む結果を返したい場合はORを選択します。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"表示したいすべてのハッシュタグの配列。"},"maxResults":{"type":"integer","description":"返される結果の最大数。"},"query":{"type":"string","description":"質問内容。","required":true},"format":{"type":"string","enum":["html","text"],"description":"html またはテキストの場合。テキストの場合、返り値はプレーンテキストになります。html の場合、html を返します。異なるフォントサイズや色などのスタイルがある html を使用する場合、html を使用できます。単にテキストとして答えを得たい場合は、テキストを使用できます。デフォルト値は html です。"}}}}}},"responses":{"200":{"description":"APIは、Q&Aデータから最も関連性の高い質問と回答を見つけます。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"confidence":{"type":"number","description":"AIモデルからの信頼度を示しています。0から1の間の数値として表示されます。"},"effectiveConfidence":{"type":"number","description":"検索結果にフィードバックを提供すると、自動的にAIモデルがトレーニングされます。効果的な信頼度は、これらのユーザーおよびメンバーのフィードバックによって調整されたスコアです。0から1の間の数値として表示されます。"},"question":{"type":"string","description":"選択されたQ&Aペアの質問の部分です。"},"answer":{"type":"string","description":"選択されたQ&Aペアの回答部分です。"},"id":{"type":"string","description":"フィードバックを与えるか取り消すかを識別するために使用されます。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"Q&A用に登録されたハッシュタグ。"},"lastUpdatedDate":{"type":"string","format":"date","description":"Q&Aが最後に更新された日付。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"メンバー(管理画面ユーザー)からの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"メンバー(管理画面ユーザー)からの否定的なフィードバックの数。"}},"description":"ダッシュボードやチャット画面、REST APIを通じたメンバーからのこのQ&Aに関するフィードバック。"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ユーザーからの肯定的なフィードバックの数。"},"negativeCount":{"type":"integer","description":"ユーザーからの否定的なフィードバックの数。"}},"description":"このQ&Aに関するユーザーからの（会話を通じた）フィードバック。"}}}},"count":{"type":"integer","description":"提案されたQ&Aの数。"},"hashId":{"type":"string","description":"このハッシュIDは、後でselect_answerを呼び出す際に使用されます。"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## シングルQ\&Aを取得
> シングルQ\&Aのすべての詳細を取得する方法です。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/single_faq":{"get":{"tags":["FAQs"],"operationId":"getExactFaq","summary":"シングルQ&Aを取得","description":"シングルQ&Aのすべての詳細を取得する方法です。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"お探しのFAQのID。"},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["html","text"]},"description":"このFAQの回答値の形式。デフォルトはHTMLです。"}],"responses":{"200":{"description":"FAQの詳細を正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"question":{"type":"string","description":"Q&Aに関連する質問。"},"similar_questions":{"type":"array","items":{"type":"string"},"description":"類似質問。"},"answer":{"type":"string","description":"質問に対する回答。"},"id":{"type":"string","description":"質疑応答のID。"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ユーザーからのポジティブなフィードバックの数。"},"negativeCount":{"type":"integer","description":"ユーザーからのネガティブなフィードバックの数。"}},"description":"このQ&Aに関するユーザーからのフィードバック。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"管理者からのポジティブなフィードバックの数。"},"negativeCount":{"type":"integer","description":"管理者からのネガティブなフィードバックの数。"}},"description":"管理者からのこのQ&Aに関するフィードバック(ダッシュボードおよびRESTコールを通じて)。"},"lastUpdatedDate":{"type":"string","format":"date","description":"Q&Aが最後に更新された日付。"},"createdDate":{"type":"string","format":"date","description":"Q&Aが最初に作成された日付。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"この質問に関連するすべてのハッシュタグ。"},"statusOnAt":{"type":"string","format":"date-time","description":"Q&AのステータスがONになった日時。"},"statusOffAt":{"type":"string","format":"date-time","description":"Q&AのステータスがOFFになった日時。"},"folder":{"type":"string","description":"このQ&Aが保存されているフォルダ。"},"agentEditor":{"type":"array","items":{"type":"string"},"description":"このQ&Aの編集権限を持つ管理者のリスト。"},"agentViewer":{"type":"array","items":{"type":"string"},"description":"このQ&Aの閲覧権限を持つ管理者のリスト。"},"allowOtherAgentsView":{"type":"boolean","description":"編集者/閲覧者のリストにない管理者がこのQ&Aを表示できるかどうか。"},"allowOtherUsersView":{"type":"boolean","description":"アクセスリストにいないユーザーがこのQ&Aを閲覧できるかどうか。"}}}}}}}},"404":{"description":"FAQが見つかりません","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string"}}}}}}}}}}}
```
## Q\&Aを一覧表示する
> ナレッジベースのQ\&Aを一覧表示できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faqs":{"get":{"tags":["FAQs"],"operationId":"getFaqs","summary":"Q&Aを一覧表示する","description":"ナレッジベースのQ&Aを一覧表示できます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0},"description":"オフセットを使用すると、ページ上の最初の項目のランク番号を指定できます。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":1000},"description":"1ページあたりに返されるオブジェクトの数を設定できます。最大値およびデフォルト値は1000です。"},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["text","html"],"default":"html"},"description":"回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式でも可能です。"}],"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","description":"データの取得を開始する位置を指定するパラメーター"},"count":{"type":"integer","description":"取得した件数に応じて表示されるQ&Aの合計"},"total_count":{"type":"integer","description":"フィルター適用後の結果のQ&Aの合計"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Q&AのID"},"question":{"type":"string","description":"Q&Aの質問部分"},"answer":{"type":"string","description":"Q&Aの回答部分"},"hashtags":{"type":"array","items":{"type":"string"},"description":"Q&Aに追加されたハッシュタグ"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ポジティブなユーザーフィードバックの数"},"negativeCount":{"type":"integer","description":"否定的なユーザーフィードバックの数"}},"description":"ユーザーのフィードバックは、今後の検索結果に影響を与えます。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ポジティブな管理者フィードバックの数"},"negativeCount":{"type":"integer","description":"否定的な管理者フィードバックの数"}},"description":"管理者のフィードバックは今後の検索結果に影響を与えます。"},"lastUpdatedDate":{"type":"string","format":"date","description":"Q&Aが最後に更新された日付"},"createdDate":{"type":"string","format":"date","description":"Q&Aが作成された日付"}}}}}}}}}}}}}}
```
## Q\&Aを検索する
> ナレッジベース内のQ\&Aの検索およびフィルタリングができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faqs":{"post":{"tags":["FAQs"],"operationId":"searchFaqs","summary":"Q&Aを検索する","description":"ナレッジベース内のQ&Aの検索およびフィルタリングができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"searchTerm":{"type":"string","description":"リストを絞り込むためのキーワード検索クエリです。以下の方法で高度な検索が可能です。を使用できます。ANDの場合は\"TERM1 TERM2\"、ORの場合は\"TERM1 OR TERM2\"、完全一致の場合は\"TERM\"を使用します。"},"isUsed":{"type":"boolean","description":"Trueの場合、有効になっているQ&Aのみが一覧表示されます。Falseの場合、無効になっているQ&Aのみが一覧表示されます。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"リストをフィルタリングするためのハッシュタグ。複数のハッシュタグを追加できます。"},"hashtagsOperator":{"type":"string","enum":["and","or"],"description":"「AND」の場合、ハッシュタグのフィルターは複数のハッシュタグに対してANDロジックで機能します。「OR」の場合、ORロジックで機能します。"},"createdByAgent":{"type":"boolean","description":"Trueの場合、リストには管理者によって作成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。createdByAgent、answeredByMrc、autoGenerated、editedByAgentの各フィルターは互いに排他的です。これらを2つ以上同時に指定した場合は、OR条件として扱われます。"},"answeredByMrc":{"type":"boolean","description":"Trueの場合、ドキュメントから自動抽出されたQ&Aのみ、Falseの場合、その他のQ&Aのみを返します。"},"autoGenerated":{"type":"boolean","description":"Trueの場合、リストには自動生成されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。"},"editedByAgent":{"type":"boolean","description":"Trueの場合、リストには登録後にエージェントによって編集されたQ&Aのみが含まれます。Falseの場合、他のQ&Aのみが含まれます。"},"format":{"type":"string","enum":["html","text"],"description":"回答に異なるフォントサイズや文字色などのスタイル付きHTMLが含まれている場合、HTML形式で取得することでスタイルが反映された回答を得ることができます。スタイルなしのプレーンなテキストとして回答を取得したい場合は、テキスト形式を使用できます。デフォルト値はHTMLです。"},"offset":{"type":"integer","description":"オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。"},"limit":{"type":"integer","description":"1ページに返されるオブジェクトの数を設定します。最大値およびデフォルト値は1000です。"}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"offset":{"type":"integer","description":"オフセットリクエストパラメータ値"},"count":{"type":"integer","description":"指定したオブジェクト数適応後にリストされたQ&Aの総数"},"total_count":{"type":"integer","description":"フィルター適用後の結果としてのQ&Aの総数"},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Q&AのID"},"question":{"type":"string","description":"Q&Aの質問部分"},"answer":{"type":"string","description":"Q&Aの解答部分"},"hashtags":{"type":"array","items":{"type":"string"},"description":"Q&Aに追加されたハッシュタグ"},"userFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ポジティブなユーザーフィードバックの数"},"negativeCount":{"type":"integer","description":"否定的なユーザーフィードバックの数"}},"description":"ユーザーフィードバックは今後の検索クエリの結果に影響を与えます。"},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"ポジティブな管理者フィードバックの数"},"negativeCount":{"type":"integer","description":"否定的な管理者のフィードバック数"}},"description":"管理者のフィードバックは、今後のクエリに対する検索結果に影響を与えます。"},"lastUpdatedDate":{"type":"string","format":"date","description":"Q&Aが最後に更新された日付"},"createdDate":{"type":"string","format":"date","description":"Q&Aが作成された日付"}}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aを追加
> 新規のQ\&Aの追加や既存のQ\&Aの更新ができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/register_faq":{"post":{"tags":["FAQs"],"operationId":"createFaq","summary":"Q&Aを追加","description":"新規のQ&Aの追加や既存のQ&Aの更新ができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"question":{"type":"string","required":true,"description":"Q&Aの質問部分"},"similarQuestions":{"type":"array","items":{"type":"string"},"description":"類似質問"},"answer":{"type":"string","required":true,"description":"Q&Aの答えの部分です。同じ質問が既にナレッジベースにに存在する場合、答えが置き換えられます。"},"hashtags":{"type":"array","items":{"type":"string"},"description":"Q&Aにハッシュタグを追加します。"},"status":{"type":"string","enum":[true,false],"required":true,"description":"Q&AのON/OFFを設定します。ONにすると、登録したQ&Aが有効になります。"},"memo":{"type":"string","description":"Q&Aのメモ"},"target_folder_id":{"type":"string"},"allowOtherAgentsView":{"type":"boolean"},"allowOtherUsersView":{"type":"boolean"}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"status":{"type":"string","description":"登録済みQ&Aのステータス。「作成済み」はQ&Aが新たに作成されたことを意味します。「更新済み」は既存のQ&Aの回答が更新されたことを意味します。"},"id":{"type":"string","description":"登録されたQ&AのID"}}},"errors":{"type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aの更新
> 既存のQ\&Aを更新できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/register_faq":{"put":{"tags":["FAQs"],"operationId":"updateFaq","summary":"Q&Aの更新","description":"既存のQ&Aを更新できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","required":true,"description":"更新するQ&AのID"},"question":{"type":"string","description":"Q&Aの質問部分"},"similar_questions":{"type":"array","items":{"type":"string"},"description":"類似質問"},"answer":{"type":"string","description":"Q&Aの答えの部分"},"hashtags":{"type":"array","items":{"type":"string"},"description":"Q&Aにハッシュタグを追加"},"status":{"type":"string","enum":[true,false],"description":"Q&AのON/OFFを切り替えます。ONにすると、Q&Aが有効になります。"},"target_folder_id":{"type":"string"},"allowOtherAgentsView":{"type":"boolean"},"allowOtherUsersView":{"type":"boolean"}}}}}},"responses":{"200":{"description":"成功","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"status":{"type":"string","description":"更新のステータス。「更新済み」はQ&Aが正常に更新されたことを意味します。"},"id":{"type":"string","description":"更新されたQ&AのID"}}},"errors":{"type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aを削除
> このAPIを使用してQ\&Aを削除できます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/delete_faq":{"post":{"tags":["FAQs"],"operationId":"deleteFaq","summary":"Q&Aを削除","description":"このAPIを使用してQ&Aを削除できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","required":true,"description":"削除したいQ&AのID。"}}}}}},"responses":{"200":{"description":"FAQが正常に削除されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"status":{"type":"string","description":"Q&Aが正常に削除された場合は\"成功\""}}},"errors":{"type":"string"}}}}}},"404":{"description":"Q&Aデータが見つかりません","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"string","description":"Q&Aが見つからないことを示すエラーメッセージ。"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aをアップロードする
> このAPIを使用することで、tsv、csv、xlsx、zip形式で複数のQ\&Aをアップロードすることができます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/upload_faq_file":{"post":{"tags":["FAQs"],"operationId":"uploadFaqWithFile","summary":"Q&Aをアップロードする","description":"このAPIを使用することで、tsv、csv、xlsx、zip形式で複数のQ&Aをアップロードすることができます。","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"ローカルに保存されているQ&Aファイルの場所。xlsx、tsv、csv、およびzipファイルがサポートされています。"}}}}}},"responses":{"200":{"description":"FAQファイルのアップロードに成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","description":"アップロードの成功状況。"},"notUploaded":{"type":"array","items":{"type":"object","properties":{"question":{"type":"string","description":"未アップロードまたは更新されていないQ&Aの質問部分。"},"state":{"type":"string","description":"重複しているために「類似の質問」コンテンツでQ&Aがアップロードされていない場合は”down”。 同じ質問内容により既存のQ&Aが更新された場合は”up”。"}}}}}}}}},"400":{"description":"無効なパラメータです。"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&Aにフィードバック
> このAPIは、クエリによって検索されたQ\&Aに対して「フィードバックを付与する / 取り消す」ためのものです。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq_feedback":{"post":{"tags":["FAQs"],"operationId":"faqFeedback","summary":"Q&Aにフィードバック","description":"このAPIは、クエリによって検索されたQ&Aに対して「フィードバックを付与する / 取り消す」ためのものです。\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query","id","isPositive"],"properties":{"query":{"type":"string","description":"フィードバックを付与または取り消したい Q&A に紐づいている質問文。"},"id":{"type":"string","description":"そのQ&Aを識別するID。これはQ&A検索APIを実行した際のレスポンスから取得できます。"},"isPositive":{"type":"boolean","nullable":true,"description":"フィードバック内容:true → ポジティブフィードバック(肯定)、false → ネガティブフィードバック(否定)、null → フィードバックの取り消し"}}}}}},"responses":{"200":{"description":"フィードバックが正常に送信されました","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"faqTrainSearchResult":{"type":"object","properties":{"faq":{"type":"object","properties":{"id":{"type":"string","description":"フィードバック付与または取り消しの対象となったQ&AのID。(リクエストに使用したIDと同じ)"}}},"agentFeedback":{"type":"object","properties":{"positiveCount":{"type":"integer","description":"リクエスト処理後のポジティブフィードバックの総数"},"negativeCount":{"type":"integer","description":"リクエスト処理後のネガティブフィードバックの総数"}}}}}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&A クエリ履歴
> 過去に行われたQ\&A検索の履歴を、REST APIおよびAlliダッシュボードを通じて参照します。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq_histories":{"get":{"tags":["FAQs"],"operationId":"faqHistories","summary":"Q&A クエリ履歴","description":"過去に行われたQ&A検索の履歴を、REST APIおよびAlliダッシュボードを通じて参照します。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"表示する結果の数の制限(ページネーションに使用)"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"すべての結果のリストで、結果のリストを開始するインデックス(ページネーションに使用)"},{"name":"endDate","in":"query","required":false,"schema":{"type":"string"},"description":"履歴を取得したい最新の日付(YYYY-MM-DDの形式である必要があります)"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string"},"description":"履歴を取得したい最も過去の日付(YYYY-MM-DDの形式での日付)"},{"name":"order","in":"query","required":false,"schema":{"type":"string"},"description":"DESC(最新のクエリが最初に表示されることを意味)または ASC(最も古いクエリが最初に表示されることを意味)のいずれかを指定できます。"},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"},"description":"クエリに表示されるべき単語"}],"responses":{"200":{"description":"正常に取得されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"histories":{"type":"array","items":{"type":"object","properties":{"agent":{"type":"object","properties":{"id":{"type":"string","description":"クエリを行ったメンバーのID。"}}},"question":{"type":"string","description":"クエリで実際に検索された質問文。"},"answers":{"type":"array","items":{"type":"object","properties":{"faq":{"type":"object","properties":{"id":{"type":"string","description":"参照されたQ&AのID。"}}},"effectiveConfidence":{"type":"number","description":"回答の効果的な信頼度スコア。"},"confidence":{"type":"number","description":"回答データの元の信頼度スコア。"}}}}}}},"count":{"type":"integer","description":"返却されたクエリの総数。"}}},"errors":{"type":"object","nullable":true,"description":"リクエストが失敗した場合のエラー情報。"}}}}}}}}}}}
```
## Q\&Aの候補を取得する
> このAPIを使用すると、ナレッジベースの未回答の質問リストを取得できます。対象のQ\&AははQ＆A登録候補（Candidates）と呼ばれます。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq_candidates":{"get":{"tags":["FAQs"],"operationId":"faqCandidates","summary":"Q&Aの候補を取得する","description":"このAPIを使用すると、ナレッジベースの未回答の質問リストを取得できます。対象のQ&AははQ＆A登録候補（Candidates）と呼ばれます。","parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"},{"name":"hashtags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}},"description":"検索範囲を指定されたハッシュタグに限定したい場合は、ハッシュタグの配列を使用します。"},{"name":"searchTerm","in":"query","required":false,"schema":{"type":"string"},"description":"閲覧するQ&A登録候補をフィルタリングするための検索クエリです。より高度な検索を実行するには演算子を使用できます。「TERM1 TERM2」はAND、「TERM1 OR TERM2」はOR、「TERM」は完全一致となります。"},{"name":"order","in":"query","required":false,"schema":{"type":"string"},"description":"Q&A登録候補を並べ替える方法。ATTRIBUTE_[DESCまたはASC]形式を使用できます。ATTRIBUTEはFREQUENCYまたはCREATED_ATで指定することが可能です。"},{"name":"state","in":"query","required":false,"schema":{"type":"string"},"description":"Q＆A登録候補のステータスを確認する。ALLまたはACTIVEまたはARCHIVEDで指定することが可能です"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer"},"description":"オフセットを指定することで、ページ上の最初のアイテムの順位番号を指定することが可能です。"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer"},"description":"limitを指定することで、1ページに返されるオブジェクトの数が設定可能です。最大値は100です。"}],"responses":{"200":{"description":"正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"faqCandidates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"未回答の質問に対する抽出されたAnswerのID。"},"frequency":{"type":"integer","description":"未回答の質問に対しての検索頻度数の合計。。"},"textAnswer":{"type":"string","description":"アップロードされたドキュメントから質問のために抽出された回答内容。"},"state":{"type":"string","description":"Q&A登録候補のステータス。Q&A登録候補がQ&Aデータベースにまだ追加されていない場合は「ACTIVE」、Q&A登録候補が既にナレッジベースのQ＆Aに追加されている場合は「ARCHIVED」。"},"createdAt":{"type":"number","description":"Q&A登録候補が作成された時点のタイムスタンプ。"},"questions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"未回答の質問のID。"},"question":{"type":"string","description":"未回答の質問の質問文章。"},"frequency":{"type":"integer","description":"その質問が何回入力されたかの検索頻度。"},"history":{"type":"object","properties":{"id":{"type":"string","description":"未回答の質問の履歴情報のID。"}}}}}}}}},"count":{"type":"integer","description":"Q&A登録候補の総数。"}}},"errors":{"type":"object","nullable":true}}}}}}}}}}}
```
## デイリーFAQ件数
> 特定の日付範囲におけるFAQ検索の日ごとの件数。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq_daily_count":{"get":{"tags":["FAQs"],"operationId":"faqDailyCount","summary":"デイリーFAQ件数","description":"特定の日付範囲におけるFAQ検索の日ごとの件数。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string","description":"照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。"},"endDate":{"type":"string","description":"照会する日付範囲の終了日をYYYY-MM-DD形式で指定します。"}}}}}},"responses":{"200":{"description":"日毎のFAQ検索件数を正常に取得しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"dailyTotalCount":{"type":"array","description":"日付とFAQがペアになっているリスト。ここでのカウントはその日に選択されたFAQの数です。","items":{"type":"object","properties":{"date":{"type":"string","description":"YYYY-MM-DD形式の日付"},"count":{"type":"integer","description":"その日に選択されたFAQの数"}}}},"state":{"type":"string","description":"リクエストの状態"},"campaignCount":{"type":"integer","description":"キャンペーン数"}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## 日毎のFAQ分析
> 最も頻繁に質問されるQ\&Aの分析情報。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/faq_daily_analytics":{"get":{"tags":["FAQs"],"operationId":"faqDailyAnalytics","summary":"日毎のFAQ分析","description":"最も頻繁に質問されるQ&Aの分析情報。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"topN":{"type":"integer","description":"最も頻繁に質問されるQ&Aの上位N。Nの最大値は20です。Nには1、5、10、または20を使用してください。"},"startDate":{"type":"string","description":"クエリする日付範囲の開始をYYYY-MM-DD形式で指定します。"},"endDate":{"type":"string","description":"クエリする日付範囲の終了をYYYY-MM-DD形式で指定します。"}}}}}},"responses":{"200":{"description":"FAQアナリティクスの取得に成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"faqDailyAnalytics":{"type":"array","description":"FAQごとの分析情報を含むJSONオブジェクトのリスト。","items":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Q&Aが選択された合計回数。"},"totalShownCount":{"type":"integer","description":"Q&Aが表示された合計回数。"},"selectedRatio":{"type":"number","description":"Q&Aの表示回数に対する選択率"},"faq":{"type":"object","properties":{"id":{"type":"string","description":"FAQ ID"},"question":{"type":"string","description":"FAQの質問"}}},"stats":{"type":"array","description":"各日付ごとに、その日にFAQが選ばれた回数をまとめたリスト","items":{"type":"object","properties":{"date":{"type":"string","description":"YYYY-MM-DD形式の日付"},"selectedCount":{"type":"integer","description":"指定された日にFAQが選択された回数"}}}}}}}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
## Q\&A登録候補
> Q\&A登録候補に新たな質問を追加します。
```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"FAQs","description":"Highlight related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"},{"url":"https://backend.alli.ai","description":"US"}],"security":[{"ApiKeyAuth":[]},{"TokenAuth":[]},{"ProjectIdHeader":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"API-KEY","description":"認証用のAPIキー"},"TokenAuth":{"type":"http","scheme":"bearer","description":"Your token for authentication"}},"parameters":{"AgentEmailHeader":{"name":"AGENT-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するメンバーのメールアドレス"},"UserEmailHeader":{"name":"USER-EMAIL","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのメールアドレス"},"OwnUserIdHeader":{"name":"OWN-USER-ID","in":"header","required":false,"schema":{"type":"string"},"description":"任意: このリクエストに使用するユーザーのID"}}},"paths":{"/webapi/add_faq_candidates":{"post":{"tags":["FAQs"],"operationId":"addFaqCandidates","summary":"Q&A登録候補","description":"Q&A登録候補に新たな質問を追加します。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["queries"],"properties":{"queries":{"type":"array","items":{"type":"string"},"description":"Q&A登録候補に追加したい質問リスト"}}}}}},"responses":{"200":{"description":"候補者が正常に登録されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"candidates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"追加したQ＆A登録候補のID。"}}}}}},"errors":{"type":"object","nullable":true}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.allganize.ai/api-reference/ja-1/faqs.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.