Cloud Natural Language V1 Client - Class LanguageServiceClient (0.31.3)

Reference documentation and code samples for the Cloud Natural Language V1 Client class LanguageServiceClient.

Service Description: Provides text analysis operations such as sentiment analysis and entity recognition.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$languageServiceClient = new Google\Cloud\Language\V1\LanguageServiceClient();
try {
    $document = new Google\Cloud\Language\V1\Document();
    $response = $languageServiceClient->analyzeEntities($document);
} finally {
    $languageServiceClient->close();
}

This service has a new (beta) implementation. See Google\Cloud\Language\V1\Client\LanguageServiceClient to use the new surface.

Namespace

Google \ Cloud \ Language \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

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.

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ encodingType`	`int` The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\AnalyzeEntitiesResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\AnalyzeEntitiesRequest;
use Google\Cloud\Language\V1\AnalyzeEntitiesResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function analyze_entities_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new AnalyzeEntitiesRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var AnalyzeEntitiesResponse $response */
        $response = $languageServiceClient->analyzeEntities($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

analyzeEntitySentiment

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

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ encodingType`	`int` The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\AnalyzeEntitySentimentResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\AnalyzeEntitySentimentRequest;
use Google\Cloud\Language\V1\AnalyzeEntitySentimentResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function analyze_entity_sentiment_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new AnalyzeEntitySentimentRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var AnalyzeEntitySentimentResponse $response */
        $response = $languageServiceClient->analyzeEntitySentiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

analyzeSentiment

Analyzes the sentiment of the provided text.

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ encodingType`	`int` The encoding type used by the API to calculate sentence offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\AnalyzeSentimentResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\AnalyzeSentimentRequest;
use Google\Cloud\Language\V1\AnalyzeSentimentResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function analyze_sentiment_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new AnalyzeSentimentRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var AnalyzeSentimentResponse $response */
        $response = $languageServiceClient->analyzeSentiment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

analyzeSyntax

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

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ encodingType`	`int` The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\AnalyzeSyntaxResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\AnalyzeSyntaxRequest;
use Google\Cloud\Language\V1\AnalyzeSyntaxResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function analyze_syntax_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new AnalyzeSyntaxRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var AnalyzeSyntaxResponse $response */
        $response = $languageServiceClient->analyzeSyntax($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

annotateText

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

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`features`	`Google\Cloud\Language\V1\AnnotateTextRequest\Features` Required. The enabled features.
`optionalArgs`	`array` Optional.
`↳ encodingType`	`int` The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V1\EncodingType
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\AnnotateTextResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\AnnotateTextRequest;
use Google\Cloud\Language\V1\AnnotateTextRequest\Features;
use Google\Cloud\Language\V1\AnnotateTextResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function annotate_text_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $features = new Features();
    $request = (new AnnotateTextRequest())
        ->setDocument($document)
        ->setFeatures($features);

    // Call the API and handle any network failures.
    try {
        /** @var AnnotateTextResponse $response */
        $response = $languageServiceClient->annotateText($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

classifyText

Classifies a document into categories.

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ classificationModelOptions`	`ClassificationModelOptions` Model options to use for classification. Defaults to v1 options if not specified.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\ClassifyTextResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\ClassifyTextRequest;
use Google\Cloud\Language\V1\ClassifyTextResponse;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function classify_text_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new ClassifyTextRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var ClassifyTextResponse $response */
        $response = $languageServiceClient->classifyText($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

moderateText

Moderates a document for harmful and sensitive categories.

Parameters
Name	Description
`document`	`Google\Cloud\Language\V1\Document` Required. Input document.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\Language\V1\ModerateTextResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Language\V1\Client\LanguageServiceClient;
use Google\Cloud\Language\V1\Document;
use Google\Cloud\Language\V1\ModerateTextRequest;
use Google\Cloud\Language\V1\ModerateTextResponse;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function moderate_text_sample(): void
{
    // Create a client.
    $languageServiceClient = new LanguageServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new ModerateTextRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var ModerateTextResponse $response */
        $response = $languageServiceClient->moderateText($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

Constants

SERVICE_NAME

Value: 'google.cloud.language.v1.LanguageService'

The name of the service.

SERVICE_ADDRESS

Value: 'language.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.