Skip to content

Commit e111b56

Browse files
committed
feat(Assistant): Add new list_mentions method
1 parent a293526 commit e111b56

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

lib/ibm_watson/assistant_v1.rb

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1213,6 +1213,46 @@ def delete_entity(workspace_id:, entity:)
12131213
nil
12141214
end
12151215
#########################
1216+
# Mentions
1217+
#########################
1218+
1219+
##
1220+
# @!method list_mentions(workspace_id:, entity:, export: nil, include_audit: nil)
1221+
# List entity mentions.
1222+
# List mentions for a contextual entity. An entity mention is an occurrence of a
1223+
# contextual entity in the context of an intent user input example.
1224+
#
1225+
# This operation is limited to 200 requests per 30 minutes. For more information,
1226+
# see **Rate limiting**.
1227+
# @param workspace_id [String] Unique identifier of the workspace.
1228+
# @param entity [String] The name of the entity.
1229+
# @param export [Boolean] Whether to include all element content in the returned data. If
1230+
# **export**=`false`, the returned data includes only information about the element
1231+
# itself. If **export**=`true`, all content, including subelements, is included.
1232+
# @param include_audit [Boolean] Whether to include the audit properties (`created` and `updated` timestamps) in
1233+
# the response.
1234+
# @return [DetailedResponse] A `DetailedResponse` object representing the response.
1235+
def list_mentions(workspace_id:, entity:, export: nil, include_audit: nil)
1236+
raise ArgumentError("workspace_id must be provided") if workspace_id.nil?
1237+
raise ArgumentError("entity must be provided") if entity.nil?
1238+
headers = {
1239+
}
1240+
params = {
1241+
"version" => @version,
1242+
"export" => export,
1243+
"include_audit" => include_audit
1244+
}
1245+
method_url = "/v1/workspaces/%s/entities/%s/mentions" % [ERB::Util.url_encode(workspace_id), ERB::Util.url_encode(entity)]
1246+
response = request(
1247+
method: "GET",
1248+
url: method_url,
1249+
headers: headers,
1250+
params: params,
1251+
accept_json: true
1252+
)
1253+
response
1254+
end
1255+
#########################
12161256
# Values
12171257
#########################
12181258

0 commit comments

Comments
 (0)