Documentation

Google_Service_CloudNaturalLanguageAPI_Resource_Documents extends Google_Service_Resource
in package

The "documents" collection of methods.

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

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
analyzeEntities()  : Google_Service_CloudNaturalLanguageAPI_AnalyzeEntitiesResponse
Finds named entities (currently finds proper names) in the text, entity types, salience, mentions for each entity, and other properties.
analyzeSentiment()  : Google_Service_CloudNaturalLanguageAPI_AnalyzeSentimentResponse
Analyzes the sentiment of the provided text. (documents.analyzeSentiment)
annotateText()  : Google_Service_CloudNaturalLanguageAPI_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.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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 finds proper names) in the text, entity types, salience, mentions for each entity, and other properties.

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

(documents.analyzeEntities)

Parameters
$postBody : Google_Service_CloudNaturalLanguageAPI_AnalyzeEntitiesRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudNaturalLanguageAPI_AnalyzeEntitiesResponse —

analyzeSentiment()

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

public analyzeSentiment(Google_Service_CloudNaturalLanguageAPI_AnalyzeSentimentRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_CloudNaturalLanguageAPI_AnalyzeSentimentResponse
Parameters
$postBody : Google_Service_CloudNaturalLanguageAPI_AnalyzeSentimentRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudNaturalLanguageAPI_AnalyzeSentimentResponse —

annotateText()

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

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

(documents.annotateText)

Parameters
$postBody : Google_Service_CloudNaturalLanguageAPI_AnnotateTextRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_CloudNaturalLanguageAPI_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
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

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>
Tags
static
Return values
string —

$requestUrl

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results