diff --git a/specs/abtesting/common/parameters.yml b/specs/abtesting/common/parameters.yml index 264d5b7650..e2d6200d31 100644 --- a/specs/abtesting/common/parameters.yml +++ b/specs/abtesting/common/parameters.yml @@ -10,7 +10,7 @@ ID: # misc index: type: string - description: A/B test index. + description: Index name of the A/B test variant (case-sensitive). example: 'delcourt_production' abTestID: diff --git a/specs/common/parameters.yml b/specs/common/parameters.yml index 36952fbb3e..8be4ac18a8 100644 --- a/specs/common/parameters.yml +++ b/specs/common/parameters.yml @@ -137,7 +137,7 @@ id: indexName: type: string example: products - description: Index name. + description: Index name (case-sensitive). hitsPerPage: type: integer diff --git a/specs/common/schemas/IndexSettings.yml b/specs/common/schemas/IndexSettings.yml index 33dfec6307..8cb0b8d5e3 100644 --- a/specs/common/schemas/IndexSettings.yml +++ b/specs/common/schemas/IndexSettings.yml @@ -22,9 +22,10 @@ baseIndexSettings: description: | Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). - Facets are ways to categorize search results based on attributes. - Facets can be used to let user filter search results. + Facets are attributes that let you categorize search results. + They can be used for filtering search results. By default, no attribute is used for faceting. + Attribute names are case-sensitive. **Modifiers** @@ -84,6 +85,7 @@ baseIndexSettings: This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. + Attribute names are case-sensitive. default: [] x-categories: - Attributes @@ -106,6 +108,7 @@ baseIndexSettings: Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. + Attribute names are case-sensitive. type: array items: type: string @@ -119,7 +122,9 @@ baseIndexSettings: items: type: string example: [description] - description: Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. + description: | + Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. + Attribute names are case-sensitive. default: [] x-categories: - Languages @@ -130,6 +135,7 @@ baseIndexSettings: - name description: | Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). + Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, "firefighter". @@ -164,7 +170,9 @@ baseIndexSettings: type: string example: - sku - description: Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). + description: | + Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). + Attribute names are case-sensitive. default: [] x-categories: - Query strategy @@ -182,6 +190,7 @@ baseIndexSettings: type: string description: | Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). + Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. @@ -221,7 +230,7 @@ baseIndexSettings: - unordered(text) - emails.personal description: | - Attributes used for searching. + Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. @@ -260,6 +269,7 @@ baseIndexSettings: attributeForDistinct: description: | Attribute that should be used to establish groups of results. + Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control @@ -286,6 +296,7 @@ indexSettingsAsSearchParams: 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"]`. @@ -335,6 +346,7 @@ indexSettingsAsSearchParams: - asc(price) description: | Attributes to use as [custom ranking](https://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. @@ -376,6 +388,7 @@ indexSettingsAsSearchParams: 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. @@ -392,6 +405,7 @@ indexSettingsAsSearchParams: - description description: | 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. @@ -461,6 +475,7 @@ indexSettingsAsSearchParams: - sku description: | Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). + Attribute names are case-sensitive. Returning only exact matches can help when: @@ -584,6 +599,7 @@ indexSettingsAsSearchParams: - description description: | Searchable attributes for which you want to [turn off the Exact ranking criterion](https://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 likelyhood of an exact match is high, such as product descriptions. @@ -741,7 +757,7 @@ maxFacetHits: reRankingApplyFilter: description: | - Restrict [Dynamic Re-ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters. + Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters. oneOf: - $ref: './SearchParams.yml#/listOfSearchFilters' - type: string diff --git a/specs/common/schemas/SearchParams.yml b/specs/common/schemas/SearchParams.yml index 017c19ab50..2f6a415bdd 100644 --- a/specs/common/schemas/SearchParams.yml +++ b/specs/common/schemas/SearchParams.yml @@ -5,6 +5,7 @@ searchParams: searchParamsObject: title: Search parameters as object + description: Each parameter value, including the `query` must not be larger than 512 bytes. allOf: - $ref: '#/baseSearchParams' - $ref: '../../common/schemas/IndexSettings.yml#/indexSettingsAsSearchParams' @@ -69,7 +70,9 @@ baseSearchParamsWithoutQuery: items: type: string example: [title, author] - description: Restricts a search to a subset of your searchable attributes. + description: | + Restricts a search to a subset of your searchable attributes. + Attribute names are case-sensitive. default: [] x-categories: - Filtering @@ -132,7 +135,7 @@ baseSearchParamsWithoutQuery: naturalLanguages: type: array items: - type: string + $ref: './IndexSettings.yml#/supportedLanguage' description: | ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): @@ -335,9 +338,9 @@ insideBoundingBox: type: array items: type: array + minItems: 4 + maxItems: 4 items: - minItems: 4 - maxItems: 4 type: number format: double description: | @@ -357,9 +360,9 @@ insidePolygon: type: array items: type: array + minItems: 6 + maxItems: 20000 items: - minItems: 6 - maxItems: 20000 type: number format: double description: | @@ -368,7 +371,7 @@ insidePolygon: 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](https://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`. + This parameter is ignored if you also specify `insideBoundingBox`. example: - [47.3165, 4.9665, 47.3424, 5.0201, 47.32, 4.9] - [40.9234, 2.1185, 38.6430, 1.9916, 39.2587, 2.0104] diff --git a/specs/ingestion/common/schemas/destination.yml b/specs/ingestion/common/schemas/destination.yml index 3df3f6ebb5..b4b13a7311 100644 --- a/specs/ingestion/common/schemas/destination.yml +++ b/specs/ingestion/common/schemas/destination.yml @@ -128,7 +128,7 @@ DestinationIndexName: properties: indexName: type: string - description: Algolia index name. + description: Algolia index name (case-sensitive). recordType: $ref: '#/RecordType' attributesToExclude: diff --git a/specs/insights/common/schemas/EventAttributes.yml b/specs/insights/common/schemas/EventAttributes.yml index c7a4186e0d..b36bdc04ed 100644 --- a/specs/insights/common/schemas/EventAttributes.yml +++ b/specs/insights/common/schemas/EventAttributes.yml @@ -13,7 +13,7 @@ eventName: index: type: string - description: Index name to which the event's items belong. + description: Index name (case-sensitive) to which the event's items belong. example: YourIndexName userToken: diff --git a/specs/query-suggestions/common/schemas/QuerySuggestionsConfiguration.yml b/specs/query-suggestions/common/schemas/QuerySuggestionsConfiguration.yml index 73a79c4081..b8b335af11 100644 --- a/specs/query-suggestions/common/schemas/QuerySuggestionsConfiguration.yml +++ b/specs/query-suggestions/common/schemas/QuerySuggestionsConfiguration.yml @@ -69,7 +69,7 @@ SourceIndex: properties: indexName: type: string - description: Name of the Algolia index to use as source for query suggestions. + description: Name of the Algolia index (case-sensitive) to use as source for query suggestions. example: products replicas: type: boolean diff --git a/specs/query-suggestions/common/schemas/QuerySuggestionsIndexName.yml b/specs/query-suggestions/common/schemas/QuerySuggestionsIndexName.yml index eb889ad89b..43881b00e2 100644 --- a/specs/query-suggestions/common/schemas/QuerySuggestionsIndexName.yml +++ b/specs/query-suggestions/common/schemas/QuerySuggestionsIndexName.yml @@ -1,4 +1,4 @@ title: indexName type: string -description: Name of the Query Suggestions index. +description: Name of the Query Suggestions index (case-sensitive). example: products_query_suggestions diff --git a/specs/search/paths/objects/multipleBatch.yml b/specs/search/paths/objects/multipleBatch.yml index db4ef88867..33fba3b753 100644 --- a/specs/search/paths/objects/multipleBatch.yml +++ b/specs/search/paths/objects/multipleBatch.yml @@ -31,9 +31,7 @@ post: type: object description: Operation arguments (varies with specified `action`). indexName: - type: string - description: Index to target for this operation. - example: 'index1' + $ref: '../../../common/parameters.yml#/indexName' required: - action - body diff --git a/tests/CTS/requests/search/search.json b/tests/CTS/requests/search/search.json index 1cd86bf182..6f7329a7ea 100644 --- a/tests/CTS/requests/search/search.json +++ b/tests/CTS/requests/search/search.json @@ -443,7 +443,7 @@ "minWordSizefor2Typos": 0, "minimumAroundRadius": 1, "naturalLanguages": [ - "" + "fr" ], "numericFilters": [ "" @@ -618,7 +618,7 @@ "minWordSizefor2Typos": 0, "minimumAroundRadius": 1, "naturalLanguages": [ - "" + "fr" ], "numericFilters": [ ""