> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Patch Evaluation Group

> Partially update an evaluation group's attributes.

Only the fields present in the request are changed; unset fields are left untouched.
Unlike the PUT endpoint, metadata is merged into the existing metadata key-by-key
rather than replaced wholesale, and group membership (evaluation_ids) cannot be
changed here -- use PUT to replace members. At least one field must be supplied or the
request fails with a 400. Supplying row_identifiers replaces the group's entire row
identifier set (an evaluation_id-to-column-name mapping for cross-dataset joins);
passing an empty mapping clears it.



## OpenAPI

````yaml https://api.dev-sgp.scale.com/openapi-versions/v5/openapi.json patch /v5/evaluation-groups/{group_id}
openapi: 3.1.0
info:
  title: EGP API V5
  description: >-
    This is the parent API for all EGP APIs. If you are looking for the EGP API,
    please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
  - url: https://api.egp.scale.com
security: []
paths:
  /v5/evaluation-groups/{group_id}:
    patch:
      tags:
        - Evaluation Groups
      summary: Patch Evaluation Group
      description: >-
        Partially update an evaluation group's attributes.


        Only the fields present in the request are changed; unset fields are
        left untouched.

        Unlike the PUT endpoint, metadata is merged into the existing metadata
        key-by-key

        rather than replaced wholesale, and group membership (evaluation_ids)
        cannot be

        changed here -- use PUT to replace members. At least one field must be
        supplied or the

        request fails with a 400. Supplying row_identifiers replaces the group's
        entire row

        identifier set (an evaluation_id-to-column-name mapping for
        cross-dataset joins);

        passing an empty mapping clears it.
      operationId: PATCH-V5-/v5/evaluation-groups/group_id
      parameters:
        - name: group_id
          in: path
          required: true
          schema:
            type: string
            title: Group Id
        - name: x-selected-account-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluationGroupPatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationGroup'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    EvaluationGroupPatchRequest:
      properties:
        tags:
          title: Tags
          description: The tags associated with the entity
          items:
            type: string
          type: array
        name:
          type: string
          maxLength: 128
          title: Name
          description: Name of the evaluation group
        description:
          title: Description
          description: Optional description
          type: string
        metadata:
          title: Metadata
          description: Optional metadata key-value pairs
          additionalProperties: true
          type: object
        row_identifiers:
          title: Row Identifiers
          description: >-
            Optional mapping of evaluation_id to column name for cross-dataset
            joins
          additionalProperties:
            type: string
          type: object
      type: object
      title: EvaluationGroupPatchRequest
      description: >-
        Request model for partial update of evaluation group attributes (name,
        description, tags, metadata, row_identifiers) (PATCH)
    EvaluationGroup:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the evaluation group
        object:
          type: string
          const: evaluation_group
          title: Object
          default: evaluation_group
        tags:
          title: Tags
          description: The tags associated with the entity
          items:
            type: string
          type: array
        name:
          type: string
          title: Name
          description: Name of the evaluation group
        description:
          title: Description
          description: Optional description
          type: string
        metadata:
          title: Metadata
          description: Optional metadata key-value pairs
          additionalProperties: true
          type: object
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the group was created
        deleted_at:
          title: Deleted At
          description: When the group was soft-deleted
          type: string
          format: date-time
        account_id:
          type: string
          title: Account Id
          description: Account that owns this evaluation group
        members:
          title: Members
          description: Evaluation members in this group. Populated with 'members' view.
          items:
            $ref: '#/components/schemas/EvaluationGroupMember'
          type: array
        row_identifiers:
          title: Row Identifiers
          description: Row identifier mappings. Populated with 'row_identifiers' view.
          items:
            $ref: '#/components/schemas/EvaluationGroupRowIdentifier'
          type: array
      type: object
      required:
        - tags
        - id
        - name
        - created_at
        - account_id
      description: Response model for evaluation group
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EvaluationGroupMember:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the member record
        object:
          type: string
          const: evaluation_group.member
          title: Object
          default: evaluation_group.member
        evaluation_group_id:
          type: string
          title: Evaluation Group Id
          description: ID of the evaluation group
        evaluation_id:
          type: string
          title: Evaluation Id
          description: ID of the evaluation
        evaluation_name:
          title: Evaluation Name
          description: Name of the evaluation
          type: string
        evaluation_tags:
          title: Evaluation Tags
          description: Tags of the evaluation
          items:
            type: string
          type: array
        evaluation_created_at:
          title: Evaluation Created At
          description: When the evaluation was created
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When this member was added to the group
        deleted_at:
          title: Deleted At
          description: When this membership was soft-deleted (if applicable)
          type: string
          format: date-time
      type: object
      required:
        - id
        - evaluation_group_id
        - evaluation_id
        - created_at
      description: Response model for evaluation group member
    EvaluationGroupRowIdentifier:
      properties:
        object:
          type: string
          const: evaluation_group.row_identifier
          title: Object
          default: evaluation_group.row_identifier
        evaluation_id:
          type: string
          title: Evaluation Id
          description: ID of the evaluation
        column_name:
          type: string
          title: Column Name
          description: Name of the column used as row identifier
      type: object
      required:
        - evaluation_id
        - column_name
      description: Response model for evaluation group row identifier
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````