{"openapi":"3.0.1","info":{"title":"Generative Feedback Second","version":"1.0"},"servers":[{"url":"/"}],"paths":{"/api/conversation/v1/generative-rating-reviews":{"get":{"description":"Review and approve feedback, verified answers, and ratings left for retrieved queries.","operationId":"GenerativeFeedback_ListGenerativeExchangeRatingReviews","parameters":[{"description":"Parent collection for the knowledge domain; autogenerated and not editable.","in":"query","name":"collection_id","schema":{"type":"string"}},{"description":"Unique ID of the generative exchange item; if supplied, overrides the collection ID as a filter item; default is no entry.","in":"query","name":"generative_exchange_id","schema":{"type":"string"}},{"description":"Unique ID of the generative exchange item; if supplied, overrides the collection ID as a filter item; default is no entry.","in":"query","name":"status","schema":{"enum":["UNSPECIFIED","PENDING","COMPLETE"],"type":"string"}},{"description":"Unique identifier for the user who provided feedback; output field, automatically populated.","in":"query","name":"creator_id","schema":{"type":"string"}},{"description":"Rank value given by the user; valid responses are 1 (negative) and 5 (positive).","in":"query","name":"rank","schema":{"format":"int32","type":"integer"}},{"description":"Maximum page size is 100; default is 100.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"For multiple pages; must be specified in each request for two pages per sheet.","in":"query","name":"page_token","schema":{"type":"string"}},{"description":"Sort order for multi page requests; valid options are rank, rank desc, create_time, create_time desc.","in":"query","name":"order_by","schema":{"type":"string"}}],"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."}},"summary":"Generative Rating Reviews","tags":["GenerativeFeedback"]}},"/api/conversation/v1/generative-ratings":{"post":{"description":"Leave positive or negative ratings on retrieved queries.","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":"Create Generative Exchange Rating","tags":["GenerativeFeedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/generative-ratings/{data.rating.rating_id}/review":{"patch":{"description":"Update the reviews and approvals on feedback, verified answers, and ratings.","operationId":"GenerativeFeedback_UpdateGenerativeExchangeRatingReview","parameters":[{"description":"Unique identifier for the exchange rating; automatically generated.","in":"path","name":"data.rating.rating_id","required":true,"schema":{"type":"string"}}],"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":"Update Exchange Rating Item","tags":["GenerativeFeedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/generative-ratings/{data.rating_id}":{"patch":{"description":"Update the ratings left for retrieved queries.","operationId":"GenerativeFeedback_UpdateGenerativeExchangeRating","parameters":[{"description":"Unique identifier for exchange rating; automatically generated.","in":"path","name":"data.rating_id","required":true,"schema":{"type":"string"}}],"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."}},"summary":"Generative Ratings","tags":["GenerativeFeedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/generative-ratings/{rating_id}":{"delete":{"description":"Delete the ratings left for retrieved queries.","operationId":"GenerativeFeedback_DeleteGenerativeExchangeRating","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"type":"string"},"description":"Unique identifier for the exchange rating; automatically generated."}],"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."}},"summary":"Delete Generative Ratings","tags":["GenerativeFeedback"]},"get":{"description":"Display the ratings left for retrieved queries.","operationId":"GenerativeFeedback_GetGenerativeExchangeRating","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"type":"string"},"description":"Unique identifier for the exchange rating; automatically generated."}],"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":"Retrieve Generative Ratings","tags":["GenerativeFeedback"]}},"/api/conversation/v1/generative-ratings/{rating_id}/review":{"get":{"description":"Explore the reasoning behind reviews and approvals left on feedback, verified answers, and ratings.","operationId":"GenerativeFeedback_GetGenerativeExchangeRatingReview","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"type":"string"},"description":"Unique identifier for the exchange rating; automatically generated."}],"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":"Retrieve Exchange Rating Perspective","tags":["GenerativeFeedback"]}}},"components":{"schemas":{"googlerpcStatus":{"properties":{"code":{"format":"int32","type":"integer"},"message":{"type":"string"},"details":{"items":{"$ref":"#/components/schemas/protobufAny"},"type":"array"}},"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"},"v1CollectionMetadata":{"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"},"v1CreateGenerativeExchangeRatingRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1GenerativeExchangeRating"}},"type":"object"},"v1GenerativeExchangeRating":{"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"},"v1GenerativeExchangeRatingReview":{"properties":{"rating":{"$ref":"#/components/schemas/v1GenerativeExchangeRating"},"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"}},"title":"Authority perspective of an Exchange Rating","type":"object"},"v1GenerativeExchangeRatingReviewStatus":{"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"},"v1GetGenerativeExchangeRatingResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1GenerativeExchangeRating"}},"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":"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"},"v1ResourceMetadata":{"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"},"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"},"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"}}},"x-original-swagger-version":"2.0"}