Verta ExperimentService API

swagger: '2.0'
info:
  title: deployment/APISync.proto AuthzService ExperimentService API
  version: version not set
basePath: /v1
consumes:
- application/json
produces:
- application/json
tags:
- name: ExperimentService
paths:
  /experiment/addAttribute:
    post:
      operationId: ExperimentService_addAttribute
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbAddAttributesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbAddAttributes'
      tags:
      - ExperimentService
  /experiment/addExperimentAttributes:
    post:
      operationId: ExperimentService_addExperimentAttributes
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbAddExperimentAttributesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbAddExperimentAttributes'
      tags:
      - ExperimentService
  /experiment/addExperimentTag:
    post:
      operationId: ExperimentService_addExperimentTag
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbAddExperimentTagResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbAddExperimentTag'
      tags:
      - ExperimentService
  /experiment/addExperimentTags:
    post:
      operationId: ExperimentService_addExperimentTags
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbAddExperimentTagsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbAddExperimentTags'
      tags:
      - ExperimentService
  /experiment/createExperiment:
    post:
      operationId: ExperimentService_createExperiment
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbCreateExperimentResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbCreateExperiment'
      tags:
      - ExperimentService
  /experiment/deleteArtifact:
    delete:
      operationId: ExperimentService_deleteArtifact
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentArtifactResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbDeleteExperimentArtifact'
      tags:
      - ExperimentService
  /experiment/deleteExperiment:
    delete:
      operationId: ExperimentService_deleteExperiment
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbDeleteExperiment'
      tags:
      - ExperimentService
  /experiment/deleteExperimentAttributes:
    delete:
      operationId: ExperimentService_deleteExperimentAttributes
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentAttributesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: attribute_keys
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: delete_all
        in: query
        required: false
        type: boolean
      tags:
      - ExperimentService
  /experiment/deleteExperimentTag:
    delete:
      operationId: ExperimentService_deleteExperimentTag
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentTagResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbDeleteExperimentTag'
      tags:
      - ExperimentService
  /experiment/deleteExperimentTags:
    delete:
      operationId: ExperimentService_deleteExperimentTags
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentTagsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbDeleteExperimentTags'
      tags:
      - ExperimentService
  /experiment/deleteExperiments:
    delete:
      operationId: ExperimentService_deleteExperiments
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbDeleteExperimentsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbDeleteExperiments'
      tags:
      - ExperimentService
  /experiment/findExperiments:
    post:
      summary: queries
      operationId: ExperimentService_findExperiments
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbFindExperimentsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbFindExperiments'
      tags:
      - ExperimentService
  /experiment/getArtifacts:
    get:
      operationId: ExperimentService_getArtifacts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetArtifactsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: key
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getExperimentAttributes:
    get:
      operationId: ExperimentService_getExperimentAttributes
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetAttributesResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      - name: attribute_keys
        in: query
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: get_all
        in: query
        required: false
        type: boolean
      tags:
      - ExperimentService
  /experiment/getExperimentById:
    get:
      operationId: ExperimentService_getExperimentById
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetExperimentByIdResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getExperimentByName:
    get:
      operationId: ExperimentService_getExperimentByName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetExperimentByNameResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: name
        in: query
        required: false
        type: string
      - name: project_id
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getExperimentCodeVersion:
    get:
      operationId: ExperimentService_getExperimentCodeVersion
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetExperimentCodeVersionResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getExperimentTags:
    get:
      operationId: ExperimentService_getExperimentTags
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetTagsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: id
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getExperimentsInProject:
    get:
      operationId: ExperimentService_getExperimentsInProject
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetExperimentsInProjectResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: project_id
        in: query
        required: false
        type: string
      - name: page_number
        in: query
        required: false
        type: integer
        format: int32
      - name: page_limit
        in: query
        required: false
        type: integer
        format: int32
      - name: ascending
        in: query
        required: false
        type: boolean
      - name: sort_key
        in: query
        required: false
        type: string
      tags:
      - ExperimentService
  /experiment/getUrlForArtifact:
    post:
      summary: artifacts
      operationId: ExperimentService_getUrlForArtifact
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbGetUrlForArtifactResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbGetUrlForArtifact'
      tags:
      - ExperimentService
  /experiment/logArtifacts:
    post:
      summary: artifacts
      operationId: ExperimentService_logArtifacts
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbLogExperimentArtifactsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbLogExperimentArtifacts'
      tags:
      - ExperimentService
  /experiment/logExperimentCodeVersion:
    post:
      summary: code version
      operationId: ExperimentService_logExperimentCodeVersion
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbLogExperimentCodeVersionResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbLogExperimentCodeVersion'
      tags:
      - ExperimentService
  /experiment/updateExperimentDescription:
    post:
      operationId: ExperimentService_updateExperimentDescription
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbUpdateExperimentDescriptionResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbUpdateExperimentDescription'
      tags:
      - ExperimentService
  /experiment/updateExperimentName:
    post:
      operationId: ExperimentService_updateExperimentName
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbUpdateExperimentNameResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbUpdateExperimentName'
      tags:
      - ExperimentService
  /experiment/updateExperimentNameOrDescription:
    post:
      operationId: ExperimentService_updateExperimentNameOrDescription
      responses:
        '200':
          description: A successful response.
          schema:
            $ref: '#/definitions/modeldbUpdateExperimentNameOrDescriptionResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/runtimeError'
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/modeldbUpdateExperimentNameOrDescription'
      tags:
      - ExperimentService
definitions:
  modeldbGetArtifactsResponse:
    type: object
    properties:
      artifacts:
        type: array
        items:
          $ref: '#/definitions/commonArtifact'
  modeldbGetExperimentByNameResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbDeleteExperimentAttributesResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbUpdateExperimentNameOrDescriptionResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbUpdateExperimentDescriptionResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbDeleteExperimentTagsResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbFindExperimentsResponse:
    type: object
    properties:
      experiments:
        type: array
        items:
          $ref: '#/definitions/modeldbExperiment'
      total_records:
        type: string
        format: int64
  TernaryEnumTernary:
    type: string
    enum:
    - UNKNOWN
    - 'TRUE'
    - 'FALSE'
    default: UNKNOWN
  modeldbGetAttributesResponse:
    type: object
    properties:
      attributes:
        type: array
        items:
          $ref: '#/definitions/commonKeyValue'
  modeldbLogExperimentCodeVersion:
    type: object
    properties:
      id:
        type: string
      code_version:
        $ref: '#/definitions/commonCodeVersion'
    title: code version
  modeldbUpdateExperimentNameOrDescription:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
      description:
        type: string
  modeldbAddExperimentTagsResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbExperiment:
    type: object
    properties:
      id:
        type: string
      project_id:
        type: string
      name:
        type: string
      description:
        type: string
      date_created:
        type: string
        format: int64
      date_updated:
        type: string
        format: int64
      attributes:
        type: array
        items:
          $ref: '#/definitions/commonKeyValue'
      tags:
        type: array
        items:
          type: string
      owner:
        type: string
      owner_id:
        type: string
        format: uint64
      group_owner_id:
        $ref: '#/definitions/commonGroupId'
      code_version_snapshot:
        $ref: '#/definitions/commonCodeVersion'
      artifacts:
        type: array
        items:
          $ref: '#/definitions/commonArtifact'
      version_number:
        type: string
        format: uint64
        title: Doc for version_number https://github.com/VertaAI/docs/pull/53
  protobufAny:
    type: object
    properties:
      type_url:
        type: string
      value:
        type: string
        format: byte
  runtimeError:
    type: object
    properties:
      error:
        type: string
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/protobufAny'
  modeldbDeleteExperimentArtifactResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbCreateExperiment:
    type: object
    properties:
      project_id:
        type: string
      name:
        type: string
      description:
        type: string
      date_created:
        type: string
        format: int64
      date_updated:
        type: string
        format: int64
      attributes:
        type: array
        items:
          $ref: '#/definitions/commonKeyValue'
      tags:
        type: array
        items:
          type: string
      artifacts:
        type: array
        items:
          $ref: '#/definitions/commonArtifact'
  modeldbFindExperiments:
    type: object
    properties:
      project_id:
        type: string
      experiment_ids:
        type: array
        items:
          type: string
      predicates:
        type: array
        items:
          $ref: '#/definitions/commonKeyValueQuery'
      ids_only:
        type: boolean
      page_number:
        type: integer
        format: int32
        title: For pagination
      page_limit:
        type: integer
        format: int32
      ascending:
        type: boolean
      sort_key:
        type: string
      workspace_name:
        type: string
  modeldbLogExperimentArtifacts:
    type: object
    properties:
      id:
        type: string
      artifacts:
        type: array
        items:
          $ref: '#/definitions/commonArtifact'
    title: artifacts
  modeldbDeleteExperimentsResponse:
    type: object
    properties:
      status:
        type: boolean
  modeldbAddExperimentTagResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbAddExperimentAttributes:
    type: object
    properties:
      id:
        type: string
      attributes:
        type: array
        items:
          $ref: '#/definitions/commonKeyValue'
  modeldbLogExperimentCodeVersionResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbLogExperimentArtifactsResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbGetTagsResponse:
    type: object
    properties:
      tags:
        type: array
        items:
          type: string
  modeldbAddExperimentTags:
    type: object
    properties:
      id:
        type: string
      tags:
        type: array
        items:
          type: string
  commonKeyValueQuery:
    type: object
    properties:
      key:
        type: string
      value:
        type: object
      value_type:
        $ref: '#/definitions/ValueTypeEnumValueType'
      operator:
        $ref: '#/definitions/OperatorEnumOperator'
  commonGitSnapshot:
    type: object
    properties:
      filepaths:
        type: array
        items:
          type: string
      repo:
        type: string
      hash:
        type: string
      is_dirty:
        $ref: '#/definitions/TernaryEnumTernary'
  modeldbGetExperimentByIdResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbDeleteExperimentTagResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  ArtifactTypeEnumArtifactType:
    type: string
    enum:
    - IMAGE
    - MODEL
    - TENSORBOARD
    - DATA
    - BLOB
    - STRING
    - CODE
    - CONTAINER
    default: IMAGE
  modeldbGetUrlForArtifactResponse:
    type: object
    properties:
      url:
        type: string
      fields:
        type: object
        additionalProperties:
          type: string
      multipart_upload_ok:
        type: boolean
  commonArtifact:
    type: object
    properties:
      key:
        type: string
      path:
        type: string
      path_only:
        type: boolean
      artifact_type:
        $ref: '#/definitions/ArtifactTypeEnumArtifactType'
      linked_artifact_id:
        type: string
      filename_extension:
        type: string
      serialization:
        type: string
      artifact_subtype:
        type: string
      upload_completed:
        type: boolean
  modeldbGetExperimentCodeVersionResponse:
    type: object
    properties:
      code_version:
        $ref: '#/definitions/commonCodeVersion'
  modeldbCreateExperimentResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbUpdateExperimentDescription:
    type: object
    properties:
      id:
        type: string
      description:
        type: string
  modeldbAddAttributesResponse:
    type: object
    properties:
      status:
        type: boolean
  modeldbDeleteExperimentTags:
    type: object
    properties:
      id:
        type: string
      tags:
        type: array
        items:
          type: string
      delete_all:
        type: boolean
  modeldbAddExperimentAttributesResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  modeldbGetExperimentsInProjectResponse:
    type: object
    properties:
      experiments:
        type: array
        items:
          $ref: '#/definitions/modeldbExperiment'
      total_records:
        type: string
        format: int64
  modeldbDeleteExperimentArtifact:
    type: object
    properties:
      id:
        type: string
      key:
        type: string
  ValueTypeEnumValueType:
    type: string
    enum:
    - STRING
    - NUMBER
    - LIST
    - BLOB
    default: STRING
  modeldbUpdateExperimentNameResponse:
    type: object
    properties:
      experiment:
        $ref: '#/definitions/modeldbExperiment'
  commonCodeVersion:
    type: object
    properties:
      git_snapshot:
        $ref: '#/definitions/commonGitSnapshot'
      code_archive:
        $ref: '#/definitions/commonArtifact'
      date_logged:
        type: string
        format: uint64
    title: code version
  commonGroupId:
    type: object
    properties:
      org_id:
        type: string
      group_id:
        type: string
  modeldbDeleteExperimentResponse:
    type: object
    properties:
      status:
        type: boolean
  modeldbDeleteExperimentTag:
    type: object
    properties:
      id:
        type: string
      tag:
        type: string
  OperatorEnumOperator:
    type: string
    enum:
    - EQ
    - NE
    - GT
    - GTE
    - LT
    - LTE
    - CONTAIN
    - NOT_CONTAIN
    - IN
    - NOT_IN
    default: EQ
  modeldbDeleteExperiment:
    type: object
    properties:
      id:
        type: string
  modeldbAddExperimentTag:
    type: object
    properties:
      id:
        type: string
      tag:
        type: string
  modeldbGetUrlForArtifact:
    type: object
    properties:
      id:
        type: string
      key:
        type: string
      method:
        type: string
      artifact_type:
        $ref: '#/definitions/ArtifactTypeEnumArtifactType'
      part_number:
        type: string
        format: uint64
  modeldbDeleteExperiments:
    type: object
    properties:
      ids:
        type: array
        items:
          type: string
  commonKeyValue:
    type: object
    properties:
      key:
        type: string
      value:
        type: object
      value_type:
        $ref: '#/definitions/ValueTypeEnumValueType'
        description: "As per documentation of proto buffer 3.\n  For enums, the default value is the first defined enum value, which must be 0."
  modeldbUpdateExperimentName:
    type: object
    properties:
      id:
        type: string
      name:
        type: string
  modeldbAddAttributes:
    type: object
    properties:
      id:
        type: string
      attribute:
        $ref: '#/definitions/commonKeyValue'
    title: 'TODO: make this update attribute'