Struct ModerationsClient 

pub struct ModerationsClient<'a, T = ()> { /* private fields */ }

Client for moderations API.

Implementations

impl<T: Default + Send + Sync> ModerationsClient<'_, T>

pub fn builder(&self, input: impl Into<String>) -> ModerationBuilder

Create a moderation builder for checking text content.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let builder = client.moderations().builder("Text to check");
let response = client.moderations().create(builder).await?;
println!("Flagged: {}", response.results[0].flagged);

pub fn check(&self, input: impl Into<String>) -> ModerationBuilder

Convenience method for moderating a single text input.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let builder = client.moderations().check("Hello world");
let response = client.moderations().create(builder).await?;

if response.results[0].flagged {
    println!("Content was flagged for moderation");
}

pub async fn create( &self, builder: ModerationBuilder, ) -> Result<CreateModerationResponse>

Execute a moderation request built with ModerationBuilder.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;

let builder = client
    .moderations()
    .check("Is this content appropriate?")
    .model("text-moderation-latest");

let response = client.moderations().create(builder).await?;

println!("Model: {}", response.model);
for result in response.results {
    println!("Flagged: {}", result.flagged);
    println!("Hate: {}", result.categories.hate);
    println!("Violence: {}", result.categories.violence);
}

Errors

Returns an error if the API request fails or the response cannot be parsed.

Trait Implementations

impl<'a, T: Clone> Clone for ModerationsClient<'a, T>

fn clone(&self) -> ModerationsClient<'a, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for ModerationsClient<'a, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, T: Copy> Copy for ModerationsClient<'a, T>