Pryon Feedback API

{"openapi":"3.0.1","info":{"title":"Feedback","version":"1.0"},"servers":[{"url":"/"}],"paths":{"/api/conversation/v1/approvals":{"get":{"operationId":"Feedback_ListApprovals","parameters":[{"description":"Unique identifier for the knowledge domain that list approval items.","in":"query","name":"knowledge_domain_id","schema":{"type":"string"}},{"description":"Unique identifier for the knowledge domain succession ID of the approved review.","in":"query","name":"kd_succession_id","schema":{"type":"string"}},{"description":"Filters items by a specific approval status.\n\n - PENDING_REVIEW: Item is pending review.\n - REJECTED: Item has been rejected.\n - APPROVED: Item has been approved.","in":"query","name":"approval_status","schema":{"enum":["UNSPECIFIED","PENDING_REVIEW","REJECTED","APPROVED"],"type":"string"}},{"description":"When set to True, returns only the item keys.","in":"query","name":"return_only_item_keys","schema":{"type":"boolean"}},{"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/v1ListApprovalsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Approval Entries","tags":["Feedback"]},"post":{"operationId":"Feedback_CreateApproval","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CreateApprovalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CreateApprovalResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Approval Entry","tags":["Feedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/approvals/{approval_id}":{"delete":{"operationId":"Feedback_DeleteApproval","parameters":[{"description":"Unique identifier of item to be deleted.","in":"path","name":"approval_id","required":true,"schema":{"type":"string"}}],"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 Approval Entry","tags":["Feedback"]},"get":{"operationId":"Feedback_GetApproval","parameters":[{"description":"Unique identifier of approval item.","in":"path","name":"approval_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetApprovalResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Information on Approval Entry","tags":["Feedback"]}},"/api/conversation/v1/approvals/{data.approval_id}":{"patch":{"operationId":"Feedback_UpdateApproval","parameters":[{"description":"Unique identifier of approval item.","in":"path","name":"data.approval_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1UpdateApprovalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1UpdateApprovalResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Modify Approval Entry","tags":["Feedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/rating-reviews":{"get":{"operationId":"Feedback_ListExchangeRatingReviews","parameters":[{"description":"The collection, or index, that the exchange is performed against.","in":"query","name":"collection_id","schema":{"type":"string"}},{"description":"Unique ID of the exchange item; overrides the collection_id filter value if supplied; defaults to empty, which disables this filter.","in":"query","name":"exchange_id","schema":{"type":"string"}},{"description":"Filters the list for ratings in a specific review status; the default of UNSPECIFIED disables the filter.\n\n - UNSPECIFIED: Not a valid exchange rating value.\n - PENDING: Exchange rating is waiting to be inspected for approval or rejection.\n - COMPLETE: Exchange rating has been inspected and acted upon; no further action taken.","in":"query","name":"status","schema":{"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/v1ListExchangeRatingReviewsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Exchange Rating Reviews","tags":["Feedback"]}},"/api/conversation/v1/ratings":{"post":{"operationId":"Feedback_CreateExchangeRating","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CreateExchangeRatingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetExchangeRatingResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Exchange Rating","tags":["Feedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/ratings/{data.rating.rating_id}/review":{"patch":{"operationId":"Feedback_UpdateExchangeRatingReview","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/v1UpdateExchangeRatingReviewRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetExchangeRatingReviewResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Review Exchange Rating","tags":["Feedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/ratings/{data.rating_id}":{"patch":{"operationId":"Feedback_UpdateExchangeRating","parameters":[{"description":"Unique identifier for the exchange rating; automatically generated.","in":"path","name":"data.rating_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1UpdateExchangeRatingRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetExchangeRatingResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Modify Exchange Rating","tags":["Feedback"],"x-codegen-request-body-name":"body"}},"/api/conversation/v1/ratings/{rating_id}":{"delete":{"operationId":"Feedback_DeleteExchangeRating","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"description":"Unique identifier for the exchange rating; automatically generated.","type":"string"}}],"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 Exchange Rating","tags":["Feedback"]},"get":{"operationId":"Feedback_GetExchangeRating","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"description":"Unique identifier for the exchange rating; automatically generated.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetExchangeRatingResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Retrieve Exchange Rating","tags":["Feedback"]}},"/api/conversation/v1/ratings/{rating_id}/review":{"get":{"operationId":"Feedback_GetExchangeRatingReview","parameters":[{"in":"path","name":"rating_id","required":true,"schema":{"description":"Unique identifier for the exchange rating; automatically generated.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1GetExchangeRatingReviewResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Retrieve Exchange Rating Review","tags":["Feedback"]}}},"components":{"schemas":{"ApprovalItemApprovalStatus":{"description":"Filters items by a specific approval status.\n\n - UNSPECIFIED: Default.\n- PENDING_REVIEW: Item is pending review.\n - REJECTED: Item has been rejected.\n - APPROVED: Item has been approved.","title":"- PENDING_REVIEW: Item is pending review.\n - REJECTED: Item has been rejected.\n - APPROVED: Item has been approved.","type":"string"},"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"},"v1ApprovalItem":{"properties":{"approval_status":{"$ref":"#/components/schemas/ApprovalItemApprovalStatus"},"approval_id":{"description":"Unique identifier of approval item.","type":"string"},"conv_review_id":{"description":"Unique identifier for conversational review of the approved exchange output.","type":"string"},"exchange_id":{"description":"Unique identifier for the parent exchange of the approved review.","type":"string"},"knowledge_domain_id":{"description":"Unique identifier for the knowledge domain of the approved review.","type":"string"},"kd_succession_id":{"description":"Unique identifier for the knowledge domain succession ID of the approved review.","type":"string"},"input_understood_text":{"description":"Normalized input text of exchange question.","type":"string"},"output_text":{"description":"Answer output text displayed to the user.","type":"string"},"approver_id":{"readOnly":true,"description":"Unique identifier for the organization administrator who approved the review.","type":"string"},"uri":{"description":"Link to additional information.","type":"string"},"uri_display_name":{"description":"Display name for the link to additional information.","type":"string"},"contact_info":{"$ref":"#/components/schemas/v1ContactInfo"},"attachments":{"additionalProperties":{"$ref":"#/components/schemas/v1Attachment"},"description":"Attachments from the associated exchange output.","type":"object"}},"type":"object"},"v1Attachment":{"properties":{"content_type":{"description":"The content type of the additional information. Format of each type field is application/vnd.pryon.**{content_type}**. Commonly occurring types are:\n- **text** - The answer snippet or the text corresponding to detected short spans within the answer_in_context. Best_n will be the same string as the ‘text’ field and represents the ranking of the sentence within the AIC/chunk.\n- **answer_in_context** - Chunk of text identified as most relevant to the input query. The smaller text answer/reply is extracted from this larger text.\n- **answer_type** - Answer type or classification. Answer types include:\n   - **TEXT_EXCERPT**: Default.\n   - **FAQ**: An answer derived from the frequently asked questions.\n   - **OUT_OF_DOMAIN**: A query that is out of domain.\n   - **NON_ASCII_OUT_OF_SCOPE**: A query that is out of scope due to non ascii characters.\n   - **BELOW_THRESHOLD**: The best answer scored below the minimum specified score.\n   - **NO_ANSWER**: No suitably scored answer was found.\n- **answer_approval_id** - Approval ID of matching verified answer - valid UUID v4 string.\n- **score** - An approximation of the strength of the returned answer and answer_in_context chunk, or the float score returned from a model.\n- **level** - Configurable answer confidence levels to categorize outputs.\n- **content_id** - content_id of the knowledge domain content where the answer is located. A client application may use the content API to get more information about the content.\n- **content_display_name** - Display name of the source file that includes the best sentence answer.\n- **content_source_location** - URL of the source content where the answer and chunk are located.\n- **index** - Index into a custom data source.\n- **followup_choice** - Indicates a multiple-choice question is being returned to the user as a reply to their request.  Each of the choices will be an attachment with this value.\n- **related_questions** - Questions related to the input question. e.g. key: rq_best_<ix>, value: {content_type:application/vnd.pryon.related_questions, content: <string>}, where ix is the index from 1 onwards.\n- **related_questions_score** - Score of a Related Question, e.g. key: rq_score_best_<ix>, value: {content_type:application/vnd.pryon.related_questions_score, content: <string>}, where ix is the index from 1 onwards.\n- **followup_questions** - Followup Question to the input question. e.g. key: fq_best_<ix>, value: {content_type:application/vnd.pryon.followup_questions, content: <string>}, where ix is the index from 1 onwards.\n- **followup_questions_score** - Followup Question score. e.g. key: fq_score_best_<ix>, value: {content_type:application/vnd.pryon.followup_questions_score, content: <string>}.\n- **start_page** - Page number where the answer_in_context or the chunk starts in a PDF.\n- **start_page_bbox** - Bounding box of the entire page on which the answer is found.\n- **end_page** - Page number where the answer_in_context ends in a PDF.\n- **start_char_index** - Index of the first occurrence of the best_sentence or answer substring within the surrounding answer_in_context chunk.\n- **end_char_index** - Index of the last occurrence of the best_sentence or answer substring within the surrounding answer_in_context chunk.\n- **bbox** - Bounding box coordinates returned as a list of four floating point numbers representing the top-left and bottom-right corners of the box for the answer snippet on the source document image.\n- **flag** - Boolean flag with either true or false values.\n- **texttrack_cue** - relative time offset from the beginning of the video associated with the short answer. e.g. key: \"texttrack_cue\", value: {content_type: application/vnd.pryon.texttrack_cue, content: <HH:MM:SS>}.","type":"string"},"content":{"description":"The content of the additional information.","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"},"v1ContactInfo":{"properties":{"contact_name":{"description":"Name of the contact person.","type":"string"},"contact_email":{"description":"Email of the contact person.","type":"string"}},"type":"object"},"v1CreateApprovalRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1CreateApprovalResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1CreateExchangeRatingRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1ExchangeRating"}},"type":"object"},"v1ExchangeRating":{"properties":{"rating_id":{"description":"Unique identifier for the exchange rating; automatically generated.","type":"string"},"exchange_id":{"description":"Unique identifier for the parent exchange of the approved review.","type":"string"},"output_id":{"description":"Output IDs from extractive output for the generated answer; defaults to best_1; answers deemed chit-chat are ignored.","type":"string"},"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"},"v1ExchangeRatingReview":{"properties":{"rating":{"$ref":"#/components/schemas/v1ExchangeRating"},"collection_id":{"description":"Unique identifier for the knowledge collection that returned the exchange being rated; automatically populated and not editable.","type":"string"},"knowledge_domain_id":{"description":"Unique identifier for the knowledge collection that returned the exchange being rated; automatically populated 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":"Unique identifier of approval item related to the exchange rating.","type":"string"},"status":{"$ref":"#/components/schemas/v1ExchangeRatingReviewStatus"}},"title":"Authority perspective of an Exchange Rating","type":"object"},"v1ExchangeRatingReviewStatus":{"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.","type":"string"},"v1GetApprovalResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1GetExchangeRatingResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ExchangeRating"}},"type":"object"},"v1GetExchangeRatingReviewResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ExchangeRatingReview"}},"type":"object"},"v1ListApprovalItem":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1ListApprovalsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1CollectionMetadata"},"items":{"description":"Approval items that meet the filter or sort criteria.","items":{"$ref":"#/components/schemas/v1ListApprovalItem"},"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":"Same as page size in request.","format":"int32","type":"integer"},"order_by":{"description":"Same as order_by in request.","type":"string"}},"type":"object"},"v1ListExchangeRatingReviewsResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1CollectionMetadata"},"items":{"items":{"$ref":"#/components/schemas/v1GetExchangeRatingReviewResponse"},"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":"Same as page size in request.","format":"int32","type":"integer"},"order_by":{"description":"Same as order_by in request.","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"},"v1UpdateApprovalRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1UpdateApprovalResponse":{"properties":{"metadata":{"$ref":"#/components/schemas/v1ResourceMetadata"},"data":{"$ref":"#/components/schemas/v1ApprovalItem"}},"type":"object"},"v1UpdateExchangeRatingRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1ExchangeRating"},"update_mask":{"items":{"type":"string"},"title":"Required. The data path corresponding to the fields being updated in this request.\nExchange Rating Creator can update the following fields:\n   data.rank\n   data.message\n   data.freeform_text\nExample mask declaration in JSON format:\n   updateMask: \"data.freeformText\"\nsee https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask","type":"array"}},"type":"object"},"v1UpdateExchangeRatingReviewRequest":{"properties":{"data":{"$ref":"#/components/schemas/v1ExchangeRatingReview"},"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"}