Class: Algolia::Search::SearchForHits
- Inherits:
-
Object
- Object
- Algolia::Search::SearchForHits
- Defined in:
- lib/algolia/models/search/search_for_hits.rb
Instance Attribute Summary collapse
-
#advanced_syntax ⇒ Object
Whether to support phrase matching and excluding words from search queries.
-
#advanced_syntax_features ⇒ Object
Advanced search syntax features you want to support.
-
#allow_typos_on_numeric_tokens ⇒ Object
Whether to allow typos on numbers in the search query.
-
#alternatives_as_exact ⇒ Object
Determine which plurals and synonyms should be considered an exact matches.
-
#analytics ⇒ Object
Whether this search will be included in Analytics.
-
#analytics_tags ⇒ Object
Tags to apply to the query for [segmenting analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).
-
#around_lat_lng ⇒ Object
Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.
-
#around_lat_lng_via_ip ⇒ Object
Whether to obtain the coordinates from the request’s IP address.
-
#around_precision ⇒ Object
Returns the value of attribute around_precision.
-
#around_radius ⇒ Object
Returns the value of attribute around_radius.
-
#attribute_criteria_computed_by_min_proximity ⇒ Object
Whether the best matching attribute should be determined by minimum proximity.
-
#attributes_to_highlight ⇒ Object
Attributes to highlight.
-
#attributes_to_retrieve ⇒ Object
Attributes to include in the API response.
-
#attributes_to_snippet ⇒ Object
Attributes for which to enable snippets.
-
#click_analytics ⇒ Object
Whether to include a ‘queryID` attribute in the response.
-
#custom_ranking ⇒ Object
Attributes to use as [custom ranking](www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).
-
#decompound_query ⇒ Object
Whether to split compound words in the query into their building blocks.
-
#disable_exact_on_attributes ⇒ Object
Searchable attributes for which you want to [turn off the Exact ranking criterion](www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
-
#disable_typo_tolerance_on_attributes ⇒ Object
Attributes for which you want to turn off [typo tolerance](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
-
#distinct ⇒ Object
Returns the value of attribute distinct.
-
#enable_ab_test ⇒ Object
Whether to enable A/B testing for this search.
-
#enable_personalization ⇒ Object
Whether to enable Personalization.
-
#enable_re_ranking ⇒ Object
Whether this search will use [Dynamic Re-Ranking](www.algolia.com/doc/guides/algolia-ai/re-ranking/).
-
#enable_rules ⇒ Object
Whether to enable rules.
-
#exact_on_single_word_query ⇒ Object
Returns the value of attribute exact_on_single_word_query.
-
#facet_filters ⇒ Object
Returns the value of attribute facet_filters.
-
#faceting_after_distinct ⇒ Object
Whether faceting should be applied after deduplication with ‘distinct`.
-
#facets ⇒ Object
Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.
-
#filters ⇒ Object
Filter expression to only include items that match the filter criteria in the response.
-
#get_ranking_info ⇒ Object
Whether the search response should include detailed ranking information.
-
#highlight_post_tag ⇒ Object
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
-
#highlight_pre_tag ⇒ Object
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
-
#hits_per_page ⇒ Object
Number of hits per page.
-
#ignore_plurals ⇒ Object
Returns the value of attribute ignore_plurals.
-
#index_name ⇒ Object
Index name (case-sensitive).
-
#inside_bounding_box ⇒ Object
Returns the value of attribute inside_bounding_box.
-
#inside_polygon ⇒ Object
Coordinates of a polygon in which to search.
-
#keep_diacritics_on_characters ⇒ Object
Characters for which diacritics should be preserved.
-
#length ⇒ Object
Number of hits to retrieve (used in combination with ‘offset`).
-
#max_values_per_facet ⇒ Object
Maximum number of facet values to return for each facet.
-
#min_proximity ⇒ Object
Minimum proximity score for two matching words.
-
#min_word_sizefor1_typo ⇒ Object
Minimum number of characters a word in the search query must contain to accept matches with [one typo](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
-
#min_word_sizefor2_typos ⇒ Object
Minimum number of characters a word in the search query must contain to accept matches with [two typos](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
-
#minimum_around_radius ⇒ Object
Minimum radius (in meters) for a search around a location when ‘aroundRadius` isn’t set.
-
#mode ⇒ Object
Returns the value of attribute mode.
-
#natural_languages ⇒ Object
ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets ‘removeStopWords` and `ignorePlurals` to the list of provided languages.
-
#numeric_filters ⇒ Object
Returns the value of attribute numeric_filters.
-
#offset ⇒ Object
Position of the first hit to retrieve.
-
#optional_filters ⇒ Object
Returns the value of attribute optional_filters.
-
#optional_words ⇒ Object
Returns the value of attribute optional_words.
-
#page ⇒ Object
Page of search results to retrieve.
-
#params ⇒ Object
Search parameters as a URL-encoded query string.
-
#percentile_computation ⇒ Object
Whether to include this search when calculating processing-time percentiles.
-
#personalization_impact ⇒ Object
Impact that Personalization should have on this search.
-
#query ⇒ Object
Search query.
-
#query_languages ⇒ Object
Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
-
#query_type ⇒ Object
Returns the value of attribute query_type.
-
#ranking ⇒ Object
Determines the order in which Algolia returns your results.
-
#re_ranking_apply_filter ⇒ Object
Returns the value of attribute re_ranking_apply_filter.
-
#relevancy_strictness ⇒ Object
Relevancy threshold below which less relevant results aren’t included in the results.
-
#remove_stop_words ⇒ Object
Returns the value of attribute remove_stop_words.
-
#remove_words_if_no_results ⇒ Object
Returns the value of attribute remove_words_if_no_results.
-
#rendering_content ⇒ Object
Returns the value of attribute rendering_content.
-
#replace_synonyms_in_highlight ⇒ Object
Whether to replace a highlighted word with the matched synonym.
-
#response_fields ⇒ Object
Properties to include in the API response of ‘search` and `browse` requests.
-
#restrict_highlight_and_snippet_arrays ⇒ Object
Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
-
#restrict_searchable_attributes ⇒ Object
Restricts a search to a subset of your searchable attributes.
-
#rule_contexts ⇒ Object
Assigns a rule context to the search query.
-
#semantic_search ⇒ Object
Returns the value of attribute semantic_search.
-
#similar_query ⇒ Object
Keywords to be used instead of the search query to conduct a more broader search.
-
#snippet_ellipsis_text ⇒ Object
String used as an ellipsis indicator when a snippet is truncated.
-
#sort_facet_values_by ⇒ Object
Order in which to retrieve facet values.
-
#sum_or_filters_scores ⇒ Object
Whether to sum all filter scores.
-
#synonyms ⇒ Object
Whether to take into account an index’s synonyms for this search.
-
#tag_filters ⇒ Object
Returns the value of attribute tag_filters.
-
#type ⇒ Object
Returns the value of attribute type.
-
#typo_tolerance ⇒ Object
Returns the value of attribute typo_tolerance.
-
#user_token ⇒ Object
Unique pseudonymous or anonymous user identifier.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3).
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.types_mapping ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SearchForHits
constructor
Initializes the object.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
- #to_json(*_args) ⇒ Object
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SearchForHits
Initializes the object
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 416 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) raise( ArgumentError, "The input argument (attributes) must be a hash in `Algolia::SearchForHits` initialize method" ) end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) raise( ArgumentError, "`#{k}` is not a valid attribute in `Algolia::SearchForHits`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect ) end h[k.to_sym] = v } if attributes.key?(:params) self.params = attributes[:params] end if attributes.key?(:query) self.query = attributes[:query] end if attributes.key?(:similar_query) self.similar_query = attributes[:similar_query] end if attributes.key?(:filters) self.filters = attributes[:filters] end if attributes.key?(:facet_filters) self.facet_filters = attributes[:facet_filters] end if attributes.key?(:optional_filters) self.optional_filters = attributes[:optional_filters] end if attributes.key?(:numeric_filters) self.numeric_filters = attributes[:numeric_filters] end if attributes.key?(:tag_filters) self.tag_filters = attributes[:tag_filters] end if attributes.key?(:sum_or_filters_scores) self.sum_or_filters_scores = attributes[:sum_or_filters_scores] end if attributes.key?(:restrict_searchable_attributes) if (value = attributes[:restrict_searchable_attributes]).is_a?(Array) self.restrict_searchable_attributes = value end end if attributes.key?(:facets) if (value = attributes[:facets]).is_a?(Array) self.facets = value end end if attributes.key?(:faceting_after_distinct) self.faceting_after_distinct = attributes[:faceting_after_distinct] end if attributes.key?(:page) self.page = attributes[:page] end if attributes.key?(:offset) self.offset = attributes[:offset] end if attributes.key?(:length) self.length = attributes[:length] end if attributes.key?(:around_lat_lng) self.around_lat_lng = attributes[:around_lat_lng] end if attributes.key?(:around_lat_lng_via_ip) self.around_lat_lng_via_ip = attributes[:around_lat_lng_via_ip] end if attributes.key?(:around_radius) self.around_radius = attributes[:around_radius] end if attributes.key?(:around_precision) self.around_precision = attributes[:around_precision] end if attributes.key?(:minimum_around_radius) self.minimum_around_radius = attributes[:minimum_around_radius] end if attributes.key?(:inside_bounding_box) self.inside_bounding_box = attributes[:inside_bounding_box] end if attributes.key?(:inside_polygon) if (value = attributes[:inside_polygon]).is_a?(Array) self.inside_polygon = value end end if attributes.key?(:natural_languages) if (value = attributes[:natural_languages]).is_a?(Array) self.natural_languages = value end end if attributes.key?(:rule_contexts) if (value = attributes[:rule_contexts]).is_a?(Array) self.rule_contexts = value end end if attributes.key?(:personalization_impact) self.personalization_impact = attributes[:personalization_impact] end if attributes.key?(:user_token) self.user_token = attributes[:user_token] end if attributes.key?(:get_ranking_info) self.get_ranking_info = attributes[:get_ranking_info] end if attributes.key?(:synonyms) self.synonyms = attributes[:synonyms] end if attributes.key?(:click_analytics) self.click_analytics = attributes[:click_analytics] end if attributes.key?(:analytics) self.analytics = attributes[:analytics] end if attributes.key?(:analytics_tags) if (value = attributes[:analytics_tags]).is_a?(Array) self. = value end end if attributes.key?(:percentile_computation) self.percentile_computation = attributes[:percentile_computation] end if attributes.key?(:enable_ab_test) self.enable_ab_test = attributes[:enable_ab_test] end if attributes.key?(:attributes_to_retrieve) if (value = attributes[:attributes_to_retrieve]).is_a?(Array) self.attributes_to_retrieve = value end end if attributes.key?(:ranking) if (value = attributes[:ranking]).is_a?(Array) self.ranking = value end end if attributes.key?(:custom_ranking) if (value = attributes[:custom_ranking]).is_a?(Array) self.custom_ranking = value end end if attributes.key?(:relevancy_strictness) self.relevancy_strictness = attributes[:relevancy_strictness] end if attributes.key?(:attributes_to_highlight) if (value = attributes[:attributes_to_highlight]).is_a?(Array) self.attributes_to_highlight = value end end if attributes.key?(:attributes_to_snippet) if (value = attributes[:attributes_to_snippet]).is_a?(Array) self.attributes_to_snippet = value end end if attributes.key?(:highlight_pre_tag) self.highlight_pre_tag = attributes[:highlight_pre_tag] end if attributes.key?(:highlight_post_tag) self.highlight_post_tag = attributes[:highlight_post_tag] end if attributes.key?(:snippet_ellipsis_text) self.snippet_ellipsis_text = attributes[:snippet_ellipsis_text] end if attributes.key?(:restrict_highlight_and_snippet_arrays) self.restrict_highlight_and_snippet_arrays = attributes[:restrict_highlight_and_snippet_arrays] end if attributes.key?(:hits_per_page) self.hits_per_page = attributes[:hits_per_page] end if attributes.key?(:min_word_sizefor1_typo) self.min_word_sizefor1_typo = attributes[:min_word_sizefor1_typo] end if attributes.key?(:min_word_sizefor2_typos) self.min_word_sizefor2_typos = attributes[:min_word_sizefor2_typos] end if attributes.key?(:typo_tolerance) self.typo_tolerance = attributes[:typo_tolerance] end if attributes.key?(:allow_typos_on_numeric_tokens) self.allow_typos_on_numeric_tokens = attributes[:allow_typos_on_numeric_tokens] end if attributes.key?(:disable_typo_tolerance_on_attributes) if (value = attributes[:disable_typo_tolerance_on_attributes]).is_a?(Array) self.disable_typo_tolerance_on_attributes = value end end if attributes.key?(:ignore_plurals) self.ignore_plurals = attributes[:ignore_plurals] end if attributes.key?(:remove_stop_words) self.remove_stop_words = attributes[:remove_stop_words] end if attributes.key?(:keep_diacritics_on_characters) self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters] end if attributes.key?(:query_languages) if (value = attributes[:query_languages]).is_a?(Array) self.query_languages = value end end if attributes.key?(:decompound_query) self.decompound_query = attributes[:decompound_query] end if attributes.key?(:enable_rules) self.enable_rules = attributes[:enable_rules] end if attributes.key?(:enable_personalization) self.enable_personalization = attributes[:enable_personalization] end if attributes.key?(:query_type) self.query_type = attributes[:query_type] end if attributes.key?(:remove_words_if_no_results) self.remove_words_if_no_results = attributes[:remove_words_if_no_results] end if attributes.key?(:mode) self.mode = attributes[:mode] end if attributes.key?(:semantic_search) self.semantic_search = attributes[:semantic_search] end if attributes.key?(:advanced_syntax) self.advanced_syntax = attributes[:advanced_syntax] end if attributes.key?(:optional_words) self.optional_words = attributes[:optional_words] end if attributes.key?(:disable_exact_on_attributes) if (value = attributes[:disable_exact_on_attributes]).is_a?(Array) self.disable_exact_on_attributes = value end end if attributes.key?(:exact_on_single_word_query) self.exact_on_single_word_query = attributes[:exact_on_single_word_query] end if attributes.key?(:alternatives_as_exact) if (value = attributes[:alternatives_as_exact]).is_a?(Array) self.alternatives_as_exact = value end end if attributes.key?(:advanced_syntax_features) if (value = attributes[:advanced_syntax_features]).is_a?(Array) self.advanced_syntax_features = value end end if attributes.key?(:distinct) self.distinct = attributes[:distinct] end if attributes.key?(:replace_synonyms_in_highlight) self.replace_synonyms_in_highlight = attributes[:replace_synonyms_in_highlight] end if attributes.key?(:min_proximity) self.min_proximity = attributes[:min_proximity] end if attributes.key?(:response_fields) if (value = attributes[:response_fields]).is_a?(Array) self.response_fields = value end end if attributes.key?(:max_values_per_facet) self.max_values_per_facet = attributes[:max_values_per_facet] end if attributes.key?(:sort_facet_values_by) self.sort_facet_values_by = attributes[:sort_facet_values_by] end if attributes.key?(:attribute_criteria_computed_by_min_proximity) self.attribute_criteria_computed_by_min_proximity = attributes[:attribute_criteria_computed_by_min_proximity] end if attributes.key?(:rendering_content) self.rendering_content = attributes[:rendering_content] end if attributes.key?(:enable_re_ranking) self.enable_re_ranking = attributes[:enable_re_ranking] end if attributes.key?(:re_ranking_apply_filter) self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter] end if attributes.key?(:index_name) self.index_name = attributes[:index_name] else self.index_name = nil end if attributes.key?(:type) self.type = attributes[:type] end end |
Instance Attribute Details
#advanced_syntax ⇒ Object
Whether to support phrase matching and excluding words from search queries. Use the ‘advancedSyntaxFeatures` parameter to control which feature is supported.
176 177 178 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 176 def advanced_syntax @advanced_syntax end |
#advanced_syntax_features ⇒ Object
Advanced search syntax features you want to support. - ‘exactPhrase`. Phrases in quotes must match exactly. For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case". - `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine` matches records that contain "search" but not "engine". This setting only has an effect if `advancedSyntax` is true.
189 190 191 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 189 def advanced_syntax_features @advanced_syntax_features end |
#allow_typos_on_numeric_tokens ⇒ Object
Whether to allow typos on numbers in the search query. Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.
143 144 145 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 143 def allow_typos_on_numeric_tokens @allow_typos_on_numeric_tokens end |
#alternatives_as_exact ⇒ Object
Determine which plurals and synonyms should be considered an exact matches. By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example: - "swimsuit" and "swimsuits" are treated the same - "swimsuit" and "swimwear" are treated the same (if they are [synonyms](www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)). - ‘ignorePlurals`. Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches. - `singleWordSynonym`. Single-word synonyms, such as "NY" = "NYC", are considered exact matches. - `multiWordsSynonym`. Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
186 187 188 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 186 def alternatives_as_exact @alternatives_as_exact end |
#analytics ⇒ Object
Whether this search will be included in Analytics.
90 91 92 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 90 def analytics @analytics end |
#analytics_tags ⇒ Object
Tags to apply to the query for [segmenting analytics data](www.algolia.com/doc/guides/search-analytics/guides/segments/).
93 94 95 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 93 def @analytics_tags end |
#around_lat_lng ⇒ Object
Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the ‘aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
51 52 53 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 51 def around_lat_lng @around_lat_lng end |
#around_lat_lng_via_ip ⇒ Object
Whether to obtain the coordinates from the request’s IP address.
54 55 56 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 54 def around_lat_lng_via_ip @around_lat_lng_via_ip end |
#around_precision ⇒ Object
Returns the value of attribute around_precision.
58 59 60 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 58 def around_precision @around_precision end |
#around_radius ⇒ Object
Returns the value of attribute around_radius.
56 57 58 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 56 def around_radius @around_radius end |
#attribute_criteria_computed_by_min_proximity ⇒ Object
Whether the best matching attribute should be determined by minimum proximity. This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the ‘ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
209 210 211 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 209 def attribute_criteria_computed_by_min_proximity @attribute_criteria_computed_by_min_proximity end |
#attributes_to_highlight ⇒ Object
Attributes to highlight. By default, all searchable attributes are highlighted. Use ‘*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
114 115 116 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 114 def attributes_to_highlight @attributes_to_highlight end |
#attributes_to_retrieve ⇒ Object
Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - ‘*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `["*", "-ATTRIBUTE"]`. - The `objectID` attribute is always included.
102 103 104 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 102 def attributes_to_retrieve @attributes_to_retrieve end |
#attributes_to_snippet ⇒ Object
Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: ‘ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
117 118 119 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 117 def attributes_to_snippet @attributes_to_snippet end |
#click_analytics ⇒ Object
Whether to include a ‘queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](www.algolia.com/guides/sending-events/getting-started/).
87 88 89 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 87 def click_analytics @click_analytics end |
#custom_ranking ⇒ Object
Attributes to use as [custom ranking](www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. Modifiers - ‘asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. If you use two or more custom ranking attributes, [reduce the precision](www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
108 109 110 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 108 def custom_ranking @custom_ranking end |
#decompound_query ⇒ Object
Whether to split compound words in the query into their building blocks. For more information, see [Word segmentation](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn’t work for words with [non-spacing mark Unicode characters](www.charactercodes.net/category/non-spacing_mark). For example, ‘Gartenstühle` won’t be decompounded if the ‘ü` consists of `u` (U+0075) and `◌̈` (U+0308).
159 160 161 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 159 def decompound_query @decompound_query end |
#disable_exact_on_attributes ⇒ Object
Searchable attributes for which you want to [turn off the Exact ranking criterion](www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
181 182 183 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 181 def disable_exact_on_attributes @disable_exact_on_attributes end |
#disable_typo_tolerance_on_attributes ⇒ Object
Attributes for which you want to turn off [typo tolerance](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as ‘disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
146 147 148 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 146 def disable_typo_tolerance_on_attributes @disable_typo_tolerance_on_attributes end |
#distinct ⇒ Object
Returns the value of attribute distinct.
191 192 193 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 191 def distinct @distinct end |
#enable_ab_test ⇒ Object
Whether to enable A/B testing for this search.
99 100 101 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 99 def enable_ab_test @enable_ab_test end |
#enable_personalization ⇒ Object
Whether to enable Personalization.
165 166 167 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 165 def enable_personalization @enable_personalization end |
#enable_re_ranking ⇒ Object
Whether this search will use [Dynamic Re-Ranking](www.algolia.com/doc/guides/algolia-ai/re-ranking/). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
214 215 216 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 214 def enable_re_ranking @enable_re_ranking end |
#enable_rules ⇒ Object
Whether to enable rules.
162 163 164 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 162 def enable_rules @enable_rules end |
#exact_on_single_word_query ⇒ Object
Returns the value of attribute exact_on_single_word_query.
183 184 185 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 183 def exact_on_single_word_query @exact_on_single_word_query end |
#facet_filters ⇒ Object
Returns the value of attribute facet_filters.
21 22 23 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 21 def facet_filters @facet_filters end |
#faceting_after_distinct ⇒ Object
Whether faceting should be applied after deduplication with ‘distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It’s usually better to use ‘afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
39 40 41 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 39 def faceting_after_distinct @faceting_after_distinct end |
#facets ⇒ Object
Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character ‘*`. For more information, see [facets](www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
36 37 38 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 36 def facets @facets end |
#filters ⇒ Object
Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** ‘<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - Ranges. `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can’t use ‘NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can’t combine conjunctions (‘AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
19 20 21 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 19 def filters @filters end |
#get_ranking_info ⇒ Object
Whether the search response should include detailed ranking information.
81 82 83 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 81 def get_ranking_info @get_ranking_info end |
#highlight_post_tag ⇒ Object
HTML tag to insert after the highlighted parts in all highlighted results and snippets.
123 124 125 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 123 def highlight_post_tag @highlight_post_tag end |
#highlight_pre_tag ⇒ Object
HTML tag to insert before the highlighted parts in all highlighted results and snippets.
120 121 122 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 120 def highlight_pre_tag @highlight_pre_tag end |
#hits_per_page ⇒ Object
Number of hits per page.
132 133 134 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 132 def hits_per_page @hits_per_page end |
#ignore_plurals ⇒ Object
Returns the value of attribute ignore_plurals.
148 149 150 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 148 def ignore_plurals @ignore_plurals end |
#index_name ⇒ Object
Index name (case-sensitive).
219 220 221 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 219 def index_name @index_name end |
#inside_bounding_box ⇒ Object
Returns the value of attribute inside_bounding_box.
63 64 65 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 63 def inside_bounding_box @inside_bounding_box end |
#inside_polygon ⇒ Object
Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify ‘insideBoundingBox`.
66 67 68 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 66 def inside_polygon @inside_polygon end |
#keep_diacritics_on_characters ⇒ Object
Characters for which diacritics should be preserved. By default, Algolia removes diacritics from letters. For example, ‘é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
153 154 155 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 153 def keep_diacritics_on_characters @keep_diacritics_on_characters end |
#length ⇒ Object
Number of hits to retrieve (used in combination with ‘offset`).
48 49 50 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 48 def length @length end |
#max_values_per_facet ⇒ Object
Maximum number of facet values to return for each facet.
203 204 205 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 203 def max_values_per_facet @max_values_per_facet end |
#min_proximity ⇒ Object
Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if ‘minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
197 198 199 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 197 def min_proximity @min_proximity end |
#min_word_sizefor1_typo ⇒ Object
Minimum number of characters a word in the search query must contain to accept matches with [one typo](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
135 136 137 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 135 def min_word_sizefor1_typo @min_word_sizefor1_typo end |
#min_word_sizefor2_typos ⇒ Object
Minimum number of characters a word in the search query must contain to accept matches with [two typos](www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
138 139 140 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 138 def min_word_sizefor2_typos @min_word_sizefor2_typos end |
#minimum_around_radius ⇒ Object
Minimum radius (in meters) for a search around a location when ‘aroundRadius` isn’t set.
61 62 63 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 61 def minimum_around_radius @minimum_around_radius end |
#mode ⇒ Object
Returns the value of attribute mode.
171 172 173 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 171 def mode @mode end |
#natural_languages ⇒ Object
ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets ‘removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
69 70 71 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 69 def natural_languages @natural_languages end |
#numeric_filters ⇒ Object
Returns the value of attribute numeric_filters.
25 26 27 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 25 def numeric_filters @numeric_filters end |
#offset ⇒ Object
Position of the first hit to retrieve.
45 46 47 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 45 def offset @offset end |
#optional_filters ⇒ Object
Returns the value of attribute optional_filters.
23 24 25 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 23 def optional_filters @optional_filters end |
#optional_words ⇒ Object
Returns the value of attribute optional_words.
178 179 180 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 178 def optional_words @optional_words end |
#page ⇒ Object
Page of search results to retrieve.
42 43 44 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 42 def page @page end |
#params ⇒ Object
Search parameters as a URL-encoded query string.
10 11 12 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 10 def params @params end |
#percentile_computation ⇒ Object
Whether to include this search when calculating processing-time percentiles.
96 97 98 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 96 def percentile_computation @percentile_computation end |
#personalization_impact ⇒ Object
Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
75 76 77 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 75 def personalization_impact @personalization_impact end |
#query ⇒ Object
Search query.
13 14 15 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 13 def query @query end |
#query_languages ⇒ Object
Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries. This setting sets a default list of languages used by the ‘removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language first. **You should always specify a query language.** If you don’t specify an indexing language, the search engine uses all [supported languages](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the ‘ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
156 157 158 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 156 def query_languages @query_languages end |
#query_type ⇒ Object
Returns the value of attribute query_type.
167 168 169 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 167 def query_type @query_type end |
#ranking ⇒ Object
Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/). The tie-breaking algorithm sequentially applies each criterion in the order they’re specified. If you configure a replica index for [sorting by an attribute](www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute/), you put the sorting attribute at the top of the list. Modifiers - ‘asc("ATTRIBUTE")`. Sort the index by the values of an attribute, in ascending order. - `desc("ATTRIBUTE")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, you should test your changes in the dashboard, and by [A/B testing](www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
105 106 107 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 105 def ranking @ranking end |
#re_ranking_apply_filter ⇒ Object
Returns the value of attribute re_ranking_apply_filter.
216 217 218 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 216 def re_ranking_apply_filter @re_ranking_apply_filter end |
#relevancy_strictness ⇒ Object
Relevancy threshold below which less relevant results aren’t included in the results. You can only set ‘relevancyStrictness` on [virtual replica indices](www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
111 112 113 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 111 def relevancy_strictness @relevancy_strictness end |
#remove_stop_words ⇒ Object
Returns the value of attribute remove_stop_words.
150 151 152 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 150 def remove_stop_words @remove_stop_words end |
#remove_words_if_no_results ⇒ Object
Returns the value of attribute remove_words_if_no_results.
169 170 171 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 169 def remove_words_if_no_results @remove_words_if_no_results end |
#rendering_content ⇒ Object
Returns the value of attribute rendering_content.
211 212 213 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 211 def rendering_content @rendering_content end |
#replace_synonyms_in_highlight ⇒ Object
Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with ‘home` as a synonym for `house` and a search for `home`, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response.
194 195 196 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 194 def replace_synonyms_in_highlight @replace_synonyms_in_highlight end |
#response_fields ⇒ Object
Properties to include in the API response of ‘search` and `browse` requests. By default, all response properties are included. To reduce the response size, you can select, which attributes should be included. You can’t exclude these properties: ‘message`, `warning`, `cursor`, `serverUsed`, `indexUsed`, `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter. Don’t exclude properties that you might need in your search UI.
200 201 202 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 200 def response_fields @response_fields end |
#restrict_highlight_and_snippet_arrays ⇒ Object
Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.
129 130 131 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 129 def restrict_highlight_and_snippet_arrays @restrict_highlight_and_snippet_arrays end |
#restrict_searchable_attributes ⇒ Object
Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
33 34 35 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 33 def restrict_searchable_attributes @restrict_searchable_attributes end |
#rule_contexts ⇒ Object
Assigns a rule context to the search query. [Rule contexts](www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
72 73 74 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 72 def rule_contexts @rule_contexts end |
#semantic_search ⇒ Object
Returns the value of attribute semantic_search.
173 174 175 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 173 def semantic_search @semantic_search end |
#similar_query ⇒ Object
Keywords to be used instead of the search query to conduct a more broader search. Using the ‘similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
16 17 18 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 16 def similar_query @similar_query end |
#snippet_ellipsis_text ⇒ Object
String used as an ellipsis indicator when a snippet is truncated.
126 127 128 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 126 def snippet_ellipsis_text @snippet_ellipsis_text end |
#sort_facet_values_by ⇒ Object
Order in which to retrieve facet values. - ‘count`. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Retrieve facet values alphabetically. This setting doesn’t influence how facet values are displayed in your UI (see ‘renderingContent`). For more information, see [facet value display](www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
206 207 208 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 206 def sort_facet_values_by @sort_facet_values_by end |
#sum_or_filters_scores ⇒ Object
Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
30 31 32 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 30 def sum_or_filters_scores @sum_or_filters_scores end |
#synonyms ⇒ Object
Whether to take into account an index’s synonyms for this search.
84 85 86 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 84 def synonyms @synonyms end |
#tag_filters ⇒ Object
Returns the value of attribute tag_filters.
27 28 29 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 27 def tag_filters @tag_filters end |
#type ⇒ Object
Returns the value of attribute type.
221 222 223 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 221 def type @type end |
#typo_tolerance ⇒ Object
Returns the value of attribute typo_tolerance.
140 141 142 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 140 def typo_tolerance @typo_tolerance end |
#user_token ⇒ Object
Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
78 79 80 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 78 def user_token @user_token end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 992 def self._deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end # model else # models (e.g. Pet) or oneOf klass = Algolia::Search.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass .build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
308 309 310 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 308 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 224 def self.attribute_map { :params => :params, :query => :query, :similar_query => :similarQuery, :filters => :filters, :facet_filters => :facetFilters, :optional_filters => :optionalFilters, :numeric_filters => :numericFilters, :tag_filters => :tagFilters, :sum_or_filters_scores => :sumOrFiltersScores, :restrict_searchable_attributes => :restrictSearchableAttributes, :facets => :facets, :faceting_after_distinct => :facetingAfterDistinct, :page => :page, :offset => :offset, :length => :length, :around_lat_lng => :aroundLatLng, :around_lat_lng_via_ip => :aroundLatLngViaIP, :around_radius => :aroundRadius, :around_precision => :aroundPrecision, :minimum_around_radius => :minimumAroundRadius, :inside_bounding_box => :insideBoundingBox, :inside_polygon => :insidePolygon, :natural_languages => :naturalLanguages, :rule_contexts => :ruleContexts, :personalization_impact => :personalizationImpact, :user_token => :userToken, :get_ranking_info => :getRankingInfo, :synonyms => :synonyms, :click_analytics => :clickAnalytics, :analytics => :analytics, :analytics_tags => :analyticsTags, :percentile_computation => :percentileComputation, :enable_ab_test => :enableABTest, :attributes_to_retrieve => :attributesToRetrieve, :ranking => :ranking, :custom_ranking => :customRanking, :relevancy_strictness => :relevancyStrictness, :attributes_to_highlight => :attributesToHighlight, :attributes_to_snippet => :attributesToSnippet, :highlight_pre_tag => :highlightPreTag, :highlight_post_tag => :highlightPostTag, :snippet_ellipsis_text => :snippetEllipsisText, :restrict_highlight_and_snippet_arrays => :restrictHighlightAndSnippetArrays, :hits_per_page => :hitsPerPage, :min_word_sizefor1_typo => :minWordSizefor1Typo, :min_word_sizefor2_typos => :minWordSizefor2Typos, :typo_tolerance => :typoTolerance, :allow_typos_on_numeric_tokens => :allowTyposOnNumericTokens, :disable_typo_tolerance_on_attributes => :disableTypoToleranceOnAttributes, :ignore_plurals => :ignorePlurals, :remove_stop_words => :removeStopWords, :keep_diacritics_on_characters => :keepDiacriticsOnCharacters, :query_languages => :queryLanguages, :decompound_query => :decompoundQuery, :enable_rules => :enableRules, :enable_personalization => :enablePersonalization, :query_type => :queryType, :remove_words_if_no_results => :removeWordsIfNoResults, :mode => :mode, :semantic_search => :semanticSearch, :advanced_syntax => :advancedSyntax, :optional_words => :optionalWords, :disable_exact_on_attributes => :disableExactOnAttributes, :exact_on_single_word_query => :exactOnSingleWordQuery, :alternatives_as_exact => :alternativesAsExact, :advanced_syntax_features => :advancedSyntaxFeatures, :distinct => :distinct, :replace_synonyms_in_highlight => :replaceSynonymsInHighlight, :min_proximity => :minProximity, :response_fields => :responseFields, :max_values_per_facet => :maxValuesPerFacet, :sort_facet_values_by => :sortFacetValuesBy, :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity, :rendering_content => :renderingContent, :enable_re_ranking => :enableReRanking, :re_ranking_apply_filter => :reRankingApplyFilter, :index_name => :indexName, :type => :type } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 965 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} types_mapping.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash[key.to_sym] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_all_of ⇒ Object
List of class defined in allOf (OpenAPI v3)
407 408 409 410 411 412 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 407 def self.openapi_all_of [ :"SearchForHitsOptions", :"SearchParams" ] end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
397 398 399 400 401 402 403 404 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 397 def self.openapi_nullable Set.new( [ :inside_bounding_box, :optional_words ] ) end |
.types_mapping ⇒ Object
Attribute type mapping.
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 313 def self.types_mapping { :params => :"String", :query => :"String", :similar_query => :"String", :filters => :"String", :facet_filters => :"FacetFilters", :optional_filters => :"OptionalFilters", :numeric_filters => :"NumericFilters", :tag_filters => :"TagFilters", :sum_or_filters_scores => :"Boolean", :restrict_searchable_attributes => :"Array<String>", :facets => :"Array<String>", :faceting_after_distinct => :"Boolean", :page => :"Integer", :offset => :"Integer", :length => :"Integer", :around_lat_lng => :"String", :around_lat_lng_via_ip => :"Boolean", :around_radius => :"AroundRadius", :around_precision => :"AroundPrecision", :minimum_around_radius => :"Integer", :inside_bounding_box => :"InsideBoundingBox", :inside_polygon => :"Array<Array<Float>>", :natural_languages => :"Array<SupportedLanguage>", :rule_contexts => :"Array<String>", :personalization_impact => :"Integer", :user_token => :"String", :get_ranking_info => :"Boolean", :synonyms => :"Boolean", :click_analytics => :"Boolean", :analytics => :"Boolean", :analytics_tags => :"Array<String>", :percentile_computation => :"Boolean", :enable_ab_test => :"Boolean", :attributes_to_retrieve => :"Array<String>", :ranking => :"Array<String>", :custom_ranking => :"Array<String>", :relevancy_strictness => :"Integer", :attributes_to_highlight => :"Array<String>", :attributes_to_snippet => :"Array<String>", :highlight_pre_tag => :"String", :highlight_post_tag => :"String", :snippet_ellipsis_text => :"String", :restrict_highlight_and_snippet_arrays => :"Boolean", :hits_per_page => :"Integer", :min_word_sizefor1_typo => :"Integer", :min_word_sizefor2_typos => :"Integer", :typo_tolerance => :"TypoTolerance", :allow_typos_on_numeric_tokens => :"Boolean", :disable_typo_tolerance_on_attributes => :"Array<String>", :ignore_plurals => :"IgnorePlurals", :remove_stop_words => :"RemoveStopWords", :keep_diacritics_on_characters => :"String", :query_languages => :"Array<SupportedLanguage>", :decompound_query => :"Boolean", :enable_rules => :"Boolean", :enable_personalization => :"Boolean", :query_type => :"QueryType", :remove_words_if_no_results => :"RemoveWordsIfNoResults", :mode => :"Mode", :semantic_search => :"SemanticSearch", :advanced_syntax => :"Boolean", :optional_words => :"OptionalWords", :disable_exact_on_attributes => :"Array<String>", :exact_on_single_word_query => :"ExactOnSingleWordQuery", :alternatives_as_exact => :"Array<AlternativesAsExact>", :advanced_syntax_features => :"Array<AdvancedSyntaxFeatures>", :distinct => :"Distinct", :replace_synonyms_in_highlight => :"Boolean", :min_proximity => :"Integer", :response_fields => :"Array<String>", :max_values_per_facet => :"Integer", :sort_facet_values_by => :"String", :attribute_criteria_computed_by_min_proximity => :"Boolean", :rendering_content => :"RenderingContent", :enable_re_ranking => :"Boolean", :re_ranking_apply_filter => :"ReRankingApplyFilter", :index_name => :"String", :type => :"SearchTypeDefault" } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 788 def ==(other) return true if self.equal?(other) self.class == other.class && params == other.params && query == other.query && similar_query == other.similar_query && filters == other.filters && facet_filters == other.facet_filters && optional_filters == other.optional_filters && numeric_filters == other.numeric_filters && tag_filters == other.tag_filters && sum_or_filters_scores == other.sum_or_filters_scores && restrict_searchable_attributes == other.restrict_searchable_attributes && facets == other.facets && faceting_after_distinct == other.faceting_after_distinct && page == other.page && offset == other.offset && length == other.length && around_lat_lng == other.around_lat_lng && around_lat_lng_via_ip == other.around_lat_lng_via_ip && around_radius == other.around_radius && around_precision == other.around_precision && minimum_around_radius == other.minimum_around_radius && inside_bounding_box == other.inside_bounding_box && inside_polygon == other.inside_polygon && natural_languages == other.natural_languages && rule_contexts == other.rule_contexts && personalization_impact == other.personalization_impact && user_token == other.user_token && get_ranking_info == other.get_ranking_info && synonyms == other.synonyms && click_analytics == other.click_analytics && analytics == other.analytics && == other. && percentile_computation == other.percentile_computation && enable_ab_test == other.enable_ab_test && attributes_to_retrieve == other.attributes_to_retrieve && ranking == other.ranking && custom_ranking == other.custom_ranking && relevancy_strictness == other.relevancy_strictness && attributes_to_highlight == other.attributes_to_highlight && attributes_to_snippet == other.attributes_to_snippet && highlight_pre_tag == other.highlight_pre_tag && highlight_post_tag == other.highlight_post_tag && snippet_ellipsis_text == other.snippet_ellipsis_text && restrict_highlight_and_snippet_arrays == other.restrict_highlight_and_snippet_arrays && hits_per_page == other.hits_per_page && min_word_sizefor1_typo == other.min_word_sizefor1_typo && min_word_sizefor2_typos == other.min_word_sizefor2_typos && typo_tolerance == other.typo_tolerance && allow_typos_on_numeric_tokens == other.allow_typos_on_numeric_tokens && disable_typo_tolerance_on_attributes == other.disable_typo_tolerance_on_attributes && ignore_plurals == other.ignore_plurals && remove_stop_words == other.remove_stop_words && keep_diacritics_on_characters == other.keep_diacritics_on_characters && query_languages == other.query_languages && decompound_query == other.decompound_query && enable_rules == other.enable_rules && enable_personalization == other.enable_personalization && query_type == other.query_type && remove_words_if_no_results == other.remove_words_if_no_results && mode == other.mode && semantic_search == other.semantic_search && advanced_syntax == other.advanced_syntax && optional_words == other.optional_words && disable_exact_on_attributes == other.disable_exact_on_attributes && exact_on_single_word_query == other.exact_on_single_word_query && alternatives_as_exact == other.alternatives_as_exact && advanced_syntax_features == other.advanced_syntax_features && distinct == other.distinct && replace_synonyms_in_highlight == other.replace_synonyms_in_highlight && min_proximity == other.min_proximity && response_fields == other.response_fields && max_values_per_facet == other.max_values_per_facet && sort_facet_values_by == other.sort_facet_values_by && attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity && rendering_content == other.rendering_content && enable_re_ranking == other.enable_re_ranking && re_ranking_apply_filter == other.re_ranking_apply_filter && index_name == other.index_name && type == other.type end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 1071 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to?(:to_hash) value.to_hash else value end end |
#eql?(other) ⇒ Boolean
873 874 875 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 873 def eql?(other) self == other end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 879 def hash [ params, query, similar_query, filters, facet_filters, optional_filters, numeric_filters, tag_filters, sum_or_filters_scores, restrict_searchable_attributes, facets, faceting_after_distinct, page, offset, length, around_lat_lng, around_lat_lng_via_ip, around_radius, around_precision, minimum_around_radius, inside_bounding_box, inside_polygon, natural_languages, rule_contexts, personalization_impact, user_token, get_ranking_info, synonyms, click_analytics, analytics, , percentile_computation, enable_ab_test, attributes_to_retrieve, ranking, custom_ranking, relevancy_strictness, attributes_to_highlight, attributes_to_snippet, highlight_pre_tag, highlight_post_tag, snippet_ellipsis_text, restrict_highlight_and_snippet_arrays, hits_per_page, min_word_sizefor1_typo, min_word_sizefor2_typos, typo_tolerance, allow_typos_on_numeric_tokens, disable_typo_tolerance_on_attributes, ignore_plurals, remove_stop_words, keep_diacritics_on_characters, query_languages, decompound_query, enable_rules, enable_personalization, query_type, remove_words_if_no_results, mode, semantic_search, advanced_syntax, optional_words, disable_exact_on_attributes, exact_on_single_word_query, alternatives_as_exact, advanced_syntax_features, distinct, replace_synonyms_in_highlight, min_proximity, response_fields, max_values_per_facet, sort_facet_values_by, attribute_criteria_computed_by_min_proximity, rendering_content, enable_re_ranking, re_ranking_apply_filter, index_name, type ].hash end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
1042 1043 1044 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 1042 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 1052 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_json(*_args) ⇒ Object
1046 1047 1048 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 1046 def to_json(*_args) to_hash.to_json end |
#to_s ⇒ String
Returns the string representation of the object
1036 1037 1038 |
# File 'lib/algolia/models/search/search_for_hits.rb', line 1036 def to_s to_hash.to_s end |