« blib/lib/Paws/Kendra/QuerySuggestionsBlockListSummary.pm
↑ Summary
blib/lib/Paws/Kendra/RelevanceFeedback.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::Relevance; | ||
| 3 | use Moose; | ||
| 4 | has Duration => (is => 'ro', isa => 'Str'); | ||
| 5 | has Freshness => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Importance => (is => 'ro', isa => 'Int'); | ||
| 7 | has RankOrder => (is => 'ro', isa => 'Str'); | ||
| 8 | has ValueImportanceMap => (is => 'ro', isa => 'Paws::Kendra::ValueImportanceMap'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Kendra::Relevance | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Kendra::Relevance object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Duration => $value, ..., ValueImportanceMap => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Relevance object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Duration | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Provides information for manually tuning the relevance of a field in a | ||
| 41 | search. When a query includes terms that match the field, the results | ||
| 42 | are given a boost in the response based on these tuning parameters. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Duration => Str | ||
| 48 | |||
| 49 | Specifies the time period that the boost applies to. For example, to | ||
| 50 | make the boost apply to documents with the field value within the last | ||
| 51 | month, you would use "2628000s". Once the field value is beyond the | ||
| 52 | specified range, the effect of the boost drops off. The higher the | ||
| 53 | importance, the faster the effect drops off. If you don't specify a | ||
| 54 | value, the default is 3 months. The value of the field is a numeric | ||
| 55 | string followed by the character "s", for example "86400s" for one day, | ||
| 56 | or "604800s" for one week. | ||
| 57 | |||
| 58 | Only applies to C<DATE> fields. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Freshness => Bool | ||
| 62 | |||
| 63 | Indicates that this field determines how "fresh" a document is. For | ||
| 64 | example, if document 1 was created on November 5, and document 2 was | ||
| 65 | created on October 31, document 1 is "fresher" than document 2. You can | ||
| 66 | only set the C<Freshness> field on one C<DATE> type field. Only applies | ||
| 67 | to C<DATE> fields. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Importance => Int | ||
| 71 | |||
| 72 | The relative importance of the field in the search. Larger numbers | ||
| 73 | provide more of a boost than smaller numbers. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 RankOrder => Str | ||
| 77 | |||
| 78 | Determines how values should be interpreted. | ||
| 79 | |||
| 80 | When the C<RankOrder> field is C<ASCENDING>, higher numbers are better. | ||
| 81 | For example, a document with a rating score of 10 is higher ranking | ||
| 82 | than a document with a rating score of 1. | ||
| 83 | |||
| 84 | When the C<RankOrder> field is C<DESCENDING>, lower numbers are better. | ||
| 85 | For example, in a task tracking application, a priority 1 task is more | ||
| 86 | important than a priority 5 task. | ||
| 87 | |||
| 88 | Only applies to C<LONG> and C<DOUBLE> fields. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 ValueImportanceMap => L<Paws::Kendra::ValueImportanceMap> | ||
| 92 | |||
| 93 | A list of values that should be given a different boost when they | ||
| 94 | appear in the result list. For example, if you are boosting a field | ||
| 95 | called "department," query terms that match the department field are | ||
| 96 | boosted in the result. However, you can add entries from the department | ||
| 97 | field to boost documents with those values higher. | ||
| 98 | |||
| 99 | For example, you can add entries to the map with names of departments. | ||
| 100 | If you add "HR",5 and "Legal",3 those departments are given special | ||
| 101 | attention when they appear in the metadata of a document. When those | ||
| 102 | terms appear they are given the specified importance instead of the | ||
| 103 | regular importance for the boost. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |