Pryon Generative Feedback API

openapi: 3.2.0
info:
  title: Pryon Generative Feedback API
  version: '1.0'
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  description: 'Operations tagged GenerativeFeedback across 3 of this provider''s published API definitions: pryon-admin-openapi.json, pryon-generative-feedback-may2025-openapi.json, pryon-generativefeedback-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.pryon.net
  description: Pryon Cloud
- url: /
tags:
- name: GenerativeFeedback
paths:
  /api/conversation/v1/generative-rating-reviews:
    get:
      operationId: GenerativeFeedback_ListGenerativeExchangeRatingReviews
      parameters:
      - description: Required. Filter list output to only include ratings for a knowledge collection. In REST form the parameter is expressed as 'collection_id'.
        in: query
        name: collection_id
        schema:
          type: string
      - description: Filter list output to only include ratings for a particular exchange. Overrides the collection_id filter value if supplied. Defaults to empty which disables this filter. In REST form the parameter is expressed as 'exchange_id'.
        in: query
        name: generative_exchange_id
        schema:
          type: string
      - description: "Filter list output to only include ratings that are in requested review status. Defaults to UNSPECIFIED which disables this filter. In REST form the parameter is expressed as 'status' with valid values PENDING and COMPLETE.\n\n - UNSPECIFIED: Not a valid exchange rating value\n - PENDING: This exchange rating is waiting to be inspected for approval or rejection (default).\n - COMPLETE: This exchange rating has been inspected and acted upon. No further action will be taken."
        in: query
        name: status
        schema:
          default: UNSPECIFIED
          enum:
          - UNSPECIFIED
          - PENDING
          - COMPLETE
          type: string
      - description: Filter list output to only include ratings made by a given user. In REST form the parameter is expressed as 'creator_id'.
        in: query
        name: creator_id
        schema:
          type: string
      - description: Filter list output to only include ratings that match a given rank value. In REST form the parameter is expressed as 'rank' with valid values 1-5.
        in: query
        name: rank
        schema:
          format: int32
          type: integer
      - description: 'Default page size is 100 when omitted. The maximum page size is 100.

          The REST query parameter is "page_size".

          See https://cloud.google.com/apis/design/design_patterns#list_pagination for details.'
        in: query
        name: page_size
        schema:
          format: int32
          type: integer
      - description: 'If there are multiple pages, pages 2-N must specify this parameter using the value of next_page_token provided in the previous page''s response. The REST query parameter is "page_token".

          See https://cloud.google.com/apis/design/design_patterns#list_pagination for details.'
        in: query
        name: page_token
        schema:
          type: string
      - description: 'If the sort order parameter is provided with a multi page request, it must be provided on all subsequent page requests.

          For exchange requests the valid options are: rank, rank desc, create_time, create_time desc.

          see https://cloud.google.com/apis/design/design_patterns#sorting_order.'
        in: query
        name: order_by
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1ListGenerativeExchangeRatingReviewsResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      tags:
      - GenerativeFeedback
      summary: ListGenerativeExchangeRatingReviews
      description: ''
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/conversation/v1/generative-ratings:
    post:
      operationId: GenerativeFeedback_CreateGenerativeExchangeRating
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1CreateGenerativeExchangeRatingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetGenerativeExchangeRatingResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      summary: CreateGenerativeExchangeRating
      tags:
      - GenerativeFeedback
      x-codegen-request-body-name: body
      description: Create a generative exchange rating.
      parameters:
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/conversation/v1/generative-ratings/{data.rating.rating_id}/review:
    patch:
      operationId: GenerativeFeedback_UpdateGenerativeExchangeRatingReview
      parameters:
      - description: UUID that uniquely identifies a particular exchange rating. Automatically generated on create.
        in: path
        name: data.rating.rating_id
        required: true
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1UpdateGenerativeExchangeRatingReviewRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetGenerativeExchangeRatingReviewResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      summary: UpdateGenerativeExchangeRatingReview
      tags:
      - GenerativeFeedback
      x-codegen-request-body-name: body
      description: A reviewing authority can update the review perspective of an exchange rating item. This includes review information not available to un-privileged users.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/conversation/v1/generative-ratings/{data.rating_id}:
    patch:
      operationId: GenerativeFeedback_UpdateGenerativeExchangeRating
      parameters:
      - description: UUID that uniquely identifies a particular exchange rating. Automatically generated on create.
        in: path
        name: data.rating_id
        required: true
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v1UpdateGenerativeExchangeRatingRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetGenerativeExchangeRatingResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      tags:
      - GenerativeFeedback
      x-codegen-request-body-name: body
      summary: UpdateGenerativeExchangeRating
      description: ''
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/conversation/v1/generative-ratings/{rating_id}:
    delete:
      operationId: GenerativeFeedback_DeleteGenerativeExchangeRating
      parameters:
      - in: path
        name: rating_id
        required: true
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      tags:
      - GenerativeFeedback
      summary: DeleteGenerativeExchangeRating
      description: ''
    get:
      operationId: GenerativeFeedback_GetGenerativeExchangeRating
      parameters:
      - in: path
        name: rating_id
        required: true
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetGenerativeExchangeRatingResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      tags:
      - GenerativeFeedback
      summary: GetGenerativeExchangeRating
      description: ''
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
  /api/conversation/v1/generative-ratings/{rating_id}/review:
    get:
      operationId: GenerativeFeedback_GetGenerativeExchangeRatingReview
      parameters:
      - in: path
        name: rating_id
        required: true
        schema:
          type: string
      - name: Authentication
        in: header
        required: true
        schema:
          type: string
        example: 'Authorization: Bearer {base64-encoded-token}'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1GetGenerativeExchangeRatingReviewResponse'
          description: A successful response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
          description: An unexpected error response.
      summary: GetGenerativeExchangeRatingReview
      tags:
      - GenerativeFeedback
      description: A reviewing authority can retrieve the review perspective of an exchange rating item. This includes review information not available to un-privileged users.
    servers:
    - url: https://api.pryon.net
      description: Pryon Cloud
components:
  schemas:
    v1GenerativeExchangeRatingReviewStatus:
      default: UNSPECIFIED
      description: " - UNSPECIFIED: Not a valid exchange rating value\n - PENDING: This exchange rating is waiting to be inspected for approval or rejection (default).\n - COMPLETE: This exchange rating has been inspected and acted upon. No further action will be taken."
      enum:
      - UNSPECIFIED
      - PENDING
      - COMPLETE
      type: string
    googlerpcStatus:
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
        details:
          items:
            $ref: '#/components/schemas/protobufAny'
          type: array
      type: object
    v1UpdateGenerativeExchangeRatingRequest:
      properties:
        data:
          $ref: '#/components/schemas/v1GenerativeExchangeRating'
        update_mask:
          items:
            type: string
          title: "Required. The data path corresponding to the fields being updated in this request.\nExchange Rating Reviewer can update the following fields:\n   data.flagged\n   data.status\nExample mask declaration in JSON format:\n   updateMask: \"data.flagged\"\nsee https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask"
          type: array
      type: object
    v1CollectionMetadata:
      properties:
        uuid:
          description: Random UUID returned in the resource response to represent the unique interaction with the API.  This can be thought of as a response id.
          type: string
        response_time_millis:
          description: Time difference in milliseconds between when the request was received and when the response was generated, that is, the latency.
          format: int64
          type: integer
      title: Metadata that will be returned with each collection-level GET
      type: object
    protobufAny:
      properties:
        type_url:
          type: string
        value:
          format: byte
          pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
          type: string
      type: object
    v1GenerativeExchangeRatingReview:
      properties:
        rating:
          $ref: '#/components/schemas/v1GenerativeExchangeRating'
        collection_id:
          description: UUID of the knowledge collection from which the exchange being rated came. Automatically populated on create. Immutable.
          type: string
        knowledge_domain_id:
          description: UUID of the knowledge domain from which the exchange being rated came. Automatically populated on create. Immutable.
          type: string
        reviewer_ids:
          description: Output field only, automatically populated. IDs of the reviewing authorities that viewed/inspected this item.
          items:
            type: string
          type: array
        flagged:
          description: Reviewing authorities can flag this rating item upon inspection. The exact meaning of flagging is intentionally vague and is left to the API to use as necessary.
          type: boolean
        approval_id:
          description: Output field only, automatically populated. The approval item related to this exchange rating. May be empty.
          type: string
        status:
          $ref: '#/components/schemas/v1GenerativeExchangeRatingReviewStatus'
      title: Authority perspective of an ExchangeRating
      type: object
    v1GetGenerativeExchangeRatingResponse:
      properties:
        metadata:
          $ref: '#/components/schemas/v1ResourceMetadata'
        data:
          $ref: '#/components/schemas/v1GenerativeExchangeRating'
      type: object
    v1CreateGenerativeExchangeRatingRequest:
      properties:
        data:
          $ref: '#/components/schemas/v1GenerativeExchangeRating'
      type: object
    v1ResourceMetadata:
      properties:
        uuid:
          description: UUID returned in the resource response, which represents the unique interaction with the API, that is, the response id.
          type: string
        create_time:
          description: Time of the initial request.
          format: date-time
          type: string
        update_time:
          description: 'Time of the last update.

            A value of 0 indicates it has never been updated.'
          format: date-time
          type: string
        response_time_millis:
          format: int64
          title: Time difference in milliseconds between when the request was received and when the response was generated
          type: integer
      type: object
    v1UpdateGenerativeExchangeRatingReviewRequest:
      properties:
        data:
          $ref: '#/components/schemas/v1GenerativeExchangeRatingReview'
        update_mask:
          items:
            type: string
          title: "Required. The data path corresponding to the fields being updated in this request.\nExchange Rating Reviewer can update the following fields:\n   data.flagged\n   data.status\nExample mask declaration in JSON format:\n   updateMask: \"data.flagged\"\nsee https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask"
          type: array
      type: object
    v1GenerativeExchangeRating:
      properties:
        rating_id:
          description: UUID that uniquely identifies a particular exchange rating. Automatically generated on create.
          type: string
        generative_exchange_id:
          description: 'Required. This is an GenerativeExchangeResponseData''s generative_exchange_id from Exchange API''s response.

            Specify type and populate this field. ExchangeRatings can only be created for exchanges matching active domains.'
          type: string
        exchange_id:
          description: Optional. An ID representing an extractive exchange_id associated with this response object from sources.
          type: string
        exchange_output_ids:
          description: 'Optional. A list of output_ids from extractive output that this generated answer is for.

            Relevant to n-best extractive exchange responses. Defaults to "best_1".

            Note: This must exist alongside the generative response, and not be chit-chat, otherwise it will be ignored.'
          items:
            type: string
          type: array
        creator_id:
          description: Output field only, automatically populated. User ID (e.g. email address) that provided this feedback.
          type: string
        question:
          description: Output field only, automatically populated. The question that was recorded for the exchange that is being rated.
          type: string
        rank:
          description: Required. The rank value given by the user. Range from 1 to 5 with 5 being the most positive rating.
          format: int32
          type: integer
        message:
          description: Optional user comment. Provides additional context on the rating. For example, a rating of 5 means "The answer was on topic and helpful".
          type: string
        freeform_text:
          description: Optional freeform text for feedback provider.
          type: string
      type: object
    v1GetGenerativeExchangeRatingReviewResponse:
      properties:
        metadata:
          $ref: '#/components/schemas/v1ResourceMetadata'
        data:
          $ref: '#/components/schemas/v1GenerativeExchangeRatingReview'
      type: object
    v1ListGenerativeExchangeRatingReviewsResponse:
      properties:
        metadata:
          $ref: '#/components/schemas/v1CollectionMetadata'
        items:
          items:
            $ref: '#/components/schemas/v1GetGenerativeExchangeRatingReviewResponse'
          type: array
        next_page_token:
          description: 'If there are multiple pages, this will be returned and must be specified in each request for pages 2-N using the "page_token" query param.  However, the only reliable way to know if more pages exist is to request the next page when a full page of items is returned.

            See https://cloud.google.com/apis/design/design_patterns#list_pagination for details.'
          type: string
        total_size:
          description: 'This is the total number of items in the collection across all the pages matching the given list filter.

            It is returned with every page and may change during page traversal.

            See https://cloud.google.com/apis/design/design_patterns#list_pagination for more details.'
          format: int32
          type: integer
        page_size:
          description: Returned for convenience and clarity - same as page_size in request.
          format: int32
          type: integer
        order_by:
          description: Returned for convenience and clarity - same as order_by in request.
          type: string
      type: object
    v1GenerativeExchangeRatingReviewStatus_2:
      description: " - UNSPECIFIED: Not a valid exchange rating value.\n - PENDING: Waiting to be inspected for approval or rejection.\n - COMPLETE: Inspected and acted upon; no further action required."
      type: string
    v1CollectionMetadata_2:
      properties:
        uuid:
          description: Unique identifier for the interaction returned in the resource response; the response ID.
          type: string
        response_time_millis:
          description: Response time (in milliseconds).
          format: int64
          type: integer
      title: Metadata that will be returned with each collection-level GET
      type: object
    v1GenerativeExchangeRatingReview_2:
      properties:
        rating:
          $ref: '#/components/schemas/v1GenerativeExchangeRating_2'
        collection_id:
          description: Parent collection for the knowledge domain; autogenerated and not editable.
          type: string
        knowledge_domain_id:
          description: Unique identifier of the knowledge domain that supplied the exchange response; autogenerated and not editable.
          type: string
        reviewer_ids:
          description: Unique identifiers of the reviewing authorities that viewed/inspected the item; output only, automatically populated.
          items:
            type: string
          type: array
        flagged:
          description: Item noted by reviewing authorities upon inspection; intentionally vague and left to the API to use as necessary.
          type: boolean
        approval_id:
          description: Approval item for exchange event; output only; automatically populated.
          type: string
        status:
          $ref: '#/components/schemas/v1GenerativeExchangeRatingReviewStatus_2'
      title: Authority perspective of an Exchange Rating
      type: object
    v1ResourceMetadata_2:
      properties:
        uuid:
          description: Unique identifier for the interaction returned in the resource response; the response ID.
          type: string
        create_time:
          description: Time of the initial request.
          format: date-time
          type: string
        update_time:
          description: Time of the last update; 0 indicates updates have never been made.
          format: date-time
          type: string
        response_time_millis:
          description: Response time (in milliseconds).
          format: int64
          type: integer
      type: object
    v1GenerativeExchangeRating_2:
      properties:
        rating_id:
          description: Unique identifier for the exchange rating; automatically generated.
          type: string
        generative_exchange_id:
          description: Unique ID of the generative exchange item; if supplied, overrides the collection ID as a filter item; default is no entry.
          type: string
        exchange_id:
          description: Unique ID of the exchange item.
          type: string
        exchange_output_ids:
          description: Output IDs from extractive output for the generated answer; defaults to best_1; answers deemed chit-chat are ignored.
          items:
            type: string
          type: array
        creator_id:
          description: Unique identifier for the user who provided feedback; output field, automatically populated.
          type: string
        question:
          description: Question asked for the rated exchange; output only, automatically populated.
          type: string
        rank:
          description: Rank value given by the user; valid responses are 1 (negative) and 5 (positive).
          format: int32
          type: integer
        message:
          description: User comment that provides additional context on the rating.
          type: string
        freeform_text:
          description: Optional freeform text for feedback provider.
          type: string
      type: object
    v1ListGenerativeExchangeRatingReviewsResponse_2:
      properties:
        metadata:
          $ref: '#/components/schemas/v1CollectionMetadata_2'
        items:
          items:
            $ref: '#/components/schemas/v1GetGenerativeExchangeRatingReviewResponse'
          type: array
        next_page_token:
          description: Returned for multiple pages; must be specified in each request for two pages per sheet using the page token parameter.
          type: string
        total_size:
          description: Total number of items in the collection across all pages.
          format: int32
          type: integer
        page_size:
          description: From the request; same as page size.
          format: int32
          type: integer
        order_by:
          description: From the request; same as order by.
          type: string
      type: object
x-refined-from:
- pryon-admin-openapi.json
- pryon-generative-feedback-may2025-openapi.json
- pryon-generativefeedback-api-openapi.yml
x-original-swagger-version: '2.0'
x-tagGroups:
- name: Retrieval
  tags:
  - Exchange
  - ExchangeEvent
  - Feedback
  - GenerativeExchange
  - GenerativeFeedback
  - TextToSpeech
- name: Reporting
  tags:
  - Analytics
  - Reports
  - Usage
- name: Collection Management
  tags:
  - KnowledgeCollectionService
  - KnowledgeDomain
  - ContentService
  - RegressionTest
  - Subjects
- name: Organization Management
  tags:
  - ConnectorServiceExternal
  - OrganizationService
  - Messages
- name: Ops Console
  tags:
  - Operations