Title: PromptBuilder::usingTopLogprobs
Published: May 20, 2026

---

# PromptBuilder::usingTopLogprobs( int|null $topLogprobs = null ): self

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#description)
 * [Parameters](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#parameters)
 * [Return](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#return)
 * [Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#source)
 * [Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#wp--skip-link--target)

Sets the top log probabilities configuration.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#description)󠁿

If $topLogprobs is null, enables log probabilities.
If $topLogprobs has a value,
enables log probabilities and sets the number of top log probabilities to return.

## 󠀁[Parameters](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#parameters)󠁿

 `$topLogprobs`int|nulloptional

The number of top log probabilities to return, or null to enable log probabilities.

Default:`null`

## 󠀁[Return](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#return)󠁿

 self

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#source)󠁿

    ```php
    public function usingTopLogprobs(?int $topLogprobs = null): self
    {
        // Always enable log probabilities
        $this->modelConfig->setLogprobs(\true);
        // If a specific number is provided, set it
        if ($topLogprobs !== null) {
            $this->modelConfig->setTopLogprobs($topLogprobs);
        }
        return $this;
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/php-ai-client/src/builders/promptbuilder.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/7.0/src/wp-includes/php-ai-client/src/Builders/PromptBuilder.php#L495)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Builders/PromptBuilder.php#L495-L504)

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingtoplogprobs/?output_format=md#changelog)󠁿

| Version | Description | 
| [0.1.0](https://developer.wordpress.org/reference/since/0.1.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwordpress-aiclient-builders-promptbuilder%2Fusingtoplogprobs%2F)
before being able to contribute a note or feedback.