176 lines
6.2 KiB
C++
176 lines
6.2 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/kendra/Kendra_EXPORTS.h>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace kendra
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Provides information about how a custom index field is used during a
|
|
* search.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search">AWS API
|
|
* Reference</a></p>
|
|
*/
|
|
class AWS_KENDRA_API Search
|
|
{
|
|
public:
|
|
Search();
|
|
Search(Aws::Utils::Json::JsonView jsonValue);
|
|
Search& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>Indicates that the field can be used to create search facets, a count of
|
|
* results for each value in the field. The default is <code>false</code> .</p>
|
|
*/
|
|
inline bool GetFacetable() const{ return m_facetable; }
|
|
|
|
/**
|
|
* <p>Indicates that the field can be used to create search facets, a count of
|
|
* results for each value in the field. The default is <code>false</code> .</p>
|
|
*/
|
|
inline bool FacetableHasBeenSet() const { return m_facetableHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates that the field can be used to create search facets, a count of
|
|
* results for each value in the field. The default is <code>false</code> .</p>
|
|
*/
|
|
inline void SetFacetable(bool value) { m_facetableHasBeenSet = true; m_facetable = value; }
|
|
|
|
/**
|
|
* <p>Indicates that the field can be used to create search facets, a count of
|
|
* results for each value in the field. The default is <code>false</code> .</p>
|
|
*/
|
|
inline Search& WithFacetable(bool value) { SetFacetable(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Determines whether the field is used in the search. If the
|
|
* <code>Searchable</code> field is <code>true</code>, you can use relevance tuning
|
|
* to manually tune how Amazon Kendra weights the field in the search. The default
|
|
* is <code>true</code> for string fields and <code>false</code> for number and
|
|
* date fields.</p>
|
|
*/
|
|
inline bool GetSearchable() const{ return m_searchable; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is used in the search. If the
|
|
* <code>Searchable</code> field is <code>true</code>, you can use relevance tuning
|
|
* to manually tune how Amazon Kendra weights the field in the search. The default
|
|
* is <code>true</code> for string fields and <code>false</code> for number and
|
|
* date fields.</p>
|
|
*/
|
|
inline bool SearchableHasBeenSet() const { return m_searchableHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is used in the search. If the
|
|
* <code>Searchable</code> field is <code>true</code>, you can use relevance tuning
|
|
* to manually tune how Amazon Kendra weights the field in the search. The default
|
|
* is <code>true</code> for string fields and <code>false</code> for number and
|
|
* date fields.</p>
|
|
*/
|
|
inline void SetSearchable(bool value) { m_searchableHasBeenSet = true; m_searchable = value; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is used in the search. If the
|
|
* <code>Searchable</code> field is <code>true</code>, you can use relevance tuning
|
|
* to manually tune how Amazon Kendra weights the field in the search. The default
|
|
* is <code>true</code> for string fields and <code>false</code> for number and
|
|
* date fields.</p>
|
|
*/
|
|
inline Search& WithSearchable(bool value) { SetSearchable(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Determines whether the field is returned in the query response. The default
|
|
* is <code>true</code>.</p>
|
|
*/
|
|
inline bool GetDisplayable() const{ return m_displayable; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is returned in the query response. The default
|
|
* is <code>true</code>.</p>
|
|
*/
|
|
inline bool DisplayableHasBeenSet() const { return m_displayableHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is returned in the query response. The default
|
|
* is <code>true</code>.</p>
|
|
*/
|
|
inline void SetDisplayable(bool value) { m_displayableHasBeenSet = true; m_displayable = value; }
|
|
|
|
/**
|
|
* <p>Determines whether the field is returned in the query response. The default
|
|
* is <code>true</code>.</p>
|
|
*/
|
|
inline Search& WithDisplayable(bool value) { SetDisplayable(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Determines whether the field can be used to sort the results of a query. If
|
|
* you specify sorting on a field that does not have <code>Sortable</code> set to
|
|
* <code>true</code>, Amazon Kendra returns an exception. The default is
|
|
* <code>false</code>.</p>
|
|
*/
|
|
inline bool GetSortable() const{ return m_sortable; }
|
|
|
|
/**
|
|
* <p>Determines whether the field can be used to sort the results of a query. If
|
|
* you specify sorting on a field that does not have <code>Sortable</code> set to
|
|
* <code>true</code>, Amazon Kendra returns an exception. The default is
|
|
* <code>false</code>.</p>
|
|
*/
|
|
inline bool SortableHasBeenSet() const { return m_sortableHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Determines whether the field can be used to sort the results of a query. If
|
|
* you specify sorting on a field that does not have <code>Sortable</code> set to
|
|
* <code>true</code>, Amazon Kendra returns an exception. The default is
|
|
* <code>false</code>.</p>
|
|
*/
|
|
inline void SetSortable(bool value) { m_sortableHasBeenSet = true; m_sortable = value; }
|
|
|
|
/**
|
|
* <p>Determines whether the field can be used to sort the results of a query. If
|
|
* you specify sorting on a field that does not have <code>Sortable</code> set to
|
|
* <code>true</code>, Amazon Kendra returns an exception. The default is
|
|
* <code>false</code>.</p>
|
|
*/
|
|
inline Search& WithSortable(bool value) { SetSortable(value); return *this;}
|
|
|
|
private:
|
|
|
|
bool m_facetable;
|
|
bool m_facetableHasBeenSet;
|
|
|
|
bool m_searchable;
|
|
bool m_searchableHasBeenSet;
|
|
|
|
bool m_displayable;
|
|
bool m_displayableHasBeenSet;
|
|
|
|
bool m_sortable;
|
|
bool m_sortableHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace kendra
|
|
} // namespace Aws
|