api-clients-automation/specs/composition/common/schemas/components/injection/InjectedItemSource.yml at 88ffe9d3fef2201da51da9b76c5fc4e10c3235db · algolia/api-clients-automation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
SearchSource:
  description: Injected items will originate from a search request performed on the specified index.
  x-discriminator-fields:
    - search
  type: object
  additionalProperties: false
  properties:
    search:
      title: injectedItemSearchSource
      type: object
      additionalProperties: false
      properties:
        index:
          type: string
          description: Composition Index name.
          example: Products
        params:
          $ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
      required:
        - index
  required:
    - search

ExternalSource:
  description: Injected items will originate from externally provided objectIDs (that must exist in the index) given at runtime in the run request payload.
  x-discriminator-fields:
    - external
  type: object
  additionalProperties: false
  properties:
    external:
      title: injectedItemExternalSource
      type: object
      additionalProperties: false
      properties:
        index:
          type: string
          description: Composition Index name.
          example: Products
        params:
          $ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
        ordering:
          $ref: '#/externalOrdering'
      required:
        - index
  required:
    - external

externalOrdering:
  enum: ['default', 'userDefined']
  default: 'default'

RecommendSource:
  title: recommendSource
  description: Injected items will originate from a recommendation request performed on the specified index.
  x-discriminator-fields:
    - recommend
  type: object
  additionalProperties: false
  properties:
    recommend:
      title: recommend
      type: object
      additionalProperties: false
      properties:
        indexName:
          type: string
          description: Index to retrieve recommendations from.
          example: Products
        model:
          $ref: './RecommendModel.yml#/model'
        threshold:
          type: integer
          minimum: 0
          maximum: 100
          description: Minimum score a recommendation must have to be included.
        queryParameters:
          $ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
        fallbackParameters:
          $ref: './SearchQueryParams.yml#/injectedItemsQueryParameters'
      required:
        - indexName
        - model
        - threshold
  required:
    - recommend