Class: Aws::KendraRanking::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::KendraRanking::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb
Overview
An API client for KendraRanking. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::KendraRanking::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_rescore_execution_plan(params = {}) ⇒ Types::CreateRescoreExecutionPlanResponse
Creates a rescore execution plan.
-
#delete_rescore_execution_plan(params = {}) ⇒ Struct
Deletes a rescore execution plan.
-
#describe_rescore_execution_plan(params = {}) ⇒ Types::DescribeRescoreExecutionPlanResponse
Gets information about a rescore execution plan.
-
#list_rescore_execution_plans(params = {}) ⇒ Types::ListRescoreExecutionPlansResponse
Lists your rescore execution plans.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a specified resource.
-
#rescore(params = {}) ⇒ Types::RescoreResult
Rescores or re-ranks search results from a search service such as OpenSearch (self managed).
-
#tag_resource(params = {}) ⇒ Struct
Adds a specified tag to a specified rescore execution plan.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a rescore execution plan.
-
#update_rescore_execution_plan(params = {}) ⇒ Struct
Updates a rescore execution plan.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 429 def initialize(*args) super end |
Instance Method Details
#create_rescore_execution_plan(params = {}) ⇒ Types::CreateRescoreExecutionPlanResponse
Creates a rescore execution plan. A rescore execution plan is an
Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API. You set the number of capacity units that you require
for Amazon Kendra Intelligent Ranking to rescore or re-rank a search
service's results.
For an example of using the CreateRescoreExecutionPlan
API,
including using the Python and Java SDKs, see Semantically ranking a
search service's results.
513 514 515 516 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 513 def create_rescore_execution_plan(params = {}, = {}) req = build_request(:create_rescore_execution_plan, params) req.send_request() end |
#delete_rescore_execution_plan(params = {}) ⇒ Struct
Deletes a rescore execution plan. A rescore execution plan is an
Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API.
537 538 539 540 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 537 def delete_rescore_execution_plan(params = {}, = {}) req = build_request(:delete_rescore_execution_plan, params) req.send_request() end |
#describe_rescore_execution_plan(params = {}) ⇒ Types::DescribeRescoreExecutionPlanResponse
Gets information about a rescore execution plan. A rescore execution
plan is an Amazon Kendra Intelligent Ranking resource used for
provisioning the Rescore
API.
584 585 586 587 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 584 def describe_rescore_execution_plan(params = {}, = {}) req = build_request(:describe_rescore_execution_plan, params) req.send_request() end |
#list_rescore_execution_plans(params = {}) ⇒ Types::ListRescoreExecutionPlansResponse
Lists your rescore execution plans. A rescore execution plan is an
Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
629 630 631 632 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 629 def list_rescore_execution_plans(params = {}, = {}) req = build_request(:list_rescore_execution_plans, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a specified resource. A rescore execution plan is an example of a resource that can have tags associated with it.
662 663 664 665 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 662 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#rescore(params = {}) ⇒ Types::RescoreResult
Rescores or re-ranks search results from a search service such as OpenSearch (self managed). You use the semantic search capabilities of Amazon Kendra Intelligent Ranking to improve the search service's results.
718 719 720 721 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 718 def rescore(params = {}, = {}) req = build_request(:rescore, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds a specified tag to a specified rescore execution plan. A rescore
execution plan is an Amazon Kendra Intelligent Ranking resource used
for provisioning the Rescore
API. If the tag already exists, the
existing value is replaced with the new value.
753 754 755 756 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 753 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from a rescore execution plan. A rescore execution plan
is an Amazon Kendra Intelligent Ranking resource used for provisioning
the Rescore
operation.
783 784 785 786 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 783 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_rescore_execution_plan(params = {}) ⇒ Struct
Updates a rescore execution plan. A rescore execution plan is an
Amazon Kendra Intelligent Ranking resource used for provisioning the
Rescore
API. You can update the number of capacity units you require
for Amazon Kendra Intelligent Ranking to rescore or re-rank a search
service's results.
831 832 833 834 |
# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/client.rb', line 831 def update_rescore_execution_plan(params = {}, = {}) req = build_request(:update_rescore_execution_plan, params) req.send_request() end |