Skip to content

Commit

Permalink
fix(ui): display issues and gql queries
Browse files Browse the repository at this point in the history
  • Loading branch information
shortcuts committed Mar 7, 2022
1 parent 72af690 commit 72cafab
Show file tree
Hide file tree
Showing 11 changed files with 228 additions and 137 deletions.
4 changes: 2 additions & 2 deletions specs/bundled/personalization.yml
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,6 @@ paths:
tags:
- personalization
get:
tags:
- personalization
operationId: getPersonalizationStrategy
description: >-
The strategy contains information on the events and facets that impact
Expand All @@ -416,3 +414,5 @@ paths:
$ref: '#/components/responses/MethodNotAllowed'
'404':
$ref: '#/components/responses/IndexNotFound'
tags:
- personalization
10 changes: 5 additions & 5 deletions specs/bundled/query-suggestions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -454,8 +454,6 @@ paths:
tags:
- query-suggestions
get:
tags:
- query-suggestions
operationId: getAllConfigs
description: >
Get all the configurations of Query Suggestions.
Expand All @@ -480,6 +478,8 @@ paths:
$ref: '#/components/responses/StatusUnprocessableEntity'
'500':
$ref: '#/components/responses/InternalError'
tags:
- query-suggestions
/1/configs/{indexName}:
put:
operationId: updateConfig
Expand All @@ -503,8 +503,6 @@ paths:
tags:
- query-suggestions
delete:
tags:
- query-suggestions
operationId: deleteConfig
description: >
Delete a configuration of a Query Suggestion's index.
Expand All @@ -526,9 +524,9 @@ paths:
$ref: '#/components/responses/MethodNotAllowed'
'500':
$ref: '#/components/responses/InternalError'
get:
tags:
- query-suggestions
get:
operationId: getConfig
description: Get the configuration of a single Query Suggestions index.
summary: Get the configuration of a single Query Suggestions index.
Expand All @@ -551,6 +549,8 @@ paths:
$ref: '#/components/responses/IndexNotFound'
'500':
$ref: '#/components/responses/InternalError'
tags:
- query-suggestions
/1/configs/{indexName}/status:
get:
operationId: getConfigStatus
Expand Down
110 changes: 72 additions & 38 deletions specs/bundled/recommend.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,34 @@ components:
type: string
example: products
description: The Algolia index name.
searchFilters:
oneOf:
- title: searchFiltersString
type: string
- title: searchFiltersArray
type: array
items:
type: string
- title: searchFiltersNestedArray
type: array
items:
type: array
items:
type: string
page:
type: integer
description: Specify the page to retrieve.
default: 0
aroundRadiusAll:
type: string
enum:
- all
aroundRadius:
description: Define the maximum radius for a geo search (in meters).
oneOf:
- type: integer
minimum: 1
- type: string
enum:
- all
- $ref: '#/components/schemas/aroundRadiusAll'
baseSearchParams:
type: object
additionalProperties: false
Expand All @@ -79,32 +95,20 @@ components:
description: Filter the query with numeric, facet and/or tag filters.
default: ''
facetFilters:
type: array
items:
type: string
description: Filter hits by facet value.
default: []
$ref: '#/components/schemas/searchFilters'
optionalFilters:
type: array
items:
type: string
description: >-
Create filters for ranking purposes, where records that match the
filter are ranked higher, or lower in the case of a negative
optional filter.
default: []
$ref: '#/components/schemas/searchFilters'
numericFilters:
type: array
items:
type: string
description: Filter on numeric attributes.
default: []
$ref: '#/components/schemas/searchFilters'
tagFilters:
type: array
items:
type: string
description: Filter hits by tags.
default: []
$ref: '#/components/schemas/searchFilters'
sumOrFiltersScores:
type: boolean
description: Determines how to calculate the total score for filtering.
Expand Down Expand Up @@ -237,6 +241,11 @@ components:
type: boolean
description: Whether this search should use AI Re-Ranking.
default: true
reRankingApplyFilter:
description: >-
When Dynamic Re-Ranking is enabled, only records that match these
filters will be impacted by Dynamic Re-Ranking.
$ref: '#/components/schemas/searchFilters'
query:
type: string
description: The text to search in the index.
Expand Down Expand Up @@ -813,6 +822,34 @@ components:
- none
- partial
- full
matchedGeoLocation:
type: object
properties:
lat:
type: number
format: double
description: Latitude of the matched location.
lng:
type: number
format: double
description: Longitude of the matched location.
distance:
type: integer
description: >-
Distance between the matched location and the search location (in
meters).
personalization:
type: object
properties:
filtersScore:
type: integer
description: The score of the filters.
rankingScore:
type: integer
description: The score of the ranking.
score:
type: integer
description: The score of the event.
rankingInfo:
type: object
additionalProperties: false
Expand All @@ -835,24 +872,9 @@ components:
type: integer
description: Precision used when computing the geo distance, in meters.
matchedGeoLocation:
type: object
additionalProperties:
type: object
additionalProperties: false
properties:
lat:
type: number
format: double
description: Latitude of the matched location.
lng:
type: number
format: double
description: Longitude of the matched location.
distance:
type: integer
description: >-
Distance between the matched location and the search location
(in meters).
$ref: '#/components/schemas/matchedGeoLocation'
personalization:
$ref: '#/components/schemas/personalization'
nbExactWords:
type: integer
description: Number of exactly matched words.
Expand All @@ -870,9 +892,21 @@ components:
userScore:
type: integer
description: Custom ranking for the object, expressed as a single integer value.
word:
words:
type: integer
description: Number of matched words, including prefixes and typos.
promotedByReRanking:
type: boolean
description: Wether the record are promoted by the re-ranking strategy.
required:
- promoted
- nbTypos
- firstMatchedWord
- geoDistance
- nbExactWords
- words
- filters
- userScore
_distinctSeqID:
type: integer
recommendHit:
Expand Down
Loading

0 comments on commit 72cafab

Please sign in to comment.