The Pryon Retrieval Engine API — create and continue retrievals over a knowledge collection (REST, WebSocket and server-sent events), fetch content, content groups, extracts, summaries and content images with bounding boxes, and record retrieval ratings and verified answers.
{"openapi":"3.0.1","info":{"title":"Retrieval","version":"1.0","contact":{"name":"Pryon Product Support","url":"https://pryon.zendesk.com","email":"support@pryon.zendesk.com"},"description":"","x-logo":{"altText":"Pryon APIs"}},"servers":[{"url":"https://api.pryon.net","description":"Pryon Cloud"}],"tags":[{"name":"Content Services","description":"A content object is a single content source (e.g., a PDF document, a Google Doc, or the HTML file associated with a single web page) and is an element of a content group (such as a Sharepoint folder). A set of content groups make up a knowledge domain (or index) which can be queried against. ","x-displayName":"Content"},{"name":"Exchange","description":"The exchange API allows you to make natural language inquiries about your ingested information, retrieving the top matched answers and surrounding context to power RAG applications. Outputs include a short answer, surrounding context chunk, links for attribution, bounding boxes for answer highlighting, content metadata, and more.\n\nFor conversational use cases, the exchange API initiates and continues a conversation. Each call performs one synchronous round-trip by sending a text request to the service and receiving the text response. Pryon stores and references a record of each verbal/textual interaction with the Pryon API. ","x-displayName":"Exchange"},{"name":"Glossary","description":"| Term | Definition |\n| ---- | ---------- |\n| Answer in Context (AIC) | The chunk of text that the answer is found in. |\n| Application Programming Interface (API) | A set of functions and procedures that allow the creation of applications that access the features or data of an operating system, application, or other service. |\n| Authentication (Auth) | Verifies the identity of a user or process, ensuring that the individual using a system or device is authorized. |\n| Bounding Box | Coordinates returned as a list of four floating point numbers representing the top-left and bottom-right corners of the box of the answer snippet on the source document image. |\n| Collection | Databases of knowledge that have been imported into the platform |\n| Content | The building blocks of the knowledge base, including any enterprise documents and data sources added to a collection. |\n| Content Group | Used to organize elements within a content type to make content more structured, adaptive, and searchable. Each content group can be prioritized or deprioritized according to the configuration. |\n| Identity Provider (IDP) | Stores and verifies user identity. |\n| Knowledge Domain (KD) | An instance or version of a collection. Updating a collection’s contents creates a new knowledge domain. |\n| Prior Knowledge (PK) | Configuration file used to store metadata about installed libraries on a system |\n| Ranking | The sort order applied to answers according to specific criterion so that the best results appear early in the result list displayed to the user. |\n| Single Sign-On (SSO) | Authentication which allows a user to log in to any of several related, yet independent, applications, systems, or services with a single ID. |\n| Score | A numerical value that indicates the quality and relevance of a piece of content in relation to the question being asked. |\n| Subjects | An entity that is part of a subject category and stores a term and its reference count. |\n| Verified Answer (VA) | Answers verified manually by a domain administrator. |","x-displayName":"Glossary"}],"paths":{"/api/knowledge/v1alpha1/content-groups":{"get":{"operationId":"ContentService_ListContentGroups","parameters":[{"description":"Unique identifier of the knowledge domain that supplied the exchange response.","in":"query","name":"knowledge_domain_id","schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"query","name":"content_id","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListContentGroupsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Content Groups","tags":["Content Service"],"description":"Filter content groups by knowledge domain and content."},"post":{"operationId":"ContentService_CreateContentGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1CreateContentGroupRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentGroupResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Content Group","tags":["Content Service"],"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}]}},"/api/knowledge/v1alpha1/content-groups/{content_group_id}":{"delete":{"operationId":"ContentService_DeleteContentGroup","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Delete Content Group","tags":["Content Service"],"description":"Delete a content group without altering the content resources."},"get":{"operationId":"ContentService_GetContentGroup","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentGroupResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Group","tags":["Content Service"],"description":"Retrieve a content group using the ID."}},"/api/knowledge/v1alpha1/content-groups/{content_group_id}/contents":{"delete":{"operationId":"ContentService_DeleteContentGroupContents","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Delete Content Group Contents","tags":["Content Service"],"description":"Delete all child content associations with the parent content group."},"get":{"operationId":"ContentService_ListContentGroupContents","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"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":"If set to True will only return item IDs.","in":"query","name":"return_only_id","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListContentGroupContentsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Content Group Contents","tags":["Content Service"],"description":"List content group sources by ID."}},"/api/knowledge/v1alpha1/content-groups/{content_group_id}/contents/{content_id}":{"delete":{"operationId":"ContentService_DeleteContentGroupContent","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Delete Content Group Content","tags":["Content Service"],"description":"Delete content associations within the parent content group."},"get":{"operationId":"ContentService_GetContentGroupContent","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentGroupContentResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Group Content","tags":["Content Service"],"description":"Get content group sources by ID."}},"/api/knowledge/v1alpha1/content-groups/{content_group_id}:cascade":{"delete":{"operationId":"ContentService_CascadeDeleteContentGroup","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"content_group_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Cascade Delete Content Group","tags":["Content Service"],"description":"Delete content group source associations and remove from knowledge domain."}},"/api/knowledge/v1alpha1/content-groups/{data.content_group_id}":{"patch":{"operationId":"ContentService_UpdateContentGroup","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"data.content_group_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentGroupResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Update Content Group","tags":["Content Service"],"description":"Update the display name for a content group."}},"/api/knowledge/v1alpha1/content-groups/{data.content_group_id}/contents/{data.content_id}":{"post":{"operationId":"ContentService_CreateContentGroupContent","parameters":[{"description":"Unique identifier for the content group.","in":"path","name":"data.content_group_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"data.content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ContentGroupContentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentGroupContentResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Content Group Content","tags":["Content Service"],"x-codegen-request-body-name":"body","description":"Create content group sources."}},"/api/knowledge/v1alpha1/contents":{"get":{"operationId":"ContentService_ListContents","parameters":[{"description":"Unique identifier of the knowledge domain that supplied the exchange response.","in":"query","name":"knowledge_domain_id","schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"query","name":"content_group_id","schema":{"type":"string"}},{"description":"Precise location of the source material.","in":"query","name":"source_location","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListContentsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Contents","tags":["Content Service"],"description":"List contents associated with a knowledge domain."},"post":{"operationId":"ContentService_CreateContent","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1CreateContentRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Content","tags":["Content Service"],"x-codegen-request-body-name":"body","description":"Create methods for contents.","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}]}},"/api/knowledge/v1alpha1/contents/{content_id}":{"delete":{"operationId":"ContentService_DeleteContent","parameters":[{"description":"Unique identifier for the content to be deleted.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Delete Content","tags":["Content Service"],"description":"Delete the content and all child resources."},"get":{"operationId":"ContentService_GetContent","parameters":[{"description":"Unique identifier for the content to be returned.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"tags":["Content Service"],"summary":"Get Content","description":""}},"/api/knowledge/v1alpha1/contents/{content_id}/image":{"get":{"operationId":"ContentService_GetContentImage","parameters":[{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"description":"Page number in the content.","in":"query","name":"page","schema":{"format":"int32","type":"integer"}},{"description":"True does not compress the image data; default is false (compressed).","in":"query","name":"uncompressed","schema":{"type":"boolean"}},{"description":"True returns a debug image.","in":"query","name":"debug","schema":{"type":"boolean"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Image","tags":["Content Service"],"description":"Return an image representation of the content."}},"/api/knowledge/v1alpha1/contents/{content_id}/processed-extracts":{"get":{"operationId":"ContentService_ListProcessedContentExtracts","parameters":[{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the knowledge domain that contains the exchange response.","in":"query","name":"knowledge_domain_id","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListProcessedContentExtractsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Processed Content Extracts","tags":["Content Service"],"description":"List initial processed extracts by content ID."}},"/api/knowledge/v1alpha1/contents/{content_id}/retrieval-extracts":{"get":{"operationId":"ContentService_ListRetrievalContentExtracts","parameters":[{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier of the knowledge domain that supplied the exchange response.","in":"query","name":"knowledge_domain_id","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListRetrievalContentExtractsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Retrieval Content Extracts","tags":["Content Service"],"description":"List of retrieval extracts by content ID."}},"/api/knowledge/v1alpha1/contents/{content_id}/subjects":{"get":{"operationId":"ContentService_ListContentSubjects","parameters":[{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"description":"Maximum page size is 100; default is 100.","in":"query","name":"page_size","schema":{"format":"int32","type":"integer"}},{"description":"IFor 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"}},{"description":"Unique identifier for the grouping of specific topics.","in":"query","name":"subject_category_id","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListSubjectsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Content Subjects","tags":["Content Service"],"description":"List subjects associated with a content item."}},"/api/knowledge/v1alpha1/contents/{content_id}/summary":{"get":{"operationId":"ContentService_GetSummary","parameters":[{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetSummaryResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Summary","tags":["Content Service"],"description":"Get summary information by content ID."}},"/api/knowledge/v1alpha1/contents/{content_id}:cascade":{"delete":{"operationId":"ContentService_CascadeDeleteContent","parameters":[{"description":"Unique identifier for the content to be deleted.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","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/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Cascade Delete Content","tags":["Content Service"],"description":"Delete the content and all child resources, and remove from all content groups."}},"/api/knowledge/v1alpha1/domains/{knowledge_domain_id}/contents/{content_id}/metadata":{"get":{"operationId":"ContentService_GetContentMetadata","parameters":[{"description":"Unique identifier of the knowledge domain containing the requested metadata","in":"path","name":"knowledge_domain_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the content within the matching content groups.","in":"path","name":"content_id","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetContentMetadataResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Content Metadata","tags":["Content Service"],"description":"List metadata by content ID."}},"/api/conversation/v1alpha1/retrievals":{"post":{"operationId":"Retrieval_CreateRetrieval","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1CreateRetrievalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetRetrievalResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Retrieval","tags":["Retrieval"],"x-codegen-request-body-name":"body","description":"Initiate or continue a conversation with the retrieval service.","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}]}},"/api/conversation/v1alpha1/retrievals/wss":{"post":{"description":"Initiate or continue a conversation.","operationId":"Retrieval_CreateWsRetrieval","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1CreateWsRetrievalRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1WsRetrieval"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Create Ws Retrieval","tags":["Retrieval"],"x-codegen-request-body-name":"body","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}]}},"/api/conversation/v1alpha1/retrievals/{retrieval_id}":{"get":{"operationId":"Retrieval_GetRetrieval","parameters":[{"description":"Unique identifier associated with the response object sources.","in":"path","name":"retrieval_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the output.","in":"query","name":"output_id","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetRetrievalResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Retrieval","tags":["Retrieval"],"description":"Retrieve the query and output data for existing retrieval data."}},"/api/conversation/v1alpha1/retrievals/{retrieval_id}/image":{"get":{"description":"Get an image representation of the content with bounding boxes.","operationId":"Retrieval_GetRetrievalContentImage","parameters":[{"description":"Unique identifier for the response object for the bounding boxes and content ID.","in":"path","name":"retrieval_id","required":true,"schema":{"type":"string"}},{"description":"Unique identifier for the retrieval output; defaults to the first instance.","in":"query","name":"output_id","schema":{"type":"string"}},{"description":"Page number in the content; defaults to the first content page associated with the retrieval output.","in":"query","name":"page","schema":{"format":"int32","type":"integer"}},{"description":"Compress image data; valid values are 0 for compressed (default) and 1 for uncompressed.","in":"query","name":"uncompressed","schema":{"type":"boolean"}},{"description":"Bounding box overlay color specified as a hex color code without the leading hashtag; supports 3, 4, 6, and 8 character codes.","in":"query","name":"overlay_color","schema":{"type":"string"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1GetRetrievalContentImageResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"Get Retrieval Content Image","tags":["Retrieval"]}},"/api/conversation/v1alpha1/retrievals/rating-reviews":{"get":{"operationId":"RetrievalFeedback_ListRetrievalRatingReviews","parameters":[{"description":"Filter list output with ratings for a knowledge collection.","in":"query","name":"collection_id","schema":{"type":"string"}},{"description":"Unique ID of the exchange item; if supplied, overrides the collection ID as a filter item; default is no entry.","in":"query","name":"retrieval_id","schema":{"type":"string"}},{"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.","in":"query","name":"status","schema":{"type":"string"}},{"description":"Filter list output to only include ratings made by a given user.","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"}},{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"},"example":"Authorization: Bearer {base64-encoded-token}"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_v1alpha1ListRetrievalRatingReviewsResponse"}}},"description":"A successful response."},"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filename_googlerpcStatus"}}},"description":"An unexpected error response."}},"summary":"List Retrieval Rating Reviews","tags":["RetrievalFeedback"],"description":"Return rating reviews for a resource."}},"/api/conversation/v1alpha1/retr
# --- truncated at 32 KB (136 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pryon/refs/heads/main/openapi/pryon-retrieval-may2025-openapi.json