From 191fa1d73ad27d00c71f373c1da52cd665d5c123 Mon Sep 17 00:00:00 2001 From: mausolf Date: Tue, 26 Mar 2024 18:24:12 +0000 Subject: [PATCH 1/7] Update known issues to remove stale BICEP references --- docs/knownissues.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index 244ae1137..ca82ff916 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -58,10 +58,10 @@ Turn off the option to require membership for the Azure Active Directory Enterpr ## Errors due to throttling or overloading Form Recognizer -Occasionally you will hit a 429 return code in the FileFormRecSubmissionPDF which indicates that you need to retry your submission later, or an internal error returned by AI Document Intelligence in the FileFormRecPollingPDF function, which indicates the service has hit internal capacity issues. Both of these situations will occur under heavy load, but the accelerator is designed to back off and retry at a later time, up to a maximum set of retries, which is configurable. +Occasionally you will hit a 429 return code in the FileFormRecSubmissionPDF which indicates that you need to retry your submission later, or an internal error returned by AI Document Intelligence in the FileFormRecPollingPDF function, which indicates the service has hit internal capacity issues. Both of these situations will occur under heavy load, but the accelerator is designed to back off and retry at a later time, up to a maximum set of retries, which is configurable. ### Solution -These values surface as configuration settings in the Azure function and can be revised there, or they can be updated at deployment in function.bicep, or they can be updated in the file local.settings.json which is used when debugging a function in VS Code. These values are as follows... +These values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... ``` @description('The maximum number of seconds between uploading a file and submitting it to FR') @@ -111,24 +111,17 @@ Deploy Azure OpenAI Service only in the supported regions. Review the local.env ## Error: jq parse error: Expected value before ',' -If you see a jq parse error while doing deployments, it means one of the makefile scripts to extract environment variables is failing to find a value it expects to be there. The files related would be the main.parameters.json file which is the variables from bicep output from the infrastructure create. The other would be the env file used during build and deploy time +If you see a jq parse error while running a deployment, it means one of the makefile scripts that extract environment variables is failing to find a value it expects. Carefully review the inf_output.json file and your local.env file used during build and deploy time ### Solution: -To resolve carefully check your deployment .env file for any missing but required values. There are rare times when ARM has issues and output values are not written. In which case simply double check your configuration and rerun the ```make deploy``` and/or ```make extract-env``` command so that the bicep outputs can be written again +To resolve, carefully check your local.env file for any missing but required values. There are rare times output values are not written. In which case simply double check your configuration and rerun the ```make deploy``` command to regenerate the inf_output.json file the Makefile script parses for variables. ## Error: Creation of new Media Service accounts are not allowed as the resource has been deprecated ### Solution: -Media Services is scheduled for 30th June 2024. This is the [guide](https://learn.microsoft.com/en-us/azure/media-services/latest/azure-media-services-retirement). On deeper investigation Video Indexer, which is the service we use that sits on top of Media Services, will switch away from this before the end date.... +Information Assistant uses Azure AI Video Indexer (VI) which depended on Azure Media Services (AMS). AMS is scheduled for retirement on June 30 2024. As part of retirement planning, steps to transition away from the current VI account AMS dependency have been published. Please refer to this [guide](https://learn.microsoft.com/en-us/azure/media-services/latest/azure-media-services-retirement) for additional details. -``` -Is Azure Video Indexer being retired? -No, Azure Video Indexer isn't part of the Media Services retirement. Although Video Indexer currently relies on a Media Services account as part of its workflow, this dependency will be eliminated before Media Services is retired on June 30, 2024. See the following for more [impact of Media Services retirement for Video Indexer](https://aka.ms/vi-ams-retirement-announcement) -``` - -As of today, Video Indexer still requires a Media Services service to be created, and so we can't remove it from bicep deployment. We will need to assess closer to the date if VI is working without the service and we can then remove the dependency. - -The error is interesting as it seems to indicate the media service cannot be created. This is not the case, it does work in regions where VI and Media Services are available. I have updated this to an enhancement and we will add a ticket to the board to action this when VI can be deployed without this supporting service. +VI isn't part of the Azure Media Services (AMS) retirement. Previously, Video Indexer relied on AMS for encoding, packaging, and streaming. This dependency was removed following this [guide](https://learn.microsoft.com/en-us/azure/azure-video-indexer/azure-video-indexer-ams-retirement-guide) which provides guidance on linking an Azure Storage account to the VI account. ## Error: Token limit often exceeded with PDF files From 6fefaa8baeef00f513209cd334f3d9483ae2a386 Mon Sep 17 00:00:00 2001 From: mausolf Date: Tue, 26 Mar 2024 18:36:08 +0000 Subject: [PATCH 2/7] updated insuficient quota solution to include GPT and embeddings models --- docs/knownissues.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index ca82ff916..12d1475eb 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -61,7 +61,7 @@ Turn off the option to require membership for the Azure Active Directory Enterpr Occasionally you will hit a 429 return code in the FileFormRecSubmissionPDF which indicates that you need to retry your submission later, or an internal error returned by AI Document Intelligence in the FileFormRecPollingPDF function, which indicates the service has hit internal capacity issues. Both of these situations will occur under heavy load, but the accelerator is designed to back off and retry at a later time, up to a maximum set of retries, which is configurable. ### Solution -These values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... +The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... ``` @description('The maximum number of seconds between uploading a file and submitting it to FR') @@ -97,7 +97,7 @@ InsufficientQuota - The specified capacity '1' of account deployment is bigger t ``` ### Solution -This means that you have exceeded the quota assigned to your deployment for the GPT-35-Turbo model.The quota is the maximum number of tokens per minute (thousands) that you can use with this model. You can check your current quota and usage in the Azure portal. To increase the quota [learn more](https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits) +This means that you have exceeded the quota assigned to your deployment for the GPT or embeddings model.The quota is the maximum number of tokens per minute (thousands) that you can use with this model. You can check your current quota and usage in the Azure portal. To increase the quota review [learn more](https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits) --- From 01587008a782622885f3535273862c86f276d3d1 Mon Sep 17 00:00:00 2001 From: mausolf Date: Tue, 26 Mar 2024 21:34:39 +0000 Subject: [PATCH 3/7] removed AMS error added lang to code blocks --- docs/knownissues.md | 91 +++++++++++++++------------------------------ 1 file changed, 31 insertions(+), 60 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index 12d1475eb..5d9e6f57f 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -10,6 +10,7 @@ Error: This subscription cannot create CognitiveServices until you agree to Resp ``` ### Solution + Manually create a "Azure AI services" in your Azure Subscription and Accept "Responsible AI Notice" 1. In the Azure portal, navigate to the “Create a resource” page and search for “Azure AI Services” @@ -58,12 +59,13 @@ Turn off the option to require membership for the Azure Active Directory Enterpr ## Errors due to throttling or overloading Form Recognizer -Occasionally you will hit a 429 return code in the FileFormRecSubmissionPDF which indicates that you need to retry your submission later, or an internal error returned by AI Document Intelligence in the FileFormRecPollingPDF function, which indicates the service has hit internal capacity issues. Both of these situations will occur under heavy load, but the accelerator is designed to back off and retry at a later time, up to a maximum set of retries, which is configurable. +Occasionally you will see a 429 return code in the FileFormRecSubmissionPDF which indicates that you need to retry your submission later or an internal error was returned by AI Document Intelligence in the FileFormRecPollingPDF function. This indicates the service has encountered internal capacity issues. Both of these situations will occur under heavy load, but the accelerator is designed to back off and retry at a later time, up to a maximum set of retries, which is configurable. ### Solution + The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... -``` +```text @description('The maximum number of seconds between uploading a file and submitting it to FR') param maxSecondsHideOnUpload string @@ -88,91 +90,54 @@ param pollingBackoff string @description('The maximum number of times we will retry to read a full processed document from FR. Failures in read may be due to network issues downloading the large response') param maxReadAttempts string ``` + --- + ## Error : Error due to service unavailability -``` +```bash InvalidTemplateDeployment - The template deployment 'infoasst-myworkspace' is not valid according to the validation procedure. The tracking id is 'XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX'. See inner errors for details. -InsufficientQuota - The specified capacity '1' of account deployment is bigger than available capacity '0' for UsageName 'Tokens Per Minute (thousands) - GPT-35-Turbo'. +InsufficientQuota: This opeeration requre xxx new capacity in quota 'Tokens Per Minute (thousands) - GPT-XXX or Text-Embeddings-Ada-002 which is bigger than the current available capacity of xxx. ``` + ### Solution -This means that you have exceeded the quota assigned to your deployment for the GPT or embeddings model.The quota is the maximum number of tokens per minute (thousands) that you can use with this model. You can check your current quota and usage in the Azure portal. To increase the quota review [learn more](https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits) +This means that you have exceeded the quota assigned to your deployment for the GPT or embeddings model. The quota is the maximum number of tokens per minute (thousands) that you can use with this model. You can check your current quota and usage in the Azure portal. To increase the quota review [learn more](https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits) --- ## Error:'OpenAI' is either invalid or unavailable in given region -``` + +```bash InvalidTemplateDeployment - The template deployment 'infoasst-myworkspace-xxxxx' is not valid according to the validation procedure. The tracking id is 'xxxxx-xxxx-xxxxx-xxxx-xxxxxxx'. See inner errors for details. InvalidApiSetId - The account type 'OpenAI' is either invalid or unavailable in given region. ``` -### Solution: + +### Solution + Deploy Azure OpenAI Service only in the supported regions. Review the local.env file and update the location as per supported models and [region availability](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability) ## Error: jq parse error: Expected value before ',' If you see a jq parse error while running a deployment, it means one of the makefile scripts that extract environment variables is failing to find a value it expects. Carefully review the inf_output.json file and your local.env file used during build and deploy time -### Solution: -To resolve, carefully check your local.env file for any missing but required values. There are rare times output values are not written. In which case simply double check your configuration and rerun the ```make deploy``` command to regenerate the inf_output.json file the Makefile script parses for variables. - -## Error: Creation of new Media Service accounts are not allowed as the resource has been deprecated - -### Solution: -Information Assistant uses Azure AI Video Indexer (VI) which depended on Azure Media Services (AMS). AMS is scheduled for retirement on June 30 2024. As part of retirement planning, steps to transition away from the current VI account AMS dependency have been published. Please refer to this [guide](https://learn.microsoft.com/en-us/azure/media-services/latest/azure-media-services-retirement) for additional details. +### Solution -VI isn't part of the Azure Media Services (AMS) retirement. Previously, Video Indexer relied on AMS for encoding, packaging, and streaming. This dependency was removed following this [guide](https://learn.microsoft.com/en-us/azure/azure-video-indexer/azure-video-indexer-ams-retirement-guide) which provides guidance on linking an Azure Storage account to the VI account. +To resolve, carefully check your local.env file for any missing but required values. There are rare times output values are not written. In which case simply double check your configuration and rerun the ```make deploy``` command to regenerate the inf_output.json file the Makefile scripts parse for variables. ## Error: Token limit often exceeded with PDF files -### Solution: - -The root of this is table processing. If a table is greater than our target token count for a chunk, this is not respected.Essentially tables are not chunked, but treated as units. We have added a task to our board to split tables by chunk size and repeat the table header rows in each chunk.. - -When we switched to using unstructured.io for non-PDF documents, we were aware of the same issue there. They were planning on adding this feature. So, we need to make the change in our code, and follow up with unstructured to confirm if this has been fixed and update that path also. - -This issue has been updated to an enhancement. -## Error: - -If you encounter an error similar to the one below that indicates your device must be managed. - -``` -ERROR: AADSTS530003: Your device is required to be managed to access this resource. -Trace ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx -Correlation ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx -Timestamp: 2023-10-05 19:54:05Z -Interactive authentication is needed. Please run: -az login --scope https://graph.microsoft.com//.default -make: *** [Makefile:18: infrastructure] Error 1 -``` - ### Solution -You will need to open your Codespace in VSCode on your managed device. Please read more about opening your [CodeSpace using VSCode](/docs/deployment/developing_in_a_codespaces.md#using-github-codespaces-in-visual-studio-code). - -## Error: +This was a problem with early deployments of 1.0. The root of this is table processing. If a table is greater than our target token count for a chunk, this is not respected meaning tables are not chunked, but treated as units. We now split tables by chunk size and repeat the table header rows in each chunk. -If you encounter an error similar to the one below that indicates your device must be managed. +This issue was resolved in a hotfix to the main branch of 1.0, so please upgrade to version 1.0 or later. -``` -ERROR: AADSTS530003: Your device is required to be managed to access this resource. -Trace ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx -Correlation ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx -Timestamp: 2023-10-05 19:54:05Z -Interactive authentication is needed. Please run: -az login --scope https://graph.microsoft.com//.default -make: *** [Makefile:18: infrastructure] Error 1 -``` - -### Solution - -You will need to open your Codespace in VSCode on your managed device. Please read more about opening your [CodeSpace using VSCode](/docs/deployment/developing_in_a_codespaces.md#using-github-codespaces-in-visual-studio-code). - -## Error: +## Error If you encounter an error similar to the one below that indicates your device must be managed. -``` +```bash ERROR: AADSTS530003: Your device is required to be managed to access this resource. Trace ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx Correlation ID: xxxxxxxx-xxxx-xxxx-xxxxxxxx @@ -184,31 +149,37 @@ make: *** [Makefile:18: infrastructure] Error 1 ### Solution -You will need to open your GitHub Codespaces in VSCode on your managed device. Please read more about opening your [GitHub Codespaces using VSCode](/docs/deployment/developing_in_a_codespaces.md#using-github-codespaces-in-visual-studio-code). +You will need to open your Codespace in VSCode on your managed device. Please read more about opening your [CodeSpace using VSCode](/docs/deployment/developing_in_a_codespaces.md#using-github-codespaces-in-visual-studio-code). ## Error: This region has quota of 0 \ cores for your subscription You receive the following error message during `make deploy` + ```bash {"ErrorEntity":{"ExtendedCode":"52039","MessageTemplate":"{0}. Try selecting different region or SKU.","Parameters":["This region has quota of 0 PremiumV3 cores for your subscription"],"Code":"Unauthorized","Message":"This region has quota of 0 PremiumV3 cores for your subscription. Try selecting different region or SKU."}}],"Innererror":null} ``` ### Solution + #### Option 1 : Request a quota increase in your subscription and region + To submit a quota increase do the following: +> >1. Log into the Azure Portal >2. Navigate to your target subscription >3. Select the **Usage + Quotas** tab on the left >4. On the **Usage + Quotas** blade, change the filter for ***Provider: Compute*** to ***Provider: App Services** ->5. Find the SKU and region you desire and use the **Edit** or **Submit Service Request** button to request a change. +>5. Find the SKU and region you desire and use the **Edit** or **Submit Service Request** button to request a change. #### Option 2 : Use Terraform parameters to select a new SKU size + We have made variable available in the terraform scripts to allow you to override the SKU size and tier for the following: + - Backend App Service Plan: This plan hosts the Information Assistant web site - Enrichment App Service Plan: This plan hosts the services that provide Azure OpenAI embeddings support - Functions App Service Plan: This plan hosts the functions that process files on upload to extract, chunk, and index the files. -You can add the following parameters to your local.env file to override the default values. +You can add the following parameters to your local.env file to override the default values. ```bash export TF_VAR_functionsAppSkuSize="S2" @@ -217,4 +188,4 @@ export TF_VAR_appServiceSkuSize="S1" export TF_VAR_appServiceSkuTier="Standard" export TF_VAR_enrichmentAppServiceSkuSize="P1v3" export TF_VAR_enrichmentAppServiceSkuTier="PremiumV3" -``` \ No newline at end of file +``` From 616baafc39e0da6e89b691cc475ce7d9d580b74c Mon Sep 17 00:00:00 2001 From: mausolf Date: Tue, 26 Mar 2024 21:43:30 +0000 Subject: [PATCH 4/7] corrected spelling errors and short names --- docs/knownissues.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index 5d9e6f57f..cec1adf65 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -1,8 +1,8 @@ # Known Issues -Here are some commonly encountered issues when deploying the PS Info Assistant Accelerator. +Here are some commonly encountered issues when deploying the WWPS Information Assistant accelerator. -## This subscription cannot create AzureIAServices until you agree to Responsible AI terms for this resource +## This subscription cannot create AzureAIServices until you agree to Responsible AI terms for this resource ```bash Error: This subscription cannot create CognitiveServices until you agree to Responsible AI terms for this resource. You can agree to Responsible AI terms by creating a resource through the Azure Portal then trying again. For more detail go to https://aka.ms/csrainotice"}] @@ -21,13 +21,12 @@ Manually create a "Azure AI services" in your Azure Subscription and Accept "Res ***IMPORTANT:*** In some instances, an older subscription that has already had the "Responsible AI Notice" accepted for the old "Cognitive Services multi-service account" may require this process to be repeated for the new "Azure AI Service". -***IMPORTANT:*** In some instances, an older subscription that has already had the "Responsible AI Notice" accepted for the old "Cognitive Services multi-service account" may require this process to be repeated for the new "Azure AI Service". --- ## Error "Your administrator has configured the application infoasst_web_access_xxxxx to block users..." -By default Info Assistant deploys the webapp to require users to be a member of an Azure Active Directory Enterprise Application to access the website. If a user is not a member of the AAD EA they will receive this error: +By default Information Assistant deploys the webapp to require users to be a member of an Azure Active Directory Enterprise Application to access the website. If a user is not a member of the AAD EA they will receive this error: ![image.png](images/known_Issues_web_app_authentication.png) @@ -129,9 +128,9 @@ To resolve, carefully check your local.env file for any missing but required val ### Solution -This was a problem with early deployments of 1.0. The root of this is table processing. If a table is greater than our target token count for a chunk, this is not respected meaning tables are not chunked, but treated as units. We now split tables by chunk size and repeat the table header rows in each chunk. +This was a problem with early deployments of Information Assistant 1.0. The root cause of this error is table processing. If a table is greater than our target token count for a chunk, this is not respected meaning tables are not chunked, but treated as units. We now split tables by chunk size and repeat the table header rows in each chunk. -This issue was resolved in a hotfix to the main branch of 1.0, so please upgrade to version 1.0 or later. +This issue was resolved in a hotfix to the main branch of Information Assistant 1.0, so please upgrade to version 1.0 or later. ## Error From f8cf78c10d4afe4cfd2f861fc939760d4e3562dc Mon Sep 17 00:00:00 2001 From: mausolf Date: Tue, 26 Mar 2024 23:28:35 +0000 Subject: [PATCH 5/7] updated params, values and descriptions for backoff - retry --- docs/knownissues.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index cec1adf65..e47a6a971 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -64,30 +64,30 @@ Occasionally you will see a 429 return code in the FileFormRecSubmissionPDF whic The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... -```text -@description('The maximum number of seconds between uploading a file and submitting it to FR') -param maxSecondsHideOnUpload string +```bash +"MAX_SECONDS_HIDE_ON_UPLOAD": "30", +// Description: The maximum number of seconds between uploading a file and submitting it to FR -@description('The maximum number of times a file can be resubmitted to FR due to throttling or internal FR capacity limitations') -param maxSubmitRequeueCount string +"MAX_SUBMIT_REQUEUE_COUNT": "10", +// Description: The maximum number of times a file can be resubmitted to FR due to throttling or internal FR capacity imitations -@description('the number of seconds that a message sleeps before we try to poll for FR completion') -param pollQueueSubmitBackoff string +"POLL_QUEUE_SUBMIT_BACKOFF": "60", +// Description: The number of seconds that a message sleeps before we try to poll for FR completion -@description('The number of seconds a message sleeps before trying to resubmit due to throttling request from FR') -param pdfSubmitQueueBackoff string +"PDF_SUBMIT_QUEUE_BACKOFF": "60", +// Description: The number of seconds a message sleeps before trying to resubmit due to throttling request from FR -@description('max times we will retry the submission due to throttling or internal errors in FR') -param maxPollingRequeueCount string +"MAX_POLLING_REQUEUE_COUNT": "10", +// Description: Max times to retry the submission due to throttling or internal errors in FR -@description('number of seconds to delay before trying to resubmit a doc to FR when it reported an internal error') -param submitRequeueHideSeconds string +"SUBMIT_REQUEUE_HIDE_SECONDS": "1200", +// Description: The number of seconds to delay before resubmitting a doc to FR when it reported an internal error -@description('The number of seconds we will hide a message before trying to repoll due to FR still processing a file. This is the default value that escalates exponentially') -param pollingBackoff string +"POLLING_BACKOFF": "30", +// Description: The number of seconds we will hide a message before trying to repoll due to FR still processing a file. This is the default value that escalates exponentially -@description('The maximum number of times we will retry to read a full processed document from FR. Failures in read may be due to network issues downloading the large response') -param maxReadAttempts string + "MAX_READ_ATTEMPTS": "5", + // Description: The maximum number of times we will retry to read a full processed document from FR. Failures in read may be due to network issues downloading the large response ``` --- From 063632715ebb3e7d7b035f3cb16b7134716a1255 Mon Sep 17 00:00:00 2001 From: mausolf Date: Wed, 27 Mar 2024 13:27:03 +0000 Subject: [PATCH 6/7] Added name, value, description table for backoff retry params --- docs/knownissues.md | 46 +++++++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 25 deletions(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index e47a6a971..abff0b095 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -62,32 +62,20 @@ Occasionally you will see a 429 return code in the FileFormRecSubmissionPDF whic ### Solution -The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. These values are as follows... +The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. The parameter names and values are as follows... + +```text +| Name | Value | Description | +|-----------------------------|-------|---------------------------------------------------------------------------------------------------------------------------| +| MAX_POLLING_REQUEUE_COUNT | 10 | Max times to retry submission due to throttling or internal errors in FR | +| MAX_READ_ATTEMPTS | 5 | Number of times to retry reading a processed document from FR | +| MAX_SECONDS_HIDE_ON_UPLOAD | 30 | Max number of seconds between uploading a file and submitting it to FR | +| MAX_SUBMIT_REQUEUE_COUNT | 10 | Max number of times a file can be resubmitted to FR for throttling or capacity limitations | +| PDF_SUBMIT_QUEUE_BACKOFF | 60 | Number of seconds a message sleeps before resubmitting due to throttlng request from FR | +| POLL_QUEUE_SUBMIT_BACKOFF | 60 | Number of seconds a message sleeps before we poll for FR completion | +| POLLING_BACKOFF | 30 | Number of seconds we hide a message before repolling due to FR still processing a file. This value esalates exponentially | +| SUBMIT_REQUEUE_HIDE_SECONDS | 1200 | Number of seconds to delay before trying to resubmit a doc to FR when it reported an internal error | -```bash -"MAX_SECONDS_HIDE_ON_UPLOAD": "30", -// Description: The maximum number of seconds between uploading a file and submitting it to FR - -"MAX_SUBMIT_REQUEUE_COUNT": "10", -// Description: The maximum number of times a file can be resubmitted to FR due to throttling or internal FR capacity imitations - -"POLL_QUEUE_SUBMIT_BACKOFF": "60", -// Description: The number of seconds that a message sleeps before we try to poll for FR completion - -"PDF_SUBMIT_QUEUE_BACKOFF": "60", -// Description: The number of seconds a message sleeps before trying to resubmit due to throttling request from FR - -"MAX_POLLING_REQUEUE_COUNT": "10", -// Description: Max times to retry the submission due to throttling or internal errors in FR - -"SUBMIT_REQUEUE_HIDE_SECONDS": "1200", -// Description: The number of seconds to delay before resubmitting a doc to FR when it reported an internal error - -"POLLING_BACKOFF": "30", -// Description: The number of seconds we will hide a message before trying to repoll due to FR still processing a file. This is the default value that escalates exponentially - - "MAX_READ_ATTEMPTS": "5", - // Description: The maximum number of times we will retry to read a full processed document from FR. Failures in read may be due to network issues downloading the large response ``` --- @@ -116,6 +104,8 @@ InvalidApiSetId - The account type 'OpenAI' is either invalid or unavailable in Deploy Azure OpenAI Service only in the supported regions. Review the local.env file and update the location as per supported models and [region availability](https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models#model-summary-table-and-region-availability) +--- + ## Error: jq parse error: Expected value before ',' If you see a jq parse error while running a deployment, it means one of the makefile scripts that extract environment variables is failing to find a value it expects. Carefully review the inf_output.json file and your local.env file used during build and deploy time @@ -124,6 +114,8 @@ If you see a jq parse error while running a deployment, it means one of the make To resolve, carefully check your local.env file for any missing but required values. There are rare times output values are not written. In which case simply double check your configuration and rerun the ```make deploy``` command to regenerate the inf_output.json file the Makefile scripts parse for variables. +--- + ## Error: Token limit often exceeded with PDF files ### Solution @@ -132,6 +124,8 @@ This was a problem with early deployments of Information Assistant 1.0. The root This issue was resolved in a hotfix to the main branch of Information Assistant 1.0, so please upgrade to version 1.0 or later. +--- + ## Error If you encounter an error similar to the one below that indicates your device must be managed. @@ -150,6 +144,8 @@ make: *** [Makefile:18: infrastructure] Error 1 You will need to open your Codespace in VSCode on your managed device. Please read more about opening your [CodeSpace using VSCode](/docs/deployment/developing_in_a_codespaces.md#using-github-codespaces-in-visual-studio-code). +--- + ## Error: This region has quota of 0 \ cores for your subscription You receive the following error message during `make deploy` From 2dd125d27dc765b44347a05528205974474c3db8 Mon Sep 17 00:00:00 2001 From: mausolf Date: Wed, 27 Mar 2024 14:15:38 +0000 Subject: [PATCH 7/7] included tf variables and portal config settings --- docs/knownissues.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/knownissues.md b/docs/knownissues.md index abff0b095..6e9b9dcb8 100644 --- a/docs/knownissues.md +++ b/docs/knownissues.md @@ -62,7 +62,7 @@ Occasionally you will see a 429 return code in the FileFormRecSubmissionPDF whic ### Solution -The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. The parameter names and values are as follows... +The back off and retry parameter values are surfaced as configuration settings in the Azure function and can be revised through the Azure portal in the Function App Configuration or in the functions local.settings.json file which is used when debugging a function in VS Code. The names and values are as follows... ```text | Name | Value | Description | @@ -78,6 +78,18 @@ The back off and retry parameter values are surfaced as configuration settings i ``` +These variables can also be updated prior to deployment by changing the following Terraform variables +```text +maxPollingRequeueCount +maxReadAttempts +maxSecondsHideOnUpload +maxSubmitRequeueCount +pdfSubmitQueueBackoff +pollQueueSubmitBackoff +pollingBackoff +submitRequeueHideSeconds +``` + --- ## Error : Error due to service unavailability