Hashtags

Hashtag related APIs

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

post

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

Responses

200

正常に送信されました。

application/json

400

Invalid Parameter

post

/webapi/kb_auto_hashtag_feedback

HTTPcURLJavaScriptPython

POST /webapi/kb_auto_hashtag_feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "autoHashtagFeedbacks": [
    {
      "id": "text",
      "state": "text"
    }
  ]
}

{
  "result": [
    {
      "id": "text",
      "state": "text"
    }
  ]
}

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

get

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses

200

ハッシュタグの取得に成功しました。

application/json

get

/webapi/hashtags

HTTPcURLJavaScriptPython

GET /webapi/hashtags HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

ハッシュタグの取得に成功しました。

{
  "result": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}

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

post

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

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body

application/json

idsarrayOptional

自動ハッシュタグ付け機能の内容を取得したいドキュメントID

Responses

200

自動ハッシュタグ付け機能のリストの取得に成功しました。

application/json

400

無効なパラメーター

post

/webapi/kb_auto_hashtag

HTTPcURLJavaScriptPython

POST /webapi/kb_auto_hashtag HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "ids": []
}

{
  "result": {
    "updated": [
      {
        "id": "text",
        "autoHashtags": [
          {
            "id": "text",
            "state": "text",
            "bestConfidence": 1,
            "autoHashtag": {
              "hashtag": "text"
            }
          }
        ]
      }
    ]
  },
  "errors": {}
}