LLMSynthesize

This functionality requires an external account »

LLMSynthesize[prompt]

generates text according to the input prompt.

LLMSynthesize[{prompt1,…}]

combines multiple prompti together.

LLMSynthesize[…,prop]

returns the specified property of the generated text.

Details and Options

  • LLMSynthesize generates text according to the instruction in the prompt using a large language model (LLM). It can create content, complete sentences, extract information and more.
  • LLMSynthesize requires external service authentication, billing and internet connectivity.
  • Possible values for prompt can be:
  • "string"static text
    LLMPrompt["name"]a repository prompt
    StringTemplate[…]templated text
    TemplateObject[…]template for creating a prompt
    Image[…]an image
    {prompt1,…}a list of prompts
  • Template objects are automatically converted to strings via TemplateObject[…][].
  • Prompts created with TemplateObject can contain text and images.
  • Not every LLM supports image input.
  • Supported values for prop include:
  • "CompletionText"textual answer by the LLM
    "CompletionToolsText"textual answer including tool interactions
    "FullText"string representation of "History"
    "History"complete history including prompt and completion
    "Prompt"content submitted to the LLM
    "PromptText"string representation of "Prompt"
    "ToolRequests"list of LLMToolRequest objects
    "ToolResponses"list of LLMToolResponse objects
    {prop1,prop2,…}multiple properties
    Allall properties
  • "FullTextAnnotations", "ToolRequests" and "ToolResponses" give associations with elements in the format {start,end}val, where val refers to an object and start and end refer to the span of characters where val is specified in "FullText".
  • The following options can be specified:
  • Authentication Automaticexplicit user ID and API key
    LLMEvaluator $LLMEvaluatorLLM configuration to use
    ProgressReporting$ProgressReportinghow to report the progress of the computation
  • LLMEvaluator can be set to an LLMConfiguration object or an association with any of the following keys:
  • "MaxTokens"maximum amount of tokens to generate
    "Model"base model
    "PromptDelimiter"string to insert between prompts
    "Prompts"initial prompts or LLMPromptGenerator objects
    "StopTokens"tokens on which to stop generation
    "Temperature"sampling temperature
    "ToolMethod"method to use for tool calling
    "Tools"list of LLMTool objects to make available
    "TopProbabilities"sampling classes cutoff
    "TotalProbabilityCutoff"sampling probability cutoff (nucleus sampling)
  • Valid forms of "Model" include:
  • namenamed model
    {service,name}named model from service
    <|"Service"service,"Name"name,"Task"task|>fully specified model
  • Possible values for task include "Chat" and "Completion".
  • The generated text is sampled from a distribution. Details of the sampling can be specified using the following properties of the LLMEvaluator:
  • "Temperature"tAutomaticsample using a positive temperature t
    "TopProbabilities"kAutomaticsample only among the k highest-probability classes
    "TotalProbabilityCutoff"pAutomaticsample among the most probable choices with an accumulated probability of at least p (nucleus sampling)
  • The Automatic value of these parameters uses the default for the specified "Model".
  • Prompts specified in the "Prompts" property of the LLMEvaluator are prepended to the input prompt with role set as "System" if task is "Chat"
  • Multiple prompts are separated by the "PromptDelimiter" property of the LLMEvaluator.
  • Possible values for Authentication are:
  • Automaticchoose the authentication scheme automatically
    Environmentcheck for a key in the environment variables
    SystemCredentialcheck for a key in the system keychain
    ServiceObject[…]inherit the authentication from a service object
    assocprovide an explicit key and user ID
  • With AuthenticationAutomatic, the function checks the variable ToUpperCase[service]<>"_API_KEY" in Environment and SystemCredential; otherwise, it uses ServiceConnect[service].
  • When using Authenticationassoc, assoc can contain the following keys:
  • "ID"user identity
    "APIKey"API key used to authenticate
  • LLMSynthesize uses machine learning. Its methods, training sets and biases included therein may change and yield varied results in different versions of the Wolfram Language.

Examples

open allclose all

Basic Examples  (3)

Synthesize text based on a simple description:

Ask a question:

Return the full context of the LLM:

Scope  (3)

Synthesize text based on a prompt:

Use a prompt with both text and images:

Specify a property to return:

Options  (8)

Authentication  (4)

Provide an authentication key for the API:

Provide both a user ID and the API key:

Store the API key using the operating system's keychain:

Look for the key in the system keychain:

Store the API key in an environment variable:

Look for the key in the system environment:

Authenticate via a service object:

LLMEvaluator  (4)

By default, the text generation continues until a termination token is generated:

Limit the amount of generated samples (tokens):

Specify that the sampling should be performed at zero temperature:

Specify a high temperature to get more variation in the generation:

Specify the maximum cumulative probability before cutting off the distribution:

Specify the service and the model to use for the generation:

Applications  (1)

Define a function that builds a prompt programmatically:

Use it to create a natural language synonym generator:

Apply it to a sequence of arguments:

Possible Issues  (1)

The text generation is not guaranteed to follow instructions to the letter:

Use exact arithmetic for precise computations:

Wolfram Research (2023), LLMSynthesize, Wolfram Language function, https://reference.wolfram.com/language/ref/LLMSynthesize.html.

Text

Wolfram Research (2023), LLMSynthesize, Wolfram Language function, https://reference.wolfram.com/language/ref/LLMSynthesize.html.

CMS

Wolfram Language. 2023. "LLMSynthesize." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/LLMSynthesize.html.

APA

Wolfram Language. (2023). LLMSynthesize. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/LLMSynthesize.html

BibTeX

@misc{reference.wolfram_2024_llmsynthesize, author="Wolfram Research", title="{LLMSynthesize}", year="2023", howpublished="\url{https://reference.wolfram.com/language/ref/LLMSynthesize.html}", note=[Accessed: 24-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_llmsynthesize, organization={Wolfram Research}, title={LLMSynthesize}, year={2023}, url={https://reference.wolfram.com/language/ref/LLMSynthesize.html}, note=[Accessed: 24-November-2024 ]}