Class AnalyzeCommentRequest

The comment analysis request message. LINT.IfChange

Inheritance

System.Object

AnalyzeCommentRequest

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.CommentAnalyzer.v1alpha1.Data

Assembly: Google.Apis.CommentAnalyzer.v1alpha1.dll

Syntax

public class AnalyzeCommentRequest : IDirectResponseSchema

Properties

ClientToken

Opaque token that is echoed from the request to the response.

Declaration

[JsonProperty("clientToken")]
public virtual string ClientToken { get; set; }

Property Value

Type	Description
System.String

Comment

The comment to analyze.

Declaration

[JsonProperty("comment")]
public virtual TextEntry Comment { get; set; }

Property Value

Type	Description
TextEntry

CommunityId

Optional identifier associating this AnalyzeCommentRequest with a particular client's community. Different communities may have different norms and rules. Specifying this value enables us to explore building community-specific models for clients.

Declaration

[JsonProperty("communityId")]
public virtual string CommunityId { get; set; }

Property Value

Type	Description
System.String

Context

The context of the comment.

Declaration

[JsonProperty("context")]
public virtual Context Context { get; set; }

Property Value

Type	Description
Context

DoNotStore

Do not store the comment or context sent in this request. By default, the service may store comments/context for debugging purposes.

Declaration

[JsonProperty("doNotStore")]
public virtual bool? DoNotStore { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Languages

The language(s) of the comment and context. If none are specified, we attempt to automatically detect the language. Specifying multiple languages means the text contains multiple lanugages. Both ISO and BCP-47 language codes are accepted.

The server returns an error if no language was specified and language detection fails. The server also returns an error if the languages (either specified by the caller, or auto-detected) are not all supported by the service.

Declaration

[JsonProperty("languages")]
public virtual IList<string> Languages { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

RequestedAttributes

Specification of requested attributes. The AttributeParameters serve as configuration for each associated attribute. The map keys are attribute names. The available attributes may be different on each RFE installation, and can be seen by calling ListAttributes (see above). For the prod installation, known as Perspective API, at blade:commentanalyzer-esf and commentanalyzer.googleapis.com, see go/checker-models (internal) and https://github.com/conversationai/perspectiveapi/blob/master/2-api/models.md#all-attribute- types.

Declaration

[JsonProperty("requestedAttributes")]
public virtual IDictionary<string, AttributeParameters> RequestedAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, AttributeParameters>

SessionId

Session ID. Used to join related RPCs into a single session. For example, an interactive tool that calls both the AnalyzeComment and SuggestCommentScore RPCs should set all invocations of both RPCs to the same Session ID, typically a random 64-bit integer.

Declaration

[JsonProperty("sessionId")]
public virtual string SessionId { get; set; }

Property Value

Type	Description
System.String

SpanAnnotations

An advisory parameter that will return span annotations if the model is capable of providing scores with sub-comment resolution. This will likely increase the size of the returned message.

Declaration

[JsonProperty("spanAnnotations")]
public virtual bool? SpanAnnotations { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Implements

IDirectResponseSchema