google_api_language

v0.1.0

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

API calls for all endpoints tagged Documents.

Link to this section Summary

Functions

language_documents_analyze_entities(connection, opts \\ [])

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

language_documents_analyze_entity_sentiment(connection, opts \\ [])

Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions

language_documents_analyze_sentiment(connection, opts \\ [])

Analyzes the sentiment of the provided text

language_documents_analyze_syntax(connection, opts \\ [])

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

language_documents_annotate_text(connection, opts \\ [])

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

language_documents_classify_text(connection, opts \\ [])

Classifies a document into categories

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

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (AnalyzeEntitiesRequest):

Returns

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

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

Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (AnalyzeEntitySentimentRequest):

Returns

{:ok, %GoogleApi.Language.V1.Model.AnalyzeEntitySentimentResponse{}} 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

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :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

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :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

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (AnnotateTextRequest):

Returns

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

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

Classifies a document into categories.

Parameters

  • connection (GoogleApi.Language.V1.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (String.t): 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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): 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.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (ClassifyTextRequest):

Returns

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