Documentation

Google_Service_CloudNaturalLanguage_Resource_Documents extends Google_Service_Resource
in package

Application

The "documents" collection of methods.

Typical usage is: $languageService = new Google_Service_CloudNaturalLanguage(...); $documents = $languageService->documents;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
analyzeEntities() : Google_Service_CloudNaturalLanguage_AnalyzeEntitiesResponse: Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties. (documents.analyzeEntities)
analyzeEntitySentiment() : Google_Service_CloudNaturalLanguage_AnalyzeEntitySentimentResponse: Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment associated with each entity and its mentions.
analyzeSentiment() : Google_Service_CloudNaturalLanguage_AnalyzeSentimentResponse: Analyzes the sentiment of the provided text. (documents.analyzeSentiment)
analyzeSyntax() : Google_Service_CloudNaturalLanguage_AnalyzeSyntaxResponse: Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties. (documents.analyzeSyntax)
annotateText() : Google_Service_CloudNaturalLanguage_AnnotateTextResponse: A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
classifyText() : Google_Service_CloudNaturalLanguage_ClassifyTextResponse: Classifies a document into categories. (documents.classifyText)
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

analyzeEntities()

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


    public
                analyzeEntities(Google_Service_CloudNaturalLanguage_AnalyzeEntitiesRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_AnalyzeEntitiesResponse

Parameters

$postBody : Google_Service_CloudNaturalLanguage_AnalyzeEntitiesRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_AnalyzeEntitiesResponse —

analyzeEntitySentiment()

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


    public
                analyzeEntitySentiment(Google_Service_CloudNaturalLanguage_AnalyzeEntitySentimentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_AnalyzeEntitySentimentResponse

(documents.analyzeEntitySentiment)

Parameters

$postBody : Google_Service_CloudNaturalLanguage_AnalyzeEntitySentimentRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_AnalyzeEntitySentimentResponse —

analyzeSentiment()

Analyzes the sentiment of the provided text. (documents.analyzeSentiment)


    public
                analyzeSentiment(Google_Service_CloudNaturalLanguage_AnalyzeSentimentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_AnalyzeSentimentResponse

Parameters

$postBody : Google_Service_CloudNaturalLanguage_AnalyzeSentimentRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_AnalyzeSentimentResponse —

analyzeSyntax()

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


    public
                analyzeSyntax(Google_Service_CloudNaturalLanguage_AnalyzeSyntaxRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_AnalyzeSyntaxResponse

Parameters

$postBody : Google_Service_CloudNaturalLanguage_AnalyzeSyntaxRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_AnalyzeSyntaxResponse —

annotateText()

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


    public
                annotateText(Google_Service_CloudNaturalLanguage_AnnotateTextRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_AnnotateTextResponse

(documents.annotateText)

Parameters

$postBody : Google_Service_CloudNaturalLanguage_AnnotateTextRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_AnnotateTextResponse —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

classifyText()

Classifies a document into categories. (documents.classifyText)


    public
                classifyText(Google_Service_CloudNaturalLanguage_ClassifyTextRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguage_ClassifyTextResponse

Parameters

$postBody : Google_Service_CloudNaturalLanguage_ClassifyTextRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_CloudNaturalLanguage_ClassifyTextResponse —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —