Skip to content

Commit

Permalink
fix(specs): remove models from ingestion specs [skip-bc] (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3774

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
  • Loading branch information
algolia-bot and shortcuts committed Sep 19, 2024
1 parent fd1a636 commit 91809c4
Show file tree
Hide file tree
Showing 34 changed files with 502 additions and 224 deletions.
2 changes: 2 additions & 0 deletions packages/algoliasearch/builds/models.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import type {
AutomaticFacetFilter,
AutomaticFacetFilters,
BaseSearchParams,
BaseIndexSettings,
BaseSearchParamsWithoutQuery,
BaseSearchResponse,
BooleanString,
Expand Down Expand Up @@ -97,6 +98,7 @@ export {
AutomaticFacetFilter,
AutomaticFacetFilters,
BaseSearchParams,
BaseIndexSettings,
BaseSearchParamsWithoutQuery,
BaseSearchResponse,
BooleanString,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,15 @@ import type { AlternativesAsExact } from './alternativesAsExact';
import type { Distinct } from './distinct';
import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
import type { IgnorePlurals } from './ignorePlurals';
import type { Mode } from './mode';
import type { QueryType } from './queryType';
import type { ReRankingApplyFilter } from './reRankingApplyFilter';
import type { RemoveStopWords } from './removeStopWords';
import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
import type { RenderingContent } from './renderingContent';
import type { SemanticSearch } from './semanticSearch';
import type { SupportedLanguage } from './supportedLanguage';
import type { TypoTolerance } from './typoTolerance';

export type IndexSettingsAsSearchParams = {
export type BaseRecommendIndexSettings = {
/**
* 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.
*/
Expand All @@ -26,11 +24,6 @@ export type IndexSettingsAsSearchParams = {
*/
ranking?: string[];

/**
* 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. 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](https://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.
*/
customRanking?: string[];

/**
* Relevancy threshold below which less relevant results aren\'t included in the results. You can only set `relevancyStrictness` on [virtual replica indices](https://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.
*/
Expand Down Expand Up @@ -66,11 +59,6 @@ export type IndexSettingsAsSearchParams = {
*/
restrictHighlightAndSnippetArrays?: boolean;

/**
* Number of hits per page.
*/
hitsPerPage?: number;

/**
* Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
*/
Expand All @@ -97,11 +85,6 @@ export type IndexSettingsAsSearchParams = {

removeStopWords?: RemoveStopWords;

/**
* 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.
*/
keepDiacriticsOnCharacters?: string;

/**
* 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](https://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](https://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](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
*/
Expand All @@ -126,10 +109,6 @@ export type IndexSettingsAsSearchParams = {

removeWordsIfNoResults?: RemoveWordsIfNoResults;

mode?: Mode;

semanticSearch?: SemanticSearch;

/**
* Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/algoliasearch/lite/model/baseRecommendRequest.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { SearchParams } from './searchParams';
import type { RecommendSearchParams } from './recommendSearchParams';

export type BaseRecommendRequest = {
/**
Expand All @@ -18,5 +18,5 @@ export type BaseRecommendRequest = {
*/
maxRecommendations?: number;

queryParameters?: SearchParams;
queryParameters?: RecommendSearchParams;
};
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { OptionalFilters } from './optionalFilters';
import type { SupportedLanguage } from './supportedLanguage';
import type { TagFilters } from './tagFilters';

export type BaseSearchParamsWithoutQuery = {
export type BaseRecommendSearchParams = {
/**
* 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.
*/
Expand Down Expand Up @@ -47,21 +47,6 @@ export type BaseSearchParamsWithoutQuery = {
*/
facetingAfterDistinct?: boolean;

/**
* Page of search results to retrieve.
*/
page?: number;

/**
* Position of the first hit to retrieve.
*/
offset?: number;

/**
* Number of hits to retrieve (used in combination with `offset`).
*/
length?: number;

/**
* Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within 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`.
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/algoliasearch/lite/model/facetOrdering.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { Facets } from './facets';
import type { IndexSettingsFacets } from './indexSettingsFacets';
import type { Value } from './value';

/**
* Order of facet names and facet values in your UI.
*/
export type FacetOrdering = {
facets?: Facets;
facets?: IndexSettingsFacets;

/**
* Order of facet values. One object for each facet.
Expand Down
4 changes: 2 additions & 2 deletions packages/algoliasearch/lite/model/fallbackParams.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { SearchParamsObject } from './searchParamsObject';
import type { RecommendSearchParams } from './recommendSearchParams';

export type FallbackParams = Record<string, unknown> & SearchParamsObject;
export type FallbackParams = RecommendSearchParams & Record<string, unknown>;
7 changes: 6 additions & 1 deletion packages/algoliasearch/lite/model/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ export * from './automaticFacetFilter';
export * from './automaticFacetFilters';
export * from './baseGetApiKeyResponse';
export * from './baseIndexSettings';
export * from './baseRecommendIndexSettings';
export * from './baseRecommendRequest';
export * from './baseRecommendSearchParams';
export * from './baseSearchParams';
export * from './baseSearchParamsWithoutQuery';
export * from './baseSearchResponse';
Expand All @@ -34,7 +36,6 @@ export * from './facetFilters';
export * from './facetHits';
export * from './facetOrdering';
export * from './facetStats';
export * from './facets';
export * from './fallbackParams';
export * from './fbtModel';
export * from './frequentlyBoughtTogether';
Expand All @@ -47,6 +48,7 @@ export * from './hit';
export * from './ignorePlurals';
export * from './indexSettings';
export * from './indexSettingsAsSearchParams';
export * from './indexSettingsFacets';
export * from './lookingSimilar';
export * from './lookingSimilarModel';
export * from './lookingSimilarQuery';
Expand All @@ -62,6 +64,8 @@ export * from './range';
export * from './rankingInfo';
export * from './reRankingApplyFilter';
export * from './recommendHit';
export * from './recommendIndexSettings';
export * from './recommendSearchParams';
export * from './recommendationsHit';
export * from './recommendationsHits';
export * from './recommendationsRequest';
Expand Down Expand Up @@ -90,6 +94,7 @@ export * from './searchPagination';
export * from './searchParams';
export * from './searchParamsObject';
export * from './searchParamsQuery';
export * from './searchParamsString';
export * from './searchQuery';
export * from './searchResponse';
export * from './searchResponses';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/**
* Order of facet names.
*/
export type Facets = {
export type IndexSettingsFacets = {
/**
* Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
*/
Expand Down
9 changes: 9 additions & 0 deletions packages/algoliasearch/lite/model/recommendIndexSettings.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { BaseIndexSettings } from './baseIndexSettings';
import type { BaseRecommendIndexSettings } from './baseRecommendIndexSettings';

/**
* Index settings.
*/
export type RecommendIndexSettings = BaseIndexSettings & BaseRecommendIndexSettings;
10 changes: 10 additions & 0 deletions packages/algoliasearch/lite/model/recommendSearchParams.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { BaseRecommendSearchParams } from './baseRecommendSearchParams';
import type { RecommendIndexSettings } from './recommendIndexSettings';
import type { SearchParamsQuery } from './searchParamsQuery';

/**
* Search parameters for filtering the recommendations.
*/
export type RecommendSearchParams = BaseRecommendSearchParams & RecommendIndexSettings & SearchParamsQuery;
3 changes: 2 additions & 1 deletion packages/algoliasearch/lite/model/searchParams.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { SearchParamsObject } from './searchParamsObject';
import type { SearchParamsString } from './searchParamsString';

export type SearchParams = Record<string, unknown> & SearchParamsObject;
export type SearchParams = SearchParamsObject | SearchParamsString;
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { Model } from './model';

/**
* List of available AI models for transformation purposes.
* Search parameters as query string.
*/
export type TransformationModels = {
llms: Model[];
export type SearchParamsString = {
/**
* Search parameters as a URL-encoded query string.
*/
params?: string;
};
4 changes: 2 additions & 2 deletions packages/algoliasearch/lite/model/trendingItems.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

import type { SearchParamsObject } from './searchParamsObject';
import type { FallbackParams } from './fallbackParams';
import type { TrendingItemsModel } from './trendingItemsModel';

export type TrendingItems = {
Expand All @@ -16,5 +16,5 @@ export type TrendingItems = {

model: TrendingItemsModel;

fallbackParameters?: SearchParamsObject;
fallbackParameters?: FallbackParams;
};
9 changes: 0 additions & 9 deletions packages/ingestion/model/generateTransformationCodePayload.ts

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions packages/ingestion/model/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,6 @@ export * from './event';
export * from './eventSortKeys';
export * from './eventStatus';
export * from './eventType';
export * from './generateTransformationCodePayload';
export * from './generateTransformationCodeResponse';
export * from './listAuthenticationsResponse';
export * from './listDestinationsResponse';
export * from './listEventsResponse';
Expand All @@ -65,7 +63,6 @@ export * from './mappingInput';
export * from './mappingKitAction';
export * from './mappingTypeCSV';
export * from './methodType';
export * from './model';
export * from './onDemandTrigger';
export * from './onDemandTriggerInput';
export * from './onDemandTriggerType';
Expand Down Expand Up @@ -139,7 +136,6 @@ export * from './transformation';
export * from './transformationCreate';
export * from './transformationCreateResponse';
export * from './transformationError';
export * from './transformationModels';
export * from './transformationSearch';
export * from './transformationTry';
export * from './transformationTryResponse';
Expand Down
13 changes: 0 additions & 13 deletions packages/ingestion/model/model.ts

This file was deleted.

Loading

0 comments on commit 91809c4

Please sign in to comment.