feat: Code merge to main

Author: Prajwal-Microsoft

.gitignore

@@ -10,12 +10,12 @@ The Content Processing solution accelerator consists of a number of APIs to hand
     OpenAPI: https://<content-processing-api-container-url>/redoc
 
 ## APIs
-Outlined before are the various APIs that are available as both Swagger and OpenAPI specifications within the solution.
+Outlined below are the various APIs that are available as both Swagger and OpenAPI specifications within the solution.
 
 ### Content Processor
-Responsible processing level actions to capture a file, processess, and queue management.
+Responsible processing level actions to capture a file, processes, and queue management.
 - **[POST]** Processed: Get all processed contents list.
-- **[POST]** Submit: Submit a file to be processed with it's selected schema and any custom meta data to pass along with it for external reference.
+- **[POST]** Submit: Submit a file to be processed with its selected schema and any custom meta data to pass along with it for external reference.
 - **[GET]** Status: Get the status of a file being processed. It shows the status of the file being processed in the pipeline.
 - **[GET]** Processed: Get the processed content results.
 - **[PUT]** Processed: Updates the processed content results; updates the comment in the process.
@@ -32,11 +32,11 @@ System level configuration for adding and managing schemas in the system related
 - **[GET]** Health: Determines the alive state of the solution for processing.
 - **[GET]** Startup: Determines the startup state of the solution.
 
-> Note: You can find a sample REST Client calls with endponts and payload examples in the respository at:<br/><br/>
-/src/ContentProcessorAPI/tetst_http/invoke_APIs.http
+> Note: You can find a sample REST Client call with endpoints and payload examples in the repository at:<br/><br/>
+/src/ContentProcessorAPI/test_http/invoke_APIs.http
 
 ## Note on Custom Meta Data
-Custom meta data can optionally be passed along when submitting a file to be processed on the Content Processor API. This allows for external source system refereence information to be captured and passed through the processing steps. This information stays as reference only for down-stream reference and is not used in in processessing or modifying any data extraction, mapping, or transformation.
+Custom meta data can optionally be passed along when submitting a file to be processed on the Content Processor API. This allows for external source system reference information to be captured and passed through the processing steps. This information stays as reference only for down-stream reference and is not used in processing or modifying any data extraction, mapping, or transformation.
 
 ## Security
 Security is applied to the API by utilizing a vnet for traffic and network control. A service principal with permission can programmatically call the end points and is registered as an application registration in Azure.

docs/API.md

@@ -52,11 +52,53 @@ We will add Microsoft Entra ID as an authentication provider to API and Web Appl
 ![configuration_app_registration_web_8](./Images/configure_app_registration_web_8.png)
 
 
+3. Grap Scope Name for Impersonation  
+      - Select **Expose an API** in left menu. Copy the Scope name then paste in some temporary place.  
+      The copied text will be used for Web Application Environment variable - **APP_MSAL_AUTH_SCOPE**.  
+![configuration_app_registration_web_9](./Images/configure_app_registration_web_9.png)
+
+4. Grap Client Id for Web App  
+      - Select **Overview** in left menu. Copy the Client Id then paste in some temporary place.  
+        The copied text will be used for Web Application Environment variable - **APP_MSAL_AUTH_CLIENT_ID**  
+![configuration_app_registration_web_10](./Images/configure_app_registration_web_10.png)
+  
 ## Step 3: Configure Application Registration - API Application  
-Add Web Application Registration's Client Id to API's Allowed client application list.
+1. Grap Scope Name for Impersonation  
+   - Go to deployed Container App **ca-< your environment >-< randomname >-api** and select **Authentication** menu then select created Application Registration  
+![configuration_app_registration_api_1](./Images/configure_app_registration_api_1.png)
+
+    - Select **Expose an API** in left menu.Copy the Scope name then paste in some temporary place.  
+    The copied text will be used for Web Application Environment variable - **APP_MSAL_TOKEN_SCOPE**.  
+![configuration_app_registration_api_2](./Images/configure_app_registration_api_2.png)
+
+2. Grap Client Id for API  
+      - Select **Overview** in left menu. Copy the Client Id then paste in some temporary place.  
+        The copied text will be used for **allowed  client applications** list
+![configuration_app_registration_api_3](./Images/configure_app_registration_api_3.png)
+
+## Step 4: Add API Client Id to Allowed Client Applications list in Web Application's Registration  
+1. Go to deployed Container App **ca-< your environment >-< randomname >-web** and select **Authentication** menu then select **Edit**  
+![add_client_id_to_web_1](./Images/add_client_id_to_web_1.png) 
+2. Select **Allow requests from specific client applications** then click **pencil** icon to add client Id  
+![add_client_id_to_web_2](./Images/add_client_id_to_web_2.png)  
+1. Add **Client Id** from [API App registration from previous step] then Save(#step-3-configure-application-registration---api-application).  
+![add_client_id_to_web_3](./Images/add_client_id_to_web_3.png)
+
+
+## Step 5: Update Environment Variable in Container App for Web Application
+In previous 2 steps for [Configure Application Registration - Web Application](#step-2-configure-application-registration---web-application) and [Configure Application Registration - API Application](#step-3-configure-application-registration---api-application), we could grap Client Id for Web App's Application Registration and Scopes for Web and API's Application Registration.  
+
+Now, We will Edit and deploy Web Application Container with updated Environment variables.  
+
+1. Select **Containers** menu under **Application** then **click Edit and Deploy** menu.
+![update_env_app_1](./Images/update_env_app_1.png)
+
+2. Select Container image and Click **Edit**. under **Environment variables** sections, update 3 values which were taken in previous steps for **APP_MSAL_AUTH_CLIENT_ID**, **APP_MSAL_AUTH_SCOPE**, **APP_MSAL_TOKEN_SCOPE**.  
+Now updated Revision will be activated soon.
+
+
+
 
-## Step 4: Update Environment Variable in Container App for Web Application
-Update Environment variable for Client Id in Web App's application registration, Scope for Web as auth scope, Scope for API as token scope
 
 
 

docs/ConfigureAppAuthentication_withImage.md

@@ -9,7 +9,7 @@ Using AI, the processing pipeline will extract what is preceived as is the "invo
 
 With this concept in mind, schemas need to be created specific to your business and domain requirements. A lot of times schemas may be generally common across industries, but this allows for variations specific to your use case.
 
-A schema should be created that includes all fields you expect to extract and transformed to. Once a schema is added specific to your intended files, you can then programmatically call the API endpoints to submit and process the file for that schema or utilize the web UI to manually process and review.
+A schema should be created that includes all fields you expect to extract and transform to. Once a schema is added specific to your intended files, you can then programmatically call the API endpoints to submit and process the file for that schema or utilize the web UI to manually process and review.
 
 ## Steps to add a Custom Schema
 1. **Create .py class to define schema**<br/>
@@ -33,13 +33,13 @@ A schema should be created that includes all fields you expect to extract and tr
     - Base import statements.
     - Class and subclass definitions that inherit from pydantic BaseModel.
     - Each class has fields, methods, and meta data.
-    - Classes include a class name, a string describing the class, it's attributes, and the attributes descriptions These are used during mapping and data transformation in the processing pipeline.
+    - Classes include a class name, a string describing the class, its attributes, and the attributes descriptions. These are used during mapping and data transformation in the processing pipeline.
     - Classes also include fields and methods.
 
 
     #### Fields
 
-    - Fields are defined in the class to represent what data this class hold. This is a 1-to-1 relationship with what gets extracted from a file being processed is mapped to this specific field. If your file has a field you'd like to extract called "invoice date", you'd have a field defined in your class to represent that.
+    - Fields are defined in the class to represent what data this class holds. This is a 1-to-1 relationship with what gets extracted from a file being processed is mapped to this specific field. If your file has a field you'd like to extract called "invoice date", you'd have a field defined in your class to represent that.
     - Each field has annotations to designate if it is optional or required.
     - Fields also have a string describing what it is and it is used as a prompt to help with data evaluation/validation, mapping and transformation in the processing pipeline. Include an example in the description to help with specificity or experiment with simple logic to help the LLM process the content correctly.
 

docs/CustomizeSchemaData.md

@@ -26,8 +26,8 @@ Here are some example regions where the services are available: East US, East US
 Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
 
 
-| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/content-processing-solution-accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/content-processing-solution-accelerator) | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2Fcontent-processing-solution-accelerator%2Fmain%2Finfra%2Fmain.json) |
-|---|---|---|
+| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/content-processing-solution-accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/content-processing-solution-accelerator) |
+|---|---|
 
 <details>
   <summary><b>Deploy in GitHub Codespaces</b></summary>
@@ -48,7 +48,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
 <details>
   <summary><b>Deploy in VS Code</b></summary>
 
- ### VS Code Dev Containers
+### VS Code Dev Containers
 
 You can run this solution in VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers):
 
@@ -66,7 +66,7 @@ You can run this solution in VS Code Dev Containers, which will open the project
 <details>
   <summary><b>Deploy in your local environment</b></summary>
 
-  ### Local environment 
+### Local environment 
 
   If you're not using one of the above options for opening the project, then you'll need to:
 
@@ -89,20 +89,10 @@ You can run this solution in VS Code Dev Containers, which will open the project
 
 </details>
 
-<details>
-  <summary><b>Deploy with Bicep/ARM template</b></summary>
-
-### Bicep
- 
-   Click the following deployment button to create the required resources for this solution directly in your Azure Subscription.
-
-   [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2Fcontent-processing-solution-accelerator%2Fmain%2Finfra%2Fmain.json)          
-
-</details>
 <br/>
 
+Consider the following settings during your deployment to modify specific settings:
 
-Next, consider the following settings during your deployment:
 <details>
   <summary><b>Configurable Deployment Settings</b></summary>
 
@@ -178,7 +168,7 @@ To change the azd parameters from the default values, follow the steps [here](./
     - **Get API Service's Endpoint**
         - Get API Service Endpoint Url from your container app for API  
           Name is **ca-**<< your environmentName >>-**api**  
-          ![Check API Service Url](images/CheckAPIService.png)
+          ![Check API Service Url](Images/CheckAPIService.png)
 
 
          - Copy the URL
@@ -197,11 +187,11 @@ To change the azd parameters from the default values, follow the steps [here](./
          
 
           ```Powershell
-          ./register_schema.ps1 http://<< API Service Endpoint>>/schemavault/ schema_info_ps1.json
+          ./register_schema.ps1 http://<< API Service Endpoint>>/schemavault/ .\schema_info_ps1.json
           ```  
 
     - **Verify Results**
-        ![schema file registration](images/SchemaFileRegistration.png)
+        ![schema file registration](./Images/SchemaFileRegistration.png)