# Hashtags

Hashtag related APIs

## ナレッジベースの自動ハッシュタグフィードバック(分類)

> このAPIを使用すると、ドキュメントに対する分類ハッシュタグを承認または拒否することができます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"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/kb_auto_hashtag_feedback":{"post":{"tags":["hashtags"],"operationId":"kbAutoHashtagFeedback","summary":"ナレッジベースの自動ハッシュタグフィードバック(分類)","description":"このAPIを使用すると、ドキュメントに対する分類ハッシュタグを承認または拒否することができます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoHashtagFeedbacks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"更新するハッシュタグのID"},"state":{"type":"string","description":"ハッシュタグに設定する状態を指定します。'accepted'、'declined'、'suggested' のいずれかです。"}}}}}}}}},"responses":{"200":{"description":"正常に送信されました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"更新されたハッシュタグのID。"},"state":{"type":"string","description":"ハッシュタグの新しい状態。'accepted'、'declined'、'suggested'のいずれかになります。"}}}}}}}}},"400":{"description":"Invalid Parameter"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## すべてのハッシュタグを取得する

> FAQおよびドキュメントの両方から、使用頻度と共にすべてのハッシュタグの情報を取得します。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"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/hashtags":{"get":{"tags":["hashtags"],"operationId":"getHashtags","summary":"すべてのハッシュタグを取得する","description":"FAQおよびドキュメントの両方から、使用頻度と共にすべてのハッシュタグの情報を取得します。","responses":{"200":{"description":"ハッシュタグの取得に成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","additionalProperties":{"type":"integer"},"description":"ハッシュタグ名とその使用回数のマッピング"}}}}}}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```

## ドキュメントへの自動ハッシュタグ（分類）機能の内容をリストで取得する

> このAPIを使用すると、ドキュメントに対する分類キーワードを含むハッシュタグのリストを取得できます。

```json
{"openapi":"3.1.0","info":{"title":"Alli API Documentation","version":"1.0.0"},"tags":[{"name":"hashtags","description":"Hashtag related APIs"}],"servers":[{"url":"https://backend-ja.alli.ai","description":"JA"}],"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/kb_auto_hashtag":{"post":{"tags":["hashtags"],"operationId":"kbAutoHashtag","summary":"ドキュメントへの自動ハッシュタグ（分類）機能の内容をリストで取得する","description":"このAPIを使用すると、ドキュメントに対する分類キーワードを含むハッシュタグのリストを取得できます。","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"自動ハッシュタグ付け機能の内容を取得したいドキュメントID"}}}}}},"responses":{"200":{"description":"自動ハッシュタグ付け機能のリストの取得に成功しました。","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ハッシュタグが対応するドキュメントのID"},"autoHashtags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ハッシュタグのID"},"state":{"type":"string","description":"ハッシュタグのステータス：「推奨」「承認」「却下」のいずれか。"},"bestConfidence":{"type":"number","description":"0から1までのこの自動生成されたハッシュタグの信頼度"},"autoHashtag":{"type":"object","properties":{"hashtag":{"type":"string","description":"ダッシュボードに表示されるハッシュタグの文字列値"}}}}}}}}}}},"errors":{"type":"object","nullable":true}}}}}},"400":{"description":"無効なパラメーター"}},"parameters":[{"$ref":"#/components/parameters/AgentEmailHeader"},{"$ref":"#/components/parameters/UserEmailHeader"},{"$ref":"#/components/parameters/OwnUserIdHeader"}]}}}}
```