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

---

# PromptBuilder::usingCandidateCount( int $candidateCount ): self

## In this article

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

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

Sets the number of candidates to generate.

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

 `$candidateCount`intrequired

The number of candidates.

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

 self

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

    ```php
    public function usingCandidateCount(int $candidateCount): self
    {
        $this->modelConfig->setCandidateCount($candidateCount);
        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#L414)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/7.0/src/wp-includes/php-ai-client/src/Builders/PromptBuilder.php#L414-L418)

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

| Used by | Description | 
| [PromptBuilder::generateSpeeches()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatespeeches/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates multiple speech outputs from the prompt.

  | 
| [PromptBuilder::generateVideos()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatevideos/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates multiple videos from the prompt.

  | 
| [PromptBuilder::generateTexts()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generatetexts/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates multiple text candidates from the prompt.

  | 
| [PromptBuilder::generateImages()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/generateimages/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Generates multiple images from the prompt.

  | 
| [PromptBuilder::convertTextToSpeeches()](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/converttexttospeeches/)`wp-includes/php-ai-client/src/Builders/PromptBuilder.php` |

Converts text to multiple speech outputs.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wordpress-aiclient-builders-promptbuilder/usingcandidatecount/?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%2Fusingcandidatecount%2F)
before being able to contribute a note or feedback.