{ "opencollection": "1.0.0", "info": { "name": "Retrieval", "version": "1.0" }, "items": [ { "info": { "name": "Content Service", "type": "folder" }, "items": [ { "info": { "name": "List Content Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that supplied the exchange response." }, { "name": "content_id", "value": "", "type": "query", "description": "Unique identifier for the content within the matching content groups." } ] }, "docs": "Filter content groups by knowledge domain and content." }, { "info": { "name": "Create Content Group", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create Content Group" }, { "info": { "name": "Get Content Group", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." } ] }, "docs": "Retrieve a content group using the ID." }, { "info": { "name": "Delete Content Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." } ] }, "docs": "Delete a content group without altering the content resources." }, { "info": { "name": "List Content Group Contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id/contents", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." }, { "name": "return_only_id", "value": "", "type": "query", "description": "If set to True will only return item IDs." } ] }, "docs": "List content group sources by ID." }, { "info": { "name": "Delete Content Group Contents", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id/contents", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." } ] }, "docs": "Delete all child content associations with the parent content group." }, { "info": { "name": "Get Content Group Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id/contents/:content_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." }, { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." } ] }, "docs": "Get content group sources by ID." }, { "info": { "name": "Delete Content Group Content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id/contents/:content_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." }, { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." } ] }, "docs": "Delete content associations within the parent content group." }, { "info": { "name": "Cascade Delete Content Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:content_group_id:cascade", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." } ] }, "docs": "Delete content group source associations and remove from knowledge domain." }, { "info": { "name": "Update Content Group", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:data.content_group_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." } ] }, "docs": "Update the display name for a content group." }, { "info": { "name": "Create Content Group Content", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/knowledge/v1alpha1/content-groups/:data.content_group_id/contents/:data.content_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.content_group_id", "value": "", "type": "path", "description": "Unique identifier for the content group." }, { "name": "data.content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create content group sources." }, { "info": { "name": "List Contents", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that supplied the exchange response." }, { "name": "content_group_id", "value": "", "type": "query", "description": "Unique identifier for the content within the matching content groups." }, { "name": "source_location", "value": "", "type": "query", "description": "Precise location of the source material." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List contents associated with a knowledge domain." }, { "info": { "name": "Create Content", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create methods for contents." }, { "info": { "name": "Get Content", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content to be returned." } ] }, "docs": "Get Content" }, { "info": { "name": "Delete Content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content to be deleted." } ] }, "docs": "Delete the content and all child resources." }, { "info": { "name": "Get Content Image", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id/image", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." }, { "name": "page", "value": "", "type": "query", "description": "Page number in the content." }, { "name": "uncompressed", "value": "", "type": "query", "description": "True does not compress the image data; default is false (compressed)." }, { "name": "debug", "value": "", "type": "query", "description": "True returns a debug image." } ] }, "docs": "Return an image representation of the content." }, { "info": { "name": "List Processed Content Extracts", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id/processed-extracts", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." }, { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that contains the exchange response." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List initial processed extracts by content ID." }, { "info": { "name": "List Retrieval Content Extracts", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id/retrieval-extracts", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." }, { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that supplied the exchange response." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List of retrieval extracts by content ID." }, { "info": { "name": "List Content Subjects", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id/subjects", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "IFor multiple pages; must be specified in each request for two pages per sheet." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order for multi page requests; valid options are rank, rank desc, create_time, create_time desc." }, { "name": "subject_category_id", "value": "", "type": "query", "description": "Unique identifier for the grouping of specific topics." } ] }, "docs": "List subjects associated with a content item." }, { "info": { "name": "Get Summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id/summary", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." } ] }, "docs": "Get summary information by content ID." }, { "info": { "name": "Cascade Delete Content", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/knowledge/v1alpha1/contents/:content_id:cascade", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content to be deleted." } ] }, "docs": "Delete the content and all child resources, and remove from all content groups." }, { "info": { "name": "Get Content Metadata", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/knowledge/v1alpha1/domains/:knowledge_domain_id/contents/:content_id/metadata", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "knowledge_domain_id", "value": "", "type": "path", "description": "Unique identifier of the knowledge domain containing the requested metadata" }, { "name": "content_id", "value": "", "type": "path", "description": "Unique identifier for the content within the matching content groups." } ] }, "docs": "List metadata by content ID." } ] }, { "info": { "name": "Retrieval", "type": "folder" }, "items": [ { "info": { "name": "Create Retrieval", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate or continue a conversation with the retrieval service." }, { "info": { "name": "Create Ws Retrieval", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/wss", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Initiate or continue a conversation." }, { "info": { "name": "Get Retrieval", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/:retrieval_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "retrieval_id", "value": "", "type": "path", "description": "Unique identifier associated with the response object sources." }, { "name": "output_id", "value": "", "type": "query", "description": "Unique identifier for the output." } ] }, "docs": "Retrieve the query and output data for existing retrieval data." }, { "info": { "name": "Get Retrieval Content Image", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/:retrieval_id/image", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "retrieval_id", "value": "", "type": "path", "description": "Unique identifier for the response object for the bounding boxes and content ID." }, { "name": "output_id", "value": "", "type": "query", "description": "Unique identifier for the retrieval output; defaults to the first instance." }, { "name": "page", "value": "", "type": "query", "description": "Page number in the content; defaults to the first content page associated with the retrieval output." }, { "name": "uncompressed", "value": "", "type": "query", "description": "Compress image data; valid values are 0 for compressed (default) and 1 for uncompressed." }, { "name": "overlay_color", "value": "", "type": "query", "description": "Bounding box overlay color specified as a hex color code without the leading hashtag; supports 3, 4, 6, and 8 character codes." } ] }, "docs": "Get an image representation of the content with bounding boxes." } ] }, { "info": { "name": "RetrievalFeedback", "type": "folder" }, "items": [ { "info": { "name": "List Retrieval Rating Reviews", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/rating-reviews", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "Filter list output with ratings for a knowledge collection." }, { "name": "retrieval_id", "value": "", "type": "query", "description": "Unique ID of the exchange item; if supplied, overrides the collection ID as a filter item; default is no entry." }, { "name": "status", "value": "", "type": "query", "description": "Ratings included in requested review status; defaults to UNSPECIFIED.\n\n - UNSPECIFIED: Not a valid retrieval rating value.\n - PENDING: Waiting to be inspected for approval or rejection.\n - COMPLETE: Inspected and acted upon; no further action taken." }, { "name": "creator_id", "value": "", "type": "query", "description": "Filter list output to only include ratings made by a given user." }, { "name": "rank", "value": "", "type": "query", "description": "Rank value given by the user; valid responses are 1 (negative) and 5 (positive)." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order for multi page requests; valid options are rank, rank desc, create_time, create_time desc." } ] }, "docs": "Return rating reviews for a resource." }, { "info": { "name": "Create Retrieval Rating", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a retrieval rating." }, { "info": { "name": "Update Retrieval Rating Review", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings/:data.rating.rating_id/review", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating.rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the review perspective of a retrieval rating item." }, { "info": { "name": "Update Retrieval Rating", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings/:data.rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing retrieval rating." }, { "info": { "name": "Get Retrieval Rating", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings/:rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "Get a retrieval rating." }, { "info": { "name": "Delete Retrieval Rating", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings/:rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "Delete a retrieval rating." }, { "info": { "name": "Get Retrieval Rating Review", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/retrievals/ratings/:rating_id/review", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "Return the review perspective of a retrieval rating item." }, { "info": { "name": "List Verified Answers", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/verified-answers", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that lists the verified answers." }, { "name": "collection_id", "value": "", "type": "query", "description": "If request contains the collection_id, use it as the filter instead of the knowledge_domain_id." }, { "name": "verified_answer_status", "value": "", "type": "query", "description": "Verified answer status.\n\n - PENDING_REVIEW: Answer under review.\n - APPROVED: Answer verified and approved." }, { "name": "return_only_item_keys", "value": "", "type": "query", "description": "If set to True will only return item IDs." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order for multi page requests; valid options are update_time desc and update_time asc." } ] }, "docs": "List verified answer entries." }, { "info": { "name": "Create Verified Answer", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/verified-answers", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a verified answer entry." }, { "info": { "name": "Update Verified Answer", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1alpha1/verified-answers/:data.verified_answer_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.verified_answer_id", "value": "", "type": "path", "description": "Unique identifier generated on a create verified answer request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing verified answer entry." }, { "info": { "name": "Get Verified Answer", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/verified-answers/:verified_answer_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "verified_answer_id", "value": "", "type": "path", "description": "Unique identifier of the verified answer; if the answer isn't verified this is unset." } ] }, "docs": "Get information about a verified answer." }, { "info": { "name": "Delete Verified Answer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/conversation/v1alpha1/verified-answers/:verified_answer_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "verified_answer_id", "value": "", "type": "path", "description": "Unique identifier of the verified answer; if the answer isn't verified this is unset." } ] }, "docs": "Delete a verified answer entry." } ] }, { "info": { "name": "GenerativeRetrieval", "type": "folder" }, "items": [ { "info": { "name": "Create Generative Retrieval SSE", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrievals", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new generative retrieval using server-sent events (SSE)." }, { "info": { "name": "Get Generative Retrieval", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrievals/:generative_retrieval_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "generative_retrieval_id", "value": "", "type": "path", "description": "Unique identifier for the generative response object." }, { "name": "knowledge_domain_id", "value": "", "type": "query", "description": "Unique identifier of the knowledge domain that supplied the generative exchange response." } ] }, "docs": "Return a generative retrieval answer." } ] }, { "info": { "name": "GenerativeRetrievalFeedback", "type": "folder" }, "items": [ { "info": { "name": "Create Generative Retrieval Rating", "type": "http" }, "http": { "method": "POST", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a rating for the generative retrieval." }, { "info": { "name": "List Generative Retrieval Rating Reviews", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings-reviews", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "collection_id", "value": "", "type": "query", "description": "Filter list output to only include ratings for a knowledge collection." }, { "name": "generative_retrieval_id", "value": "", "type": "query", "description": "Unique ID of the exchange item; if supplied, overrides the collection ID as a filter item; default is no entry." }, { "name": "status", "value": "", "type": "query", "description": "Ratings included in requested review status; defaults to UNSPECIFIED.\n\n - UNSPECIFIED: Not a valid retrieval rating value.\n - PENDING: Waiting to be inspected for approval or rejection.\n - COMPLETE: Inspected and acted upon; no further action taken." }, { "name": "creator_id", "value": "", "type": "query", "description": "Filter list output to only include ratings made by a given user." }, { "name": "rank", "value": "", "type": "query", "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." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." }, { "name": "order_by", "value": "", "type": "query", "description": "Sort order for multi page requests; valid options are rank, rank desc, create_time, create_time desc." } ] }, "docs": "List generative retrieval reviews by rating." }, { "info": { "name": "Update Generative Retrieval Rating Review", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings/:data.rating.rating_id/review", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating.rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the review perspective of a retrieval rating item." }, { "info": { "name": "Update Generative Retrieval Rating", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings/:data.rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "data.rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a generative retrieval rating." }, { "info": { "name": "Get Generative Retrieval Rating", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings/:rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "Return a generative retrieval rating. " }, { "info": { "name": "Delete Generative Retrieval Rating", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings/:rating_id", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "Delete a generative retrieval rating." }, { "info": { "name": "Get Generative Retrieval Rating Review", "type": "http" }, "http": { "method": "GET", "url": "https://api.pryon.net/api/conversation/v1alpha1/generative-retrieval-ratings/:rating_id/review", "headers": [ { "name": "Authorization", "value": "Authorization: Bearer {base64-encoded-token}" } ], "params": [ { "name": "rating_id", "value": "", "type": "path", "description": "Unique identifier for the exchange rating; automatically generated." } ] }, "docs": "List the review perspective of a retrieval rating item." } ] } ], "bundled": true }