Skip to content

Commit 1a67106

Browse files
authored
Merge pull request #285225 from MicrosoftDocs/main
8/21/2024 PM Publish
2 parents 5cd3977 + 00204e2 commit 1a67106

File tree

152 files changed

+1393
-1198
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+1393
-1198
lines changed

articles/ai-services/content-safety/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ To use the Content Safety APIs, you must create your Azure AI Content Safety res
156156
| France Central || | | || ||
157157
| West Europe |||| || ||
158158
| Japan East || | | || ||
159-
| Australia East|| | | ||||
159+
| Australia East|| | | ||||
160160
| USGov Arizona || | | | | | |
161161
| USGov Virginia || | | | | | |
162162

articles/ai-services/content-safety/quickstart-groundedness.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Create a new Python file named _quickstart.py_. Open the new file in your prefer
8181
"groundingSources": [
8282
"I'm 21 years old and I need to make a decision about the next two years of my life. Within a week. I currently work for a bank that requires strict sales goals to meet. IF they aren't met three times (three months) you're canned. They pay me 10/hour and it's not unheard of to get a raise in 6ish months. The issue is, **I'm not a salesperson**. That's not my personality. I'm amazing at customer service, I have the most positive customer service \"reports\" done about me in the short time I've worked here. A coworker asked \"do you ask for people to fill these out? you have a ton\". That being said, I have a job opportunity at Chase Bank as a part time teller. What makes this decision so hard is that at my current job, I get 40 hours and Chase could only offer me 20 hours/week. Drive time to my current job is also 21 miles **one way** while Chase is literally 1.8 miles from my house, allowing me to go home for lunch. I do have an apartment and an awesome roommate that I know wont be late on his portion of rent, so paying bills with 20hours a week isn't the issue. It's the spending money and being broke all the time.\n\nI previously worked at Wal-Mart and took home just about 400 dollars every other week. So I know i can survive on this income. I just don't know whether I should go for Chase as I could definitely see myself having a career there. I'm a math major likely going to become an actuary, so Chase could provide excellent opportunities for me **eventually**."
8383
],
84-
"reasoning": false
84+
"reasoning": False
8585
})
8686
headers = {
8787
'Ocp-Apim-Subscription-Key': '<your_subscription_key>',

articles/ai-services/document-intelligence/concept-custom-generative.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Field extraction custom generative model `2024-07-31-preview` version is only av
9090

9191
* **Field Description**. Provide more contextual information in description to help clarify the field that needs to be extracted. Examples include location in the document, potential field labels it can be associated with, and ways to differentiate with other terms that could be ambiguous.
9292

93-
* **Variation**. Custom generative models can generalize across different document templates of the same document type. As a best practice, create a single model for all variations of a document type. Ideally, include a visual template for each type, especially for ones that
93+
* **Variation**. Custom generative models can generalize across different document templates of the same document type. As a best practice, create a single model for all variations of a document type. Ideally, include a visual template for each type, especially for ones that involve distinct formatting or structural elements, to improve the model's accuracy and consistency in generating or processing documents.
9494

9595
## Service guidance
9696

articles/ai-services/document-intelligence/concept-mortgage-documents.md

Lines changed: 4 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The Document Intelligence Mortgage models use powerful Optical Character Recogni
2626
**Supported document types:**
2727

2828
* Uniform Residential Loan Application (Form 1003)
29+
* Uniform Residential Appraisal Report (Form 1004)
30+
* Verification of employment form (Form 1005)
2931
* Uniform Underwriting and Transmittal Summary (Form 1008)
3032
* Closing Disclosure form
3133

@@ -38,7 +40,7 @@ Document Intelligence v4.0 (2024-07-31-preview) supports the following tools, ap
3840

3941
| Feature | Resources | Model ID |
4042
|----------|-------------|-----------|
41-
|**Mortgage model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-07-31-preview)&preserve-view=true)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**&bullet; prebuilt-mortgage.us.1003</br>&bullet; prebuilt-mortgage.us.1008</br>&bullet; prebuilt-mortgage.us.closingDisclosure**|
43+
|**Mortgage model**|&bullet; [**Document Intelligence Studio**](https://formrecognizer.appliedai.azure.com)</br>&bullet; [**REST API**](/rest/api/aiservices/operation-groups?view=rest-aiservices-v4.0%20(2024-07-31-preview)&preserve-view=true)</br>&bullet; [**C# SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Python SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**Java SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)</br>&bullet; [**JavaScript SDK**](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-4.0.0&preserve-view=true)|**&bullet; prebuilt-mortgage.us.1003</br>&bullet; prebuilt-mortgage.us.1004</br>&bullet; prebuilt-mortgage.us.1005</br>&bullet; prebuilt-mortgage.us.1008</br>&bullet; prebuilt-mortgage.us.closingDisclosure**|
4244
::: moniker-end
4345

4446
## Input requirements
@@ -126,74 +128,6 @@ The following are the fields extracted from a 1003 URLA form in the JSON output
126128
|`Property.MixedUseProperty`|`selectionGroup`|Is the property a mixed-use property?|:selected: NO:unselected: YES|
127129
|`Property.ManufacturedHome`|`selectionGroup`|Is the property a manufactured home?|:selected: NO:unselected: YES|
128130

129-
## [2024-02-29-preview](#tab/2024-02-29-preview)
130-
131-
132-
### Supported languages and locales
133-
134-
135-
136-
| Supported Languages | Details |
137-
|:--------------------|:-------:|
138-
|English|United States (`en-US`)|
139-
140-
141-
### Supported document fields
142-
143-
#### mortgage.us.1003
144-
145-
| Field | Type | Description | Example |
146-
|:------|:-----|:------------|:--------|
147-
|`LenderLoanNumber`|`string`|Lender loan number or universal loan identifier|10Bx939c5543TqA1144M999143X38|
148-
|`AgencyCaseNumber`|`string`|Agency case number|115894|
149-
|`Borrower`|`object`|||
150-
|`Borrower.Name`|`string`|Borrower's full name as written on the form|Gwen Stacy|
151-
|`Borrower.SocialSecurityNumber`|`string`|Borrower's social security number|557-99-7283|
152-
|`Borrower.BirthDate`|`date`|Borrower's date of birth|11/07/1989|
153-
|`Borrower.CitizenshipType`|`selectionGroup`|Borrower's citizenship|:selected: U.S. Citizen<br>:unselected: Permanent Resident Alien<br>:unselected: Non-Permanent Resident Alien|
154-
|`Borrower.CreditApplicationType`|`selectionGroup`|Borrower's credit type|:selected: I'm applying for individual credit.<br>:unselected: I'm applying for joint credit.|
155-
|`Borrower.NumberOfBorrowers`|`integer`|Total number of borrowers|1|
156-
|`Borrower.MaritalStatus`|`selectionGroup`|Borrower's marital status|:selected: Married<br>:unselected: Separated<br>:unselected: Unmarried|
157-
|`Borrower.NumberOfDependents`|`integer`|Total number of borrower's dependents|2|
158-
|`Borrower.DependentsAges`|`string`|Age of borrower's dependents|10, 11|
159-
|`Borrower.HomePhoneNumber`|`phoneNumber`|Borrower's home phone number|(818) 246-8900|
160-
|`Borrower.CellPhoneNumber`|`phoneNumber`|Borrower's cell phone number|(831) 728-4766|
161-
|`Borrower.WorkPhoneNumber`|`phoneNumber`|Borrower's work phone number|(987) 213-5674|
162-
|`Borrower.CurrentAddress`|`address`|Borrower's current address|1634 W Glenoaks Blvd<br>Glendale CA 91201 United States|
163-
|`Borrower.YearsInCurrentAddress`|`integer`|Years in current address|1|
164-
|`Borrower.MonthsInCurrentAddress`|`integer`|Months in current address|1|
165-
|`Borrower.CurrentHousingExpenseType`|`selectionGroup`|Borrower's housing expense type|:unselected: No primary housing expense:selected: Own:unselected: Rent|
166-
|`Borrower.CurrentMonthlyRent`|`number`|Borrower's monthly rent|1,600.00|
167-
|`Borrower.SignedDate`|`date`|Borrower's signature date|03/16/2021|
168-
|`CoBorrower`|`object`|||
169-
|`CoBorrower.Names`|`string`|Coborrowers' names|Peter Parker<br>Mary Jane Watson|
170-
|`CoBorrower.SignedDate`|`date`|Coborrower's signature date|03/16/2021|
171-
|`CurrentEmployment`|`object`|||
172-
|`CurrentEmployment.DoesNotApply`|`boolean`|Checkbox state of 'Doesn't apply'|:selected:|
173-
|`CurrentEmployment.EmployerName`|`string`|Borrower's employer or business name|Spider Wb Corp.|
174-
|`CurrentEmployment.EmployerPhoneNumber`|`phoneNumber`|Borrower's employer phone number|(390) 353-2474|
175-
|`CurrentEmployment.EmployerAddress`|`address`|Borrower's employer address|3533 Band Ave<br>Glendale CA 92506 United States|
176-
|`CurrentEmployment.PositionOrTitle`|`string`|Borrower's position or title|Language Teacher|
177-
|`CurrentEmployment.StartDate`|`date`|Borrower's employment start date|01/08/2020|
178-
|`CurrentEmployment.GrossMonthlyIncomeTotal`|`number`|Borrower's gross monthly income total|4,254.00|
179-
|`Loan`|`object`|||
180-
|`Loan.Amount`|`number`|Loan amount|156,000.00|
181-
|`Loan.PurposeType`|`selectionGroup`|Loan purpose type|:unselected: Purchase:selected: Refinance:unselected: Other|
182-
|`Loan.OtherPurpose`|`string`|Other loan purpose type|Construction|
183-
|`Loan.RefinanceType`|`selectionGroup`|Loan refinance type|:selected: No Cash Out<br>:unselected: Limited Cash Out<br>:unselected: Cash Out|
184-
|`Loan.RefinanceProgramType`|`selectionGroup`|Loan refinance program type|:unselected: Full Documentation:selected: Interest Rate Reduction<br>:unselected: Streamlined without Appraisal<br>:unselected: Other|
185-
|`Loan.OtherRefinanceProgram`|`string`|Other loan refinance program type|Cash-out refinance|
186-
|`Property`|`object`|||
187-
|`Property.Address`|`address`|Property address|1634 W Glenoaks Blvd<br>Glendale CA 91201 Los Angeles|
188-
|`Property.NumberOfUnits`|`integer`|Number of units|1|
189-
|`Property.Value`|`number`|Property value|200,000.00|
190-
|`Property.OccupancyStatus`|`selectionGroup`|Property occupancy status|:selected: Primary Residence<br>:unselected: Second Home<br>:unselected: Investment Property|
191-
|`Property.IsFhaSecondaryResidence`|`boolean`|Checkbox state of '`FHA` Secondary Residence'|:unselected:|
192-
|`Property.MixedUseProperty`|`selectionGroup`|Is the property a mixed-use property?|:selected: NO:unselected: YES|
193-
|`Property.ManufacturedHome`|`selectionGroup`|Is the property a manufactured home?|:selected: NO:unselected: YES|
194-
195-
196-
The 1003 URLA key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
197131

198132
## Field extraction 1004 Uniform Residential Appraisal Report (URAR)
199133
The following are the fields extracted from a 1004 URAR form in the JSON output response.
@@ -404,4 +338,4 @@ The mortgage closing disclosure key-value pairs and line items extracted are in
404338
* Try processing your own forms and documents with the [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio).
405339

406340
* Complete a [Document Intelligence quickstart](quickstarts/get-started-sdks-rest-api.md?view=doc-intel-3.0.0&preserve-view=true) and get started creating a document processing app in the development language of your choice.
407-
341+

articles/ai-services/openai/concepts/assistants.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: Azure OpenAI Service Assistants API concepts
33
titleSuffix: Azure OpenAI Service
44
description: Learn about the concepts behind the Azure OpenAI Assistants API.
55
ms.topic: conceptual
6-
ms.date: 03/04/2024
6+
ms.date: 08/21/2024
77
ms.service: azure-ai-openai
88
manager: nitinme
9-
author: mrbullwinkle
10-
ms.author: mbullwin
9+
author: aahill
10+
ms.author: aahi
1111
recommendations: false
1212
---
1313

@@ -71,21 +71,21 @@ The Assistants API has support for several parameters that let you customize the
7171

7272
## Context window management
7373

74-
Assistants automatically truncates text to ensure it stays within the model's maximum context length. You can customize this behavior by specifying the maximum tokens you'd like a run to utilize and/or the maximum number of recent messages you'd like to include in a run.
74+
Assistants automatically truncate text to ensure it stays within the model's maximum context length. You can customize this behavior by specifying the maximum tokens you'd like a run to utilize and/or the maximum number of recent messages you'd like to include in a run.
7575

7676
### Max completion and max prompt tokens
7777

7878
To control the token usage in a single Run, set `max_prompt_tokens` and `max_completion_tokens` when you create the Run. These limits apply to the total number of tokens used in all completions throughout the Run's lifecycle.
7979

80-
For example, initiating a Run with `max_prompt_tokens` set to 500 and `max_completion_tokens` set to 1000 means the first completion will truncate the thread to 500 tokens and cap the output at 1000 tokens. If only 200 prompt tokens and 300 completion tokens are used in the first completion, the second completion will have available limits of 300 prompt tokens and 700 completion tokens.
80+
For example, initiating a Run with `max_prompt_tokens` set to 500 and `max_completion_tokens` set to 1000 means the first completion will truncate the thread to 500 tokens and cap the output at 1,000 tokens. If only 200 prompt tokens and 300 completion tokens are used in the first completion, the second completion will have available limits of 300 prompt tokens and 700 completion tokens.
8181

8282
If a completion reaches the `max_completion_tokens` limit, the Run will terminate with a status of incomplete, and details will be provided in the `incomplete_details` field of the Run object.
8383

8484
When using the File Search tool, we recommend setting the `max_prompt_tokens` to no less than 20,000. For longer conversations or multiple interactions with File Search, consider increasing this limit to 50,000, or ideally, removing the `max_prompt_tokens` limits altogether to get the highest quality results.
8585

8686
## Truncation strategy
8787

88-
You may also specify a truncation strategy to control how your thread should be rendered into the model's context window. Using a truncation strategy of type `auto` will use OpenAI's default truncation strategy. Using a truncation strategy of type `last_messages` will allow you to specify the number of the most recent messages to include in the context window.
88+
You can also specify a truncation strategy to control how your thread should be rendered into the model's context window. Using a truncation strategy of type `auto` will use OpenAI's default truncation strategy. Using a truncation strategy of type `last_messages` will allow you to specify the number of the most recent messages to include in the context window.
8989

9090
## See also
9191
* Learn more about Assistants and [File Search](../how-to/file-search.md)

0 commit comments

Comments
 (0)