> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update existing examples in a dataset

> Updates existing dataset examples by matching their `id` field.

an example ID does not match any existing example in the dataset
version, it will be ignored. In other words, only examples with IDs
that already exist will be updated. To add new examples, use the
Insert Dataset Examples endpoint.

Adding columns that do not exist in the dataset schema is allowed, but
removing existing columns is not.

Optionally, the update can create a new version of the dataset. In
this case, the outcome of the update will be reflected only in the new
version, while the previous version remains unchanged. If a new
version is not created, the updates will be applied directly (in place)
to the specified version.

**Payload Requirements**
- Each item in `examples[]` may contain any user-defined fields.
- Each item in `examples[]` must include the `id` field to identify the
example to update.
- Do not include system-managed fields on input: `created_at`, `updated_at`.
Requests that contain these fields in any example will be rejected.
- Each example must contain at least one property (i.e., `{}` is invalid).

**Valid example** (create)
```json
{
  "examples": [
    {
      "id": "ex_001",
      "question": "What is 2+2?",
      "answer": "4",
      "topic": "math"
    }
  ]
}
```

**Invalid example** ('id' missing for update)
```json
{
  "examples": [
    {
      "input": "Hello"
    }
  ]
}
```

<Note>This endpoint is in beta, read more [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>




## OpenAPI

````yaml https://api.arize.com/v2/spec.yaml patch /v2/datasets/{dataset_id}/examples
openapi: 3.0.3
info:
  title: Arize REST API
  version: 2.0.0
  description: |
    API specification for the backend data server. The API is hosted globally
    at https://api.arize.com/v2 or in your own environment.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - description: Global
    url: https://api.arize.com
  - description: Regional
    url: https://api.{region}.arize.com
    variables:
      region:
        default: eu-west-1a
        enum:
          - eu-west-1a
          - ca-central-1a
  - description: Custom Host
    url: https://{host}
    variables:
      host:
        default: api.arize.com
security:
  - bearerAuth: []
tags:
  - name: AI Integrations
    description: |
      AI integrations configure access to external LLM providers (e.g. OpenAI,
      Azure OpenAI, AWS Bedrock, Vertex AI). Integrations can be scoped to the
      entire account, a specific organization, or a specific space.
  - name: Annotation Configs
    description: >
      Annotation configs allow you to define consistent annotation schemas that

      can be reused across your workspace, ensuring evaluations are structured
      and

      comparable over time.
  - name: Annotation Queues
    description: >
      Annotation queues help you organize and manage human evaluation workflows.

      Use queues to assign spans or examples to annotators for review and
      labeling.
  - name: API Keys
    description: >
      API keys are used to authenticate requests to the Arize API. List your
      keys

      to view metadata; the raw secret is never returned after creation.
  - name: Datasets
    description: |
      Datasets are structured, version-controlled example collections you use to
      run, evaluate, and track LLM experiments.
  - name: Evaluators
    description: >
      Evaluators are reusable evaluation configurations used to assess the
      quality

      of LLM outputs. They can be template-based (using LLM judges) or
      code-based.
  - name: Experiments
    description: >
      Experiments let you systematically test prompt/model changes using
      datasets,

      tasks, and evaluators.
  - name: Integrations
    description: >
      Integrations configure access to external LLM providers (e.g. OpenAI,

      Azure OpenAI, AWS Bedrock, Vertex AI), notifications services (e.g.
      PagerDuty, Slack), and

      your own agents. Integrations can be scoped to the entire account, a
      specific

      organization, or a specific space.
  - name: Organizations
    description: >
      Organizations are top-level containers within an Arize AX account for
      grouping spaces.
  - name: Projects
    description: |
      Projects represent LLM applications being monitored in Arize where you can
      observe traces and spans.
  - name: Prompts
    description: >
      Prompts are reusable, versioned templates for LLM interactions. Use
      prompts

      to standardize and manage how you interact with LLMs across your
      application.
  - name: Resource Restrictions
    description: |
      Endpoints for restricting and unrestricting resources (projects, models).
  - name: Role Bindings
    description: |
      Role bindings assign a role to a user on a resource. REST currently
      supports space- and project-scoped bindings.
  - name: Roles
    description: >
      Roles define sets of permissions that can be assigned to users within an

      account. Create custom roles to tailor access control to your team's
      needs.
  - name: Spaces
    description: >
      Spaces are containers within an organization for grouping related
      projects,

      datasets, and experiments, enabling collaboration or isolated
      experimentation

      with role-based access control.
  - name: Spans
    description: |
      Spans represent individual operations within a trace. A span captures the
      timing, status, and attributes of a single operation in your application.
  - name: Tasks
    description: |
      Tasks are configurable units of work that tie one or more evaluators to a
      data source (project or dataset). Use tasks to automate evaluation of LLM
      outputs, with support for continuous evaluation and backfill runs.
  - name: Users
    description: >
      Users represent members of an account. The Users endpoints allow creating,

      listing, updating (display name), and removing users from the account
      programmatically.
paths:
  /v2/datasets/{dataset_id}/examples:
    patch:
      tags:
        - Datasets
      summary: Update existing examples in a dataset
      description: >
        Updates existing dataset examples by matching their `id` field.


        an example ID does not match any existing example in the dataset

        version, it will be ignored. In other words, only examples with IDs

        that already exist will be updated. To add new examples, use the

        Insert Dataset Examples endpoint.


        Adding columns that do not exist in the dataset schema is allowed, but

        removing existing columns is not.


        Optionally, the update can create a new version of the dataset. In

        this case, the outcome of the update will be reflected only in the new

        version, while the previous version remains unchanged. If a new

        version is not created, the updates will be applied directly (in place)

        to the specified version.


        **Payload Requirements**

        - Each item in `examples[]` may contain any user-defined fields.

        - Each item in `examples[]` must include the `id` field to identify the

        example to update.

        - Do not include system-managed fields on input: `created_at`,
        `updated_at`.

        Requests that contain these fields in any example will be rejected.

        - Each example must contain at least one property (i.e., `{}` is
        invalid).


        **Valid example** (create)

        ```json

        {
          "examples": [
            {
              "id": "ex_001",
              "question": "What is 2+2?",
              "answer": "4",
              "topic": "math"
            }
          ]
        }

        ```


        **Invalid example** ('id' missing for update)

        ```json

        {
          "examples": [
            {
              "input": "Hello"
            }
          ]
        }

        ```


        <Note>This endpoint is in beta, read more
        [here](https://arize.com/docs/ax/rest-reference#api-version-stages).</Note>
      operationId: datasets_examples_update
      parameters:
        - $ref: '#/components/parameters/DatasetIdPathParam'
        - $ref: '#/components/parameters/DatasetVersionIdQueryParam'
      requestBody:
        $ref: '#/components/requestBodies/UpdateDatasetExamplesRequestBody'
      responses:
        '200':
          $ref: '#/components/responses/DatasetExamplesUpdated'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  parameters:
    DatasetIdPathParam:
      name: dataset_id
      in: path
      description: The unique dataset identifier (base64)
      required: true
      schema:
        $ref: '#/components/schemas/Id'
      example: RGF0YXNldDoxMjM0NQ==
    DatasetVersionIdQueryParam:
      name: dataset_version_id
      in: query
      description: The unique identifier of the dataset version
      schema:
        $ref: '#/components/schemas/Id'
      example: RGF0YXNldFZlcnNpb246MTIzNDU=
  requestBodies:
    UpdateDatasetExamplesRequestBody:
      description: Body containing dataset examples for update operation by ID matching
      required: true
      content:
        application/json:
          schema:
            required:
              - examples
            type: object
            properties:
              examples:
                type: array
                minItems: 1
                maxItems: 1000
                description: >-
                  Array of examples with 'id' field for matching and updating
                  existing records
                items:
                  $ref: '#/components/schemas/DatasetExampleUpdate'
              new_version:
                type: string
                description: |
                  Name for the new version. If provided (non-empty), creates a
                  new version with that name.

                  If omitted or empty, updates the existing version in-place.
          example:
            examples:
              - id: example_001
                question: What is 2 * 2?
              - id: example_002
                question: What is the square root of 64?
                answer: '8'
              - id: example_003
                question: If 9x = 36, what is x?
                topic: algebra
  responses:
    DatasetExamplesUpdated:
      description: Examples successfully updated in the dataset.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DatasetVersionWithExampleIds'
          example:
            id: RGF0YXNldDoxOmFCY0Q=
            name: Sample Dataset
            space_id: U3BhY2U6MTphQmNE
            created_at: '2024-01-01T12:00:00Z'
            updated_at: '2024-01-02T12:00:00Z'
            dataset_version_id: RGF0YXNldFZlcnNpb246MTphQmNE
            example_ids:
              - 550e8400-e29b-41d4-a716-446655440000
              - 6ba7b810-9dad-11d1-80b4-00c04fd430c8
    BadRequest:
      description: Invalid request
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 400
            title: Invalid request parameters
            detail: The 'name' field is required and must be a non-empty string.
            instance: /resource
            type: https://arize.com/docs/ax/rest-reference/errors#invalid-request
    Unauthorized:
      description: Authentication is required
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 401
            title: Authentication required
            detail: You must be authenticated to access this resource.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#authentication-required
    Forbidden:
      description: Insufficient permissions to access this resource
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 403
            title: Access forbidden
            detail: You do not have permission to access this resource.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#access-forbidden
    NotFound:
      description: Not found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 404
            title: Resource not found
            detail: The requested resource with ID '12345' was not found.
            instance: /resource/12345
            type: https://arize.com/docs/ax/rest-reference/errors#resource-not-found
    Conflict:
      description: Resource conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 409
            title: Resource conflict
            detail: A resource with the given identifier already exists.
            instance: /resource
            type: https://arize.com/docs/ax/rest-reference/errors#resource-conflict
    UnprocessableEntity:
      description: Unprocessable entity
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 422
            title: Unprocessable Entity
            detail: Minimum score must be less than maximum score.
            instance: /annotation-configs
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity
    RateLimitExceeded:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: |
            When throttled (429), how long to wait before retrying. Value is
            either a delta-seconds integer.
          schema:
            type: integer
            minimum: 0
          example: 42
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 429
            title: Rate limit exceeded
            detail: >-
              You have exceeded the allowed number of requests. Please try again
              later.
            instance: /resource
            type: >-
              https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded
  schemas:
    Id:
      type: string
      description: A universally unique identifier (base64-encoded opaque string).
      example: RW50aXR5OjEyMzQ1
    DatasetExampleUpdate:
      type: object
      description: |
        A dataset example with arbitrary user-defined fields. System-managed
        fields, except 'id', are excluded for update requests.
      properties:
        id:
          type: string
          description: System-assigned unique ID for the example
      required:
        - id
      additionalProperties: true
    DatasetVersionWithExampleIds:
      description: |
        A dataset with the IDs of examples that were inserted or updated.
        Includes the version the examples were written to and the list of
        affected example IDs.
      type: object
      required:
        - id
        - name
        - space_id
        - created_at
        - updated_at
        - dataset_version_id
        - example_ids
      properties:
        id:
          type: string
          description: Unique identifier for the dataset
        name:
          type: string
          description: Name of the dataset
        space_id:
          type: string
          description: Unique identifier for the space this dataset belongs to
        created_at:
          type: string
          description: Timestamp for when the dataset was created
          format: date-time
        updated_at:
          type: string
          description: Timestamp for the last update of the dataset
          format: date-time
        dataset_version_id:
          type: string
          description: >-
            Unique identifier for the dataset version the examples were written
            to
        example_ids:
          type: array
          description: IDs of the examples that were inserted or updated
          items:
            type: string
      additionalProperties: false
    Problem:
      type: object
      description: RFC 9457 Problem Details
      properties:
        title:
          type: string
          description: A short, human-readable summary of the problem type
        status:
          type: integer
          description: >-
            The HTTP status code generated by the origin server for this
            occurrence of the problem
        type:
          type: string
          format: uri-reference
          description: A URI reference that identifies the problem type
        detail:
          type: string
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem
        instance:
          type: string
          format: uri-reference
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem
      required:
        - title
        - status
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: <api-key>
      description: >
        Most Arize AI endpoints require authentication. For those endpoints that
        require authentication, include your API key in the request header using
        the format

        ``` Authorization: Bearer <api-key>

        ```

````