Skip to content

language: verbose mode #1782

@callmehiphop

Description

@callmehiphop

We've received some feedback for our Natural Language implementation from the API team. They have some concerns about our verbose option.

If you're unfamiliar with said option, it essentially collapses data that was deemed non-crucial. Using the following text, please refer to the examples below - Google is an American multinational technology company specializing in Internet-related services and products.

Non-verbose Entities
entities = {
  organizations: [
    'Google'
  ],
  places: [
    'American'
  ]
}
Verbose Entities
entities = {
  organizations: [
    {
      name: 'Google',
      type: 'ORGANIZATION',
      metadata: {
        wikipedia_url: 'http: *   //en.wikipedia.org/wiki/Google'
      },
      salience: 65.137446,
      mentions: [
        {
          text: {
            content: 'Google',
            beginOffset: -1
          }
        }
      ]
    }
  ],
  places: [
    {
      name: 'American',
      type: 'LOCATION',
      metadata: {
        wikipedia_url: 'http: *   //en.wikipedia.org/wiki/United_States'
      },
      salience: 13.947371,
      mentions: [
        {
          text: {
            content: 'American',
            beginOffset: -1
          }
        }
      ]
    }
  ]
}

I believe the intention for verbose was to supply the user with the information returned from the API that covered the most common use cases, however we may actually be supplying the user with too little information making the non-verbose mode impractical. I'd like to use this issue to open a line of dialogue to see if we can improve our implementation in this area and to address any concerns from the API team.

Metadata

Metadata

Assignees

Labels

api: languageIssues related to the Cloud Natural Language API API.priority: p0Highest priority. Critical issue. P0 implies highest priority.type: questionRequest for information or clarification. Not an issue.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions