search_relevance.yaml

openapi: 3.1.0
info:
  title: OpenSearch Search Relevance API
  description: OpenSearch Search Relevance API.
  version: 1.0.0
paths:
  /_plugins/_search_relevance/query_sets:
    get:
      operationId: search_relevance.get_query_sets.0
      x-operation-group: search_relevance.get_query_sets
      x-version-added: '3.1'
      description: Lists the current query sets available.
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_query_sets@200'
    post:
      operationId: search_relevance.post_query_sets.0
      x-operation-group: search_relevance.post_query_sets
      x-version-added: '3.1'
      description: Creates a new query set by sampling queries from the user behavior data. 
      requestBody:
        $ref: '#/components/requestBodies/search_relevance.post_query_sets'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.post_query_sets@200'
    put:
      operationId: search_relevance.put_query_sets.0
      x-operation-group: search_relevance.put_query_sets
      x-version-added: '3.1'
      description: Creates a new query set by uploading manually.
      requestBody:
        $ref: '#/components/requestBodies/search_relevance.put_query_sets'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.put_query_sets@200'
  /_plugins/_search_relevance/query_sets/{query_set_id}:
    get:
      operationId: search_relevance.get_query_sets.1
      x-operation-group: search_relevance.get_query_sets
      x-version-added: '3.1'
      description: Lists the current query sets available.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_query_sets::path.query_set_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_query_sets@200'
    delete:
      operationId: search_relevance.delete_query_sets.0
      x-operation-group: search_relevance.delete_query_sets
      x-version-added: '3.1'
      description: Deletes a query set.
      parameters:
        - $ref: '#/components/parameters/search_relevance.delete_query_sets::path.query_set_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.delete_query_sets@200'
  /_plugins/_search_relevance/judgments:
    get:
      operationId: search_relevance.get_judgments.0
      x-operation-group: search_relevance.get_judgments
      x-version-added: '3.1'
      description: Gets judgments.
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_judgments@200'
    put:
      operationId: search_relevance.put_judgments.0
      x-operation-group: search_relevance.put_judgments
      x-version-added: '3.1'
      description: Creates a judgment.
      requestBody:
        description: The request body of the judgment to be created.
        $ref: '#/components/requestBodies/search_relevance.put_judgments' 
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.put_judgments@200'
  /_plugins/_search_relevance/judgments/{judgment_id}:
    get:
      operationId: search_relevance.get_judgments.1
      x-operation-group: search_relevance.get_judgments
      x-version-added: '3.1'
      description: Gets judgments.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_judgments::path.judgment_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_judgments@200'
    delete:
      operationId: search_relevance.delete_judgments.0
      x-operation-group: search_relevance.delete_judgments
      x-version-added: '3.1'
      description: Deletes a specified judgment.
      parameters:
        - $ref: '#/components/parameters/search_relevance.delete_judgments::path.judgment_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.delete_judgments@200'
  /_plugins/_search_relevance/search_configurations:
    get:
      operationId: search_relevance.get_search_configurations.0
      x-operation-group: search_relevance.get_search_configurations
      x-version-added: '3.1'
      description: Gets the search configurations.
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_search_configurations@200'
    put:
      operationId: search_relevance.put_search_configurations.0
      x-operation-group: search_relevance.put_search_configurations
      x-version-added: '3.1'
      description: Creates a search configuration.
      requestBody:
        $ref: '#/components/requestBodies/search_relevance.put_search_configurations' 
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.put_search_configurations@200'
  /_plugins/_search_relevance/search_configurations/{search_configuration_id}:
    get:
      operationId: search_relevance.get_search_configurations.1
      x-operation-group: search_relevance.get_search_configurations
      x-version-added: '3.1'
      description: Gets the search configurations.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_search_configurations::path.search_configuration_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_search_configurations@200'
    delete:
      operationId: search_relevance.delete_search_configurations.0
      x-operation-group: search_relevance.delete_search_configurations
      x-version-added: '3.1'
      description: Deletes a specified search configuration.
      parameters:
        - $ref: '#/components/parameters/search_relevance.delete_search_configurations::path.search_configuration_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.delete_search_configurations@200'
  /_plugins/_search_relevance/experiments:
    get:
      operationId: search_relevance.get_experiments.0
      x-operation-group: search_relevance.get_experiments
      x-version-added: '3.1'
      description: Gets experiments.
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_experiments@200'
    put:
      operationId: search_relevance.put_experiments.0
      x-operation-group: search_relevance.put_experiments
      x-version-added: '3.1'
      description: Creates an experiment.
      requestBody:
        $ref: '#/components/requestBodies/search_relevance.put_experiments'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.put_experiments@200'
  /_plugins/_search_relevance/experiments/{experiment_id}:
    get:
      operationId: search_relevance.get_experiments.1
      x-operation-group: search_relevance.get_experiments
      x-version-added: '3.1'
      description: Gets experiments.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_experiments::path.experiment_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_experiments@200'
          # content:
          #  application/json:
          #    schema:
          #      type: object
          # $ref: '../schemas/search_relevance._common.yaml#/components/schemas/Experiment'
    delete:
      operationId: search_relevance.delete_experiments.0
      x-operation-group: search_relevance.delete_experiments
      x-version-added: '3.1'
      description: Deletes a specified experiment.
      parameters:
        - $ref: '#/components/parameters/search_relevance.delete_experiments::path.experiment_id'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.delete_experiments@200'
  /_plugins/_search_relevance/{node_id}/stats:
    get:
      operationId: search_relevance.get_node_stats.0
      x-operation-group: search_relevance.get_node_stats
      x-version-added: '3.1'
      description: Gets stats by node.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_node_stats::path.node_id'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.flat_stat_paths'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_all_nodes'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_individual_nodes'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_info'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_metadata'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_node_stats@200'
  /_plugins/_search_relevance/{node_id}/stats/{stat}:
    get: 
      operationId: search_relevance.get_node_stats.1
      x-operation-group: search_relevance.get_node_stats
      x-version-added: '3.1'
      description: Gets stats by node.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_node_stats::path.node_id'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::path.stat'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.flat_stat_paths'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_all_nodes'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_individual_nodes'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_info'
        - $ref: '#/components/parameters/search_relevance.get_node_stats::query.include_metadata'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_node_stats@200'
  /_plugins/_search_relevance/stats:
    get:
      operationId: search_relevance.get_stats.0
      x-operation-group: search_relevance.get_stats
      x-version-added: '3.1'
      description: Gets stats.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_stats::query.flat_stat_paths'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_all_nodes'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_individual_nodes'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_info'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_metadata'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_stats@200'
  /_plugins/_search_relevance/stats/{stat}:
    get:
      operationId: search_relevance.get_stats.1
      x-operation-group: search_relevance.get_stats
      x-version-added: '3.1'
      description: Gets stats.
      parameters:
        - $ref: '#/components/parameters/search_relevance.get_stats::path.stat'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.flat_stat_paths'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_all_nodes'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_individual_nodes'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_info'
        - $ref: '#/components/parameters/search_relevance.get_stats::query.include_metadata'
      responses:
        '200':
          $ref: '#/components/responses/search_relevance.get_stats@200'

          
components:
  parameters:
    search_relevance.get_query_sets::path.query_set_id: 
      name: query_set_id
      in: path
      required: true
      description: The query set id
      schema:
        type: string
    search_relevance.delete_query_sets::path.query_set_id: 
      name: query_set_id
      in: path
      required: true
      description: The query set id
      schema:
        type: string
    search_relevance.get_judgments::path.judgment_id:
      name: judgment_id
      in: path
      required: true
      description: The judgment id
      schema:
        type:
          string
    search_relevance.delete_judgments::path.judgment_id:
      name: judgment_id
      in: path
      required: true
      description: The judgment id
      schema:
        type:
          string
    search_relevance.get_search_configurations::path.search_configuration_id:
      name: search_configuration_id
      in: path
      required: true
      description: The search configuration id
      schema:
        type:
          string
    search_relevance.delete_search_configurations::path.search_configuration_id:
      name: search_configuration_id
      in: path
      required: true
      description: The search configuration id
      schema:
        type:
          string
    search_relevance.get_experiments::path.experiment_id:
      name: experiment_id
      in: path
      required: true
      description: The experiment id
      schema:
        type:
          string
    search_relevance.delete_experiments::path.experiment_id:
      name: experiment_id
      in: path
      required: true
      description: The experiment id
      schema:
        type:
          string
    search_relevance.get_node_stats::path.node_id:
      name: node_id
      in: path
      required: true
      description: The node id
      schema:
        type:
          string
    search_relevance.get_node_stats::path.stat:
      name: stat
      in: path
      required: true
      description: The statistic to return
      schema:
        type:
          string
    search_relevance.get_stats::path.stat:
      name: stat
      in: path
      required: true
      description: The statistic to return
      schema:
        type:
          string
    search_relevance.get_node_stats::query.flat_stat_paths:
      name: flat_stat_paths
      in: query
      required: false
      description: Requests flattened stat paths as keys
      schema:
        type:
          string
    search_relevance.get_node_stats::query.include_metadata:
      name: include_metadata
      in: query
      required: false
      description: Whether to include metadata
      schema:
        type:
          string
    search_relevance.get_node_stats::query.include_individual_nodes:
      name: include_individual_nodes
      in: query
      required: false
      description: Whether to include individual nodes
      schema:
        type:
          string
    search_relevance.get_node_stats::query.include_all_nodes:
      name: include_all_nodes
      in: query
      required: false
      description: Whether to include all nodes
      schema:
        type:
          string
    search_relevance.get_node_stats::query.include_info:
      name: include_info
      in: query
      required: false
      description: Whether to include info
      schema:
        type:
          string
    search_relevance.get_stats::query.flat_stat_paths:
      name: flat_stat_paths
      in: query
      required: false
      description: Requests flattened stat paths as keys
      schema:
        type:
          string
    search_relevance.get_stats::query.include_metadata:
      name: include_metadata
      in: query
      required: false
      description: Whether to include metadata
      schema:
        type:
          string
    search_relevance.get_stats::query.include_individual_nodes:
      name: include_individual_nodes
      in: query
      required: false
      description: Whether to include individual nodes
      schema:
        type:
          string
    search_relevance.get_stats::query.include_all_nodes:
      name: include_all_nodes
      in: query
      required: false
      description: Whether to include all nodes
      schema:
        type:
          string
    search_relevance.get_stats::query.include_info:
      name: include_info
      in: query
      required: false
      description: Whether to include info
      schema:
        type:
          string
  requestBodies:
    search_relevance.post_query_sets:
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              sampling:
                type: string
              querySetSize:
                type: integer
    search_relevance.put_query_sets:
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
              sampling:
                type: string
              querySetQueries:
                type: array
                items:
                  type: object
                  # TODO: Replace the object type with the actual querySet
                  # schema. 
    search_relevance.put_judgments:
      content:
        application/json:
          schema:
            oneOf:
              - type: object
                description: The schema for a LLM judgment 
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  type:
                    type: string
                  modelId:
                    type: string
                  querySetId:
                    type: string
                  searchConfigurationList:
                    type: array
                    items:
                      type: string
                  size:
                    type: integer
                  ignoreFailure:
                    type: boolean
                  contextFields:
                    type: array
                    items:
                      type: string
              - type: object
                description: The schema for a UBI judgment 
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  type:
                    type: string
                  clickModel:
                    type: string
                  maxRank:
                    type: integer
              - type: object
                description: The schema for an import judgment 
                properties:
                  name:
                    type: string
                  description:
                    type: string
                  type:
                    type: string
                  judgmentRatings:
                    type: array
                    items:
                      type: object
    search_relevance.put_search_configurations:
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
              index:
                type: string
              query:
                type: string
              searchPipeline:
                type: string

    search_relevance.put_experiments:
      content:
        application/json:
          schema:
            anyOf:
              - type: object
                description: The schema for a pointwise and hybrid optimizer experiment 
                properties:
                  querySetId:
                    type: string
                  searchConfigurationList:
                    type: array
                    items:
                      type: string
                  judgmentList:
                    type: array
                    items:
                      type: string
                  size:
                    type: integer
                  type:
                    type: string
              - type: object
                description: The schema for a pairwise experiment 
                properties:
                  querySetId:
                    type: string
                  searchConfigurationList:
                    type: array
                    items:
                      type: string
                  size:
                    type: integer
                  type:
                    type: string
  responses:
    search_relevance.get_query_sets@200:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/QuerySet'
              # TODO: Right Now, the generic object is the response of a get, but this can
              # be more fleshed out to accomodate the specific return values of different gets. 
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/GenericObject'
    search_relevance.post_query_sets@200:
      content:
        application/json:
          schema:
            type: object
            properties:
              query_set_id: 
                type: string
              query_set_result:
                type: string
    search_relevance.put_query_sets@200:
      content:
        application/json:
          schema:
            type: object
            properties:
              query_set_id: 
                type: string
              query_set_result:
                type: string
    search_relevance.delete_query_sets@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of deletes can be more specific. 
    search_relevance.get_judgments@200:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/Judgment'
              # TODO: Right Now, the generic object is the response of a get, but this can
              # be more fleshed out to accomodate the specific return values of different gets. 
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/GenericObject'
    search_relevance.put_judgments@200:
      content:
        application/json:
          schema:
            type: 
              object
            properties:
              judgment_id:
                type: string
    search_relevance.delete_judgments@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of deletes can be more specific. 
    search_relevance.get_search_configurations@200:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/SearchConfiguration'
              # TODO: Right Now, the generic object is the response of a get, but this can
              # be more fleshed out to accomodate the specific return values of different gets. 
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/GenericObject'
    search_relevance.put_search_configurations@200:
      content:
        application/json:
          schema:
            type: object
            properties:
              search_configuration_id:
                type: string
              search_configuration_result:
                type: string
    search_relevance.delete_search_configurations@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of deletes can be more specific. 
    search_relevance.get_experiments@200:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/Experiment'
              # TODO: Right Now, the generic object is the response of a get, but this can
              # be more fleshed out to accomodate the specific return values of different gets. 
              - $ref: '../schemas/search_relevance._common.yaml#/components/schemas/GenericObject'
    search_relevance.put_experiments@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of puts can be more specific. 
    search_relevance.delete_experiments@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of deletes can be more specific. 
    search_relevance.get_node_stats@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of get node stats can be more specific. 
    search_relevance.get_stats@200:
      content:
        application/json:
          schema:
            type: object
            # TODO: The return value of get stats should be more specific.