Skip to content

ResponseOutputTextAnnotationAddedEvent annotation property should be a ref to the annotation component #509

@baywet

Description

@baywet
 ResponseOutputTextAnnotationAddedEvent:
      type: object
      title: ResponseOutputTextAnnotationAddedEvent
      description: |
        Emitted when an annotation is added to output text content.
      properties:
        type:
          type: string
          enum:
            - response.output_text.annotation.added
          description: The type of the event. Always 'response.output_text.annotation.added'.
          x-stainless-const: true
        item_id:
          type: string
          description: The unique identifier of the item to which the annotation is being added.
        output_index:
          type: integer
          description: The index of the output item in the response's output array.
        content_index:
          type: integer
          description: The index of the content part within the output item.
        annotation_index:
          type: integer
          description: The index of the annotation within the content part.
        sequence_number:
          type: integer
          description: The sequence number of this event.
        annotation:
-           type: object
+          $ref: "#/components/schemas/Annotation"
          description: The annotation object being added. (See annotation schema for details.)

This will improve the developer experience in the SDKs across all languages. https://github.com/openai/openai-python/blob/f94256daf8f5d7268f28c2330dc343660a959c3e/src/openai/types/responses/response_output_text_annotation_added_event.py#L13

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions