Guidelines for Writing an AI Description

Note:

The content in this topic applies only if the AI Description field is available in the custom object definition page.

This topic provides guidelines for writing AI Descriptions for custom objects, such as record types, transaction types, and fields. For general information about the AI Description field, see AI Description for Custom Object Definitions.

Use the dos and don'ts outlined in the following table to help you write your AI description.

Do	Don't
Include what the custom record, field, or transaction is used for, and list the types of data it holds. Explain how the object fits into your business process. Focus on the business reason or why this custom object exists. Highlight relationships to other records or fields if they're essential for understanding. List the types of data the field holds (if describing a field). Keep your description short and focused (maximum 280 characters, including spaces). Use clear, everyday language. Make it understandable for someone outside your team or company. Update the description if the business use changes.	Use internal jargon, codes, or technical abbreviations. Reference NetSuite screen names, menu paths, or navigation steps. Include internal IDs or irrelevant numbers. Copy and paste unrelated documentation or code. Use special formatting, bullet points, or non-standard characters. Exceed the 280-character limit. Add specific examples or user instructions-keep it general and descriptive.

Don't

Include what the custom record, field, or transaction is used for, and list the types of data it holds.
Explain how the object fits into your business process.
Focus on the business reason or why this custom object exists.
Highlight relationships to other records or fields if they're essential for understanding.
List the types of data the field holds (if describing a field).
Keep your description short and focused (maximum 280 characters, including spaces).
Use clear, everyday language.
Make it understandable for someone outside your team or company.
Update the description if the business use changes.

Use internal jargon, codes, or technical abbreviations.
Reference NetSuite screen names, menu paths, or navigation steps.
Include internal IDs or irrelevant numbers.
Copy and paste unrelated documentation or code.
Use special formatting, bullet points, or non-standard characters.
Exceed the 280-character limit.
Add specific examples or user instructions-keep it general and descriptive.

See the following topics for AI description examples:

Related Topics