Basic Examples (2)
Explain what a function does using natural language:
Please document my function for me:
Scope (4)
Summarize the definition of a ResourceFunction:
Do not apply any formatting to the result:
Format as a text cell:
PartyParrot is a Wolfram Language function that retrieves data about various Party Parrots from an external source. It can be used with or without arguments. When called without arguments, it will return a list of all the Party Parrot names. When called with a single argument - the id of the Party Parrot - it will return the simple animation associated with that Party Parrot.
Summarize the definition of a PacletSymbol:
Options (6)
OpenAIKey (3)
Specify the OpenAI API key to authenticate requests with:
Save the API key persistently using SystemCredential:
This key is now used by default:
Model (1)
Specify an alternate language model:
MaxTokens (2)
Some models require a smaller number of tokens:
Specify a smaller value:
Properties and Relations (5)
SummarizeDefinition has the attribute HoldFirst, so it can be used on symbols defined with OwnValues:
SummarizeDefinition is not deterministic:
Symbol names have a significant influence on the result. Here are two equivalent definitions that only differ in name (the definition is from the resource function StupidSort):
SummarizeDefinition is far more likely to mention that StupidSort is inefficient:
Well-named symbols will often lead to higher-level explanations:
SummarizeDefinition includes dependent symbol definitions:
Possible Issues (4)
SummarizeDefinition will not work without an OpenAI API key:
System symbols are not supported:
Symbols cannot have the ReadProtected attribute:
Some models can occasionally return an empty response:
Some are just not suitable for this particular task: