CommentRelevanceResult

Represents the result of comment relevance analysis.

TypeScript

import type { CommentRelevanceResult } from "@respectify/client";

Python

from respectify.schemas import CommentRelevanceResult

PHP

use Respectify\Schemas\CommentRelevanceResult;

JSON

Types are returned as JSON objects in API responses.

Fields

on_topic

On-topic analysis result

TypeScript

result.on_topic: OnTopicResult

Python

result.on_topic: OnTopicResult

PHP

$result->onTopic: OnTopicResult

JSON

"on_topic": {
  "reasoning": "string",
  "on_topic": true,
  "confidence": 0.5
}

This is a OnTopicResult object.

banned_topics

Banned topics analysis result

TypeScript

result.banned_topics: BannedTopicsResult

Python

result.banned_topics: BannedTopicsResult

PHP

$result->bannedTopics: BannedTopicsResult

JSON

"banned_topics": {
  "reasoning": "string",
  "banned_topics": ["...", "..."],
  "quantity_on_banned_topics": 0.5,
  "confidence": 0.5
}

This is a BannedTopicsResult object.

Sub-types

OnTopicResult

Represents whether a comment is on-topic.

TypeScript

Field	Type	Description
reasoning	string	Explanation of the relevance analysis
on_topic	boolean	Whether the comment is on-topic
confidence	number // 0.0-1.0	Confidence level (0.0=low, 1.0=high)

Python

Field	Type	Description
reasoning	str	Explanation of the relevance analysis
on_topic	bool	Whether the comment is on-topic
confidence	float # 0.0-1.0	Confidence level (0.0=low, 1.0=high)

PHP

Field	Type	Description
reasoning	string	Explanation of the relevance analysis
onTopic	bool	Whether the comment is on-topic
confidence	float	Confidence level (0.0=low, 1.0=high)

JSON

{
  "reasoning": "string",
  "on_topic": true,
  "confidence": 0.5
}

BannedTopicsResult

Represents analysis of banned topics in a comment.

TypeScript

Field	Type	Description
reasoning	string	Explanation of the banned topics analysis
banned_topics	string[]	List of banned topics detected
quantity_on_banned_topics	number // 0.0-1.0	Proportion discussing banned topics (0.0=none, 1.0=entirely)
confidence	number // 0.0-1.0	Confidence level (0.0=low, 1.0=high)

Python

Field	Type	Description
reasoning	str	Explanation of the banned topics analysis
banned_topics	List[str]	List of banned topics detected
quantity_on_banned_topics	float # 0.0-1.0	Proportion discussing banned topics (0.0=none, 1.0=entirely)
confidence	float # 0.0-1.0	Confidence level (0.0=low, 1.0=high)

PHP

Field	Type	Description
reasoning	string	Explanation of the banned topics analysis
bannedTopics	str[]	List of banned topics detected
quantityOnBannedTopics	float	Proportion discussing banned topics (0.0=none, 1.0=entirely)
confidence	float	Confidence level (0.0=low, 1.0=high)

JSON

{
  "reasoning": "string",
  "banned_topics": ["...", "..."],
  "quantity_on_banned_topics": 0.5,
  "confidence": 0.5
}