Last Mile AI Experiment API

openapi: 3.2.0
info:
  title: Lastmileai Experiment API
  version: '2.0'
  description: 'Operations tagged Experiment across 2 of this provider''s published API definitions: model.json, lastmileai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://lastmileai.dev
  description: Production server - LastMile AI
security:
- BearerAuth: []
tags:
- name: Experiment
paths:
  /api/2/auto_eval/experiment/create:
    post:
      tags:
      - Experiment
      summary: Create Experiment
      operationId: CreateExperiment
      description: Create a new Experiment
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lmai.proto.webserver.v2.CreateExperimentRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lmai.proto.webserver.v2.CreateExperimentResponse'
      x-codeSamples:
      - lang: JavaScript
        source: "import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n  bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const experiment = await client.experiments.create({ name: 'name', projectId: 'projectId' });\n\n  console.log(experiment.experiment);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n    bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"),  # This is the default and can be omitted\n)\nexperiment = client.experiments.create(\n    name=\"name\",\n    project_id=\"projectId\",\n)\nprint(experiment.experiment)"
    servers:
    - url: https://lastmileai.dev
      description: Production server - LastMile AI
  /api/2/auto_eval/experiment/get:
    post:
      tags:
      - Experiment
      summary: Get Experiment
      operationId: GetExperiment
      description: Get an Experiment.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lmai.proto.webserver.v2.GetExperimentRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lmai.proto.webserver.v2.GetExperimentResponse'
      x-codeSamples:
      - lang: JavaScript
        source: "import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n  bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const experiment = await client.experiments.get({ id: 'id' });\n\n  console.log(experiment.experiment);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n    bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"),  # This is the default and can be omitted\n)\nexperiment = client.experiments.get(\n    id=\"id\",\n)\nprint(experiment.experiment)"
    servers:
    - url: https://lastmileai.dev
      description: Production server - LastMile AI
  /api/2/auto_eval/experiment/list:
    post:
      tags:
      - Experiment
      summary: List Experiments
      operationId: ListExperiments
      description: List Experiments.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lmai.proto.webserver.v2.ListExperimentsRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lmai.proto.webserver.v2.ListExperimentsResponse'
      x-codeSamples:
      - lang: JavaScript
        source: "import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n  bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const experiments = await client.experiments.list();\n\n  console.log(experiments.experiments);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n    bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"),  # This is the default and can be omitted\n)\nexperiments = client.experiments.list()\nprint(experiments.experiments)"
    servers:
    - url: https://lastmileai.dev
      description: Production server - LastMile AI
  /api/2/auto_eval/experiment/delete:
    delete:
      tags:
      - Experiment
      summary: Delete Experiment
      operationId: DeleteExperiment
      description: Delete an Experiment.
      security:
      - BearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/lmai.proto.webserver.v2.DeleteExperimentRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lmai.proto.webserver.v2.DeleteExperimentResponse'
      x-codeSamples:
      - lang: JavaScript
        source: "import Lastmile from 'lastmile';\n\nconst client = new Lastmile({\n  bearerToken: process.env['LASTMILE_API_TOKEN'], // This is the default and can be omitted\n});\n\nasync function main() {\n  const experiment = await client.experiments.delete({ id: 'id' });\n\n  console.log(experiment.id);\n}\n\nmain();"
      - lang: Python
        source: "import os\nfrom lastmile import Lastmile\n\nclient = Lastmile(\n    bearer_token=os.environ.get(\"LASTMILE_API_TOKEN\"),  # This is the default and can be omitted\n)\nexperiment = client.experiments.delete(\n    id=\"id\",\n)\nprint(experiment.id)"
    servers:
    - url: https://lastmileai.dev
      description: Production server - LastMile AI
components:
  schemas:
    lmai.proto.webserver.v2.ListExperimentsRequest:
      title: ListExperimentsRequest
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/lmai.proto.webserver.v2.ListExperimentsRequestFilters'
        pageIndex:
          type: integer
        pageSize:
          type: integer
    lmai.proto.webserver.v2.CreateExperimentResponse:
      title: CreateExperimentResponse
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/lmai.proto.webserver.v2.Experiment'
      required:
      - experiment
    lmai.proto.webserver.v2.ListExperimentsResponse:
      title: ListExperimentsResponse
      type: object
      properties:
        experiments:
          type: array
          items:
            $ref: '#/components/schemas/lmai.proto.webserver.v2.Experiment'
        totalCount:
          type: integer
          description: "Total count of experiments which can be listed with applicable\n filters, regardless of page size"
      required:
      - experiments
      - totalCount
    lmai.proto.webserver.v2.Experiment:
      title: Experiment
      type: object
      properties:
        id:
          type: string
        createdAt:
          type: string
          format: date-time
          description: "A summary is retrieved for a time range from start_time to end_time\n If no end_time is provided, current time is used"
        updatedAt:
          type: string
          format: date-time
          description: "A summary is retrieved for a time range from start_time to end_time\n If no end_time is provided, current time is used"
        creatorId:
          type: string
        name:
          type: string
        description:
          type: string
        projectId:
          type: string
        metadata:
          $ref: '#/components/schemas/google.protobuf.Struct'
      required:
      - id
      - createdAt
      - updatedAt
      - name
      - projectId
    lmai.proto.webserver.v2.DeleteExperimentRequest:
      title: DeleteExperimentRequest
      type: object
      properties:
        id:
          type: string
          description: ID of the experiment to delete
      required:
      - id
    lmai.proto.webserver.v2.ListExperimentsRequestFilters:
      title: ListExperimentsRequestFilters
      type: object
      properties:
        query:
          type: string
          description: search query substring match for name and description
        projectId:
          type: string
          description: search only experiments associated with specific project
    lmai.proto.webserver.v2.GetExperimentResponse:
      title: GetExperimentResponse
      type: object
      properties:
        experiment:
          $ref: '#/components/schemas/lmai.proto.webserver.v2.Experiment'
      required:
      - experiment
    lmai.proto.webserver.v2.CreateExperimentRequest:
      title: CreateExperimentRequest
      type: object
      properties:
        name:
          type: string
          description: Human-readable name for the experiment
        description:
          type: string
          description: Succint description of the experiment, if one exists.
        projectId:
          type: string
          description: Project the experiment is associated with
        metadata:
          $ref: '#/components/schemas/google.protobuf.Struct'
          description: "Metadata relevant to the application configuration from which all\n experiment evaluation runs are derived. E.g. 'llm_model', 'chunk_size'"
      required:
      - name
      - projectId
      description: Create an Experiment
    google.protobuf.Struct:
      title: Struct
      type: object
      properties:
        fields:
          type: object
          additionalProperties:
            description: "Ordered row values with length always equal to `num_rows` on the\n corresponding view."
            type: object
            additionalProperties: true
      required:
      - fields
    lmai.proto.webserver.v2.GetExperimentRequest:
      title: GetExperimentRequest
      type: object
      properties:
        id:
          type: string
      required:
      - id
    lmai.proto.webserver.v2.DeleteExperimentResponse:
      title: DeleteExperimentResponse
      type: object
      properties:
        id:
          type: string
          description: ID of the deleted experiment
      required:
      - id
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- model.json
- lastmileai-openapi.json