google_api_language v0.0.1 GoogleApi.Language.V1.Api.Documents View Source

API calls for all endpoints tagged Documents.

Link to this section Summary

Functions

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties

Analyzes the sentiment of the provided text

Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call

Link to this section Functions

Link to this function language_documents_analyze_entities(connection, opts \\ []) View Source
language_documents_analyze_entities(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Language.V1.Model.AnalyzeEntitiesResponse.t} |
  {:error, Tesla.Env.t}

Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String): OAuth access token.
    • :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.
    • :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.
    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :callback (String): JSONP
    • :__/xgafv (String): V1 error format.
    • :alt (String): Data format for response.
    • :body (AnalyzeEntitiesRequest):

Returns

{:ok, %GoogleApi.Language.V1.Model.AnalyzeEntitiesResponse{}} on success {:error, info} on failure

Link to this function language_documents_analyze_sentiment(connection, opts \\ []) View Source
language_documents_analyze_sentiment(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Language.V1.Model.AnalyzeSentimentResponse.t} |
  {:error, Tesla.Env.t}

Analyzes the sentiment of the provided text.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String): OAuth access token.
    • :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.
    • :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.
    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :callback (String): JSONP
    • :__/xgafv (String): V1 error format.
    • :alt (String): Data format for response.
    • :body (AnalyzeSentimentRequest):

Returns

{:ok, %GoogleApi.Language.V1.Model.AnalyzeSentimentResponse{}} on success {:error, info} on failure

Link to this function language_documents_analyze_syntax(connection, opts \\ []) View Source
language_documents_analyze_syntax(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Language.V1.Model.AnalyzeSyntaxResponse.t} |
  {:error, Tesla.Env.t}

Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String): OAuth access token.
    • :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.
    • :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.
    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :callback (String): JSONP
    • :__/xgafv (String): V1 error format.
    • :alt (String): Data format for response.
    • :body (AnalyzeSyntaxRequest):

Returns

{:ok, %GoogleApi.Language.V1.Model.AnalyzeSyntaxResponse{}} on success {:error, info} on failure

Link to this function language_documents_annotate_text(connection, opts \\ []) View Source
language_documents_annotate_text(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.Language.V1.Model.AnnotateTextResponse.t} |
  {:error, Tesla.Env.t}

A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

    • :access_token (String): OAuth access token.
    • :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.
    • :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.
    • :pp (Boolean): Pretty-print response.
    • :oauth_token (String): OAuth 2.0 token for the current user.
    • :bearer_token (String): OAuth bearer token.
    • :upload_protocol (String): Upload protocol for media (e.g. "raw", "multipart").
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :upload_type (String): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :callback (String): JSONP
    • :__/xgafv (String): V1 error format.
    • :alt (String): Data format for response.
    • :body (AnnotateTextRequest):

Returns

{:ok, %GoogleApi.Language.V1.Model.AnnotateTextResponse{}} on success {:error, info} on failure