Document Summarization Error Codes

Message:
"Ah ah ah! It looks like the 'Ocp-Apim-Subscription-Key' header is missing."

Suggestion:
"Please include your subscription key in the 'Ocp-Apim-Subscription-Key' header of your request."

This error occurs when the API does not receive the required subscription key in the request headers. The subscription key is necessary to authenticate your request and ensure you have access to the API.

Ensure that you include your valid subscription key in the Ocp-Apim-Subscription-Key header of every API request. Verify that the key is correctly spelled and has not expired.

Message:
"The 'format' value you provided doesn't seem to be valid."

Suggestion:
"Please choose a valid 'format' from the following options: standard, bullet_points, paragraph, conversation, tv_show, movie_trailer, storybook, structured, action_plan, memo, data_insights, q_and_a, comic_book, poetry, rap, interactive_presentation, email, social_media_post."

This error occurs when the format parameter in your request is not one of the allowed options. The API expects a valid format to generate the summary accordingly.

Select a valid format from the provided list of options. Ensure that the format value matches one of the allowed formats exactly.

Message:
"The 'tone' value provided isn't recognized."

Suggestion:
"Please select a valid 'tone' from these options: energetic, neutral, calm, formal, informal, fun, enthusiastic, friendly, professional, empathetic, serious, cheerful, motivational."

This error occurs when the tone value in your customization options is not recognized by the API. The tone specifies the style in which the summary should be written.

Choose a valid tone from the allowed options. Ensure that the tone value is spelled correctly and matches one of the predefined tones.

Message:
"It seems the 'summary_length' value is incorrect."

Suggestion:
"Please provide a valid 'summary_length' from the following choices: very_simple, simple, standard, detailed, extended, comprehensive."

This error occurs when the summary_length value in your customization options is not one of the accepted values. This parameter determines how detailed the summary will be.

Select a valid summary length from the allowed options. Ensure that the summary_length value is correctly specified.

Message:
"The 'summary_type' you've entered isn't supported."

Suggestion:
"Please select a valid 'summary_type' from these options: executive, technical, abstract."

This error occurs when the summary_type parameter is not one of the supported types. The summary type allows you to specify the style or focus of the summary.

Use a valid summary type from the provided options. Ensure that the summary_type value is accurate and matches one of the supported types.

Message:
"You've provided too many URLs."

Suggestion:
"Please limit your request to a maximum of 3 URLs."

This error occurs when you include more than 3 URLs in the urls array of your request. The API has a limit to prevent overloading.

Reduce the number of URLs to 3 or fewer. If you need to summarize more documents, consider making multiple API requests.

Message:
"We couldn't find any text or URLs to process."

Suggestion:
"Please provide either 'text' or an array of 'urls' pointing to the documents you want to process."

This error occurs when neither text nor urls are provided in the request. The API needs content to generate a summary.

Include either the text field with the content you wish to summarize or the urls array with links to the documents. Ensure that at least one of these fields is populated.

Message:
"One or more of the URLs you've provided are not valid."

Suggestion:
"Please double-check that all your URLs are correctly formatted and accessible."

This error occurs when one or more URLs in your urls array are not valid URLs. This could be due to typos, missing protocols (http/https), or incorrect formatting.

Verify that all URLs are correctly formatted, include the proper protocol (e.g., https://), and point to accessible resources. Correct any typos or formatting issues in the URLs.

Message:
"One of your files is too large."

Suggestion:
"Please ensure all files are smaller than 2 MB and try again."

This error occurs when a file at one of the provided URLs exceeds the size limit of 2 MB. Large files are not processed to maintain performance.

Use files that are under 2 MB in size. If necessary, reduce the file size by compressing the document or extracting only the relevant sections to include in your request.

Message:
"We can't process the file type you've uploaded."

Suggestion:
"Please provide a supported file type (e.g., PDF, DOC/DOCX, TXT, RTF, HTML/HTM, CSS/SCSS, JS, JAVA, PY, JSON, EML, MSG)."

This error occurs when you provide a URL to a file type that the API does not support.

Ensure that the files you are trying to summarize are in one of the supported formats. Convert unsupported file types to a supported format before including them in your request.

Message:
"We encountered issues processing some of your URLs."

Suggestion:
"Please verify the accessibility and format of the URLs you've provided and try again."

This error occurs when the API cannot access or process the files at the provided URLs. Possible reasons include inaccessible URLs, server errors, or files that cannot be read.

Ensure that all URLs are publicly accessible and that the files can be downloaded without authentication or restrictions. Check that the files are in supported formats and not corrupted.

Message:
"The text you've provided isn't valid for processing."

Suggestion:
"Please provide clear and valid text to summarize or extract keywords from."

This error occurs when the text provided is empty or contains only whitespace, or if the text cannot be processed for some reason.

Provide valid, non-empty text in the text field. Ensure that the text contains meaningful content that can be summarized.

Message:
"Something went wrong while generating your summary."

Suggestion:
"Please try again later. If the issue persists, feel free to contact support for assistance. You can also check our status page here."

This error occurs when there's an issue with the underlying AI service used to generate the summary. It could be due to high load, service outages, or internal errors.

Wait for a few minutes and try your request again. If the problem continues, check the status page for any ongoing issues or contact support for further assistance.

Message:
"We received an unexpected response format from our summarization service."

Suggestion:
"Ensure that the 'format' parameter is correct and try your request again."

This error occurs when the AI service returns a response that doesn't match the expected structure for the specified format. This might happen if the AI model didn't understand the prompt correctly.

Verify that the format parameter is correct and that your request parameters are properly set. If the issue persists, consider adjusting your request or contacting support for assistance.

Message:
"The 'model' value you provided is not valid."

Suggestion:
"Please select a valid 'model' from the following options: strd-us-east, strd-us-nor-cent."

This error occurs when the model parameter in your request is not one of the allowed options. The API requires a valid model to process your request.

Use a valid model from the provided options. Ensure that the model value is correctly specified and matches one of the allowed models.

Message: "Whoops! Something went wrong on our end."

Suggestion: "Please try again later. If the problem continues, contact support for help. You can check our status page here."