Analyzes the provided text and returns scores for requested attributes.

Scopes

You will need authorization for the https://www.googleapis.com/auth/userinfo.email scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/userinfo.email. You can set the scope for this method like this: commentanalyzer1-alpha1 --scope <scope> comments analyze ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

AnalyzeCommentRequest:
  client-token: string
  comment:
    text: string
    type: string
  community-id: string
  context:
    article-and-parent-comment:
      article:
        text: string
        type: string
      parent-comment:
        text: string
        type: string
  do-not-store: boolean
  languages: [string]
  session-id: string
  span-annotations: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . client-token=et
    • Opaque token that is echoed from the request to the response.
  • comment text=magna
    • UTF-8 encoded text.

  • type=no

    • Type of the text field.

  • .. community-id=ipsum

    • 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.
  • context.article-and-parent-comment.article text=voluptua.
    • UTF-8 encoded text.

  • type=at

    • Type of the text field.

  • ..parent-comment text=sanctus

    • UTF-8 encoded text.

  • type=sed

    • Type of the text field.

  • .... do-not-store=true

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

    • 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. - Each invocation of this argument appends the given value to the array. * session-id=duo - 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. * span-annotations=true - 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").