docs: refine api ref

[JeanKaddour]

Important

Refines API documentation by clarifying sample randomness in evaluations and updating user management descriptions.

• Evaluations API:
  • Clarified num_samples in EvalRunRequest as "Number of random samples to evaluate" in evaluations.mdx.
• Users API:
  • Updated description to include chatbots in users.mdx.
• Misc:
  • Removed trailing spaces in evaluations.mdx, run-management.mdx, and users.mdx.

^{This description was created by for 03eaccf. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to 03eaccf in 49 seconds

More details

• Looked at 54 lines of code in 3 files
• Skipped 0 files when reviewing.
• Skipped posting 7 drafted comments based on config settings.

1. docs/api-reference/evaluations.mdx:44

• Draft comment:
  Changed param description to 'random samples'. Consider expanding if randomness has specific implications.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 30% <= threshold 50%
  The comment suggests expanding the description if randomness has specific implications. This is a suggestion to ensure clarity, but it doesn't directly ask for a code change or point out a specific issue. It seems to be more of a suggestion for clarity rather than a necessary change.

2. docs/api-reference/run-management.mdx:121

• Draft comment:
  Ensure file ends with a newline consistently.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

3. docs/api-reference/users.mdx:4

• Draft comment:
  Include 'chatbots' in description; verify it aligns with actual endpoint behavior.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
  The comment is asking the PR author to update the PR description and verify alignment with endpoint behavior. This violates the rule against asking for PR description updates and ensuring behavior is intended.

4. docs/api-reference/evaluations.mdx:44

• Draft comment:
  Clarifies 'num_samples' as using random sampling.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

5. docs/api-reference/run-management.mdx:124

• Draft comment:
  Removed trailing whitespace after closing code block for consistency.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

6. docs/api-reference/users.mdx:4

• Draft comment:
  Including 'chatbots' improves clarity on deployment context.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

7. docs/api-reference/users.mdx:115

• Draft comment:
  Removed trailing whitespace in response spec for consistency.
• Reason this comment was not posted:
  Confidence changes required: 0% <= threshold 50%
  None

Workflow ID: wflow_uckVYYjWATMtuBRO

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.